AccountP.hpp File Reference

This is the private header for the account structure. More...

#include <vector>
#include <optional>
#include "Account.h"

Go to the source code of this file.

Data Structures
struct	AccountPrivate
struct	Account
	Account in Gnucash. More...
struct	AccountTestFunctions

Macros
#define	GNC_ID_ROOT_ACCOUNT   "RootAccount"

Functions
void	xaccAccountSetGUID (Account *account, const GncGUID *guid)
gboolean	xaccAccountRegister (void)
AccountTestFunctions *	_utest_account_fill_functions (void)

Detailed Description

This is the private header for the account structure.

No one outside of the engine should ever include this file.

This header includes prototypes for "dangerous" functions. Invoking any of these functions potentially leave the account in an inconsistent state. If they are not used in the proper setting, they can leave the account structures in an inconsistent state. Thus, these methods should never be used outside of the engine, which is why they are "hidden" here.

Definition in file AccountP.hpp.

Macro Definition Documentation

GNC_ID_ROOT_ACCOUNT

#define GNC_ID_ROOT_ACCOUNT   "RootAccount"

Definition at line 47 of file AccountP.hpp.

Function Documentation

_utest_account_fill_functions()

AccountTestFunctions * _utest_account_fill_functions

(

void

)

Definition at line 5952 of file Account.cpp.

{
    AccountTestFunctions* func = g_new(AccountTestFunctions, 1);
 
    func->get_private = utest_account_get_private;
    func->coll_get_root_account = gnc_coll_get_root_account;
    func->xaccFreeAccountChildren = xaccFreeAccountChildren;
    func->xaccFreeAccount = xaccFreeAccount;
    func->qofAccountSetParent = qofAccountSetParent;
    func->gnc_account_lookup_by_full_name_helper =
        gnc_account_lookup_by_full_name_helper;
 
    return func;
}

xaccAccountRegister()

gboolean xaccAccountRegister

(

void

)

Definition at line 5832 of file Account.cpp.

{
    static QofParam params[] =
    {
        {
            ACCOUNT_NAME_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetName,
            (QofSetterFunc) xaccAccountSetName
        },
        {
            ACCOUNT_CODE_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetCode,
            (QofSetterFunc) xaccAccountSetCode
        },
        {
            ACCOUNT_DESCRIPTION_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetDescription,
            (QofSetterFunc) xaccAccountSetDescription
        },
        {
            ACCOUNT_COLOR_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetColor,
            (QofSetterFunc) xaccAccountSetColor
        },
        {
            ACCOUNT_FILTER_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetFilter,
            (QofSetterFunc) xaccAccountSetFilter
        },
        {
            ACCOUNT_SORT_ORDER_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetSortOrder,
            (QofSetterFunc) xaccAccountSetSortOrder
        },
        {
            ACCOUNT_SORT_REVERSED_, QOF_TYPE_BOOLEAN,
            (QofAccessFunc) xaccAccountGetSortReversed,
            (QofSetterFunc) xaccAccountSetSortReversed
        },
        {
            ACCOUNT_NOTES_, QOF_TYPE_STRING,
            (QofAccessFunc) xaccAccountGetNotes,
            (QofSetterFunc) xaccAccountSetNotes
        },
        {
            ACCOUNT_PRESENT_, QOF_TYPE_NUMERIC,
            (QofAccessFunc) xaccAccountGetPresentBalance, nullptr
        },
        {
            ACCOUNT_BALANCE_, QOF_TYPE_NUMERIC,
            (QofAccessFunc) xaccAccountGetBalance, nullptr
        },
        {
            ACCOUNT_CLEARED_, QOF_TYPE_NUMERIC,
            (QofAccessFunc) xaccAccountGetClearedBalance, nullptr
        },
        {
            ACCOUNT_RECONCILED_, QOF_TYPE_NUMERIC,
            (QofAccessFunc) xaccAccountGetReconciledBalance, nullptr
        },
        {
            ACCOUNT_TYPE_, QOF_TYPE_STRING,
            (QofAccessFunc) qofAccountGetTypeString,
            (QofSetterFunc) qofAccountSetType
        },
        {
            ACCOUNT_FUTURE_MINIMUM_, QOF_TYPE_NUMERIC,
            (QofAccessFunc) xaccAccountGetProjectedMinimumBalance, nullptr
        },
        {
            ACCOUNT_TAX_RELATED, QOF_TYPE_BOOLEAN,
            (QofAccessFunc) xaccAccountGetTaxRelated,
            (QofSetterFunc) xaccAccountSetTaxRelated
        },
        {
            ACCOUNT_OPENING_BALANCE_, QOF_TYPE_BOOLEAN,
            (QofAccessFunc) xaccAccountGetIsOpeningBalance,
            (QofSetterFunc) xaccAccountSetIsOpeningBalance
        },
        {
            ACCOUNT_SCU, QOF_TYPE_INT32,
            (QofAccessFunc) xaccAccountGetCommoditySCU,
            (QofSetterFunc) xaccAccountSetCommoditySCU
        },
        {
            ACCOUNT_NSCU, QOF_TYPE_BOOLEAN,
            (QofAccessFunc) xaccAccountGetNonStdSCU,
            (QofSetterFunc) xaccAccountSetNonStdSCU
        },
        {
            ACCOUNT_PARENT, GNC_ID_ACCOUNT,
            (QofAccessFunc) gnc_account_get_parent,
            (QofSetterFunc) qofAccountSetParent
        },
        {
            QOF_PARAM_BOOK, QOF_ID_BOOK,
            (QofAccessFunc) qof_instance_get_book, nullptr
        },
        {
            QOF_PARAM_GUID, QOF_TYPE_GUID,
            (QofAccessFunc) qof_instance_get_guid, nullptr
        },
        { nullptr },
    };
 
    qof_class_register (GNC_ID_ACCOUNT, (QofSortFunc) qof_xaccAccountOrder, params);
 
    return qof_object_register (&account_object_def);
}

xaccAccountSetGUID()

void xaccAccountSetGUID	(	Account *	account,
		const GncGUID *	guid
	)

Definition at line 2021 of file Account.cpp.

{
    g_return_if_fail(GNC_IS_ACCOUNT(acc));
    g_return_if_fail(guid);
 
    /* XXX this looks fishy and weird to me ... */
    PINFO("acct=%p", acc);
    xaccAccountBeginEdit (acc);
    qof_instance_set_guid (&acc->inst, guid);
    qof_instance_set_dirty(&acc->inst);
    xaccAccountCommitEdit (acc);
}