GnuCash
5.6-150-g038405b370+
|
The GnuCash Engine provides a set of objects and classes that encapsulate typical financial accounting concepts. More...
Modules | |
Environment | |
The API in this file is used to read the environment configuration file and set up a number of environment variables based on the values found in it. | |
Generic Preference Utilities | |
The only function in this file is meant to initialize the preferences system early in the load process. | |
Account | |
Splits are grouped into Accounts which are also known as "Ledgers" in accounting practice. | |
Cap Gains | |
This file implements the various routines to automatically compute and handle Cap Gains/Losses resulting from trading activities. | |
Commodities | |
A commodity is something of value that is easily tradeable or sellable; for example, currencies, stocks, bonds, grain, copper, and oil are all commodities. | |
Lots: Core Function for AR/AP, Inventory, Stock Lots, Cap Gains | |
One often needs to know that the item 'bought' in one transaction is the same one as the item 'sold' in a different transaction. | |
Options | |
GnuCash Options System for Book, Report, and Stylesheet Options. | |
Price Database | |
The PriceDB is intended to be a database of price quotes, or more specifically, a database of GNCPrices. | |
Prices | |
Each price in the database represents an "instantaneous" quote for a given commodity with respect to another commodity. | |
Business | |
This module implements a number of basic small-business accounting functions. | |
Accounting Policy (FIFO/LIFO) | |
This file implements Accounting Policy. | |
Scheduled/Periodic/Recurring Transactions | |
Scheduled Transactions provide a framework for remembering information about a transactions that are set to occur in the future, either once or periodically. | |
Data Validation | |
Data scrubbing, repairing and forward migration routines. | |
Transaction, Split | |
A good overview of transactions, splits and accounts can be found in the texinfo documentation, together with an overview of how to use this API. | |
Transaction Logging | |
The transaction logging mechanism provides a very simple, low-level logging of user input to a file. | |
Files | |
file | gnc-engine.h |
All type declarations for the whole Gnucash engine. | |
Data Structures | |
struct | GncImapInfo |
Macros | |
#define | ACCOUNT_MATCH_ALL_TYPE "account-match-all" |
This is the type-override when you want to match all accounts. More... | |
#define | GNC_ID_NONE QOF_ID_NONE |
IDENTIFIERS GncGUID Identifiers can be used to reference Accounts, Transactions, Splits and other objects. More... | |
#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" |
STRING CONSTANTS ********************************************** Used to declare constant KVP keys used in more than one class. | |
#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" |
Typedefs | |
typedef GList | AccountList |
GList of Account. | |
typedef GList | LotList |
GList of GNCLots. | |
typedef GList | SplitList |
GList of Split. | |
typedef GList | TransList |
GList of Transaction. | |
typedef GList | AccountGUIDList |
GList of GUIDs of a Account. | |
typedef GList | BookGUIDList |
GList of GUIDs of a QofBook. | |
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 **) |
Function type for init hooks in the engine. More... | |
Enumerations | |
enum | GNCPlaceholderType { PLACEHOLDER_NONE, PLACEHOLDER_THIS, PLACEHOLDER_CHILD } |
DOCUMENT ME! | |
Functions | |
void | gnc_engine_init (int argc, char **argv) |
PROTOTYPES. More... | |
void | gnc_engine_init_static (int argc, char **argv) |
This is the statically linked-in version of gnc_engine_init. More... | |
void | gnc_engine_shutdown (void) |
Called to shutdown the engine. More... | |
gboolean | gnc_engine_is_initialized (void) |
check the engine is fully initialized | |
void | gnc_log_default (void) |
enable default log modules | |
void | gnc_engine_add_init_hook (gnc_engine_init_hook_t hook) |
Pass a function pointer to gnc_engine_add_init_hook and it will be called during the evaluation of gnc_engine_init. | |
void | gnc_engine_add_commit_error_callback (EngineCommitErrorCallback cb, gpointer data) |
Set a callback function to be called in case an engine commit fails. | |
void | gnc_engine_signal_commit_error (QofBackendError errcode) |
GncOptionValue< ValueType >::GncOptionValue (const char *section, const char *name, const char *key, const char *doc_string, ValueType value, GncOptionUIType ui_type=GncOptionUIType::INTERNAL) | |
GncOptionValue< ValueType >::GncOptionValue (const GncOptionValue &)=default | |
GncOptionValue< ValueType >::GncOptionValue (GncOptionValue &&)=default | |
GncOptionValue & | GncOptionValue< ValueType >::operator= (const GncOptionValue &)=default |
GncOptionValue & | GncOptionValue< ValueType >::operator= (GncOptionValue &&)=default |
ValueType | GncOptionValue< ValueType >::get_value () const |
ValueType | GncOptionValue< ValueType >::get_default_value () const |
void | GncOptionValue< ValueType >::set_value (ValueType new_value) |
void | GncOptionValue< ValueType >::set_default_value (ValueType new_value) |
void | GncOptionValue< ValueType >::reset_default_value () |
void | GncOptionValue< ValueType >::mark_saved () noexcept |
bool | GncOptionValue< ValueType >::is_dirty () const noexcept |
bool | GncOptionValue< ValueType >::is_changed () const noexcept |
GncOptionUIType | GncOptionValue< ValueType >::get_ui_type () const noexcept |
void | GncOptionValue< ValueType >::make_internal () |
bool | GncOptionValue< ValueType >::is_internal () |
std::string | GncOptionValue< ValueType >::serialize () const noexcept |
bool | GncOptionValue< ValueType >::deserialize (const std::string &str) noexcept |
void | GncOwnerDeleter::operator() (GncOwner *o) |
GncOptionGncOwnerValue::GncOptionGncOwnerValue (const char *section, const char *name, const char *key, const char *doc_string, const GncOwner *value, GncOptionUIType ui_type=GncOptionUIType::INTERNAL) | |
GncOptionGncOwnerValue::GncOptionGncOwnerValue (const GncOptionGncOwnerValue &from) | |
GncOptionGncOwnerValue::GncOptionGncOwnerValue (GncOptionGncOwnerValue &&)=default | |
const GncOwner * | GncOptionGncOwnerValue::get_value () const |
const GncOwner * | GncOptionGncOwnerValue::get_default_value () const |
void | GncOptionGncOwnerValue::set_value (const GncOwner *new_value) |
void | GncOptionGncOwnerValue::set_default_value (const GncOwner *new_value) |
void | GncOptionGncOwnerValue::reset_default_value () |
void | GncOptionGncOwnerValue::mark_saved () noexcept |
bool | GncOptionGncOwnerValue::is_dirty () const noexcept |
bool | GncOptionGncOwnerValue::is_changed () const noexcept |
GncOptionUIType | GncOptionGncOwnerValue::get_ui_type () const noexcept |
void | GncOptionGncOwnerValue::make_internal () |
bool | GncOptionGncOwnerValue::is_internal () |
std::string | GncOptionGncOwnerValue::serialize () const noexcept |
bool | GncOptionGncOwnerValue::deserialize (const std::string &str) noexcept |
GncOptionQofInstanceValue::GncOptionQofInstanceValue (const char *section, const char *name, const char *key, const char *doc_string, const QofInstance *value, GncOptionUIType ui_type=GncOptionUIType::INTERNAL) | |
GncOptionQofInstanceValue::GncOptionQofInstanceValue (const GncOptionQofInstanceValue &from) | |
GncOptionQofInstanceValue::GncOptionQofInstanceValue (GncOptionQofInstanceValue &&)=default | |
GncOptionQofInstanceValue & | GncOptionQofInstanceValue::operator= (GncOptionQofInstanceValue &&)=default |
const QofInstance * | GncOptionQofInstanceValue::get_value () const |
const QofInstance * | GncOptionQofInstanceValue::get_default_value () const |
GncItem | GncOptionQofInstanceValue::get_item () const |
GncItem | GncOptionQofInstanceValue::get_default_item () const |
void | GncOptionQofInstanceValue::set_value (const QofInstance *new_value) |
void | GncOptionQofInstanceValue::set_default_value (const QofInstance *new_value) |
void | GncOptionQofInstanceValue::reset_default_value () |
void | GncOptionQofInstanceValue::mark_saved () noexcept |
bool | GncOptionQofInstanceValue::is_dirty () const noexcept |
bool | GncOptionQofInstanceValue::is_changed () const noexcept |
GncOptionUIType | GncOptionQofInstanceValue::get_ui_type () const noexcept |
void | GncOptionQofInstanceValue::make_internal () |
bool | GncOptionQofInstanceValue::is_internal () |
std::string | GncOptionQofInstanceValue::serialize () const noexcept |
bool | GncOptionQofInstanceValue::deserialize (const std::string &str) noexcept |
GncOptionCommodityValue::GncOptionCommodityValue (const char *section, const char *name, const char *key, const char *doc_string, gnc_commodity *value, GncOptionUIType ui_type=GncOptionUIType::COMMODITY) | |
GncOptionCommodityValue::GncOptionCommodityValue (const GncOptionCommodityValue &)=default | |
GncOptionCommodityValue::GncOptionCommodityValue (GncOptionCommodityValue &&)=default | |
GncOptionCommodityValue & | GncOptionCommodityValue::operator= (const GncOptionCommodityValue &)=default |
GncOptionCommodityValue & | GncOptionCommodityValue::operator= (GncOptionCommodityValue &&)=default |
gnc_commodity * | GncOptionCommodityValue::get_value () const |
gnc_commodity * | GncOptionCommodityValue::get_default_value () const |
bool | GncOptionCommodityValue::validate (gnc_commodity *) const noexcept |
void | GncOptionCommodityValue::set_value (gnc_commodity *value) |
void | GncOptionCommodityValue::set_default_value (gnc_commodity *value) |
void | GncOptionCommodityValue::reset_default_value () |
void | GncOptionCommodityValue::mark_saved () noexcept |
bool | GncOptionCommodityValue::is_dirty () const noexcept |
bool | GncOptionCommodityValue::is_changed () const noexcept |
GncOptionUIType | GncOptionCommodityValue::get_ui_type () const noexcept |
void | GncOptionCommodityValue::make_internal () |
bool | GncOptionCommodityValue::is_internal () |
std::string | GncOptionCommodityValue::serialize () const noexcept |
bool | GncOptionCommodityValue::deserialize (const std::string &str) noexcept |
GncOptionRangeValue< ValueType >::GncOptionRangeValue (const char *section, const char *name, const char *key, const char *doc_string, ValueType value, ValueType min, ValueType max, ValueType step) | |
GncOptionRangeValue< ValueType >::GncOptionRangeValue (const char *section, const char *name, const char *key, const char *doc_string, ValueType value, ValueType min, ValueType max, ValueType step, GncOptionUIType ui) | |
GncOptionRangeValue< ValueType >::GncOptionRangeValue (const GncOptionRangeValue< ValueType > &)=default | |
GncOptionRangeValue< ValueType >::GncOptionRangeValue (GncOptionRangeValue< ValueType > &&)=default | |
GncOptionRangeValue< ValueType > & | GncOptionRangeValue< ValueType >::operator= (const GncOptionRangeValue< ValueType > &)=default |
GncOptionRangeValue< ValueType > & | GncOptionRangeValue< ValueType >::operator= (GncOptionRangeValue< ValueType > &&)=default |
ValueType | GncOptionRangeValue< ValueType >::get_value () const |
ValueType | GncOptionRangeValue< ValueType >::get_default_value () const |
bool | GncOptionRangeValue< ValueType >::validate (ValueType value) |
void | GncOptionRangeValue< ValueType >::set_value (ValueType value) |
void | GncOptionRangeValue< ValueType >::set_default_value (ValueType value) |
void | GncOptionRangeValue< ValueType >::get_limits (ValueType &upper, ValueType &lower, ValueType &step) const noexcept |
void | GncOptionRangeValue< ValueType >::reset_default_value () |
void | GncOptionRangeValue< ValueType >::mark_saved () noexcept |
bool | GncOptionRangeValue< ValueType >::is_dirty () const noexcept |
bool | GncOptionRangeValue< ValueType >::is_changed () const noexcept |
GncOptionUIType | GncOptionRangeValue< ValueType >::get_ui_type () const noexcept |
void | GncOptionRangeValue< ValueType >::make_internal () |
bool | GncOptionRangeValue< ValueType >::is_internal () |
bool | GncOptionRangeValue< ValueType >::is_alternate () const noexcept |
void | GncOptionRangeValue< ValueType >::set_alternate (bool value) noexcept |
std::string | GncOptionRangeValue< ValueType >::serialize () const noexcept |
bool | GncOptionRangeValue< ValueType >::deserialize (const std::string &str) noexcept |
GncOptionMultichoiceValue::GncOptionMultichoiceValue (const char *section, const char *name, const char *key, const char *doc_string, const char *value, GncMultichoiceOptionChoices &&choices, GncOptionUIType ui_type=GncOptionUIType::MULTICHOICE) | |
GncOptionMultichoiceValue::GncOptionMultichoiceValue (const char *section, const char *name, const char *key, const char *doc_string, uint16_t index, GncMultichoiceOptionChoices &&choices, GncOptionUIType ui_type=GncOptionUIType::MULTICHOICE) | |
GncOptionMultichoiceValue::GncOptionMultichoiceValue (const char *section, const char *name, const char *key, const char *doc_string, GncMultichoiceOptionIndexVec &&indices, GncMultichoiceOptionChoices &&choices, GncOptionUIType ui_type=GncOptionUIType::LIST) | |
GncOptionMultichoiceValue::GncOptionMultichoiceValue (const GncOptionMultichoiceValue &)=default | |
GncOptionMultichoiceValue::GncOptionMultichoiceValue (GncOptionMultichoiceValue &&)=default | |
GncOptionMultichoiceValue & | GncOptionMultichoiceValue::operator= (const GncOptionMultichoiceValue &)=default |
GncOptionMultichoiceValue & | GncOptionMultichoiceValue::operator= (GncOptionMultichoiceValue &&)=default |
const std::string & | GncOptionMultichoiceValue::get_value () const |
const std::string & | GncOptionMultichoiceValue::get_default_value () const |
uint16_t | GncOptionMultichoiceValue::get_index () const |
const GncMultichoiceOptionIndexVec & | GncOptionMultichoiceValue::get_multiple () const noexcept |
const GncMultichoiceOptionIndexVec & | GncOptionMultichoiceValue::get_default_multiple () const noexcept |
bool | GncOptionMultichoiceValue::validate (const std::string &value) const noexcept |
bool | GncOptionMultichoiceValue::validate (const GncMultichoiceOptionIndexVec &indexes) const noexcept |
void | GncOptionMultichoiceValue::set_value (const std::string &value) |
void | GncOptionMultichoiceValue::set_value (uint16_t index) |
void | GncOptionMultichoiceValue::set_default_value (const std::string &value) |
void | GncOptionMultichoiceValue::set_default_value (uint16_t index) |
void | GncOptionMultichoiceValue::set_multiple (const GncMultichoiceOptionIndexVec &indexes) |
void | GncOptionMultichoiceValue::set_default_multiple (const GncMultichoiceOptionIndexVec &indexes) |
uint16_t | GncOptionMultichoiceValue::num_permissible_values () const noexcept |
uint16_t | GncOptionMultichoiceValue::permissible_value_index (const char *key) const noexcept |
const char * | GncOptionMultichoiceValue::permissible_value (uint16_t index) const |
const char * | GncOptionMultichoiceValue::permissible_value_name (uint16_t index) const |
void | GncOptionMultichoiceValue::reset_default_value () |
void | GncOptionMultichoiceValue::mark_saved () noexcept |
bool | GncOptionMultichoiceValue::is_dirty () const noexcept |
bool | GncOptionMultichoiceValue::is_changed () const noexcept |
GncOptionUIType | GncOptionMultichoiceValue::get_ui_type () const noexcept |
void | GncOptionMultichoiceValue::make_internal () |
bool | GncOptionMultichoiceValue::is_internal () |
GncOptionMultichoiceKeyType | GncOptionMultichoiceValue::get_keytype (unsigned i) const |
std::string | GncOptionMultichoiceValue::serialize () const noexcept |
bool | GncOptionMultichoiceValue::deserialize (const std::string &str) noexcept |
GncOptionAccountListValue::GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, bool multi=true) | |
GncOptionAccountListValue::GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const GncOptionAccountList &value, bool multi=true) | |
GncOptionAccountListValue::GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, GncOptionAccountTypeList &&allowed, bool multi=true) | |
GncOptionAccountListValue::GncOptionAccountListValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const GncOptionAccountList &value, GncOptionAccountTypeList &&allowed, bool multi=true) | |
GncOptionAccountList | GncOptionAccountListValue::get_value () const |
GncOptionAccountList | GncOptionAccountListValue::get_default_value () const |
bool | GncOptionAccountListValue::validate (const GncOptionAccountList &values) const |
void | GncOptionAccountListValue::set_value (GncOptionAccountList values) |
void | GncOptionAccountListValue::set_default_value (GncOptionAccountList values) |
GList * | GncOptionAccountListValue::account_type_list () const noexcept |
Create a GList of account types to pass to gnc_account_sel_set_acct_filters. More... | |
void | GncOptionAccountListValue::reset_default_value () |
void | GncOptionAccountListValue::mark_saved () noexcept |
bool | GncOptionAccountListValue::is_dirty () const noexcept |
bool | GncOptionAccountListValue::is_changed () const noexcept |
GncOptionUIType | GncOptionAccountListValue::get_ui_type () const noexcept |
void | GncOptionAccountListValue::make_internal () |
bool | GncOptionAccountListValue::is_internal () |
bool | GncOptionAccountListValue::is_multiselect () const noexcept |
std::string | GncOptionAccountListValue::serialize () const noexcept |
bool | GncOptionAccountListValue::deserialize (const std::string &str) noexcept |
GncOptionAccountSelValue::GncOptionAccountSelValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type) | |
GncOptionAccountSelValue::GncOptionAccountSelValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const Account *value) | |
GncOptionAccountSelValue::GncOptionAccountSelValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, GncOptionAccountTypeList &&allowed) | |
GncOptionAccountSelValue::GncOptionAccountSelValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const Account *value, GncOptionAccountTypeList &&allowed) | |
const Account * | GncOptionAccountSelValue::get_value () const |
const Account * | GncOptionAccountSelValue::get_default_value () const |
bool | GncOptionAccountSelValue::validate (const Account *value) const |
void | GncOptionAccountSelValue::set_value (const Account *value) |
void | GncOptionAccountSelValue::set_default_value (const Account *value) |
GList * | GncOptionAccountSelValue::account_type_list () const noexcept |
Create a GList of account types to pass to gnc_account_sel_set_acct_filters. More... | |
void | GncOptionAccountSelValue::reset_default_value () |
void | GncOptionAccountSelValue::mark_saved () noexcept |
bool | GncOptionAccountSelValue::is_dirty () const noexcept |
bool | GncOptionAccountSelValue::is_changed () const noexcept |
GncOptionUIType | GncOptionAccountSelValue::get_ui_type () const noexcept |
void | GncOptionAccountSelValue::make_internal () |
bool | GncOptionAccountSelValue::is_internal () |
std::string | GncOptionAccountSelValue::serialize () const noexcept |
bool | GncOptionAccountSelValue::deserialize (const std::string &str) noexcept |
GncOptionDateValue::GncOptionDateValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type) | |
GncOptionDateValue::GncOptionDateValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, time64 time) | |
GncOptionDateValue::GncOptionDateValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, RelativeDatePeriod period) | |
GncOptionDateValue::GncOptionDateValue (const char *section, const char *name, const char *key, const char *doc_string, GncOptionUIType ui_type, const RelativeDatePeriodVec &period_set) | |
GncOptionDateValue::GncOptionDateValue (const GncOptionDateValue &)=default | |
GncOptionDateValue::GncOptionDateValue (GncOptionDateValue &&)=default | |
GncOptionDateValue & | GncOptionDateValue::operator= (const GncOptionDateValue &)=default |
GncOptionDateValue & | GncOptionDateValue::operator= (GncOptionDateValue &&)=default |
time64 | GncOptionDateValue::get_value () const noexcept |
time64 | GncOptionDateValue::get_default_value () const noexcept |
RelativeDatePeriod | GncOptionDateValue::get_period () const noexcept |
RelativeDatePeriod | GncOptionDateValue::get_default_period () const noexcept |
uint16_t | GncOptionDateValue::get_period_index () const noexcept |
uint16_t | GncOptionDateValue::get_default_period_index () const noexcept |
std::ostream & | GncOptionDateValue::out_stream (std::ostream &oss) const noexcept |
std::istream & | GncOptionDateValue::in_stream (std::istream &iss) |
bool | GncOptionDateValue::validate (RelativeDatePeriod value) |
bool | GncOptionDateValue::validate (time64 time) |
void | GncOptionDateValue::set_value (RelativeDatePeriod value) |
void | GncOptionDateValue::set_value (time64 time) |
void | GncOptionDateValue::set_value (uint16_t index) noexcept |
void | GncOptionDateValue::set_default_value (RelativeDatePeriod value) |
void | GncOptionDateValue::set_default_value (time64 time) |
uint16_t | GncOptionDateValue::num_permissible_values () const noexcept |
uint16_t | GncOptionDateValue::permissible_value_index (const char *key) const noexcept |
const char * | GncOptionDateValue::permissible_value (uint16_t index) const |
const char * | GncOptionDateValue::permissible_value_name (uint16_t index) const |
void | GncOptionDateValue::reset_default_value () |
void | GncOptionDateValue::mark_saved () noexcept |
bool | GncOptionDateValue::is_dirty () const noexcept |
bool | GncOptionDateValue::is_changed () const noexcept |
GncOptionUIType | GncOptionDateValue::get_ui_type () const noexcept |
void | GncOptionDateValue::make_internal () |
bool | GncOptionDateValue::is_internal () |
const RelativeDatePeriodVec & | GncOptionDateValue::get_period_set () const |
std::string | GncOptionDateValue::serialize () const noexcept |
bool | GncOptionDateValue::deserialize (const std::string &str) noexcept |
template<typename OptionType , typename std::enable_if_t< is_OptionClassifier_v< OptionType >, int > = 0> | |
GncOption::GncOption (OptionType option) | |
template<typename ValueType , typename std::enable_if_t<!is_OptionClassifier_v< ValueType >, int > = 0> | |
GncOption::GncOption (const char *section, const char *name, const char *key, const char *doc_string, ValueType value, GncOptionUIType ui_type=GncOptionUIType::INTERNAL) | |
template<typename ValueType > | |
void | GncOption::set_value (ValueType value) |
template<typename ValueType > | |
void | GncOption::set_default_value (ValueType value) |
template<typename ValueType > | |
ValueType | GncOption::get_default_value () const |
template<typename ValueType > | |
ValueType | GncOption::get_value () const |
void | GncOption::reset_default_value () |
const std::string & | GncOption::get_section () const |
const std::string & | GncOption::get_name () const |
const std::string & | GncOption::get_key () const |
const std::string & | GncOption::get_docstring () const |
void | GncOption::set_ui_item (GncOptionUIItemPtr &&ui_elem) |
const GncOptionUIType | GncOption::get_ui_type () const |
void | GncOption::set_ui_item_selectable (bool) const noexcept |
GncOptionUIItem *const | GncOption::get_ui_item () const |
void | GncOption::set_ui_item_from_option () |
void | GncOption::set_option_from_ui_item () |
void | GncOption::make_internal () |
bool | GncOption::is_internal () |
void | GncOption::mark_saved () noexcept |
Mark the option as needing to be saved. More... | |
bool | GncOption::is_dirty () const noexcept |
bool | GncOption::is_changed () const noexcept |
bool | GncOption::is_multiselect () const noexcept |
template<typename ValueType > | |
void | GncOption::get_limits (ValueType &, ValueType &, ValueType &) const noexcept |
Implemented only for GncOptionNumericRange. | |
template<typename ValueType > | |
bool | GncOption::validate (ValueType value) const |
Not implemented for GncOptionValue. More... | |
uint16_t | GncOption::num_permissible_values () const |
Implemented only for GncOptionMultiselectValue. More... | |
uint16_t | GncOption::permissible_value_index (const char *value) const |
Implemented only for GncOptionMultiselectValue. More... | |
const char * | GncOption::permissible_value (uint16_t index) const |
Implemented only for GncOptionMultiselectValue. More... | |
const char * | GncOption::permissible_value_name (uint16_t index) const |
Implemented only for GncOptionMultiselectValue. More... | |
GList * | GncOption::account_type_list () const noexcept |
Implemented only for GncOptionAccountListValue. More... | |
bool | GncOption::is_alternate () const noexcept |
void | GncOption::set_alternate (bool) noexcept |
std::string | GncOption::serialize () const |
Get a string suitable for storage representing the option's value. More... | |
bool | GncOption::deserialize (const std::string &str) |
Set the option's value from a character sequence. More... | |
std::istream & | GncOption::in_stream (std::istream &iss) |
Set the option's value from an input stream. More... | |
void | GncOption::set_widget_changed (std::any cb) |
std::any & | GncOption::get_widget_changed () |
GncOptionSection::GncOptionSection (const char *name) | |
void | GncOptionSection::foreach_option (std::function< void(GncOption &)> func) |
void | GncOptionSection::foreach_option (std::function< void(const GncOption &)> func) const |
const std::string & | GncOptionSection::get_name () const noexcept |
size_t | GncOptionSection::get_num_options () const noexcept |
void | GncOptionSection::add_option (GncOption &&option) |
void | GncOptionSection::remove_option (const char *name) |
const GncOption * | GncOptionSection::find_option (const char *name) const |
GncOptionDBCallback::GncOptionDBCallback (size_t id, GncOptionDBChangeCallback func, void *data) | |
GncOptionDBCallback::GncOptionDBCallback (const GncOptionDBCallback &)=delete | |
GncOptionDBCallback::GncOptionDBCallback (GncOptionDBCallback &&)=default | |
GncOptionDBCallback & | GncOptionDBCallback::operator= (const GncOptionDBCallback &)=default |
GncOptionDBCallback & | GncOptionDBCallback::operator= (GncOptionDBCallback &&)=default |
GncOptionDB::GncOptionDB (QofBook *book) | |
void | GncOptionDB::foreach_section (std::function< void(GncOptionSectionPtr &)> func) |
void | GncOptionDB::foreach_section (std::function< void(const GncOptionSectionPtr &)> func) const |
size_t | GncOptionDB::num_sections () const noexcept |
bool | GncOptionDB::get_changed () const noexcept |
void | GncOptionDB::register_option (const char *section, GncOption &&option) |
void | GncOptionDB::register_option (const char *section, GncOption *option) |
void | GncOptionDB::unregister_option (const char *section, const char *name) |
void | GncOptionDB::set_default_section (const char *section) |
const GncOptionSection *const | GncOptionDB::get_default_section () const noexcept |
std::string | GncOptionDB::lookup_string_option (const char *section, const char *name) |
bool | GncOptionDB::set_string_option (const char *section, const char *name, const std::string &value) |
template<typename ValueType > | |
bool | GncOptionDB::set_option (const char *section, const char *name, ValueType value) |
void | GncOptionDB::make_internal (const char *section, const char *name) |
void | GncOptionDB::commit () |
GncOptionSection * | GncOptionDB::find_section (const std::string §name) |
const GncOptionSection * | GncOptionDB::find_section (const std::string §name) const |
GncOption * | GncOptionDB::find_option (const std::string §ion, const char *name) |
const GncOption * | GncOptionDB::find_option (const std::string §ion, const char *name) const |
std::ostream & | GncOptionDB::save_to_key_value (std::ostream &oss) const noexcept |
std::istream & | GncOptionDB::load_from_key_value (std::istream &iss) |
void | GncOptionDB::save_to_kvp (QofBook *book, bool clear_book) const noexcept |
void | GncOptionDB::load_from_kvp (QofBook *book) noexcept |
std::ostream & | GncOptionDB::save_option_key_value (std::ostream &oss, const std::string §ion, const std::string &name) const noexcept |
std::istream & | GncOptionDB::load_option_key_value (std::istream &iss) |
size_t | GncOptionDB::register_callback (GncOptionDBChangeCallback, void *) |
void | GncOptionDB::unregister_callback (size_t) |
void | GncOptionDB::run_callbacks () |
Friends | |
GncOptionVariant & | GncOption::swig_get_option (GncOption *) |
Lookup Accounts and Subaccounts by name or code | |
Account * | gnc_account_lookup_by_name (const Account *parent, const char *name) |
The gnc_account_lookup_by_name() subroutine fetches the account by name from the descendants of the specified account. More... | |
Account * | gnc_account_lookup_by_full_name (const Account *any_account, const gchar *name) |
The gnc_account_lookup_full_name() subroutine works like gnc_account_lookup_by_name, but uses fully-qualified names using the given separator. | |
Account * | gnc_account_lookup_by_code (const Account *parent, const char *code) |
The gnc_account_lookup_by_code() subroutine works like gnc_account_lookup_by_name, but uses the account code. | |
Account * | gnc_account_lookup_by_opening_balance (Account *account, gnc_commodity *commodity) |
Find the opening balance account for the currency. More... | |
GList * | gnc_account_lookup_by_type_and_commodity (Account *root, const char *name, GNCAccountType acctype, gnc_commodity *commodity) |
Find a direct child account matching name, GNCAccountType, and/or commodity. More... | |
GNCAccountType conversion/checking | |
const char * | xaccAccountTypeEnumAsString (GNCAccountType type) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications. More... | |
gboolean | xaccAccountStringToType (const char *str, GNCAccountType *type) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications. More... | |
GNCAccountType | xaccAccountStringToEnum (const char *str) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications. More... | |
const char * | xaccAccountGetTypeStr (GNCAccountType type) |
The xaccAccountGetTypeStr() routine returns a string suitable for use in the GUI/Interface. More... | |
guint32 | xaccAccountTypesCompatibleWith (GNCAccountType type) |
Return the bitmask of account types compatible with a given type. More... | |
guint32 | xaccParentAccountTypesCompatibleWith (GNCAccountType type) |
Return the bitmask of parent account types compatible with a given type. More... | |
gboolean | xaccAccountTypesCompatible (GNCAccountType parent_type, GNCAccountType child_type) |
Return TRUE if accounts of type parent_type can have accounts of type child_type as children. More... | |
guint32 | xaccAccountTypesValid (void) |
Returns the bitmask of the account type enums that are valid. More... | |
gboolean | xaccAccountIsAssetLiabType (GNCAccountType t) |
Convenience function to check if the account is a valid Asset or Liability type, but not a business account type (meaning not an Accounts Payable/Accounts Receivable). More... | |
GNCAccountType | xaccAccountTypeGetFundamental (GNCAccountType t) |
Convenience function to return the fundamental type asset/liability/income/expense/equity given an account type. More... | |
gboolean | xaccAccountIsAPARType (GNCAccountType t) |
Convenience function to check if the account is a valid business account type (meaning an Accounts Payable/Accounts Receivable). More... | |
gboolean | xaccAccountIsEquityType (GNCAccountType t) |
Convenience function to check if the account is a valid Equity type. More... | |
Account split/transaction list management | |
SplitList * | xaccAccountGetSplitList (const Account *account) |
The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account. More... | |
size_t | xaccAccountGetSplitsSize (const Account *account) |
void | xaccAccountMoveAllSplits (Account *accfrom, Account *accto) |
The xaccAccountMoveAllSplits() routine reassigns each of the splits in accfrom to accto. More... | |
gint | xaccAccountForEachTransaction (const Account *account, TransactionCallback proc, void *data) |
The xaccAccountForEachTransaction() routine will traverse all of the transactions in account and call the callback function proc on each transaction. More... | |
Transaction * | xaccAccountFindTransByDesc (const Account *account, const char *description) |
Returns a pointer to the transaction, not a copy. More... | |
Split * | xaccAccountFindSplitByDesc (const Account *account, const char *description) |
Returns a pointer to the split, not a copy. More... | |
#define | xaccAccountInsertSplit(acc, s) xaccSplitSetAccount((s), (acc)) |
The xaccAccountInsertSplit() method will insert the indicated split into the indicated account. More... | |
Account lots | |
void | xaccAccountInsertLot (Account *, GNCLot *) |
The xaccAccountInsertLot() method will register the indicated lot with this account. More... | |
void | xaccAccountRemoveLot (Account *, GNCLot *) |
LotList * | xaccAccountGetLotList (const Account *account) |
The xaccAccountGetLotList() routine returns a list of all lots in this account. More... | |
gpointer | xaccAccountForEachLot (const Account *acc, gpointer(*proc)(GNCLot *lot, gpointer user_data), gpointer user_data) |
The xaccAccountForEachLot() method will apply the function 'proc' to each lot in the account. More... | |
LotList * | xaccAccountFindOpenLots (const Account *acc, gboolean(*match_func)(GNCLot *lot, gpointer user_data), gpointer user_data, GCompareFunc sort_func) |
Find a list of open lots that match the match_func. More... | |
Account Reconciliation information getters/setters | |
gboolean | xaccAccountGetReconcileLastDate (const Account *account, time64 *last_date) |
DOCUMENT ME! | |
void | xaccAccountSetReconcileLastDate (Account *account, time64 last_date) |
DOCUMENT ME! | |
gboolean | xaccAccountGetReconcileLastInterval (const Account *account, int *months, int *days) |
DOCUMENT ME! | |
void | xaccAccountSetReconcileLastInterval (Account *account, int months, int days) |
DOCUMENT ME! | |
gboolean | xaccAccountGetReconcilePostponeDate (const Account *account, time64 *postpone_date) |
DOCUMENT ME! | |
void | xaccAccountSetReconcilePostponeDate (Account *account, time64 postpone_date) |
DOCUMENT ME! | |
gboolean | xaccAccountGetReconcilePostponeBalance (const Account *account, gnc_numeric *balance) |
DOCUMENT ME! | |
void | xaccAccountSetReconcilePostponeBalance (Account *account, gnc_numeric balance) |
DOCUMENT ME! | |
void | xaccAccountClearReconcilePostpone (Account *account) |
DOCUMENT ME! | |
Account Balance Limits | |
gboolean | xaccAccountGetHigherBalanceLimit (const Account *account, gnc_numeric *balance) |
Get the higher balance limit for the account. More... | |
void | xaccAccountSetHigherBalanceLimit (Account *account, gnc_numeric balance) |
Set the higher balance limit for the account. More... | |
void | xaccAccountClearHigherBalanceLimit (Account *account) |
Clear the higher balance limit for the account. More... | |
gboolean | xaccAccountGetLowerBalanceLimit (const Account *account, gnc_numeric *balance) |
Get the lower balance limit for the account. More... | |
void | xaccAccountSetLowerBalanceLimit (Account *account, gnc_numeric balance) |
Set the lower balance limit for the account. More... | |
void | xaccAccountClearLowerBalanceLimit (Account *account) |
Clear the lower balance limit for the account. More... | |
gboolean | xaccAccountGetIncludeSubAccountBalances (const Account *account) |
Get whether to include balances of sub accounts. More... | |
void | xaccAccountSetIncludeSubAccountBalances (Account *account, gboolean include) |
Set whether to include balances of sub accounts. More... | |
Account Placeholder flag | |
gboolean | xaccAccountGetPlaceholder (const Account *account) |
Get the "placeholder" flag for an account. More... | |
void | xaccAccountSetPlaceholder (Account *account, gboolean val) |
Set the "placeholder" flag for an account. More... | |
Account Append Text flag | |
gboolean | xaccAccountGetAppendText (const Account *account) |
Get the "import-append-text" flag for an account. More... | |
void | xaccAccountSetAppendText (Account *account, gboolean val) |
Set the "import-append-text" flag for an account. More... | |
gboolean | xaccAccountGetIsOpeningBalance (const Account *account) |
Get the "opening-balance" flag for an account. More... | |
void | xaccAccountSetIsOpeningBalance (Account *account, gboolean val) |
Set the "opening-balance" flag for an account. More... | |
GNCPlaceholderType | xaccAccountGetDescendantPlaceholder (const Account *account) |
Returns PLACEHOLDER_NONE if account is NULL or neither account nor any descendant of account is a placeholder. More... | |
Account Hidden flag | |
gboolean | xaccAccountGetHidden (const Account *acc) |
Get the "hidden" flag for an account. More... | |
void | xaccAccountSetHidden (Account *acc, gboolean val) |
Set the "hidden" flag for an account. More... | |
gboolean | xaccAccountIsHidden (const Account *acc) |
Should this account be "hidden". More... | |
Account Auto Interest flag | |
gboolean | xaccAccountGetAutoInterest (const Account *acc) |
Get the "auto interest" flag for an account. More... | |
void | xaccAccountSetAutoInterest (Account *acc, gboolean val) |
Set the "auto interest" flag for an account. More... | |
Account Tax related getters/setters | |
gboolean | xaccAccountGetTaxRelated (const Account *account) |
DOCUMENT ME! | |
void | xaccAccountSetTaxRelated (Account *account, gboolean tax_related) |
DOCUMENT ME! | |
const char * | xaccAccountGetTaxUSCode (const Account *account) |
DOCUMENT ME! | |
void | xaccAccountSetTaxUSCode (Account *account, const char *code) |
DOCUMENT ME! | |
const char * | xaccAccountGetTaxUSPayerNameSource (const Account *account) |
DOCUMENT ME! | |
void | xaccAccountSetTaxUSPayerNameSource (Account *account, const char *source) |
DOCUMENT ME! | |
gint64 | xaccAccountGetTaxUSCopyNumber (const Account *account) |
DOCUMENT ME! | |
void | xaccAccountSetTaxUSCopyNumber (Account *account, gint64 copy_number) |
DOCUMENT ME! | |
Account type debit/credit string getters | |
const char * | gnc_account_get_debit_string (GNCAccountType acct_type) |
Get the debit string associated with this account type. | |
const char * | gnc_account_get_credit_string (GNCAccountType acct_type) |
Get the credit string associated with this account type. | |
Account marking | |
void | xaccAccountSetMark (Account *account, short mark) |
Set a mark on the account. More... | |
void | xaccClearMark (Account *account, short val) |
Get the mark set by xaccAccountSetMark short xaccAccountGetMark (const Account *account);. More... | |
void | xaccClearMarkDown (Account *account, short val) |
The xaccClearMarkDown will clear the mark only in this and in sub-accounts. More... | |
Staged Traversal | |
The following functions provide support for "staged traversals" over all of the transactions in an account or group. The idea is to be able to perform a sequence of traversals ("stages"), and perform an operation on each transaction exactly once for that stage. Only transactions whose current "stage" is less than the stage of the current traversal will be affected, and they will be "brought up" to the current stage when they are processed. For example, you could perform a stage 1 traversal of all the transactions in an account, and then perform a stage 1 traversal of the transactions in a second account. Presuming the traversal of the first account didn't abort prematurely, any transactions shared by both accounts would be ignored during the traversal of the second account since they had been processed while traversing the first account. However, if you had traversed the second account using a stage of 2, then all the transactions in the second account would have been processed. Traversal can be aborted by having the callback function return a non-zero value. The traversal is aborted immediately, and the non-zero value is returned. Note that an aborted traversal can be restarted; no information is lost due to an abort. The initial impetus for this particular approach came from generalizing a mark/sweep practice that was already being used in FileIO.c. Note that currently, there is a hard limit of 256 stages, which can be changed by enlarging "marker" in the transaction struct. | |
void | gnc_account_tree_begin_staged_transaction_traversals (Account *acc) |
gnc_account_tree_begin_staged_transaction_traversals() resets the traversal marker inside every transactions of every account in the account tree originating with the specified node. More... | |
void | xaccAccountBeginStagedTransactionTraversals (const Account *account) |
xaccAccountBeginStagedTransactionTraversals() resets the traversal marker for each transaction which is a parent of one of the splits in the account. | |
gboolean | xaccTransactionTraverse (Transaction *trans, int stage) |
xaccTransactionTraverse() checks the stage of the given transaction. More... | |
int | xaccAccountStagedTransactionTraversal (const Account *a, unsigned int stage, TransactionCallback thunk, void *data) |
xaccAccountStagedTransactionTraversal() calls thunk on each transaction in account a whose current marker is less than the given stage and updates each transaction's marker to be stage. More... | |
int | gnc_account_tree_staged_transaction_traversal (const Account *account, unsigned int stage, TransactionCallback thunk, void *data) |
gnc_account_tree_staged_transaction_traversal() calls thunk on each transaction in the group whose current marker is less than the given stage and updates each transaction's marker to be stage. More... | |
int | xaccAccountTreeForEachTransaction (Account *acc, TransactionCallback proc, void *data) |
Traverse all of the transactions in the given account group. More... | |
Account * | gnc_account_imap_find_account (Account *acc, const char *category, const char *key) |
Account * | gnc_account_imap_find_any (QofBook *book, const char *category, const char *key) |
void | gnc_account_imap_add_account (Account *acc, const char *category, const char *key, Account *added_acc) |
void | gnc_account_imap_delete_account (Account *acc, const char *category, const char *key) |
Account * | gnc_account_imap_find_account_bayes (Account *acc, GList *tokens) |
Look up an Account in the map using Baysian. More... | |
void | gnc_account_imap_add_account_bayes (Account *acc, GList *tokens, Account *added_acc) |
Updates the imap for a given account using a list of tokens. | |
void | gnc_account_imap_info_destroy (GncImapInfo *) |
Clean destructor for the imap_info structure of Bayesian mappings. | |
GList * | gnc_account_imap_get_info_bayes (Account *acc) |
Returns a GList of structure imap_info of all Bayesian mappings for required Account. | |
GList * | gnc_account_imap_get_info (Account *acc, const char *category) |
Returns a GList of structure imap_info of all Non Bayesian mappings for required Account. | |
gchar * | gnc_account_get_map_entry (Account *acc, const char *head, const char *category) |
Returns the text string pointed to by head and category for the Account, free the returned text. | |
void | gnc_account_delete_map_entry (Account *acc, char *head, char *category, char *match_string, gboolean empty) |
Delete the entry for Account pointed to by head,category and match_string, if empty is TRUE then use delete if empty. | |
void | gnc_account_delete_all_bayes_maps (Account *acc) |
Delete all bayes entries for Account. | |
void | gnc_account_reset_convert_bayes_to_flat (void) |
Reset the flag that indicates the function imap_convert_bayes_to_flat has been run. | |
Deprecated Routines. | |
void | DxaccAccountSetCurrency (Account *account, gnc_commodity *currency) |
gnc_commodity * | DxaccAccountGetCurrency (const Account *account) |
void | dxaccAccountSetQuoteTZ (Account *account, const char *tz) |
Set the timezone to be used when interpreting the results from a given Finance::Quote backend. More... | |
const char * | dxaccAccountGetQuoteTZ (const Account *account) |
Get the timezone to be used when interpreting the results from a given Finance::Quote backend. More... | |
The GnuCash Engine provides a set of objects and classes that encapsulate typical financial accounting concepts.
The GnuCash GUI is expected to manipulate these objects through the provided engine API.
#define ACCOUNT_MATCH_ALL_TYPE "account-match-all" |
#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.
Definition at line 91 of file gnc-engine.h.
#define xaccAccountInsertSplit | ( | acc, | |
s | |||
) | xaccSplitSetAccount((s), (acc)) |
The xaccAccountInsertSplit() method will insert the indicated split into the indicated account.
If the split already belongs to another account, it will be removed from that account first.
typedef void(* gnc_engine_init_hook_t) (int, char **) |
Function type for init hooks in the engine.
Definition at line 221 of file gnc-engine.h.
|
noexcept |
Implemented only for GncOptionAccountListValue.
Definition at line 414 of file gnc-option.cpp.
|
noexcept |
Create a GList of account types to pass to gnc_account_sel_set_acct_filters.
gnc_account_sel_set_acct_filters copies the list so the intermediary caller is responsible for freeing the list.
Definition at line 462 of file gnc-option-impl.cpp.
|
noexcept |
Create a GList of account types to pass to gnc_account_sel_set_acct_filters.
gnc_account_sel_set_acct_filters copies the list so the intermediary caller is responsible for freeing the list.
Definition at line 533 of file gnc-option-impl.cpp.
bool GncOption::deserialize | ( | const std::string & | str | ) |
Set the option's value from a character sequence.
str | The character sequence representing the value |
Definition at line 455 of file gnc-option.cpp.
gnc_commodity* DxaccAccountGetCurrency | ( | const Account * | account | ) |
Use xaccAccountGetCommodity() to fetch it.
Definition at line 3347 of file Account.cpp.
const char* dxaccAccountGetQuoteTZ | ( | const Account * | account | ) |
Get the timezone to be used when interpreting the results from a given Finance::Quote backend.
Unfortunately, the upstream sources don't label their output, so the user has to specify this bit. This function uses a static char*.
Definition at line 4813 of file Account.cpp.
void DxaccAccountSetCurrency | ( | Account * | account, |
gnc_commodity * | currency | ||
) |
Use xaccAccountGetCommodity() to fetch it.
These two funcs take control of their gnc_commodity args. Don't free
Definition at line 2736 of file Account.cpp.
void dxaccAccountSetQuoteTZ | ( | Account * | account, |
const char * | tz | ||
) |
Set the timezone to be used when interpreting the results from a given Finance::Quote backend.
Unfortunately, the upstream sources don't label their output, so the user has to specify this bit.
Definition at line 4802 of file Account.cpp.
Look up an Account in the map using Baysian.
Look up an Account in the map using Baysian.
Definition at line 5459 of file Account.cpp.
The gnc_account_lookup_by_name() subroutine fetches the account by name from the descendants of the specified account.
The immediate children are searched first. If there is no match, then a recursive search of all descendants is performed looking for a match.
Definition at line 3043 of file Account.cpp.
Find the opening balance account for the currency.
account | The account of which the sought-for account is a descendant. |
commodity | The commodity in which the account should be denominated |
Definition at line 3071 of file Account.cpp.
GList* gnc_account_lookup_by_type_and_commodity | ( | Account * | root, |
const char * | name, | ||
GNCAccountType | acctype, | ||
gnc_commodity * | commodity | ||
) |
Find a direct child account matching name, GNCAccountType, and/or commodity.
Name and commodity may be nullptr in which case the accounts in the list may have any value for those properties. Note that commodity matching is by equivalence: If the mnemonic/symbol and namespace are the same, it matches.
root | The account among whose children one expects to find the account. |
name | The name of the account to look for or nullptr. |
acctype | The GNCAccountType to match. |
commodity | The commodity in which the account should be denominated or nullptr. |
Definition at line 3138 of file Account.cpp.
void gnc_account_tree_begin_staged_transaction_traversals | ( | Account * | acc | ) |
gnc_account_tree_begin_staged_transaction_traversals() resets the traversal marker inside every transactions of every account in the account tree originating with the specified node.
This is done so that a new sequence of staged traversals can begin.
Definition at line 4996 of file Account.cpp.
int gnc_account_tree_staged_transaction_traversal | ( | const Account * | account, |
unsigned int | stage, | ||
TransactionCallback | thunk, | ||
void * | data | ||
) |
gnc_account_tree_staged_transaction_traversal() calls thunk on each transaction in the group whose current marker is less than the given stage and updates each transaction's marker to be stage.
The traversal will stop if thunk returns a non-zero value. gnc_account_tree_staged_transaction_traversal() function will return zero or the non-zero value returned by thunk. This API does not handle handle recursive traversals.
Definition at line 5031 of file Account.cpp.
void gnc_engine_init | ( | int | argc, |
char ** | argv | ||
) |
PROTOTYPES.
gnc_engine_init should be called before gnc engine functions can be used.
Definition at line 116 of file gnc-engine.cpp.
void gnc_engine_init_static | ( | int | argc, |
char ** | argv | ||
) |
This is the statically linked-in version of gnc_engine_init.
It is identical to that function except that it doesn't load any backend library.
Definition at line 126 of file gnc-engine.cpp.
void gnc_engine_shutdown | ( | void | ) |
Called to shutdown the engine.
Definition at line 141 of file gnc-engine.cpp.
std::istream & GncOption::in_stream | ( | std::istream & | iss | ) |
Set the option's value from an input stream.
iss | An input stream reference. |
Definition at line 463 of file gnc-option.cpp.
|
noexcept |
Definition at line 314 of file gnc-option.cpp.
|
noexcept |
Definition at line 306 of file gnc-option.cpp.
|
noexcept |
Definition at line 322 of file gnc-option.cpp.
|
noexcept |
Mark the option as needing to be saved.
Definition at line 298 of file gnc-option.cpp.
std::uint16_t GncOption::num_permissible_values | ( | ) | const |
Implemented only for GncOptionMultiselectValue.
Definition at line 356 of file gnc-option.cpp.
const char * GncOption::permissible_value | ( | uint16_t | index | ) | const |
Implemented only for GncOptionMultiselectValue.
Definition at line 386 of file gnc-option.cpp.
std::uint16_t GncOption::permissible_value_index | ( | const char * | value | ) | const |
Implemented only for GncOptionMultiselectValue.
Definition at line 371 of file gnc-option.cpp.
const char * GncOption::permissible_value_name | ( | uint16_t | index | ) | const |
Implemented only for GncOptionMultiselectValue.
Definition at line 400 of file gnc-option.cpp.
std::string GncOption::serialize | ( | ) | const |
Get a string suitable for storage representing the option's value.
Definition at line 445 of file gnc-option.cpp.
template bool GncOption::validate | ( | ValueType | value | ) | const |
Not implemented for GncOptionValue.
Definition at line 335 of file gnc-option.cpp.
void xaccAccountClearHigherBalanceLimit | ( | Account * | account | ) |
Clear the higher balance limit for the account.
account | The account to clear the limit on |
Definition at line 4684 of file Account.cpp.
void xaccAccountClearLowerBalanceLimit | ( | Account * | account | ) |
Clear the lower balance limit for the account.
account | The account to clear the limit on |
Definition at line 4690 of file Account.cpp.
LotList* xaccAccountFindOpenLots | ( | const Account * | acc, |
gboolean(*)(GNCLot *lot, gpointer user_data) | match_func, | ||
gpointer | user_data, | ||
GCompareFunc | sort_func | ||
) |
Find a list of open lots that match the match_func.
Sort according to sort_func. If match_func is NULL, then all open lots are returned. If sort_func is NULL, then the returned list has no particular order. The caller must free to returned list.
Definition at line 3925 of file Account.cpp.
Split* xaccAccountFindSplitByDesc | ( | const Account * | account, |
const char * | description | ||
) |
Returns a pointer to the split, not a copy.
Definition at line 4850 of file Account.cpp.
Transaction* xaccAccountFindTransByDesc | ( | const Account * | account, |
const char * | description | ||
) |
Returns a pointer to the transaction, not a copy.
Definition at line 4863 of file Account.cpp.
gpointer xaccAccountForEachLot | ( | const Account * | acc, |
gpointer(*)(GNCLot *lot, gpointer user_data) | proc, | ||
gpointer | user_data | ||
) |
The xaccAccountForEachLot() method will apply the function 'proc' to each lot in the account.
If 'proc' returns a non-NULL value, further application will be stopped, and the resulting value will be returned. There is no guaranteed order over which the Lots will be traversed.
gint xaccAccountForEachTransaction | ( | const Account * | account, |
TransactionCallback | proc, | ||
void * | data | ||
) |
The xaccAccountForEachTransaction() routine will traverse all of the transactions in account and call the callback function proc on each transaction.
Processing will continue if-and-only-if proc returns 0. The user data pointer data will be passed on to the callback function proc.
This function does not descend recursively to traverse transactions in child accounts.
proc will be called exactly once for each transaction that is pointed to by at least one split in the given account.
The result of this function will be 0 if and only if every relevant transaction was traversed exactly once. Else the return value is the last non-zero value returned by proc.
Definition at line 5084 of file Account.cpp.
gboolean xaccAccountGetAppendText | ( | const Account * | account | ) |
Get the "import-append-text" flag for an account.
This is the saved state of the Append checkbox in the "Generic import transaction matcher" used to set the initial state of the Append checkbox next time this account is imported.
account | The account whose flag should be retrieved. |
Definition at line 4070 of file Account.cpp.
gboolean xaccAccountGetAutoInterest | ( | const Account * | acc | ) |
Get the "auto interest" flag for an account.
If this flag is set then the account (and any children) will trigger an interest transfer after reconciling.
acc | The account whose flag should be retrieved. |
Definition at line 4114 of file Account.cpp.
GNCPlaceholderType xaccAccountGetDescendantPlaceholder | ( | const Account * | account | ) |
Returns PLACEHOLDER_NONE if account is NULL or neither account nor any descendant of account is a placeholder.
If account is a placeholder, returns PLACEHOLDER_THIS. Otherwise, if any descendant of account is a placeholder, return PLACEHOLDER_CHILD.
Definition at line 4101 of file Account.cpp.
gboolean xaccAccountGetHidden | ( | const Account * | acc | ) |
Get the "hidden" flag for an account.
If this flag is set then the account (and any children) will be hidden from the user unless they explicitly ask to see them.
acc | The account whose flag should be retrieved. |
Definition at line 4129 of file Account.cpp.
gboolean xaccAccountGetHigherBalanceLimit | ( | const Account * | account, |
gnc_numeric * | balance | ||
) |
Get the higher balance limit for the account.
account | The account whose higher limit is to be retrieved |
balance | The placeholder to store the retrieved balance |
Definition at line 4658 of file Account.cpp.
gboolean xaccAccountGetIncludeSubAccountBalances | ( | const Account * | account | ) |
Get whether to include balances of sub accounts.
account | The account to get setting on |
Definition at line 4696 of file Account.cpp.
gboolean xaccAccountGetIsOpeningBalance | ( | const Account * | account | ) |
Get the "opening-balance" flag for an account.
If this flag is set then the account is used for opening balance transactions.
account | The account whose flag should be retrieved. |
Definition at line 4082 of file Account.cpp.
The xaccAccountGetLotList() routine returns a list of all lots in this account.
account | The account whose lots should be returned. |
Definition at line 3918 of file Account.cpp.
gboolean xaccAccountGetLowerBalanceLimit | ( | const Account * | account, |
gnc_numeric * | balance | ||
) |
Get the lower balance limit for the account.
account | The account whose lower limit is to be retrieved |
balance | The placeholder to store the retrieved balance |
Definition at line 4665 of file Account.cpp.
gboolean xaccAccountGetPlaceholder | ( | const Account * | account | ) |
Get the "placeholder" flag for an account.
If this flag is set then the account may not be modified by the user.
account | The account whose flag should be retrieved. |
Definition at line 4058 of file Account.cpp.
The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account.
Definition at line 3893 of file Account.cpp.
const char* xaccAccountGetTypeStr | ( | GNCAccountType | type | ) |
The xaccAccountGetTypeStr() routine returns a string suitable for use in the GUI/Interface.
These strings should be translated to the local language.
Definition at line 4296 of file Account.cpp.
void xaccAccountInsertLot | ( | Account * | , |
GNCLot * | |||
) |
The xaccAccountInsertLot() method will register the indicated lot with this account.
Any splits later inserted into this lot must belong to this account. If the lot is already in another account, the lot, and all of the splits in it, will be moved from that account to this account.
Definition at line 2122 of file Account.cpp.
gboolean xaccAccountIsAPARType | ( | GNCAccountType | t | ) |
Convenience function to check if the account is a valid business account type (meaning an Accounts Payable/Accounts Receivable).
Definition at line 4466 of file Account.cpp.
gboolean xaccAccountIsAssetLiabType | ( | GNCAccountType | t | ) |
Convenience function to check if the account is a valid Asset or Liability type, but not a business account type (meaning not an Accounts Payable/Accounts Receivable).
Definition at line 4420 of file Account.cpp.
gboolean xaccAccountIsEquityType | ( | GNCAccountType | t | ) |
Convenience function to check if the account is a valid Equity type.
Definition at line 4478 of file Account.cpp.
gboolean xaccAccountIsHidden | ( | const Account * | acc | ) |
Should this account be "hidden".
If this flag is set for this account (or any parent account) then the account should be hidden from the user unless they explicitly ask to see it. This function is different from the xaccAccountGetHidden() function because it checks the flag in parent accounts in addition to this account.
acc | The account whose flag should be retrieved. |
Definition at line 4141 of file Account.cpp.
The xaccAccountMoveAllSplits() routine reassigns each of the splits in accfrom to accto.
Definition at line 2182 of file Account.cpp.
void xaccAccountSetAppendText | ( | Account * | account, |
gboolean | val | ||
) |
Set the "import-append-text" flag for an account.
This is the saved state of the Append checkbox in the "Generic import transaction matcher" used to set the initial state of the Append checkbox next time this account is imported.
account | The account whose flag should be retrieved. |
val | The new state for the account's "import-append-text" flag. |
Definition at line 4076 of file Account.cpp.
void xaccAccountSetAutoInterest | ( | Account * | acc, |
gboolean | val | ||
) |
Set the "auto interest" flag for an account.
If this flag is set then the account (and any children) will trigger an interest transfer after reconciling.
acc | The account whose flag should be retrieved. |
val | The new state for the account's "auto interest" flag. |
Definition at line 4120 of file Account.cpp.
void xaccAccountSetHidden | ( | Account * | acc, |
gboolean | val | ||
) |
Set the "hidden" flag for an account.
If this flag is set then the account (and any children) will be hidden from the user unless they explicitly ask to see them.
acc | The account whose flag should be retrieved. |
val | The new state for the account's "hidden" flag. |
Definition at line 4135 of file Account.cpp.
void xaccAccountSetHigherBalanceLimit | ( | Account * | account, |
gnc_numeric | balance | ||
) |
Set the higher balance limit for the account.
account | The account whose higher limit is to be saved |
balance | The balance to be saved |
Definition at line 4672 of file Account.cpp.
void xaccAccountSetIncludeSubAccountBalances | ( | Account * | account, |
gboolean | include | ||
) |
Set whether to include balances of sub accounts.
account | The account to set the setting on |
include | Set to TRUE for including sub account balances |
Definition at line 4702 of file Account.cpp.
void xaccAccountSetIsOpeningBalance | ( | Account * | account, |
gboolean | val | ||
) |
Set the "opening-balance" flag for an account.
If this flag is set then the account is used for opening balance transactions.
account | The account whose flag should be set. |
val | The new state for the account's "opening-balance" flag. |
Definition at line 4092 of file Account.cpp.
void xaccAccountSetLowerBalanceLimit | ( | Account * | account, |
gnc_numeric | balance | ||
) |
Set the lower balance limit for the account.
account | The account whose lower limit is to be saved |
balance | The balance to be saved |
Definition at line 4678 of file Account.cpp.
void xaccAccountSetMark | ( | Account * | account, |
short | mark | ||
) |
Set a mark on the account.
The meaning of this mark is completely undefined. Its presented here as a utility for the programmer, to use as desired. Handy for performing customer traversals over the account tree. The mark is not stored in the database/file format. When accounts are newly created, the mark is set to zero.
Definition at line 2044 of file Account.cpp.
void xaccAccountSetPlaceholder | ( | Account * | account, |
gboolean | val | ||
) |
Set the "placeholder" flag for an account.
If this flag is set then the account may not be modified by the user.
account | The account whose flag should be retrieved. |
val | The new state for the account's "placeholder" flag. |
Definition at line 4064 of file Account.cpp.
int xaccAccountStagedTransactionTraversal | ( | const Account * | a, |
unsigned int | stage, | ||
TransactionCallback | thunk, | ||
void * | data | ||
) |
xaccAccountStagedTransactionTraversal() calls thunk on each transaction in account a whose current marker is less than the given stage and updates each transaction's marker to be stage.
The traversal will stop if thunk returns a non-zero value. xaccAccountStagedTransactionTraversal() function will return zero or the non-zero value returned by thunk. This API does not handle handle recursive traversals.
Definition at line 5004 of file Account.cpp.
GNCAccountType xaccAccountStringToEnum | ( | const char * | str | ) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications.
These strings should not be translated to the local language. Typical conversion is "INCOME" -> ACCT_TYPE_INCOME.
Definition at line 4257 of file Account.cpp.
gboolean xaccAccountStringToType | ( | const char * | str, |
GNCAccountType * | type | ||
) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications.
These strings should not be translated to the local language. Typical conversion is "INCOME" -> ACCT_TYPE_INCOME.
Definition at line 4223 of file Account.cpp.
int xaccAccountTreeForEachTransaction | ( | Account * | acc, |
TransactionCallback | proc, | ||
void * | data | ||
) |
Traverse all of the transactions in the given account group.
Continue processing IF proc returns 0. This function will descend recursively to traverse transactions in the children of the accounts in the group.
Proc will be called exactly once for each transaction that is pointed to by at least one split in any account in the hierarchy topped by the root Account acc.
The result of this function will be 0 IF every relevant transaction was traversed exactly once; otherwise, the return value is the last non-zero value returned by the callback.
Note that this routine is just a trivial wrapper for
gnc_account_tree_begin_staged_transaction_traversals(g); gnc_account_tree_staged_transaction_traversal(g, 42, proc, data);
const char* xaccAccountTypeEnumAsString | ( | GNCAccountType | type | ) |
Conversion routines for the account types to/from strings that are used in persistent storage, communications.
These strings should not be translated to the local language. Typical conversion is ACCT_TYPE_INCOME -> "INCOME".
Definition at line 4186 of file Account.cpp.
GNCAccountType xaccAccountTypeGetFundamental | ( | GNCAccountType | t | ) |
Convenience function to return the fundamental type asset/liability/income/expense/equity given an account type.
Definition at line 4434 of file Account.cpp.
gboolean xaccAccountTypesCompatible | ( | GNCAccountType | parent_type, |
GNCAccountType | child_type | ||
) |
Return TRUE if accounts of type parent_type can have accounts of type child_type as children.
Definition at line 4393 of file Account.cpp.
guint32 xaccAccountTypesCompatibleWith | ( | GNCAccountType | type | ) |
Return the bitmask of account types compatible with a given type.
That is, you could switch to any of the account types in the compatible list without unwanted side-effects.
Definition at line 4306 of file Account.cpp.
guint32 xaccAccountTypesValid | ( | void | ) |
Returns the bitmask of the account type enums that are valid.
Deprecated and root account types are stripped.
Definition at line 4411 of file Account.cpp.
void xaccClearMark | ( | Account * | account, |
short | val | ||
) |
Get the mark set by xaccAccountSetMark short xaccAccountGetMark (const Account *account);.
The xaccClearMark will find the root account, and clear the mark in the entire account tree.
Definition at line 2055 of file Account.cpp.
void xaccClearMarkDown | ( | Account * | account, |
short | val | ||
) |
The xaccClearMarkDown will clear the mark only in this and in sub-accounts.
Definition at line 2066 of file Account.cpp.
guint32 xaccParentAccountTypesCompatibleWith | ( | GNCAccountType | type | ) |
Return the bitmask of parent account types compatible with a given type.
Definition at line 4346 of file Account.cpp.
gboolean xaccTransactionTraverse | ( | Transaction * | trans, |
int | stage | ||
) |
xaccTransactionTraverse() checks the stage of the given transaction.
If the transaction hasn't reached the given stage, the transaction is updated to that stage and the function returns TRUE. Otherwise no change is made and the function returns FALSE.
Definition at line 4981 of file Account.cpp.
|
static |
Definition at line 75 of file gnc-option.hpp.
|
static |
Definition at line 85 of file gnc-option.hpp.
|
static |
Definition at line 95 of file gnc-option.hpp.
|
static |
Definition at line 268 of file gnc-option-impl.hpp.
|
static |
Definition at line 278 of file gnc-option-impl.hpp.
|
static |
Definition at line 288 of file gnc-option-impl.hpp.