GnuCash  4.12-75-g66025ae738+
Files | Data Structures | Macros | Enumerations | Functions
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.
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
GtkTreeViewColumn * gnc_tree_view_add_date_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 date column to a GncTreeView base view. More...
 
GtkTreeViewColumn * gnc_tree_view_add_combo_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeModel *combo_tree_model, gint combo_model_text_column, GtkTreeIterCompareFunc column_sort_fn)
 This function adds a new combobox column to a GncTreeView base view. More...
 
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. More...
 
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. More...
 
gint gnc_tree_view_append_column (GncTreeView *view, GtkTreeViewColumn *column)
 Add a column to a view based upon a GncTreeView. More...
 
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. More...
 

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. More...
 

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,..). More...
 
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. More...
 
const gchar * gnc_tree_view_get_state_section (GncTreeView *view)
 Get the name of the state section this tree view is associated with. More...
 
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. More...
 

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. More...
 
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. More...
 
void gnc_tree_view_set_sort_user_data (GncTreeView *view, GtkTreeModel *s_model)
 This allows the columns to be setup without the model connected. More...
 
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. More...
 
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. More...
 

Detailed Description

Function Documentation

◆ gnc_tree_view_add_combo_column()

GtkTreeViewColumn* gnc_tree_view_add_combo_column ( GncTreeView view,
const gchar *  column_title,
const gchar *  pref_name,
const gchar *  sizing_text,
gint  model_data_column,
gint  model_visibility_column,
GtkTreeModel *  combo_tree_model,
gint  combo_model_text_column,
GtkTreeIterCompareFunc  column_sort_fn 
)

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

The parameters it takes in common with gnc_tree_view_add_text_column() behave the same as there. In addition, it will use combo_tree_model as the GtkTreeModel for the combobox, and combo_model_text_column will be the column in the model used for displaying the text in the combobox.

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

2037 {
2038  GtkTreeViewColumn *column;
2039  GtkCellRenderer *renderer;
2040  PangoLayout* layout;
2041  int default_width, title_width;
2042 
2043  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
2044 
2045  column = gtk_tree_view_column_new ();
2046  gtk_tree_view_column_set_title (column, gettext(column_title));
2047 
2048  /* Set up a renderer and attributes */
2049  renderer = gtk_cell_renderer_combo_new ();
2050  gtk_tree_view_column_pack_start (column, renderer, TRUE);
2051 
2052  /* Set renderer attributes controlled by the model */
2053  if (model_data_column != GNC_TREE_VIEW_COLUMN_DATA_NONE)
2054  gtk_tree_view_column_add_attribute (column, renderer,
2055  "text", model_data_column);
2056  if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
2057  gtk_tree_view_column_add_attribute (column, renderer,
2058  "visible", model_visibility_column);
2059 
2060  /* Default size is the larger of the column title and the sizing text */
2061  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
2062  pango_layout_get_pixel_size (layout, &title_width, NULL);
2063  g_object_unref (layout);
2064  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
2065  pango_layout_get_pixel_size (layout, &default_width, NULL);
2066  g_object_unref (layout);
2067  default_width = MAX(default_width, title_width);
2068  if (default_width)
2069  default_width += 10; /* padding on either side */
2070 
2071  gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
2072  default_width, TRUE, column_sort_fn);
2073 
2074  /* Stuff specific to combo */
2075  if (combo_tree_model)
2076  {
2077  g_object_set (G_OBJECT(renderer), "model", combo_tree_model,
2078  "text-column", combo_model_text_column, NULL);
2079  }
2080  /* TODO: has-entry? */
2081 
2082  gnc_tree_view_append_column (view, column);
2083  return column;
2084 }
gint gnc_tree_view_append_column(GncTreeView *view, GtkTreeViewColumn *column)
Add a column to a view based upon a GncTreeView.

◆ gnc_tree_view_add_date_column()

GtkTreeViewColumn* gnc_tree_view_add_date_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 date 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 1970 of file gnc-tree-view.c.

