Register2 Page

Files
file	gnc-plugin-page-register.h
	Functions providing a register page for the GnuCash UI.

Data Structures
struct	GncPluginPageRegister2
struct	GncPluginPageRegister2Class

Macros
#define	GNC_TYPE_PLUGIN_PAGE_REGISTER2   (gnc_plugin_page_register2_get_type ())
#define	GNC_PLUGIN_PAGE_REGISTER2(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER2, GncPluginPageRegister2))
#define	GNC_PLUGIN_PAGE_REGISTER2_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER2, GncPluginPageRegister2Class))
#define	GNC_IS_PLUGIN_PAGE_REGISTER2(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER2))
#define	GNC_IS_PLUGIN_PAGE_REGISTER2_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER2))
#define	GNC_PLUGIN_PAGE_REGISTER2_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER2, GncPluginPageRegister2Class))
#define	GNC_PLUGIN_PAGE_REGISTER2_NAME   "GncPluginPageRegister2"

Functions
GType	gnc_plugin_page_register2_get_type (void)
GncPluginPage *	gnc_plugin_page_register2_new (Account *account, gboolean subaccounts)
GncPluginPage *	gnc_plugin_page_register2_new_ledger (GNCLedgerDisplay2 *ledger)
GncPluginPage *	gnc_plugin_page_register2_new_gl (void)
void	gnc_plugin_page_register2_set_options (GncPluginPage *plugin_page, gint lines_default, gboolean read_only)
GNCSplitReg2 *	gnc_plugin_page_register2_get_gsr (GncPluginPage *plugin_page)
GNCLedgerDisplay2 *	gnc_plugin_page_register2_get_ledger (GncPluginPage *plugin_page)
Account *	gnc_plugin_page_register2_get_account (GncPluginPageRegister2 *page)

Detailed Description

Function Documentation

Account* gnc_plugin_page_register2_get_account

(

GncPluginPageRegister2 *

page

)

Get the Account associated with this register page.

Parameters

page	A "register" page.

Returns

The account if the register contains only a single account, or an account and its sub-accounts. NULL otherwise.

Definition at line 798 of file gnc-plugin-page-register2.c.

{
    GncPluginPageRegister2Private *priv;
    GNCLedgerDisplay2Type ledger_type;
    Account *leader;

    priv = GNC_PLUGIN_PAGE_REGISTER2_GET_PRIVATE(page);
    ledger_type = gnc_ledger_display2_type (priv->ledger);
    leader = gnc_ledger_display2_leader (priv->ledger);

    if ((ledger_type == LD2_SINGLE) || (ledger_type == LD2_SUBACCOUNT))
        return leader;
    return NULL;
}

GNCSplitReg2* gnc_plugin_page_register2_get_gsr

(

GncPluginPage *

plugin_page

)

Get the GNCSplitReg data structure associated with this register page.

Parameters

plugin_page

A "register" page.

Definition at line 3838 of file gnc-plugin-page-register2.c.

