Budgets

gnc-budget_view.c – Budget display widget More...

Files
file	gnc-budget.h
	GnuCash Budgets.
file	gnc-budget-view.c
	File to define budget views for gnucash (the actual display of the budget, along with some calculations and event handlers).
file	gnc-budget-view.h
file	gnc-plugin-page-budget.h
file	gnc-tree-model-budget.h
	provides some utilities for working with the list of budgets in a book.

Data Structures
struct	GncBudgetView
struct	GncBudgetViewClass
struct	GncBudgetViewPrivate
	the private budget view structure More...
struct	BudgetAccumulationInfo
	Action for when a selection in a gnc budget view is changed. More...
struct	GncPluginPageBudget
struct	GncPluginPageBudgetClass

Macros
#define	GNC_TYPE_BUDGET   (gnc_budget_get_type ())
#define	GNC_BUDGET(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_BUDGET, GncBudget))
#define	GNC_BUDGET_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_BUDGET, GncBudgetClass))
#define	GNC_IS_BUDGET(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_BUDGET))
#define	GNC_IS_BUDGET_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_BUDGET))
#define	GNC_BUDGET_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_BUDGET, GncBudgetClass))
#define	GNC_BUDGET_MAX_NUM_PERIODS_DIGITS   3
#define	GNC_BUDGET_NOTES_PATH   "notes"
#define	gnc_budget_return_guid(X)   (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
#define	gnc_budget_lookup_direct(g, b)   gnc_budget_lookup(&(g),(b))
#define	PLUGIN_PAGE_BUDGET_CM_CLASS   "budget-view"
#define	STATE_SECTION_PREFIX   "Budget"
#define	GNC_BUDGET_VIEW_GET_PRIVATE(o)   ((GncBudgetViewPrivate*)gnc_budget_view_get_instance_private((GncBudgetView*)o))
#define	BUDGET_GUID   "Budget GncGUID"
#define	GNC_TYPE_BUDGET_VIEW   (gnc_budget_view_get_type ())
#define	GNC_BUDGET_VIEW(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_BUDGET_VIEW, GncBudgetView))
#define	GNC_BUDGET_VIEW_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_BUDGET_VIEW, GncBudgetViewClass))
#define	GNC_IS_BUDGET_VIEW(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_BUDGET_VIEW))
#define	GNC_IS_BUDGET_VIEW_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_BUDGET_VIEW))
#define	GNC_BUDGET_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_BUDGET_VIEW, GncBudgetViewClass))
#define	GNC_BUDGET_VIEW_NAME   "GncBudgetView"
#define	GNC_TYPE_PLUGIN_PAGE_BUDGET   (gnc_plugin_page_budget_get_type ())
#define	GNC_PLUGIN_PAGE_BUDGET(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudget))
#define	GNC_PLUGIN_PAGE_BUDGET_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudgetClass))
#define	GNC_IS_PLUGIN_PAGE_BUDGET(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET))
#define	GNC_IS_PLUGIN_PAGE_BUDGET_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_BUDGET))
#define	GNC_PLUGIN_PAGE_BUDGET_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudgetClass))
#define	GNC_PLUGIN_PAGE_BUDGET_NAME   "GncPluginPageBudget"

Enumerations
enum	{ TOTALS_TYPE_INCOME, TOTALS_TYPE_EXPENSES, TOTALS_TYPE_ASSET_LIAB_EQ, TOTALS_TYPE_REMAINDER }
enum	{ BUDGET_GUID_COLUMN, BUDGET_NAME_COLUMN, BUDGET_DESCRIPTION_COLUMN, BUDGET_LIST_NUM_COLS }

Functions
GType	gnc_budget_get_type (void)
gboolean	gnc_budget_register (void)
GncBudget *	gnc_budget_new (QofBook *book)
	Creates and initializes a Budget.
void	gnc_budget_destroy (GncBudget *budget)
	Deletes the given budget object. More...
void	gnc_budget_begin_edit (GncBudget *bgt)
void	gnc_budget_commit_edit (GncBudget *bgt)
GncBudget *	gnc_budget_clone (const GncBudget *budget)
	Clones a budget creating a copy.
const GncGUID *	gnc_budget_get_guid (const GncBudget *budget)
void	gnc_budget_set_name (GncBudget *budget, const gchar *name)
	Set/Get the name of the Budget.
