Register Page

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

Data Structures
struct	status_action
struct	GncPluginPageRegisterPrivate
struct	GncPluginPageRegister
struct	GncPluginPageRegisterClass

Macros
#define	DEFAULT_LINES_AMOUNT   50
#define	DEFAULT_FILTER_NUM_DAYS_GL   "30"
#define	CUT_TRANSACTION_LABEL   N_("Cu_t Transaction")
#define	COPY_TRANSACTION_LABEL   N_("_Copy Transaction")
#define	PASTE_TRANSACTION_LABEL   N_("_Paste Transaction")
#define	DUPLICATE_TRANSACTION_LABEL   N_("Dup_licate Transaction")
#define	DELETE_TRANSACTION_LABEL   N_("_Delete Transaction")
#define	LINK_TRANSACTION_LABEL   N_("_Manage Document Link…")
#define	LINK_TRANSACTION_OPEN_LABEL   N_("_Open Linked Document")
#define	JUMP_LINKED_INVOICE_LABEL   N_("Jump to Invoice")
#define	CUT_SPLIT_LABEL   N_("Cu_t Split")
#define	COPY_SPLIT_LABEL   N_("_Copy Split")
#define	PASTE_SPLIT_LABEL   N_("_Paste Split")
#define	DUPLICATE_SPLIT_LABEL   N_("Dup_licate Split")
#define	DELETE_SPLIT_LABEL   N_("_Delete Split")
#define	CUT_TRANSACTION_TIP   N_("Cut the selected transaction into clipboard")
#define	COPY_TRANSACTION_TIP   N_("Copy the selected transaction into clipboard")
#define	PASTE_TRANSACTION_TIP   N_("Paste the transaction from the clipboard")
#define	DUPLICATE_TRANSACTION_TIP   N_("Make a copy of the current transaction")
#define	DELETE_TRANSACTION_TIP   N_("Delete the current transaction")
#define	LINK_TRANSACTION_TIP   N_("Add, change, or unlink the document linked with the current transaction")
#define	LINK_TRANSACTION_OPEN_TIP   N_("Open the linked document for the current transaction")
#define	JUMP_LINKED_INVOICE_TIP   N_("Jump to the linked bill, invoice, or voucher")
#define	CUT_SPLIT_TIP   N_("Cut the selected split into clipboard")
#define	COPY_SPLIT_TIP   N_("Copy the selected split into clipboard")
#define	PASTE_SPLIT_TIP   N_("Paste the split from the clipboard")
#define	DUPLICATE_SPLIT_TIP   N_("Make a copy of the current split")
#define	DELETE_SPLIT_TIP   N_("Delete the current split")
#define	CLEARED_VALUE   "cleared_value"
#define	DEFAULT_FILTER   "0x001f"
#define	DEFAULT_SORT_ORDER   "BY_STANDARD"
#define	KEY_REGISTER_TYPE   "RegisterType"
#define	KEY_ACCOUNT_NAME   "AccountName"
#define	KEY_ACCOUNT_GUID   "AccountGuid"
#define	KEY_REGISTER_STYLE   "RegisterStyle"
#define	KEY_DOUBLE_LINE   "DoubleLineMode"
#define	LABEL_ACCOUNT   "Account"
#define	LABEL_SUBACCOUNT   "SubAccount"
#define	LABEL_GL   "GL"
#define	LABEL_SEARCH   "Search"
#define	GNC_TYPE_PLUGIN_PAGE_REGISTER   (gnc_plugin_page_register_get_type ())
#define	GNC_PLUGIN_PAGE_REGISTER(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegister))
#define	GNC_PLUGIN_PAGE_REGISTER_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
#define	GNC_IS_PLUGIN_PAGE_REGISTER(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER))
#define	GNC_IS_PLUGIN_PAGE_REGISTER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER))
#define	GNC_PLUGIN_PAGE_REGISTER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
#define	GNC_PLUGIN_PAGE_REGISTER_NAME   "GncPluginPageRegister"

Functions
void	gnc_plugin_page_register_sort_button_cb (GtkToggleButton *button, GncPluginPageRegister *page)
	This function is called when a radio button in the "Sort By…" dialog is clicked. More...
