← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gpe-expenses/oneiric

« back to all changes in this revision

Viewing changes to doc/man/man3/QofMainContext.3

  • Committer: Bazaar Package Importer
  • Author(s): Neil Williams
  • Date: 2007-12-07 00:08:39 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20071207000839-sh6utdxr23ymhd8d
Tags: 0.1.4-1
* New upstream release
* use machine operable debian/copyright, migrate to standards 3.7.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/QofMainContext.3
1
 
.TH "QofMainContext" 3 "9 Sep 2007" "Version 0.1.3" "gpe-expenses" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QofMainContext \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
\fC#include <qof-main.h>\fP
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
The qof-main context struct. 
14
 
 
15
 
Intended as a core type for QOF-based CLI programs, wrap your own context struct around qof_main_context 
16
 
.PP
17
 
Definition at line 212 of file qof-main.h.
18
 
.SS "Data Fields"
19
 
 
20
 
.in +1c
21
 
.ti -1c
22
 
.RI "gchar * \fBfilename\fP"
23
 
.br
24
 
.ti -1c
25
 
.RI "gchar * \fBwrite_file\fP"
26
 
.br
27
 
.ti -1c
28
 
.RI "gchar * \fBinput_file\fP"
29
 
.br
30
 
.ti -1c
31
 
.RI "gchar * \fBsql_file\fP"
32
 
.br
33
 
.ti -1c
34
 
.RI "gchar * \fBsql_str\fP"
35
 
.br
36
 
.ti -1c
37
 
.RI "gchar * \fBdatabase\fP"
38
 
.br
39
 
.ti -1c
40
 
.RI "gchar * \fBexclude\fP"
41
 
.br
42
 
.ti -1c
43
 
.RI "gchar * \fBcategory\fP"
44
 
.br
45
 
.ti -1c
46
 
.RI "QofTime * \fBmin_qt\fP"
47
 
.br
48
 
.ti -1c
49
 
.RI "QofTime * \fBmax_qt\fP"
50
 
.br
51
 
.ti -1c
52
 
.RI "QofSession * \fBinput_session\fP"
53
 
.br
54
 
.ti -1c
55
 
.RI "QofSession * \fBexport_session\fP"
56
 
.br
57
 
.ti -1c
58
 
.RI "gboolean \fBerror\fP"
59
 
.br
60
 
.ti -1c
61
 
.RI "QofQuery * \fBquery\fP"
62
 
.br
63
 
.ti -1c
64
 
.RI "GList * \fBsql_list\fP"
65
 
.br
66
 
.ti -1c
67
 
.RI "gint64 \fBgz_level\fP"
68
 
.br
69
 
.ti -1c
70
 
.RI "const gchar * \fBencoding\fP"
71
 
.br
72
 
.ti -1c
73
 
.RI "gint64 \fBconvert\fP"
74
 
.br
75
 
.ti -1c
76
 
.RI "QofType \fBparam_type\fP"
77
 
.br
78
 
.in -1c
79
 
.SH "Field Documentation"
80
 
.PP 
81
 
.SS "gchar* \fBQofMainContext::filename\fP"
82
 
.PP
83
 
Input filename containing (usually) QSF XML data, if any. 
84
 
.PP
85
 
Definition at line 215 of file qof-main.h.
86
 
.PP
87
 
Referenced by qof_cmd_xmlfile(), and qof_main_free().
88
 
.SS "gchar* \fBQofMainContext::write_file\fP"
89
 
.PP
90
 
Export filename, if any. 
91
 
.PP
92
 
Definition at line 217 of file qof-main.h.
93
 
.PP
94
 
Referenced by qof_cmd_xmlfile(), qof_main_free(), and qof_mod_write().
95
 
.SS "gchar* \fBQofMainContext::input_file\fP"
96
 
.PP
97
 
File containing data to upload, if any. 
98
 
.PP
99
 
Definition at line 219 of file qof-main.h.
100
 
.SS "gchar* \fBQofMainContext::sql_file\fP"
101
 
.PP
102
 
SQL file, if any. 
103
 
.PP
104
 
Definition at line 221 of file qof-main.h.
105
 
.PP
106
 
Referenced by qof_main_free(), and qof_mod_sql_file().
107
 
.SS "gchar* \fBQofMainContext::sql_str\fP"
108
 
.PP
109
 
The current SQL, overwritten each iteration if using a file. 
110
 
.PP
111
 
Definition at line 224 of file qof-main.h.
112
 
.PP
113
 
Referenced by qof_main_moderate_query(), qof_main_run_sql(), and qof_mod_sql().
114
 
.SS "gchar* \fBQofMainContext::database\fP"
115
 
.PP
116
 
The database to include with -d. 
117
 
.PP
118
 
Definition at line 226 of file qof-main.h.
119
 
