Budgets

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

Files
file	gnc-budget.h
	GnuCash Budgets.
file	gnc-tree-model-budget.h
	provides some utilities for working with the list of budgets in a book.
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

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	{ BUDGET_GUID_COLUMN , BUDGET_NAME_COLUMN , BUDGET_DESCRIPTION_COLUMN , BUDGET_LIST_NUM_COLS }
enum	{ TOTALS_TYPE_INCOME , TOTALS_TYPE_EXPENSES , TOTALS_TYPE_ASSET_LIAB_EQ , TOTALS_TYPE_REMAINDER }

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.
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)
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)
GncBudgetView *	gnc_budget_view_new (GncBudget *budget, AccountFilterDialog *fd)
	Create new gnc budget view.
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.
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
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.
void	gnc_budget_gui_delete_budget (GncBudget *budget)

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

Macro Definition Documentation

BUDGET_GUID

#define BUDGET_GUID   "Budget GncGUID"

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

GNC_BUDGET

#define GNC_BUDGET

(

o

)

(G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_BUDGET, GncBudget))

Definition at line 84 of file gnc-budget.h.

                                               : *(guid_null()))
 
void gnc_budget_set_name(GncBudget* budget, const gchar* name);
/*@ dependent @*/
const gchar* gnc_budget_get_name(const GncBudget* budget);
 
void gnc_budget_set_description(GncBudget* budget, const gchar* description);
/*@ dependent @*/
const gchar* gnc_budget_get_description(const GncBudget* budget);
 
void gnc_budget_set_num_periods(GncBudget* budget, guint num_periods);
guint gnc_budget_get_num_periods(const GncBudget* budget);
 
void gnc_budget_set_recurrence(GncBudget *budget, const Recurrence *r);
/*@ dependent @*/
const Recurrence * gnc_budget_get_recurrence(const GncBudget *budget);
 
time64 gnc_budget_get_period_start_date(const GncBudget* budget, guint period_num);
 
time64 gnc_budget_get_period_end_date(const GncBudget* budget, guint period_num);
 
/* Period indices are zero-based. */
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);
 
/* get the budget account period's budgeted value */
gnc_numeric gnc_budget_get_account_period_value(
    const GncBudget *budget, const Account *account, guint period_num);
 
/* get the budget account period's actual value, including children,
   excluding closing entries */
gnc_numeric gnc_budget_get_account_period_actual_value(
    const GncBudget *budget, Account *account, guint period_num);
 
/* get/set the budget account period's note */
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);
 
/* Returns some budget in the book, or NULL. */
GncBudget* gnc_budget_get_default(QofBook *book);
 
/* Get the budget associated with the given GncGUID from the given book. */
/*@ dependent @*/
GncBudget* gnc_budget_lookup (const GncGUID *guid, const QofBook *book);
#define  gnc_budget_lookup_direct(g,b) gnc_budget_lookup(&(g),(b))
 
#ifdef __cplusplus
}
#endif
 
 
#endif // __BUDGET_H__
 

GNC_BUDGET_CLASS

#define GNC_BUDGET_CLASS

(

k

)

(G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_BUDGET, GncBudgetClass))

Definition at line 86 of file gnc-budget.h.

GNC_BUDGET_GET_CLASS

#define GNC_BUDGET_GET_CLASS

(

o

)

(G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_BUDGET, GncBudgetClass))

Definition at line 92 of file gnc-budget.h.

gnc_budget_lookup_direct

#define gnc_budget_lookup_direct	(		g,
			b
	)		gnc_budget_lookup(&(g),(b))

Definition at line 176 of file gnc-budget.h.

GNC_BUDGET_MAX_NUM_PERIODS_DIGITS

#define GNC_BUDGET_MAX_NUM_PERIODS_DIGITS   3

Definition at line 96 of file gnc-budget.h.

GNC_BUDGET_NOTES_PATH

#define GNC_BUDGET_NOTES_PATH   "notes"

Definition at line 98 of file gnc-budget.h.

gnc_budget_return_guid

#define gnc_budget_return_guid

(

X

)

(X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))

Definition at line 119 of file gnc-budget.h.

                                               : *(guid_null()))

GNC_BUDGET_VIEW

#define GNC_BUDGET_VIEW

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_BUDGET_VIEW, GncBudgetView))

Definition at line 44 of file gnc-budget-view.h.

GNC_BUDGET_VIEW_CLASS

#define GNC_BUDGET_VIEW_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_BUDGET_VIEW, GncBudgetViewClass))

Definition at line 45 of file gnc-budget-view.h.

GNC_BUDGET_VIEW_GET_CLASS

#define GNC_BUDGET_VIEW_GET_CLASS

(

obj

)

(G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_BUDGET_VIEW, GncBudgetViewClass))

Definition at line 48 of file gnc-budget-view.h.

GNC_BUDGET_VIEW_GET_PRIVATE

#define GNC_BUDGET_VIEW_GET_PRIVATE

(

o

)

((GncBudgetViewPrivate*)gnc_budget_view_get_instance_private((GncBudgetView*)o))

Definition at line 180 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;
}
 
static void
gnc_budget_view_class_init (GncBudgetViewClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS(klass);
 
    object_class->finalize = gnc_budget_view_finalize;
 
    g_signal_new ("account-activated", GNC_TYPE_BUDGET_VIEW, G_SIGNAL_RUN_LAST,
                  0, NULL, NULL, NULL, G_TYPE_NONE, 1, GNC_TYPE_ACCOUNT);
}
 
static void
gnc_budget_view_init (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
 
    ENTER("view %p", budget_view);
 
    gtk_orientable_set_orientation (GTK_ORIENTABLE(budget_view), GTK_ORIENTATION_VERTICAL);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    /* Keep track of the root account */
    priv->rootAcct = gnc_book_get_root_account (gnc_get_current_book());
 
    LEAVE("");
}
 
static void
gbv_treeview_update_grid_lines (gpointer prefs, gchar *pref, gpointer user_data)
{
    GtkTreeView *view = user_data;
    gtk_tree_view_set_grid_lines (GTK_TREE_VIEW(view), gnc_tree_view_get_grid_lines_pref ());
}
 
void
gnc_budget_view_set_show_account_code (GncBudgetView *budget_view, gboolean show_account_code)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    priv->show_account_code = show_account_code;
    gnc_budget_view_refresh (budget_view);
}
 
gboolean
gnc_budget_view_get_show_account_code (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return priv->show_account_code;
}
 
void
gnc_budget_view_set_show_account_description (GncBudgetView *budget_view, gboolean show_account_desc)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    priv->show_account_desc = show_account_desc;
    gnc_budget_view_refresh (budget_view);
}
 
gboolean
gnc_budget_view_get_show_account_description (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return priv->show_account_desc;
}
 
static void
gbv_update_use_red (gpointer prefs, gchar *pref, gpointer user_data)
{
    GncBudgetView *budget_view = user_data;
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    priv->use_red_color = gnc_prefs_get_bool (GNC_PREFS_GROUP_GENERAL,
                                              GNC_PREF_NEGATIVE_IN_RED);
}
 
static void
gnc_budget_view_finalize (GObject *object)
{
    GncBudgetView *budget_view;
    GncBudgetViewPrivate *priv;
 
    ENTER("object %p", object);
    budget_view = GNC_BUDGET_VIEW(object);
    g_return_if_fail (GNC_IS_BUDGET_VIEW(budget_view));
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    g_list_free (priv->period_col_list);
    g_list_free (priv->totals_col_list);
 
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_GRID_LINES_HORIZONTAL,
                                 gbv_treeview_update_grid_lines, priv->totals_tree_view);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_GRID_LINES_VERTICAL,
                                 gbv_treeview_update_grid_lines, priv->totals_tree_view);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_NEGATIVE_IN_RED,
                                 gbv_update_use_red, budget_view);
 
    G_OBJECT_CLASS(gnc_budget_view_parent_class)->finalize (object);
    LEAVE(" ");
}
 
GtkTreeSelection*
gnc_budget_view_get_selection (GncBudgetView *budget_view)
{
    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));
}
 
Account*
gnc_budget_view_get_account_from_path (GncBudgetView *budget_view, GtkTreePath *path)
{
    GncBudgetViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_BUDGET_VIEW(budget_view), NULL);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return gnc_tree_view_account_get_account_from_path (GNC_TREE_VIEW_ACCOUNT(priv->tree_view), path);
}
 
GtkWidget*
gnc_budget_view_get_account_tree_view (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_BUDGET_VIEW(budget_view), NULL);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return GTK_WIDGET(priv->fd->tree_view);
}
 
GList*
gnc_budget_view_get_selected_accounts (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_BUDGET_VIEW(budget_view), NULL);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return gnc_tree_view_account_get_selected_accounts (GNC_TREE_VIEW_ACCOUNT(priv->tree_view));
}
 
static void
gbv_totals_scrollbar_value_changed_cb (GtkAdjustment *adj, GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_BUDGET_VIEW(budget_view));
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    gtk_adjustment_set_value (priv->hadj, gtk_adjustment_get_value (adj));
}
 
static gboolean
gbv_totals_tree_view_redraw_idle (GtkTreeView *view)
{
    gtk_widget_queue_draw (GTK_WIDGET(view));
    return FALSE;
}
 
static void
gbv_tree_view_model_row_changed_cb (GtkTreeModel *tree_model, GtkTreePath *path,
                                    GtkTreeIter *iter, gpointer user_data)
{
    GncBudgetView *budget_view = user_data;
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // The model row-changed signal can be emitted multiple times so we
    // use an idle_add to do a redraw of the totals tree view once
    g_idle_remove_by_data (priv->totals_tree_view);
    g_idle_add ((GSourceFunc)gbv_totals_tree_view_redraw_idle, priv->totals_tree_view);
}
 
