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

file	gnc-plugin-page-register-filter.hpp
	Functions providing a register page filter for the GnuCash UI.

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

Data Structures
struct	RegisterFilterDialog

struct	status_action

struct	FilterData

struct	RegisterSortDialog

struct	SortData

struct	GncPluginPageRegisterPrivate

struct	GncPluginPageRegister

struct	GncPluginPageRegisterClass

Macros
#define	DEFAULT_LINES_AMOUNT 50

#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 Business item")

#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 invoice, bill, expense or credit note")

#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	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"

Enumerations
enum	GncPrefJumpMultSplits : gint { JUMP_DEFAULT = 0 , JUMP_LARGEST_VALUE_FIRST_SPLIT = 1 , JUMP_SMALLEST_VALUE_FIRST_SPLIT = 2 }

Functions
void	gnc_ppr_filter_select_range_cb (GtkRadioButton button, RegisterFilterDialog rfd)
	This function is called when the radio buttons changes state.

void	gnc_ppr_filter_start_cb (GtkWidget radio, RegisterFilterDialog rfd)
	This function is called when one of the start date radio buttons is selected.

void	gnc_ppr_filter_end_cb (GtkWidget radio, RegisterFilterDialog rfd)
	This function is called when one of the end date radio buttons is selected.

void	gnc_ppr_filter_response_cb (GtkDialog dialog, gint response, RegisterFilterDialog rfd)
	This function is called when the "Filter By…" dialog is closed.

void	gnc_ppr_filter_status_select_all_cb (GtkButton button, RegisterFilterDialog rfd)
	This function is called whenever the "select all" status button is clicked.

void	gnc_ppr_filter_status_clear_all_cb (GtkButton button, RegisterFilterDialog rfd)
	This function is called whenever the "clear all" status button is clicked.

void	gnc_ppr_filter_status_one_cb (GtkToggleButton button, RegisterFilterDialog rfd)
	This function is called whenever one of the status entries is checked or unchecked.

void	gnc_ppr_filter_save_cb (GtkToggleButton button, RegisterFilterDialog rfd)
	This function is called whenever the save status is checked or unchecked.

void	gnc_ppr_filter_days_changed_cb (GtkSpinButton button, RegisterFilterDialog rfd)
	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.

void	gnc_ppr_filter_start_toggle_cb (GtkToggleButton button, RegisterFilterDialog rfd)
	This function is called when one of the check buttons for start relative or start date is changed.

void	gnc_ppr_filter_end_toggle_cb (GtkToggleButton button, RegisterFilterDialog rfd)
	This function is called when one of the check buttons for end relative or end date is changed.

void	gnc_ppr_filter_start_end_days_changed_cb (GtkSpinButton button, RegisterFilterDialog rfd)
	This function is called when the "days ago" spin button is changed which is then saved and updates the time limitation on the register query.

void	gnc_ppr_filter_set_tooltip (GncPluginPage plugin_page, FilterData fd)
	This function is used to update the tooltip shown in the register which shows a summary of the current filter.

void	gnc_ppr_filter_clear_current_filter (GncPluginPage *plugin_page)
	This function is used to clear the current filter so that a specific split can be shown in the register.

void	gnc_ppr_filter_update_register (GncPluginPage *plugin_page)
	This function is called to update the register.

void	gnc_ppr_filter_by (GncPluginPage plugin_page, Query query, FilterData *fd, bool show_save_button)
	This function is called for the filter dialog.

void	gnc_ppr_sort_response_cb (GtkDialog dialog, gint response, RegisterSortDialog rsd)
	This function is called when the "Sort By…" dialog is closed.

void	gnc_ppr_sort_button_cb (GtkToggleButton button, RegisterSortDialog rsd)
	This function is called when a radio button in the "Sort By…" dialog is clicked.

void	gnc_ppr_sort_order_save_cb (GtkToggleButton button, RegisterSortDialog rsd)
	This function is called whenever the save sort order is checked or unchecked which allows saving of the sort order.

void	gnc_ppr_sort_order_reverse_cb (GtkToggleButton button, RegisterSortDialog rsd)
	This function is called whenever the reverse sort order is checked or unchecked which allows reversing of the sort order.

void	gnc_ppr_sort_update_register (GncPluginPage *plugin_page)
	This function is called to update the register.

void	gnc_ppr_sort_dialog (GncPluginPage plugin_page, SplitRegister reg, SortData *sd, bool show_save_button)
	This function is called for the sort dialog.

	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.

GncPluginPage *	gnc_plugin_page_register_new_gl (void)
	Create a new "register" plugin page containing a general journal.

GncPluginPage *	gnc_plugin_page_register_new_ledger (GNCLedgerDisplay *ledger)
	Create a new "register" plugin page, given a pointer to an already created ledger.

Account *	gnc_plugin_page_register_get_account (GncPluginPageRegister *page)
	Get the Account associated with this register page.

Transaction *	gnc_plugin_page_register_get_current_txn (GncPluginPageRegister *page)
	Get the currently selected transaction in this register page.

Query *	gnc_plugin_page_register_get_query (GncPluginPage *plugin_page)
	This function is called to get the query associated with this plugin page.

void	gnc_plugin_page_register_query_update (GncPluginPageRegister page, Query query)
	This updates the query after the filters have been applied.

void	gnc_plugin_page_register_update_for_search_query (GncPluginPageRegister *page)
	This checks if the register is a search register and if so saves the query.

void	gnc_plugin_register_set_enable_refresh (GncPluginPageRegister *page, gboolean enable_refresh)
	This allows controlling when refreshes happen, used to reduce refreshes when different aspects of the register filter change, namely date and status.

void	gnc_plugin_page_register_clear_current_filter (GncPluginPage *plugin_page)
	This function clears the registers current filter.

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.