.PP
120
 
Referenced by qof_cmd_explain(), qof_cmd_xmlfile(), qof_main_free(), qof_main_moderate_query(), and qof_mod_database().
121
 
.SS "gchar* \fBQofMainContext::exclude\fP"
122
 
.PP
123
 
The database to exclude with -e. 
124
 
.PP
125
 
Definition at line 228 of file qof-main.h.
126
 
.PP
127
 
Referenced by qof_cmd_xmlfile(), qof_main_moderate_query(), qof_mod_exclude(), and select_cb().
128
 
.SS "gchar* \fBQofMainContext::category\fP"
129
 
.PP
130
 
The category to include with -c. 
131
 
.PP
132
 
Definition at line 230 of file qof-main.h.
133
 
.PP
134
 
Referenced by build_database_list(), qof_main_free(), and qof_mod_category().
135
 
.SS "QofTime* \fBQofMainContext::min_qt\fP"
136
 
.PP
137
 
Holds the converted -t field - minimum. Matches objects above min. 
138
 
.PP
139
 
Definition at line 233 of file qof-main.h.
140
 
.PP
141
 
Referenced by build_database_list(), find_param_cb(), and qof_mod_time().
142
 
.SS "QofTime* \fBQofMainContext::max_qt\fP"
143
 
.PP
144
 
Holds the converted -t field - maximum. Matches objects below max. 
145
 
.PP
146
 
Definition at line 236 of file qof-main.h.
147
 
.PP
148
 
Referenced by find_param_cb(), and qof_mod_time().
149
 
.SS "QofSession* \fBQofMainContext::input_session\fP"
150
 
.PP
151
 
The input session. 
152
 
.PP
153
 
Definition at line 238 of file qof-main.h.
154
 
.PP
155
 
Referenced by qof_cmd_xmlfile(), qof_main_run_query(), and qof_main_run_sql().
156
 
.SS "QofSession* \fBQofMainContext::export_session\fP"
157
 
.PP
158
 
The query results session, for STDOUT or -w. 
159
 
.PP
160
 
Definition at line 240 of file qof-main.h.
161
 
.PP
162
 
Referenced by qof_cmd_xmlfile(), qof_main_run_query(), qof_mod_compression(), qof_mod_convert_deprecated(), and qof_mod_encoding().
163
 
.SS "gboolean \fBQofMainContext::error\fP"
164
 
.PP
165
 
general error, abort. 
166
 
.PP
167
 
Definition at line 242 of file qof-main.h.
168
 
.PP
169
 
Referenced by qof_cmd_explain().
170
 
.SS "QofQuery* \fBQofMainContext::query\fP"
171
 
.PP
172
 
The current QofQuery, converted from QofSqlQuery 
173
 
.PP
174
 
Definition at line 244 of file qof-main.h.
175
 
.PP
176
 
Referenced by build_database_list(), find_param_cb(), qof_main_moderate_query(), qof_main_run_query(), and qof_main_run_sql().
177
 
.SS "GList* \fBQofMainContext::sql_list\fP"
178
 
.PP
179
 
List of sql commands from a file. 
180
 
.PP
181
 
Definition at line 246 of file qof-main.h.
182
 
.PP
183
 
Referenced by qof_main_moderate_query(), and qof_mod_sql_file().
184
 
.SS "gint64 \fBQofMainContext::gz_level\fP"
185
 
.PP
186
 
Use compression (>0 <=9) or not (0) 
187
 
.PP
188
 
Definition at line 248 of file qof-main.h.
189
 
.PP
190
 
Referenced by option_cb(), qof_cmd_xmlfile(), and qof_mod_compression().
191
 
.SS "const gchar* \fBQofMainContext::encoding\fP"
192
 
.PP
193
 
The encoding string to pass to the backend. 
194
 
.PP
195
 
Definition at line 250 of file qof-main.h.
196
 
.PP
197
 
Referenced by option_cb(), qof_cmd_xmlfile(), and qof_mod_encoding().
198
 
.SS "gint64 \fBQofMainContext::convert\fP"
199
 
.PP
200
 
If the application needs to read QOF_TYPE_DATE data records, set this to non-zero. 
201
 
.PP
202
 
Definition at line 253 of file qof-main.h.
203
 
.PP
204
 
Referenced by option_cb(), and qof_mod_convert_deprecated().
205
 
.SS "QofType \fBQofMainContext::param_type\fP"
206
 
.PP
207
 
The current parameter type in the query. 
208
 
.PP
209
 
Definition at line 255 of file qof-main.h.
210
 
.PP
211
 
Referenced by build_database_list(), and find_param_cb().
212
 
 
213
 
.SH "Author"
214
 
.PP 
215
 
Generated automatically by Doxygen for gpe-expenses from the source code.