{
    GncPluginPageRegister2 *page;
    GncPluginPageRegister2Private *priv;

    g_return_val_if_fail(GNC_IS_PLUGIN_PAGE_REGISTER2(plugin_page), NULL);

    page = GNC_PLUGIN_PAGE_REGISTER2 (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER2_GET_PRIVATE(page);

    return priv->gsr;
}

GNCLedgerDisplay2* gnc_plugin_page_register2_get_ledger

(

GncPluginPage *

plugin_page

)

Get the GNCLedgerDisplay data structure associated with this register page.

Parameters

plugin_page

A "register" page.

Definition at line 3853 of file gnc-plugin-page-register2.c.

{
    GncPluginPageRegister2 *page;
    GncPluginPageRegister2Private *priv;

    g_return_val_if_fail(GNC_IS_PLUGIN_PAGE_REGISTER2(plugin_page), NULL);

    page = GNC_PLUGIN_PAGE_REGISTER2 (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER2_GET_PRIVATE(page);

    return priv->ledger;
}

GType gnc_plugin_page_register2_get_type

(

void

)

Retrieve the type number for the plugin page.

Returns

The type number.

Definition at line 560 of file gnc-plugin-page-register2.c.

{
    static GType gnc_plugin_page_register2_type = 0;

    if (gnc_plugin_page_register2_type == 0)
    {
        static const GTypeInfo our_info =
        {
            sizeof (GncPluginPageRegister2Class),
            NULL,
            NULL,
            (GClassInitFunc) gnc_plugin_page_register2_class_init,
            NULL,
            NULL,
            sizeof (GncPluginPageRegister2),
            0,
            (GInstanceInitFunc) gnc_plugin_page_register2_init
        };

        gnc_plugin_page_register2_type = g_type_register_static (GNC_TYPE_PLUGIN_PAGE,
                                        GNC_PLUGIN_PAGE_REGISTER2_NAME,
                                        &our_info, 0);
    }

    return gnc_plugin_page_register2_type;
}

GncPluginPage* gnc_plugin_page_register2_new	(	Account *	account,
		gboolean	subaccounts
	)

Create a new "register" plugin page, given a pointer to an account.

Parameters

account	The pointer to the account to embed in the register.
subaccounts	TRUE if all the sub-accounts of the specified account should be included in the register.

Returns

The newly created plugin page.

Definition at line 653 of file gnc-plugin-page-register2.c.

{
    GNCLedgerDisplay2 *ledger;
    GncPluginPage *page;
    GncPluginPageRegister2Private *priv;

/*################## Added for Reg2 #################*/
    const GList *item;
    GncPluginPageRegister  *old_register_page;
/*################## Added for Reg2 #################*/

    ENTER("account=%p, subaccounts=%s", account,
          subaccounts ? "TRUE" : "FALSE");

/*################## Added for Reg2 #################*/
    // We test for the old register being open here, ie matching account guids
    item = gnc_gobject_tracking_get_list (GNC_PLUGIN_PAGE_REGISTER_NAME);
    for ( ; item; item = g_list_next (item))
    {
        Account *old_account;
        old_register_page = (GncPluginPageRegister *)item->data;
        old_account = gnc_plugin_page_register_get_account (old_register_page);

        if (guid_equal (xaccAccountGetGUID (account), xaccAccountGetGUID (old_account)))
        {
            gnc_error_dialog (NULL, "%s",
                         _("You have tried to open an account in the new register while it is open in the old register."));
            return NULL;
        }
    }
/*################## Added for Reg2 #################*/

    if (subaccounts)
        ledger = gnc_ledger_display2_subaccounts (account);
    else
        ledger = gnc_ledger_display2_simple (account);

    page = gnc_plugin_page_register2_new_common (ledger);
    priv = GNC_PLUGIN_PAGE_REGISTER2_GET_PRIVATE (page);
    priv->key = *xaccAccountGetGUID (account);

    LEAVE("%p", page);
    return page;
}

GncPluginPage* gnc_plugin_page_register2_new_gl

(

void

)

Create a new "register" plugin page containing a general ledger.

Returns

The newly created plugin page.

Definition at line 699 of file gnc-plugin-page-register2.c.

{
    GNCLedgerDisplay2 *ledger;

    ledger = gnc_ledger_display2_gl ();
    return gnc_plugin_page_register2_new_common (ledger);
}

GncPluginPage* gnc_plugin_page_register2_new_ledger

(

GNCLedgerDisplay2 *

ledger

)

Create a new "register" plugin page, given a pointer to an already created ledger. This function should be used when the ledger already exists. (E.G. From the "find transaction" code, or from the scheduled transaction code.)

Parameters

ledger

The pointer to the ledger to embed into the register.

Returns

The newly created plugin page.

Definition at line 708 of file gnc-plugin-page-register2.c.

{
    return gnc_plugin_page_register2_new_common (ledger);
}

void gnc_plugin_page_register2_set_options	(	GncPluginPage *	plugin_page,
		gint	lines_default,
		gboolean	read_only
	)

Set various register options on a newly created "register" plugin page.

Parameters

plugin_page	The "register" page to modify.
lines_default	Used to calculate the minimum preferred height of the plugin page.
read_only	True if the register should be read-only.

Definition at line 3822 of file gnc-plugin-page-register2.c.

{
    GncPluginPageRegister2 *page;
    GncPluginPageRegister2Private *priv;

    g_return_if_fail(GNC_IS_PLUGIN_PAGE_REGISTER2(plugin_page));

    page = GNC_PLUGIN_PAGE_REGISTER2 (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER2_GET_PRIVATE(page);
    priv->lines_default     = lines_default;
    priv->read_only         = read_only;
}