/****************************
 * GncPluginPage Functions  *
 ***************************/
static void
gbv_create_widget (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
    GtkTreeSelection     *selection;
    GtkTreeView          *tree_view;
    GtkWidget            *scrolled_window;
    GtkAdjustment        *h_adj;
    GtkWidget            *h_scrollbar;
    GtkBox               *vbox;
    GtkListStore         *totals_tree_model;
    GtkTreeView          *totals_tree_view;
    GtkTreeViewColumn    *totals_title_col, *name_col, *code_col, *desc_col;
    GtkTreeIter           iter;
    GtkWidget            *h_separator;
    gchar                *state_section;
    gchar                 guidstr[GUID_ENCODING_LENGTH+1];
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    vbox = GTK_BOX(budget_view);
 
    // Set the name for this widget so it can be easily manipulated with css
    gtk_widget_set_name (GTK_WIDGET(vbox), "gnc-id-budget-page");
 
    // Accounts scroll window
    scrolled_window = gtk_scrolled_window_new (NULL, NULL);
    gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW(scrolled_window),
                                    GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 
    // Create Accounts tree_view
    tree_view = gnc_tree_view_account_new (FALSE);
    gtk_tree_view_set_headers_visible (tree_view, TRUE);
 
    guid_to_string_buff (&priv->key, guidstr);
    state_section = g_strjoin (" ", STATE_SECTION_PREFIX, guidstr, NULL);
    g_object_set (G_OBJECT(tree_view), "state-section", state_section, NULL);
    g_free (state_section);
 
    gnc_tree_view_configure_columns (GNC_TREE_VIEW(tree_view));
    priv->tree_view = tree_view;
    selection = gtk_tree_view_get_selection (tree_view);
    gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
 
    // make sure the account column is the expand column
    gnc_tree_view_expand_columns (GNC_TREE_VIEW(tree_view), "name", NULL);
    name_col = gnc_tree_view_find_column_by_name (GNC_TREE_VIEW(priv->tree_view), "name");
    gtk_tree_view_column_set_reorderable (name_col, FALSE);
 
    // Accounts filter
    priv->fd->tree_view = GNC_TREE_VIEW_ACCOUNT(priv->tree_view);
    gnc_tree_view_account_set_filter (GNC_TREE_VIEW_ACCOUNT(tree_view),
                                      gnc_plugin_page_account_tree_filter_accounts,
                                      priv->fd, NULL);
 
    // get the visibility of the account code column
    code_col = gnc_tree_view_find_column_by_name (GNC_TREE_VIEW(priv->tree_view), "account-code");
    priv->show_account_code = gtk_tree_view_column_get_visible (code_col);
    gtk_tree_view_column_set_reorderable (code_col, FALSE);
 
    // get the visibility of the account description column
    desc_col = gnc_tree_view_find_column_by_name (GNC_TREE_VIEW(priv->tree_view), "description");
    priv->show_account_desc = gtk_tree_view_column_get_visible (desc_col);
    gtk_tree_view_column_set_reorderable (desc_col, FALSE);
 
    // Add accounts tree view to scroll window
    gtk_container_add (GTK_CONTAINER(scrolled_window), GTK_WIDGET(tree_view));
 
    g_object_set (tree_view, "has-tooltip", TRUE, NULL);
    g_signal_connect (G_OBJECT(tree_view), "query-tooltip",
                      G_CALLBACK(query_tooltip_tree_view_cb), budget_view);
    g_signal_connect (G_OBJECT(tree_view), "row-activated",
                      G_CALLBACK(gbv_row_activated_cb), budget_view);
 
    // save the main scrolled window horizontal adjustment
    priv->hadj = gtk_scrolled_window_get_hadjustment (GTK_SCROLLED_WINDOW(scrolled_window));
 
    PINFO("Number of Created Account columns is %d", gtk_tree_view_get_n_columns (tree_view));
 
#if 0
    g_signal_connect (G_OBJECT(selection), "changed",
                      G_CALLBACK(gbv_selection_changed_cb), budget_view);
    g_signal_connect (G_OBJECT(tree_view), "button-press-event",
                      G_CALLBACK(gbv_button_press_cb), budget_view);
    gbv_selection_changed_cb (NULL, budget_view);
#endif
 
    // Totals scroll window
    priv->totals_scroll_window = gtk_scrolled_window_new (NULL, NULL);
    gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW(priv->totals_scroll_window),
                                    GTK_POLICY_AUTOMATIC, GTK_POLICY_NEVER); // horizontal/vertical
 
    h_adj = gtk_scrolled_window_get_hadjustment (GTK_SCROLLED_WINDOW(priv->totals_scroll_window));
    g_signal_connect (G_OBJECT(h_adj), "value-changed",
                      G_CALLBACK(gbv_totals_scrollbar_value_changed_cb), budget_view);
 
    // Create totals tree view
    totals_tree_model = gtk_list_store_new (4, G_TYPE_STRING, G_TYPE_INT, G_TYPE_STRING, G_TYPE_STRING);
    gtk_list_store_append (totals_tree_model, &iter);
    gtk_list_store_set (totals_tree_model, &iter, 0, _("Income"),
                                                  1, TOTALS_TYPE_INCOME, 2, " ", 3, " ", -1);
    gtk_list_store_append (totals_tree_model, &iter);
    gtk_list_store_set (totals_tree_model, &iter, 0, _("Expenses"),
                                                  1, TOTALS_TYPE_EXPENSES, 2, " ", 3, " ", -1);
    gtk_list_store_append (totals_tree_model, &iter);
    gtk_list_store_set (totals_tree_model, &iter, 0, _("Transfer"),
                                                  1, TOTALS_TYPE_ASSET_LIAB_EQ, 2, " ", 3, " ", -1);
    gtk_list_store_append (totals_tree_model, &iter);
    gtk_list_store_set (totals_tree_model, &iter, 0, _("Remaining to Budget"),
                                                  1, TOTALS_TYPE_REMAINDER, 2, " ", 3, " ", -1);
 
    totals_tree_view = GTK_TREE_VIEW(gtk_tree_view_new ());
    priv->totals_tree_view = totals_tree_view;
    gtk_tree_selection_set_mode (gtk_tree_view_get_selection (totals_tree_view), GTK_SELECTION_NONE);
    gtk_tree_view_set_headers_visible (totals_tree_view, FALSE);
    gtk_tree_view_set_model (totals_tree_view, GTK_TREE_MODEL(totals_tree_model));
    g_object_unref (totals_tree_model);
 
    // add the totals title column
    totals_title_col = gtk_tree_view_column_new_with_attributes ("", gtk_cell_renderer_text_new (), "text", 0, NULL);
    gtk_tree_view_column_set_expand (totals_title_col, TRUE);
    gtk_tree_view_column_set_sizing (totals_title_col, GTK_TREE_VIEW_COLUMN_FIXED);
    gtk_tree_view_append_column (totals_tree_view, totals_title_col);
 
    // add the totals account code column
    code_col = gtk_tree_view_column_new_with_attributes ("", gtk_cell_renderer_text_new(), "text", 2, NULL);
    gtk_tree_view_column_set_sizing (code_col, GTK_TREE_VIEW_COLUMN_FIXED);
    gtk_tree_view_append_column (totals_tree_view, code_col);
    gtk_tree_view_column_set_visible (code_col, priv->show_account_code);
 
    // add the totals account description column
    desc_col = gtk_tree_view_column_new_with_attributes ("", gtk_cell_renderer_text_new(), "text", 3, NULL);
    gtk_tree_view_column_set_sizing (desc_col, GTK_TREE_VIEW_COLUMN_FIXED);
    gtk_tree_view_append_column (totals_tree_view, desc_col);
    gtk_tree_view_column_set_visible (desc_col, priv->show_account_desc);
 
    // Add totals tree view to scroll window
    gtk_container_add (GTK_CONTAINER(priv->totals_scroll_window), GTK_WIDGET(totals_tree_view));
 
    // Set grid lines option to preference
    gtk_tree_view_set_grid_lines (GTK_TREE_VIEW(totals_tree_view), gnc_tree_view_get_grid_lines_pref ());
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_GRID_LINES_HORIZONTAL,
                           gbv_treeview_update_grid_lines, totals_tree_view);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_GRID_LINES_VERTICAL,
                           gbv_treeview_update_grid_lines, totals_tree_view);
 
    // get initial value and register prefs call back for use red color
    priv->use_red_color = gnc_prefs_get_bool (GNC_PREFS_GROUP_GENERAL, GNC_PREF_NEGATIVE_IN_RED);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_NEGATIVE_IN_RED,
                           gbv_update_use_red, budget_view);
 
    PINFO("Number of Created totals columns is %d", gtk_tree_view_get_n_columns (totals_tree_view));
 
    gtk_box_set_homogeneous (GTK_BOX(vbox), FALSE);
 
    gtk_box_pack_start (GTK_BOX(vbox), scrolled_window, /*expand*/TRUE, /*fill*/TRUE, 0);
 
    h_separator = gtk_separator_new (GTK_ORIENTATION_HORIZONTAL);
    gtk_box_pack_end (GTK_BOX(vbox), h_separator, /*expand*/FALSE, /*fill*/TRUE, 0);
 
    gtk_box_pack_start (GTK_BOX(vbox), GTK_WIDGET(priv->totals_scroll_window), /*expand*/FALSE, /*fill*/TRUE, 0);
 
    gtk_widget_show_all (GTK_WIDGET(vbox));
 
    // hide the account scroll window horizontal scroll bar
    h_scrollbar = gtk_scrolled_window_get_hscrollbar (GTK_SCROLLED_WINDOW(scrolled_window));
    gtk_widget_hide (h_scrollbar);
 
    g_signal_connect (G_OBJECT(tree_view), "size-allocate",
                      G_CALLBACK(gbv_treeview_resized_cb), budget_view);
 
    // Read account filter state information from budget section
    gnc_tree_view_account_restore_filter (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                          priv->fd,
                                          gnc_state_get_current(),
                                          gnc_tree_view_get_state_section (
                                          GNC_TREE_VIEW(priv->tree_view)));
 
    // use the model row-changed signal to do a redraw on the totals tree view
    g_signal_connect (G_OBJECT(gtk_tree_view_get_model (GTK_TREE_VIEW(tree_view))), "row-changed",
                      G_CALLBACK(gbv_tree_view_model_row_changed_cb), budget_view);
 
    gnc_budget_view_refresh (budget_view);
}
 