1978 {
1979  GtkTreeViewColumn *column;
1980  GtkCellRenderer *renderer;
1981  PangoLayout* layout;
1982  int default_width, title_width;
1983 
1984  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
1985 
1986  column = gtk_tree_view_column_new ();
1987  gtk_tree_view_column_set_title (column, column_title);
1988 
1989  /* Set up an icon renderer if requested */
1990  if (icon_name)
1991  {
1992  renderer = gtk_cell_renderer_pixbuf_new ();
1993  g_object_set (renderer, "icon-name", icon_name, NULL);
1994  gtk_tree_view_column_pack_start (column, renderer, FALSE);
1995  }
1996 
1997  /* Set up a text renderer and attributes */
1998  renderer = gnc_cell_renderer_date_new (TRUE);
1999  gtk_tree_view_column_pack_start (column, renderer, TRUE);
2000 
2001  /* Set renderer attributes controlled by the model */
2002  if (model_data_column != GNC_TREE_VIEW_COLUMN_DATA_NONE)
2003  gtk_tree_view_column_add_attribute (column, renderer,
2004  "text", model_data_column);
2005  if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
2006  gtk_tree_view_column_add_attribute (column, renderer,
2007  "visible", model_visibility_column);
2008 
2009  /* Default size is the larger of the column title and the sizing text */
2010  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
2011  pango_layout_get_pixel_size (layout, &title_width, NULL);
2012  g_object_unref (layout);
2013  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
2014  pango_layout_get_pixel_size (layout, &default_width, NULL);
2015  g_object_unref (layout);
2016  default_width = MAX(default_width, title_width);
2017  if (default_width)
2018  default_width += 10; /* padding on either side */
2019  gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
2020  default_width, TRUE, column_sort_fn);
2021 
2022  gnc_tree_view_append_column (view, column);
2023  return column;
2024 }
gint gnc_tree_view_append_column(GncTreeView *view, GtkTreeViewColumn *column)
Add a column to a view based upon a GncTreeView.

◆ 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 2114 of file gnc-tree-view.c.

2122 {
2123  GtkTreeViewColumn *column;
2124  GtkCellRenderer *renderer;
2125  gfloat alignment = 1.0;
2126 
2127  column = gnc_tree_view_add_text_column (view, column_title, pref_name,
2128  NULL, sizing_text, model_data_column,
2129  model_visibility_column,
2130  column_sort_fn);
2131 
2132  renderer = gnc_tree_view_column_get_renderer (column);
2133 
2134  /* Right align the column title and data for both ltr and rtl */
2135  if (gtk_widget_get_direction (GTK_WIDGET(view)) == GTK_TEXT_DIR_RTL)
2136  alignment = 0.0;
2137 
2138  g_object_set (G_OBJECT(column), "alignment", alignment, NULL);
2139  g_object_set (G_OBJECT(renderer), "xalign", alignment, NULL);
2140 
2141  /* Change the text color */
2142  if (model_color_column != GNC_TREE_VIEW_COLUMN_COLOR_NONE)
2143  gtk_tree_view_column_add_attribute (column, renderer,
2144  "foreground", model_color_column);
2145 
2146  return column;
2147 }
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 conveni...
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.

◆ 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 1905 of file gnc-tree-view.c.

1913 {
1914  GtkCellRenderer *renderer;
1915 
1916  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
1917 
1918  renderer = gtk_cell_renderer_text_new ();
1919 
1920  return add_text_column_variant (view, renderer,
1921  column_title, pref_name,
1922  icon_name, sizing_text,
1923  model_data_column,
1924  model_visibility_column,
1925  column_sort_fn);
1926 }

◆ 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 1937 of file gnc-tree-view.c.

1945 {
1946  GtkCellRenderer *renderer;
1947 
1948  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
1949 
1950  renderer = gnc_cell_renderer_text_view_new ();
1951 
1952  return add_text_column_variant (view, renderer,
1953  column_title, pref_name,
1954  icon_name, sizing_text,
1955  model_data_column,
1956  model_visibility_column,
1957  column_sort_fn);
1958 }

◆ 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 1752 of file gnc-tree-view.c.

