GnuCash Tree Model

Files
file	gnc-tree-model-account-types.h
	GtkTreeModel implementation to display account types in a GtkTreeView.
file	gnc-tree-model-account.h
	GtkTreeModel implementation for gnucash account tree.
file	gnc-tree-model-commodity.h
	GtkTreeModel implementation for gnucash commodities.
file	gnc-tree-model-owner.h
	GtkTreeModel implementation for gnucash owner tree.
file	gnc-tree-model-price.h
	GtkTreeModel implementation for gnucash price database.
file	gnc-tree-model.h
	GtkTreeModel implementation for a generic gnucash tree.
file	gnc-tree-view-account.h
	GtkTreeView implementation for gnucash account tree.
file	gnc-tree-view-commodity.h
	GtkTreeView implementation for gnucash commodity tree.
file	gnc-tree-view-owner.h
	GtkTreeView implementation for gnucash owner tree.
file	gnc-tree-view-price.h
	GtkTreeView implementation for gnucash price tree.

Data Structures
struct	_GncTreeModelClass
	The class data structure for a generic tree model. More...
struct	AccountViewInfo
struct	AccountFilterDialog
struct	OwnerViewInfo
struct	OwnerFilterDialog

Macros
#define	GNC_TYPE_TREE_MODEL_ACCOUNT_TYPES   (gnc_tree_model_account_types_get_type ())
#define	GNC_TYPE_TREE_MODEL_ACCOUNT   (gnc_tree_model_account_get_type ())
#define	GNC_TREE_MODEL_ACCOUNT_NAME   "GncTreeModelAccount"
#define	GNC_TYPE_TREE_MODEL_COMMODITY   (gnc_tree_model_commodity_get_type ())
#define	GNC_TREE_MODEL_COMMODITY_NAME   "GncTreeModelCommodity"
#define	GNC_TYPE_TREE_MODEL_OWNER   (gnc_tree_model_owner_get_type ())
#define	GNC_TREE_MODEL_OWNER_NAME   "GncTreeModelOwner"
#define	GNC_TYPE_TREE_MODEL_PRICE   (gnc_tree_model_price_get_type ())
#define	GNC_TREE_MODEL_PRICE_NAME   "GncTreeModelPrice"
#define	GNC_TYPE_TREE_MODEL   (gnc_tree_model_get_type ())
#define	GNC_TREE_MODEL_NAME   "GncTreeModel"
#define	GNC_TYPE_TREE_VIEW_ACCOUNT   (gnc_tree_view_account_get_type ())
#define	GNC_TREE_VIEW_ACCOUNT_NAME   "GncTreeViewAccount"
#define	GNC_TYPE_TREE_VIEW_COMMODITY   (gnc_tree_view_commodity_get_type ())
#define	GNC_TYPE_TREE_VIEW_OWNER   (gnc_tree_view_owner_get_type ())
#define	GNC_TREE_VIEW_OWNER_NAME   "GncTreeViewOwner"
#define	GNC_OWNER_TREE_NAME_COL   "name"
#define	GNC_OWNER_TREE_TYPE_COL   "type"
#define	GNC_OWNER_TREE_ID_COL   "owner-id"
#define	GNC_OWNER_TREE_CURRENCY_COL   "currency"
#define	GNC_OWNER_TREE_ADDRESS_NAME_COL   "address-name"
#define	GNC_OWNER_TREE_ADDRESS_1_COL   "address-1"
#define	GNC_OWNER_TREE_ADDRESS_2_COL   "address-2"
#define	GNC_OWNER_TREE_ADDRESS_3_COL   "address-3"
#define	GNC_OWNER_TREE_ADDRESS_4_COL   "address-4"
#define	GNC_OWNER_TREE_PHONE_COL   "phone"
#define	GNC_OWNER_TREE_FAX_COL   "fax"
#define	GNC_OWNER_TREE_EMAIL_COL   "email"
#define	GNC_OWNER_TREE_BALANCE_COL   "balance"
#define	GNC_OWNER_TREE_BALANCE_REPORT_COL   "balance-report"
#define	GNC_OWNER_TREE_BALANCE_PERIOD_COL   "balance-period"
#define	GNC_OWNER_TREE_NOTES_COL   "notes"
#define	GNC_OWNER_TREE_ACTIVE_COL   "active"
#define	GNC_TYPE_TREE_VIEW_PRICE   (gnc_tree_view_price_get_type ())

Enumerations
enum	GncTreeModelAccountTypesColumn { GNC_TREE_MODEL_ACCOUNT_TYPES_COL_TYPE, GNC_TREE_MODEL_ACCOUNT_TYPES_COL_NAME, GNC_TREE_MODEL_ACCOUNT_TYPES_COL_SELECTED, GNC_TREE_MODEL_ACCOUNT_TYPES_NUM_COLUMNS }
enum	GncTreeModelAccountColumn {   GNC_TREE_MODEL_ACCOUNT_COL_NAME, GNC_TREE_MODEL_ACCOUNT_COL_TYPE, GNC_TREE_MODEL_ACCOUNT_COL_COMMODITY, GNC_TREE_MODEL_ACCOUNT_COL_CODE,   GNC_TREE_MODEL_ACCOUNT_COL_DESCRIPTION, GNC_TREE_MODEL_ACCOUNT_COL_LASTNUM, GNC_TREE_MODEL_ACCOUNT_COL_PRESENT, GNC_TREE_MODEL_ACCOUNT_COL_PRESENT_REPORT,   GNC_TREE_MODEL_ACCOUNT_COL_BALANCE, GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_REPORT, GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_PERIOD, GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_LIMIT,   GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_LIMIT_EXPLANATION, GNC_TREE_MODEL_ACCOUNT_COL_CLEARED, GNC_TREE_MODEL_ACCOUNT_COL_CLEARED_REPORT, GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED,   GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED_REPORT, GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED_DATE, GNC_TREE_MODEL_ACCOUNT_COL_FUTURE_MIN, GNC_TREE_MODEL_ACCOUNT_COL_FUTURE_MIN_REPORT,   GNC_TREE_MODEL_ACCOUNT_COL_TOTAL, GNC_TREE_MODEL_ACCOUNT_COL_TOTAL_REPORT, GNC_TREE_MODEL_ACCOUNT_COL_TOTAL_PERIOD, GNC_TREE_MODEL_ACCOUNT_COL_NOTES,   GNC_TREE_MODEL_ACCOUNT_COL_TAX_INFO, GNC_TREE_MODEL_ACCOUNT_COL_TAX_INFO_SUB_ACCT, GNC_TREE_MODEL_ACCOUNT_COL_HIDDEN, GNC_TREE_MODEL_ACCOUNT_COL_PLACEHOLDER,   GNC_TREE_MODEL_ACCOUNT_COL_OPENING_BALANCE, GNC_TREE_MODEL_ACCOUNT_COL_LAST_VISIBLE = GNC_TREE_MODEL_ACCOUNT_COL_OPENING_BALANCE, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_PRESENT, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_ACCOUNT,   GNC_TREE_MODEL_ACCOUNT_COL_COLOR_BALANCE, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_BALANCE_PERIOD, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_CLEARED, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_RECONCILED,   GNC_TREE_MODEL_ACCOUNT_COL_COLOR_FUTURE_MIN, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_TOTAL, GNC_TREE_MODEL_ACCOUNT_COL_COLOR_TOTAL_PERIOD, GNC_TREE_MODEL_ACCOUNT_NUM_COLUMNS }
enum	GncTreeModelCommodityColumn {   GNC_TREE_MODEL_COMMODITY_COL_NAMESPACE, GNC_TREE_MODEL_COMMODITY_COL_MNEMONIC, GNC_TREE_MODEL_COMMODITY_COL_USER_SYMBOL, GNC_TREE_MODEL_COMMODITY_COL_FULLNAME,   GNC_TREE_MODEL_COMMODITY_COL_PRINTNAME, GNC_TREE_MODEL_COMMODITY_COL_UNIQUE_NAME, GNC_TREE_MODEL_COMMODITY_COL_CUSIP, GNC_TREE_MODEL_COMMODITY_COL_FRACTION,   GNC_TREE_MODEL_COMMODITY_COL_QUOTE_FLAG, GNC_TREE_MODEL_COMMODITY_COL_QUOTE_SOURCE, GNC_TREE_MODEL_COMMODITY_COL_QUOTE_TZ, GNC_TREE_MODEL_COMMODITY_COL_LAST_VISIBLE = GNC_TREE_MODEL_COMMODITY_COL_QUOTE_TZ,   GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY, GNC_TREE_MODEL_COMMODITY_NUM_COLUMNS }
enum	GncTreeModelOwnerColumn {   GNC_TREE_MODEL_OWNER_COL_NAME, GNC_TREE_MODEL_OWNER_COL_TYPE, GNC_TREE_MODEL_OWNER_COL_ID, GNC_TREE_MODEL_OWNER_COL_CURRENCY,   GNC_TREE_MODEL_OWNER_COL_ADDRESS_NAME, GNC_TREE_MODEL_OWNER_COL_ADDRESS_1, GNC_TREE_MODEL_OWNER_COL_ADDRESS_2, GNC_TREE_MODEL_OWNER_COL_ADDRESS_3,   GNC_TREE_MODEL_OWNER_COL_ADDRESS_4, GNC_TREE_MODEL_OWNER_COL_PHONE, GNC_TREE_MODEL_OWNER_COL_FAX, GNC_TREE_MODEL_OWNER_COL_EMAIL,   GNC_TREE_MODEL_OWNER_COL_BALANCE, GNC_TREE_MODEL_OWNER_COL_BALANCE_REPORT, GNC_TREE_MODEL_OWNER_COL_NOTES, GNC_TREE_MODEL_OWNER_COL_ACTIVE,   GNC_TREE_MODEL_OWNER_COL_LAST_VISIBLE = GNC_TREE_MODEL_OWNER_COL_ACTIVE, GNC_TREE_MODEL_OWNER_COL_COLOR_BALANCE, GNC_TREE_MODEL_OWNER_NUM_COLUMNS }
enum	GncTreeModelPriceColumn {   GNC_TREE_MODEL_PRICE_COL_COMMODITY, GNC_TREE_MODEL_PRICE_COL_CURRENCY, GNC_TREE_MODEL_PRICE_COL_DATE, GNC_TREE_MODEL_PRICE_COL_SOURCE,   GNC_TREE_MODEL_PRICE_COL_TYPE, GNC_TREE_MODEL_PRICE_COL_VALUE, GNC_TREE_MODEL_PRICE_COL_LAST_VISIBLE = GNC_TREE_MODEL_PRICE_COL_VALUE, GNC_TREE_MODEL_PRICE_COL_VISIBILITY,   GNC_TREE_MODEL_PRICE_NUM_COLUMNS }

Functions
GtkTreeModel *	gnc_tree_model_account_types_filter_using_mask (guint32 types)
void	gnc_tree_model_account_types_set_mask (GtkTreeModel *f_model, guint32 types)
guint32	gnc_tree_model_account_types_get_mask (GtkTreeModel *f_model)
guint32	gnc_tree_model_account_types_get_selection (GtkTreeSelection *sel)
GNCAccountType	gnc_tree_model_account_types_get_selection_single (GtkTreeSelection *sel)
GNCAccountType	gnc_tree_model_account_types_get_active_combo (GtkComboBox *combo)
void	gnc_tree_model_account_types_set_selection (GtkTreeSelection *sel, guint32 selected)
void	gnc_tree_model_account_types_set_active_combo (GtkComboBox *combo, guint32 selected)
GtkTreeModel *	gnc_tree_model_account_types_new (guint32 selected)
void	gnc_tree_model_account_clear_cache (GncTreeModelAccount *model)
	Clear the tree model account cached values. More...
void	account_filter_dialog_create (AccountFilterDialog *fd, GncPluginPage *page)
gboolean	gnc_plugin_page_account_tree_filter_accounts (Account *account, gpointer user_data)
	This function tells the account tree view whether or not to filter out a particular account. More...
void	gppat_filter_show_hidden_toggled_cb (GtkToggleButton *togglebutton, AccountFilterDialog *fd)
	The "show hidden" button in the Filter dialog changed state. More...
void	gppat_filter_show_zero_toggled_cb (GtkToggleButton *togglebutton, AccountFilterDialog *fd)
	The "show zero totals" button in the Filter dialog changed state. More...
void	gppat_filter_show_unused_toggled_cb (GtkToggleButton *togglebutton, AccountFilterDialog *fd)
	The "show unused" button in the Filter dialog changed state. More...
void	gppat_filter_clear_all_cb (GtkWidget *button, AccountFilterDialog *fd)
	The "clear all account types" button in the Filter dialog was clicked. More...
void	gppat_filter_select_all_cb (GtkWidget *button, AccountFilterDialog *fd)
	The "select all account types" button in the Filter dialog was clicked. More...
void	gppat_filter_select_default_cb (GtkWidget *button, AccountFilterDialog *fd)
	The "select default account types" button in the Filter dialog was clicked. More...
void	gppat_filter_response_cb (GtkWidget *dialog, gint response, AccountFilterDialog *fd)
	The Filter dialog was closed. More...
void	gnc_tree_view_account_save (GncTreeViewAccount *tree_view, AccountFilterDialog *fd, GKeyFile *key_file, const gchar *group_name)
void	gnc_tree_view_account_restore (GncTreeViewAccount *view, AccountFilterDialog *fd, GKeyFile *key_file, const gchar *group_name)
void	gnc_tree_view_account_save_filter (GncTreeViewAccount *tree_view, AccountFilterDialog *fd, GKeyFile *key_file, const gchar *group_name)
void	gnc_tree_view_account_restore_filter (GncTreeViewAccount *view, AccountFilterDialog *fd, GKeyFile *key_file, const gchar *group_name)
GType	gnc_tree_view_account_get_type (void)
void	owner_filter_dialog_create (OwnerFilterDialog *fd, GncPluginPage *page)
gboolean	gnc_plugin_page_owner_tree_filter_owners (GncOwner *owner, gpointer user_data)
	This function tells the owner tree view whether or not to filter out a particular owner. More...
void	gppot_filter_show_inactive_toggled_cb (GtkToggleButton *togglebutton, OwnerFilterDialog *fd)
	The "only show active" button in the Filter dialog changed state. More...
void	gppot_filter_show_zero_toggled_cb (GtkToggleButton *togglebutton, OwnerFilterDialog *fd)
	The "show zero totals" button in the Filter dialog changed state. More...
void	gppot_filter_response_cb (GtkWidget *dialog, gint response, OwnerFilterDialog *fd)
	The Filter dialog was closed. More...
void	gnc_tree_view_owner_save (GncTreeViewOwner *tree_view, OwnerFilterDialog *fd, GKeyFile *key_file, const gchar *group_name)
void	gnc_tree_view_owner_restore (GncTreeViewOwner *view, OwnerFilterDialog *fd, GKeyFile *key_file, const gchar *group_name, GncOwnerType owner_type)

Variables
gboolean	OwnerViewInfo::show_inactive
GtkWidget *	OwnerFilterDialog::dialog
GncTreeViewOwner *	OwnerFilterDialog::tree_view
gboolean	OwnerFilterDialog::show_inactive
gboolean	OwnerFilterDialog::original_show_inactive
gboolean	OwnerFilterDialog::show_zero_total
gboolean	OwnerFilterDialog::original_show_zero_total

Account Tree Model Constructors
GtkTreeModel *	gnc_tree_model_account_new (Account *root)
	Create a new GtkTreeModel for manipulating gnucash accounts. More...