#define BUDGET_GUID "Budget GncGUID"
 
/***********************************************************************
 *  Save enough information about this view that it can                *
 *  be recreated next time the user starts gnucash.                    *
 *                                                                     *
 *  @param budget_view The view to save.                               *
 *                                                                     *
 *  @param key_file A pointer to the GKeyFile data structure where the *
 *  page information should be written.                                *
 *                                                                     *
 *  @param group_name The group name to use when saving data.          *
 **********************************************************************/
void
gnc_budget_view_save (GncBudgetView *budget_view, GKeyFile *key_file, const gchar *group_name)
{
    GncBudgetViewPrivate *priv;
 
    g_return_if_fail (budget_view != NULL);
    g_return_if_fail (key_file != NULL);
    g_return_if_fail (group_name != NULL);
 
    ENTER("view %p, key_file %p, group_name %s", budget_view, key_file, group_name);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Save the account filter and page state information to page section
    gnc_tree_view_account_save (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                priv->fd, key_file, group_name);
    LEAVE(" ");
}
 
 
/***********************************************************************
 *  Create a new plugin page based on the information saved
 *  during a previous instantiation of gnucash.
 *
 *  @param budget_view The budget view to be restored
 *
 *  @param key_file A pointer to the GKeyFile data structure where the
 *  page information should be read.
 *
 *  @param group_name The group name to use when restoring data.
 *
 *  @return TRUE if successful, FALSE if unsuccessful
 **********************************************************************/
gboolean
gnc_budget_view_restore (GncBudgetView *budget_view, GKeyFile *key_file, const gchar *group_name)
{
    GncBudgetViewPrivate *priv;
    GError *error = NULL;
    char *guid_str;
    GncGUID guid;
    GncBudget *bgt;
    QofBook *book;
    gboolean has_guid;
 
    g_return_val_if_fail (key_file, FALSE);
    g_return_val_if_fail (group_name, FALSE);
 
    ENTER("key_file %p, group_name %s", key_file, group_name);
 
    guid_str = g_key_file_get_string (key_file, group_name, BUDGET_GUID,
                                      &error);
    if (error)
    {
        g_warning ("error reading group %s key %s: %s",
                   group_name, BUDGET_GUID, error->message);
        g_error_free (error);
        error = NULL;
        return FALSE;
    }
    has_guid = string_to_guid (guid_str, &guid);
    g_free (guid_str);
 
    if (!has_guid)
    {
        return FALSE;
    }
 
    book = qof_session_get_book (gnc_get_current_session());
    bgt = gnc_budget_lookup (&guid, book);
    if (!bgt)
    {
        return FALSE;
    }
 
    /* Create the new view */
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Restore the account filter and page state information from page section
    gnc_tree_view_account_restore (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                   priv->fd, key_file, group_name);
    LEAVE(" ");
 
    return TRUE;
}
 
/***********************************************************************
 *  The budget associated with this view is about to be removed from   *
 *  the book. So drop any saved state we still have.                   *
 *                                                                     *
 *  @param budget_view The view to which the budget is associated.     *
 **********************************************************************/
void
gnc_budget_view_delete_budget (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
    gchar guidstr[GUID_ENCODING_LENGTH+1];
 
    g_return_if_fail (budget_view != NULL);
 
    ENTER("view %p", budget_view);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    guid_to_string_buff (&priv->key, guidstr);
    gnc_state_drop_sections_for (guidstr);
    g_object_set (G_OBJECT(priv->tree_view), "state-section", NULL, NULL);
 
    LEAVE(" ");
}
 
/***********************************************************************
 *  Save the Account filter information for this budget                *
 *                                                                     *
 *  @param budget_view The view to which the budget is associated.     *
 **********************************************************************/
void
gnc_budget_view_save_account_filter (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
 
    g_return_if_fail (budget_view != NULL);
 
    ENTER("view %p", budget_view);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Save account filter state information to budget section
    gnc_tree_view_account_save_filter (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                       priv->fd, gnc_state_get_current (),
                                       gnc_tree_view_get_state_section (
                                       GNC_TREE_VIEW(priv->tree_view)));
    LEAVE(" ");
}
 
#if 0
/***********************************************************************
 *   This button press handler calls the common button press handler
 *  for all pages.  The GtkTreeView eats all button presses and
 *  doesn't pass them up the widget tree, even when it doesn't do
 *  anything with them.  The only way to get access to the button
 *  presses in an account tree page is here on the tree view widget.
 *  Button presses on all other pages are caught by the signal
 *  registered in gnc-main-window.c.
 **********************************************************************/
static gboolean
gbv_button_press_cb (GtkWidget *widget, GdkEventButton *event,
                     GncBudgetView *budget_view)
{
    gboolean result;
 
    g_return_val_if_fail (budget_view != NULL, FALSE);
 
    ENTER("widget %p, event %p, page %p", widget, event, page);
    result = gnc_main_window_button_press_cb (widget, event, page);
    LEAVE(" ");
    return result;
}
#endif
 
static gboolean
gbv_key_press_cb (GtkWidget *widget, GdkEventKey *event, gpointer user_data)
{
    GtkTreeViewColumn    *col;
    GtkTreePath          *path = NULL;
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(user_data);
    GtkTreeView          *tv = priv->tree_view;
    gboolean              shifted;
    gint                  period_num, num_periods;
    gpointer              data;
 
    if (event->type != GDK_KEY_PRESS || !priv->temp_cr)
        return FALSE;
 
    switch (event->keyval)
    {
    case GDK_KEY_KP_Decimal:
        if (event->keyval == GDK_KEY_KP_Decimal)
        {
            struct lconv *lc = gnc_localeconv ();
            event->keyval = lc->mon_decimal_point[0];
            event->string[0] = lc->mon_decimal_point[0];
        }
        return FALSE;
    case GDK_KEY_Tab:
    case GDK_KEY_ISO_Left_Tab:
    case GDK_KEY_KP_Tab:
        shifted = event->state & GDK_SHIFT_MASK;
        gtk_tree_view_get_cursor (tv, &path, &col);
        if (!path)
            return TRUE;
        data        = g_object_get_data (G_OBJECT(col), "period_num");
        period_num  = GPOINTER_TO_UINT(data);
        num_periods = gnc_budget_get_num_periods (priv->budget);
 
        if (period_num >= num_periods)
            period_num = num_periods - 1;
 
        if (shifted)
            period_num--;
        else
            period_num++;
 
        if (period_num >= num_periods)
        {
            period_num = 0;
            if (gtk_tree_view_row_expanded (tv, path))
            {
                gtk_tree_path_down (path);
            }
            else
            {
                gtk_tree_path_next (path);
                while (!gnc_tree_view_path_is_valid (GNC_TREE_VIEW(tv), path) &&
                       gtk_tree_path_get_depth (path) > 1)
                {
                    gtk_tree_path_up (path);
                    gtk_tree_path_next (path);
                }
            }
        }
        else if (period_num < 0)
        {
            period_num = num_periods - 1;
            if (!gtk_tree_path_prev (path))
                gtk_tree_path_up (path);
            else
            {
                while (gtk_tree_view_row_expanded (tv, path))
                {
                    gtk_tree_path_down (path);
                    do
                    {
                        gtk_tree_path_next (path);
                    } while (
                        gnc_tree_view_path_is_valid (GNC_TREE_VIEW(tv), path));
                    gtk_tree_path_prev (path);
                }
            }
        }
 
        col = g_list_nth_data (priv->period_col_list, period_num);
 
        // finish editing
        if (priv->temp_ce)
        {
            gtk_cell_editable_editing_done (priv->temp_ce);
            gtk_cell_editable_remove_widget (priv->temp_ce);
 
            while (gtk_events_pending())
                gtk_main_iteration ();
        }
 
        if (gnc_tree_view_path_is_valid (GNC_TREE_VIEW(tv), path))
            gtk_tree_view_set_cursor (tv, path, col, TRUE);
        gtk_tree_path_free (path);
        break;
    default:
        return FALSE;
    }
 
    return TRUE;
}
 
