mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
Doxygen tweak
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@13569 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
@@ -46,10 +46,10 @@ Used together with QOF_EVENT_BASE to simplify creation
|
||||
of application events without interfering with any new
|
||||
events added within QOF.
|
||||
|
||||
/verbatim
|
||||
\verbatim
|
||||
#define APP_EVENT_A QOF_MAKE_EVENT(QOF_EVENT_BASE+0)
|
||||
#define APP_EVENT_B QOF_MAKE_EVENT(QOF_EVENT_BASE+1)
|
||||
/endverbatim
|
||||
\endverbatim
|
||||
*/
|
||||
#define QOF_MAKE_EVENT(x) (1<<(x))
|
||||
|
||||
@@ -61,6 +61,9 @@ event identifiers must be based on this when using QOF_MAKE_EVENT(). */
|
||||
|
||||
These defaults merely replicate previous behaviour,
|
||||
any process can define their own events.
|
||||
|
||||
\note events 5, 6, and 7 are "undefined" as of v0.6.3
|
||||
for future libqof1 or libqof2 usage.
|
||||
*/
|
||||
#define QOF_EVENT_NONE (0)
|
||||
#define QOF_EVENT_CREATE QOF_MAKE_EVENT(0)
|
||||
@@ -70,7 +73,6 @@ any process can define their own events.
|
||||
#define QOF_EVENT_REMOVE QOF_MAKE_EVENT(4)
|
||||
#define QOF_EVENT__LAST QOF_MAKE_EVENT(QOF_EVENT_BASE-1)
|
||||
#define QOF_EVENT_ALL (0xff)
|
||||
/* Note that events 5, 6, and 7 are "undefined" as of 2006-03-08 */
|
||||
|
||||
/** \brief Handler invoked when an event is generated.
|
||||
*
|
||||
@@ -102,11 +104,11 @@ void qof_event_unregister_handler (gint handler_id);
|
||||
|
||||
Certain default events are used by QOF:
|
||||
|
||||
-QOF_EVENT_DEFAULT_CREATE events should be generated after the object
|
||||
- QOF_EVENT_DEFAULT_CREATE events should be generated after the object
|
||||
has been created and registered in the engine entity table.
|
||||
-QOF_EVENT_DEFAULT_MODIFY events should be generated whenever any data
|
||||
- QOF_EVENT_DEFAULT_MODIFY events should be generated whenever any data
|
||||
member or submember (i.e., splits) is changed.
|
||||
-QOF_EVENT_DEFAULT_DESTROY events should be called before the object
|
||||
- QOF_EVENT_DEFAULT_DESTROY events should be called before the object
|
||||
has been destroyed or removed from the entity table.
|
||||
|
||||
Any other events are entirely the concern of the application.
|
||||
|
||||
Reference in New Issue
Block a user