const gchar *	gnc_budget_get_name (const GncBudget *budget)
void	gnc_budget_set_description (GncBudget *budget, const gchar *description)
	Set/Get the description of the Budget.
const gchar *	gnc_budget_get_description (const GncBudget *budget)
void	gnc_budget_set_num_periods (GncBudget *budget, guint num_periods)
	Set/Get the number of periods in the Budget.
guint	gnc_budget_get_num_periods (const GncBudget *budget)
void	gnc_budget_set_recurrence (GncBudget *budget, const Recurrence *r)
const Recurrence *	gnc_budget_get_recurrence (const GncBudget *budget)
time64	gnc_budget_get_period_start_date (const GncBudget *budget, guint period_num)
	Get the starting date of the Budget period.
time64	gnc_budget_get_period_end_date (const GncBudget *budget, guint period_num)
	Get the ending date of the Budget period.
void	gnc_budget_set_account_period_value (GncBudget *budget, const Account *account, guint period_num, gnc_numeric val)
void	gnc_budget_unset_account_period_value (GncBudget *budget, const Account *account, guint period_num)
gboolean	gnc_budget_is_account_period_value_set (const GncBudget *budget, const Account *account, guint period_num)
gnc_numeric	gnc_budget_get_account_period_value (const GncBudget *budget, const Account *account, guint period_num)
gnc_numeric	gnc_budget_get_account_period_actual_value (const GncBudget *budget, Account *account, guint period_num)
void	gnc_budget_set_account_period_note (GncBudget *budget, const Account *account, guint period_num, const gchar *note)
const gchar *	gnc_budget_get_account_period_note (const GncBudget *budget, const Account *account, guint period_num)
GncBudget *	gnc_budget_get_default (QofBook *book)
GncBudget *	gnc_budget_lookup (const GncGUID *guid, const QofBook *book)
GncBudgetView *	gnc_budget_view_new (GncBudget *budget, AccountFilterDialog *fd)
	Create new gnc budget view. More...
void	gnc_budget_view_set_show_account_code (GncBudgetView *budget_view, gboolean show_account_code)
gboolean	gnc_budget_view_get_show_account_code (GncBudgetView *budget_view)
void	gnc_budget_view_set_show_account_description (GncBudgetView *budget_view, gboolean show_account_desc)
gboolean	gnc_budget_view_get_show_account_description (GncBudgetView *budget_view)
GtkTreeSelection *	gnc_budget_view_get_selection (GncBudgetView *budget_view)
	returns the current selection in the gnc budget view. More...
Account *	gnc_budget_view_get_account_from_path (GncBudgetView *budget_view, GtkTreePath *path)
GtkWidget *	gnc_budget_view_get_account_tree_view (GncBudgetView *budget_view)
GList *	gnc_budget_view_get_selected_accounts (GncBudgetView *budget_view)
void	gnc_budget_view_save (GncBudgetView *budget_view, GKeyFile *key_file, const gchar *group_name)
gboolean	gnc_budget_view_restore (GncBudgetView *budget_view, GKeyFile *key_file, const gchar *group_name)
void	gnc_budget_view_delete_budget (GncBudgetView *budget_view)
void	gnc_budget_view_save_account_filter (GncBudgetView *budget_view)
void	gnc_budget_view_refresh (GncBudgetView *budget_view)
	refreshes the current budget view More...
GType	gnc_budget_view_get_type (void)
GType	gnc_plugin_page_budget_get_type (void)
GncPluginPage *	gnc_plugin_page_budget_new (GncBudget *budget)
	Create a new "budget" plugin page. More...
void	gnc_budget_gui_delete_budget (GncBudget *budget)
GtkTreeModel *	gnc_tree_model_budget_new (QofBook *book)
void	gnc_tree_view_budget_set_model (GtkTreeView *tv, GtkTreeModel *tm)
GncBudget *	gnc_tree_model_budget_get_budget (GtkTreeModel *tm, GtkTreeIter *iter)
gboolean	gnc_tree_model_budget_get_iter_for_budget (GtkTreeModel *tm, GtkTreeIter *iter, GncBudget *bgt)