Account Tree Model Get/Set Functions
Account *	gnc_tree_model_account_get_account (GncTreeModelAccount *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash account. More...
gboolean	gnc_tree_model_account_get_iter_from_account (GncTreeModelAccount *model, Account *account, GtkTreeIter *iter)
	Convert a model/account pair into a gtk_tree_model_iter. More...
GtkTreePath *	gnc_tree_model_account_get_path_from_account (GncTreeModelAccount *model, Account *account)
	Convert a model/account pair into a gtk_tree_model_path. More...

Account Tree Model Constructors
GtkTreeModel *	gnc_tree_model_commodity_new (QofBook *book, gnc_commodity_table *ct)
	Create a new GtkTreeModel for manipulating gnucash commodities. More...

Commodity Tree Model Filter Helper Functions
gboolean	gnc_tree_model_commodity_iter_is_namespace (GncTreeModelCommodity *model, GtkTreeIter *iter)
	Determine whether or not the specified GtkTreeIter points to a commodity namespace. More...
gboolean	gnc_tree_model_commodity_iter_is_commodity (GncTreeModelCommodity *model, GtkTreeIter *iter)
	Determine whether or not the specified GtkTreeIter points to a commodity. More...
gnc_commodity_namespace *	gnc_tree_model_commodity_get_namespace (GncTreeModelCommodity *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash commodity namespace. More...
gnc_commodity *	gnc_tree_model_commodity_get_commodity (GncTreeModelCommodity *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash commodity. More...

Commodity Tree Model Lookup Functions
gboolean	gnc_tree_model_commodity_get_iter_from_namespace (GncTreeModelCommodity *model, gnc_commodity_namespace *name_space, GtkTreeIter *iter)
	Convert a commodity namespace pointer into a GtkTreeIter. More...
gboolean	gnc_tree_model_commodity_get_iter_from_commodity (GncTreeModelCommodity *model, gnc_commodity *commodity, GtkTreeIter *iter)
	Convert a commodity pointer into a GtkTreeIter. More...
GtkTreePath *	gnc_tree_model_commodity_get_path_from_commodity (GncTreeModelCommodity *model, gnc_commodity *commodity)
	Convert a commodity pointer into a GtkTreePath. More...

Owner Tree Model Constructors
GtkTreeModel *	gnc_tree_model_owner_new (GncOwnerType owner_type)
	Create a new GtkTreeModel for manipulating gnucash owners. More...

Owner Tree Model Get/Set Functions
GncOwner *	gnc_tree_model_owner_get_owner (GncTreeModelOwner *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash owner. More...
gboolean	gnc_tree_model_owner_get_iter_from_owner (GncTreeModelOwner *model, GncOwner *owner, GtkTreeIter *iter)
	Convert a model/owner pair into a gtk_tree_model_iter. More...
GtkTreePath *	gnc_tree_model_owner_get_path_from_owner (GncTreeModelOwner *model, GncOwner *owner)
	Convert a model/owner pair into a gtk_tree_model_path. More...

Account Tree Model Constructors
GtkTreeModel *	gnc_tree_model_price_new (QofBook *book, GNCPriceDB *price_db)
	Create a new GtkTreeModel for manipulating gnucash commodity prices. More...

Price Tree Model Filter Helper Functions
gboolean	gnc_tree_model_price_iter_is_namespace (GncTreeModelPrice *model, GtkTreeIter *iter)
	Determine whether or not the specified GtkTreeIter points to a "commodity namespace". More...
gboolean	gnc_tree_model_price_iter_is_commodity (GncTreeModelPrice *model, GtkTreeIter *iter)
	Determine whether or not the specified GtkTreeIter points to a commodity. More...
gboolean	gnc_tree_model_price_iter_is_price (GncTreeModelPrice *model, GtkTreeIter *iter)
	Determine whether or not the specified GtkTreeIter points to a price. More...
gnc_commodity_namespace *	gnc_tree_model_price_get_namespace (GncTreeModelPrice *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash commodity namespace. More...
gnc_commodity *	gnc_tree_model_price_get_commodity (GncTreeModelPrice *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash commodity. More...
GNCPrice *	gnc_tree_model_price_get_price (GncTreeModelPrice *model, GtkTreeIter *iter)
	Convert a model/iter pair to a gnucash price. More...

Commodity Tree Model Lookup Functions
gboolean	gnc_tree_model_price_get_iter_from_namespace (GncTreeModelPrice *model, gnc_commodity_namespace *name_space, GtkTreeIter *iter)
	Convert a commodity namespace pointer into a GtkTreeIter. More...
gboolean	gnc_tree_model_price_get_iter_from_commodity (GncTreeModelPrice *model, gnc_commodity *commodity, GtkTreeIter *iter)
	Convert a commodity pointer into a GtkTreeIter. More...
gboolean	gnc_tree_model_price_get_iter_from_price (GncTreeModelPrice *model, GNCPrice *price, GtkTreeIter *iter)
	Convert a price pointer into a GtkTreeIter. More...
GtkTreePath *	gnc_tree_model_price_get_path_from_price (GncTreeModelPrice *model, GNCPrice *price)
	Convert a price pointer into a GtkTreePath. More...

Account Tree View Constructors
GtkTreeView *	gnc_tree_view_account_new_with_root (Account *root, gboolean show_root)
	Create a new account tree view. More...
GtkTreeView *	gnc_tree_view_account_new (gboolean show_root)
	Create a new account tree view. More...

Account Tree View Configuration
typedef gchar *(*	GncTreeViewAccountColumnSource) (Account *account, GtkTreeViewColumn *col, GtkCellRenderer *cell)
typedef void(*	GncTreeViewAccountColumnTextEdited) (Account *account, GtkTreeViewColumn *col, const gchar *new_text)
GtkTreeViewColumn *	gnc_tree_view_account_add_custom_column (GncTreeViewAccount *view, const gchar *column_title, GncTreeViewAccountColumnSource source_cb, GncTreeViewAccountColumnTextEdited edited_cb)
	Add a new custom column to the set of columns in an account tree view. More...
GtkTreeViewColumn *	gnc_tree_view_account_add_custom_column_renderer (GncTreeViewAccount *account_view, const gchar *column_title, GncTreeViewAccountColumnSource col_source_cb, GncTreeViewAccountColumnTextEdited col_edited_cb, GtkCellRenderer *renderer)
void	gnc_tree_view_account_set_name_edited (GncTreeViewAccount *view, GncTreeViewAccountColumnTextEdited edited_cb)
void	gnc_tree_view_account_name_edited_cb (Account *account, GtkTreeViewColumn *col, const gchar *new_name)
void	gnc_tree_view_account_set_code_edited (GncTreeViewAccount *view, GncTreeViewAccountColumnTextEdited edited_cb)
void	gnc_tree_view_account_code_edited_cb (Account *account, GtkTreeViewColumn *col, const gchar *new_code)
void	gnc_tree_view_account_set_description_edited (GncTreeViewAccount *view, GncTreeViewAccountColumnTextEdited edited_cb)
void	gnc_tree_view_account_description_edited_cb (Account *account, GtkTreeViewColumn *col, const gchar *new_desc)
void	gnc_tree_view_account_set_notes_edited (GncTreeViewAccount *view, GncTreeViewAccountColumnTextEdited edited_cb)
void	gnc_tree_view_account_notes_edited_cb (Account *account, GtkTreeViewColumn *col, const gchar *new_notes)
GtkTreeViewColumn *	gnc_tree_view_account_add_property_column (GncTreeViewAccount *view, const gchar *column_title, const gchar *propname)
	Add a new column to the set of columns in an account tree view. More...

Account Tree View Filtering
typedef gboolean(*	gnc_tree_view_account_filter_func) (Account *account, gpointer data)
	This is the description of a filter function used by the account tree. More...
void	gnc_tree_view_account_get_view_info (GncTreeViewAccount *account_view, AccountViewInfo *avi)
	Given pointers to an account tree and old style filter block, this function will copy the current configuration of the account tree widget into the data block. More...
void	gnc_tree_view_account_set_view_info (GncTreeViewAccount *account_view, AccountViewInfo *avi)
	Given pointers to an account tree and old style filter block, this function will applies the settings specified to the current configuration of the account tree widget. More...
void	gnc_tree_view_account_set_filter (GncTreeViewAccount *account_view, gnc_tree_view_account_filter_func func, gpointer data, GSourceFunc destroy)
	This function attaches a filter function to the given account tree. More...
gboolean	gnc_tree_view_account_filter_by_view_info (Account *acct, gpointer data)
void	gnc_tree_view_account_refilter (GncTreeViewAccount *view)
	This function forces the account tree filter to be evaluated. More...

Account Tree View Get/Set Functions
gint	gnc_tree_view_account_count_children (GncTreeViewAccount *view, Account *account)
	This function determines if an account in the account tree view has any visible children. More...
void	gnc_tree_view_account_clear_model_cache (GncTreeViewAccount *view)
	This function clears the tree model account cache so the values will be updated/refreshed. More...
Account *	gnc_tree_view_account_get_account_from_path (GncTreeViewAccount *view, GtkTreePath *path)
	This function returns the account associated with the specified path. More...
Account *	gnc_tree_view_account_get_account_from_iter (GtkTreeModel *model, GtkTreeIter *iter)
	This function returns the account associated with the specified iter. More...
Account *	gnc_tree_view_account_get_cursor_account (GncTreeViewAccount *view)
	This function returns the account in the account tree view at the current location of the cursor. More...
Account *	gnc_tree_view_account_get_selected_account (GncTreeViewAccount *view)
	This function returns the account associated with the selected item in the account tree view. More...
void	gnc_tree_view_account_set_selected_account (GncTreeViewAccount *view, Account *account)
	This function selects an account in the account tree view. More...
GList *	gnc_tree_view_account_get_selected_accounts (GncTreeViewAccount *view)
	This function returns a list of the accounts associated with the selected items in the account tree view. More...
void	gnc_tree_view_account_set_selected_accounts (GncTreeViewAccount *view, GList *account_list, gboolean show_last)
	This function selects a set of accounts in the account tree view. More...
void	gnc_tree_view_account_select_subaccounts (GncTreeViewAccount *view, Account *account)
	This function selects all sub-accounts of an account in the account tree view. More...
void	gnc_tree_view_account_expand_to_account (GncTreeViewAccount *view, Account *account)
	This function forces the account tree expand whatever levels are necessary to make the specified account visible. More...
void	gnc_tree_view_account_column_add_color (GncTreeViewAccount *view, GtkTreeViewColumn *col)
	Add the account color background data function to the GncTreeViewAccount column to show or not the column background in the account color.
void	gnc_tree_view_account_set_editing_started_cb (GncTreeViewAccount *view, GFunc editing_started_cb, gpointer editing_cb_data)
	Setup the callback for when the user starts editing the account tree so actions can be disabled like the delete menu option as required.
void	gnc_tree_view_account_set_editing_finished_cb (GncTreeViewAccount *view, GFunc editing_finished_cb, gpointer editing_cb_data)
	Setup the callback for when the user finishes editing the account tree so actions can be enabled like the delete menu option as required.

Commodity Tree View Constructors
GtkTreeView *	gnc_tree_view_commodity_new (QofBook *book, const gchar *first_property_name,...)
	Create a new commodity tree view. More...

Commodity Tree View Configuration
void	gnc_tree_view_commodity_configure_columns (GncTreeViewCommodity *view, GSList *column_names)
	Configure (by name) the set of visible columns in an commodity tree view. More...

Commodity Tree View Filtering
typedef gboolean(*	gnc_tree_view_commodity_ns_filter_func) (gnc_commodity_namespace *, gpointer data)
typedef gboolean(*	gnc_tree_view_commodity_cm_filter_func) (gnc_commodity *, gpointer data)
void	gnc_tree_view_commodity_set_filter (GncTreeViewCommodity *view, gnc_tree_view_commodity_ns_filter_func ns_func, gnc_tree_view_commodity_cm_filter_func cm_func, gpointer data, GDestroyNotify destroy)
	This function attaches a filter function to the given commodity tree. More...
void	gnc_tree_view_commodity_refilter (GncTreeViewCommodity *view)
	This function forces the commodity tree filter to be evaluated. More...

Commodity Tree View Get/Set Functions
gnc_commodity *	gnc_tree_view_commodity_get_cursor_commodity (GncTreeViewCommodity *view)
	This function returns the commodity in the commodity tree view at the current location of the cursor. More...
gnc_commodity *	gnc_tree_view_commodity_get_selected_commodity (GncTreeViewCommodity *view)
	This function returns the commodity associated with the selected item in the commodity tree view. More...
void	gnc_tree_view_commodity_select_commodity (GncTreeViewCommodity *view, gnc_commodity *commodity)
	Select the commodity in the associated commodity tree view. More...
void	gnc_tree_view_commodity_select_subcommodities (GncTreeViewCommodity *view, gnc_commodity *commodity)
	This function selects all sub-commodities of an commodity in the commodity tree view. More...

Owner Tree View Constructor
GtkTreeView *	gnc_tree_view_owner_new (GncOwnerType owner_type)
	Create a new owner tree view for one type of owners. More...

Owner Tree View Configuration
typedef gchar *(*	GncTreeViewOwnerColumnSource) (GncOwner *owner, GtkTreeViewColumn *col, GtkCellRenderer *cell)
typedef void(*	GncTreeViewOwnerColumnTextEdited) (GncOwner *owner, GtkTreeViewColumn *col, const gchar *new_text)

Owner Tree View Filtering
typedef gboolean(*	gnc_tree_view_owner_filter_func) (GncOwner *owner, gpointer data)
	This is the description of a filter function used by the owner tree. More...
void	gnc_tree_view_owner_set_filter (GncTreeViewOwner *owner_view, gnc_tree_view_owner_filter_func func, gpointer data, GSourceFunc destroy)
	This function attaches a filter function to the given owner tree. More...
void	gnc_tree_view_owner_refilter (GncTreeViewOwner *view)
	This function forces the owner tree filter to be evaluated. More...

Owner Tree View Get/Set Functions
GncOwner *	gnc_tree_view_owner_get_owner_from_path (GncTreeViewOwner *view, GtkTreePath *path)
	This function returns the owner associated with the specified path. More...
GncOwner *	gnc_tree_view_owner_get_owner_from_iter (GtkTreeModel *model, GtkTreeIter *iter)
	This function returns the owner associated with the specified iter. More...
GncOwner *	gnc_tree_view_owner_get_selected_owner (GncTreeViewOwner *view)
	This function returns the owner associated with the selected item in the owner tree view. More...
void	gnc_tree_view_owner_set_selected_owner (GncTreeViewOwner *view, GncOwner *owner)
	This function selects an owner in the owner tree view. More...

Price Tree View Constructors
GtkTreeView *	gnc_tree_view_price_new (QofBook *book, const gchar *first_property_name,...)
	Create a new price tree view. More...

Price Tree View Filtering
typedef gboolean(*	gnc_tree_view_price_ns_filter_func) (gnc_commodity_namespace *, gpointer data)
	This function attaches a filter function to the given price tree. More...
typedef gboolean(*	gnc_tree_view_price_cm_filter_func) (gnc_commodity *, gpointer data)
typedef gboolean(*	gnc_tree_view_price_pc_filter_func) (GNCPrice *, gpointer data)
void	gnc_tree_view_price_set_filter (GncTreeViewPrice *view, gnc_tree_view_price_ns_filter_func ns_func, gnc_tree_view_price_cm_filter_func cm_func, gnc_tree_view_price_pc_filter_func pc_func, gpointer data, GDestroyNotify destroy)

Price Tree View Get/Set Functions
GNCPrice *	gnc_tree_view_price_get_cursor_price (GncTreeViewPrice *view)
	This function returns the price in the price tree view at the current location of the cursor. More...
GNCPrice *	gnc_tree_view_price_get_selected_price (GncTreeViewPrice *view)
	This function returns the price associated with the selected item in the price tree view. More...
void	gnc_tree_view_price_set_selected_price (GncTreeViewPrice *view, GNCPrice *price)
	This function selects an price in the price tree view. More...
GList *	gnc_tree_view_price_get_selected_prices (GncTreeViewPrice *view)
	This function returns a list of the prices associated with the selected items in the price tree view. More...
GList *	gnc_tree_view_price_get_selected_commodities (GncTreeViewPrice *view)
	This function returns a list of commodities associated with the selected rows that are not prices but are the parent rows for prices in the price tree view. More...

Detailed Description

Typedef Documentation

gnc_tree_view_account_filter_func

typedef gboolean(* gnc_tree_view_account_filter_func) (Account *account, gpointer data)

This is the description of a filter function used by the account tree.

Parameters

account	The account to be tested.
data	The data provided when the filter function was added.

Returns

TRUE if the account should be displayed.

Definition at line 266 of file gnc-tree-view-account.h.

gnc_tree_view_owner_filter_func

typedef gboolean(* gnc_tree_view_owner_filter_func) (GncOwner *owner, gpointer data)

This is the description of a filter function used by the owner tree.

Parameters

owner	The owner to be tested.
data	The data provided when the filter function was added.

Returns

TRUE if the owner should be displayed.

Definition at line 155 of file gnc-tree-view-owner.h.

gnc_tree_view_price_ns_filter_func

typedef gboolean(* gnc_tree_view_price_ns_filter_func) (gnc_commodity_namespace *, gpointer data)

This function attaches a filter function to the given price tree.

This function will be called for each price that the view thinks should possibly show. The filter may perform any actions necessary on the price to decide whether it should be shown or not. (I.E. Check type, placeholder status, etc.) If the filter returns TRUE then the price will be displayed.

Parameters

price_view	A pointer to an price tree view.
func	A filtration function that is called on individual elements in the tree. If this function returns TRUE, the price will be displayed.
data	A data block passed into each instance of the function.
destroy	A function to destroy the data block. This function will be called when the filter is destroyed. may be NULL.

Definition at line 116 of file gnc-tree-view-price.h.

Function Documentation

gnc_plugin_page_account_tree_filter_accounts()

gboolean gnc_plugin_page_account_tree_filter_accounts	(	Account *	account,
		gpointer	user_data
	)

This function tells the account tree view whether or not to filter out a particular account.

Accounts may be filtered if the user has decided not to display that particular account type, or if the user has requested that accounts with a zero total not be shown.

Parameters

account	The account that was toggled.
user_data	A pointer to the AccountFilterDialog struct.

Returns

TRUE if the account should be visible. FALSE if the account should be hidden.

Definition at line 2012 of file gnc-tree-view-account.c.

{
    AccountFilterDialog *fd = user_data;
    GNCAccountType acct_type;
    gnc_numeric total;
    gboolean result;

    ENTER("account %p:%s", account, xaccAccountGetName(account));

    if (g_hash_table_size (fd->filter_override) > 0)
    {
        Account *test_acc = NULL;
        test_acc = g_hash_table_lookup (fd->filter_override, account);
        if (test_acc != NULL)
        {
            LEAVE(" filter: override");
            return TRUE;
        }
    }

    if (!fd->show_hidden && xaccAccountIsHidden (account))
    {
        LEAVE(" hide: hidden");
        return FALSE;
    }

    if (!fd->show_zero_total)
    {
        total = xaccAccountGetBalanceInCurrency (account, NULL, TRUE);
        if (gnc_numeric_zero_p(total))
        {
            LEAVE(" hide: zero balance");
            return FALSE;
        }
    }

    if (!fd->show_unused)
    {
        if (gnc_account_and_descendants_empty(account))
        {
            LEAVE(" hide: unused");
            return FALSE;
        }
    }

    acct_type = xaccAccountGetType(account);
    result = (fd->visible_types & (1 << acct_type)) ? TRUE : FALSE;
    LEAVE(" %s", result ? "show" : "hide");
    return result;
}

gnc_plugin_page_owner_tree_filter_owners()

gboolean gnc_plugin_page_owner_tree_filter_owners	(	GncOwner *	owner,
		gpointer	user_data
	)

This function tells the owner tree view whether or not to filter out a particular owner.

Owners may be filtered if the user has decided not to display inactive owners, or if the user has requested that owners with a zero total not be shown.

Parameters

owner	The owner that is being evaluated.
user_data	A pointer to the OwnerFilterDialog struct.

Returns

TRUE if the owner should be visible. FALSE if the owner should be hidden.

Definition at line 1025 of file gnc-tree-view-owner.c.

{
    OwnerFilterDialog *fd = user_data;
    gnc_numeric total;

    ENTER("owner %p:%s", owner, gncOwnerGetName(owner));

    if (!fd->show_inactive && !gncOwnerGetActive (owner))
    {
        LEAVE(" hide: inactive");
        return FALSE;
    }

    if (!fd->show_zero_total)
    {
        total = gncOwnerGetBalanceInCurrency (owner, NULL);
        if (gnc_numeric_zero_p(total))
        {
            LEAVE(" hide: zero balance");
            return FALSE;
        }
    }

    return TRUE;
}

gnc_tree_model_account_clear_cache()

void gnc_tree_model_account_clear_cache

(

GncTreeModelAccount *

model

)

Clear the tree model account cached values.

Parameters

model

A pointer to the account tree model.

Definition at line 573 of file gnc-tree-model-account.c.

{
    if (model)
    {
        // destroy the cached account values and recreate
        g_hash_table_destroy (model->account_values_hash);
        model->account_values_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
                                                           g_free, g_free);

        gtk_tree_model_foreach (GTK_TREE_MODEL(model), row_changed_foreach_func, NULL);
    }
}

gnc_tree_model_account_get_account()

Account* gnc_tree_model_account_get_account	(	GncTreeModelAccount *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash account.

This routine should only be called from an account tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the account tree model.
iter	A gtk_tree_iter corresponding to a single account in the model.

Returns

A pointer to the corresponding account.

Definition at line 1241 of file gnc-tree-model-account.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_ACCOUNT(model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    return (Account *) iter->user_data;
}

gnc_tree_model_account_get_iter_from_account()

gboolean gnc_tree_model_account_get_iter_from_account	(	GncTreeModelAccount *	model,
		Account *	account,
		GtkTreeIter *	iter
	)

Convert a model/account pair into a gtk_tree_model_iter.

This routine should only be called from the file gnc-tree-view-account.c.

Definition at line 1258 of file gnc-tree-model-account.c.

{
    Account *parent;
    gint i;

    ENTER("model %p, account %p, iter %p", model, account, iter);
    gnc_leave_return_val_if_fail (GNC_IS_TREE_MODEL_ACCOUNT(model), FALSE);
    gnc_leave_return_val_if_fail ((account != NULL), FALSE);
    gnc_leave_return_val_if_fail ((iter != NULL), FALSE);

    iter->user_data = account;
    iter->stamp = model->stamp;

    if (account == model->root)
    {
        iter->user_data2 = NULL;
        iter->user_data3 = GINT_TO_POINTER(0);
        LEAVE("Matched root");
        return TRUE;
    }

    if (model->root != gnc_account_get_root (account))
    {
        LEAVE("Root doesn't match");
        return FALSE;
    }

    parent = gnc_account_get_parent (account);
    i = gnc_account_child_index (parent, account);
    iter->user_data2 = parent;
    iter->user_data3 = GINT_TO_POINTER(i);
    LEAVE("iter %s", iter_to_string (iter));
    return (i != -1);
}

gnc_tree_model_account_get_path_from_account()

GtkTreePath* gnc_tree_model_account_get_path_from_account	(	GncTreeModelAccount *	model,
		Account *	account
	)

Convert a model/account pair into a gtk_tree_model_path.

This routine should only be called from the file gnc-tree-view-account.c.

Definition at line 1301 of file gnc-tree-model-account.c.

{
    GtkTreeIter tree_iter;
    GtkTreePath *tree_path;

    ENTER("model %p, account %p", model, account);
    gnc_leave_return_val_if_fail (GNC_IS_TREE_MODEL_ACCOUNT(model), NULL);
    gnc_leave_return_val_if_fail (account != NULL, NULL);

    if (!gnc_tree_model_account_get_iter_from_account (model, account,
            &tree_iter))
    {
        LEAVE("no iter");
        return NULL;
    }

    tree_path = gtk_tree_model_get_path (GTK_TREE_MODEL(model), &tree_iter);
    if (tree_path)
    {
        gchar *path_string = gtk_tree_path_to_string (tree_path);
        LEAVE("path (2) %s", path_string);
        g_free (path_string);
    }
    else
    {
        LEAVE("no path");
    }
    return tree_path;
}

gnc_tree_model_account_new()

GtkTreeModel* gnc_tree_model_account_new

(

Account *

root

)

Create a new GtkTreeModel for manipulating gnucash accounts.

Parameters

root	The account group to put at the top level of the tree hierarchy.

Definition at line 255 of file gnc-tree-model-account.c.

{
    GncTreeModelAccount *model;
    const GList *item;

    ENTER("root %p", root);
    item = gnc_gobject_tracking_get_list (GNC_TREE_MODEL_ACCOUNT_NAME);
    for ( ; item; item = g_list_next (item))
    {
        model = (GncTreeModelAccount *)item->data;
        if (model->root == root)
        {
            g_object_ref (G_OBJECT(model));
            LEAVE("returning existing model %p", model);
            return GTK_TREE_MODEL(model);
        }
    }

    model = g_object_new (GNC_TYPE_TREE_MODEL_ACCOUNT, NULL);

    model->book = gnc_get_current_book();
    model->root = root;

    model->event_handler_id = qof_event_register_handler
                             ((QofEventHandler)gnc_tree_model_account_event_handler, model);

    LEAVE("model %p", model);
    return GTK_TREE_MODEL(model);
}

gnc_tree_model_commodity_get_commodity()

gnc_commodity* gnc_tree_model_commodity_get_commodity	(	GncTreeModelCommodity *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash commodity.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single commodity in the model.

Returns

A pointer to the corresponding commodity.

Definition at line 237 of file gnc-tree-model-commodity.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    if (iter->user_data != ITER_IS_COMMODITY)
        return NULL;
    return (gnc_commodity *)iter->user_data2;
}

gnc_tree_model_commodity_get_iter_from_commodity()

gboolean gnc_tree_model_commodity_get_iter_from_commodity	(	GncTreeModelCommodity *	model,
		gnc_commodity *	commodity,
		GtkTreeIter *	iter
	)

Convert a commodity pointer into a GtkTreeIter.

Parameters

model	A pointer to the commodity tree model.
commodity	A pointer to the gnucash commodity.
iter	A pointer to a GtkTreeIter. This iter will be filled in to point where the commodity appears in the commodity tree.

Returns

TRUE if the returned iter is valid, FALSE otherwise.

Definition at line 893 of file gnc-tree-model-commodity.c.

{
    gnc_commodity_namespace *name_space;
    GList *list;
    gint n;

    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), FALSE);
    g_return_val_if_fail ((commodity != NULL), FALSE);
    g_return_val_if_fail ((iter != NULL), FALSE);

    ENTER("model %p, commodity %p, iter %p", model, commodity, iter);

    name_space = gnc_commodity_get_namespace_ds(commodity);
    if (name_space == NULL)
    {
        LEAVE("no namespace");
        return FALSE;
    }

    list = gnc_commodity_namespace_get_commodity_list(name_space);
    if (list == NULL)
    {
        LEAVE("empty list");
        return FALSE;
    }

    n = g_list_index(list, commodity);
    if (n == -1)
    {
        LEAVE("not in list");
        return FALSE;
    }

    iter->stamp = model->stamp;
    iter->user_data  = ITER_IS_COMMODITY;
    iter->user_data2 = commodity;
    iter->user_data3 = GINT_TO_POINTER(n);
    LEAVE("iter %s", iter_to_string(iter));
    return TRUE;
}

gnc_tree_model_commodity_get_iter_from_namespace()

gboolean gnc_tree_model_commodity_get_iter_from_namespace	(	GncTreeModelCommodity *	model,
		gnc_commodity_namespace *	name_space,
		GtkTreeIter *	iter
	)

Convert a commodity namespace pointer into a GtkTreeIter.

Parameters

model	A pointer to the commodity tree model.
namespace	A pointer to the gnucash commodity namespace.
iter	A pointer to a GtkTreeIter. This iter will be filled in to point where the namespace appears in the commodity tree.

Returns

TRUE if the returned iter is valid, FALSE otherwise.

Definition at line 978 of file gnc-tree-model-commodity.c.

{
    GList *list;
    gint n;

    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), FALSE);
    g_return_val_if_fail ((name_space != NULL), FALSE);
    g_return_val_if_fail ((iter != NULL), FALSE);

    ENTER("model %p, namespace %p, iter %p", model, name_space, iter);

    list = gnc_commodity_table_get_namespaces_list(model->commodity_table);
    if (list == NULL)
    {
        LEAVE("");
        return FALSE;
    }

    n = g_list_index(list, name_space);
    if (n == -1)
    {
        LEAVE("");
        return FALSE;
    }

    iter->stamp = model->stamp;
    iter->user_data  = ITER_IS_NAMESPACE;
    iter->user_data2 = name_space;
    iter->user_data3 = GINT_TO_POINTER(n);
    LEAVE("iter %s", iter_to_string(iter));
    return TRUE;
}

gnc_tree_model_commodity_get_namespace()

gnc_commodity_namespace* gnc_tree_model_commodity_get_namespace	(	GncTreeModelCommodity *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash commodity namespace.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single namespace in the model.

Returns

A pointer to the corresponding namespace.

Definition at line 223 of file gnc-tree-model-commodity.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    if (iter->user_data != ITER_IS_NAMESPACE)
        return NULL;
    return (gnc_commodity_namespace *)iter->user_data2;
}

gnc_tree_model_commodity_get_path_from_commodity()

GtkTreePath* gnc_tree_model_commodity_get_path_from_commodity	(	GncTreeModelCommodity *	model,
		gnc_commodity *	commodity
	)

Convert a commodity pointer into a GtkTreePath.

Parameters

model	A pointer to the commodity tree model.
commodity	A pointer to the gnucash commodity.

Returns

A pointer to a GtkTreePath describing the location of this commodity. This pointer must be freed by the caller when no longer needed. This routine will return NULL if the commodity does not exist in the tree.

Definition at line 942 of file gnc-tree-model-commodity.c.

{
    GtkTreeIter tree_iter;
    GtkTreePath *tree_path;

    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), NULL);
    g_return_val_if_fail (commodity != NULL, NULL);
    ENTER("model %p, commodity %p", model, commodity);

    if (!gnc_tree_model_commodity_get_iter_from_commodity (model, commodity, &tree_iter))
    {
        LEAVE("no iter");
        return NULL;
    }

    tree_path = gtk_tree_model_get_path (GTK_TREE_MODEL(model), &tree_iter);
    if (tree_path)
    {
        gchar *path_string = gtk_tree_path_to_string(tree_path);
        LEAVE("path (2) %s", path_string);
        g_free(path_string);
    }
    else
    {
        LEAVE("no path");
    }
    return tree_path;
}