static void
gbv_treeview_resized_cb (GtkWidget *widget, GtkAllocation *allocation,
                         GncBudgetView *budget_view)
{
    GncBudgetViewPrivate* priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    GList *columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(priv->tree_view));
    GList *total_columns = gtk_tree_view_get_columns (GTK_TREE_VIEW (priv->totals_tree_view));
 
    ENTER("");
 
    for (GList *node = columns, *total_node = total_columns;
         node; node = g_list_next (node))
    {
        GtkTreeViewColumn *tree_view_col = node->data;
        const gchar *name = g_object_get_data (G_OBJECT(tree_view_col), PREF_NAME);
 
        // if we do not show account code, step over the equivalent totals column
        if ((g_strcmp0 (name, "account-code") == 0) && (!priv->show_account_code))
            total_node = g_list_next (total_node);
 
        // if we do not show account description, step over the
        // equivalent totals column
        if ((g_strcmp0 (name, "description") == 0) && (!priv->show_account_desc))
            total_node = g_list_next (total_node);
 
        if (gtk_tree_view_column_get_visible (tree_view_col) && total_node != NULL)
        {
            gint col_width = gtk_tree_view_column_get_width (tree_view_col);
            GtkTreeViewColumn *totals_view_col = total_node->data;
            if (GTK_IS_TREE_VIEW_COLUMN(totals_view_col))
                gtk_tree_view_column_set_fixed_width (totals_view_col, col_width);
            total_node = g_list_next (total_node);
        }
    }
    // make sure the account column is the expand column
    gnc_tree_view_expand_columns (GNC_TREE_VIEW(priv->tree_view), "name", NULL);
    g_list_free (columns);
    g_list_free (total_columns);
    LEAVE("");
}
 
static void
gbv_row_activated_cb (GtkTreeView *treeview, GtkTreePath *path,
                      GtkTreeViewColumn *col, GncBudgetView *budget_view)
{
    Account *account;
 
    g_return_if_fail (GNC_IS_BUDGET_VIEW(budget_view));
 
    account = gnc_tree_view_account_get_account_from_path (
                  GNC_TREE_VIEW_ACCOUNT(treeview), path);
    if (account == NULL)
        return;
 
    g_signal_emit_by_name (budget_view, "account-activated", account);
}
 
static gboolean
query_tooltip_tree_view_cb (GtkWidget *widget, gint x, gint y,
                            gboolean keyboard_tip, GtkTooltip *tooltip,
                            GncBudgetView *view)
{
    GtkTreeView          *tree_view = GTK_TREE_VIEW(widget);
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(view);
    GtkTreePath          *path  = NULL;
    GtkTreeViewColumn    *column = NULL;
    const gchar          *note;
    guint                 period_num;
    Account              *account;
 
    gtk_tree_view_convert_widget_to_bin_window_coords (tree_view, x, y, &x, &y);
 
    if (keyboard_tip || !gtk_tree_view_get_path_at_pos (tree_view, x, y, &path,
                                                        &column, NULL, NULL))
    {
        gtk_tree_path_free (path);
        return FALSE;
    }
 
    if (!column)
    {
        gtk_tree_path_free (path);
        return FALSE;
    }
 
    period_num = GPOINTER_TO_UINT(g_object_get_data (G_OBJECT(column), "period_num"));
    if (!period_num && priv->period_col_list->data != column)
    {
        gtk_tree_path_free (path);
        return FALSE;
    }
    account = gnc_tree_view_account_get_account_from_path (
                  GNC_TREE_VIEW_ACCOUNT(widget), path);
    note = gnc_budget_get_account_period_note (priv->budget, account, period_num);
    if (!note)
    {
        gtk_tree_path_free (path);
        return FALSE;
    }
 
    gtk_tooltip_set_text (tooltip, note);
    gtk_tree_view_set_tooltip_cell (tree_view, tooltip, path, column, NULL);
    gtk_tree_path_free (path);
 
    return TRUE;
}
 
#if 0
static void
gbv_selection_changed_cb (GtkTreeSelection *selection, GncBudgetView *budget_view)
{
    GtkTreeView *tree_view;
    GList       *acct_list;
    gboolean     sensitive;
 
    if (!selection)
        sensitive = FALSE;
    else
    {
        g_return_if_fail (GTK_IS_TREE_SELECTION(selection));
        tree_view = gtk_tree_selection_get_tree_view (selection);
        acct_list = gnc_tree_view_account_get_selected_accounts (
                        GNC_TREE_VIEW_ACCOUNT(tree_view));
 
        /* Check here for placeholder accounts, etc. */
        sensitive = (g_list_length (acct_list) > 0);
        g_list_free (acct_list);
    }
}
#endif
 
typedef struct
{
    gnc_numeric    total;
    GncBudget     *budget;
    guint          period_num;
    GNCPriceDB    *pdb;
    gnc_commodity *total_currency;
} BudgetAccumulationInfo;
 
static void
budget_accum_helper (Account *account, gpointer data)
{
    BudgetAccumulationInfo *info = (BudgetAccumulationInfo*)data;
    gnc_numeric numeric;
    gnc_commodity *currency;
 
    currency = gnc_account_get_currency_or_parent (account);
 
    if (gnc_budget_is_account_period_value_set (info->budget, account, info->period_num))
    {
        numeric = gnc_budget_get_account_period_value (info->budget, account,
                                                       info->period_num);
        numeric = gnc_pricedb_convert_balance_nearest_price_t64 (
                    info->pdb, numeric, currency, info->total_currency,
                    gnc_budget_get_period_start_date (info->budget, info->period_num));
        info->total = gnc_numeric_add (info->total, numeric, GNC_DENOM_AUTO,
                                       GNC_HOW_DENOM_LCD);
    }
    else if (gnc_account_n_children (account) != 0)
    {
        numeric = gbv_get_accumulated_budget_amount (info->budget, account,
                                                     info->period_num);
        numeric = gnc_pricedb_convert_balance_nearest_price_t64 (
                    info->pdb, numeric, currency, info->total_currency,
                    gnc_budget_get_period_start_date (info->budget, info->period_num));
 
        info->total = gnc_numeric_add (info->total, numeric, GNC_DENOM_AUTO,
                                       GNC_HOW_DENOM_LCD);
    }
}
 
static gnc_numeric
gbv_get_accumulated_budget_amount (GncBudget *budget, Account *account, guint period_num)
{
    BudgetAccumulationInfo info;
 
    info.total = gnc_numeric_zero ();
    info.budget = budget;
    info.period_num = period_num;
    info.pdb = gnc_pricedb_get_db (gnc_account_get_book (account));
    info.total_currency = gnc_account_get_currency_or_parent (account);
 
    if (!gnc_budget_is_account_period_value_set (budget, account, period_num))
        gnc_account_foreach_child (account, budget_accum_helper, &info);
    else
        info.total = gnc_budget_get_account_period_value (budget, account, period_num);
 
    return info.total;
}
 
 
static gchar *
budget_col_source (Account *account, GtkTreeViewColumn *col,
                   GtkCellRenderer *cell)
{
    GncBudgetView *budget_view;
    GncBudgetViewPrivate *priv;
    guint period_num;
    gnc_numeric numeric;
    gchar amtbuff[100]; //FIXME: overkill, where's the #define?
    const gchar *note;
 
    budget_view = GNC_BUDGET_VIEW(g_object_get_data (G_OBJECT(col), "budget_view"));
    period_num = GPOINTER_TO_UINT(g_object_get_data (G_OBJECT(col), "period_num"));
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    if (!gnc_budget_is_account_period_value_set (priv->budget, account, period_num))
    {
        if (gnc_account_n_children (account) == 0)
            amtbuff[0] = '\0';
        else
        {
            GdkRGBA color;
            GtkStyleContext *stylectxt = gtk_widget_get_style_context (GTK_WIDGET(priv->tree_view));
            gtk_style_context_get_color (stylectxt, GTK_STATE_FLAG_NORMAL, &color);
 
            numeric = gbv_get_accumulated_budget_amount (priv->budget, account, period_num);
 
            if (gnc_reverse_balance (account))
                numeric = gnc_numeric_neg (numeric);
 
            xaccSPrintAmount (amtbuff, numeric, gnc_account_print_info (account, FALSE));
            if (gnc_is_dark_theme (&color))
                g_object_set (cell, "foreground",
                              priv->use_red_color && gnc_numeric_negative_p (numeric)
                                  ? "darkred"
                                  : "darkgray",
                              NULL);
            else
                g_object_set (cell, "foreground",
                              priv->use_red_color && gnc_numeric_negative_p (numeric)
                                  ? "PaleVioletRed"
                                  : "dimgray",
                              NULL);
        }
    }
    else
    {
        numeric = gnc_budget_get_account_period_value (priv->budget, account,
                                                       period_num);
        if (gnc_numeric_check (numeric))
            strcpy (amtbuff, "error");
        else
        {
            if (gnc_reverse_balance (account))
                numeric = gnc_numeric_neg (numeric);
 
            xaccSPrintAmount (amtbuff, numeric,
                              gnc_account_print_info (account, FALSE));
 
            if (priv->use_red_color && gnc_numeric_negative_p (numeric))
            {
                gchar *color = gnc_get_negative_color ();
                g_object_set (cell, "foreground", color, NULL);
                g_free (color);
            }
            else
                g_object_set (cell, "foreground", NULL, NULL);
        }
    }
 
    note = gnc_budget_get_account_period_note (priv->budget, account, period_num);
    g_object_set (cell, "flagged", note != NULL, NULL);
 
    return g_strdup (amtbuff);
}
 
