Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.

Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.

Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.

Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.

Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.

Time: 64bit UTC Time handling.
[Query Object Framework]


Detailed Description

Universal time is the 'one true time' that is independent of one's location on planet Earth. It is measured in seconds from midnight January 1, 1970 in localtime-Greenwich (GMT).

QofTime uses a signed 64bit integer to count the seconds, which differs from GTimeVal (32bit) and most other time handling routines (which only count from the epoch).

A QofTime where qt_sec == +1 therefore represents one second after midnight on 1st January 1970 - the epoch. Negative values of QofTime->qt_sec represent times before one second before midnight on 31st December 1969. Support for times before 1st Jan Year 1 are included.

Note:
GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GTime will overflow in the year 2038. (A 32bit time_t will overflow at 2038-01-19T03:14:07Z to be precise, at which point it will likely wrap around to 20:45:52 UTC on December 13, 1901.)
QofTime is defined as 64bit on all systems and will not overflow until the year 292,471,208,679 (not counting leap years). i.e. approx. 9223372036854775808 / (60*60*24*365). This 374 }

void qof_entity_set_guid ( QofEntity ent,
const GUID *  guid 
)

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.

Definition at line 92 of file qofid.c.

00093 {
00094     QofCollection *col;
00095     if (guid_equal (guid, &ent->guid))
00096         return;
00097 
00098     col = ent->collection;
00099     qof_collection_remove_entity (ent);
00100     ent->guid = *guid;
00101     qof_collection_insert_entity (col, ent);
00102 }

void qof_object_book_begin ( QofBook book  ) 

To be called from within the book

Definition at line 60 of file qofobject.c.

00061 {
00062     GList *l;
00063 
00064     if (!book)
00065         return;
00066     ENTER (" ");
00067     for (l = object_modules; l; l = l->next)
00068     {
00069         QofObject *obj = l->data;
00070         if (obj->book_begin)
00071             obj->book_begin (book);
00072     }
00073 
00074     /* Remember this book for later */
00075     book_list = g_list_prepend (book_list, book);
00076     LEAVE (" ");
00077 }

gboolean qof_object_compliance ( QofIdTypeConst  type_name,
gboolean  warn 
)

check an object can be created and supports iteration

Parameters:
type_name object to check
warn If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE.
Returns:
TRUE if object can be created and supports iteration, else FALSE.

Definition at line 155 of file qofobject.c.

00156 {
00157     const QofObject *obj;
00158 
00159     obj = qof_object_lookup (type_name);
00160     if ((obj->create == NULL) || (obj->foreach == NULL))
00161     {
00162         if (warn)
00163         {
00164             PINFO (" Object type %s is not fully QOF compliant",
00165                 obj->e_type);
00166         }
00167         return FALSE;
00168     }
00169     return TRUE;
00170 }


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOF.html0000644000000000000000000001056410750450711021233 0ustar rootroot QOF: Query Object Framework

Query Object Framework


Modules

 Book: The QOF Data Set.
 Object: Describing data structure.
 Class: Getting and setting entity values.
 Time: 64bit UTC Time handling.
 Numeric: Rational Number Handling with Rounding Error Control
 KVP: Key-Value Pairs
 Backends: Permanent storage for QOF entities.
 Query: Querying for Objects
 Error: Extensible error handling.
 Trace: Debugging support
 Event: QOF event handlers.
 Choice: One to many links.
 Merge: Merging QofBook structures
 Reference: Referring to entities outside a partial book.
 Undo: Track and undo or redo entity changes
 Utilities: Miscellany


Generated on Thu Jan 31 22:55:01 2008 for QOF by  doxygen 1.5.4
./usr/share/doc/libqof-doc/html/doxy/group__QOFTIME.html0000644000000000000000000030053310750450711021710 0ustar rootroot QOF: Time: 64bit UTC Time handling.