GNCSplitReg *	gnc_plugin_page_register_get_gsr (GncPluginPage *plugin_page)
	Get the GNCSplitReg data structure associated with this register page.

FilterData *	gnc_plugin_page_register_get_filter_data (GncPluginPage *plugin_page)
	Get the FilterData data structure associated with this register page.

SortData *	gnc_plugin_page_register_get_sort_data (GncPluginPage *plugin_page)
	Get the SortData data structure associated with this register page.

GType	gnc_plugin_page_register_get_type (void)
	Retrieve the type number for the plugin page.

Variables
GncPluginPage *	RegisterFilterDialog::plugin_page

GtkWidget *	RegisterFilterDialog::dialog

GtkWidget *	RegisterFilterDialog::table

GtkWidget *	RegisterFilterDialog::start_earliest

GtkWidget *	RegisterFilterDialog::start_relative_check

GtkWidget *	RegisterFilterDialog::start_relative

GtkWidget *	RegisterFilterDialog::start_date_check

GtkWidget *	RegisterFilterDialog::start_date

GtkWidget *	RegisterFilterDialog::start_days_check

GtkWidget *	RegisterFilterDialog::start_days

GtkWidget *	RegisterFilterDialog::end_latest

GtkWidget *	RegisterFilterDialog::end_relative_check

GtkWidget *	RegisterFilterDialog::end_relative

GtkWidget *	RegisterFilterDialog::end_date_check

GtkWidget *	RegisterFilterDialog::end_date

GtkWidget *	RegisterFilterDialog::end_days_check

GtkWidget *	RegisterFilterDialog::end_days

GtkWidget *	RegisterFilterDialog::num_days

cleared_match_t	RegisterFilterDialog::original_cleared_match

GncAccountingPeriod	RegisterFilterDialog::original_start_ap

time64	RegisterFilterDialog::original_start_time

int	RegisterFilterDialog::original_start_days

GncAccountingPeriod	RegisterFilterDialog::original_end_ap

time64	RegisterFilterDialog::original_end_time

int	RegisterFilterDialog::original_end_days

int	RegisterFilterDialog::original_days

bool	RegisterFilterDialog::original_save_filter

bool	RegisterFilterDialog::show_save_button

std::string	status_action::action_name

int	status_action::value

GtkWidget *	status_action::widget

GtkWidget *	FilterData::dialog

cleared_match_t	FilterData::cleared_match

GncAccountingPeriod	FilterData::start_ap

time64	FilterData::start_time

int	FilterData::start_days

GncAccountingPeriod	FilterData::end_ap

time64	FilterData::end_time

int	FilterData::end_days

int	FilterData::days

bool	FilterData::save_filter

GncPluginPage *	RegisterSortDialog::plugin_page

SplitRegister *	RegisterSortDialog::reg

GtkWidget *	RegisterSortDialog::dialog

GtkWidget *	RegisterSortDialog::num_radio

GtkWidget *	RegisterSortDialog::act_radio

SortType	RegisterSortDialog::original_sort_type

bool	RegisterSortDialog::original_reverse_order

bool	RegisterSortDialog::original_save_order

bool	RegisterSortDialog::show_save_button

GtkWidget *	SortData::dialog

SortType	SortData::sort_type

bool	SortData::reverse_order

bool	SortData::save_order

Detailed Description

Macro Definition Documentation

◆ COPY_SPLIT_LABEL

#define COPY_SPLIT_LABEL N_("_Copy Split")

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

◆ COPY_SPLIT_TIP

#define COPY_SPLIT_TIP N_("Copy the selected split into clipboard")

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

◆ COPY_TRANSACTION_LABEL

#define COPY_TRANSACTION_LABEL N_("_Copy Transaction")

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

◆ COPY_TRANSACTION_TIP

#define COPY_TRANSACTION_TIP N_("Copy the selected transaction into clipboard")

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

◆ CUT_SPLIT_LABEL

#define CUT_SPLIT_LABEL N_("Cu_t Split")

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

◆ CUT_SPLIT_TIP

#define CUT_SPLIT_TIP N_("Cut the selected split into clipboard")

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

◆ CUT_TRANSACTION_LABEL

#define CUT_TRANSACTION_LABEL N_("Cu_t Transaction")

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

◆ CUT_TRANSACTION_TIP

#define CUT_TRANSACTION_TIP N_("Cut the selected transaction into clipboard")

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

◆ DEFAULT_LINES_AMOUNT

#define DEFAULT_LINES_AMOUNT 50

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

◆ DELETE_SPLIT_LABEL

#define DELETE_SPLIT_LABEL N_("_Delete Split")

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

◆ DELETE_SPLIT_TIP

#define DELETE_SPLIT_TIP N_("Delete the current split")

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

◆ DELETE_TRANSACTION_LABEL

#define DELETE_TRANSACTION_LABEL N_("_Delete Transaction")

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

◆ DELETE_TRANSACTION_TIP

#define DELETE_TRANSACTION_TIP N_("Delete the current transaction")

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

◆ DUPLICATE_SPLIT_LABEL

#define DUPLICATE_SPLIT_LABEL N_("Dup_licate Split")

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

◆ DUPLICATE_SPLIT_TIP

#define DUPLICATE_SPLIT_TIP N_("Make a copy of the current split")

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

◆ DUPLICATE_TRANSACTION_LABEL

#define DUPLICATE_TRANSACTION_LABEL N_("Dup_licate Transaction")

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

◆ DUPLICATE_TRANSACTION_TIP

#define DUPLICATE_TRANSACTION_TIP N_("Make a copy of the current transaction")

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

◆ GNC_IS_PLUGIN_PAGE_REGISTER

#define GNC_IS_PLUGIN_PAGE_REGISTER ( obj ) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER))

Definition at line 60 of file gnc-plugin-page-register.h.

◆ GNC_IS_PLUGIN_PAGE_REGISTER_CLASS