gnc_tree_model_commodity_iter_is_commodity()

gboolean gnc_tree_model_commodity_iter_is_commodity	(	GncTreeModelCommodity *	model,
		GtkTreeIter *	iter
	)

Determine whether or not the specified GtkTreeIter points to a commodity.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single item in the model.

Returns

TRUE if the iter points to a commodity, FALSE otherwise.

Definition at line 211 of file gnc-tree-model-commodity.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), FALSE);
    g_return_val_if_fail (iter != NULL, FALSE);
    g_return_val_if_fail (iter->user_data != NULL, FALSE);
    g_return_val_if_fail (iter->stamp == model->stamp, FALSE);

    return (iter->user_data == ITER_IS_COMMODITY);
}

gnc_tree_model_commodity_iter_is_namespace()

gboolean gnc_tree_model_commodity_iter_is_namespace	(	GncTreeModelCommodity *	model,
		GtkTreeIter *	iter
	)

Determine whether or not the specified GtkTreeIter points to a commodity namespace.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single item in the model.

Returns

TRUE if the iter points to a commodity namespace, FALSE otherwise.

Definition at line 199 of file gnc-tree-model-commodity.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_COMMODITY (model), FALSE);
    g_return_val_if_fail (iter != NULL, FALSE);
    g_return_val_if_fail (iter->user_data != NULL, FALSE);
    g_return_val_if_fail (iter->stamp == model->stamp, FALSE);

    return (iter->user_data == ITER_IS_NAMESPACE);
}

gnc_tree_model_commodity_new()

GtkTreeModel* gnc_tree_model_commodity_new	(	QofBook *	book,
		gnc_commodity_table *	ct
	)

Create a new GtkTreeModel for manipulating gnucash commodities.

Parameters

book	The book that holds these commodities.
ct	A pointer to the commodity table to use for this tree. All namespaces and commodities in this tree will be included.

Definition at line 168 of file gnc-tree-model-commodity.c.

{
    GncTreeModelCommodity *model;
    const GList *item;

    ENTER("");

    item = gnc_gobject_tracking_get_list(GNC_TREE_MODEL_COMMODITY_NAME);
    for ( ; item; item = g_list_next(item))
    {
        model = (GncTreeModelCommodity *)item->data;
        if (model->commodity_table == ct)
        {
            g_object_ref(G_OBJECT(model));
            LEAVE("returning existing model %p", model);
            return GTK_TREE_MODEL(model);
        }
    }

    model = g_object_new (GNC_TYPE_TREE_MODEL_COMMODITY, NULL);
    model->book = book;
    model->commodity_table = ct;

    model->event_handler_id =
        qof_event_register_handler (gnc_tree_model_commodity_event_handler, model);

    LEAVE("");
    return GTK_TREE_MODEL (model);
}

gnc_tree_model_owner_get_iter_from_owner()

gboolean gnc_tree_model_owner_get_iter_from_owner	(	GncTreeModelOwner *	model,
		GncOwner *	owner,
		GtkTreeIter *	iter
	)

Convert a model/owner pair into a gtk_tree_model_iter.

This routine should only be called from the file gnc-tree-view-owner.c.

Definition at line 797 of file gnc-tree-model-owner.c.

{
    GList *owner_in_list;

    ENTER("model %p, owner %p, iter %p", model, owner, iter);
    gnc_leave_return_val_if_fail (GNC_IS_TREE_MODEL_OWNER (model), FALSE);
    gnc_leave_return_val_if_fail ((owner != NULL), FALSE);
    gnc_leave_return_val_if_fail ((iter != NULL), FALSE);

    owner_in_list = g_list_find_custom (model->owner_list, (gconstpointer)owner, (GCompareFunc)gncOwnerGCompareFunc);
    if (owner_in_list)
    {
        iter->stamp = model->stamp;
        iter->user_data = owner_in_list->data;
        iter->user_data2 = GINT_TO_POINTER (g_list_position (model->owner_list, owner_in_list));
        iter->user_data3 = NULL;
        LEAVE("iter %s", iter_to_string (iter));
        return TRUE;
    }
    else
    {
        iter->stamp = 0;
        iter->user_data = NULL;
        LEAVE("Owner not found in list");
        return FALSE;
    }
}

gnc_tree_model_owner_get_owner()

GncOwner* gnc_tree_model_owner_get_owner	(	GncTreeModelOwner *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash owner.

This routine should only be called from an owner tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the owner tree model.
iter	A gtk_tree_iter corresponding to a single owner in the model.

Returns

A pointer to the corresponding owner.

Definition at line 780 of file gnc-tree-model-owner.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_OWNER (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    return (GncOwner *) iter->user_data;
}

gnc_tree_model_owner_get_path_from_owner()

GtkTreePath* gnc_tree_model_owner_get_path_from_owner	(	GncTreeModelOwner *	model,
		GncOwner *	owner
	)

Convert a model/owner pair into a gtk_tree_model_path.

This routine should only be called from the file gnc-tree-view-owner.c.

Definition at line 833 of file gnc-tree-model-owner.c.

{
    GtkTreeIter tree_iter;
    GtkTreePath *tree_path;

    ENTER("model %p, owner %p", model, owner);
    gnc_leave_return_val_if_fail (GNC_IS_TREE_MODEL_OWNER (model), NULL);
    gnc_leave_return_val_if_fail (owner != NULL, NULL);

    if (!gnc_tree_model_owner_get_iter_from_owner (model, owner,
            &tree_iter))
    {
        LEAVE("no iter");
        return NULL;
    }

    tree_path = gtk_tree_model_get_path (GTK_TREE_MODEL(model), &tree_iter);
    if (tree_path)
    {
        gchar *path_string = gtk_tree_path_to_string(tree_path);
        LEAVE("path (2) %s", path_string);
        g_free(path_string);
    }
    else
    {
        LEAVE("no path");
    }
    return tree_path;
}

gnc_tree_model_owner_new()

GtkTreeModel* gnc_tree_model_owner_new

(

GncOwnerType

owner_type

)

Create a new GtkTreeModel for manipulating gnucash owners.

Parameters

root	The owner group to put at the top level of the tree hierarchy.

Definition at line 224 of file gnc-tree-model-owner.c.

{
    GncTreeModelOwner *model;
    const GList *item;

    ENTER("owner_type %d", owner_type);
    item = gnc_gobject_tracking_get_list(GNC_TREE_MODEL_OWNER_NAME);
    for ( ; item; item = g_list_next(item))
    {
        model = (GncTreeModelOwner *)item->data;
        if (model->owner_type == owner_type)
        {
            g_object_ref(G_OBJECT(model));
            LEAVE("returning existing model %p", model);
            return GTK_TREE_MODEL(model);
        }
    }

    model = g_object_new (GNC_TYPE_TREE_MODEL_OWNER,
                          NULL);

    model->book = gnc_get_current_book();
    model->owner_type = owner_type;
    model->owner_list = gncBusinessGetOwnerList (model->book, gncOwnerTypeToQofIdType(owner_type), TRUE);

    model->event_handler_id = qof_event_register_handler
                             ((QofEventHandler)gnc_tree_model_owner_event_handler, model);

    LEAVE("model %p", model);
    return GTK_TREE_MODEL (model);
}

gnc_tree_model_price_get_commodity()

gnc_commodity* gnc_tree_model_price_get_commodity	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash commodity.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single commodity in the model.

Returns

A pointer to the corresponding commodity.

Definition at line 282 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    if (iter->user_data != ITER_IS_COMMODITY)
        return NULL;
    return (gnc_commodity *)iter->user_data2;
}

