qof-main.h File Reference

Detailed Description

Common functions for the QOF external framework.

Copyright (c) 2005 Neil Williams <linux@codehelp.co.uk>

Definition in file qof-main.h.

Go to the source code of this file.

Data Structures

struct  QofMain_s
 The qof-main context struct. More...


#define ERR_INDENT   strlen(PACKAGE) + 2
 Indent error messages as paragraphs.
#define QOF_MAIN_CLI   "QOF-mod-command-line"
#define CATEGORY_NAME   "category"
 Category name.
#define QSF_COMPRESS   "compression_level"
#define QSF_ENCODING   "encoding_string"
#define QSF_DATE_CONVERT   "convert_date_to_time"
 Common QOF CLI options.
#define QOF_MAIN_OP
#define QOF_OP_VARS
#define QOF_OP_INIT


typedef QofMain_s QofMainContext
 The qof-main context struct.


void qof_main_wrap_line (FILE *fp, gint indent, const gchar *template_str,...) __attribute__((format(printf
 Wrap long lines in popt-style.
GSList * qof_main_get_param_list (QofIdTypeConst object_type, QofType param_type)
 List of all parameters for this object of one QOF type.
gchar * qof_main_make_utf8 (gchar *string)
 Convert strings received from the wrapped objects into UTF-8.
glong qof_mod_get_local_offset (void)
 Get the gmt_off offset for this locale.
void qof_main_show_error (QofSession *session)
 Output error messages from QOF.
void qof_main_free (QofMainContext *context)
void qof_cmd_xmlfile (QofMainContext *context)
void qof_cmd_list (void)
 Lists all databases supported by the current QOF framework.
void qof_mod_category (const gchar *category, QofMainContext *data)
 Shorthand to only query objects that are set to the specified category.
void qof_mod_database (const gchar *database, QofMainContext *data)
 Shorthand to only query objects within one specific supported database.
void qof_mod_time (const gchar *date_time, QofMainContext *data)
 Shorthand to only query objects that contain the specified date.
void qof_mod_exclude (const gchar *exclude, QofMainContext *data)
 Shorthand to exclude a supported database from the query.
void qof_mod_sql (const gchar *sql_query, QofMainContext *data)
 Specify a SQL query on the command line.
void qof_mod_sql_file (const gchar *sql_file, QofMainContext *data)
 Specify one or more SQL queries contained in a file.
void qof_mod_write (const gchar *write_file, QofMainContext *data)
 Write the results of any query to the file.
void qof_mod_compression (gint64 gz_level, QofMainContext *context)
void qof_mod_encoding (const gchar *encoding, QofMainContext *context)
void qof_mod_convert_deprecated (gint64 convert, QofMainContext *context)
void qof_main_moderate_query (QofMainContext *context)
 Assemble the components of the query.
void qof_cmd_explain (QofMainContext *context)
void qof_main_select (QofMainContext *context)

Generated on Tue Mar 6 00:08:09 2007 for pilot-qof by  doxygen 1.5.1