void	gnc_plugin_page_register_sort_response_cb (GtkDialog *dialog, gint response, GncPluginPageRegister *page)
	This function is called when the "Sort By…" dialog is closed. More...
void	gnc_plugin_page_register_sort_order_save_cb (GtkToggleButton *button, GncPluginPageRegister *page)
	This function is called whenever the save sort order is checked or unchecked which allows saving of the sort order. More...
void	gnc_plugin_page_register_sort_order_reverse_cb (GtkToggleButton *button, GncPluginPageRegister *page)
	This function is called whenever the reverse sort order is checked or unchecked which allows reversing of the sort order. More...
void	gnc_plugin_page_register_set_sort_order (GncPluginPage *plugin_page, const gchar *sort_order)
void	gnc_plugin_page_register_set_sort_reversed (GncPluginPage *plugin_page, gboolean reverse_order)
void	gnc_plugin_page_register_filter_select_range_cb (GtkRadioButton *button, GncPluginPageRegister *page)
	This function is called when the radio buttons changes state. More...
void	gnc_plugin_page_register_filter_start_cb (GtkWidget *radio, GncPluginPageRegister *page)
	This function is called when one of the start date radio buttons is selected. More...
void	gnc_plugin_page_register_filter_end_cb (GtkWidget *radio, GncPluginPageRegister *page)
	This function is called when one of the end date radio buttons is selected. More...
void	gnc_plugin_page_register_filter_response_cb (GtkDialog *dialog, gint response, GncPluginPageRegister *page)
	This function is called when the "Filter By…" dialog is closed. More...
void	gnc_plugin_page_register_filter_status_all_cb (GtkButton *button, GncPluginPageRegister *page)
	This function is called whenever the "select all" status button is clicked. More...
void	gnc_plugin_page_register_filter_status_one_cb (GtkToggleButton *button, GncPluginPageRegister *page)
	This function is called whenever one of the status entries is checked or unchecked. More...
void	gnc_plugin_page_register_filter_save_cb (GtkToggleButton *button, GncPluginPageRegister *page)
	This function is called whenever the save status is checked or unchecked. More...
void	gnc_plugin_page_register_filter_days_changed_cb (GtkSpinButton *button, GncPluginPageRegister *page)
	This function is called when the "number of days" spin button is changed which is then saved and updates the time limitation on the register query. More...
void	gnc_plugin_page_register_set_filter (GncPluginPage *plugin_page, const gchar *filter)
	G_DEFINE_TYPE_WITH_PRIVATE (GncPluginPageRegister, gnc_plugin_page_register, GNC_TYPE_PLUGIN_PAGE) static GncPluginPage *gnc_plugin_page_register_new_common(GNCLedgerDisplay *ledger)
GncPluginPage *	gnc_plugin_page_register_new (Account *account, gboolean subaccounts)
	Create a new "register" plugin page, given a pointer to an account. More...
GncPluginPage *	gnc_plugin_page_register_new_gl (void)
	Create a new "register" plugin page containing a general journal. More...
GncPluginPage *	gnc_plugin_page_register_new_ledger (GNCLedgerDisplay *ledger)
	Create a new "register" plugin page, given a pointer to an already created ledger. More...
Account *	gnc_plugin_page_register_get_account (GncPluginPageRegister *page)
	Get the Account associated with this register page. More...
Transaction *	gnc_plugin_page_register_get_current_txn (GncPluginPageRegister *page)
	Get the currently selected transaction in this register page. More...
Query *	gnc_plugin_page_register_get_query (GncPluginPage *plugin_page)
	This function is called to get the query associated with this plugin page. More...
void	gnc_plugin_page_register_clear_current_filter (GncPluginPage *plugin_page)
	This function clears the registers current filter. More...
void	gnc_plugin_page_register_set_options (GncPluginPage *plugin_page, gint lines_default, gboolean read_only)
	Set various register options on a newly created "register" plugin page. More...
GNCSplitReg *	gnc_plugin_page_register_get_gsr (GncPluginPage *plugin_page)
	Get the GNCSplitReg data structure associated with this register page. More...