Variables
GtkBox	GncBudgetView::w
GtkBoxClass	GncBudgetViewClass::w
GtkTreeView *	GncBudgetViewPrivate::tree_view
GtkTreeView *	GncBudgetViewPrivate::totals_tree_view
GtkWidget *	GncBudgetViewPrivate::totals_scroll_window
GtkAdjustment *	GncBudgetViewPrivate::hadj
GncBudget *	GncBudgetViewPrivate::budget
GncGUID	GncBudgetViewPrivate::key
gboolean	GncBudgetViewPrivate::use_red_color
GList *	GncBudgetViewPrivate::period_col_list
GList *	GncBudgetViewPrivate::totals_col_list
GtkTreeViewColumn *	GncBudgetViewPrivate::total_col
AccountFilterDialog *	GncBudgetViewPrivate::fd
Account *	GncBudgetViewPrivate::rootAcct
gboolean	GncBudgetViewPrivate::show_account_code
gboolean	GncBudgetViewPrivate::show_account_desc
GtkCellRenderer *	GncBudgetViewPrivate::temp_cr
GtkCellEditable *	GncBudgetViewPrivate::temp_ce
gnc_numeric	BudgetAccumulationInfo::total
GncBudget *	BudgetAccumulationInfo::budget
guint	BudgetAccumulationInfo::period_num
GNCPriceDB *	BudgetAccumulationInfo::pdb
gnc_commodity *	BudgetAccumulationInfo::total_currency

Detailed Description

gnc-budget_view.c – Budget display widget

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
TOTALS_TYPE_INCOME	This total is Income type.
TOTALS_TYPE_EXPENSES	This total is Expenses type.
TOTALS_TYPE_ASSET_LIAB_EQ	This total is Asset/Liab/Equity type.
TOTALS_TYPE_REMAINDER	This total is Remaining to Budget.

Definition at line 97 of file gnc-budget-view.c.

{
    TOTALS_TYPE_INCOME,        
    TOTALS_TYPE_EXPENSES,      
    TOTALS_TYPE_ASSET_LIAB_EQ, 
    TOTALS_TYPE_REMAINDER      
};

anonymous enum

anonymous enum

Todo:

This file is poorly named, since it covers both model and view.

Definition at line 42 of file gnc-tree-model-budget.h.

{
    BUDGET_GUID_COLUMN,
    BUDGET_NAME_COLUMN,
    BUDGET_DESCRIPTION_COLUMN,
    BUDGET_LIST_NUM_COLS
};

Function Documentation

gnc_budget_destroy()

void gnc_budget_destroy

(

GncBudget *

budget

)

Deletes the given budget object.

Definition at line 321 of file gnc-budget.cpp.

{
    g_return_if_fail(GNC_IS_BUDGET(budget));
    gnc_budget_begin_edit(budget);
    qof_instance_set_dirty(&budget->inst);
    qof_instance_set_destroying(budget, TRUE);
    gnc_budget_commit_edit(budget);
}

gnc_budget_view_get_selection()

GtkTreeSelection * gnc_budget_view_get_selection

(

GncBudgetView *

budget_view

)

returns the current selection in the gnc budget view.

Returns the current selection in the gnc budget view by using the macro GNC_BUDGET_VIEW_GET_PRIVATE.

Definition at line 318 of file gnc-budget-view.c.

{
    GncBudgetViewPrivate *priv;

    g_return_val_if_fail (GNC_IS_BUDGET_VIEW(budget_view), NULL);

    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return gtk_tree_view_get_selection (GTK_TREE_VIEW(priv->tree_view));
}

gnc_budget_view_new()

GncBudgetView * gnc_budget_view_new	(	GncBudget *	budget,
		AccountFilterDialog *	fd
	)

Create new gnc budget view.

Create a new "budget" display widget.

As the name suggests, this creates a new gnc budget view.

Returns

The newly created widget

Definition at line 188 of file gnc-budget-view.c.

{
    GncBudgetView        *budget_view;
    GncBudgetViewPrivate *priv;

    g_return_val_if_fail (GNC_IS_BUDGET(budget), NULL);
    ENTER(" ");

    budget_view = g_object_new (GNC_TYPE_BUDGET_VIEW, NULL);

    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    priv->budget = budget;
    priv->key = *gnc_budget_get_guid (budget);
    priv->fd = fd;
    priv->total_col = NULL;
    priv->show_account_code = FALSE;
    priv->show_account_desc = FALSE;
    gbv_create_widget (budget_view);

    LEAVE("new budget view %p", budget_view);
    return budget_view;
}

gnc_budget_view_refresh()

void gnc_budget_view_refresh

(

GncBudgetView *

budget_view

)

refreshes the current budget view

The function will step through to only display the columns that are set as visible, and will add any needed columns (e.g. the totals column).

Definition at line 1477 of file gnc-budget-view.c.

