GncTreeView

Files
file	gnc-tree-view.c
	Base GncTreeView implementation for gnucash trees.
file	tree-view-utils.c
	Simple convenience functions for common tasks on GtkTreeViews.

Data Structures
struct	GncTreeViewPrivate
	Private Data Structure. More...

Macros
#define	STATE_KEY   "state-key"
#define	STATE_KEY_SORT_COLUMN   "sort_column"
#define	STATE_KEY_SORT_ORDER   "sort_order"
#define	STATE_KEY_COLUMN_ORDER   "column_order"
#define	STATE_KEY_SUFF_VISIBLE   "visible"
#define	STATE_KEY_SUFF_WIDTH   "width"

Enumerations
enum	{ PROP_0 , PROP_STATE_SECTION , PROP_SHOW_COLUMN_MENU }

Functions
void	gnc_tree_view_configure_columns (GncTreeView *view)
	Make all the correct columns visible, respecting their default visibility setting, their "always" visibility setting, and the last saved state if available.
GtkTreeViewColumn *	gnc_tree_view_add_toggle_column (GncTreeView *view, const gchar *column_title, const gchar *column_short_title, const gchar *pref_name, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn, renderer_toggled toggle_edited_cb)
	This function adds a new toggle column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_text_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *icon_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new text column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_text_view_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *icon_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new text view column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_pix_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new pixbuf view column to a GncTreeView base view.
GtkCellRenderer *	gnc_tree_view_column_get_renderer (GtkTreeViewColumn *column)
	Return the "main" cell renderer from a GtkTreeViewColumn added to a GncTreeView my one of the convenience routines.
GtkTreeViewColumn *	gnc_tree_view_add_numeric_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *sizing_text, gint model_data_column, gint model_color_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new numeric column to a GncTreeView base view.
gint	gnc_tree_view_append_column (GncTreeView *view, GtkTreeViewColumn *column)
	Add a column to a view based upon a GncTreeView.
gboolean	gnc_tree_view_path_is_valid (GncTreeView *view, GtkTreePath *path)
void	gnc_tree_view_keynav (GncTreeView *view, GtkTreeViewColumn **col, GtkTreePath *path, GdkEventKey *event)
void	gnc_tree_view_set_editing_started_cb (GncTreeView *view, GFunc editing_started_cb, gpointer editing_cb_data)
	Setup a callback for when the user starts editing so appropriate actions can be taken like disable the actions delete menu option.
void	gnc_tree_view_set_editing_finished_cb (GncTreeView *view, GFunc editing_finished_cb, gpointer editing_cb_data)
	Setup a callback for when the user finishes editing so appropriate actions can be taken like enable the actions delete menu option.
void	tree_view_column_set_default_width (GtkTreeView *view, GtkTreeViewColumn *column, const gchar *sizing_text)
	Set default width for a treeview column.

Gnc Tree View Column Selection Menu Related Functions
void	gnc_tree_view_expand_columns (GncTreeView *view, gchar *first_column_name,...)
	This function set the columns that will be allocated the free space in the view.
void	gnc_tree_view_set_control_column_background (GncTreeView *view, gint column, GtkTreeCellDataFunc func)
	This function links the cell backgrounds of the two control columns to a column in the model that has color strings or a cell data function that sets the "cell-background" property.
void	gnc_tree_view_set_sort_user_data (GncTreeView *view, GtkTreeModel *s_model)
	This allows the columns to be setup without the model connected.
void	gnc_tree_view_set_show_column_menu (GncTreeView *view, gboolean visible)
	This function is called to set the "show-column-menu" property on this view.
gboolean	gnc_tree_view_get_show_column_menu (GncTreeView *view)
	This function is called to get the current value of the "show-column-menu" property.

Gnc Tree View state Callback / Related Functions
void	gnc_tree_view_remove_state_information (GncTreeView *view)
	Completely wipe the treeview's state information (column visibility, width, sorting order,..).
void	gnc_tree_view_set_state_section (GncTreeView *view, const gchar *section)
	Set up or remove an association between a saved state section and the display of a view.
const gchar *	gnc_tree_view_get_state_section (GncTreeView *view)
	Get the name of the state section this tree view is associated with.