1760 {
1761  GtkTreeViewColumn *column;
1762  GtkCellRenderer *renderer;
1763 
1764  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
1765 
1766  renderer = gtk_cell_renderer_toggle_new ();
1767  if (!toggle_edited_cb)
1768  {
1769  gtk_cell_renderer_toggle_set_activatable (GTK_CELL_RENDERER_TOGGLE(renderer), FALSE);
1770  }
1771  column =
1772  gtk_tree_view_column_new_with_attributes (column_short_title,
1773  renderer,
1774  "active", model_data_column,
1775  NULL);
1776 
1777  /* Add the full title to the object for menu creation */
1778  g_object_set_data_full (G_OBJECT(column), REAL_TITLE,
1779  g_strdup(column_title), g_free);
1780  if (toggle_edited_cb)
1781  g_signal_connect (G_OBJECT(renderer), "toggled",
1782  G_CALLBACK(toggle_edited_cb), view);
1783 
1784  if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
1785  gtk_tree_view_column_add_attribute (column, renderer,
1786  "visible", model_visibility_column);
1787 
1788 
1789  gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
1790  0, FALSE, column_sort_fn);
1791 
1792  gnc_tree_view_append_column (view, column);
1793 
1794  /* Also add the full title to the object as a tooltip */
1795  gtk_widget_set_tooltip_text (gtk_tree_view_column_get_button (column), column_title);
1796 
1797  return column;
1798 }
gint gnc_tree_view_append_column(GncTreeView *view, GtkTreeViewColumn *column)
Add a column to a view based upon a GncTreeView.

◆ 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 2158 of file gnc-tree-view.c.

2160 {
2161  int n = gtk_tree_view_get_n_columns (GTK_TREE_VIEW(view));
2162 
2163  /* Ignore the initial column, the selection menu */
2164  if (n >= 1)
2165  n -= 1;
2166  return gtk_tree_view_insert_column (GTK_TREE_VIEW(view), column, n);
2167 }

◆ 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
columnThe tree view column that was added to the GncTreeView
Returns
The cell renderer in use in the column.

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

2088 {
2089  GList *renderers;
2090  GtkCellRenderer *cr = NULL;
2091 
2092  g_return_val_if_fail (GTK_TREE_VIEW_COLUMN(column), NULL);
2093 
2094  /* Get the list of one renderer */
2095  renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT(column));
2096  if (g_list_length (renderers) > 0)
2097  cr = GTK_CELL_RENDERER(renderers->data);
2098  g_list_free (renderers);
2099 
2100  return cr;
2101 }

◆ 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
viewA pointer to an gnc tree view.

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