GType	gnc_plugin_page_register_get_type (void)
	Retrieve the type number for the plugin page. More...

Detailed Description

Function Documentation

gnc_plugin_page_register_clear_current_filter()

void gnc_plugin_page_register_clear_current_filter

(

GncPluginPage *

plugin_page

)

This function clears the registers current filter.

It is used so jumps to splits from other places can be completed otherwise the jump will be to the last active cell.

Parameters

plugin_page

A pointer to the GncPluginPageRegister.

Definition at line 2912 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (plugin_page));

    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (plugin_page);

    priv->fd.days = 0;
    priv->fd.start_time = 0;
    priv->fd.end_time = 0;
    priv->fd.cleared_match = (cleared_match_t)g_ascii_strtoll (DEFAULT_FILTER, NULL, 16);

    gnc_ppr_update_date_query (GNC_PLUGIN_PAGE_REGISTER(plugin_page));
}

gnc_plugin_page_register_filter_days_changed_cb()

void gnc_plugin_page_register_filter_days_changed_cb	(	GtkSpinButton *	button,
		GncPluginPageRegister *	page
	)

This function is called when the "number of days" spin button is changed which is then saved and updates the time limitation on the register query.

This is handled by a helper function as potentially all widgets will need to be examined.

Parameters

button	A pointer to the "number of days" spin button.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 2939 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GTK_IS_SPIN_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("(button %p, page %p)", button, page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);

    priv->fd.days = gtk_spin_button_get_value (GTK_SPIN_BUTTON (button));
    gnc_ppr_update_date_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_filter_end_cb()

void gnc_plugin_page_register_filter_end_cb	(	GtkWidget *	radio,
		GncPluginPageRegister *	page
	)

This function is called when one of the end date radio buttons is selected.

It updates the sensitivity of the date entry widget, then calls a common routine to determine the start/end times and update the register query.

*Note: This function is actually called twice for each new radio button selection. The first time call is to uncheck the old button, and the second time to check the new button. This does make a kind of sense, as radio buttons are nothing more than linked toggle buttons where only one can be active.

Parameters

radio	The button whose state is changing. This will be the previously selected button the first of the pair of calls to this function, and will be the newly selected button the second time.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 3048 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    const gchar* name;
    gboolean active;

    g_return_if_fail (GTK_IS_RADIO_BUTTON (radio));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("(radio %s(%p), page %p)",
           gtk_buildable_get_name (GTK_BUILDABLE (radio)), radio, page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (radio)))
    {
        LEAVE ("1st callback of pair. Defer to 2nd callback.");
        return;
    }

    name = gtk_buildable_get_name (GTK_BUILDABLE (radio));
    active = !g_strcmp0 (name, "end_date_choose");
    gtk_widget_set_sensitive (priv->fd.end_date, active);
    get_filter_times (page);
    gnc_ppr_update_date_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_filter_response_cb()

void gnc_plugin_page_register_filter_response_cb	(	GtkDialog *	dialog,
		gint	response,
		GncPluginPageRegister *	page
	)

This function is called when the "Filter By…" dialog is closed.

If the dialog was closed by any method other than clicking the OK button, the original sorting order will be restored.

Parameters

dialog	A pointer to the dialog box.
response	A numerical value indicating why the dialog box was closed.
page	A pointer to the GncPluginPageRegister associated with this dialog box.