void	gnc_tree_view_save_state (GncTreeView *view)
	This function is called to write the treeview's state information (column visibility, width, sorting order,..) to the state file.

Gnc Tree View Auxiliary Functions
GtkTreeViewColumn *	gnc_tree_view_find_column_by_name (GncTreeView *view, const gchar *wanted)
	Find a tree column given the "pref name" used with saved state.

Detailed Description

Macro Definition Documentation

STATE_KEY

#define STATE_KEY   "state-key"

Definition at line 55 of file gnc-tree-view.c.

STATE_KEY_COLUMN_ORDER

#define STATE_KEY_COLUMN_ORDER   "column_order"

Definition at line 60 of file gnc-tree-view.c.

STATE_KEY_SORT_COLUMN

#define STATE_KEY_SORT_COLUMN   "sort_column"

Definition at line 58 of file gnc-tree-view.c.

STATE_KEY_SORT_ORDER

#define STATE_KEY_SORT_ORDER   "sort_order"

Definition at line 59 of file gnc-tree-view.c.

STATE_KEY_SUFF_VISIBLE

#define STATE_KEY_SUFF_VISIBLE   "visible"

Definition at line 65 of file gnc-tree-view.c.

STATE_KEY_SUFF_WIDTH

#define STATE_KEY_SUFF_WIDTH   "width"

Definition at line 66 of file gnc-tree-view.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Definition at line 68 of file gnc-tree-view.c.

{
    PROP_0,
    PROP_STATE_SECTION,
    PROP_SHOW_COLUMN_MENU,
};

Function Documentation

gnc_tree_view_add_numeric_column()

GtkTreeViewColumn * gnc_tree_view_add_numeric_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_color_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new numeric column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered. A numeric column is nothing more then a text column with a few extra attributes.

Parameters are defined in gnc-tree-view.h

Definition at line 2061 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GtkCellRenderer *renderer;
    gfloat alignment = 1.0;
 
    /* Use GncCellRendererLabel so the user can click a cell and select
     * its text (e.g. to copy it to the clipboard), without being able
     * to modify the underlying data. */
    renderer = gnc_cell_renderer_label_new ();
    column = add_text_column_variant (view, renderer, column_title, pref_name,
                                      NULL, sizing_text, model_data_column,
                                      model_visibility_column, column_sort_fn);
 
    /* Right align the column title and data for both ltr and rtl */
    if (gtk_widget_get_direction (GTK_WIDGET(view)) == GTK_TEXT_DIR_RTL)
        alignment = 0.0;
 
    g_object_set (G_OBJECT(column), "alignment", alignment, NULL);
    g_object_set (G_OBJECT(renderer), "xalign", alignment, NULL);
 
    /* Change the text color */
    if (model_color_column != GNC_TREE_VIEW_COLUMN_COLOR_NONE)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "foreground", model_color_column);
 
    return column;
}

gnc_tree_view_add_pix_column()

GtkTreeViewColumn * gnc_tree_view_add_pix_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new pixbuf view column to a GncTreeView base view.

This function adds a pixbuf view column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1985 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    PangoLayout* layout;
    int default_width, title_width;
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_pixbuf_new ();
 
    column = gtk_tree_view_column_new ();
    gtk_tree_view_column_set_title (column, column_title);
 
    /* Set up a text renderer and attributes */
    gtk_tree_view_column_pack_start (column, renderer, TRUE);
 
    /* Set renderer attributes controlled by the model */
    if (model_data_column != GNC_TREE_VIEW_COLUMN_DATA_NONE)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "icon-name", model_data_column);
    if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "visible", model_visibility_column);
 
    /* Default size is the larger of the column title and the sizing text */
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
    pango_layout_get_pixel_size (layout, &title_width, NULL);
    g_object_unref (layout);
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
    pango_layout_get_pixel_size (layout, &default_width, NULL);
    g_object_unref (layout);
    default_width = MAX(default_width, title_width);
    if (default_width)
        default_width += 10; /* padding on either side */
    gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
                                     default_width, TRUE, column_sort_fn);
 
    gnc_tree_view_append_column (view, column);
    return column;
}

gnc_tree_view_add_text_column()

GtkTreeViewColumn * gnc_tree_view_add_text_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	icon_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new text column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1921 of file gnc-tree-view.c.