gnc_tree_model_price_get_iter_from_commodity()

gboolean gnc_tree_model_price_get_iter_from_commodity	(	GncTreeModelPrice *	model,
		gnc_commodity *	commodity,
		GtkTreeIter *	iter
	)

Convert a commodity pointer into a GtkTreeIter.

Parameters

model	A pointer to the price tree model.
commodity	A pointer to the gnucash commodity.
iter	A pointer to a GtkTreeIter. This iter will be filled in to point where the commodity appears in the price tree.

Returns

TRUE if the returned iter is valid, FALSE otherwise.

Definition at line 1178 of file gnc-tree-model-price.c.

{
    gnc_commodity_namespace *name_space;
    GList *list;
    gint n;

    ENTER("model %p, commodity %p, iter %p", model, commodity, iter);
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail ((commodity != NULL), FALSE);
    g_return_val_if_fail ((iter != NULL), FALSE);

    name_space = gnc_commodity_get_namespace_ds(commodity);
    if (name_space == NULL)
    {
        LEAVE("no namespace");
        return FALSE;
    }

    list = gnc_commodity_namespace_get_commodity_list(name_space);
    if (list == NULL)
    {
        LEAVE("empty list");
        return FALSE;
    }

    n = g_list_index(list, commodity);
    if (n == -1)
    {
        LEAVE("commodity not in list");
        return FALSE;
    }

    iter->stamp = model->stamp;
    iter->user_data  = ITER_IS_COMMODITY;
    iter->user_data2 = commodity;
    iter->user_data3 = GINT_TO_POINTER(n);
    LEAVE("iter %s", iter_to_string(model, iter));
    return TRUE;
}

gnc_tree_model_price_get_iter_from_namespace()

gboolean gnc_tree_model_price_get_iter_from_namespace	(	GncTreeModelPrice *	model,
		gnc_commodity_namespace *	name_space,
		GtkTreeIter *	iter
	)

Convert a commodity namespace pointer into a GtkTreeIter.

Parameters

model	A pointer to the price tree model.
namespace	A pointer to the gnucash commodity namespace.
iter	A pointer to a GtkTreeIter. This iter will be filled in to point where the namespace appears in the price tree.

Returns

TRUE if the returned iter is valid, FALSE otherwise.

Definition at line 1226 of file gnc-tree-model-price.c.

{
    gnc_commodity_table *ct;
    GList *list;
    gint n;

    ENTER("model %p, namespace %p, iter %p", model, name_space, iter);
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail ((name_space != NULL), FALSE);
    g_return_val_if_fail ((iter != NULL), FALSE);

    ct = qof_book_get_data (model->book, GNC_COMMODITY_TABLE);
    list = gnc_commodity_table_get_namespaces_list(ct);
    if (list == NULL)
    {
        LEAVE("namespace list empty");
        return FALSE;
    }

    n = g_list_index(list, name_space);
    if (n == -1)
    {
        LEAVE("namespace not found");
        return FALSE;
    }

    iter->stamp = model->stamp;
    iter->user_data  = ITER_IS_NAMESPACE;
    iter->user_data2 = name_space;
    iter->user_data3 = GINT_TO_POINTER(n);
    LEAVE("iter %s", iter_to_string(model, iter));
    return TRUE;
}

gnc_tree_model_price_get_iter_from_price()

gboolean gnc_tree_model_price_get_iter_from_price	(	GncTreeModelPrice *	model,
		GNCPrice *	price,
		GtkTreeIter *	iter
	)

Convert a price pointer into a GtkTreeIter.

Parameters

model	A pointer to the price tree model.
price	A pointer to the gnucash price.
iter	A pointer to a GtkTreeIter. This iter will be filled in to point where the price appears in the price tree.

Returns

TRUE if the returned iter is valid, FALSE otherwise.

Definition at line 1092 of file gnc-tree-model-price.c.

{
    gnc_commodity *commodity;
    GList *list;
    gint n;

    ENTER("model %p, price %p, iter %p", model, price, iter);
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail ((price != NULL), FALSE);
    g_return_val_if_fail ((iter != NULL), FALSE);

    commodity = gnc_price_get_commodity(price);
    if (commodity == NULL)
    {
        LEAVE("no commodity");
        return FALSE;
    }

    list = gnc_pricedb_get_prices(model->price_db, commodity, NULL);
    if (list == NULL)
    {
        LEAVE("empty list");
        return FALSE;
    }

    n = g_list_index(list, price);
    if (n == -1)
    {
        gnc_price_list_destroy(list);
        LEAVE("not in list");
        return FALSE;
    }

    iter->stamp = model->stamp;
    iter->user_data  = ITER_IS_PRICE;
    iter->user_data2 = price;
    iter->user_data3 = GINT_TO_POINTER(n);
    gnc_price_list_destroy(list);
    LEAVE("iter %s", iter_to_string(model, iter));
    return TRUE;
}

gnc_tree_model_price_get_namespace()

gnc_commodity_namespace* gnc_tree_model_price_get_namespace	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash commodity namespace.

This routine should only be called from a commodity tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the commodity tree model.
iter	A GtkTreeIter corresponding to a single namespace in the model.

Returns

A pointer to the corresponding namespace.

Definition at line 268 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    if (iter->user_data != ITER_IS_NAMESPACE)
        return NULL;
    return (gnc_commodity_namespace *)iter->user_data2;
}

gnc_tree_model_price_get_path_from_price()

GtkTreePath* gnc_tree_model_price_get_path_from_price	(	GncTreeModelPrice *	model,
		GNCPrice *	price
	)

Convert a price pointer into a GtkTreePath.

Parameters

model	A pointer to the price tree model.
price	A pointer to the commodity price.

Returns

A pointer to a GtkTreePath describing the location of this price. This pointer must be freed by the caller when no longer needed. This routine will return NULL if the price does not exist in the tree.

Definition at line 1142 of file gnc-tree-model-price.c.

{
    GtkTreeIter tree_iter;
    GtkTreePath *tree_path;

    ENTER("model %p, price %p", model, price);
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), NULL);
    g_return_val_if_fail (price != NULL, NULL);

    if (!gnc_tree_model_price_get_iter_from_price (model, price, &tree_iter))
    {
        LEAVE("no iter");
        return NULL;
    }

    tree_path = gtk_tree_model_get_path (GTK_TREE_MODEL(model), &tree_iter);
    if (tree_path)
    {
        gchar *path_string = gtk_tree_path_to_string(tree_path);
        LEAVE("path (2) %s", path_string);
        g_free(path_string);
    }
    else
    {
        LEAVE("no path");
    }
    return tree_path;
}

gnc_tree_model_price_get_price()

GNCPrice* gnc_tree_model_price_get_price	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Convert a model/iter pair to a gnucash price.

This routine should only be called from a price tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the price tree model.
iter	A GtkTreeIter corresponding to a single price in the model.

Returns

A pointer to the corresponding price.

Definition at line 296 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), NULL);
    g_return_val_if_fail (iter != NULL, NULL);
    g_return_val_if_fail (iter->user_data != NULL, NULL);
    g_return_val_if_fail (iter->stamp == model->stamp, NULL);

    if (iter->user_data != ITER_IS_PRICE)
        return NULL;
    return (GNCPrice *)iter->user_data2;
}

gnc_tree_model_price_iter_is_commodity()

gboolean gnc_tree_model_price_iter_is_commodity	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Determine whether or not the specified GtkTreeIter points to a commodity.

This routine should only be called from a price tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the price tree model.
iter	A GtkTreeIter corresponding to a single item in the model.

Returns

TRUE if the iter points to a commodity, FALSE otherwise.

Definition at line 244 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail (iter != NULL, FALSE);
    g_return_val_if_fail (iter->user_data != NULL, FALSE);
    g_return_val_if_fail (iter->stamp == model->stamp, FALSE);

    return (iter->user_data == ITER_IS_COMMODITY);
}

gnc_tree_model_price_iter_is_namespace()

gboolean gnc_tree_model_price_iter_is_namespace	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Determine whether or not the specified GtkTreeIter points to a "commodity namespace".

This routine should only be called from a price tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the price tree model.
iter	A GtkTreeIter corresponding to a single item in the model.

Returns

TRUE if the iter points to a commodity namespace, FALSE otherwise.

Definition at line 232 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail (iter != NULL, FALSE);
    g_return_val_if_fail (iter->user_data != NULL, FALSE);
    g_return_val_if_fail (iter->stamp == model->stamp, FALSE);

    return (iter->user_data == ITER_IS_NAMESPACE);
}

gnc_tree_model_price_iter_is_price()

gboolean gnc_tree_model_price_iter_is_price	(	GncTreeModelPrice *	model,
		GtkTreeIter *	iter
	)

Determine whether or not the specified GtkTreeIter points to a price.

This routine should only be called from a price tree view filter function. The model and iter values will be provided as part of the call to the filter.

Parameters

model	A pointer to the price tree model.
iter	A GtkTreeIter corresponding to a single item in the model.

Returns

TRUE if the iter points to a price, FALSE otherwise.

Definition at line 256 of file gnc-tree-model-price.c.

{
    g_return_val_if_fail (GNC_IS_TREE_MODEL_PRICE (model), FALSE);
    g_return_val_if_fail (iter != NULL, FALSE);
    g_return_val_if_fail (iter->user_data != NULL, FALSE);
    g_return_val_if_fail (iter->stamp == model->stamp, FALSE);

    return (iter->user_data == ITER_IS_PRICE);
}

gnc_tree_model_price_new()

GtkTreeModel* gnc_tree_model_price_new	(	QofBook *	book,
		GNCPriceDB *	price_db
	)

Create a new GtkTreeModel for manipulating gnucash commodity prices.

Parameters

book	The book that holds these prices.
price_db	A pointer to the price database for this tree. All namespaces and commodities in the book, and all prices in this tree will be included.

Definition at line 200 of file gnc-tree-model-price.c.

{
    GncTreeModelPrice *model;
    const GList *item;

    ENTER(" ");

    item = gnc_gobject_tracking_get_list(GNC_TREE_MODEL_PRICE_NAME);
    for ( ; item; item = g_list_next(item))
    {
        model = (GncTreeModelPrice *)item->data;
        if (model->price_db == price_db)
        {
            g_object_ref(G_OBJECT(model));
            LEAVE("returning existing model %p", model);
            return GTK_TREE_MODEL(model);
        }
    }

    model = g_object_new (GNC_TYPE_TREE_MODEL_PRICE, NULL);

    model->book = book;
    model->price_db = price_db;

    model->event_handler_id =
        qof_event_register_handler (gnc_tree_model_price_event_handler, model);

    LEAVE("returning new model %p", model);
    return GTK_TREE_MODEL (model);
}

gnc_tree_view_account_add_custom_column()

GtkTreeViewColumn* gnc_tree_view_account_add_custom_column	(	GncTreeViewAccount *	view,
		const gchar *	column_title,
		GncTreeViewAccountColumnSource	source_cb,
		GncTreeViewAccountColumnTextEdited	edited_cb
	)

Add a new custom column to the set of columns in an account tree view.

This column will be visible as soon as it is added and will query the provided functions to determine what data to display. The TreeView will own the resulting TreeViewColumn, but caller may set any additional properties they wish.

Parameters

view	A pointer to an account tree view.
column_title	The title for this new column.
source_cb	A callback function that is expected to provide the data to be displayed.
edited_cb	A callback function that will be called if the user edits the displayed data.

Definition at line 1950 of file gnc-tree-view-account.c.

{
    GtkCellRenderer *renderer;

    g_return_val_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(account_view), NULL);

    renderer = gtk_cell_renderer_text_new();

    return gnc_tree_view_account_add_custom_column_renderer(
        account_view, column_title, col_source_cb, col_edited_cb, renderer);
}

gnc_tree_view_account_add_property_column()

GtkTreeViewColumn* gnc_tree_view_account_add_property_column	(	GncTreeViewAccount *	view,
		const gchar *	column_title,
		const gchar *	propname
	)

Add a new column to the set of columns in an account tree view.

This column will be visible as soon as it is added and will display the contents of the specified account property

Parameters

view	A pointer to an account tree view.
column_title	The title for this new column.
propname	The g_object_property name of the desired value. This must be a string property.

Definition at line 1851 of file gnc-tree-view-account.c.

{
    GtkCellRenderer *renderer;
    GtkTreeViewColumn *column;

    g_return_val_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view), NULL);
    g_return_val_if_fail (propname != NULL, NULL);

    column = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), column_title,
                                           propname, NULL, "Sample text",
                                           -1, -1, NULL);

    /* This new kvp column has only had one renderer added to it so
     * far.  Find that renderer. */
    renderer = gnc_tree_view_column_get_renderer(column);
    g_object_set (G_OBJECT (renderer), "xalign", 1.0, NULL);

    // add a pointer to the view to make it easier to access in data_func
    g_object_set_data(G_OBJECT(column), "tree-view", (gpointer)view);

    gtk_tree_view_column_set_cell_data_func (column, renderer,
            account_cell_property_data_func,
            g_strdup(propname), g_free);
    return column;
}

gnc_tree_view_account_clear_model_cache()

void gnc_tree_view_account_clear_model_cache

(

GncTreeViewAccount *

view

)

This function clears the tree model account cache so the values will be updated/refreshed.

Parameters

view	A pointer to an account tree view.

Definition at line 1173 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model, *s_model;

    s_model = gtk_tree_view_get_model (GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT(s_model));
    model = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER(f_model));

    gnc_tree_model_account_clear_cache (GNC_TREE_MODEL_ACCOUNT(model));
}

gnc_tree_view_account_count_children()

gint gnc_tree_view_account_count_children	(	GncTreeViewAccount *	view,
		Account *	account
	)

This function determines if an account in the account tree view has any visible children.

Parameters

view	A pointer to an account tree view.
account	A pointer to the account to check.

Returns

The number of children of the specified account. Returns 0 on error.

Definition at line 1144 of file gnc-tree-view-account.c.

{
    GtkTreeModel *s_model;
    GtkTreeIter s_iter;
    gint num_children;

    ENTER("view %p, account %p (%s)", view, account, xaccAccountGetName(account));

    if (account == NULL)
    {
        LEAVE("no account");
        return 0;
    }

    if (!gnc_tree_view_account_get_iter_from_account (view, account, &s_iter))
    {
        LEAVE("view_get_iter_from_account failed");
        return 0;
    }

    /* Any children? */
    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    num_children = gtk_tree_model_iter_n_children(s_model, &s_iter);
    LEAVE("%d children", num_children);
    return num_children;
}

gnc_tree_view_account_expand_to_account()

void gnc_tree_view_account_expand_to_account	(	GncTreeViewAccount *	view,
		Account *	account
	)

This function forces the account tree expand whatever levels are necessary to make the specified account visible.

Parameters

view	A pointer to an account tree view.
account	A pointer to the account to show.

Definition at line 1717 of file gnc-tree-view-account.c.

{
    GtkTreePath *path;

    g_return_if_fail(view != NULL);
    g_return_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(view));
    ENTER("view %p, account %p", view, account);

    path = gnc_tree_view_account_get_path_from_account(view, account);
    if (path)
    {
        gtk_tree_view_expand_to_path(GTK_TREE_VIEW(view), path);
        gtk_tree_path_free(path);
    }
    LEAVE(" ");
}

gnc_tree_view_account_get_account_from_iter()

Account* gnc_tree_view_account_get_account_from_iter	(	GtkTreeModel *	model,
		GtkTreeIter *	iter
	)

This function returns the account associated with the specified iter.

This function is useful in selection callbacks on an account tree widget.

Parameters

model	The model provided to the callback function.
iter	The iter provided to the callback function.

Returns

The account associated with this iter.

Definition at line 1356 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model;
    GtkTreeIter iter, f_iter;
    Account *account;

    g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT(s_model), NULL);
    g_return_val_if_fail (s_iter != NULL, NULL);

    ENTER("model %p, iter %p", s_model, s_iter);

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT(s_model),
            &f_iter,
            s_iter);
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (
        GTK_TREE_MODEL_FILTER(f_model), &iter, &f_iter);
    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    account = gnc_tree_model_account_get_account (
                  GNC_TREE_MODEL_ACCOUNT(model), &iter);
    LEAVE("account %p (%s)", account, xaccAccountGetName (account));
    return account;
}

gnc_tree_view_account_get_account_from_path()

Account* gnc_tree_view_account_get_account_from_path	(	GncTreeViewAccount *	view,
		GtkTreePath *	path
	)

This function returns the account associated with the specified path.

This function is useful in selection callbacks on an account tree widget.

Parameters

view	A pointer to an account tree view.
path	A path specifying a node in the account tree.

Returns

The account associated with this path.