Definition at line 3117 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    GncPluginPage* plugin_page;

    g_return_if_fail (GTK_IS_DIALOG (dialog));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER (" ");
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    plugin_page = GNC_PLUGIN_PAGE (page);

    if (response != GTK_RESPONSE_OK)
    {
        /* Remove the old status match */
        priv->fd.cleared_match = priv->fd.original_cleared_match;
        priv->enable_refresh = FALSE;
        gnc_ppr_update_status_query (page);
        priv->enable_refresh = TRUE;
        priv->fd.start_time = priv->fd.original_start_time;
        priv->fd.end_time = priv->fd.original_end_time;
        priv->fd.days = priv->fd.original_days;
        priv->fd.save_filter = priv->fd.original_save_filter;
        gnc_ppr_update_date_query (page);
    }
    else
    {
        // clear the filter when unticking the save option
        if ((priv->fd.save_filter == FALSE) && (priv->fd.original_save_filter == TRUE))
            gnc_plugin_page_register_set_filter (plugin_page, NULL);

        priv->fd.original_save_filter = priv->fd.save_filter;

        if (priv->fd.save_filter)
        {
            gchar *filter;
            GList *flist = NULL;

            // cleared match
            flist = g_list_prepend
                (flist, g_strdup_printf ("0x%04x", priv->fd.cleared_match));

            // start time
            if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->fd.start_date_choose)) && priv->fd.start_time != 0)
                flist = g_list_prepend (flist, gnc_plugin_page_register_filter_time2dmy (priv->fd.start_time));
            else
                flist = g_list_prepend (flist, g_strdup ("0"));

            // end time
            if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->fd.end_date_choose))
                && priv->fd.end_time != 0)
                flist = g_list_prepend (flist, gnc_plugin_page_register_filter_time2dmy (priv->fd.end_time));
            else
                flist = g_list_prepend (flist, g_strdup ("0"));

            // number of days
            if (priv->fd.days > 0)
                flist = g_list_prepend (flist, g_strdup_printf ("%d", priv->fd.days));
            else
                flist = g_list_prepend (flist, g_strdup ("0"));

            flist = g_list_reverse (flist);
            filter = gnc_g_list_stringjoin (flist, ",");
            PINFO ("The filter to save is %s", filter);
            gnc_plugin_page_register_set_filter (plugin_page, filter);
            g_free (filter);
            g_list_free_full (flist, g_free);
        }
    }
    priv->fd.dialog = NULL;
    gtk_widget_destroy (GTK_WIDGET (dialog));
    LEAVE (" ");
}

gnc_plugin_page_register_filter_save_cb()

void gnc_plugin_page_register_filter_save_cb	(	GtkToggleButton *	button,
		GncPluginPageRegister *	page
	)

This function is called whenever the save status is checked or unchecked.

It will allow saving of the filter if required.

Parameters

button	The toggle button that was changed.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 3085 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GTK_IS_CHECK_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("Save toggle button (%p), plugin_page %p", button, page);

    /* Compute the new save filter status */
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    if (gtk_toggle_button_get_active (button))
        priv->fd.save_filter = TRUE;
    else
        priv->fd.save_filter = FALSE;
    LEAVE (" ");
}

gnc_plugin_page_register_filter_select_range_cb()

void gnc_plugin_page_register_filter_select_range_cb	(	GtkRadioButton *	button,
		GncPluginPageRegister *	page
	)

This function is called when the radio buttons changes state.

This function is responsible for setting the sensitivity of the widgets controlled by each radio button choice and updating the time limitation on the register query. This is handled by a helper function as potentially all widgets will need to be examined.

Parameters

button	A pointer to the "select range" radio button.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 2872 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    gboolean active;
    const gchar* name;

    g_return_if_fail (GTK_IS_RADIO_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("(button %p, page %p)", button, page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    name = gtk_buildable_get_name (GTK_BUILDABLE (button));
    active = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button));

    if (active && g_strcmp0 (name, "filter_show_range") == 0)
    {
        gtk_widget_set_sensitive (priv->fd.table, active);
        gtk_widget_set_sensitive (priv->fd.num_days, !active);
        get_filter_times (page);
    }
    else if (active && g_strcmp0 (name, "filter_show_days") == 0)
    {
        gtk_widget_set_sensitive (priv->fd.table, !active);
        gtk_widget_set_sensitive (priv->fd.num_days, active);
        gtk_spin_button_set_value (GTK_SPIN_BUTTON (priv->fd.num_days), priv->fd.days);
    }
    else
    {
        gtk_widget_set_sensitive (priv->fd.table, FALSE);
        gtk_widget_set_sensitive (priv->fd.num_days, FALSE);
        priv->fd.days = 0;
        priv->fd.start_time = 0;
        priv->fd.end_time = 0;
    }
    gnc_ppr_update_date_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_filter_start_cb()

void gnc_plugin_page_register_filter_start_cb	(	GtkWidget *	radio,
		GncPluginPageRegister *	page
	)