{
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_text_new ();
 
    return add_text_column_variant (view, renderer,
                                    column_title, pref_name,
                                    icon_name, sizing_text,
                                    model_data_column,
                                    model_visibility_column,
                                    column_sort_fn);
}

gnc_tree_view_add_text_view_column()

GtkTreeViewColumn * gnc_tree_view_add_text_view_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	icon_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new text view column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1953 of file gnc-tree-view.c.

{
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gnc_cell_renderer_text_view_new ();
 
    return add_text_column_variant (view, renderer,
                                    column_title, pref_name,
                                    icon_name, sizing_text,
                                    model_data_column,
                                    model_visibility_column,
                                    column_sort_fn);
}

gnc_tree_view_add_toggle_column()

GtkTreeViewColumn * gnc_tree_view_add_toggle_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	column_short_title,
		const gchar *	pref_name,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn,
		renderer_toggled	toggle_edited_cb
	)

This function adds a new toggle column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. It handles creating a tooltip to show the full title name, and setting the sort and edit callback functions. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1768 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_toggle_new ();
    if (!toggle_edited_cb)
    {
        gtk_cell_renderer_toggle_set_activatable (GTK_CELL_RENDERER_TOGGLE(renderer), FALSE);
    }
    column =
        gtk_tree_view_column_new_with_attributes (column_short_title,
                renderer,
                "active", model_data_column,
                NULL);
 
    /* Add the full title to the object for menu creation */
    g_object_set_data_full (G_OBJECT(column), REAL_TITLE,
                            g_strdup(column_title), g_free);
    if (toggle_edited_cb)
        g_signal_connect (G_OBJECT(renderer), "toggled",
                          G_CALLBACK(toggle_edited_cb), view);
 
    if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "visible", model_visibility_column);
 
 
    gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
                                     0, FALSE, column_sort_fn);
 
    gnc_tree_view_append_column (view, column);
 
    /* Also add the full title to the object as a tooltip */
    gtk_widget_set_tooltip_text (gtk_tree_view_column_get_button (column), column_title);
 
    return column;
}

gnc_tree_view_append_column()

gint gnc_tree_view_append_column	(	GncTreeView *	view,
		GtkTreeViewColumn *	column
	)

Add a column to a view based upon a GncTreeView.

This function knows about the two special columns on the right side of this type of view, and adds the new column before these two columns. You could say that it appends to the data columns and ignores the infrastructure columns.

Parameters are defined in gnc-tree-view.h

Definition at line 2106 of file gnc-tree-view.c.

{
    int n = gtk_tree_view_get_n_columns (GTK_TREE_VIEW(view));
 
    /* Ignore the initial column, the selection menu */
    if (n >= 1)
        n -= 1;
    return gtk_tree_view_insert_column (GTK_TREE_VIEW(view), column, n);
}

gnc_tree_view_column_get_renderer()

GtkCellRenderer * gnc_tree_view_column_get_renderer

(

GtkTreeViewColumn *

column

)

Return the "main" cell renderer from a GtkTreeViewColumn added to a GncTreeView my one of the convenience routines.

Parameters

column

The tree view column that was added to the GncTreeView

Returns

The cell renderer in use in the column.

Definition at line 2034 of file gnc-tree-view.c.

{
    GList *renderers;
    GtkCellRenderer *cr = NULL;
 
    g_return_val_if_fail (GTK_TREE_VIEW_COLUMN(column), NULL);
 
    /* Get the list of one renderer */
    renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT(column));
    if (g_list_length (renderers) > 0)
        cr = GTK_CELL_RENDERER(renderers->data);
    g_list_free (renderers);
 
    return cr;
}

gnc_tree_view_configure_columns()

void gnc_tree_view_configure_columns

(

GncTreeView *

view

)

Make all the correct columns visible, respecting their default visibility setting, their "always" visibility setting, and the last saved state if available.

Parameters

view	A pointer to an gnc tree view.