#define GNC_IS_PLUGIN_PAGE_REGISTER_CLASS ( klass ) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER))

Definition at line 61 of file gnc-plugin-page-register.h.

◆ GNC_PLUGIN_PAGE_REGISTER

#define GNC_PLUGIN_PAGE_REGISTER ( obj ) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegister))

Definition at line 58 of file gnc-plugin-page-register.h.

◆ GNC_PLUGIN_PAGE_REGISTER_CLASS

#define GNC_PLUGIN_PAGE_REGISTER_CLASS ( klass ) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))

Definition at line 59 of file gnc-plugin-page-register.h.

◆ GNC_PLUGIN_PAGE_REGISTER_GET_CLASS

#define GNC_PLUGIN_PAGE_REGISTER_GET_CLASS ( obj ) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))

Definition at line 62 of file gnc-plugin-page-register.h.

◆ GNC_PLUGIN_PAGE_REGISTER_NAME

#define GNC_PLUGIN_PAGE_REGISTER_NAME "GncPluginPageRegister"

Definition at line 63 of file gnc-plugin-page-register.h.

◆ GNC_TYPE_PLUGIN_PAGE_REGISTER

#define GNC_TYPE_PLUGIN_PAGE_REGISTER (gnc_plugin_page_register_get_type ())

Definition at line 57 of file gnc-plugin-page-register.h.

◆ JUMP_LINKED_INVOICE_LABEL

#define JUMP_LINKED_INVOICE_LABEL N_("Jump to Business item")

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

◆ JUMP_LINKED_INVOICE_TIP

#define JUMP_LINKED_INVOICE_TIP N_("Jump to the linked invoice, bill, expense or credit note")

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

◆ KEY_ACCOUNT_GUID

#define KEY_ACCOUNT_GUID "AccountGuid"

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

◆ KEY_ACCOUNT_NAME

#define KEY_ACCOUNT_NAME "AccountName"

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

◆ KEY_DOUBLE_LINE

#define KEY_DOUBLE_LINE "DoubleLineMode"

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

◆ KEY_REGISTER_STYLE

#define KEY_REGISTER_STYLE "RegisterStyle"

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

◆ KEY_REGISTER_TYPE

#define KEY_REGISTER_TYPE "RegisterType"

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

◆ LABEL_ACCOUNT

#define LABEL_ACCOUNT "Account"

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

◆ LABEL_GL

#define LABEL_GL "GL"

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

◆ LABEL_SEARCH

#define LABEL_SEARCH "Search"

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

◆ LABEL_SUBACCOUNT

#define LABEL_SUBACCOUNT "SubAccount"

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

◆ LINK_TRANSACTION_LABEL

#define LINK_TRANSACTION_LABEL N_("_Manage Document Link…")

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

◆ LINK_TRANSACTION_OPEN_LABEL

#define LINK_TRANSACTION_OPEN_LABEL N_("_Open Linked Document")

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

◆ LINK_TRANSACTION_OPEN_TIP

#define LINK_TRANSACTION_OPEN_TIP N_("Open the linked document for the current transaction")

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

◆ LINK_TRANSACTION_TIP

#define LINK_TRANSACTION_TIP N_("Add, change, or unlink the document linked with the current transaction")

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

◆ PASTE_SPLIT_LABEL

#define PASTE_SPLIT_LABEL N_("_Paste Split")

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

◆ PASTE_SPLIT_TIP

#define PASTE_SPLIT_TIP N_("Paste the split from the clipboard")

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

◆ PASTE_TRANSACTION_LABEL

#define PASTE_TRANSACTION_LABEL N_("_Paste Transaction")

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

◆ PASTE_TRANSACTION_TIP

#define PASTE_TRANSACTION_TIP N_("Paste the transaction from the clipboard")

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

Enumeration Type Documentation

◆ GncPrefJumpMultSplits

enum GncPrefJumpMultSplits : gint

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

{
    JUMP_DEFAULT = 0, /* Do nothing */
    JUMP_LARGEST_VALUE_FIRST_SPLIT = 1,
    JUMP_SMALLEST_VALUE_FIRST_SPLIT = 2,
} GncPrefJumpMultSplits;

Function Documentation

◆ G_DEFINE_TYPE_WITH_PRIVATE()

G_DEFINE_TYPE_WITH_PRIVATE	(	GncPluginPageRegister	,
		gnc_plugin_page_register	,
		GNC_TYPE_PLUGIN_PAGE
	)

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

{
    GncPluginPageRegister* page;
    GncPluginPageRegisterPrivate* priv;
    GncPluginPage* plugin_page;
    GNCSplitReg* gsr;
    const GList* item;
    GList* book_list;
    gchar* label;
    gchar* label_color;
    QofQuery* q;
 
    // added for version 4.0 onwards
    if (!gnc_features_check_used (gnc_get_current_book(), GNC_FEATURE_REG_SORT_FILTER))
        gnc_features_set_used (gnc_get_current_book(), GNC_FEATURE_REG_SORT_FILTER);
 
    // added for version 4.14 onwards
    if (!gnc_using_equity_type_opening_balance_account (gnc_get_current_book()))
        gnc_set_use_equity_type_opening_balance_account (gnc_get_current_book());
 
    /* Is there an existing page? */
    gsr = GNC_SPLIT_REG(gnc_ledger_display_get_user_data (ledger));
    if (gsr)
    {
        item = gnc_gobject_tracking_get_list (GNC_PLUGIN_PAGE_REGISTER_NAME);
        for (; item; item = g_list_next (item))
        {
            page = (GncPluginPageRegister*)item->data;
            priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
            if (priv->gsr == gsr)
                return GNC_PLUGIN_PAGE (page);
        }
    }
 
    page = GNC_PLUGIN_PAGE_REGISTER(g_object_new (GNC_TYPE_PLUGIN_PAGE_REGISTER, nullptr));
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (page);
    priv->ledger = ledger;
    priv->key = *guid_null();
 
    plugin_page = GNC_PLUGIN_PAGE (page);
    label = gnc_plugin_page_register_get_tab_name (plugin_page);
    gnc_plugin_page_set_page_name (plugin_page, label);
    g_free (label);
 
    label_color = gnc_plugin_page_register_get_tab_color (plugin_page);
    gnc_plugin_page_set_page_color (plugin_page, label_color);
    g_free (label_color);
 
    label = gnc_plugin_page_register_get_long_name (plugin_page);
    gnc_plugin_page_set_page_long_name (plugin_page, label);
    g_free (label);
 
    q = gnc_ledger_display_get_query (ledger);
    book_list = qof_query_get_books (q);
    for (item = book_list; item; item = g_list_next (item))
        gnc_plugin_page_add_book (plugin_page, (QofBook*)item->data);
    // Do not free the list. It is owned by the query.
 
    priv->component_manager_id = 0;
    return plugin_page;
}

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

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page));
 
    gnc_ppr_filter_clear_current_filter (plugin_page);
}