This function is called when one of the start date radio buttons is selected.

It updates the sensitivity of the date entry widget, then calls a common routine to determine the start/end times and update the register query.

*Note: This function is actually called twice for each new radio button selection. The first time call is to uncheck the old button, and the second time to check the new button. This does make a kind of sense, as radio buttons are nothing more than linked toggle buttons where only one can be active.

Parameters

radio	The button whose state is changing. This will be the previously selected button the first of the pair of calls to this function, and will be the newly selected button the second time.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 3000 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    const gchar* name;
    gboolean active;

    g_return_if_fail (GTK_IS_RADIO_BUTTON (radio));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("(radio %s(%p), page %p)",
           gtk_buildable_get_name (GTK_BUILDABLE (radio)), radio, page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (radio)))
    {
        LEAVE ("1st callback of pair. Defer to 2nd callback.");
        return;
    }

    name = gtk_buildable_get_name (GTK_BUILDABLE (radio));
    active = !g_strcmp0 (name, "start_date_choose");
    gtk_widget_set_sensitive (priv->fd.start_date, active);
    get_filter_times (page);
    gnc_ppr_update_date_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_filter_status_all_cb()

void gnc_plugin_page_register_filter_status_all_cb	(	GtkButton *	button,
		GncPluginPageRegister *	page
	)

This function is called whenever the "select all" status button is clicked.

It updates all of the checkbox widgets, then updates the query on the register.

Parameters

button	The button that was clicked.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 2769 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    GtkWidget* widget;
    gint i;

    g_return_if_fail (GTK_IS_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("(button %p, page %p)", button, page);

    /* Turn on all the check menu items */
    for (i = 0; status_actions[i].action_name; i++)
    {
        widget = status_actions[i].widget;
        g_signal_handlers_block_by_func (widget,
                                         (gpointer)gnc_plugin_page_register_filter_status_one_cb, page);
        gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
        g_signal_handlers_unblock_by_func (widget,
                                           (gpointer)gnc_plugin_page_register_filter_status_one_cb, page);
    }

    /* Set the requested status */
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    priv->fd.cleared_match = CLEARED_ALL;
    gnc_ppr_update_status_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_filter_status_one_cb()

void gnc_plugin_page_register_filter_status_one_cb	(	GtkToggleButton *	button,
		GncPluginPageRegister *	page
	)

This function is called whenever one of the status entries is checked or unchecked.

It updates the status value maintained for the filter dialog, and calls another function to do the work of applying the change to the register itself.

Parameters

button	The toggle button that was changed.
page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

Definition at line 2724 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    const gchar* name;
    gint i, value;

    g_return_if_fail (GTK_IS_CHECK_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    name = gtk_buildable_get_name (GTK_BUILDABLE (button));
    ENTER ("toggle button %s (%p), plugin_page %p", name, button, page);

    /* Determine what status bit to change */
    value = CLEARED_NONE;
    for (i = 0; status_actions[i].action_name; i++)
    {
        if (g_strcmp0 (name, status_actions[i].action_name) == 0)
        {
            value = status_actions[i].value;
            break;
        }
    }

    /* Compute the new match status */
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    if (gtk_toggle_button_get_active (button))
        priv->fd.cleared_match = (cleared_match_t)(priv->fd.cleared_match | value);
    else
        priv->fd.cleared_match = (cleared_match_t)(priv->fd.cleared_match & ~value);
    gnc_ppr_update_status_query (page);
    LEAVE (" ");
}

gnc_plugin_page_register_get_account()

Account * gnc_plugin_page_register_get_account

(

GncPluginPageRegister *

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 680 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    GNCLedgerDisplayType ledger_type;
    Account* leader;

    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    ledger_type = gnc_ledger_display_type (priv->ledger);
    leader = gnc_ledger_display_leader (priv->ledger);

    if ((ledger_type == LD_SINGLE) || (ledger_type == LD_SUBACCOUNT))
        return leader;
    return NULL;
}

gnc_plugin_page_register_get_current_txn()

Transaction * gnc_plugin_page_register_get_current_txn

(

GncPluginPageRegister *

page

)

Get the currently selected transaction in this register page.

Parameters

page	A "register" page.

Returns

The currently active transaction or NULL if there currently is no currently selected.

Definition at line 696 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    SplitRegister* reg;

    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    reg = gnc_ledger_display_get_split_register (priv->ledger);
    return gnc_split_register_get_current_trans (reg);
}

