1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>QOF: qofquery.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6-20040222 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>qofquery.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
find objects that match a certain expression.
<p>
<dl compact><dt><b>Author:</b></dt><dd>Copyright (C) 2002 Derek Atkins <<a href="mailto:warlord@MIT.EDU">warlord@MIT.EDU</a>> <p>
Copyright (C) 2003 Linas Vepstas <<a href="mailto:linas@linas.org">linas@linas.org</a>></dd></dl>
<p>
<code>#include "<a class="el" href="guid_8h.html">guid.h</a>"</code><br>
<code>#include "<a class="el" href="qofbook_8h.html">qofbook.h</a>"</code><br>
<code>#include "<a class="el" href="qofquerycore_8h.html">qofquerycore.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Query Subsystem Initialization and Shudown</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga2">qof_query_init</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga3" doxytag="qofquery.h::qof_query_shutdown" ></a>
void </td><td class="memItemRight" valign=bottom><b>qof_query_shutdown</b> (void)</td></tr>
<tr><td colspan=2><br><h2>Low-Level API Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga4" doxytag="qofquery.h::qof_query_build_param_list" ></a>
GSList * </td><td class="memItemRight" valign=bottom><b>qof_query_build_param_list</b> (char const *param,...)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__Query.html#ga0">QofQuery</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga5">qof_query_create</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga6" doxytag="qofquery.h::qof_query_create_for" ></a>
<a class="el" href="group__Query.html#ga0">QofQuery</a> * </td><td class="memItemRight" valign=bottom><b>qof_query_create_for</b> (QofIdTypeConst obj_type)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga7">qof_query_destroy</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga8">qof_query_search_for</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query, QofIdTypeConst obj_type)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga9">qof_query_set_book</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, <a class="el" href="struct__QofBook.html">QofBook</a> *book)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga10">qof_query_add_term</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query, GSList *param_list, <a class="el" href="struct__QofQueryPredData.html">QofQueryPredData</a> *pred_data, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga11">qof_query_add_guid_match</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *param_list, const <a class="el" href="union__GUID.html">GUID</a> *guid, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga12">qof_query_add_guid_list_match</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *param_list, GList *guid_list, <a class="el" href="group__Query.html#ga59">QofGuidMatch</a> options, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga13">qof_query_add_boolean_match</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *param_list, gboolean value, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GList * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga14">qof_query_run</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GList * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga15">qof_query_last_run</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga16">qof_query_clear</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga17">qof_query_purge_terms</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *param_list)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga18">qof_query_has_terms</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga19">qof_query_num_terms</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gboolean </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga20">qof_query_has_term_type</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *term_param)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__Query.html#ga0">QofQuery</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga21">qof_query_copy</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__Query.html#ga0">QofQuery</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga22">qof_query_invert</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__Query.html#ga0">QofQuery</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga23">qof_query_merge</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q1, <a class="el" href="group__Query.html#ga0">QofQuery</a> *q2, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga24">qof_query_merge_in_place</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q1, <a class="el" href="group__Query.html#ga0">QofQuery</a> *q2, <a class="el" href="group__Query.html#ga54">QofQueryOp</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga25">qof_query_set_sort_order</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, GSList *primary_sort_params, GSList *secondary_sort_params, GSList *tertiary_sort_params)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga26" doxytag="qofquery.h::qof_query_set_sort_options" ></a>
void </td><td class="memItemRight" valign=bottom><b>qof_query_set_sort_options</b> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, gint prim_op, gint sec_op, gint tert_op)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga27">qof_query_set_sort_increasing</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, gboolean prim_inc, gboolean sec_inc, gboolean tert_inc)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga28">qof_query_set_max_results</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q, int n)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>gboolean </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga29">qof_query_equal</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q1, <a class="el" href="group__Query.html#ga0">QofQuery</a> *q2)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga30">qof_query_print</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *query)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>QofIdType </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga31">qof_query_get_search_for</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GList * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga32">qof_query_get_books</a> (<a class="el" href="group__Query.html#ga0">QofQuery</a> *q)</td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga47" doxytag="qofquery.h::QOF_QUERY_FIRST_TERM" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_QUERY_FIRST_TERM</b> QOF_QUERY_AND</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga48">QUERY_DEFAULT_SORT</a> "QofQueryDefaultSort"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga49">QOF_PARAM_BOOK</a> "book"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="ga50" doxytag="qofquery.h::QOF_PARAM_GUID" ></a>
#define </td><td class="memItemRight" valign=bottom><b>QOF_PARAM_GUID</b> "guid"</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga51">QOF_PARAM_ACTIVE</a> "active"</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef _QofQuery </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga0">QofQuery</a></td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="group__Query.html#ga54">QofQueryOp</a> { <br>
<b>QOF_QUERY_AND</b> = 1,
<b>QOF_QUERY_OR</b>,
<b>QOF_QUERY_NAND</b>,
<b>QOF_QUERY_NOR</b>,
<br>
<b>QOF_QUERY_XOR</b>
<br>
}</td></tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 23 15:41:46 2004 for QOF by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6-20040222 </small></address>
</body>
</html>
|