◆ 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 580 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 596 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_filter_data()

struct FilterData * gnc_plugin_page_register_get_filter_data ( GncPluginPage * plugin_page )

Get the FilterData data structure associated with this register page.

Parameters

plugin_page A "register" page.

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

{
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page), NULL);
 
    GncPluginPageRegister* page = GNC_PLUGIN_PAGE_REGISTER(plugin_page);
    GncPluginPageRegisterPrivate* priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE(page);
 
    return &priv->fd;
}

◆ 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 3766 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 1853 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_sort_data()

struct SortData * gnc_plugin_page_register_get_sort_data ( GncPluginPage * plugin_page )

Get the SortData data structure associated with this register page.

Parameters

plugin_page A "register" page.

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

{
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page), NULL);
 
    GncPluginPageRegister* page = GNC_PLUGIN_PAGE_REGISTER(plugin_page);
    GncPluginPageRegisterPrivate* priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE(page);
 
    return &priv->sd;
}

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

{
    GNCLedgerDisplay* ledger;
    GncPluginPage* plugin_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);
 
    plugin_page = gnc_plugin_page_register_new_common (ledger);
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE (plugin_page);
    priv->key = *xaccAccountGetGUID (account);
 
    LEAVE ("%p", plugin_page);
    return plugin_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 494 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 503 of file gnc-plugin-page-register.cpp.

{
    return gnc_plugin_page_register_new_common (ledger);
}

◆ gnc_plugin_page_register_query_update()

void gnc_plugin_page_register_query_update	(	GncPluginPageRegister *	page,
		Query *	query
	)

This updates the query after the filters have been applied.

Parameters

plugin_page	A pointer to the GncPluginPageRegister.
query	The updated query

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

{
    GncPluginPageRegisterPrivate* priv;
 
    ENTER(" ");
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE(page);
 
    // clear previous filter query and save current
    qof_query_destroy (priv->filter_query);
    priv->filter_query = qof_query_copy (query);
 
    if (priv->enable_refresh)
        gnc_ledger_display_refresh (priv->ledger);
    LEAVE(" ");
}

◆ 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 3750 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_update_for_search_query()

void gnc_plugin_page_register_update_for_search_query ( GncPluginPageRegister * page )

This checks if the register is a search register and if so saves the query.

Parameters

plugin_page A pointer to the GncPluginPageRegister.

Definition at line 1883 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);
 
    if (reg->type == SEARCH_LEDGER)
    {
        Query* query_tmp = gnc_ledger_display_get_query (priv->ledger);
 
        // if filter_query is NULL, then the dialogue find has been run
        // before coming here. if query_tmp does not equal filter_query
        // then the dialogue find has been run again before coming here
        if ((priv->filter_query == NULL) ||
            (!qof_query_equal (query_tmp, priv->filter_query)))
        {
            qof_query_destroy (priv->search_query);
            priv->search_query = qof_query_copy (query_tmp);
        }
        gnc_ledger_display_set_query (priv->ledger, priv->search_query);
    }
}

◆ gnc_plugin_register_set_enable_refresh()

void gnc_plugin_register_set_enable_refresh	(	GncPluginPageRegister *	page,
		gboolean	enable_refresh
	)

This allows controlling when refreshes happen, used to reduce refreshes when different aspects of the register filter change, namely date and status.

Parameters

plugin_page	A pointer to the GncPluginPageRegister.
enable_refresh	Used to controll wehn refresh is required

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

{
    GncPluginPageRegisterPrivate* priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(page));
 
    priv = GNC_PLUGIN_PAGE_REGISTER_GET_PRIVATE(page);
 
    priv->enable_refresh = enable_refresh;
}

◆ gnc_ppr_filter_by()

void gnc_ppr_filter_by	(	GncPluginPage *	plugin_page,
		Query *	query,
		FilterData *	fd,
		bool	show_save_button
	)

This function is called for the filter dialog.

Parameters

plugin_page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.
query	A pointer to the current register query.
fd	A pointer to the filter data structure for remembering state.
show_save_button	Set to True to show save button.

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

{
    RegisterFilterDialog *rfd;
 
    ENTER(" ");
 
    rfd = g_new0 (RegisterFilterDialog, 1);
 
    rfd->plugin_page = plugin_page;
    rfd->show_save_button = show_save_button;
 
    ppr_filter_dialog_create (rfd, fd, query);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_clear_current_filter()

void gnc_ppr_filter_clear_current_filter ( GncPluginPage * plugin_page )

This function is used to clear the current filter so that a specific split can be shown in the register.

Parameters

page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

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

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page));
 
    auto fd = gnc_plugin_page_register_get_filter_data (plugin_page);
 
    set_filterdata_to_defaults (fd, false);
 
    ppr_filter_update_date_query (plugin_page);
}