Definition at line 1598 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GtkTreeViewColumn *column;
    GList *columns;
    gboolean hide_menu_column;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER(" ");
 
    /* Update the view and saved state */
    columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
    g_list_foreach (columns, (GFunc)gnc_tree_view_update_visibility, view);
    g_list_free (columns);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    if (priv->state_section)
        priv->seen_state_visibility = TRUE;
 
    /* If only the first column is visible, hide the spacer and make that
     * column expand. */
    hide_menu_column = (gnc_tree_view_count_visible_columns (view) == 1);
    column = gtk_tree_view_get_column (GTK_TREE_VIEW(view), 0);
    gtk_tree_view_column_set_expand (column, hide_menu_column);
    gtk_tree_view_column_set_visible (priv->column_menu_column, !hide_menu_column);
 
    LEAVE(" ");
}

gnc_tree_view_expand_columns()

void gnc_tree_view_expand_columns	(	GncTreeView *	view,
		gchar *	first_column_name,
			...
	)

This function set the columns that will be allocated the free space in the view.

Parameters

view	The tree view.
list	of column names.

Definition at line 1433 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GList *columns, *tmp;
    gchar *name, *pref_name;
    va_list args;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
    ENTER(" ");
    va_start (args, first_column_name);
    name = first_column_name;
 
    /* First disable the expand property on all (non-infrastructure) columns. */
    columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
    for (tmp = columns; tmp; tmp = g_list_next (tmp))
    {
        column = tmp->data;
        pref_name = g_object_get_data (G_OBJECT(column), PREF_NAME);
        if (pref_name != NULL)
            gtk_tree_view_column_set_expand (column, FALSE);
    }
    g_list_free(columns);
 
    /* Now enable it on the requested columns. */
    while (name != NULL)
    {
        column = gnc_tree_view_find_column_by_name (view, name);
        if (column != NULL)
        {
            gtk_tree_view_column_set_expand (column, TRUE);
        }
        name = va_arg (args, gchar*);
    }
    va_end (args);
 
    LEAVE(" ");
}

gnc_tree_view_find_column_by_name()

GtkTreeViewColumn * gnc_tree_view_find_column_by_name	(	GncTreeView *	view,
		const gchar *	wanted
	)

Find a tree column given the "pref name" used with saved state.

Find a tree column given the "pref name".

This function simply runs the list of all (visible and invisible) columns looking for a match. Column names were attached to each column at the time the column was created.

Parameters

view	The visible tree widget.
wanted	The "pref name" to find.

Definition at line 538 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column, *found = NULL;
    GList *column_list, *tmp;
    const gchar *name;
 
    // ENTER("view %p, wanted %s", view, wanted);
    column_list = gtk_tree_view_get_columns(GTK_TREE_VIEW(view));
    for (tmp = column_list; tmp; tmp = g_list_next (tmp))
    {
        column = tmp->data;
        name = g_object_get_data (G_OBJECT(column), PREF_NAME);
        if (!name || (strcmp(name, wanted) != 0))
            continue;
        found = column;
        break;
    }
    g_list_free (column_list);
 
    // LEAVE("column %p", found);
    return found;
}

gnc_tree_view_get_show_column_menu()

gboolean gnc_tree_view_get_show_column_menu

(

GncTreeView *

view

)

This function is called to get the current value of the "show-column-menu" property.

It returns the same value passed to gnc_tree_view_set_show_menu_column().

Parameters are defined in gnc-tree-view.h

Definition at line 1562 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), FALSE);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    return (priv->show_column_menu);
}

gnc_tree_view_get_state_section()

const gchar * gnc_tree_view_get_state_section

(

GncTreeView *

view

)

Get the name of the state section this tree view is associated with.

This function is called to get the current association between a saved state section and the display of a view.

It returns the same value passed to gnc_tree_view_set_state_section(); i.e. a string like "dialogs/edit_prices".

Parameters are defined in gnc-tree-view.h

Definition at line 1124 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE (view);
    return priv->state_section;
}

gnc_tree_view_keynav()

void gnc_tree_view_keynav	(	GncTreeView *	view,
		GtkTreeViewColumn **	col,
		GtkTreePath *	path,
		GdkEventKey *	event
	)

Definition at line 2162 of file gnc-tree-view.c.

