more documentation

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@6896 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas 2002-05-23 05:24:41 +00:00
parent 698e96e874
commit 0b360f29ea
2 changed files with 22 additions and 0 deletions

View File

@ -144,6 +144,13 @@ gnc_lot_get_slots (GNCLot *lot)
return lot->kvp_data;
}
SplitList *
gnc_lot_get_split_list (GNCLot *lot)
{
if (!lot) return NULL;
return lot->splits;
}
/* ============================================================= */
gnc_numeric

View File

@ -45,9 +45,21 @@ void gnc_lot_destroy (GNCLot *);
const GUID * gnc_lot_get_guid (GNCLot *p);
/* The gnc_lot_add_split() routine adds a split to this lot. Note
* that *all* splits in a lot must also be in the same account.
*/
void gnc_lot_add_split (GNCLot *, Split *);
void gnc_lot_remove_split (GNCLot *, Split *);
/* The gnc_lot_get_split_list() routine returns a GList of all the
* splits in this lot. Do *not* not free this list when done;
* it is a pointer straight into the lots intenal list. Do
* *not* add to or remove from this list directly. Calling
* either gnc_lot_add_split() or gnc_lot_remove_split() will
* invalidate the returned pointer.
*/
SplitList * gnc_lot_get_split_list (GNCLot *);
/* The gnc_lot_get_account() routine returns the account with which
* this lot is associated. */
Account * gnc_lot_get_account (GNCLot *);
@ -64,6 +76,9 @@ gnc_numeric gnc_lot_get_balance (GNCLot *);
*/
gboolean gnc_lot_is_closed (GNCLot *);
/* Every lot has a place to hang kvp data. This routine returns that
* place.
* */
kvp_frame * gnc_lot_get_slots (GNCLot *);
#endif /* GNC_LOT_H */