◆ gnc_ppr_filter_days_changed_cb()

void gnc_ppr_filter_days_changed_cb	(	GtkSpinButton *	button,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_SPIN_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(button %p, page %p)", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    fd->days = gtk_spin_button_get_value (GTK_SPIN_BUTTON(button));
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_end_cb()

void gnc_ppr_filter_end_cb	(	GtkWidget *	radio,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_RADIO_BUTTON(radio));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(radio %s(%p), page %p)",
          gtk_buildable_get_name (GTK_BUILDABLE(radio)), radio, rfd->plugin_page);
 
    if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(radio)))
    {
        LEAVE("1st callback of pair. Defer to 2nd callback.");
        return;
    }
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(radio));
    gboolean active = !g_strcmp0 (name, "end_date_choose");
    gtk_widget_set_sensitive (rfd->end_date, active);
    get_filter_times (rfd);
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_end_toggle_cb()

void gnc_ppr_filter_end_toggle_cb	(	GtkToggleButton *	button,
		RegisterFilterDialog *	rfd
	)

This function is called when one of the check buttons for end relative or end date is changed.

It activates the associated widget and deactivates the other.

Parameters

button	A pointer to a GtkToggleButton widget.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("End toggle button (%p), plugin_page %p", button, rfd->plugin_page);
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
 
    gboolean active = gtk_toggle_button_get_active (button);
 
    gtk_widget_set_sensitive (rfd->end_latest, !active);
 
    if (g_strcmp0 (name, "end_date_check") == 0)
    {
        set_sensitive_end_widget (rfd, rfd->end_date, active);
 
        set_checkbutton_with_blocking (rfd->end_relative_check,
                                       rfd->end_days_check,
                                       (GFunc)gnc_ppr_filter_end_toggle_cb,
                                       rfd, FALSE);
    }
    if (g_strcmp0 (name, "end_relative_check") == 0)
    {
        set_sensitive_end_widget (rfd, rfd->end_relative, active);
 
        set_checkbutton_with_blocking (rfd->end_date_check,
                                       rfd->end_days_check,
                                       (GFunc)gnc_ppr_filter_end_toggle_cb,
                                       rfd, FALSE);
    }
    if (g_strcmp0 (name, "end_days_check") == 0)
    {
        set_sensitive_end_widget (rfd, rfd->end_days, active);
 
        set_checkbutton_with_blocking (rfd->end_date_check,
                                       rfd->end_relative_check,
                                       (GFunc)gnc_ppr_filter_end_toggle_cb,
                                       rfd, FALSE);
    }
    get_filter_times (rfd);
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_response_cb()

void gnc_ppr_filter_response_cb	(	GtkDialog *	dialog,
		gint	response,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_DIALOG(dialog));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER(" ");
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
    auto gsr = gnc_plugin_page_register_get_gsr (rfd->plugin_page);
 
    if ((fd->start_time > 0 && fd->end_time > 0) && (fd->start_time > fd->end_time))
    {
        auto response = gnc_ok_cancel_dialog (GTK_WINDOW(rfd->dialog),
                                              GTK_RESPONSE_CANCEL,
                                              _("The Start date is after the End date.\n"
                                                "Select Cancel to change dates.\n"));
        if (response == GTK_RESPONSE_CANCEL)
            return;
    }
 
    if (response != GTK_RESPONSE_OK)
    {
        /* Remove the old status match */
        fd->cleared_match = rfd->original_cleared_match;
        gnc_plugin_register_set_enable_refresh (GNC_PLUGIN_PAGE_REGISTER(rfd->plugin_page), FALSE);
        ppr_filter_update_status_query (rfd->plugin_page);
        gnc_plugin_register_set_enable_refresh (GNC_PLUGIN_PAGE_REGISTER(rfd->plugin_page), TRUE);
 
        fd->start_ap = rfd->original_start_ap;
        fd->start_time = rfd->original_start_time;
        fd->start_days = rfd->original_start_days;
        fd->end_ap = rfd->original_end_ap;
        fd->end_time = rfd->original_end_time;
        fd->end_days = rfd->original_end_days;
 
        fd->days = rfd->original_days;
        fd->save_filter = rfd->original_save_filter;
        ppr_filter_update_date_query (rfd->plugin_page);
    }
    else
    {
        // clear the filter when unticking the save option
        if (!fd->save_filter && rfd->original_save_filter)
            ppr_filter_save_filter (gsr, "");
 
        rfd->original_save_filter = fd->save_filter;
 
        if (fd->save_filter)
            ppr_filter_save_filter_parts (gsr, fd);
    }
    rfd->dialog = nullptr;
    fd->dialog = nullptr;
    g_free (rfd);
    gtk_widget_destroy (GTK_WIDGET(dialog));
    LEAVE(" ");
}

◆ gnc_ppr_filter_save_cb()