Definition at line 1310 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path;
    GtkTreeIter iter;
    Account *account;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view), NULL);
    g_return_val_if_fail (s_path != NULL, NULL);

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_path = gtk_tree_model_sort_convert_path_to_child_path (
                 GTK_TREE_MODEL_SORT (s_model), s_path);
    if (!f_path)
    {
        LEAVE("no filter path");
        return NULL;
    }

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    path = gtk_tree_model_filter_convert_path_to_child_path (
               GTK_TREE_MODEL_FILTER (f_model), f_path);
    gtk_tree_path_free(f_path);
    if (!path)
    {
        LEAVE("no path");
        return NULL;
    }

    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    if (!gtk_tree_model_get_iter (model, &iter, path))
    {
        LEAVE("no iter");
        return NULL;
    }

    account = iter.user_data;
    gtk_tree_path_free(path);
    LEAVE("account %p (%s)", account, xaccAccountGetName (account));
    return account;
}

gnc_tree_view_account_get_cursor_account()

Account* gnc_tree_view_account_get_cursor_account

(

GncTreeViewAccount *

view

)

This function returns the account in the account tree view at the current location of the cursor.

(The outline frame. Usually is selected and therefore filled in, but not always.)

Parameters

view	A pointer to an account tree view.

Returns

The account at the cursor.

Definition at line 1740 of file gnc-tree-view-account.c.

{
    GtkTreePath *s_path;
    Account *account;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view), NULL);

    gtk_tree_view_get_cursor (GTK_TREE_VIEW(view), &s_path, NULL);
    if (!s_path)
    {
        LEAVE("no account");
        return NULL;
    }

    account = gnc_tree_view_account_get_account_from_path (view, s_path);
    gtk_tree_path_free(s_path);
    LEAVE("account %p (%s)", account, xaccAccountGetName (account));
    return account;
}

gnc_tree_view_account_get_selected_account()

Account* gnc_tree_view_account_get_selected_account

(

GncTreeViewAccount *

view

)

This function returns the account associated with the selected item in the account tree view.

Note

It only makes sense to call this function when the account tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an account tree view.

Returns

The selected account, or NULL if no account was selected.

Definition at line 1387 of file gnc-tree-view-account.c.

{
    GtkTreeSelection *selection;
    GtkTreeModel *f_model, *s_model;
    GtkTreeIter iter, f_iter, s_iter;
    Account *account;
    GtkSelectionMode mode;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view), NULL);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    mode = gtk_tree_selection_get_mode(selection);
    if ((mode != GTK_SELECTION_SINGLE) && (mode != GTK_SELECTION_BROWSE))
    {
        return NULL;
    }
    if (!gtk_tree_selection_get_selected (selection, &s_model, &s_iter))
    {
        LEAVE("no account, get_selected failed");
        return FALSE;
    }

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (s_model),
            &f_iter, &s_iter);

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (
        GTK_TREE_MODEL_FILTER (f_model), &iter, &f_iter);

    account = iter.user_data;
    LEAVE("account %p (%s)", account, xaccAccountGetName (account));
    return account;
}

gnc_tree_view_account_get_selected_accounts()

GList* gnc_tree_view_account_get_selected_accounts

(

GncTreeViewAccount *

view

)

This function returns a list of the accounts associated with the selected items in the account tree view.

Note

It only makes sense to call this function when the account tree is set to select multiple items. There is a different function to use when the tree supports single selection.

Parameters

view	A pointer to an account tree view.

Returns

A list of accounts, or NULL if no account was selected.

Definition at line 1545 of file gnc-tree-view-account.c.

{
    GtkTreeSelection *selection;
    GncTreeViewSelectionInfo info;

    g_return_val_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view), NULL);

    info.return_list = NULL;
    info.view = view;
    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    gtk_tree_selection_selected_foreach(selection, get_selected_accounts_helper, &info);
    info.return_list = g_list_reverse (info.return_list);
    return info.return_list;
}

gnc_tree_view_account_get_view_info()

void gnc_tree_view_account_get_view_info	(	GncTreeViewAccount *	account_view,
		AccountViewInfo *	avi
	)

Given pointers to an account tree and old style filter block, this function will copy the current configuration of the account tree widget into the data block.

This may be used in conjunction with the gnc_tree_view_account_set_view_info function to modify the filters on an existing account tree.

Parameters

account_view	A pointer to an account tree view.
avi	A pointer to an old style filter block to fill in.

Definition at line 1193 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(view));
    g_return_if_fail(avi != NULL);

    *avi = view->avi;
}

gnc_tree_view_account_new()

GtkTreeView* gnc_tree_view_account_new

(

gboolean

show_root

)

Create a new account tree view.

This view may or may not show a pseudo top-level account. The gnucash engine does not have a single top level account (it has a list of top level accounts), but this code provides one so that it can be used with all parts of the gnucash gui. The first level of accounts in the created tree will be the top level of accounts in the current book.

Parameters

show_root

Show the pseudo top-level account in this view.

Returns

A pointer to a new account tree view.

Definition at line 1049 of file gnc-tree-view-account.c.

{
    Account *root;

    root = gnc_book_get_root_account (gnc_get_current_book ());
    return gnc_tree_view_account_new_with_root (root, show_root);
}

gnc_tree_view_account_new_with_root()

GtkTreeView* gnc_tree_view_account_new_with_root	(	Account *	root,
		gboolean	show_root
	)

Create a new account tree view.

This view may or may not show a pseudo top-level account. The gnucash engine does not have a single top level account (it has a list of top level accounts), but this code provides one so that it can be used with all parts of the gnucash gui.

Parameters

root	The account to use as the first level of the created tree.
show_root	Show the pseudo top-level account in this view.

Returns

A pointer to a new account tree view.

Definition at line 744 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *virtual_root_path = NULL;
    const gchar *sample_type, *sample_commodity;
    GtkTreeViewColumn *tax_info_column, *acc_color_column, *acc_balance_limit_column;
    GtkCellRenderer *renderer;
    GList *col_list = NULL, *node = NULL;

    ENTER(" ");
    /* Create our view */
    GncTreeViewAccount *view = g_object_new (GNC_TYPE_TREE_VIEW_ACCOUNT,
                                             "has-tooltip", true,
                                             "name", "gnc-id-account-tree", NULL);

    /* Get the show_account_color value from gsettings */
    view->show_account_color = gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL, GNC_PREF_ACCOUNT_COLOR);

    /* Create/get a pointer to the existing model for this set of books. */
    model = gnc_tree_model_account_new (root);

    /* Set up the view private filter layer on the common model. */
    if (!show_root)
        virtual_root_path = gtk_tree_path_new_first ();
    f_model = gtk_tree_model_filter_new (model, virtual_root_path);
    /* A GncTreeModelAccount is based on a GncTreeModel, which is a
     * GObject that provides a GtkTreeModel interface. */
    g_object_unref(G_OBJECT(model));
    if (virtual_root_path)
        gtk_tree_path_free(virtual_root_path);

    /* Set up the view private sort layer on the common model. */
    s_model = gtk_tree_model_sort_new_with_model(f_model);
    g_object_unref(G_OBJECT(f_model));
    gtk_tree_view_set_model (GTK_TREE_VIEW (view), s_model);
    g_object_unref(G_OBJECT(s_model));

    /* Set default visibilities */
    gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(view), FALSE);

    sample_type = xaccAccountGetTypeStr(ACCT_TYPE_CREDIT);
    sample_commodity = gnc_commodity_get_fullname(gnc_default_currency());

    view->name_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Account Name"), "name",
                                        GNC_ICON_ACCOUNT, "Expenses:Entertainment",
                                        GNC_TREE_MODEL_ACCOUNT_COL_NAME,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);

    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Type"), "type", NULL, sample_type,
                                  GNC_TREE_MODEL_ACCOUNT_COL_TYPE,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);

    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Commodity"), "commodity", NULL,
                                  sample_commodity,
                                  GNC_TREE_MODEL_ACCOUNT_COL_COMMODITY,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    view->code_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Account Code"), "account-code", NULL,
                                        "1-123-1234",
                                        GNC_TREE_MODEL_ACCOUNT_COL_CODE,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_code);
    view->desc_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Description"), "description", NULL,
                                        "Sample account description.",
                                        GNC_TREE_MODEL_ACCOUNT_COL_DESCRIPTION,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Last Num"), "lastnum", "12345",
                                     GNC_TREE_MODEL_ACCOUNT_COL_LASTNUM,
                                     GNC_TREE_VIEW_COLUMN_COLOR_NONE,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_string);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Present"), "present",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_PRESENT,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_PRESENT,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_present_value);
    view->present_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Present (Report)"), "present_report",
                                           SAMPLE_ACCOUNT_VALUE,
                                           GNC_TREE_MODEL_ACCOUNT_COL_PRESENT_REPORT,
                                           GNC_TREE_MODEL_ACCOUNT_COL_COLOR_PRESENT,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_present_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Balance"), "balance",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_BALANCE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_BALANCE,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_balance_value);
    view->balance_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Balance (Report)"), "balance_report",
                                           SAMPLE_ACCOUNT_VALUE,
                                           GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_REPORT,
                                           GNC_TREE_MODEL_ACCOUNT_COL_COLOR_BALANCE,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_balance_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Balance (Period)"), "balance-period",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_PERIOD,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_BALANCE_PERIOD,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_balance_period_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Cleared"), "cleared",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_CLEARED,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_CLEARED,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_cleared_value);
    view->cleared_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Cleared (Report)"), "cleared_report",
                                           SAMPLE_ACCOUNT_VALUE,
                                           GNC_TREE_MODEL_ACCOUNT_COL_CLEARED_REPORT,
                                           GNC_TREE_MODEL_ACCOUNT_COL_COLOR_CLEARED,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_cleared_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Reconciled"), "reconciled",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_RECONCILED,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_reconciled_value);
    view->reconciled_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Reconciled (Report)"), "reconciled_report",
                                           SAMPLE_ACCOUNT_VALUE,
                                           GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED_REPORT,
                                           GNC_TREE_MODEL_ACCOUNT_COL_COLOR_RECONCILED,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_reconciled_value);

    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Last Reconcile Date"), "last-recon-date", NULL,
                                  "Last Reconcile Date",
                                  GNC_TREE_MODEL_ACCOUNT_COL_RECONCILED_DATE,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_last_reconcile_date);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Future Minimum"), "future_min",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_FUTURE_MIN,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_FUTURE_MIN,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_future_min_value);
    view->future_min_report_column
        =  gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Future Minimum (Report)"), "future_min_report",
                                            SAMPLE_ACCOUNT_VALUE,
                                            GNC_TREE_MODEL_ACCOUNT_COL_FUTURE_MIN_REPORT,
                                            GNC_TREE_MODEL_ACCOUNT_COL_COLOR_FUTURE_MIN,
                                            GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                            sort_by_future_min_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Total"), "total",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_TOTAL,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_TOTAL,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_total_value);
    view->total_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Total (Report)"), "total_report",
                                           SAMPLE_ACCOUNT_VALUE,
                                           GNC_TREE_MODEL_ACCOUNT_COL_TOTAL_REPORT,
                                           GNC_TREE_MODEL_ACCOUNT_COL_COLOR_TOTAL,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_total_value);

    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Total (Period)"), "total-period",
                                     SAMPLE_ACCOUNT_VALUE,
                                     GNC_TREE_MODEL_ACCOUNT_COL_TOTAL_PERIOD,
                                     GNC_TREE_MODEL_ACCOUNT_COL_COLOR_TOTAL_PERIOD,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_total_period_value);

    /* Translators: The C is the column title and stands for Color, this should be one character */
    acc_color_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), C_("Column header for 'Color'", "C"), "account-color", NULL,
                                        "xx",
                                        GNC_TREE_VIEW_COLUMN_DATA_NONE,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        NULL);

    /* Add the full title to the object for menu creation */
    g_object_set_data_full(G_OBJECT(acc_color_column), REAL_TITLE,
                           g_strdup(_("Account Color")), g_free);

    /* Also add the full title to the column header as a tooltip */
    gtk_widget_set_tooltip_text (gtk_tree_view_column_get_button (acc_color_column), _("Account Color"));

    acc_balance_limit_column
        = gnc_tree_view_add_pix_column (GNC_TREE_VIEW(view),
                                        C_("Column header for 'Balance Limit'", "L"),
                                        "account-balance-limit",
                                        "xx",
                                        GNC_TREE_MODEL_ACCOUNT_COL_BALANCE_LIMIT,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        NULL);

    /* Add the full title to the object for menu creation */
    g_object_set_data_full(G_OBJECT(acc_balance_limit_column), REAL_TITLE,
                           g_strdup(_("Balance Limit")), g_free);

    /* Also add the full title to the column header as a tooltip */
    gtk_widget_set_tooltip_text (gtk_tree_view_column_get_button (acc_balance_limit_column), _("Balance Limit"));

    view->notes_column
        = gnc_tree_view_add_text_view_column(GNC_TREE_VIEW(view), _("Notes"), "notes", NULL,
                                        "Sample account notes.",
                                        GNC_TREE_MODEL_ACCOUNT_COL_NOTES,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);

    tax_info_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Tax Info"), "tax-info", NULL,
                                        "Sample tax info.",
                                        GNC_TREE_MODEL_ACCOUNT_COL_TAX_INFO,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);

    renderer = gnc_tree_view_column_get_renderer(tax_info_column);
    gtk_tree_view_column_set_cell_data_func(tax_info_column,
                                            renderer,
                                            tax_info_data_func,
                                            GTK_TREE_VIEW(view),
                                            NULL);

    gnc_tree_view_add_toggle_column (GNC_TREE_VIEW(view), _("Hidden"),
                                     C_("Column header for 'Hidden'", "H"),
                                     "hidden",
                                     GNC_TREE_MODEL_ACCOUNT_COL_HIDDEN,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_hidden,
                                     gnc_tree_view_account_hidden_toggled);

    gnc_tree_view_add_toggle_column(GNC_TREE_VIEW(view), _("Placeholder"),
                    C_("Column header for 'Placeholder'", "P"),
                                    "placeholder",
                                    GNC_TREE_MODEL_ACCOUNT_COL_PLACEHOLDER,
                                    GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                    sort_by_placeholder,
                                    gnc_tree_view_account_placeholder_toggled);

    gnc_tree_view_add_toggle_column(GNC_TREE_VIEW(view), _("Opening Balance"),
                    C_("Column header for 'Opening Balance'", "O"),
                                    "opening-balance",
                                    GNC_TREE_MODEL_ACCOUNT_COL_OPENING_BALANCE,
                                    GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                    sort_by_opening_balance,
                                    NULL);

    /* Add function to each column that optionally sets a background color for accounts */
    col_list = gtk_tree_view_get_columns(GTK_TREE_VIEW(view));
    for (node = col_list; node; node = node->next)
    {
        renderer = gnc_tree_view_column_get_renderer(node->data);
        gtk_tree_view_column_set_cell_data_func(node->data,
                renderer,
                acc_color_data_func,
                GTK_TREE_VIEW(view),
                NULL);
    }
    g_list_free (col_list);

    /* Update column titles to use the currency name. */
    gtva_update_column_names(view);

    /* By default only the first column is visible. */
    gnc_tree_view_configure_columns(GNC_TREE_VIEW(view));
    gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (f_model),
                                            gnc_tree_view_account_filter_helper,
                                            view,
                                            NULL);

    /* Default the sorting to account name */
    gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(s_model),
                                         GNC_TREE_MODEL_ACCOUNT_COL_NAME,
                                         GTK_SORT_ASCENDING);

    /* Set account find-as-you-type search function */
    gtk_tree_view_set_search_equal_func (GTK_TREE_VIEW(view), gnc_tree_view_search_compare, NULL, NULL);

    g_signal_connect (G_OBJECT(view), "query-tooltip",
                      G_CALLBACK(gnc_tree_view_tooltip_cb), NULL);

    gtk_widget_show(GTK_WIDGET(view));
    LEAVE("%p", view);
    return GTK_TREE_VIEW(view);
}

gnc_tree_view_account_refilter()

void gnc_tree_view_account_refilter

(

GncTreeViewAccount *

view

)

This function forces the account tree filter to be evaluated.

It may be necessary to call this function if the initial state of the view is incorrect. This appears to only be necessary if the filter affects one of the top level accounts in gnucash.

Note

This calls a function in gtk that is annotated in the sources as being slow. You have been warned.

Parameters

view	A pointer to an account tree view.

Definition at line 1276 of file gnc-tree-view-account.c.

{
    GtkTreeModel *f_model, *s_model;

    g_return_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(view));

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_refilter (GTK_TREE_MODEL_FILTER (f_model));
}

gnc_tree_view_account_select_subaccounts()

void gnc_tree_view_account_select_subaccounts	(	GncTreeViewAccount *	view,
		Account *	account
	)

This function selects all sub-accounts of an account in the account tree view.

All other accounts will be unselected.

Note

It only makes sense to call this function when the account tree is set to select multiple items. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an account tree view.
account	A pointer to the account whose children should be selected.

Definition at line 1645 of file gnc-tree-view-account.c.

{
    GtkTreeModel *s_model;
    GtkTreeSelection *selection;
    GtkTreePath *sp_account, *sp_start, *sp_end;
    GtkTreeIter si_account, si_start, si_end;
    gboolean have_start, have_end = FALSE;
    gint num_children;

    ENTER("view %p, account %p (%s)", view, account, xaccAccountGetName(account));

    g_return_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view));

    if (account == NULL)
    {
        LEAVE("no account");
        return;
    }

    if (!gnc_tree_view_account_get_iter_from_account (view, account, &si_account))
    {
        LEAVE("view_get_iter_from_account failed");
        return;
    }

    /* Any children? */
    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    num_children = gtk_tree_model_iter_n_children(s_model, &si_account);
    if (num_children == 0)
    {
        LEAVE("no children");
        return;
    }

    /* Expand the tree.  Required for selection to work */
    sp_account = gtk_tree_model_get_path (s_model, &si_account);
    gtk_tree_view_expand_row (GTK_TREE_VIEW(view), sp_account, TRUE);

    /* compute start/end paths */
    have_start = gtk_tree_model_iter_nth_child(s_model, &si_start, &si_account, 0);
    si_end = si_account;
    while (num_children)
    {
        GtkTreeIter tmp_iter = si_end;
        have_end = gtk_tree_model_iter_nth_child(s_model, &si_end, &tmp_iter,
                   num_children - 1);
        if (have_end)
            num_children = gtk_tree_model_iter_n_children(s_model, &si_end);
        else
            num_children = 0;
    }

    if (have_start && have_end)
    {
        sp_start = gtk_tree_model_get_path (s_model, &si_start);
        sp_end = gtk_tree_model_get_path (s_model, &si_end);

        /* select everything between */
        selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
        gtk_tree_selection_select_range (selection, sp_start, sp_end);

        /* clean up */
        gtk_tree_path_free(sp_start);
        gtk_tree_path_free(sp_end);
    }
    gtk_tree_path_free(sp_account);
    LEAVE(" ");
    return;
}

