QOF: qofquery.h File Reference

QOF 0.7.5

Macros | Typedefs | Enumerations
qofquery.h File Reference
Query Object Framework » Query: Querying for Objects

find objects that match a certain expression. More...

`#include "guid.h"`
`#include "qofbook.h"`
`#include "qofquerycore.h"`
`#include "qofchoice.h"`

Go to the source code of this file.

## Macros
#define | QOF_MOD_QUERY "qof-query"
#define | QOF_QUERY_FIRST_TERM QOF_QUERY_AND
#define | QUERY_DEFAULT_SORT "QofQueryDefaultSort"
#define | QOF_PARAM_BOOK "book"
#define | QOF_PARAM_GUID "guid"
#define | QOF_PARAM_KVP "kvp"
#define | QOF_PARAM_ACTIVE "active"
#define | QOF_PARAM_VERSION "version"

## Typedefs
typedef struct _QofQuery | QofQuery

## Enumerations
enum | QofQueryOp { QOF_QUERY_AND = 1, QOF_QUERY_OR, QOF_QUERY_NAND, QOF_QUERY_NOR, QOF_QUERY_XOR }

## Functions
Query Subsystem Initialization and Shudown
void | qof_query_init (void)
void | qof_query_shutdown (void)
Low-Level API Functions
GSList * | qof_query_build_param_list (gchar const *param,...)
QofQuery * | qof_query_create (void)
QofQuery * | qof_query_create_for (QofIdTypeConst obj_type)
void | qof_query_destroy (QofQuery *q)
void | qof_query_search_for (QofQuery *query, QofIdTypeConst obj_type)
void | qof_query_set_book (QofQuery *q, QofBook *book)
void | qof_query_add_term (QofQuery *query, GSList *param_list, QofQueryPredData *pred_data, QofQueryOp op)
void | qof_query_add_guid_match (QofQuery *q, GSList *param_list, const GUID *guid, QofQueryOp op)
void | qof_query_add_guid_list_match (QofQuery *q, GSList *param_list, GList *guid_list, QofGuidMatch options, QofQueryOp op)
void | qof_query_add_boolean_match (QofQuery *q, GSList *param_list, gboolean value, QofQueryOp op)
GList * | qof_query_run (QofQuery *query)
GList * | qof_query_last_run (QofQuery *query)
void | qof_query_clear (QofQuery *query)
void | qof_query_purge_terms (QofQuery *q, GSList *param_list)
gint | qof_query_has_terms (QofQuery *q)
gint | qof_query_num_terms (QofQuery *q)
gboolean | qof_query_has_term_type (QofQuery *q, GSList *term_param)
GSList * | qof_query_get_term_type (QofQuery *q, GSList *term_param)
QofQuery * | qof_query_copy (QofQuery *q)
QofQuery * | qof_query_invert (QofQuery *q)
QofQuery * | qof_query_merge (QofQuery *q1, QofQuery *q2, QofQueryOp op)
void | qof_query_merge_in_place (QofQuery *q1, QofQuery *q2, QofQueryOp op)
void | qof_query_set_sort_order (QofQuery *q, GSList *primary_sort_params, GSList *secondary_sort_params, GSList *tertiary_sort_params)
void | qof_query_set_sort_options (QofQuery *q, gint prim_op, gint sec_op, gint tert_op)
void | qof_query_set_sort_increasing (QofQuery *q, gboolean prim_inc, gboolean sec_inc, gboolean tert_inc)
void | qof_query_set_max_results (QofQuery *q, gint n)
gboolean | qof_query_equal (QofQuery *q1, QofQuery *q2)
QofIdType | qof_query_get_search_for (QofQuery *q)
GList * | qof_query_get_books (QofQuery *q)

## Detailed Description

find objects that match a certain expression.

Author
  Copyright (C) 2002 Derek Atkins warlo.nosp@m.rd@M.nosp@m.IT.ED.nosp@m.U
  Copyright (C) 2003 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g
  Copyright (c) 2006 Neil Williams linux.nosp@m.@cod.nosp@m.ehelp.nosp@m..co..nosp@m.uk

Definition in file qofquery.h.