1583 {
1584  GncTreeViewPrivate *priv;
1585  GtkTreeViewColumn *column;
1586  GList *columns;
1587  gboolean hide_menu_column;
1588 
1589  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1590 
1591  ENTER(" ");
1592 
1593  /* Update the view and saved state */
1594  columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
1595  g_list_foreach (columns, (GFunc)gnc_tree_view_update_visibility, view);
1596  g_list_free (columns);
1597 
1598  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1599  if (priv->state_section)
1600  priv->seen_state_visibility = TRUE;
1601 
1602  /* If only the first column is visible, hide the spacer and make that
1603  * column expand. */
1604  hide_menu_column = (gnc_tree_view_count_visible_columns (view) == 1);
1605  column = gtk_tree_view_get_column (GTK_TREE_VIEW(view), 0);
1606  gtk_tree_view_column_set_expand (column, hide_menu_column);
1607  gtk_tree_view_column_set_visible (priv->column_menu_column, !hide_menu_column);
1608 
1609  LEAVE(" ");
1610 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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
viewThe tree view.
listof column names.

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

1415 {
1416  GncTreeViewPrivate *priv;
1417  GtkTreeViewColumn *column;
1418  gboolean hide_spacer;
1419  GList *columns, *tmp;
1420  gchar *name, *pref_name;
1421  va_list args;
1422 
1423  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1424  ENTER(" ");
1425  va_start (args, first_column_name);
1426  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1427  name = first_column_name;
1428  hide_spacer = FALSE;
1429 
1430  /* First disable the expand property on all (non-infrastructure) columns. */
1431  columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
1432  for (tmp = columns; tmp; tmp = g_list_next (tmp))
1433  {
1434  column = tmp->data;
1435  pref_name = g_object_get_data (G_OBJECT(column), PREF_NAME);
1436  if (pref_name != NULL)
1437  gtk_tree_view_column_set_expand (column, FALSE);
1438  }
1439  g_list_free(columns);
1440 
1441  /* Now enable it on the requested columns. */
1442  while (name != NULL)
1443  {
1444  column = gnc_tree_view_find_column_by_name (view, name);
1445  if (column != NULL)
1446  {
1447  gtk_tree_view_column_set_expand (column, TRUE);
1448  hide_spacer = TRUE;
1449  }
1450  name = va_arg (args, gchar*);
1451  }
1452  va_end (args);
1453 
1454  LEAVE(" ");
1455 }
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.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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
viewThe visible tree widget.
wantedThe "pref name" to find.

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

536 {
537  GtkTreeViewColumn *column, *found = NULL;
538  GList *column_list, *tmp;
539  const gchar *name;
540 
541  // ENTER("view %p, wanted %s", view, wanted);
542  column_list = gtk_tree_view_get_columns(GTK_TREE_VIEW(view));
543  for (tmp = column_list; tmp; tmp = g_list_next (tmp))
544  {
545  column = tmp->data;
546  name = g_object_get_data (G_OBJECT(column), PREF_NAME);
547  if (!name || (strcmp(name, wanted) != 0))
548  continue;
549  found = column;
550  break;
551  }
552  g_list_free (column_list);
553 
554  // LEAVE("column %p", found);
555  return found;
556 }

◆ 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 1546 of file gnc-tree-view.c.

1547 {
1548  GncTreeViewPrivate *priv;
1549 
1550  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), FALSE);
1551 
1552  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1553  return (priv->show_column_menu);
1554 }
Private Data Structure.

◆ 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 1120 of file gnc-tree-view.c.

1121 {
1122  GncTreeViewPrivate *priv;
1123 
1124  g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
1125 
1126  priv = GNC_TREE_VIEW_GET_PRIVATE (view);
1127  return priv->state_section;
1128 }
Private Data Structure.

◆ 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
viewThe tree view.

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