static gnc_numeric
bgv_get_total_for_account (Account *account, GncBudget *budget, gnc_commodity *new_currency)
{
    guint num_periods;
    int period_num;
    gnc_numeric numeric;
    gnc_numeric total = gnc_numeric_zero ();
    GNCPriceDB *pdb;
    gnc_commodity *currency;
 
    if (new_currency)
    {
        pdb      = gnc_pricedb_get_db (gnc_get_current_book ());
        currency = gnc_account_get_currency_or_parent (account);
    }
 
    num_periods = gnc_budget_get_num_periods (budget);
    for (period_num = 0; period_num < num_periods; ++period_num)
    {
        if (!gnc_budget_is_account_period_value_set (budget, account, period_num))
        {
            if (gnc_account_n_children (account) != 0)
            {
                numeric = gbv_get_accumulated_budget_amount (budget, account, period_num);
 
                if (new_currency)
                {
                    numeric = gnc_pricedb_convert_balance_nearest_price_t64 (
                                pdb, numeric, currency, new_currency,
                                gnc_budget_get_period_start_date (budget, period_num));
                }
                total = gnc_numeric_add (total, numeric, GNC_DENOM_AUTO, GNC_HOW_DENOM_LCD);
            }
        }
        else
        {
            numeric = gnc_budget_get_account_period_value (budget, account, period_num);
            if (!gnc_numeric_check (numeric))
            {
                if (new_currency)
                {
                    numeric = gnc_pricedb_convert_balance_nearest_price_t64 (
                                pdb, numeric, currency, new_currency,
                                gnc_budget_get_period_start_date (budget, period_num));
                }
                total = gnc_numeric_add (total, numeric, GNC_DENOM_AUTO, GNC_HOW_DENOM_LCD);
            }
        }
    }
 
    return total;
}
 
static gchar *
budget_total_col_source (Account *account, GtkTreeViewColumn *col,
                         GtkCellRenderer *cell)
{
    GncBudgetView *budget_view;
    GncBudgetViewPrivate *priv;
    gnc_numeric total;
    gchar amtbuff[100]; //FIXME: overkill, where's the #define?
 
    budget_view = GNC_BUDGET_VIEW(g_object_get_data (G_OBJECT(col), "budget_view"));
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    total = bgv_get_total_for_account (account, priv->budget, NULL);
    if (gnc_reverse_balance (account))
        total = gnc_numeric_neg (total);
 
    xaccSPrintAmount (amtbuff, total, gnc_account_print_info (account, TRUE));
 
    if (priv->use_red_color && gnc_numeric_negative_p (total))
    {
        gchar *color = gnc_get_negative_color ();
        g_object_set (cell, "foreground", color, NULL);
        g_free (color);
    }
    else
        g_object_set (cell, "foreground", NULL, NULL);
 
    return g_strdup (amtbuff);
}
 
static void
budget_col_edited (Account *account, GtkTreeViewColumn *col,
                   const gchar *new_text)
{
    GncBudgetView *budget_view;
    GncBudgetViewPrivate *priv;
    guint period_num;
    gnc_numeric numeric = gnc_numeric_error (GNC_ERROR_ARG);
 
    if (qof_book_is_readonly (gnc_get_current_book ()))
        return;
 
    if (!xaccParseAmount (new_text, TRUE, &numeric, NULL) &&
                !(new_text && *new_text == '\0'))
        return;
 
    period_num = GPOINTER_TO_UINT(g_object_get_data (G_OBJECT(col), "period_num"));
 
    budget_view = GNC_BUDGET_VIEW(g_object_get_data (G_OBJECT(col), "budget_view"));
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    if (new_text && *new_text == '\0')
        gnc_budget_unset_account_period_value (priv->budget, account, period_num);
    else
    {
        if (gnc_reverse_balance (account))
            numeric = gnc_numeric_neg (numeric);
        gnc_budget_set_account_period_value (priv->budget, account, period_num,
                                             numeric);
    }
}
 
static void
totals_col_source (GtkTreeViewColumn *col, GtkCellRenderer *cell,
                   GtkTreeModel *s_model, GtkTreeIter *s_iter,
                   gpointer user_data)
{
    gnc_numeric total = gnc_numeric_zero ();
    GncBudgetView *budget_view = GNC_BUDGET_VIEW(user_data);
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    gint period_num = GPOINTER_TO_INT(g_object_get_data (G_OBJECT(col), "period_num"));
    GNCPriceDB *pdb = gnc_pricedb_get_db (gnc_get_current_book ());
    gnc_commodity *total_currency = gnc_default_currency ();
    GList *top_level_accounts = gnc_account_get_children (priv->rootAcct);
    gint row_type;
 
    gtk_tree_model_get (s_model, s_iter, 1, &row_type, -1);
 
    // step through each child account of the root, find the total
    // income, expenses, liabilities, and assets.
    for (GList *node = top_level_accounts; node; node = g_list_next (node))
    {
        Account *account = node->data;
        GNCAccountType acctype = xaccAccountTypeGetFundamental (xaccAccountGetType (account));
 
        if ((row_type == TOTALS_TYPE_INCOME && acctype == ACCT_TYPE_INCOME) ||
            (row_type == TOTALS_TYPE_EXPENSES && acctype == ACCT_TYPE_EXPENSE) ||
            (row_type == TOTALS_TYPE_REMAINDER) ||
            (row_type == TOTALS_TYPE_ASSET_LIAB_EQ &&
             (acctype == ACCT_TYPE_ASSET || acctype == ACCT_TYPE_LIABILITY ||
              acctype == ACCT_TYPE_EQUITY)))
        {
            gnc_numeric value; // used to assist in adding and subtracting
            // find the total for this account
            if (period_num < 0)
                value = bgv_get_total_for_account (account, priv->budget, total_currency);
            else
            {
                gnc_commodity *currency = gnc_account_get_currency_or_parent (account);
                value = gbv_get_accumulated_budget_amount
                    (priv->budget, account, period_num);
 
                value = gnc_pricedb_convert_balance_nearest_price_t64
                    (pdb, value, currency, total_currency,
                     gnc_budget_get_period_start_date (priv->budget, period_num));
            }
 
            total = gnc_numeric_add (total, value, GNC_DENOM_AUTO, GNC_HOW_DENOM_LCD);
        }
    }
 
    total = gnc_numeric_neg (total);
 
    GNCPrintAmountInfo pinfo = gnc_commodity_print_info (total_currency, period_num < 0);
    gchar *color = (priv->use_red_color && gnc_numeric_negative_p (total)) ?
        gnc_get_negative_color () : NULL;
 
    g_object_set (G_OBJECT(cell),
                  "text", xaccPrintAmount (total, pinfo),
                  "xalign", 1.0,
                  "foreground", color,
                  NULL);
 
    g_free (color);
    g_list_free (top_level_accounts);
}
 
static void
gbv_refresh_col_titles (GncBudgetView *budget_view)
{
    GncBudgetViewPrivate *priv;
    const Recurrence *r;
    GDate date, nextdate;
    gchar title[MAX_DATE_LENGTH + 1];
 
    g_return_if_fail (budget_view != NULL);
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    /* Show the dates in column titles */
    r = gnc_budget_get_recurrence (priv->budget);
    date = r->start;
    for (GList *node = priv->period_col_list; node; node = g_list_next (node))
    {
        GtkTreeViewColumn *col = GTK_TREE_VIEW_COLUMN (node->data);
        guint titlelen = qof_print_gdate (title, MAX_DATE_LENGTH, &date);
 
        if (titlelen > 0)
            gtk_tree_view_column_set_title (col, title);
 
        recurrenceNextInstance (r, &date, &nextdate);
        date = nextdate;
    }
}
 
static void
gbv_renderer_add_padding (GtkCellRenderer *renderer)
{
    gint xpad, ypad;
 
    gtk_cell_renderer_get_padding (renderer, &xpad, &ypad);
    if (xpad < 5)
        gtk_cell_renderer_set_padding (renderer, 5, ypad);
}
 
static GtkTreeViewColumn*
gbv_create_totals_column (GncBudgetView *budget_view, gint period_num)
{
    GtkTreeViewColumn *col;
    GtkCellRenderer* renderer;
 
    g_return_val_if_fail (budget_view != NULL, NULL);
 
    renderer = gtk_cell_renderer_text_new ();
    col = gtk_tree_view_column_new_with_attributes ("", renderer, NULL);
 
    // add some padding to the right of the numbers
    gbv_renderer_add_padding (renderer);
 
    gtk_tree_view_column_set_cell_data_func (col, renderer, totals_col_source, budget_view, NULL);
    g_object_set_data (G_OBJECT(col), "budget_view", budget_view);
    g_object_set_data (G_OBJECT(col), "period_num", GUINT_TO_POINTER(period_num));
    gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
 
    return col;
}
 
static void
gbv_col_edited_cb (GtkCellRendererText *cell, gchar *path_string,
                   gchar *new_text, gpointer user_data)
{
    GncBudgetView *budget_view = GNC_BUDGET_VIEW(user_data);
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    gtk_widget_queue_draw (GTK_WIDGET(priv->totals_tree_view));
}
 
/* The main Start Editing Call back for the budget columns, for key navigation
 */
static void
gdv_editing_started_cb (GtkCellRenderer *cr, GtkCellEditable *editable,
                        const gchar *path_string, gpointer user_data)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(user_data);
 
    priv->temp_cr = cr;
    priv->temp_ce = editable;
 
    g_signal_connect (G_OBJECT(editable), "key-press-event",
                      G_CALLBACK(gbv_key_press_cb), user_data);
}
 
static void
gdv_editing_canceled_cb (GtkCellRenderer *cr, gpointer user_data)
{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(user_data);
 
    priv->temp_cr = NULL;
    priv->temp_ce = NULL;
}
 
void
gnc_budget_view_refresh (GncBudgetView *budget_view)
{
    // 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_BUDGET_VIEW_NAME

#define GNC_BUDGET_VIEW_NAME   "GncBudgetView"

Definition at line 50 of file gnc-budget-view.h.

GNC_IS_BUDGET

#define GNC_IS_BUDGET

(

o

)

(G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_BUDGET))