{
    // Column identifiers
    enum {
        code_column         = 1,
        description_column  = 2,
        startPeriods_column = 3
        // The Totals column will be after the periods columns.
    };

    GncBudgetViewPrivate *priv;
    gint num_periods;
    gint num_periods_visible;
    GtkTreeViewColumn *col, *code_col, *desc_col;
    GList *col_list;
    GList *totals_col_list;
    GdkRGBA *note_color, *note_color_selected;
    GtkStyleContext *stylectxt;

    ENTER("view %p", budget_view);

    g_return_if_fail (budget_view != NULL);
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);

    stylectxt = gtk_widget_get_style_context (GTK_WIDGET(priv->tree_view));
    gtk_style_context_get (stylectxt, GTK_STATE_FLAG_SELECTED, "background-color", &note_color, NULL);
    gtk_style_context_get (stylectxt, GTK_STATE_FLAG_NORMAL, "background-color", &note_color_selected, NULL);

    num_periods = gnc_budget_get_num_periods (priv->budget);

    col_list = g_list_reverse (priv->period_col_list);
    totals_col_list = g_list_reverse (priv->totals_col_list);
    num_periods_visible = g_list_length (col_list);

    /* Hide any unneeded extra columns */
    while (num_periods_visible > num_periods)
    {
        col = GTK_TREE_VIEW_COLUMN (col_list->data);
        gtk_tree_view_remove_column (GTK_TREE_VIEW(priv->tree_view), col);
        col_list = g_list_delete_link (col_list, col_list);
        num_periods_visible--;

        col = GTK_TREE_VIEW_COLUMN(totals_col_list->data);
        gtk_tree_view_remove_column (GTK_TREE_VIEW(priv->totals_tree_view), col);
        totals_col_list = g_list_delete_link (totals_col_list, totals_col_list);
    }

    gnc_tree_view_configure_columns (GNC_TREE_VIEW(priv->tree_view));

    // set visibility of the account code columns
    code_col = gnc_tree_view_find_column_by_name (GNC_TREE_VIEW(priv->tree_view), "account-code");
    gtk_tree_view_column_set_visible (code_col, priv->show_account_code);
    code_col = gtk_tree_view_get_column (GTK_TREE_VIEW(priv->totals_tree_view), code_column);
    gtk_tree_view_column_set_visible (code_col, priv->show_account_code);

    // set visibility of the account description columns
    desc_col = gnc_tree_view_find_column_by_name (GNC_TREE_VIEW(priv->tree_view), "description");
    gtk_tree_view_column_set_visible (desc_col, priv->show_account_desc);
    desc_col = gtk_tree_view_get_column (GTK_TREE_VIEW(priv->totals_tree_view), description_column);
    gtk_tree_view_column_set_visible (desc_col, priv->show_account_desc);

    /* If we're creating new columns to be appended to already existing
     * columns, first delete the total column. (Then regenerate after
     * new columns have been appended */
    if (num_periods_visible != 0 && num_periods > num_periods_visible)
    {
        /* Delete the totals column */
        col = priv->total_col;
        gtk_tree_view_remove_column (GTK_TREE_VIEW(priv->tree_view), col);
        priv->total_col = NULL;
        col = gtk_tree_view_get_column (GTK_TREE_VIEW(priv->totals_tree_view),
            startPeriods_column + num_periods_visible);
        gtk_tree_view_remove_column (GTK_TREE_VIEW(priv->totals_tree_view), col);
    }

    /* Create any needed columns */
    while (num_periods_visible < num_periods)
    {
        GtkCellRenderer *renderer = gnc_cell_renderer_text_flag_new ();
        g_object_set (renderer, "flag-color-rgba", note_color, NULL);
        g_object_set (renderer, "flag-color-rgba-selected", note_color_selected, NULL);

        col = gnc_tree_view_account_add_custom_column_renderer (
                  GNC_TREE_VIEW_ACCOUNT(priv->tree_view), "",
                  budget_col_source, budget_col_edited, renderer);
        g_object_set_data (G_OBJECT(col), "budget_view", budget_view);
        g_object_set_data (G_OBJECT(col), "period_num", GUINT_TO_POINTER(num_periods_visible));
        col_list = g_list_prepend (col_list, col);

        // add some padding to the right of the numbers
        gbv_renderer_add_padding (renderer);

        g_signal_connect (G_OBJECT(renderer), "edited", (GCallback)gbv_col_edited_cb, budget_view);
        g_signal_connect (G_OBJECT(renderer), "editing-started",
                          (GCallback)gdv_editing_started_cb, budget_view);
        g_signal_connect (G_OBJECT(renderer), "editing-canceled",
                          (GCallback)gdv_editing_canceled_cb, budget_view);
        col = gbv_create_totals_column (budget_view, num_periods_visible);
        if (col != NULL)
        {
            gtk_tree_view_append_column (priv->totals_tree_view, col);
            totals_col_list = g_list_prepend (totals_col_list, col);
        }

        num_periods_visible++;
    }

    gdk_rgba_free (note_color);
    gdk_rgba_free (note_color_selected);

    priv->period_col_list = g_list_reverse (col_list);
    priv->totals_col_list = g_list_reverse (totals_col_list);

    if (priv->total_col == NULL)
    {
        gchar title[MAX_DATE_LENGTH + 1];
        guint titlelen;
        GDate *date;
        GtkCellRenderer* renderer;

        priv->total_col = gnc_tree_view_account_add_custom_column (
                              GNC_TREE_VIEW_ACCOUNT(priv->tree_view), _("Total"),
                              budget_total_col_source, NULL);

        // set column title alignment to right to match column data
        gtk_tree_view_column_set_alignment (priv->total_col, 1.0);

        // set a minimum column size based on the date length, adds some space to the column
        date = g_date_new_dmy (31, 12, 2018);
        titlelen = qof_print_gdate (title, MAX_DATE_LENGTH, date);
        if (titlelen > 0)
        {
            PangoLayout *layout = gtk_widget_create_pango_layout (GTK_WIDGET(budget_view), title);
            PangoRectangle logical_rect;
            pango_layout_set_width (layout, -1);
            pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
            g_object_unref (layout);

            gtk_tree_view_column_set_min_width (priv->total_col, logical_rect.width);
        }
        g_date_free (date);
        g_object_set_data (G_OBJECT(priv->total_col), "budget_view", budget_view);

        // as we only have one renderer/column, use this function to get it
        renderer = gnc_tree_view_column_get_renderer (priv->total_col);

        // add some padding to the right of the numbers
        gbv_renderer_add_padding (renderer);

        col = gbv_create_totals_column (budget_view, -1);
        if (col != NULL)
            gtk_tree_view_append_column (priv->totals_tree_view, col);
    }
    gbv_refresh_col_titles (budget_view);

    PINFO("Number of columns is %d, totals columns is %d",
          gtk_tree_view_get_n_columns (priv->tree_view), gtk_tree_view_get_n_columns (priv->totals_tree_view));

    LEAVE(" ");
}

