QOF  0.8.7
qofinstance-p.h
1 /********************************************************************\
2  * qofinstance-p.h -- private fields common to all object instances *
3  * *
4  * This program is free software; you can redistribute it and/or *
5  * modify it under the terms of the GNU General Public License as *
6  * published by the Free Software Foundation; either version 2 of *
7  * the License, or (at your option) any later version. *
8  * *
9  * This program is distributed in the hope that it will be useful, *
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12  * GNU General Public License for more details. *
13  * *
14  * You should have received a copy of the GNU General Public License*
15  * along with this program; if not, contact: *
16  * *
17  * Free Software Foundation Voice: +1-617-542-5942 *
18  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
19  * Boston, MA 02110-1301, USA gnu@gnu.org *
20  * *
21 \********************************************************************/
22 /*
23  * Object instance holds many common fields that most
24  * QofObjects use.
25  *
26  * Copyright (C) 2003 Linas Vepstas <linas@linas.org>
27  * Copyright 2008 Neil Williams <linux@codehelp.co.uk>
28  */
29 
30 #ifndef QOF_INSTANCE_P_H
31 #define QOF_INSTANCE_P_H
32 #include "config.h"
33 #include "qofinstance.h"
34 #include "qofclass.h"
35 
37 {
40 
43 
49 
53  const QofParam * param;
54 
63 
64  /* Keep track of nesting level of begin/end edit calls */
65  gint editlevel;
66 
67  /* In process of being destroyed */
68  gboolean do_free;
69 
70  /* dirty/clean flag. If dirty, then this instance has been modified,
71  * but has not yet been written out to storage (file/database)
72  */
73  gboolean dirty;
74 };
75 
76 /* reset the dirty flag */
77 void qof_instance_mark_clean (QofInstance *);
78 
79 void qof_instance_set_slots (QofInstance *, KvpFrame *);
80 
81 /* Set the update time. Reserved for use by the SQL backend;
82  * used for comparing version in local memory to that in remote
83  * server. The QofTime becomes the property of the instance.
84  */
85 void
86 qof_instance_set_update_time (QofInstance * inst, QofTime * time);
87 
88 #endif /* QOF_INSTANCE_P_H */
struct _KvpFrame KvpFrame
Definition: kvpframe.h:74
Object instance holds common fields that most QofObjects use.
KvpFrame * kvp_data
Definition: qofinstance-p.h:48
QofEntity entity
Definition: qofinstance-p.h:39
API for registering parameters on objects.
QofTime * update_time
Definition: qofinstance-p.h:62
struct QofTime64 QofTime
Use a 64-bit signed int QofTime.
Definition: qoftime.h:112
const QofParam * param
Definition: qofinstance-p.h:53
QofBook * book
Definition: qofinstance-p.h:42