void gnc_ppr_filter_save_cb	(	GtkToggleButton *	button,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("Save toggle button (%p), plugin_page %p", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    /* Compute the new save filter status */
    if (gtk_toggle_button_get_active (button))
        fd->save_filter = true;
    else
        fd->save_filter = false;
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_select_range_cb()

void gnc_ppr_filter_select_range_cb	(	GtkRadioButton *	button,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_RADIO_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(button %p, page %p)", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
    gboolean active = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(button));
 
    if (active && g_strcmp0 (name, "filter_show_range") == 0)
    {
        gtk_widget_set_sensitive (rfd->table, active);
        gtk_widget_set_sensitive (rfd->num_days, !active);
        get_filter_times (rfd);
    }
    else if (active && g_strcmp0 (name, "filter_show_days") == 0)
    {
        gtk_widget_set_sensitive (rfd->table, !active);
        gtk_widget_set_sensitive (rfd->num_days, active);
        fd->days = gtk_spin_button_get_value (GTK_SPIN_BUTTON(rfd->num_days));
    }
    else
    {
        gtk_widget_set_sensitive (rfd->table, FALSE);
        gtk_widget_set_sensitive (rfd->num_days, FALSE);
        set_filterdata_to_defaults (fd, true);
    }
    ppr_filter_update_date_query (rfd->plugin_page);
    LEAVE(" ");
}

◆ gnc_ppr_filter_set_tooltip()

void gnc_ppr_filter_set_tooltip	(	GncPluginPage *	plugin_page,
		FilterData *	fd
	)

This function is used to update the tooltip shown in the register which shows a summary of the current filter.

Parameters

page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.
fd	A pointer to the filter data used for filter state.

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

{
    GList *t_list = nullptr;
 
    ENTER(" ");
 
    auto gsr = gnc_plugin_page_register_get_gsr (plugin_page);
 
    // filtered start time
    if (fd->start_time != 0)
    {
        auto sdate = qof_print_date (fd->start_time);
        t_list = g_list_prepend
            (t_list, g_strdup_printf ("%s %s", _("Start Date:"), sdate));
        g_free (sdate);
    }
 
    // filtered number of days
    if (fd->days > 0)
    {
        t_list = g_list_prepend
            (t_list, g_strdup_printf ("%s %d", _("Show previous number of days:"),
                                      fd->days));
    }
    // filtered end time
    if (fd->end_time != 0)
    {
        auto edate = qof_print_date (fd->end_time);
        t_list = g_list_prepend
            (t_list, g_strdup_printf ("%s %s", _("End Date:"), edate));
        g_free (edate);
    }
 
    // filtered match items
    if (fd->cleared_match != CLEARED_ALL)
    {
        GList *show = nullptr;
        GList *hide = nullptr;
 
        update_match_filter_text (fd->cleared_match, 0x01, _("Unreconciled"),
                                  &show, &hide);
        update_match_filter_text (fd->cleared_match, 0x02, _("Cleared"),
                                  &show, &hide);
        update_match_filter_text (fd->cleared_match, 0x04, _("Reconciled"),
                                  &show, &hide);
        update_match_filter_text (fd->cleared_match, 0x08, _("Frozen"),
                                  &show, &hide);
        update_match_filter_text (fd->cleared_match, 0x10, _("Voided"),
                                  &show, &hide);
 
        show = g_list_reverse (show);
        hide = g_list_reverse (hide);
 
        if (show)
        {
            auto str = gnc_list_formatter (show);
            t_list = g_list_prepend
                (t_list, g_strdup_printf ("%s %s", _("Show:"), str));
            g_free (str);
        }
 
        if (hide)
        {
            auto str = gnc_list_formatter (hide);
            t_list = g_list_prepend
                (t_list, g_strdup_printf ("%s %s", _("Hide:"), str));
            g_free (str);
        }
 
        g_list_free_full (show, g_free);
        g_list_free_full (hide, g_free);
    }
 
    t_list = g_list_reverse (t_list);
 
    if (t_list)
        t_list = g_list_prepend (t_list, g_strdup (_("Filter By:")));
 
    // free the existing text if present
    if (gsr->filter_text)
        g_free (gsr->filter_text);
 
    // set the tooltip text variable in the gsr
    gsr->filter_text = gnc_g_list_stringjoin (t_list, "\n");
 
    g_list_free_full (t_list, g_free);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_start_cb()

void gnc_ppr_filter_start_cb	(	GtkWidget *	radio,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_RADIO_BUTTON(radio));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(radio %s(%p), page %p)",
           gtk_buildable_get_name (GTK_BUILDABLE(radio)), radio, rfd->plugin_page);
 
    if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(radio)))
    {
        LEAVE("1st callback of pair. Defer to 2nd callback.");
        return;
    }
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(radio));
    gboolean active = !g_strcmp0 (name, "start_date_choose");
    gtk_widget_set_sensitive (rfd->start_date, active);
    get_filter_times (rfd);
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_start_end_days_changed_cb()

void gnc_ppr_filter_start_end_days_changed_cb	(	GtkSpinButton *	button,
		RegisterFilterDialog *	rfd
	)

This function is called when the "days ago" 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 "days ago" spin button.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_SPIN_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(button %p, page %p)", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
 
    if (g_strcmp0 (name, "start_days_spin") == 0)
        fd->start_days = gtk_spin_button_get_value (GTK_SPIN_BUTTON(button));
 
    if (g_strcmp0 (name, "end_days_spin") == 0)
        fd->end_days = gtk_spin_button_get_value (GTK_SPIN_BUTTON(button));
 
    get_filter_times (rfd);
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_start_toggle_cb()

void gnc_ppr_filter_start_toggle_cb	(	GtkToggleButton *	button,
		RegisterFilterDialog *	rfd
	)

This function is called when one of the check buttons for start relative or start date is changed.

It activates the associated widget and deactivates the other.

Parameters

button	A pointer to a GtkToggleButton widget.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("Start toggle button (%p), plugin_page %p", button, rfd->plugin_page);
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
 
    gboolean active = gtk_toggle_button_get_active (button);
 
    gtk_widget_set_sensitive (rfd->start_earliest, !active);
 
    if (g_strcmp0 (name, "start_date_check") == 0)
    {
        set_sensitive_start_widget (rfd, rfd->start_date, active);
 
        set_checkbutton_with_blocking (rfd->start_relative_check,
                                       rfd->start_days_check,
                                       (GFunc)gnc_ppr_filter_start_toggle_cb,
                                       rfd, FALSE);
    }
    if (g_strcmp0 (name, "start_relative_check") == 0)
    {
        set_sensitive_start_widget (rfd, rfd->start_relative, active);
 
        set_checkbutton_with_blocking (rfd->start_date_check,
                                       rfd->start_days_check,
                                       (GFunc)gnc_ppr_filter_start_toggle_cb,
                                       rfd, FALSE);
    }
    if (g_strcmp0 (name, "start_days_check") == 0)
    {
        set_sensitive_start_widget (rfd, rfd->start_days, active);
 
        set_checkbutton_with_blocking (rfd->start_date_check,
                                       rfd->start_relative_check,
                                       (GFunc)gnc_ppr_filter_start_toggle_cb,
                                       rfd, FALSE);
    }
    get_filter_times (rfd);
    ppr_filter_update_date_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_status_clear_all_cb()

