GnuCash  4.8a-80-g9825132ea+
Data Structures | Typedefs | Enumerations
qofquerycore.h File Reference

API for providing core Query data types. More...

#include "gnc-numeric.h"
#include "gnc-date.h"
#include "qofclass.h"

Go to the source code of this file.

Data Structures

struct  QofQueryPredData
 No extended comparisons for QOF_TYPE_INT32, QOF_TYPE_INT64, QOF_TYPE_DOUBLE, QOF_TYPE_BOOLEAN. More...
 

Typedefs

typedef GSList QofQueryParamList
 A list of parameters (QofIdType) used to describe a parameter to use in a predicate or when sorting.
 

Enumerations

enum  QofQueryCompare {
  QOF_COMPARE_LT = 1, QOF_COMPARE_LTE, QOF_COMPARE_EQUAL, QOF_COMPARE_GT,
  QOF_COMPARE_GTE, QOF_COMPARE_NEQ, QOF_COMPARE_CONTAINS, QOF_COMPARE_NCONTAINS
}
 Standard Query comparators, for how to compare objects in a predicate. More...
 
enum  QofStringMatch { QOF_STRING_MATCH_NORMAL = 1, QOF_STRING_MATCH_CASEINSENSITIVE }
 List of known core query data-types... More...
 
enum  QofDateMatch { QOF_DATE_MATCH_NORMAL = 1, QOF_DATE_MATCH_DAY }
 Comparisons for QOF_TYPE_DATE The QOF_DATE_MATCH_DAY comparison rounds the two time values to mid-day and then compares these rounded values. More...
 
enum  QofNumericMatch { QOF_NUMERIC_MATCH_DEBIT = 1, QOF_NUMERIC_MATCH_CREDIT, QOF_NUMERIC_MATCH_ANY }
 Comparisons for QOF_TYPE_NUMERIC, QOF_TYPE_DEBCRED. More...
 
enum  QofGuidMatch {
  QOF_GUID_MATCH_ANY = 1, QOF_GUID_MATCH_NONE, QOF_GUID_MATCH_NULL, QOF_GUID_MATCH_ALL,
  QOF_GUID_MATCH_LIST_ANY
}
 
enum  QofCharMatch { QOF_CHAR_MATCH_ANY = 1, QOF_CHAR_MATCH_NONE }
 A CHAR type is for a RECNCell, Comparisons for QOF_TYPE_CHAR 'ANY' will match any character in the string. More...
 

Functions

Core Data Type Predicates
QofQueryPredData * qof_query_string_predicate (QofQueryCompare how, const gchar *str, QofStringMatch options, gboolean is_regex)
 
QofQueryPredData * qof_query_date_predicate (QofQueryCompare how, QofDateMatch options, time64 date)
 
QofQueryPredData * qof_query_numeric_predicate (QofQueryCompare how, QofNumericMatch options, gnc_numeric value)
 
QofQueryPredData * qof_query_guid_predicate (QofGuidMatch options, GList *guids)
 
QofQueryPredData * qof_query_int32_predicate (QofQueryCompare how, gint32 val)
 
QofQueryPredData * qof_query_int64_predicate (QofQueryCompare how, gint64 val)
 
QofQueryPredData * qof_query_double_predicate (QofQueryCompare how, double val)
 
QofQueryPredData * qof_query_boolean_predicate (QofQueryCompare how, gboolean val)
 
QofQueryPredData * qof_query_char_predicate (QofCharMatch options, const gchar *chars)
 
QofQueryPredData * qof_query_collect_predicate (QofGuidMatch options, QofCollection *coll)
 
QofQueryPredData * qof_query_choice_predicate (QofGuidMatch options, GList *guids)
 
QofQueryPredData * qof_query_core_predicate_copy (const QofQueryPredData *pdata)
 Copy a predicate. More...
 
void qof_query_core_predicate_free (QofQueryPredData *pdata)
 Destroy a predicate. More...
 
gboolean qof_query_date_predicate_get_date (const QofQueryPredData *pd, time64 *date)
 Retrieve a predicate. More...
 
char * qof_query_core_to_string (QofType, gpointer object, QofParam *getter)
 Return a printable string for a core data object. More...
 
int qof_string_number_compare_func (gpointer a, gpointer b, gint options, QofParam *this_param)
 Compare two parameter(strings) as if they are numbers! the two objects, a and b, are the objects being compared this_param is the QofParam for this parameter in the objects.
 

Detailed Description

API for providing core Query data types.

Author
Copyright (C) 2002 Derek Atkins warlo.nosp@m.rd@M.nosp@m.IT.ED.nosp@m.U

Definition in file qofquerycore.h.