{
    GtkTreeView *tv = GTK_TREE_VIEW(view);
    gint depth;
    gboolean shifted;
 
    if (event->type != GDK_KEY_PRESS) return;
 
    switch (event->keyval)
    {
    case GDK_KEY_Tab:
    case GDK_KEY_ISO_Left_Tab:
    case GDK_KEY_KP_Tab:
        shifted = event->state & GDK_SHIFT_MASK;
        if (get_column_next_to (tv, col, shifted))
        {
            /* This is the end (or beginning) of the line, buddy. */
            depth = gtk_tree_path_get_depth (path);
            if (shifted)
            {
                if (!gtk_tree_path_prev (path) && depth > 1)
                {
                    gtk_tree_path_up (path);
                }
            }
            else if (gtk_tree_view_row_expanded (tv, path))
            {
                gtk_tree_path_down (path);
            }
            else
            {
                gtk_tree_path_next (path);
                if (!gnc_tree_view_path_is_valid (view, path) && depth > 2)
                {
                    gtk_tree_path_prev (path);
                    gtk_tree_path_up (path);
                    gtk_tree_path_next (path);
                }
                if (!gnc_tree_view_path_is_valid (view, path) && depth > 1)
                {
                    gtk_tree_path_prev (path);
                    gtk_tree_path_up (path);
                    gtk_tree_path_next (path);
                }
            }
        }
        break;
 
    case GDK_KEY_Return:
    case GDK_KEY_KP_Enter:
        if (gtk_tree_view_row_expanded (tv, path))
        {
            gtk_tree_path_down (path);
        }
        else
        {
            depth = gtk_tree_path_get_depth (path);
            gtk_tree_path_next (path);
            if (!gnc_tree_view_path_is_valid (view, path) && depth > 1)
            {
                gtk_tree_path_prev (path);
                gtk_tree_path_up (path);
                gtk_tree_path_next (path);
            }
        }
        break;
    }
    return;
}

gnc_tree_view_path_is_valid()

gboolean gnc_tree_view_path_is_valid	(	GncTreeView *	view,
		GtkTreePath *	path
	)

Definition at line 2151 of file gnc-tree-view.c.

{
    GtkTreeView *tv = GTK_TREE_VIEW(view);
    GtkTreeModel *s_model;
    GtkTreeIter iter;
 
    s_model = gtk_tree_view_get_model (tv);
    return gtk_tree_model_get_iter (s_model, &iter, path);
}

gnc_tree_view_remove_state_information()

void gnc_tree_view_remove_state_information

(

GncTreeView *

view

)

Completely wipe the treeview's state information (column visibility, width, sorting order,..).

This function is called to completely wipe the treeview's state information (column visibility, width, sorting order,..).

This function may be called at any time; either when the user wants to disconnect or when the view object is being destroyed.

Parameters

view	The tree view.

Definition at line 982 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GKeyFile *state_file = gnc_state_get_current ();
 
    ENTER(" ");
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    if (!priv->state_section)
    {
        LEAVE("no state section");
        return;
    }
 
    g_key_file_remove_group (state_file, priv->state_section, NULL);
    g_free (priv->state_section);
    priv->state_section = NULL;
    LEAVE(" ");
}

gnc_tree_view_save_state()

void gnc_tree_view_save_state

(

GncTreeView *

view

)

This function is called to write the treeview's state information (column visibility, width, sorting order,..) to the state file.

Parameters

view	The tree view.