gnc_plugin_page_register_get_gsr()

GNCSplitReg * gnc_plugin_page_register_get_gsr

(

GncPluginPage *

plugin_page

)

Get the GNCSplitReg data structure associated with this register page.

Parameters

plugin_page

A "register" page.

Definition at line 5142 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegister* page;
    GncPluginPageRegisterPrivate* priv;

    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (plugin_page), NULL);

    page = GNC_PLUGIN_PAGE_REGISTER (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);

    return priv->gsr;
}

gnc_plugin_page_register_get_query()

Query * gnc_plugin_page_register_get_query

(

GncPluginPage *

plugin_page

)

This function is called to get the query associated with this plugin page.

Get the Query associated with this "register" plugin page.

Parameters

page	A pointer to the GncPluginPage.
plugin_page	The "register" page to modify.

Returns

The query.

Definition at line 2299 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegister* page;
    GncPluginPageRegisterPrivate* priv;

    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (plugin_page), NULL);

    page = GNC_PLUGIN_PAGE_REGISTER (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    return gnc_ledger_display_get_query (priv->ledger);
}

gnc_plugin_page_register_get_type()

GType gnc_plugin_page_register_get_type

(

void

)

Retrieve the type number for the plugin page.

Returns

The type number.

gnc_plugin_page_register_new()

GncPluginPage * gnc_plugin_page_register_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 564 of file gnc-plugin-page-register.cpp.

{
    GNCLedgerDisplay* ledger;
    GncPluginPage* page;
    GncPluginPageRegisterPrivate* priv;
    gnc_commodity* com0;
    gnc_commodity* com1;

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

    com0 = gnc_account_get_currency_or_parent (account);
    com1 = GNC_COMMODITY(gnc_account_foreach_descendant_until (account,
                                                               gnc_plug_page_register_check_commodity,
                                                               static_cast<gpointer>(com0)));

    if (subaccounts)
        ledger = gnc_ledger_display_subaccounts (account, com1 != NULL);
    else
        ledger = gnc_ledger_display_simple (account);

    page = gnc_plugin_page_register_new_common (ledger);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    priv->key = *xaccAccountGetGUID (account);

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

gnc_plugin_page_register_new_gl()

GncPluginPage * gnc_plugin_page_register_new_gl

(

void

)

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

Returns

The newly created plugin page.

Definition at line 594 of file gnc-plugin-page-register.cpp.

{
    GNCLedgerDisplay* ledger;

    ledger = gnc_ledger_display_gl();
    return gnc_plugin_page_register_new_common (ledger);
}

gnc_plugin_page_register_new_ledger()

GncPluginPage * gnc_plugin_page_register_new_ledger

(

GNCLedgerDisplay *

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 603 of file gnc-plugin-page-register.cpp.

{
    return gnc_plugin_page_register_new_common (ledger);
}

gnc_plugin_page_register_set_options()

void gnc_plugin_page_register_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 5126 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegister* page;
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (plugin_page));

    page = GNC_PLUGIN_PAGE_REGISTER (plugin_page);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    priv->lines_default     = lines_default;
    priv->read_only         = read_only;
}

gnc_plugin_page_register_sort_button_cb()

void gnc_plugin_page_register_sort_button_cb	(	GtkToggleButton *	button,
		GncPluginPageRegister *	page
	)

This function is called when a radio button in the "Sort By…" dialog is clicked.

Parameters

button	The button that was toggled.
page	A pointer to the GncPluginPageRegister associated with this dialog box.

Definition at line 2426 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    const gchar* name;
    SortType type;

    g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    name = gtk_buildable_get_name (GTK_BUILDABLE (button));
    ENTER ("button %s(%p), page %p", name, button, page);
    type = SortTypefromString (name);
    gnc_split_reg_set_sort_type (priv->gsr, type);
    LEAVE (" ");
}