Definition at line 88 of file gnc-budget.h.

GNC_IS_BUDGET_CLASS

#define GNC_IS_BUDGET_CLASS

(

k

)

(G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_BUDGET))

Definition at line 90 of file gnc-budget.h.

GNC_IS_BUDGET_VIEW

#define GNC_IS_BUDGET_VIEW

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_BUDGET_VIEW))

Definition at line 46 of file gnc-budget-view.h.

GNC_IS_BUDGET_VIEW_CLASS

#define GNC_IS_BUDGET_VIEW_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_BUDGET_VIEW))

Definition at line 47 of file gnc-budget-view.h.

GNC_IS_PLUGIN_PAGE_BUDGET

#define GNC_IS_PLUGIN_PAGE_BUDGET

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET))

Definition at line 44 of file gnc-plugin-page-budget.h.

GNC_IS_PLUGIN_PAGE_BUDGET_CLASS

#define GNC_IS_PLUGIN_PAGE_BUDGET_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_BUDGET))

Definition at line 45 of file gnc-plugin-page-budget.h.

GNC_PLUGIN_PAGE_BUDGET

#define GNC_PLUGIN_PAGE_BUDGET

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudget))

Definition at line 42 of file gnc-plugin-page-budget.h.

GNC_PLUGIN_PAGE_BUDGET_CLASS

#define GNC_PLUGIN_PAGE_BUDGET_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudgetClass))

Definition at line 43 of file gnc-plugin-page-budget.h.

GNC_PLUGIN_PAGE_BUDGET_GET_CLASS

#define GNC_PLUGIN_PAGE_BUDGET_GET_CLASS

(

obj

)

(G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_BUDGET, GncPluginPageBudgetClass))

Definition at line 46 of file gnc-plugin-page-budget.h.

GNC_PLUGIN_PAGE_BUDGET_NAME

#define GNC_PLUGIN_PAGE_BUDGET_NAME   "GncPluginPageBudget"

Definition at line 48 of file gnc-plugin-page-budget.h.

GNC_TYPE_BUDGET

#define GNC_TYPE_BUDGET   (gnc_budget_get_type ())

Definition at line 83 of file gnc-budget.h.

GNC_TYPE_BUDGET_VIEW

#define GNC_TYPE_BUDGET_VIEW   (gnc_budget_view_get_type ())

Definition at line 43 of file gnc-budget-view.h.

GNC_TYPE_PLUGIN_PAGE_BUDGET

#define GNC_TYPE_PLUGIN_PAGE_BUDGET   (gnc_plugin_page_budget_get_type ())

Definition at line 41 of file gnc-plugin-page-budget.h.

PLUGIN_PAGE_BUDGET_CM_CLASS

#define PLUGIN_PAGE_BUDGET_CM_CLASS   "budget-view"

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

STATE_SECTION_PREFIX

#define STATE_SECTION_PREFIX   "Budget"

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

Enumeration Type Documentation

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
};

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      
};

Function Documentation

gnc_budget_begin_edit()

void gnc_budget_begin_edit

(

GncBudget *

bgt

)

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

{
    qof_begin_edit(QOF_INSTANCE(bgt));
}

gnc_budget_clone()

GncBudget * gnc_budget_clone

(

const GncBudget *

budget

)

Clones a budget creating a copy.

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

{
    GncBudget* new_b;
    Account* root;
    CloneBudgetData_t clone_data;
 
    g_return_val_if_fail(old_b != nullptr, nullptr);
 
    ENTER(" ");
 
    new_b = gnc_budget_new(qof_instance_get_book(old_b));
    gnc_budget_begin_edit(new_b);
    gnc_budget_set_name(new_b, gnc_budget_get_name(old_b));
    gnc_budget_set_description(new_b, gnc_budget_get_description(old_b));
    gnc_budget_set_recurrence(new_b, gnc_budget_get_recurrence(old_b));
    gnc_budget_set_num_periods(new_b, gnc_budget_get_num_periods(old_b));
 
    root = gnc_book_get_root_account(qof_instance_get_book(old_b));
    clone_data.old_b = old_b;
    clone_data.new_b = new_b;
    clone_data.num_periods = gnc_budget_get_num_periods(new_b);
    gnc_account_foreach_descendant(root, clone_budget_values_cb, &clone_data);
 
    gnc_budget_commit_edit(new_b);
 
    LEAVE(" ");
 
    return new_b;
}

gnc_budget_commit_edit()

void gnc_budget_commit_edit

(

GncBudget *

bgt

)

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

{
    if (!qof_commit_edit(QOF_INSTANCE(bgt))) return;
    qof_commit_edit_part2(QOF_INSTANCE(bgt), commit_err,
                          noop, gnc_budget_free);
}

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_get_account_period_actual_value()

gnc_numeric gnc_budget_get_account_period_actual_value	(	const GncBudget *	budget,
		Account *	account,
		guint	period_num
	)

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

{
    // FIXME: maybe zero is not best error return val.
    g_return_val_if_fail(GNC_IS_BUDGET(budget) && acc, gnc_numeric_zero());
    return recurrenceGetAccountPeriodValue(&GET_PRIVATE(budget)->recurrence,
                                           acc, period_num);
}

gnc_budget_get_account_period_note()

const gchar * gnc_budget_get_account_period_note	(	const GncBudget *	budget,
		const Account *	account,
		guint	period_num
	)

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

{
    g_return_val_if_fail (period_num < GET_PRIVATE(budget)->num_periods, nullptr);
    auto& data = get_perioddata (budget, account, period_num);
    return data.note.empty () ? nullptr : data.note.c_str();
}

gnc_budget_get_account_period_value()

gnc_numeric gnc_budget_get_account_period_value	(	const GncBudget *	budget,
		const Account *	account,
		guint	period_num
	)

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

{
    g_return_val_if_fail (period_num < GET_PRIVATE(budget)->num_periods,
                          gnc_numeric_zero());
    auto& data = get_perioddata (budget, account, period_num);
 
    return data.opt_value.has_value() ? data.opt_value.value() : gnc_numeric_zero();
}

gnc_budget_get_default()

GncBudget * gnc_budget_get_default

(

QofBook *

book

)

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

{
    QofCollection *col;
    GncBudget *bgt = nullptr;
    GncGUID *default_budget_guid = nullptr;
 
    g_return_val_if_fail(book, nullptr);
 
    qof_instance_get (QOF_INSTANCE (book),
                      "default-budget", &default_budget_guid,
                      nullptr);
    if (default_budget_guid)
    {
        col = qof_book_get_collection(book, GNC_ID_BUDGET);
        bgt = (GncBudget *) qof_collection_lookup_entity(col,
                                                         default_budget_guid);
    }
 
    /* Revert to 2.2.x behavior if the book has no default budget. */
 
    if ( bgt == nullptr )
    {
        col = qof_book_get_collection(book, GNC_ID_BUDGET);
        if (qof_collection_count(col) > 0)
        {
            qof_collection_foreach(col, just_get_one, &bgt);
        }
    }
 
    guid_free (default_budget_guid);
    return bgt;
}

gnc_budget_get_description()

const gchar * gnc_budget_get_description

(

const GncBudget *

budget

)

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

{
    g_return_val_if_fail(GNC_IS_BUDGET(budget), nullptr);
    return GET_PRIVATE(budget)->description;
}

gnc_budget_get_guid()

const GncGUID * gnc_budget_get_guid

(

const GncBudget *

budget

)

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

{
    g_return_val_if_fail(budget, nullptr);
    g_return_val_if_fail(GNC_IS_BUDGET(budget), nullptr);
    return qof_instance_get_guid(QOF_INSTANCE(budget));
}

gnc_budget_get_name()

const gchar * gnc_budget_get_name

(

const GncBudget *

budget

)

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

{
    g_return_val_if_fail(GNC_IS_BUDGET(budget), nullptr);
    return GET_PRIVATE(budget)->name;
}

gnc_budget_get_num_periods()

guint gnc_budget_get_num_periods

(

const GncBudget *

budget

)

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

{
    g_return_val_if_fail(GNC_IS_BUDGET(budget), 0);
    return GET_PRIVATE(budget)->num_periods;
}

gnc_budget_get_period_end_date()

time64 gnc_budget_get_period_end_date	(	const GncBudget *	budget,
		guint	period_num
	)

Get the ending date of the Budget period.

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

{
    g_return_val_if_fail (GNC_IS_BUDGET(budget), 0);
    return recurrenceGetPeriodTime(&GET_PRIVATE(budget)->recurrence, period_num, TRUE);
}

gnc_budget_get_period_start_date()

time64 gnc_budget_get_period_start_date	(	const GncBudget *	budget,
		guint	period_num
	)

Get the starting date of the Budget period.

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

{
    g_return_val_if_fail (GNC_IS_BUDGET(budget), 0);
    return recurrenceGetPeriodTime(&GET_PRIVATE(budget)->recurrence, period_num, FALSE);
}

gnc_budget_get_recurrence()

const Recurrence * gnc_budget_get_recurrence

(

const GncBudget *

budget

)

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

{
    g_return_val_if_fail(budget, nullptr);
    return (&GET_PRIVATE(budget)->recurrence);
}

gnc_budget_gui_delete_budget()

void gnc_budget_gui_delete_budget

(

GncBudget *

budget

)

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