void gnc_ppr_filter_status_clear_all_cb	(	GtkButton *	button,
		RegisterFilterDialog *	rfd
	)

This function is called whenever the "clear 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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(button %p, page %p)", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    /* Turn off all the check menu items */
    for (const auto& action : status_actions)
    {
        set_checkbutton_with_blocking (action.widget, nullptr,
                                       (GFunc)gnc_ppr_filter_status_one_cb,
                                       rfd, FALSE);
    }
 
    /* Set the requested status */
    fd->cleared_match = CLEARED_NONE;
    ppr_filter_update_status_query (rfd->plugin_page);
    LEAVE(" ");
}

◆ gnc_ppr_filter_status_one_cb()

void gnc_ppr_filter_status_one_cb	(	GtkToggleButton *	button,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
 
    ENTER("toggle button %s (%p), plugin_page %p", name, button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    /* Determine what status bit to change */
    int value = CLEARED_NONE;
    for (const auto& action : status_actions)
    {
        if (action.action_name.compare (name) == 0)
        {
            value = action.value;
            break;
        }
    }
 
    /* Compute the new match status */
    if (gtk_toggle_button_get_active (button))
        fd->cleared_match = (cleared_match_t)(fd->cleared_match | value);
    else
        fd->cleared_match = (cleared_match_t)(fd->cleared_match & ~value);
 
    ppr_filter_update_status_query (rfd->plugin_page);
 
    LEAVE(" ");
}

◆ gnc_ppr_filter_status_select_all_cb()

void gnc_ppr_filter_status_select_all_cb	(	GtkButton *	button,
		RegisterFilterDialog *	rfd
	)

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.
rfd	A pointer to the filter dialog structure.

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

{
    g_return_if_fail (GTK_IS_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rfd->plugin_page));
 
    ENTER("(button %p, page %p)", button, rfd->plugin_page);
 
    auto fd = gnc_plugin_page_register_get_filter_data (rfd->plugin_page);
 
    /* Turn on all the check menu items */
    for (const auto& action : status_actions)
    {
        set_checkbutton_with_blocking (action.widget, nullptr,
                                       (GFunc)gnc_ppr_filter_status_one_cb,
                                       rfd, TRUE);
    }
 
    /* Set the requested status */
    fd->cleared_match = CLEARED_ALL;
    ppr_filter_update_status_query (rfd->plugin_page);
    LEAVE(" ");
}

◆ gnc_ppr_filter_update_register()

void gnc_ppr_filter_update_register ( GncPluginPage * plugin_page )

This function is called to update the register.

Parameters

page	A pointer to the GncPluginPageRegister that is associated with this filter dialog.

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

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page));
 
    auto gsr = gnc_plugin_page_register_get_gsr (plugin_page);
 
    if (!gsr)
        return;
 
    auto fd = gnc_plugin_page_register_get_filter_data (plugin_page);
    GNCLedgerDisplayType ledger_type = gnc_ledger_display_type (gsr->ledger);
 
    /* Set the filter for the split register and status of save filter button */
    fd->save_filter = false;
 
    ppr_filter_load_filter_parts (gsr, ledger_type, fd);
 
    if (ledger_type == LD_GL)
    {
        SplitRegister *reg = gnc_ledger_display_get_split_register (gsr->ledger);
 
        if (reg->type != GENERAL_JOURNAL) // search ledger and the like
            set_filterdata_to_defaults (fd, false);
    }
    /* Update Query with Filter Status and Dates */
    ppr_filter_update_status_query (plugin_page);
    ppr_filter_update_date_query (plugin_page);
}

◆ gnc_ppr_sort_button_cb()

void gnc_ppr_sort_button_cb	(	GtkToggleButton *	button,
		RegisterSortDialog *	rsd
	)

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

Parameters

button	The button that was toggled.
rsd	A pointer to the sort dialog structure.

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

{
    g_return_if_fail (GTK_IS_TOGGLE_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rsd->plugin_page));
 
    auto name = gtk_buildable_get_name (GTK_BUILDABLE(button));
 
    ENTER("button %s(%p), page %p", name, button, rsd->plugin_page);
 
    if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(button)))
    {
        LEAVE("1st callback of pair. Defer to 2nd callback.");
        return;
    }
 
    auto gsr = gnc_plugin_page_register_get_gsr (rsd->plugin_page);
 
    SortType type = SortTypefromString (name);
    gnc_split_reg_sort (gsr, type, no_force, refresh);
    LEAVE (" ");
}

◆ gnc_ppr_sort_dialog()

void gnc_ppr_sort_dialog	(	GncPluginPage *	plugin_page,
		SplitRegister *	reg,
		SortData *	sd,
		bool	show_save_button
	)

This function is called for the sort dialog.

Parameters

plugin_page	A pointer to the GncPluginPageRegister that is associated with this sort dialog.
reg	A pointer to the SplitRegister of the current register.
fd	A pointer to the sort data structure for remembering state.
show_save_button	Set to True to show save button.

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

{
    RegisterSortDialog *rsd;
 
    ENTER(" ");
 
    rsd = g_new0 (RegisterSortDialog, 1);
 
    rsd->plugin_page = plugin_page;
    rsd->reg = reg;
    rsd->show_save_button = show_save_button;
 
    gnc_ppr_sort_dialog_create (rsd, sd);
 
    LEAVE(" ");
}