gnc_tree_view_account_set_filter()

void gnc_tree_view_account_set_filter	(	GncTreeViewAccount *	account_view,
		gnc_tree_view_account_filter_func	func,
		gpointer	data,
		GSourceFunc	destroy
	)

This function attaches a filter function to the given account tree.

This function will be called for each account that the view thinks should possibly show. The filter may perform any actions necessary on the account to decide whether it should be shown or not. (I.E. Check type, placeholder status, etc.) If the filter returns TRUE then the account will be displayed.

Parameters

account_view	A pointer to an account tree view.
func	A filtration function that is called on individual elements in the tree. If this function returns TRUE, the account will be displayed.
data	A data block passed into each instance of the function.
destroy	A function to destroy the data block. This function will be called when the filter is destroyed. may be NULL.

Definition at line 1250 of file gnc-tree-view-account.c.

{
    ENTER("view %p, filter func %p, data %p, destroy %p",
          view, func, data, destroy);

    g_return_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(view));

    if (view->filter_destroy)
    {
        view->filter_destroy(view->filter_data);
    }
    view->filter_destroy = destroy;
    view->filter_data = data;
    view->filter_fn = func;

    gnc_tree_view_account_refilter(view);
    LEAVE(" ");
}

gnc_tree_view_account_set_selected_account()

void gnc_tree_view_account_set_selected_account	(	GncTreeViewAccount *	view,
		Account *	account
	)

This function selects an account in the account tree view.

All other accounts will be unselected. In addition, this function collapses the entire tree and then expands only the path to the selected account, making the item easy to find. In general, this routine only need be called when initially putting up a window containing an account tree view widget.

Note

It only makes sense to call this function when the account tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an account tree view.
account	A pointer to the account to select.

Definition at line 1427 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path, *s_path, *parent_path;
    GtkTreeSelection *selection;

    ENTER("view %p, account %p (%s)", view,
          account, xaccAccountGetName (account));
    g_return_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view));

    /* Clear any existing selection. */
    selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
    gtk_tree_selection_unselect_all (selection);

    if (account == NULL)
        return;

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));

    path = gnc_tree_model_account_get_path_from_account (
               GNC_TREE_MODEL_ACCOUNT(model), account);
    if (path == NULL)
    {
        LEAVE("no path");
        return;
    }
    debug_path(DEBUG, path);

    f_path = gtk_tree_model_filter_convert_child_path_to_path (
                 GTK_TREE_MODEL_FILTER (f_model), path);
    gtk_tree_path_free(path);
    if (f_path == NULL)
    {
        LEAVE("no filter path");
        return;
    }
    debug_path(DEBUG, f_path);

    s_path = gtk_tree_model_sort_convert_child_path_to_path (GTK_TREE_MODEL_SORT (s_model),
             f_path);
    gtk_tree_path_free(f_path);
    if (s_path == NULL)
    {
        LEAVE("no sort path");
        return;
    }

    /* gtk_tree_view requires that a row be visible before it can be selected */
    parent_path = gtk_tree_path_copy (s_path);
    if (gtk_tree_path_up (parent_path))
    {
        /* This function is misnamed.  It expands the actual item
         * specified, not the path to the item specified. I.E. It expands
         * one level too many, thus the get of the parent. */
        gtk_tree_view_expand_to_path(GTK_TREE_VIEW(view), parent_path);
    }
    gtk_tree_path_free(parent_path);

    gtk_tree_selection_select_path (selection, s_path);

    /* give gtk+ a chance to resize the tree view first by handling pending
     * configure events */
    while (gtk_events_pending ())
        gtk_main_iteration ();
    gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW(view), s_path, NULL, FALSE, 0.0, 0.0);
    debug_path(LEAVE, s_path);
    gtk_tree_path_free(s_path);
}

gnc_tree_view_account_set_selected_accounts()

void gnc_tree_view_account_set_selected_accounts	(	GncTreeViewAccount *	view,
		GList *	account_list,
		gboolean	show_last
	)

This function selects a set of accounts in the account tree view.

All other accounts will be unselected. In addition, this function collapses the entire tree and then expands only the path to the selected accounts, making them easy to find. In general, this routine only need be called when initially putting up a window containing an account tree view widget.

Note

It only makes sense to call this function when the account tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

It is the responsibility of the caller to free the returned list.

Parameters

view	A pointer to an account tree view.
account_list	A list of accounts to select.
show_last	Force the window to scroll to the last account selected.

Definition at line 1565 of file gnc-tree-view-account.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path, *s_path, *parent_path;
    GtkTreeSelection *selection;
    GList *element;
    Account *account;

    g_return_if_fail (GNC_IS_TREE_VIEW_ACCOUNT (view));

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));

    /* Clear any existing selection. */
    selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
    gtk_tree_selection_unselect_all (selection);
    gtk_tree_view_collapse_all (GTK_TREE_VIEW(view));

    /* Now go select what the user requested. */
    for (element = account_list; element; )
    {
        account = element->data;
        element = g_list_next(element);

        if (account == NULL)
        {
            /*
             * Oops.  Someone must have deleted this account and not cleaned
             * up all references to it.
             */
            continue;
        }

        path = gnc_tree_model_account_get_path_from_account (GNC_TREE_MODEL_ACCOUNT(model), account);
        if (path == NULL)
        {
            /*
             * Oops.  Someone must have deleted this account and not cleaned
             * up all references to it.
             */
            continue;
        }

        f_path = gtk_tree_model_filter_convert_child_path_to_path (GTK_TREE_MODEL_FILTER (f_model),
                 path);
        gtk_tree_path_free(path);
        if (f_path == NULL)
            continue;

        s_path = gtk_tree_model_sort_convert_child_path_to_path (GTK_TREE_MODEL_SORT (s_model),
                 f_path);
        gtk_tree_path_free(f_path);
        if (s_path == NULL)
            continue;

        /* gtk_tree_view requires that a row be visible before it can be selected */
        parent_path = gtk_tree_path_copy (s_path);
        if (gtk_tree_path_up (parent_path))
        {
            /* This function is misnamed.  It expands the actual item
             * specified, not the path to the item specified. I.E. It
             * expands one level too many, thus the get of the parent. */
            gtk_tree_view_expand_to_path(GTK_TREE_VIEW(view), parent_path);
        }
        gtk_tree_path_free(parent_path);

        gtk_tree_selection_select_path (selection, s_path);
        if (show_last && (element == NULL))
            gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW(view), s_path, NULL, FALSE, 0.0, 0.0);
        gtk_tree_path_free(s_path);
    }
}

gnc_tree_view_account_set_view_info()

void gnc_tree_view_account_set_view_info	(	GncTreeViewAccount *	account_view,
		AccountViewInfo *	avi
	)

Given pointers to an account tree and old style filter block, this function will applies the settings specified to the current configuration of the account tree widget.

This may be used in conjunction with the gnc_tree_view_account_get_view_info function to modify the filters on an existing account tree.

Parameters

account_view	A pointer to an account tree view.
avi	A pointer to an old style filter block to apply to the view.

Definition at line 1207 of file gnc-tree-view-account.c.

{
    ENTER("%p", view);
    g_return_if_fail(GNC_IS_TREE_VIEW_ACCOUNT(view));
    g_return_if_fail(avi != NULL);

    view->avi = *avi;

    gnc_tree_view_account_set_filter(
        view, gnc_tree_view_account_filter_by_view_info,
        &view->avi, NULL);

    LEAVE(" ");
}

gnc_tree_view_commodity_configure_columns()

void gnc_tree_view_commodity_configure_columns	(	GncTreeViewCommodity *	view,
		GSList *	column_names
	)

Configure (by name) the set of visible columns in an commodity tree view.

By default, only the commodity name column is show. The available list of columns can be found in the file gnc-tree-view-commodity.c

Parameters

view	A pointer to an commodity tree view.
column_names	A list of column names to make visible.

gnc_tree_view_commodity_get_cursor_commodity()

gnc_commodity* gnc_tree_view_commodity_get_cursor_commodity

(

GncTreeViewCommodity *

view

)

This function returns the commodity in the commodity tree view at the current location of the cursor.

(The outline frame. Usually is selected and therefore filled in, but not always.)

Parameters

view	A pointer to an commodity tree view.

Returns

The commodity at the cursor.

gnc_tree_view_commodity_get_selected_commodity()

gnc_commodity* gnc_tree_view_commodity_get_selected_commodity

(

GncTreeViewCommodity *

view

)

This function returns the commodity associated with the selected item in the commodity tree view.

Note

It only makes sense to call this function when the commodity tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an commodity tree view.

Returns

The selected commodity, or NULL if no commodity was selected.

Definition at line 614 of file gnc-tree-view-commodity.c.

{
    GtkTreeSelection *selection;
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreeIter iter, f_iter, s_iter;
    gnc_commodity *commodity;

    g_return_val_if_fail (GNC_IS_TREE_VIEW_COMMODITY (view), NULL);

    ENTER("view %p", view);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    if (!gtk_tree_selection_get_selected (selection, &s_model, &s_iter))
    {
        LEAVE("no commodity, get_selected failed");
        return FALSE;
    }

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (s_model),
            &f_iter, &s_iter);

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (f_model),
            &iter, &f_iter);

    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    commodity = gnc_tree_model_commodity_get_commodity (GNC_TREE_MODEL_COMMODITY(model),
                &iter);
    LEAVE("commodity %p (%s)", commodity,
          commodity ? gnc_commodity_get_mnemonic(commodity) : "");
    return commodity;
}

gnc_tree_view_commodity_new()

GtkTreeView* gnc_tree_view_commodity_new	(	QofBook *	book,
		const gchar *	first_property_name,
			...
	)

Create a new commodity tree view.

This view may or may not show a pseudo top-level commodity. The gnucash engine does not have a single top level commodity (it has a list of top level commodities), but this code provides one so that it can be used with all parts of the gnucash gui.

Parameters

book	The book containing the commodities to show.
first_property_name	Pairs of property name/value settings for the newly created object. Terminate the properties with a single NULL argument.

Returns

A pointer to a new commodity tree view.

Definition at line 311 of file gnc-tree-view-commodity.c.

{
    GncTreeView *view;
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreeViewColumn *col;
    gnc_commodity_table *ct;
    va_list var_args;

    ENTER(" ");
    /* Create/get a pointer to the existing model for this set of books. */
    ct = gnc_commodity_table_get_table (book);
    model = gnc_tree_model_commodity_new (book, ct);

    /* Set up the view private filter on the common model. */
    f_model = gtk_tree_model_filter_new (model, NULL);
    g_object_unref(G_OBJECT(model));
    s_model = gtk_tree_model_sort_new_with_model (f_model);
    g_object_unref(G_OBJECT(f_model));

    /* Create our view */
    view = g_object_new (GNC_TYPE_TREE_VIEW_COMMODITY,
                         "name", "gnc-id-commodity-tree", NULL);
    gtk_tree_view_set_model (GTK_TREE_VIEW (view), s_model);
    g_object_unref(G_OBJECT(s_model));

    DEBUG("model ref count is %d",   G_OBJECT(model)->ref_count);
    DEBUG("f_model ref count is %d", G_OBJECT(f_model)->ref_count);
    DEBUG("s_model ref count is %d", G_OBJECT(s_model)->ref_count);

    /* Set default visibilities */
    gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(view), FALSE);

    gnc_tree_view_add_text_column (
              view, _("Namespace"), "namespace", NULL, "NASDAQ",
              GNC_TREE_MODEL_COMMODITY_COL_NAMESPACE,
              GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
              sort_by_commodity_string);
    col = gnc_tree_view_add_text_column (
              view, _("Symbol"), "symbol", NULL, "ACMEACME",
              GNC_TREE_MODEL_COMMODITY_COL_MNEMONIC,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_text_column (
              view, _("Name"), "name", NULL, "Acme Corporation, Inc.",
              GNC_TREE_MODEL_COMMODITY_COL_FULLNAME,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    gnc_tree_view_add_text_column (
              view, _("Print Name"), "printname", NULL,
              "ACMEACME (Acme Corporation, Inc.)",
              GNC_TREE_MODEL_COMMODITY_COL_PRINTNAME,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    col = gnc_tree_view_add_text_column (
              view, _("Display symbol"), "user_symbol", NULL, "ACME",
              GNC_TREE_MODEL_COMMODITY_COL_USER_SYMBOL,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    gnc_tree_view_add_text_column (
              view, _("Unique Name"), "uniquename", NULL,
              "NASDAQ::ACMEACME", GNC_TREE_MODEL_COMMODITY_COL_UNIQUE_NAME,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    col = gnc_tree_view_add_text_column (
              /* Translators: Again replace CUSIP by the name of your
                 National Securities Identifying Number. */
              view, _("ISIN/CUSIP"), "cusip_code", NULL, "US1234567890",
              GNC_TREE_MODEL_COMMODITY_COL_CUSIP,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_numeric_column (
              view, _("Fraction"), "fraction", "10000",
              GNC_TREE_MODEL_COMMODITY_COL_FRACTION,
              GNC_TREE_VIEW_COLUMN_COLOR_NONE,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_fraction);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    gnc_tree_view_add_toggle_column(
              view, _("Get Quotes"),
              C_("Column letter for 'Get Quotes'", "Q"), "quote_flag",
              GNC_TREE_MODEL_COMMODITY_COL_QUOTE_FLAG,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_quote_flag,
              NULL);
    gnc_tree_view_add_text_column (
              view, _("Source"), "quote_source", NULL, "alphavantage",
              GNC_TREE_MODEL_COMMODITY_COL_QUOTE_SOURCE,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    col = gnc_tree_view_add_text_column (
              view, _("Timezone"), "quote_timezone", NULL, "America/New_York",
              GNC_TREE_MODEL_COMMODITY_COL_QUOTE_TZ,
              GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY,
              sort_by_commodity_string);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));

    gnc_tree_view_configure_columns(view);

    /* Set properties */
    va_start (var_args, first_property_name);
    g_object_set_valist (G_OBJECT(view), first_property_name, var_args);
    va_end (var_args);

    /* Sort on the name column by default. This allows for a consistent
     * sort if commodities are briefly removed and re-added. */
    if (!gtk_tree_sortable_get_sort_column_id(GTK_TREE_SORTABLE(s_model),
            NULL, NULL))
    {
        gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(s_model),
                                             GNC_TREE_MODEL_COMMODITY_COL_FULLNAME,
                                             GTK_SORT_ASCENDING);
    }

    gtk_widget_show(GTK_WIDGET(view));
    LEAVE(" %p", view);
    return GTK_TREE_VIEW(view);
}

gnc_tree_view_commodity_refilter()

void gnc_tree_view_commodity_refilter

(

GncTreeViewCommodity *

view

)

This function forces the commodity tree filter to be evaluated.

It may be necessary to call this function if the initial state of the view is incorrect. This appears to only be necessary if the filter affects one of the top level commodities in gnucash.

Note

This calls a function in gtk that is annotated in the sources as being slow. You have been warned.

Parameters

view	A pointer to an commodity tree view.

Definition at line 591 of file gnc-tree-view-commodity.c.

{
    GtkTreeModel *f_model, *s_model;

    g_return_if_fail(GNC_IS_TREE_VIEW_COMMODITY(view));

    ENTER("view %p", view);
    s_model = gtk_tree_view_get_model (GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (s_model));
    gtk_tree_model_filter_refilter (GTK_TREE_MODEL_FILTER (f_model));
    LEAVE(" ");
}

gnc_tree_view_commodity_select_commodity()

void gnc_tree_view_commodity_select_commodity	(	GncTreeViewCommodity *	view,
		gnc_commodity *	commodity
	)

Select the commodity in the associated commodity tree view.

Parameters

view	A pointer to an commodity tree view.
commodity	The commodity to select.

Definition at line 651 of file gnc-tree-view-commodity.c.

{
    GtkTreeSelection *selection;
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *tree_path;
    GtkTreePath *f_tree_path;
    GtkTreePath *s_tree_path;

    g_return_if_fail (GNC_IS_TREE_VIEW_COMMODITY(view));

    if (!commodity)
        return;

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));

    s_model = gtk_tree_view_get_model (GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (s_model));
    model = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER (f_model));

    tree_path = gnc_tree_model_commodity_get_path_from_commodity (GNC_TREE_MODEL_COMMODITY(model), commodity);

    if (tree_path)
    {
        f_tree_path = gtk_tree_model_filter_convert_child_path_to_path
                                   (GTK_TREE_MODEL_FILTER (f_model), tree_path);

        s_tree_path = gtk_tree_model_sort_convert_child_path_to_path
                                   (GTK_TREE_MODEL_SORT (s_model), f_tree_path);

        gtk_tree_view_expand_to_path (GTK_TREE_VIEW(view), s_tree_path);
        gtk_tree_selection_select_path (selection, s_tree_path);
        gtk_tree_path_free (tree_path);
        gtk_tree_path_free (f_tree_path);
        gtk_tree_path_free (s_tree_path);
    }
}