gnc_plugin_page_budget_new()

GncPluginPage* gnc_plugin_page_budget_new

(

GncBudget *

budget

)

Create a new "budget" plugin page.

Returns

The newly created plugin page.

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

{
    GncPluginPageBudgetPrivate *priv;
    gchar* label;
    const GList *item;

    g_return_val_if_fail (GNC_IS_BUDGET(budget), NULL);
    ENTER(" ");

    /* Is there an existing page? */
    item = gnc_gobject_tracking_get_list (GNC_PLUGIN_PAGE_BUDGET_NAME);
    for ( ; item; item = g_list_next (item))
    {
        auto plugin_page = GNC_PLUGIN_PAGE_BUDGET(item->data);
        priv = GNC_PLUGIN_PAGE_BUDGET_GET_PRIVATE(plugin_page);
        if (priv->budget == budget)
        {
            LEAVE("existing budget page %p", plugin_page);
            return GNC_PLUGIN_PAGE(plugin_page);
        }
    }

    auto plugin_page = GNC_PLUGIN_PAGE_BUDGET (g_object_new (GNC_TYPE_PLUGIN_PAGE_BUDGET, nullptr));

    priv = GNC_PLUGIN_PAGE_BUDGET_GET_PRIVATE(plugin_page);
    priv->budget = budget;
    priv->delete_budget = FALSE;
    priv->key = *gnc_budget_get_guid (budget);
    priv->reportPage = NULL;
    label = g_strdup_printf ("%s: %s", _("Budget"), gnc_budget_get_name (budget));
    g_object_set (G_OBJECT(plugin_page), "page-name", label, NULL);
    g_free (label);
    LEAVE("new budget page %p", plugin_page);
    return GNC_PLUGIN_PAGE(plugin_page);
}