All type declarations for the whole Gnucash engine. More...

#include <glib.h>
#include "qof.h"

Macros
#define	GNC_ID_NONE QOF_ID_NONE
	IDENTIFIERS GncGUID Identifiers can be used to reference Accounts, Transactions, Splits and other objects. These Gnucash types are referred to as Gnucash entities. GncGUID Identifiers are globally-unique and permanent, i.e., once an entity has been assigned an identifier, it retains that same identifier for its lifetime. Identifiers are 'typed' with strings. The ids used in gnucash are defined below. An id with type GNC_ID_NONE does not refer to any entity, although that may change as new ids are created. An id with type GNC_ID_NULL does not refer to any entity, and will never refer to any entity. An identifier with any other type may refer to an actual entity, but that is not guaranteed. If an id does refer to an entity, the type of the entity will match the type of the identifier.

#define	GNC_ID_BOOK QOF_ID_BOOK

#define	GNC_ID_SESSION QOF_ID_SESSION

#define	GNC_ID_NULL QOF_ID_NULL

#define	GNC_ID_ACCOUNT "Account"

#define	GNC_ID_COMMODITY "Commodity"

#define	GNC_ID_COMMODITY_NAMESPACE "CommodityNamespace"

#define	GNC_ID_COMMODITY_TABLE "CommodityTable"

#define	GNC_ID_LOT "Lot"

#define	GNC_ID_PERIOD "Period"

#define	GNC_ID_PRICE "Price"

#define	GNC_ID_PRICEDB "PriceDB"

#define	GNC_ID_SPLIT "Split"

#define	GNC_ID_BUDGET "Budget"

#define	GNC_ID_SCHEDXACTION "SchedXaction"

#define	GNC_ID_SXES "SchedXactions"

#define	GNC_ID_SXTG "SXTGroup"

#define	GNC_ID_SXTT "SXTTrans"

#define	GNC_ID_TRANS "Trans"

#define	GNC_INVOICE_ID "gncInvoice"

#define	GNC_INVOICE_GUID "invoice-guid"

#define	GNC_OWNER_ID "gncOwner"

#define	GNC_OWNER_TYPE "owner-type"

#define	GNC_OWNER_GUID "owner-guid"

#define	GNC_SX_ID "sched-xaction"

QofLogModule identifiers
#define	GNC_MOD_ROOT "gnc"

#define	GNC_MOD_ENGINE "gnc.engine"

#define	GNC_MOD_ACCOUNT "gnc.account"

#define	GNC_MOD_SX "gnc.engine.sx"

#define	GNC_MOD_QUERY "gnc.query"

#define	GNC_MOD_SCRUB "gnc.scrub"

#define	GNC_MOD_LOT "gnc.lots"

#define	GNC_MOD_COMMODITY "gnc.commodity"

#define	GNC_MOD_BACKEND "gnc.backend"

#define	GNC_MOD_PRICE "gnc.pricedb"

#define	GNC_MOD_BUSINESS "gnc.business"

#define	GNC_MOD_IO "gnc.io"

#define	GNC_MOD_BOOK "gnc.book-period"

#define	GNC_MOD_GUI "gnc.gui"

#define	GNC_MOD_GUI_SX "gnc.gui.sx"

#define	GNC_MOD_GUILE "gnc.guile"

#define	GNC_MOD_LEDGER "gnc.ledger"

#define	GNC_MOD_REGISTER "gnc.register"

#define	GNC_MOD_HTML "gnc.html"

#define	GNC_MOD_PREFS "gnc.pref"

#define	GNC_MOD_IMPORT "gnc.import"

#define	GNC_MOD_ASSISTANT "gnc.assistant"

#define	GNC_MOD_TEST "gnc.tests"

#define	GNC_MOD_BUDGET "gnc.budget"

Typedefs
typedef struct account_s	Account
	Account in Gnucash. This is the typename for an account. The actual structure is defined in the private header AccountP.h, but no one outside the engine should include that file. Instead, access that data only through the functions in Account.h .

typedef struct split_s	Split
	Split in Gnucash. A "split" is more commonly referred to as a "entry" in a "transaction". Each split belongs to one Account and one Transaction. The split is one out of several parts a Transaction is divided into. More...

typedef struct transaction_s	Transaction
	Transaction in Gnucash. A Transaction is a piece of business done; the transfer of money from one account to one or more other accounts. Each Transaction is divided into one or more Splits (usually two). More...

typedef struct gnc_commodity_s	gnc_commodity
	An article that is bought and sold. A Commodity is the most general term of what an account keeps track of. Usually this is a monetary currency, but it can also be a stock share or even a precious metal. Every account keeps track of exactly one gnc_commodity. More...

typedef struct gnc_commodity_namespace_s	gnc_commodity_namespace
	A gnc_commodity_namespace is an collection of commodities.

typedef struct gnc_commodity_table_s	gnc_commodity_table
	A gnc_commodity_table is a database of commodity info.

typedef struct gnc_lot_s	GNCLot
	Identifies that something sold at one time was bought at another. A GNCLot provides a way of tracking physical items as they are bought and sold in different transactions. By identifying the individual, underlying physical objects, it provides the needed framework for implementing depreciation, capital gains, inventory control and invoices. More...

typedef struct gnc_price_s	GNCPrice
	Price of commodity on a given date. A GNCPrice encapsulates price information: the cost of a commodity expressed as a currency, on a given date. It also holds info about the provenance of the price: where it came from, its general validity.

typedef struct gnc_quote_source_s	gnc_quote_source

typedef GList	AccountList

typedef GList	LotList

typedef GList	SplitList

typedef GList	TransList

typedef GList	AccountGUIDList

typedef GList	BookGUIDList

typedef void(*	EngineCommitErrorCallback )(gpointer data, QofBackendError errcode)

typedef gint(*	SplitCallback )(Split *s, gpointer data)

typedef gint(*	TransactionCallback )(Transaction t, void data)

typedef void(*	gnc_engine_init_hook_t )(int, char **)

Functions
void	gnc_engine_init (int argc, char **argv)

void	gnc_engine_init_static (int argc, char **argv)

void	gnc_engine_shutdown (void)

gboolean	gnc_engine_is_initialized (void)

void	gnc_log_default (void)

void	gnc_engine_add_init_hook (gnc_engine_init_hook_t hook)

void	gnc_engine_add_commit_error_callback (EngineCommitErrorCallback cb, gpointer data)

void	gnc_engine_signal_commit_error (QofBackendError errcode)

Detailed Description

All type declarations for the whole Gnucash engine.

Author: Copyright (C) 1997 Robin D. Clark; Copyright (C) 2000 Bill Gribble grib@.nosp@m.bill.nosp@m.gribb.nosp@m.le.c.nosp@m.om; Copyright (C) 2000 Dave Peticolas petic.nosp@m.ola@.nosp@m.cs.uc.nosp@m.davi.nosp@m.s.edu; Copyright (C) 1997-2001 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g

Definition in file gnc-engine.h.

Macros

Typedefs

Functions

Detailed Description