gnc_tree_view_commodity_select_subcommodities()

void gnc_tree_view_commodity_select_subcommodities	(	GncTreeViewCommodity *	view,
		gnc_commodity *	commodity
	)

This function selects all sub-commodities of an commodity in the commodity tree view.

All other commodities will be unselected.

Note

It only makes sense to call this function when the commodity tree is set to select multiple items. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an commodity tree view.
commodity	A pointer to the commodity whose children should be selected.

gnc_tree_view_commodity_set_filter()

void gnc_tree_view_commodity_set_filter	(	GncTreeViewCommodity *	view,
		gnc_tree_view_commodity_ns_filter_func	ns_func,
		gnc_tree_view_commodity_cm_filter_func	cm_func,
		gpointer	data,
		GDestroyNotify	destroy
	)

This function attaches a filter function to the given commodity tree.

This function will be called for each commodity that the view thinks should possibly show. The filter may perform any actions necessary on the commodity to decide whether it should be shown or not. (I.E. Check type, placeholder status, etc.) If the filter returns TRUE then the commodity will be displayed.

Parameters

view	A pointer to an commodity tree view.
ns_func	A filtration function that is called on individual tree elements that represent a namespace. If this function returns TRUE, the namespace (and commodities under it) will be displayed.
cm_func	A filtration function that is called on individual tree elements that represent a commodity. If this function returns TRUE, the commodity will be displayed.
data	A data block passed into each instance of the function.
destroy	A function to destroy the data block. This function will be called when the filter is destroyed. may be NULL.

Definition at line 543 of file gnc-tree-view-commodity.c.

{
    GtkTreeModel *f_model, *s_model;
    filter_user_data *fd = data;

    g_return_if_fail(GNC_IS_TREE_VIEW_COMMODITY(view));
    g_return_if_fail((ns_func != NULL) || (cm_func != NULL));

    ENTER("view %p, ns func %p, cm func %p, data %p, destroy %p",
          view, ns_func, cm_func, data, destroy);

    fd = g_malloc(sizeof(filter_user_data));
    fd->user_ns_fn   = ns_func;
    fd->user_cm_fn   = cm_func;
    fd->user_data    = data;
    fd->user_destroy = destroy;

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));

    /* disconnect model from view */
    g_object_ref (G_OBJECT(s_model));
    gtk_tree_view_set_model (GTK_TREE_VIEW(view), NULL);

    gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (f_model),
                                            gnc_tree_view_commodity_filter_helper,
                                            fd,
                                            gnc_tree_view_commodity_filter_destroy);

    /* Whack any existing levels. The top two levels have been created
     * before this routine can be called. */
    gtk_tree_model_filter_refilter (GTK_TREE_MODEL_FILTER (f_model));

    /* connect model to view */
    gtk_tree_view_set_model (GTK_TREE_VIEW(view), s_model);
    g_object_unref (G_OBJECT(s_model));

    LEAVE(" ");
}

gnc_tree_view_owner_get_owner_from_iter()

GncOwner* gnc_tree_view_owner_get_owner_from_iter	(	GtkTreeModel *	model,
		GtkTreeIter *	iter
	)

This function returns the owner associated with the specified iter.

This function is useful in selection callbacks on an owner tree widget.

Parameters

model	The model provided to the callback function.
iter	The iter provided to the callback function.

Returns

The owner associated with this iter.

Definition at line 699 of file gnc-tree-view-owner.c.

{
    GtkTreeModel *model, *f_model;
    GtkTreeIter iter, f_iter;
    GncOwner *owner;

    g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT(s_model), NULL);
    g_return_val_if_fail (s_iter != NULL, NULL);

    ENTER("model %p, iter %p", s_model, s_iter);

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT(s_model),
            &f_iter,
            s_iter);
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (
        GTK_TREE_MODEL_FILTER(f_model), &iter, &f_iter);
    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    owner = gnc_tree_model_owner_get_owner (
                GNC_TREE_MODEL_OWNER(model), &iter);
    LEAVE("owner %p (%s)", owner, gncOwnerGetName (owner));
    return owner;
}

gnc_tree_view_owner_get_owner_from_path()

GncOwner* gnc_tree_view_owner_get_owner_from_path	(	GncTreeViewOwner *	view,
		GtkTreePath *	path
	)

This function returns the owner associated with the specified path.

This function is useful in selection callbacks on an owner tree widget.

Parameters

view	A pointer to an owner tree view.
path	A path specifying a node in the owner tree.

Returns

The owner associated with this path.

Definition at line 653 of file gnc-tree-view-owner.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path;
    GtkTreeIter iter;
    GncOwner *owner;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_OWNER (view), NULL);
    g_return_val_if_fail (s_path != NULL, NULL);

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_path = gtk_tree_model_sort_convert_path_to_child_path (
                 GTK_TREE_MODEL_SORT (s_model), s_path);
    if (!f_path)
    {
        LEAVE("no filter path");
        return NULL;
    }

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    path = gtk_tree_model_filter_convert_path_to_child_path (
               GTK_TREE_MODEL_FILTER (f_model), f_path);
    gtk_tree_path_free(f_path);
    if (!path)
    {
        LEAVE("no path");
        return NULL;
    }

    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    if (!gtk_tree_model_get_iter (model, &iter, path))
    {
        LEAVE("no iter");
        return NULL;
    }

    owner = iter.user_data;
    gtk_tree_path_free(path);
    LEAVE("owner %p (%s)", owner, gncOwnerGetName (owner));
    return owner;
}

gnc_tree_view_owner_get_selected_owner()

GncOwner* gnc_tree_view_owner_get_selected_owner

(

GncTreeViewOwner *

view

)

This function returns the owner associated with the selected item in the owner tree view.

Note

It only makes sense to call this function when the owner tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an owner tree view.

Returns

The selected owner, or NULL if no owner was selected.

Definition at line 730 of file gnc-tree-view-owner.c.

{
    GtkTreeSelection *selection;
    GtkTreeModel *f_model, *s_model;
    GtkTreeIter iter, f_iter, s_iter;
    GncOwner *owner;
    GtkSelectionMode mode;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_OWNER (view), NULL);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    mode = gtk_tree_selection_get_mode(selection);
    if ((mode != GTK_SELECTION_SINGLE) && (mode != GTK_SELECTION_BROWSE))
    {
        return NULL;
    }
    if (!gtk_tree_selection_get_selected (selection, &s_model, &s_iter))
    {
        LEAVE("no owner, get_selected failed");
        return FALSE;
    }

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (s_model),
            &f_iter, &s_iter);

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (
        GTK_TREE_MODEL_FILTER (f_model), &iter, &f_iter);

    owner = iter.user_data;
    LEAVE("owner %p (%s)", owner, gncOwnerGetName (owner));
    return owner;
}

gnc_tree_view_owner_new()

GtkTreeView* gnc_tree_view_owner_new

(

GncOwnerType

owner_type

)

Create a new owner tree view for one type of owners.

Parameters

owner_type

The type of owners to use in the view.

Returns

A pointer to a new owner tree view.

Definition at line 319 of file gnc-tree-view-owner.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    const gchar *sample_type, *sample_currency;
    const gchar *owner_name = NULL, * owner_id = NULL;

    ENTER(" ");

    switch (owner_type)
    {
    case GNC_OWNER_NONE :
    case GNC_OWNER_UNDEFINED :
        PWARN("missing owner_type");
        owner_name = _("Name");
        owner_id = _("ID #");
        break;
    case GNC_OWNER_CUSTOMER :
        owner_name = _("Company Name");
        owner_id = _("Customer Number");
        break;
    case GNC_OWNER_JOB :
        owner_name = _("Job Name");
        owner_id = _("Job Number");
        break;
    case GNC_OWNER_VENDOR :
        owner_name = _("Company Name");
        owner_id = _("Vendor Number");
        break;
    case GNC_OWNER_EMPLOYEE :
        owner_name = _("Employee Name");
        owner_id = _("Employee Number");
        break;
    }
    /* Create our view */
    GncTreeViewOwner *view = g_object_new (GNC_TYPE_TREE_VIEW_OWNER,
                                           "name", "gnc-id-owner-tree", NULL);

    /* Create/get a pointer to the existing model for this set of books. */
    model = gnc_tree_model_owner_new (owner_type);

    /* Set up the view private filter layer on the common model. */
    f_model = gtk_tree_model_filter_new (model, NULL);
    /* A GncTreeModelOwner is based on a GncTreeModel, which is a
     * GObject that provides a GtkTreeModel interface. */
    g_object_unref(G_OBJECT(model));

    /* Set up the view private sort layer on the common model. */
    s_model = gtk_tree_model_sort_new_with_model(f_model);
    g_object_unref(G_OBJECT(f_model));
    gtk_tree_view_set_model (GTK_TREE_VIEW (view), s_model);
    g_object_unref(G_OBJECT(s_model));

    /* Set default visibilities */
    gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(view), FALSE);

    sample_type = gncOwnerTypeToQofIdType (GNC_OWNER_CUSTOMER);
    sample_currency = gnc_commodity_get_fullname(gnc_default_currency());

    view->name_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), owner_name, GNC_OWNER_TREE_NAME_COL,
                                        NULL, "GnuCash Inc.",
                                        GNC_TREE_MODEL_OWNER_COL_NAME,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Type"), GNC_OWNER_TREE_TYPE_COL,
                                  NULL, sample_type,
                                  GNC_TREE_MODEL_OWNER_COL_TYPE,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    view->id_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), owner_id, GNC_OWNER_TREE_ID_COL,
                                        NULL, "1-123-1234",
                                        GNC_TREE_MODEL_OWNER_COL_ID,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Currency"), GNC_OWNER_TREE_CURRENCY_COL,
                                  NULL, sample_currency,
                                  GNC_TREE_MODEL_OWNER_COL_CURRENCY,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Address Name"), GNC_OWNER_TREE_ADDRESS_NAME_COL,
                                  NULL, "GnuCash Inc.",
                                  GNC_TREE_MODEL_OWNER_COL_ADDRESS_NAME,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Address 1"), GNC_OWNER_TREE_ADDRESS_1_COL,
                                  NULL, "Free Software Foundation",
                                  GNC_TREE_MODEL_OWNER_COL_ADDRESS_1,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Address 2"), GNC_OWNER_TREE_ADDRESS_2_COL,
                                  NULL, "51 Franklin Street, Fifth Floor",
                                  GNC_TREE_MODEL_OWNER_COL_ADDRESS_2,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Address 3"), GNC_OWNER_TREE_ADDRESS_3_COL,
                                  NULL, "Boston, MA  02110-1301",
                                  GNC_TREE_MODEL_OWNER_COL_ADDRESS_3,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Address 4"), GNC_OWNER_TREE_ADDRESS_4_COL,
                                  NULL, "USA",
                                  GNC_TREE_MODEL_OWNER_COL_ADDRESS_4,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Phone"), GNC_OWNER_TREE_PHONE_COL,
                                  NULL, "+1-617-542-5942",
                                  GNC_TREE_MODEL_OWNER_COL_PHONE,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Fax"), GNC_OWNER_TREE_FAX_COL,
                                  NULL, "+1-617-542-2652",
                                  GNC_TREE_MODEL_OWNER_COL_FAX,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("E-mail"), GNC_OWNER_TREE_EMAIL_COL,
                                  NULL, "gnu@gnu.org",
                                  GNC_TREE_MODEL_OWNER_COL_EMAIL,
                                  GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                  sort_by_string);
    gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Balance"), GNC_OWNER_TREE_BALANCE_COL,
                                     SAMPLE_OWNER_VALUE,
                                     GNC_TREE_MODEL_OWNER_COL_BALANCE,
                                     GNC_TREE_MODEL_OWNER_COL_COLOR_BALANCE,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_balance_value);

    view->balance_report_column
        = gnc_tree_view_add_numeric_column(GNC_TREE_VIEW(view), _("Balance"), GNC_OWNER_TREE_BALANCE_REPORT_COL,
                                           SAMPLE_OWNER_VALUE,
                                           GNC_TREE_MODEL_OWNER_COL_BALANCE_REPORT,
                                           GNC_TREE_MODEL_OWNER_COL_COLOR_BALANCE,
                                           GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                           sort_by_balance_value);

    view->notes_column
        = gnc_tree_view_add_text_column(GNC_TREE_VIEW(view), _("Notes"), GNC_OWNER_TREE_NOTES_COL, NULL,
                                        "Sample owner notes.",
                                        GNC_TREE_MODEL_OWNER_COL_NOTES,
                                        GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                        sort_by_string);
    gnc_tree_view_add_toggle_column (GNC_TREE_VIEW(view), _("Active"),
                                     C_("Column letter for 'Active'", "A"),
                                     GNC_OWNER_TREE_ACTIVE_COL,
                                     GNC_TREE_MODEL_OWNER_COL_ACTIVE,
                                     GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
                                     sort_by_boolean,
                                     gnc_tree_view_owner_active_toggled);

    /* Update column titles to use the currency name. */
    gtvo_update_column_names(view);

    /* By default only the first column is visible. */
    gnc_tree_view_configure_columns(GNC_TREE_VIEW(view));
    gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (f_model),
                                            gnc_tree_view_owner_filter_helper,
                                            view,
                                            NULL);

    /* Default the sorting to owner name */
    gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(s_model),
                                         GNC_TREE_MODEL_OWNER_COL_NAME,
                                         GTK_SORT_ASCENDING);

    gtk_widget_show(GTK_WIDGET(view));
    LEAVE("%p", view);
    return GTK_TREE_VIEW(view);
}

gnc_tree_view_owner_refilter()

void gnc_tree_view_owner_refilter

(

GncTreeViewOwner *

view

)

This function forces the owner tree filter to be evaluated.

It may be necessary to call this function if the initial state of the view is incorrect. This appears to only be necessary if the filter affects one of the top level owners in gnucash.

Note

This calls a function in gtk that is annotated in the sources as being slow. You have been warned.

Parameters

view	A pointer to an owner tree view.

Definition at line 633 of file gnc-tree-view-owner.c.

{
    GtkTreeModel *f_model, *s_model;

    g_return_if_fail(GNC_IS_TREE_VIEW_OWNER(view));

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_refilter (GTK_TREE_MODEL_FILTER (f_model));
}

gnc_tree_view_owner_set_filter()

void gnc_tree_view_owner_set_filter	(	GncTreeViewOwner *	owner_view,
		gnc_tree_view_owner_filter_func	func,
		gpointer	data,
		GSourceFunc	destroy
	)

This function attaches a filter function to the given owner tree.

This function will be called for each owner that the view thinks should possibly show. The filter may perform any actions necessary on the owner to decide whether it should be shown or not. (I.E. Check type, placeholder status, etc.) If the filter returns TRUE then the owner will be displayed.

Parameters

owner_view	A pointer to an owner tree view.
func	A filtration function that is called on individual elements in the tree. If this function returns TRUE, the owner will be displayed.
data	A data block passed into each instance of the function.
destroy	A function to destroy the data block. This function will be called when the filter is destroyed. may be NULL.

Definition at line 607 of file gnc-tree-view-owner.c.

{
    ENTER("view %p, filter func %p, data %p, destroy %p",
          view, func, data, destroy);

    g_return_if_fail(GNC_IS_TREE_VIEW_OWNER(view));

    if (view->filter_destroy)
    {
        view->filter_destroy(view->filter_data);
    }
    view->filter_destroy = destroy;
    view->filter_data = data;
    view->filter_fn = func;

    gnc_tree_view_owner_refilter(view);
    LEAVE(" ");
}

gnc_tree_view_owner_set_selected_owner()

void gnc_tree_view_owner_set_selected_owner	(	GncTreeViewOwner *	view,
		GncOwner *	owner
	)

This function selects an owner in the owner tree view.

All other owners will be unselected. In addition, this function collapses the entire tree and then expands only the path to the selected owner, making the item easy to find. In general, this routine only need be called when initially putting up a window containing an owner tree view widget.

Note

It only makes sense to call this function when the owner tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an owner tree view.
owner	A pointer to the owner to select.

Definition at line 770 of file gnc-tree-view-owner.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path, *s_path;
    GtkTreeSelection *selection;

    ENTER("view %p, owner %p (%s)", view,
          owner, gncOwnerGetName (owner));
    g_return_if_fail (GNC_IS_TREE_VIEW_OWNER (view));

    /* Clear any existing selection. */
    selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
    gtk_tree_selection_unselect_all (selection);

    if (owner == NULL)
        return;

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));

    path = gnc_tree_model_owner_get_path_from_owner (
               GNC_TREE_MODEL_OWNER(model), owner);
    if (path == NULL)
    {
        LEAVE("no path");
        return;
    }
    debug_path(DEBUG, path);

    f_path = gtk_tree_model_filter_convert_child_path_to_path (
                 GTK_TREE_MODEL_FILTER (f_model), path);
    gtk_tree_path_free(path);
    if (f_path == NULL)
    {
        LEAVE("no filter path");
        return;
    }
    debug_path(DEBUG, f_path);

    s_path = gtk_tree_model_sort_convert_child_path_to_path (GTK_TREE_MODEL_SORT (s_model),
             f_path);
    gtk_tree_path_free(f_path);
    if (s_path == NULL)
    {
        LEAVE("no sort path");
        return;
    }

    gtk_tree_selection_select_path (selection, s_path);

    /* give gtk+ a chance to resize the tree view first by handling pending
     * configure events */
    while (gtk_events_pending ())
        gtk_main_iteration ();
    gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW(view), s_path, NULL, FALSE, 0.0, 0.0);
    debug_path(LEAVE, s_path);
    gtk_tree_path_free(s_path);
}