Definition at line 1134 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    ENTER("view %p", view);
    g_return_if_fail (view != NULL);
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    if (priv->state_section)
    {
        /* Save state. Only store non-default values when possible. */
        GList *column_list, *tmp;
        GKeyFile *state_file = gnc_state_get_current();
        gsize num_cols = 0;
        gchar *sort_column = gnc_tree_view_get_sort_column (view);
        gchar *sort_order = gnc_tree_view_get_sort_order (view);
        gchar **col_order = gnc_tree_view_get_column_order (view, &num_cols);
 
        /* Default sort column is the name column */
        if (sort_column && (g_strcmp0 (sort_column, "name") != 0))
            g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, sort_column);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL);
        g_free (sort_column);
 
 
        /* Default sort order is "ascending" */
        if (g_strcmp0 (sort_order, "descending") == 0)
            g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_ORDER, sort_order);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL);
        g_free (sort_order);
 
        if (col_order && (num_cols > 0))
            g_key_file_set_string_list (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER,
                                        (const gchar**) col_order, num_cols);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL);
 
        g_strfreev (col_order);
 
 
        // ENTER("view %p, wanted %s", view, wanted);
        column_list = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
        for (tmp = column_list; tmp; tmp = g_list_next (tmp))
        {
            GtkTreeViewColumn *column = tmp->data;
            gchar *key=NULL;
            const gchar *name = g_object_get_data (G_OBJECT(column), PREF_NAME);
            if (!name)
                continue;
 
            if (!g_object_get_data (G_OBJECT(column), ALWAYS_VISIBLE))
            {
                key = g_strjoin ("_", name, STATE_KEY_SUFF_VISIBLE, NULL);
                g_key_file_set_boolean (state_file, priv->state_section, key,
                                        gtk_tree_view_column_get_visible (column));
                g_free (key);
            }
 
            key = g_strjoin ("_", name, STATE_KEY_SUFF_WIDTH, NULL);
            if (g_object_get_data (G_OBJECT(column), "default-width") &&
                (GPOINTER_TO_INT((g_object_get_data (G_OBJECT(column), "default-width")))
                    != gtk_tree_view_column_get_width (column)))
            {
                g_key_file_set_integer (state_file, priv->state_section, key,
                                        gtk_tree_view_column_get_width (column));
            }
            else if (g_key_file_has_key (state_file, priv->state_section, key, NULL))
                g_key_file_remove_key (state_file, priv->state_section, key, NULL);
            g_free (key);
        }
        g_list_free (column_list);
    }
 
    LEAVE(" ");
}

gnc_tree_view_set_control_column_background()

void gnc_tree_view_set_control_column_background	(	GncTreeView *	view,
		gint	column,
		GtkTreeCellDataFunc	func
	)

This function links the cell backgrounds of the two control columns to a column in the model that has color strings or a cell data function that sets the "cell-background" property.

Parameters

view	The tree view.
column	The column in the model containing color strings.
func	This is a cell data function that sets the "cell-background".

Definition at line 1502 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, column %d, func %p", view, column, func);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    update_control_cell_renderers_background (view, priv->column_menu_column, column, func);
 
    LEAVE(" ");
}

gnc_tree_view_set_editing_finished_cb()

void gnc_tree_view_set_editing_finished_cb	(	GncTreeView *	view,
		GFunc	editing_finished_cb,
		gpointer	editing_cb_data
	)

Setup a callback for when the user finishes editing so appropriate actions can be taken like enable the actions delete menu option.

Definition at line 2248 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    if (!view && !editing_finished_cb)
        return;
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->editing_finished_cb = editing_finished_cb;
    priv->editing_cb_data = editing_cb_data;
}

gnc_tree_view_set_editing_started_cb()

void gnc_tree_view_set_editing_started_cb	(	GncTreeView *	view,
		GFunc	editing_started_cb,
		gpointer	editing_cb_data
	)

Setup a callback for when the user starts editing so appropriate actions can be taken like disable the actions delete menu option.

Definition at line 2234 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    if (!view && !editing_started_cb)
        return;
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->editing_started_cb = editing_started_cb;
    priv->editing_cb_data = editing_cb_data;
}

gnc_tree_view_set_show_column_menu()

void gnc_tree_view_set_show_column_menu	(	GncTreeView *	view,
		gboolean	visible
	)

This function is called to set the "show-column-menu" property on this view.

This function has no visible effect if the "state-section" property has not been set.

Parameters are defined in gnc-tree-view.h

Definition at line 1541 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, show menu %d", view, visible);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    priv->show_column_menu = visible;
    gnc_tree_view_build_column_menu (view);
    LEAVE(" ");
}

gnc_tree_view_set_sort_user_data()

void gnc_tree_view_set_sort_user_data	(	GncTreeView *	view,
		GtkTreeModel *	s_model
	)

This allows the columns to be setup without the model connected.

Parameters

view	The tree view.
sort	model.

Definition at line 1520 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, sort_model %p", view, s_model);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->sort_model = s_model;
    LEAVE(" ");
}

gnc_tree_view_set_state_section()

void gnc_tree_view_set_state_section	(	GncTreeView *	view,
		const gchar *	section
	)

Set up or remove an association between a saved state section and the display of a view.

This function is called to set up or remove an association between a saved state section and the display of a view.

It will first remove any existing association, and then install the new one. If the new section has state information, update the view with this information.

Parameters are defined in gnc-tree-view.h

