1
.TH "qof-main.h" 3 "30 May 2007" "Version 0.1.0" "gpe-expenses" \" -*- nroff -*-
6
.SH "Detailed Description"
8
Common functions for the QOF external framework.
12
Copyright (c) 2005 Neil Williams <linux@codehelp.co.uk>
17
Definition in file \fBqof-main.h\fP.
25
.RI "struct \fBQofMain_s\fP"
27
.RI "\fIThe qof-main context struct. \fP"
33
.RI "#define \fBERR_INDENT\fP strlen(PACKAGE) + 2"
35
.RI "\fIIndent error messages as paragraphs. \fP"
37
.RI "#define \fBQOF_DATE_STRING_LENGTH\fP MAX_DATE_LENGTH"
40
.RI "#define \fBQOF_MAIN_CLI\fP 'QOF-mod-command-line'"
43
.RI "#define \fBCATEGORY_NAME\fP 'category'"
45
.RI "\fICategory name. \fP"
47
.RI "#define \fBQSF_COMPRESS\fP 'compression_level'"
50
.RI "#define \fBQSF_ENCODING\fP 'encoding_string'"
53
.RI "#define \fBQSF_DATE_CONVERT\fP 'convert_date_to_time'"
56
.RI "#define \fBQOF_SQL_SUPPORTED\fP '^SELECT|INSERT'"
59
.RI "#define \fBQOF_CLI_OPTIONS\fP"
61
.RI "\fICommon QOF CLI options. \fP"
63
.RI "#define \fBQOF_MAIN_OP\fP"
66
.RI "#define \fBQOF_OP_VARS\fP"
69
.RI "#define \fBQOF_OP_INIT\fP"
76
.RI "typedef \fBQofMain_s\fP \fBQofMainContext\fP"
78
.RI "\fIThe qof-main context struct. \fP"
84
.RI "void \fBqof_main_wrap_line\fP (FILE *fp, gint indent, const gchar *template_str,...) __attribute__((format(printf"
86
.RI "\fIWrap long lines in popt-style. \fP"
88
.RI "GSList * \fBqof_main_get_param_list\fP (QofIdTypeConst object_type, QofType param_type)"
90
.RI "\fIList of all parameters for this object of one QOF type. \fP"
92
.RI "gchar * \fBqof_main_make_utf8\fP (gchar *string)"
94
.RI "\fIConvert strings received from the wrapped objects into UTF-8. \fP"
96
.RI "glong \fBqof_mod_get_local_offset\fP (void)"
98
.RI "\fIGet the gmt_off offset for this locale. \fP"
100
.RI "void \fBqof_main_show_error\fP (QofSession *session)"
102
.RI "\fIOutput error messages from QOF. \fP"
104
.RI "void \fBqof_main_free\fP (\fBQofMainContext\fP *context)"
107
.RI "void \fBqof_cmd_xmlfile\fP (\fBQofMainContext\fP *context)"
110
.RI "void \fBqof_cmd_list\fP (void)"
112
.RI "\fILists all databases supported by the current QOF framework. \fP"
114
.RI "void \fBqof_mod_category\fP (const gchar *category, \fBQofMainContext\fP *data)"
116
.RI "\fIShorthand to only query objects that are set to the specified category. \fP"
118
.RI "void \fBqof_mod_database\fP (const gchar *database, \fBQofMainContext\fP *data)"
120
.RI "\fIShorthand to only query objects within one specific supported database. \fP"
122
.RI "void \fBqof_mod_time\fP (const gchar *date_time, \fBQofMainContext\fP *data)"
124
.RI "\fIShorthand to only query objects that contain the specified date. \fP"
126
.RI "void \fBqof_mod_exclude\fP (const gchar *exclude, \fBQofMainContext\fP *data)"
128
.RI "\fIShorthand to exclude a supported database from the query. \fP"
130
.RI "void \fBqof_mod_sql\fP (const gchar *sql_query, \fBQofMainContext\fP *data)"
132
.RI "\fISpecify a SQL query on the command line. \fP"
134
.RI "void \fBqof_mod_sql_file\fP (const gchar *sql_file, \fBQofMainContext\fP *data)"
136
.RI "\fISpecify one or more SQL queries contained in a file. \fP"
138
.RI "void \fBqof_mod_write\fP (const gchar *write_file, \fBQofMainContext\fP *data)"
140
.RI "\fIWrite the results of any query to the file. \fP"
142
.RI "void \fBqof_mod_compression\fP (gint64 gz_level, \fBQofMainContext\fP *context)"
145
.RI "void \fBqof_mod_encoding\fP (const gchar *encoding, \fBQofMainContext\fP *context)"
148
.RI "void \fBqof_mod_convert_deprecated\fP (gint64 convert, \fBQofMainContext\fP *context)"
151
.RI "void \fBqof_main_moderate_query\fP (\fBQofMainContext\fP *context)"
153
.RI "\fIAssemble the components of the query. \fP"
155
.RI "void \fBqof_cmd_explain\fP (\fBQofMainContext\fP *context)"
158
.RI "void \fBqof_main_select\fP (\fBQofMainContext\fP *context)"
163
Generated automatically by Doxygen for gpe-expenses from the source code.
added
removed
doc/man/man3/qof-main.h.3