gnc_tree_view_price_get_cursor_price()

GNCPrice* gnc_tree_view_price_get_cursor_price

(

GncTreeViewPrice *

view

)

This function returns the price in the price tree view at the current location of the cursor.

(The outline frame. Usually is selected and therefore filled in, but not always.)

Parameters

view	A pointer to an price tree view.

Returns

The price at the cursor.

gnc_tree_view_price_get_selected_commodities()

GList* gnc_tree_view_price_get_selected_commodities

(

GncTreeViewPrice *

view

)

This function returns a list of commodities associated with the selected rows that are not prices but are the parent rows for prices in the price tree view.

Note

It only makes sense to call this function when the price tree is set to select multiple items.

Parameters

view	A pointer to an price tree view.

Returns

A list of commodities, or NULL if no commodity was selected.

Definition at line 810 of file gnc-tree-view-price.c.

{
    GtkTreeSelection *selection;
    GList *return_list = NULL;

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    gtk_tree_selection_selected_foreach (selection, get_selected_commodity_helper, &return_list);
    return g_list_reverse (return_list);
}

gnc_tree_view_price_get_selected_price()

GNCPrice* gnc_tree_view_price_get_selected_price

(

GncTreeViewPrice *

view

)

This function returns the price associated with the selected item in the price tree view.

Note

It only makes sense to call this function when the price tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an price tree view.

Returns

The selected price, or NULL if no price was selected.

Definition at line 628 of file gnc-tree-view-price.c.

{
    GtkTreeSelection *selection;
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreeIter iter, f_iter, s_iter;
    GNCPrice *price;

    ENTER("view %p", view);
    g_return_val_if_fail (GNC_IS_TREE_VIEW_PRICE (view), NULL);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    if (!gtk_tree_selection_get_selected (selection, &s_model, &s_iter))
    {
        LEAVE("no price, get_selected failed");
        return FALSE;
    }

    gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (s_model),
            &f_iter, &s_iter);

    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (f_model),
            &iter, &f_iter);

    model = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(f_model));
    price = gnc_tree_model_price_get_price (GNC_TREE_MODEL_PRICE(model),
                                            &iter);
    LEAVE("price %p", price);
    return price;
}

gnc_tree_view_price_get_selected_prices()

GList* gnc_tree_view_price_get_selected_prices

(

GncTreeViewPrice *

view

)

This function returns a list of the prices associated with the selected items in the price tree view.

Note

It only makes sense to call this function when the price tree is set to select multiple items. There is a different function to use when the tree supports single selection.

Parameters

view	A pointer to an price tree view.

Returns

A list of prices, or NULL if no price was selected.

Definition at line 766 of file gnc-tree-view-price.c.

{
    GtkTreeSelection *selection;
    GList *return_list = NULL;

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW(view));
    gtk_tree_selection_selected_foreach(selection, get_selected_prices_helper, &return_list);
    return g_list_reverse (return_list);
}

gnc_tree_view_price_new()

GtkTreeView* gnc_tree_view_price_new	(	QofBook *	book,
		const gchar *	first_property_name,
			...
	)

Create a new price tree view.

This view may or may not show a pseudo top-level price. The gnucash engine does not have a single top level price (it has a list of top level prices), but this code provides one so that it can be used with all parts of the gnucash gui.

Parameters

book	The book containing the prices to show.
first_property_name	Pairs of property name/value settings for the newly created object. Terminate the properties with a single NULL argument.

Returns

A pointer to a new price tree view.

Definition at line 350 of file gnc-tree-view-price.c.

{
    GncTreeView *view;
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreeViewColumn *col;
    GNCPriceDB *price_db;
    va_list var_args;
    const gchar *sample_text;
    gchar *sample_text2;

    ENTER(" ");
    /* Create/get a pointer to the existing model for this set of books. */
    price_db = gnc_pricedb_get_db(book);
    model = gnc_tree_model_price_new (book, price_db);

    /* Set up the view private filter on the common model. */
    f_model = gtk_tree_model_filter_new (model, NULL);
    g_object_unref(G_OBJECT(model));
    s_model = gtk_tree_model_sort_new_with_model (f_model);
    g_object_unref(G_OBJECT(f_model));

    /* Create our view */
    view = g_object_new (GNC_TYPE_TREE_VIEW_PRICE,
                         "name", "gnc-id-price-tree", NULL);
    gtk_tree_view_set_model (GTK_TREE_VIEW (view), s_model);
    g_object_unref(G_OBJECT(s_model));

    DEBUG("model ref count is %d",   G_OBJECT(model)->ref_count);
    DEBUG("f_model ref count is %d", G_OBJECT(f_model)->ref_count);
    DEBUG("s_model ref count is %d", G_OBJECT(s_model)->ref_count);

    sample_text = gnc_commodity_get_printname(gnc_default_currency());
    sample_text2 = g_strdup_printf("%s%s", sample_text, sample_text);
    gnc_tree_view_add_text_column (
              view, _("Security"), "security", NULL, sample_text2,
              GNC_TREE_MODEL_PRICE_COL_COMMODITY,
              GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS,
              sort_by_name);
    g_free(sample_text2);
    col = gnc_tree_view_add_text_column (
              view, _("Currency"), "currency", NULL, sample_text,
              GNC_TREE_MODEL_PRICE_COL_CURRENCY,
              GNC_TREE_MODEL_PRICE_COL_VISIBILITY,
              sort_by_name);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_text_column (
              view, _("Date"), "date", NULL, "2005-05-20",
              GNC_TREE_MODEL_PRICE_COL_DATE,
              GNC_TREE_MODEL_PRICE_COL_VISIBILITY,
              sort_by_date);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_text_column (
              view, _("Source"), "source", NULL, "Finance::Quote",
              GNC_TREE_MODEL_PRICE_COL_SOURCE,
              GNC_TREE_MODEL_PRICE_COL_VISIBILITY,
              sort_by_source);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_text_column (
              view, _("Type"), "type", NULL, "last",
              GNC_TREE_MODEL_PRICE_COL_TYPE,
              GNC_TREE_MODEL_PRICE_COL_VISIBILITY,
              sort_by_type);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));
    col = gnc_tree_view_add_numeric_column (
              view, _("Price"), "price", "100.00000",
              GNC_TREE_MODEL_PRICE_COL_VALUE,
              GNC_TREE_VIEW_COLUMN_COLOR_NONE,
              GNC_TREE_MODEL_PRICE_COL_VISIBILITY,
              sort_by_value);
    g_object_set_data(G_OBJECT(col), DEFAULT_VISIBLE, GINT_TO_POINTER(1));

    gnc_tree_view_configure_columns(view);

    /* Set properties */
    va_start (var_args, first_property_name);
    g_object_set_valist (G_OBJECT(view), first_property_name, var_args);
    va_end (var_args);

    /* Sort on the commodity column by default. This allows for a consistent
     * sort if commodities are removed and re-added from the model. */
    if (!gtk_tree_sortable_get_sort_column_id(GTK_TREE_SORTABLE(s_model),
            NULL, NULL))
    {
        gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(s_model),
                                             GNC_TREE_MODEL_PRICE_COL_COMMODITY,
                                             GTK_SORT_ASCENDING);
    }

    gtk_widget_show(GTK_WIDGET(view));
    LEAVE(" %p", view);
    return GTK_TREE_VIEW(view);
}

gnc_tree_view_price_set_selected_price()

void gnc_tree_view_price_set_selected_price	(	GncTreeViewPrice *	view,
		GNCPrice *	price
	)

This function selects an price in the price tree view.

All other prices will be unselected. In addition, this function collapses the entire tree and then expands only the path to the selected price, making the item easy to find. In general, this routine only need be called when initially putting up a window containing an price tree view widget.

Note

It only makes sense to call this function when the price tree is set to select a single item. There is a different function to use when the tree supports multiple selections.

Parameters

view	A pointer to an price tree view.
price	A pointer to the price to select.

Definition at line 664 of file gnc-tree-view-price.c.

{
    GtkTreeModel *model, *f_model, *s_model;
    GtkTreePath *path, *f_path, *s_path, *parent_path;
    GtkTreeSelection *selection;

    ENTER("view %p, price %p", view, price);

    /* Clear any existing selection. */
    selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
    gtk_tree_selection_unselect_all (selection);

    if (price == NULL)
        return;

    s_model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
    f_model = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(s_model));
    model = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER (f_model));

    path = gnc_tree_model_price_get_path_from_price (GNC_TREE_MODEL_PRICE(model), price);
    if (path == NULL)
    {
        LEAVE("get_path_from_price failed");
        return;
    }
    debug_path(DEBUG, path);

    f_path = gtk_tree_model_filter_convert_child_path_to_path (GTK_TREE_MODEL_FILTER (f_model),
             path);
    gtk_tree_path_free(path);
    if (f_path == NULL)
    {
        LEAVE("no filter path");
        return;
    }
    debug_path(DEBUG, f_path);

    s_path = gtk_tree_model_sort_convert_child_path_to_path (GTK_TREE_MODEL_SORT (s_model),
             f_path);
    gtk_tree_path_free(f_path);
    if (s_path == NULL)
    {
        LEAVE("no sort path");
        return;
    }

    /* gtk_tree_view requires that a row be visible before it can be selected */
    parent_path = gtk_tree_path_copy (s_path);
    if (gtk_tree_path_up (parent_path))
    {
        /* This function is misnamed.  It expands the actual item
         * specified, not the path to the item specified. I.E. It expands
         * one level too many, thus the get of the parent. */
        gtk_tree_view_expand_to_path(GTK_TREE_VIEW(view), parent_path);
    }
    gtk_tree_path_free(parent_path);

    gtk_tree_selection_select_path (selection, s_path);
    gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW(view), s_path, NULL, FALSE, 0.0, 0.0);
    debug_path(LEAVE, s_path);
    gtk_tree_path_free(s_path);
}

gppat_filter_clear_all_cb()

void gppat_filter_clear_all_cb	(	GtkWidget *	button,
		AccountFilterDialog *	fd
	)

The "clear all account types" button in the Filter dialog was clicked.

Clear all account types shown, and update the visible page.

Parameters

button	The button that was clicked.
fd	A pointer to the account filter dialog struct.

Definition at line 2130 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GTK_IS_BUTTON(button));

    ENTER("button %p", button);
    fd->visible_types = 0;
    gtk_tree_model_filter_refilter(GTK_TREE_MODEL_FILTER(fd->model));
    gnc_tree_view_account_refilter(fd->tree_view);
    LEAVE("types 0x%x", fd->visible_types);
}

gppat_filter_response_cb()

void gppat_filter_response_cb	(	GtkWidget *	dialog,
		gint	response,
		AccountFilterDialog *	fd
	)

The Filter dialog was closed.

Check to see if this was done via the OK button. If so, make the changes permanent. If not, revert any changes.

Parameters

dialog	A pointer to the "Filter By" dialog.
response	The response code from closing the dialog.
fd	A pointer to the account filter dialog struct.

Definition at line 2244 of file gnc-tree-view-account.c.

{
    gpointer gptemp;

    g_return_if_fail(GTK_IS_DIALOG(dialog));

    ENTER("dialog %p, response %d", dialog, response);

    if (response != GTK_RESPONSE_OK)
    {
        fd->visible_types = fd->original_visible_types;
        fd->show_hidden = fd->original_show_hidden;
        fd->show_zero_total = fd->original_show_zero_total;
        fd->show_unused = fd->original_show_unused;
        gnc_tree_view_account_refilter(fd->tree_view);
    }

    /* Clean up and delete dialog */
    gptemp = (gpointer)fd->dialog;
    g_atomic_pointer_compare_and_exchange(&gptemp,
                                          (gpointer)dialog, NULL);
    fd->dialog = gptemp;
    gtk_widget_destroy(dialog);
    LEAVE("types 0x%x", fd->visible_types);
}

gppat_filter_select_all_cb()

void gppat_filter_select_all_cb	(	GtkWidget *	button,
		AccountFilterDialog *	fd
	)

The "select all account types" button in the Filter dialog was clicked.

Make all account types visible, and update the page.

Parameters

button	The button that was clicked.
fd	A pointer to the account filter dialog struct.

Definition at line 2149 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GTK_IS_BUTTON(button));

    ENTER("button %p", button);
    fd->visible_types = -1;
    gtk_tree_model_filter_refilter(GTK_TREE_MODEL_FILTER(fd->model));
    gnc_tree_view_account_refilter(fd->tree_view);
    LEAVE("types 0x%x", fd->visible_types);
}

gppat_filter_select_default_cb()

void gppat_filter_select_default_cb	(	GtkWidget *	button,
		AccountFilterDialog *	fd
	)

The "select default account types" button in the Filter dialog was clicked.

Set all account types to their default visibility (which happens to be visible for all of them), and update the page.

Parameters

button	The button that was clicked.
fd	A pointer to the account filter dialog struct.

Definition at line 2169 of file gnc-tree-view-account.c.

{
    ENTER("button %p", button);
    gppat_filter_select_all_cb(button, fd);
    LEAVE(" ");
}

gppat_filter_show_hidden_toggled_cb()

void gppat_filter_show_hidden_toggled_cb	(	GtkToggleButton *	button,
		AccountFilterDialog *	fd
	)

The "show hidden" button in the Filter dialog changed state.

Update the page to reflect these changes.

Parameters

button	The GtkCheckButton that was toggled.
fd	A pointer to the account filter dialog struct.

Definition at line 2072 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GTK_IS_TOGGLE_BUTTON(button));

    ENTER("button %p", button);
    fd->show_hidden = gtk_toggle_button_get_active(button);
    gnc_tree_view_account_refilter(fd->tree_view);
    LEAVE("show_hidden %d", fd->show_hidden);
}

gppat_filter_show_unused_toggled_cb()

void gppat_filter_show_unused_toggled_cb	(	GtkToggleButton *	button,
		AccountFilterDialog *	fd
	)

The "show unused" button in the Filter dialog changed state.

Update the page to reflect these changes.

Parameters

button	The GtkCheckButton that was toggled.
fd	A pointer to the account filter dialog struct.

Definition at line 2110 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GTK_IS_TOGGLE_BUTTON(button));

    ENTER("button %p", button);
    fd->show_unused = gtk_toggle_button_get_active(button);
    gnc_tree_view_account_refilter(fd->tree_view);
    LEAVE("show_unused %d", fd->show_unused);
}

gppat_filter_show_zero_toggled_cb()

void gppat_filter_show_zero_toggled_cb	(	GtkToggleButton *	button,
		AccountFilterDialog *	fd
	)

The "show zero totals" button in the Filter dialog changed state.

Update the page to reflect these changes.

Parameters

button	The GtkCheckButton that was toggled.
fd	A pointer to the account filter dialog struct.

Definition at line 2091 of file gnc-tree-view-account.c.

{
    g_return_if_fail(GTK_IS_TOGGLE_BUTTON(button));

    ENTER("button %p", button);
    fd->show_zero_total = gtk_toggle_button_get_active(button);
    gnc_tree_view_account_refilter(fd->tree_view);
    LEAVE("show_zero %d", fd->show_zero_total);
}

gppot_filter_response_cb()

void gppot_filter_response_cb	(	GtkWidget *	dialog,
		gint	response,
		OwnerFilterDialog *	fd
	)

The Filter dialog was closed.

Check to see if this was done via the OK button. If so, make the changes permanent. If not, revert any changes.

Parameters

dialog	A pointer to the "Filter By" dialog.
response	The response code from closing the dialog.
fd	A pointer to the owner filter dialog struct.

Definition at line 1098 of file gnc-tree-view-owner.c.

{
    gpointer gptemp;

    g_return_if_fail(GTK_IS_DIALOG(dialog));

    ENTER("dialog %p, response %d", dialog, response);

    if (response != GTK_RESPONSE_OK)
    {
        fd->show_inactive = fd->original_show_inactive;
        fd->show_zero_total = fd->original_show_zero_total;
        gnc_tree_view_owner_refilter(fd->tree_view);
    }

    /* Clean up and delete dialog */
    gptemp = (gpointer)fd->dialog;
    g_atomic_pointer_compare_and_exchange(&gptemp,
                                          (gpointer)dialog, NULL);
    fd->dialog = gptemp;
    gtk_widget_destroy(dialog);
    LEAVE("");
}

gppot_filter_show_inactive_toggled_cb()

void gppot_filter_show_inactive_toggled_cb	(	GtkToggleButton *	button,
		OwnerFilterDialog *	fd
	)

The "only show active" button in the Filter dialog changed state.

Update the page to reflect these changes.

Parameters

button	The GtkCheckButton that was toggled.
fd	A pointer to the owner filter dialog struct.

Definition at line 1059 of file gnc-tree-view-owner.c.

{
    g_return_if_fail(GTK_IS_TOGGLE_BUTTON(button));

    ENTER("button %p", button);
    fd->show_inactive = !gtk_toggle_button_get_active(button);
    gnc_tree_view_owner_refilter(fd->tree_view);
    LEAVE("show_inactive %d", fd->show_inactive);
}

gppot_filter_show_zero_toggled_cb()

void gppot_filter_show_zero_toggled_cb	(	GtkToggleButton *	button,
		OwnerFilterDialog *	fd
	)

The "show zero totals" button in the Filter dialog changed state.

Update the page to reflect these changes.

Parameters

button	The GtkCheckButton that was toggled.
fd	A pointer to the owner filter dialog struct.

Definition at line 1077 of file gnc-tree-view-owner.c.

{
    g_return_if_fail(GTK_IS_TOGGLE_BUTTON(button));

    ENTER("button %p", button);
    fd->show_zero_total = gtk_toggle_button_get_active(button);
    gnc_tree_view_owner_refilter(fd->tree_view);
    LEAVE("show_zero %d", fd->show_zero_total);
}