Definition at line 1009 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GKeyFile *state_file;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, section %s", view, section);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    /* Drop any previous state section */
    if (priv->state_section)
        gnc_tree_view_remove_state_information (view);
 
    if (!section)
    {
        LEAVE("cleared state section");
        return;
    }
 
    /* Catch changes in state. Propagate to view. */
    priv->state_section = g_strdup (section);
 
    state_file = gnc_state_get_current ();
    if (g_key_file_has_group (state_file, priv->state_section))
    {
        gsize num_keys, idx;
        gchar **keys = g_key_file_get_keys (state_file, priv->state_section, &num_keys, NULL);
        for (idx = 0; idx < num_keys; idx++)
        {
            gchar *key = keys[idx];
            if (g_strcmp0 (key, STATE_KEY_SORT_COLUMN) == 0)
            {
                gchar *name = g_key_file_get_string (state_file, priv->state_section,
                                                     key, NULL);
                gnc_tree_view_set_sort_column (view, name);
                g_free (name);
            }
            else if (g_strcmp0 (key, STATE_KEY_SORT_ORDER) == 0)
            {
                gchar *name = g_key_file_get_string (state_file, priv->state_section,
                                                     key, NULL);
                gnc_tree_view_set_sort_order (view, name);
                g_free (name);
            }
            else if (g_strcmp0 (key, STATE_KEY_COLUMN_ORDER) == 0)
            {
                gsize length;
                gchar **columns = g_key_file_get_string_list (state_file, priv->state_section,
                                                              key, &length, NULL);
                gnc_tree_view_set_column_order (view, columns, length);
                g_strfreev (columns);
            }
            else
            {
                /* Make a copy of the local part of the key so it can be split
                 * into column name and key type */
                gboolean known = FALSE;
                gchar *column_name = g_strdup (key);
                gchar *type_name = g_strrstr (column_name, "_");
 
                if (type_name != NULL) //guard against not finding '_'
                {
                    *type_name++ = '\0';
 
                    if (g_strcmp0 (type_name, STATE_KEY_SUFF_VISIBLE) == 0)
                    {
                        GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
                        if (column)
                        {
                            known = TRUE;
                            if (!g_object_get_data (G_OBJECT (column), ALWAYS_VISIBLE))
                            {
                                gtk_tree_view_column_set_visible (column,
                                                                  g_key_file_get_boolean (state_file, priv->state_section, key, NULL));
                            }
                        }
                    }
                    else if (g_strcmp0 (type_name, STATE_KEY_SUFF_WIDTH) == 0)
                    {
                        gint width = g_key_file_get_integer (state_file, priv->state_section, key, NULL);
                        GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
                        if (column)
                        {
                            known = TRUE;
                            if (width && (width != gtk_tree_view_column_get_width (column)))
                            {
                                gtk_tree_view_column_set_fixed_width (column, width);
                            }
                        }
                    }
                    if (!known)
                        DEBUG ("Ignored key %s", key);
 
                    g_free (column_name);
                }
            }
        }
        g_strfreev (keys);
    }
 
    /* Rebuild the column visibility menu */
    gnc_tree_view_build_column_menu (view);
    LEAVE ("set state section");
}

tree_view_column_set_default_width()

void tree_view_column_set_default_width	(	GtkTreeView *	view,
		GtkTreeViewColumn *	column,
		const gchar *	sizing_text
	)

Set default width for a treeview column.

This base width is the largest of the column title and some arbitrary text passed in via sizing_text. This base width is then increased with some padding.

Definition at line 43 of file tree-view-utils.c.

{
    PangoLayout* layout;
    int default_width, title_width;
    const gchar *column_title;
 
    /* Default size is the larger of the column title and the sizing text */
    column_title = gtk_tree_view_column_get_title (column);
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
    pango_layout_get_pixel_size(layout, &title_width, NULL);
    g_object_unref(layout);
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
    pango_layout_get_pixel_size(layout, &default_width, NULL);
    g_object_unref(layout);
    default_width = MAX(default_width, title_width);
    if (default_width)
    {
        default_width += 10; /* add some padding */
        g_object_set(G_OBJECT(column),
                     "sizing",      GTK_TREE_VIEW_COLUMN_FIXED,
                     "fixed-width", default_width,
                     NULL);
    }
}