{
    const char *name;
 
    g_return_if_fail (GNC_IS_BUDGET(budget));
    name = gnc_budget_get_name (budget);
    if (!name)
        name = _("Unnamed Budget");
 
    if (gnc_verify_dialog (NULL, FALSE, _("Delete %s?"), name))
    {
        QofBook* book = gnc_get_current_book ();
 
        gnc_suspend_gui_refresh ();
        gnc_budget_destroy (budget);
 
        if (qof_collection_count (qof_book_get_collection (book, GNC_ID_BUDGET)) == 0)
        {
            gnc_features_set_unused (book, GNC_FEATURE_BUDGET_UNREVERSED);
            PWARN ("No budgets left. Removing feature BUDGET_UNREVERSED.");
        }
        // Views should close themselves because the CM will notify them.
        gnc_resume_gui_refresh ();
    }
}

gnc_budget_is_account_period_value_set()

gboolean gnc_budget_is_account_period_value_set	(	const GncBudget *	budget,
		const Account *	account,
		guint	period_num
	)

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

{
    g_return_val_if_fail (period_num < GET_PRIVATE(budget)->num_periods, false);
    return get_perioddata (budget, account, period_num).opt_value.has_value();
}

gnc_budget_lookup()

GncBudget * gnc_budget_lookup	(	const GncGUID *	guid,
		const QofBook *	book
	)

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

{
    QofCollection *col;
 
    g_return_val_if_fail(guid, nullptr);
    g_return_val_if_fail(book, nullptr);
    col = qof_book_get_collection (book, GNC_ID_BUDGET);
    return GNC_BUDGET(qof_collection_lookup_entity (col, guid));
}

gnc_budget_new()

GncBudget * gnc_budget_new

(

QofBook *

book

)

Creates and initializes a Budget.

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

{
    g_return_val_if_fail(book, nullptr);
 
    ENTER(" ");
 
    auto budget { static_cast<GncBudget*>(g_object_new(GNC_TYPE_BUDGET, nullptr)) };
    qof_instance_init_data (&budget->inst, GNC_ID_BUDGET, book);
 
    qof_event_gen( &budget->inst, QOF_EVENT_CREATE , nullptr);
 
    LEAVE(" ");
    return budget;
}

gnc_budget_register()

gboolean gnc_budget_register

(

void

)

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

{
    static QofParam params[] =
    {
        {
            "name", QOF_TYPE_STRING,
            (QofAccessFunc) gnc_budget_get_name,
            (QofSetterFunc) gnc_budget_set_name
        },
        {
            "description", QOF_TYPE_STRING,
            (QofAccessFunc) gnc_budget_get_description,
            (QofSetterFunc) gnc_budget_set_description
        },
        {
            "recurrence_period_type", QOF_TYPE_INT32,
            (QofAccessFunc) gnc_budget_get_rec_pt, nullptr
        },
        /* Signedness problem: Should be unsigned. */
        {
            "recurrence_multiplier", QOF_TYPE_INT32,
            (QofAccessFunc) gnc_budget_get_rec_mult, nullptr
        },
        /* This is the same way that SchedXaction.c uses QOF_TYPE_DATE
           but I don't think QOF actually supports a GDate, so I think
           this is wrong. */
        {
            "recurrence_date", QOF_TYPE_DATE,
            (QofAccessFunc) gnc_budget_get_rec_time, nullptr
        },
        /* Signedness problem: Should be unsigned. */
        {
            "num_periods", QOF_TYPE_INT32,
            (QofAccessFunc) gnc_budget_get_num_periods,
            (QofSetterFunc) gnc_budget_set_num_periods
        },
        {
            QOF_PARAM_BOOK, QOF_ID_BOOK,
            (QofAccessFunc) qof_instance_get_book, nullptr
        },
        {
            QOF_PARAM_GUID, QOF_TYPE_GUID,
            (QofAccessFunc) qof_instance_get_guid, nullptr
        },
        { nullptr },
    };
 
    qof_class_register(GNC_ID_BUDGET, (QofSortFunc) nullptr, params);
    return qof_object_register(&budget_object_def);
}

gnc_budget_set_account_period_note()

void gnc_budget_set_account_period_note	(	GncBudget *	budget,
		const Account *	account,
		guint	period_num,
		const gchar *	note
	)

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

{
    g_return_if_fail (budget != nullptr);
    g_return_if_fail (account != nullptr);
 
    /* Watch out for an off-by-one error here:
     * period_num starts from 0 while num_periods starts from 1 */
    if (period_num >= GET_PRIVATE(budget)->num_periods)
    {
        PWARN("Period %i does not exist", period_num);
        return;
    }
 
    auto& perioddata = get_perioddata (budget, account, period_num);
    auto budget_kvp { QOF_INSTANCE (budget)->kvp_data };
    auto path = make_period_note_path (account, period_num);
 
    gnc_budget_begin_edit(budget);
    if (note == nullptr)
    {
        delete budget_kvp->set_path (path, nullptr);
        perioddata.note.clear ();
    }
    else
    {
        KvpValue* v = new KvpValue (g_strdup (note));
 
        delete budget_kvp->set_path (path, v);
        perioddata.note = note;
    }
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
 
}

gnc_budget_set_account_period_value()

void gnc_budget_set_account_period_value	(	GncBudget *	budget,
		const Account *	account,
		guint	period_num,
		gnc_numeric	val
	)

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

{
    g_return_if_fail (budget != nullptr);
    g_return_if_fail (account != nullptr);
 
    /* Watch out for an off-by-one error here:
     * period_num starts from 0 while num_periods starts from 1 */
    if (period_num >= GET_PRIVATE(budget)->num_periods)
    {
        PWARN("Period %i does not exist", period_num);
        return;
    }
 
    auto& perioddata = get_perioddata (budget, account, period_num);
    auto budget_kvp { QOF_INSTANCE (budget)->kvp_data };
    auto path = make_period_data_path (account, period_num);
 
    gnc_budget_begin_edit(budget);
    if (gnc_numeric_check(val))
    {
        delete budget_kvp->set_path (path, nullptr);
        perioddata.opt_value.reset();
    }
    else
    {
        KvpValue* v = new KvpValue (val);
        delete budget_kvp->set_path (path, v);
        perioddata.opt_value = val;
    }
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
 
}

gnc_budget_set_description()

void gnc_budget_set_description	(	GncBudget *	budget,
		const gchar *	description
	)

Set/Get the description of the Budget.

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

{
    GncBudgetPrivate* priv;
 
    g_return_if_fail(GNC_IS_BUDGET(budget));
    g_return_if_fail(description);
 
    priv = GET_PRIVATE(budget);
    if ( description == priv->description ) return;
    gnc_budget_begin_edit(budget);
    CACHE_REPLACE(priv->description, description);
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
}

gnc_budget_set_name()

void gnc_budget_set_name	(	GncBudget *	budget,
		const gchar *	name
	)

Set/Get the name of the Budget.

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

{
    GncBudgetPrivate* priv;
 
    g_return_if_fail(GNC_IS_BUDGET(budget) && name);
 
    priv = GET_PRIVATE(budget);
    if ( name == priv->name ) return;
 
    gnc_budget_begin_edit(budget);
    CACHE_REPLACE(priv->name, name);
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
}

gnc_budget_set_num_periods()

void gnc_budget_set_num_periods	(	GncBudget *	budget,
		guint	num_periods
	)

Set/Get the number of periods in the Budget.

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

{
    GncBudgetPrivate* priv;
 
    g_return_if_fail(GNC_IS_BUDGET(budget));
    g_return_if_fail(num_periods > 0);
 
    priv = GET_PRIVATE(budget);
    if ( priv->num_periods == num_periods ) return;
 
    gnc_budget_begin_edit(budget);
    priv->num_periods = num_periods;
    std::for_each (priv->acct_map.begin(), priv->acct_map.end(),
                   [num_periods](auto& it){ it.second.resize(num_periods); });
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
}

gnc_budget_set_recurrence()

void gnc_budget_set_recurrence	(	GncBudget *	budget,
		const Recurrence *	r
	)

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

{
    GncBudgetPrivate* priv;
 
    g_return_if_fail(budget && r);
    priv = GET_PRIVATE(budget);
 
    gnc_budget_begin_edit(budget);
    priv->recurrence = *r;
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen(&budget->inst, QOF_EVENT_MODIFY, nullptr);
}

gnc_budget_unset_account_period_value()

void gnc_budget_unset_account_period_value	(	GncBudget *	budget,
		const Account *	account,
		guint	period_num
	)

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

{
    g_return_if_fail (budget != nullptr);
    g_return_if_fail (account != nullptr);
    g_return_if_fail (period_num < GET_PRIVATE(budget)->num_periods);
 
    auto& data = get_perioddata (budget, account, period_num);
    data.opt_value.reset();
 
    gnc_budget_begin_edit(budget);
    auto path = make_period_data_path (account, period_num);
    auto budget_kvp { QOF_INSTANCE (budget)->kvp_data };
    delete budget_kvp->set_path (path, nullptr);
    qof_instance_set_dirty(&budget->inst);
    gnc_budget_commit_edit(budget);
 
    qof_event_gen( &budget->inst, QOF_EVENT_MODIFY, nullptr);
 
}

gnc_budget_view_delete_budget()

void gnc_budget_view_delete_budget

(

GncBudgetView *

budget_view

)

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

{
    GncBudgetViewPrivate *priv;
    gchar guidstr[GUID_ENCODING_LENGTH+1];
 
    g_return_if_fail (budget_view != NULL);
 
    ENTER("view %p", budget_view);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    guid_to_string_buff (&priv->key, guidstr);
    gnc_state_drop_sections_for (guidstr);
    g_object_set (G_OBJECT(priv->tree_view), "state-section", NULL, NULL);
 
    LEAVE(" ");
}