gnc_plugin_page_register_sort_order_reverse_cb()

void gnc_plugin_page_register_sort_order_reverse_cb	(	GtkToggleButton *	button,
		GncPluginPageRegister *	page
	)

This function is called whenever the reverse sort order is checked or unchecked which allows reversing of the sort order.

Parameters

button	The toggle button that was changed.
page	A pointer to the GncPluginPageRegister that is associated with this sort order dialog.

Definition at line 2483 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GTK_IS_CHECK_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("Reverse toggle button (%p), plugin_page %p", button, page);

    /* Compute the new save sort order */
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);

    priv->sd.reverse_order = gtk_toggle_button_get_active (button);
    gnc_split_reg_set_sort_reversed (priv->gsr, priv->sd.reverse_order, TRUE);
    LEAVE (" ");
}

gnc_plugin_page_register_sort_order_save_cb()

void gnc_plugin_page_register_sort_order_save_cb	(	GtkToggleButton *	button,
		GncPluginPageRegister *	page
	)

This function is called whenever the save sort order is checked or unchecked which allows saving of the sort order.

Parameters

button	The toggle button that was changed.
page	A pointer to the GncPluginPageRegister that is associated with this sort order dialog.

Definition at line 2454 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;

    g_return_if_fail (GTK_IS_CHECK_BUTTON (button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER ("Save toggle button (%p), plugin_page %p", button, page);

    /* Compute the new save sort order */
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);

    if (gtk_toggle_button_get_active (button))
        priv->sd.save_order = TRUE;
    else
        priv->sd.save_order = FALSE;
    LEAVE (" ");
}

gnc_plugin_page_register_sort_response_cb()

void gnc_plugin_page_register_sort_response_cb	(	GtkDialog *	dialog,
		gint	response,
		GncPluginPageRegister *	page
	)

This function is called when the "Sort By…" dialog is closed.

If the dialog was closed by any method other than clicking the OK button, the original sorting order will be restored.

Parameters

dialog	A pointer to the dialog box.
response	A numerical value indicating why the dialog box was closed.
page	A pointer to the GncPluginPageRegister associated with this dialog box.

Definition at line 2362 of file gnc-plugin-page-register.cpp.

{
    GncPluginPageRegisterPrivate* priv;
    GncPluginPage* plugin_page;
    SortType type;
    const gchar* order;

    g_return_if_fail (GTK_IS_DIALOG (dialog));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER (page));

    ENTER (" ");
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    plugin_page = GNC_PLUGIN_PAGE (page);

    if (response != GTK_RESPONSE_OK)
    {
        /* Restore the original sort order */
        gnc_split_reg_set_sort_reversed (priv->gsr, priv->sd.original_reverse_order,
                                         TRUE);
        priv->sd.reverse_order = priv->sd.original_reverse_order;
        gnc_split_reg_set_sort_type (priv->gsr, priv->sd.original_sort_type);
        priv->sd.save_order = priv->sd.original_save_order;
    }
    else
    {
        // clear the sort when unticking the save option
        if ((!priv->sd.save_order) && ((priv->sd.original_save_order) || (priv->sd.original_reverse_order)))
        {
            gnc_plugin_page_register_set_sort_order (plugin_page, DEFAULT_SORT_ORDER);
            gnc_plugin_page_register_set_sort_reversed (plugin_page, FALSE);
        }
        priv->sd.original_save_order = priv->sd.save_order;

        if (priv->sd.save_order)
        {
            type = gnc_split_reg_get_sort_type (priv->gsr);
            order = SortTypeasString (type);
            gnc_plugin_page_register_set_sort_order (plugin_page, order);
            gnc_plugin_page_register_set_sort_reversed (plugin_page,
                                                        priv->sd.reverse_order);
        }
    }
    gnc_book_option_remove_cb (OPTION_NAME_NUM_FIELD_SOURCE,
                               gnc_plugin_page_register_sort_book_option_changed,
                               page);
    priv->sd.dialog = NULL;
    priv->sd.num_radio = NULL;
    priv->sd.act_radio = NULL;
    gtk_widget_destroy (GTK_WIDGET (dialog));
    LEAVE (" ");
}