979 {
980  GncTreeViewPrivate *priv;
981  GKeyFile *state_file = gnc_state_get_current ();
982 
983  ENTER(" ");
984  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
985  if (!priv->state_section)
986  {
987  LEAVE("no state section");
988  return;
989  }
990 
991  g_key_file_remove_group (state_file, priv->state_section, NULL);
992  g_free (priv->state_section);
993  priv->state_section = NULL;
994  LEAVE(" ");
995 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
GKeyFile * gnc_state_get_current(void)
Returns a pointer to the most recently loaded state.
Definition: gnc-state.c:248
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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
viewThe tree view.

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

1131 {
1132  GncTreeViewPrivate *priv;
1133 
1134  ENTER("view %p", view);
1135  g_return_if_fail (view != NULL);
1136  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1137 
1138  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1139 
1140  if (priv->state_section)
1141  {
1142  /* Save state. Only store non-default values when possible. */
1143  GList *column_list, *tmp;
1144  GKeyFile *state_file = gnc_state_get_current();
1145  gsize num_cols = 0;
1146  gchar *sort_column = gnc_tree_view_get_sort_column (view);
1147  gchar *sort_order = gnc_tree_view_get_sort_order (view);
1148  gchar **col_order = gnc_tree_view_get_column_order (view, &num_cols);
1149 
1150  /* Default sort column is the name column */
1151  if (sort_column && (g_strcmp0 (sort_column, "name") != 0))
1152  g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, sort_column);
1153  else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL))
1154  g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL);
1155  g_free (sort_column);
1156 
1157 
1158  /* Default sort order is "ascending" */
1159  if (g_strcmp0 (sort_order, "descending") == 0)
1160  g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_ORDER, sort_order);
1161  else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL))
1162  g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL);
1163  g_free (sort_order);
1164 
1165  if (col_order && (num_cols > 0))
1166  g_key_file_set_string_list (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER,
1167  (const gchar**) col_order, num_cols);
1168  else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL))
1169  g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL);
1170 
1171  g_strfreev (col_order);
1172 
1173 
1174  // ENTER("view %p, wanted %s", view, wanted);
1175  column_list = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
1176  for (tmp = column_list; tmp; tmp = g_list_next (tmp))
1177  {
1178  GtkTreeViewColumn *column = tmp->data;
1179  gchar *key=NULL;
1180  const gchar *name = g_object_get_data (G_OBJECT(column), PREF_NAME);
1181  if (!name)
1182  continue;
1183 
1184  if (!g_object_get_data (G_OBJECT(column), ALWAYS_VISIBLE))
1185  {
1186  key = g_strjoin ("_", name, STATE_KEY_SUFF_VISIBLE, NULL);
1187  g_key_file_set_boolean (state_file, priv->state_section, key,
1188  gtk_tree_view_column_get_visible (column));
1189  g_free (key);
1190  }
1191 
1192  key = g_strjoin ("_", name, STATE_KEY_SUFF_WIDTH, NULL);
1193  if (g_object_get_data (G_OBJECT(column), "default-width") &&
1194  (GPOINTER_TO_INT((g_object_get_data (G_OBJECT(column), "default-width")))
1195  != gtk_tree_view_column_get_width (column)))
1196  {
1197  g_key_file_set_integer (state_file, priv->state_section, key,
1198  gtk_tree_view_column_get_width (column));
1199  }
1200  else if (g_key_file_has_key (state_file, priv->state_section, key, NULL))
1201  g_key_file_remove_key (state_file, priv->state_section, key, NULL);
1202  g_free (key);
1203  }
1204  g_list_free (column_list);
1205  }
1206 
1207  LEAVE(" ");
1208 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
GKeyFile * gnc_state_get_current(void)
Returns a pointer to the most recently loaded state.
Definition: gnc-state.c:248
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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
viewThe tree view.
columnThe column in the model containing color strings.
funcThis is a cell data function that sets the "cell-background".

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

