An Account Tree Plugin

Files
file	gnc-plugin-page-account-tree.h
	Functions providing a chart of account page.

Data Structures
struct	delete_helper_t
struct	GncPluginPageAccountTreePrivate
struct	Adopter
struct	Adopters
struct	GncPluginPageAccountTree
struct	GncPluginPageAccountTreeClass

Macros
#define	PLUGIN_PAGE_ACCT_TREE_CM_CLASS   "plugin-page-acct-tree"
#define	STATE_SECTION   "Account Hierarchy"
#define	DELETE_DIALOG_FILTER   "filter"
#define	DELETE_DIALOG_ACCOUNT   "account"
#define	DELETE_DIALOG_TRANS_MAS   "trans_mas"
#define	DELETE_DIALOG_SA_MAS   "sa_mas"
#define	DELETE_DIALOG_SA_TRANS_MAS   "sa_trans_mas"
#define	DELETE_DIALOG_SA_TRANS   "sa_trans"
#define	DELETE_DIALOG_SA_SPLITS   "sa_has_split"
#define	DELETE_DIALOG_OK_BUTTON   "deletebutton"
#define	GNC_PLUGIN_PAGE_ACCOUNT_TREE_GET_PRIVATE(o)   ((GncPluginPageAccountTreePrivate*)gnc_plugin_page_account_tree_get_instance_private((GncPluginPageAccountTree*)o))
#define	GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE   (gnc_plugin_page_account_tree_get_type ())
#define	GNC_PLUGIN_PAGE_ACCOUNT_TREE(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE, GncPluginPageAccountTree))
#define	GNC_PLUGIN_PAGE_ACCOUNT_TREE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE, GncPluginPageAccountTreeClass))
#define	GNC_IS_PLUGIN_PAGE_ACCOUNT_TREE(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE))
#define	GNC_IS_PLUGIN_PAGE_ACCOUNT_TREE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE))
#define	GNC_PLUGIN_PAGE_ACCOUNT_TREE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE, GncPluginPageAccountTreeClass))
#define	GNC_PLUGIN_PAGE_ACCOUNT_TREE_NAME   "GncPluginPageAccountTree"

Enumerations
enum	{ ACCOUNT_SELECTED, LAST_SIGNAL }

Functions
void	gppat_populate_trans_mas_list (GtkToggleButton *sa_mrb, GtkWidget *dialog)
void	gppat_set_insensitive_iff_rb_active (GtkWidget *widget, GtkToggleButton *b)
GncPluginPage *	gnc_plugin_page_account_tree_new (void)
	Create a new "account tree" plugin page. More...
void	gnc_plugin_page_account_tree_open (Account *account, GtkWindow *win)
	Given a pointer to an account, the account tree will open and the account will be selected (if any). More...
Account *	gnc_plugin_page_account_tree_get_current_account (GncPluginPageAccountTree *page)
	Given a pointer to an account tree plugin page, return the selected account (if any). More...
GType	gnc_plugin_page_account_tree_get_type (void)
	Retrieve the type number for an "account tree" plugin page. More...

Detailed Description

Function Documentation

gnc_plugin_page_account_tree_get_current_account()

Account * gnc_plugin_page_account_tree_get_current_account

(

GncPluginPageAccountTree *

page

)

Given a pointer to an account tree plugin page, return the selected account (if any).

Parameters

page	The "account tree" page.

Returns

The currently selected account. NULL if no account is selected.

Definition at line 518 of file gnc-plugin-page-account-tree.cpp.

{
    GncPluginPageAccountTreePrivate *priv;
    Account *account;

    priv = GNC_PLUGIN_PAGE_ACCOUNT_TREE_GET_PRIVATE(page);
    ENTER("page %p (tree view %p)", page, priv->tree_view);
    account = gnc_tree_view_account_get_selected_account (GNC_TREE_VIEW_ACCOUNT(priv->tree_view));
    if (account == NULL)
    {
        LEAVE("no account");
        return NULL;
    }

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

gnc_plugin_page_account_tree_get_type()

GType gnc_plugin_page_account_tree_get_type

(

void

)

Retrieve the type number for an "account tree" plugin page.

Returns

The type number.

gnc_plugin_page_account_tree_new()

GncPluginPage * gnc_plugin_page_account_tree_new

(

void

)

Create a new "account tree" plugin page.

Returns

The newly created plugin page.

Definition at line 302 of file gnc-plugin-page-account-tree.cpp.

{
    ENTER(" ");
    auto plugin_page = GNC_PLUGIN_PAGE_ACCOUNT_TREE
        (g_object_new (GNC_TYPE_PLUGIN_PAGE_ACCOUNT_TREE, nullptr));

    LEAVE("new account tree page %p", plugin_page);
    return GNC_PLUGIN_PAGE (plugin_page);
}

gnc_plugin_page_account_tree_open()

void gnc_plugin_page_account_tree_open	(	Account *	account,
		GtkWindow *	win
	)

Given a pointer to an account, the account tree will open and the account will be selected (if any).

Parameters

account	The "account" to be selected.
win	The "window" where the account tree is to be selected.

Definition at line 459 of file gnc-plugin-page-account-tree.cpp.

{
    GncPluginPageAccountTreePrivate *priv;
    GncPluginPageAccountTree *page;
    GncPluginPage *plugin_page = NULL;
    const GList *page_list;
    GtkWidget   *window;

    /* Find Accounts page */
    page_list = gnc_gobject_tracking_get_list(GNC_PLUGIN_PAGE_ACCOUNT_TREE_NAME);

    // If we have a window, look for account page in that window
    if (gnc_list_length_cmp (page_list, 0))
    {
        if (win != NULL)
        {
            for ( ; page_list; page_list = g_list_next(page_list))
            {
                plugin_page = GNC_PLUGIN_PAGE(page_list->data);
                if (GTK_WINDOW(plugin_page->window) == win)
                    break;
            }
        }
        else // if no window, open first account page in list
            plugin_page = GNC_PLUGIN_PAGE(page_list->data);
    }
    else // we have no account pages, create one
        plugin_page = gnc_plugin_page_account_tree_new ();

    g_return_if_fail(plugin_page);
    window = plugin_page->window;

    gnc_main_window_open_page (GNC_MAIN_WINDOW(window), plugin_page);

    page = GNC_PLUGIN_PAGE_ACCOUNT_TREE (plugin_page);
    priv = GNC_PLUGIN_PAGE_ACCOUNT_TREE_GET_PRIVATE(page);

    if (account != NULL)
    {
        Account *root_account = gnc_get_current_root_account ();
        Account *parent_account = NULL;
        Account *temp_account = account;

        g_hash_table_insert (priv->fd.filter_override, account, account);

        // make sure we override all the parent accounts to root
        while (parent_account != root_account)
        {
            parent_account = gnc_account_get_parent (temp_account);

            g_hash_table_insert (priv->fd.filter_override, parent_account, parent_account);
            temp_account = parent_account;
        }
        gnc_tree_view_account_refilter (GNC_TREE_VIEW_ACCOUNT(priv->tree_view));
        gnc_tree_view_account_set_selected_account (GNC_TREE_VIEW_ACCOUNT(priv->tree_view), account);
    }
}