◆ gnc_ppr_sort_order_reverse_cb()

void gnc_ppr_sort_order_reverse_cb	(	GtkToggleButton *	button,
		RegisterSortDialog *	rsd
	)

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.
rsd	A pointer to the sort dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rsd->plugin_page));
 
    ENTER("Reverse toggle button (%p), page %p", button, rsd->plugin_page);
 
    /* Compute the new save sort order */
    auto sd = gnc_plugin_page_register_get_sort_data (rsd->plugin_page);
    auto gsr = gnc_plugin_page_register_get_gsr (rsd->plugin_page);
 
    sd->reverse_order = gtk_toggle_button_get_active (button);
    gnc_split_reg_set_sort_reversed (gsr, sd->reverse_order, refresh);
    LEAVE (" ");
}

◆ gnc_ppr_sort_order_save_cb()

void gnc_ppr_sort_order_save_cb	(	GtkToggleButton *	button,
		RegisterSortDialog *	rsd
	)

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.
rsd	A pointer to the sort dialog structure.

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

{
    g_return_if_fail (GTK_IS_CHECK_BUTTON(button));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rsd->plugin_page));
 
    ENTER("Save toggle button (%p), page %p", button, rsd->plugin_page);
 
    /* Compute the new save sort order */
    auto sd = gnc_plugin_page_register_get_sort_data (rsd->plugin_page);
 
    if (gtk_toggle_button_get_active (button))
        sd->save_order = true;
    else
        sd->save_order = false;
    LEAVE (" ");
}

◆ gnc_ppr_sort_response_cb()

void gnc_ppr_sort_response_cb	(	GtkDialog *	dialog,
		gint	response,
		RegisterSortDialog *	rsd
	)

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.
rsd	A pointer to the sort dialog structure.

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

{
    g_return_if_fail (GTK_IS_DIALOG(dialog));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(rsd->plugin_page));
 
    ENTER(" ");
 
    auto sd = gnc_plugin_page_register_get_sort_data (rsd->plugin_page);
    auto gsr = gnc_plugin_page_register_get_gsr (rsd->plugin_page);
 
    if (response != GTK_RESPONSE_OK)
    {
        // Restore the original sort order
        gnc_split_reg_set_sort_reversed (gsr, rsd->original_reverse_order, no_refresh);
        sd->reverse_order = rsd->original_reverse_order;
        // use force as sort_type may still be the same if only reverse_order changed
        gnc_split_reg_sort (gsr, rsd->original_sort_type, force, refresh);
        sd->sort_type = rsd->original_sort_type;
        sd->save_order = rsd->original_save_order;
    }
    else
    {
        // clear the sort when unticking the save option
        if ((!sd->save_order) && ((rsd->original_sort_type) ||
                                  (rsd->original_reverse_order)))
        {
            gnc_ppr_sort_set_order (gsr, DEFAULT_SORT_ORDER);
            gnc_ppr_sort_set_reversed (gsr, false);
        }
        rsd->original_sort_type = sd->sort_type;
        rsd->original_reverse_order = sd->reverse_order;
 
        if (sd->save_order)
        {
            SortType type = gnc_split_reg_get_sort_type (gsr);
            std::string sort_type = (SortTypeasString (type));
 
            gnc_ppr_sort_set_order (gsr, sort_type);
            gnc_ppr_sort_set_reversed (gsr, sd->reverse_order);
        }
    }
    gnc_book_option_remove_cb (OPTION_NAME_NUM_FIELD_SOURCE,
                               gnc_ppr_sort_book_option_changed,
                               (gpointer)rsd);
    rsd->dialog = nullptr;
    rsd->num_radio = nullptr;
    rsd->act_radio = nullptr;
    sd->dialog = nullptr;
    g_free (rsd);
    gtk_widget_destroy (GTK_WIDGET(dialog));
    LEAVE (" ");
}

◆ gnc_ppr_sort_update_register()

void gnc_ppr_sort_update_register ( GncPluginPage * plugin_page )

This function is called to update the register.

Parameters

page	A pointer to the GncPluginPageRegister that is associated with this sort order dialog.

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

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE_REGISTER(plugin_page));
 
    auto sd = gnc_plugin_page_register_get_sort_data (plugin_page);
    auto gsr = gnc_plugin_page_register_get_gsr (plugin_page);
    GNCLedgerDisplayType ledger_type = gnc_ledger_display_type (gsr->ledger);
 
    sd->save_order = false;
 
    // Set the sort direction for the split register and status of save order button
    sd->reverse_order = gnc_ppr_sort_get_reversed (gsr);
 
    PINFO("Loaded Sort reversed order is %s", sd->reverse_order ? "true" : "false");
 
    gnc_split_reg_set_sort_reversed (gsr, sd->reverse_order, no_refresh);
    if (sd->reverse_order)
        sd->save_order = true;
 
    // Set the sort order for the split register and status of save order button
    std::string sort_type = gnc_ppr_sort_get_order (gsr);
 
    PINFO("Loaded Sort type is %s", sort_type.c_str());
 
    SortType type = SortTypefromString (sort_type.c_str());
 
    gnc_split_reg_sort (gsr, type, no_force, no_refresh);
 
    if (sort_type.compare (DEFAULT_SORT_ORDER) != 0)
        sd->save_order = true;
 
    if (ledger_type == LD_GL)
    {
        auto reg = gnc_ledger_display_get_split_register (gsr->ledger);
 
        if (reg->type != GENERAL_JOURNAL) // search ledger and the like
        {
            gnc_split_reg_sort (gsr, SortTypefromString (DEFAULT_SORT_ORDER.c_str()), no_force, no_refresh);
            sd->reverse_order = false;
            sd->save_order = false;
        }
    }
}