1487 {
1488  GncTreeViewPrivate *priv;
1489 
1490  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1491 
1492  ENTER("view %p, column %d, func %p", view, column, func);
1493  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1494 
1495  update_control_cell_renderers_background (view, priv->column_menu_column, column, func);
1496 
1497  LEAVE(" ");
1498 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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 1525 of file gnc-tree-view.c.

1527 {
1528  GncTreeViewPrivate *priv;
1529 
1530  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1531 
1532  ENTER("view %p, show menu %d", view, visible);
1533  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1534  priv->show_column_menu = visible;
1535  gnc_tree_view_build_column_menu (view);
1536  LEAVE(" ");
1537 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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
viewThe tree view.
sortmodel.

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

1505 {
1506  GncTreeViewPrivate *priv;
1507 
1508  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1509 
1510  ENTER("view %p, sort_model %p", view, s_model);
1511  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1512 
1513  priv->sort_model = s_model;
1514  LEAVE(" ");
1515 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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 1005 of file gnc-tree-view.c.

1007 {
1008  GncTreeViewPrivate *priv;
1009  GKeyFile *state_file;
1010 
1011  g_return_if_fail (GNC_IS_TREE_VIEW(view));
1012 
1013  ENTER("view %p, section %s", view, section);
1014 
1015  priv = GNC_TREE_VIEW_GET_PRIVATE(view);
1016 
1017  /* Drop any previous state section */
1018  if (priv->state_section)
1020 
1021  if (!section)
1022  {
1023  LEAVE("cleared state section");
1024  return;
1025  }
1026 
1027  /* Catch changes in state. Propagate to view. */
1028  priv->state_section = g_strdup (section);
1029 
1030  state_file = gnc_state_get_current ();
1031  if (g_key_file_has_group (state_file, priv->state_section))
1032  {
1033  gsize num_keys, idx;
1034  gchar **keys = g_key_file_get_keys (state_file, priv->state_section, &num_keys, NULL);
1035  for (idx = 0; idx < num_keys; idx++)
1036  {
1037  gchar *key = keys[idx];
1038  if (g_strcmp0 (key, STATE_KEY_SORT_COLUMN) == 0)
1039  {
1040  gchar *name = g_key_file_get_string (state_file, priv->state_section,
1041  key, NULL);
1042  gnc_tree_view_set_sort_column (view, name);
1043  g_free (name);
1044  }
1045  else if (g_strcmp0 (key, STATE_KEY_SORT_ORDER) == 0)
1046  {
1047  gchar *name = g_key_file_get_string (state_file, priv->state_section,
1048  key, NULL);
1049  gnc_tree_view_set_sort_order (view, name);
1050  g_free (name);
1051  }
1052  else if (g_strcmp0 (key, STATE_KEY_COLUMN_ORDER) == 0)
1053  {
1054  gsize length;
1055  gchar **columns = g_key_file_get_string_list (state_file, priv->state_section,
1056  key, &length, NULL);
1057  gnc_tree_view_set_column_order (view, columns, length);
1058  g_strfreev (columns);
1059  }
1060  else
1061  {
1062  /* Make a copy of the local part of the key so it can be split
1063  * into column name and key type */
1064  gboolean known = FALSE;
1065  gchar *column_name = g_strdup (key);
1066  gchar *type_name = g_strrstr (column_name, "_");
1067 
1068  if (type_name != NULL) //guard against not finding '_'
1069  {
1070  *type_name++ = '\0';
1071 
1072  if (g_strcmp0 (type_name, STATE_KEY_SUFF_VISIBLE) == 0)
1073  {
1074  GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
1075  if (column)
1076  {
1077  known = TRUE;
1078  if (!g_object_get_data (G_OBJECT (column), ALWAYS_VISIBLE))
1079  {
1080  gtk_tree_view_column_set_visible (column,
1081  g_key_file_get_boolean (state_file, priv->state_section, key, NULL));
1082  }
1083  }
1084  }
1085  else if (g_strcmp0 (type_name, STATE_KEY_SUFF_WIDTH) == 0)
1086  {
1087  gint width = g_key_file_get_integer (state_file, priv->state_section, key, NULL);
1088  GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
1089  if (column)
1090  {
1091  known = TRUE;
1092  if (width && (width != gtk_tree_view_column_get_width (column)))
1093  {
1094  gtk_tree_view_column_set_fixed_width (column, width);
1095  }
1096  }
1097  }
1098  if (!known)
1099  DEBUG ("Ignored key %s", key);
1100 
1101  g_free (column_name);
1102  }
1103  }
1104  }
1105  g_strfreev (keys);
1106  }
1107 
1108  /* Rebuild the column visibility menu */
1109  gnc_tree_view_build_column_menu (view);
1110  LEAVE ("set state section");
1111 }
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:264
void gnc_tree_view_remove_state_information(GncTreeView *view)
Completely wipe the treeview&#39;s state information (column visibility, width, sorting order...
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.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
GKeyFile * gnc_state_get_current(void)
Returns a pointer to the most recently loaded state.
Definition: gnc-state.c:248
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
Private Data Structure.

◆ 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.

46 {
47  PangoLayout* layout;
48  int default_width, title_width;
49  const gchar *column_title;
50 
51  /* Default size is the larger of the column title and the sizing text */
52  column_title = gtk_tree_view_column_get_title (column);
53  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
54  pango_layout_get_pixel_size(layout, &title_width, NULL);
55  g_object_unref(layout);
56  layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
57  pango_layout_get_pixel_size(layout, &default_width, NULL);
58  g_object_unref(layout);
59  default_width = MAX(default_width, title_width);
60  if (default_width)
61  {
62  default_width += 10; /* add some padding */
63  g_object_set(G_OBJECT(column),
64  "sizing", GTK_TREE_VIEW_COLUMN_FIXED,
65  "fixed-width", default_width,
66  NULL);
67  }
68 }