gnc_budget_view_get_account_from_path()

Account * gnc_budget_view_get_account_from_path	(	GncBudgetView *	budget_view,
		GtkTreePath *	path
	)

Definition at line 329 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 gnc_tree_view_account_get_account_from_path (GNC_TREE_VIEW_ACCOUNT(priv->tree_view), path);
}

gnc_budget_view_get_account_tree_view()

GtkWidget * gnc_budget_view_get_account_tree_view

(

GncBudgetView *

budget_view

)

Definition at line 340 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_WIDGET(priv->fd->tree_view);
}

gnc_budget_view_get_selected_accounts()

GList * gnc_budget_view_get_selected_accounts

(

GncBudgetView *

budget_view

)

Definition at line 351 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 gnc_tree_view_account_get_selected_accounts (GNC_TREE_VIEW_ACCOUNT(priv->tree_view));
}

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_get_show_account_code()

gboolean gnc_budget_view_get_show_account_code

(

GncBudgetView *

budget_view

)

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

{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return priv->show_account_code;
}

gnc_budget_view_get_show_account_description()

gboolean gnc_budget_view_get_show_account_description

(

GncBudgetView *

budget_view

)

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

{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    return priv->show_account_desc;
}

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_budget_view_restore()

gboolean gnc_budget_view_restore	(	GncBudgetView *	budget_view,
		GKeyFile *	key_file,
		const gchar *	group_name
	)

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

{
    GncBudgetViewPrivate *priv;
    GError *error = NULL;
    char *guid_str;
    GncGUID guid;
    GncBudget *bgt;
    QofBook *book;
    gboolean has_guid;
 
    g_return_val_if_fail (key_file, FALSE);
    g_return_val_if_fail (group_name, FALSE);
 
    ENTER("key_file %p, group_name %s", key_file, group_name);
 
    guid_str = g_key_file_get_string (key_file, group_name, BUDGET_GUID,
                                      &error);
    if (error)
    {
        g_warning ("error reading group %s key %s: %s",
                   group_name, BUDGET_GUID, error->message);
        g_error_free (error);
        error = NULL;
        return FALSE;
    }
    has_guid = string_to_guid (guid_str, &guid);
    g_free (guid_str);
 
    if (!has_guid)
    {
        return FALSE;
    }
 
    book = qof_session_get_book (gnc_get_current_session());
    bgt = gnc_budget_lookup (&guid, book);
    if (!bgt)
    {
        return FALSE;
    }
 
    /* Create the new view */
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Restore the account filter and page state information from page section
    gnc_tree_view_account_restore (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                   priv->fd, key_file, group_name);
    LEAVE(" ");
 
    return TRUE;
}

gnc_budget_view_save()

void gnc_budget_view_save	(	GncBudgetView *	budget_view,
		GKeyFile *	key_file,
		const gchar *	group_name
	)

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

{
    GncBudgetViewPrivate *priv;
 
    g_return_if_fail (budget_view != NULL);
    g_return_if_fail (key_file != NULL);
    g_return_if_fail (group_name != NULL);
 
    ENTER("view %p, key_file %p, group_name %s", budget_view, key_file, group_name);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Save the account filter and page state information to page section
    gnc_tree_view_account_save (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                priv->fd, key_file, group_name);
    LEAVE(" ");
}

gnc_budget_view_save_account_filter()

void gnc_budget_view_save_account_filter

(

GncBudgetView *

budget_view

)

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

{
    GncBudgetViewPrivate *priv;
 
    g_return_if_fail (budget_view != NULL);
 
    ENTER("view %p", budget_view);
 
    priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
 
    // Save account filter state information to budget section
    gnc_tree_view_account_save_filter (GNC_TREE_VIEW_ACCOUNT(priv->tree_view),
                                       priv->fd, gnc_state_get_current (),
                                       gnc_tree_view_get_state_section (
                                       GNC_TREE_VIEW(priv->tree_view)));
    LEAVE(" ");
}

gnc_budget_view_set_show_account_code()

void gnc_budget_view_set_show_account_code	(	GncBudgetView *	budget_view,
		gboolean	show_account_code
	)

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

{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    priv->show_account_code = show_account_code;
    gnc_budget_view_refresh (budget_view);
}

gnc_budget_view_set_show_account_description()

void gnc_budget_view_set_show_account_description	(	GncBudgetView *	budget_view,
		gboolean	show_account_desc
	)

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

{
    GncBudgetViewPrivate *priv = GNC_BUDGET_VIEW_GET_PRIVATE(budget_view);
    priv->show_account_desc = show_account_desc;
    gnc_budget_view_refresh (budget_view);
}

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);
}

gnc_tree_model_budget_get_budget()

GncBudget * gnc_tree_model_budget_get_budget	(	GtkTreeModel *	tm,
		GtkTreeIter *	iter
	)

Definition at line 108 of file gnc-tree-model-budget.c.

{
    GncBudget *bgt;
    GncGUID *guid;
 
    gtk_tree_model_get (tm, iter, BUDGET_GUID_COLUMN, &guid, -1);
    bgt = gnc_budget_lookup(guid, gnc_get_current_book());
    return bgt;
}

gnc_tree_model_budget_get_iter_for_budget()

gboolean gnc_tree_model_budget_get_iter_for_budget	(	GtkTreeModel *	tm,
		GtkTreeIter *	iter,
		GncBudget *	bgt
	)

Definition at line 119 of file gnc-tree-model-budget.c.

{
    const GncGUID *guid1;
    GncGUID *guid2;
 
    g_return_val_if_fail(GNC_BUDGET(bgt), FALSE);
 
    guid1 = gnc_budget_get_guid(bgt);
    if (!gtk_tree_model_get_iter_first(tm, iter))
        return FALSE;
    while (gtk_list_store_iter_is_valid(GTK_LIST_STORE(tm), iter))
    {
        gtk_tree_model_get (tm, iter, BUDGET_GUID_COLUMN, &guid2, -1);
 
        if (guid_equal(guid1, guid2))
            return TRUE;
 
        if (!gtk_tree_model_iter_next(tm, iter))
            return FALSE;
    }
    return FALSE;
}

gnc_tree_model_budget_new()

GtkTreeModel * gnc_tree_model_budget_new

(

QofBook *

book

)

Definition at line 70 of file gnc-tree-model-budget.c.

{
    GtkListStore* store;
 
    store = gtk_list_store_new (BUDGET_LIST_NUM_COLS,
                                G_TYPE_POINTER,
                                G_TYPE_STRING,
                                G_TYPE_STRING);
 
    qof_collection_foreach(qof_book_get_collection(book, GNC_ID_BUDGET),
                           add_budget_to_model, GTK_TREE_MODEL(store));
 
    return GTK_TREE_MODEL(store);
}

gnc_tree_view_budget_set_model()

void gnc_tree_view_budget_set_model	(	GtkTreeView *	tv,
		GtkTreeModel *	tm
	)

Definition at line 86 of file gnc-tree-model-budget.c.

{
    GtkCellRenderer *renderer;
    GtkTreeViewColumn *column;
 
    gtk_tree_view_set_model (tv, tm);
 
    /* column for name */
    renderer = gtk_cell_renderer_text_new ();
    column = gtk_tree_view_column_new_with_attributes (
                 _("Name"), renderer, "text", BUDGET_NAME_COLUMN, NULL);
    gtk_tree_view_append_column (tv, column);
 
    /* column for description */
    renderer = gtk_cell_renderer_text_new ();
    column = gtk_tree_view_column_new_with_attributes (
                 _("Description"), renderer, "text", BUDGET_DESCRIPTION_COLUMN, NULL);
    gtk_tree_view_append_column (tv, column);
 
}

Variable Documentation

budget [1/2]

GncBudget* GncBudgetViewPrivate::budget

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

budget [2/2]

GncBudget* BudgetAccumulationInfo::budget

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

fd

AccountFilterDialog* GncBudgetViewPrivate::fd

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

hadj

GtkAdjustment* GncBudgetViewPrivate::hadj

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

key

GncGUID GncBudgetViewPrivate::key

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

pdb

GNCPriceDB* BudgetAccumulationInfo::pdb

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

period_col_list

GList* GncBudgetViewPrivate::period_col_list

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

period_num

guint BudgetAccumulationInfo::period_num

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

rootAcct

Account* GncBudgetViewPrivate::rootAcct

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

show_account_code

gboolean GncBudgetViewPrivate::show_account_code

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

show_account_desc

gboolean GncBudgetViewPrivate::show_account_desc

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

temp_ce

GtkCellEditable* GncBudgetViewPrivate::temp_ce

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

temp_cr

GtkCellRenderer* GncBudgetViewPrivate::temp_cr

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

total

gnc_numeric BudgetAccumulationInfo::total

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

total_col

GtkTreeViewColumn* GncBudgetViewPrivate::total_col

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

total_currency

gnc_commodity* BudgetAccumulationInfo::total_currency

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

totals_col_list

GList* GncBudgetViewPrivate::totals_col_list

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

totals_scroll_window

GtkWidget* GncBudgetViewPrivate::totals_scroll_window

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

totals_tree_view

GtkTreeView* GncBudgetViewPrivate::totals_tree_view

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

tree_view

GtkTreeView* GncBudgetViewPrivate::tree_view

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

use_red_color

gboolean GncBudgetViewPrivate::use_red_color

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

w [1/2]

GtkBox GncBudgetView::w

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

w [2/2]

GtkBoxClass GncBudgetViewClass::w

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