GtkTreeView

GtkTreeView — A widget for displaying both trees and lists

Synopsis


#include <gtk/gtk.h>

                    GtkTreeView;
enum                GtkTreeViewDropPosition;
                    GtkTreeViewPrivate;
gboolean            (*GtkTreeViewColumnDropFunc)        (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         GtkTreeViewColumn *prev_column,
                                                         GtkTreeViewColumn *next_column,
                                                         gpointer data);
void                (*GtkTreeViewMappingFunc)           (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         gpointer user_data);
gboolean            (*GtkTreeViewSearchEqualFunc)       (GtkTreeModel *model,
                                                         gint column,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer search_data);
GtkWidget*          gtk_tree_view_new                   (void);
gint                gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);
gboolean            gtk_tree_view_get_show_expanders    (GtkTreeView *tree_view);
void                gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
                                                         gint indentation);
void                gtk_tree_view_set_show_expanders    (GtkTreeView *tree_view,
                                                         gboolean enabled);
GtkWidget*          gtk_tree_view_new_with_model        (GtkTreeModel *model);
GtkTreeModel*       gtk_tree_view_get_model             (GtkTreeView *tree_view);
void                gtk_tree_view_set_model             (GtkTreeView *tree_view,
                                                         GtkTreeModel *model);
GtkTreeSelection*   gtk_tree_view_get_selection         (GtkTreeView *tree_view);
GtkAdjustment*      gtk_tree_view_get_hadjustment       (GtkTreeView *tree_view);
void                gtk_tree_view_set_hadjustment       (GtkTreeView *tree_view,
                                                         GtkAdjustment *adjustment);
GtkAdjustment*      gtk_tree_view_get_vadjustment       (GtkTreeView *tree_view);
void                gtk_tree_view_set_vadjustment       (GtkTreeView *tree_view,
                                                         GtkAdjustment *adjustment);
gboolean            gtk_tree_view_get_headers_visible   (GtkTreeView *tree_view);
void                gtk_tree_view_set_headers_visible   (GtkTreeView *tree_view,
                                                         gboolean headers_visible);
void                gtk_tree_view_columns_autosize      (GtkTreeView *tree_view);
gboolean            gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);
void                gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
                                                         gboolean setting);
void                gtk_tree_view_set_rules_hint        (GtkTreeView *tree_view,
                                                         gboolean setting);
gboolean            gtk_tree_view_get_rules_hint        (GtkTreeView *tree_view);
gint                gtk_tree_view_append_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);
gint                gtk_tree_view_remove_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);
gint                gtk_tree_view_insert_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         gint position);
gint                gtk_tree_view_insert_column_with_attributes
                                                        (GtkTreeView *tree_view,
                                                         gint position,
                                                         const gchar *title,
                                                         GtkCellRenderer *cell,
                                                         ...);
gint                gtk_tree_view_insert_column_with_data_func
                                                        (GtkTreeView *tree_view,
                                                         gint position,
                                                         const gchar *title,
                                                         GtkCellRenderer *cell,
                                                         GtkTreeCellDataFunc func,
                                                         gpointer data,
                                                         GDestroyNotify dnotify);
GtkTreeViewColumn*  gtk_tree_view_get_column            (GtkTreeView *tree_view,
                                                         gint n);
GList*              gtk_tree_view_get_columns           (GtkTreeView *tree_view);
void                gtk_tree_view_move_column_after     (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         GtkTreeViewColumn *base_column);
void                gtk_tree_view_set_expander_column   (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);
GtkTreeViewColumn*  gtk_tree_view_get_expander_column   (GtkTreeView *tree_view);
void                gtk_tree_view_set_column_drag_function
                                                        (GtkTreeView *tree_view,
                                                         GtkTreeViewColumnDropFunc func,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy);
void                gtk_tree_view_scroll_to_point       (GtkTreeView *tree_view,
                                                         gint tree_x,
                                                         gint tree_y);
void                gtk_tree_view_scroll_to_cell        (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column,
                                                         gboolean use_align,
                                                         gfloat row_align,
                                                         gfloat col_align);
void                gtk_tree_view_set_cursor            (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *focus_column,
                                                         gboolean start_editing);
void                gtk_tree_view_set_cursor_on_cell    (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *focus_column,
                                                         GtkCellRenderer *focus_cell,
                                                         gboolean start_editing);
void                gtk_tree_view_get_cursor            (GtkTreeView *tree_view,
                                                         GtkTreePath **path,
                                                         GtkTreeViewColumn **focus_column);
void                gtk_tree_view_row_activated         (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column);
void                gtk_tree_view_expand_all            (GtkTreeView *tree_view);
void                gtk_tree_view_collapse_all          (GtkTreeView *tree_view);
void                gtk_tree_view_expand_to_path        (GtkTreeView *tree_view,
                                                         GtkTreePath *path);
gboolean            gtk_tree_view_expand_row            (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         gboolean open_all);
gboolean            gtk_tree_view_collapse_row          (GtkTreeView *tree_view,
                                                         GtkTreePath *path);
void                gtk_tree_view_map_expanded_rows     (GtkTreeView *tree_view,
                                                         GtkTreeViewMappingFunc func,
                                                         gpointer data);
gboolean            gtk_tree_view_row_expanded          (GtkTreeView *tree_view,
                                                         GtkTreePath *path);
void                gtk_tree_view_set_reorderable       (GtkTreeView *tree_view,
                                                         gboolean reorderable);
gboolean            gtk_tree_view_get_reorderable       (GtkTreeView *tree_view);
gboolean            gtk_tree_view_get_path_at_pos       (GtkTreeView *tree_view,
                                                         gint x,
                                                         gint y,
                                                         GtkTreePath **path,
                                                         GtkTreeViewColumn **column,
                                                         gint *cell_x,
                                                         gint *cell_y);
void                gtk_tree_view_get_cell_area         (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column,
                                                         GdkRectangle *rect);
void                gtk_tree_view_get_background_area   (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column,
                                                         GdkRectangle *rect);
void                gtk_tree_view_get_visible_rect      (GtkTreeView *tree_view,
                                                         GdkRectangle *visible_rect);
gboolean            gtk_tree_view_get_visible_range     (GtkTreeView *tree_view,
                                                         GtkTreePath **start_path,
                                                         GtkTreePath **end_path);
GdkWindow*          gtk_tree_view_get_bin_window        (GtkTreeView *tree_view);
void                gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
                                                         gint wx,
                                                         gint wy,
                                                         gint *tx,
                                                         gint *ty);
void                gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
                                                         gint tx,
                                                         gint ty,
                                                         gint *wx,
                                                         gint *wy);
void                gtk_tree_view_convert_bin_window_to_tree_coords
                                                        (GtkTreeView *tree_view,
                                                         gint bx,
                                                         gint by,
                                                         gint *tx,
                                                         gint *ty);
void                gtk_tree_view_convert_bin_window_to_widget_coords
                                                        (GtkTreeView *tree_view,
                                                         gint bx,
                                                         gint by,
                                                         gint *wx,
                                                         gint *wy);
void                gtk_tree_view_convert_tree_to_bin_window_coords
                                                        (GtkTreeView *tree_view,
                                                         gint tx,
                                                         gint ty,
                                                         gint *bx,
                                                         gint *by);
void                gtk_tree_view_convert_tree_to_widget_coords
                                                        (GtkTreeView *tree_view,
                                                         gint tx,
                                                         gint ty,
                                                         gint *wx,
                                                         gint *wy);
void                gtk_tree_view_convert_widget_to_bin_window_coords
                                                        (GtkTreeView *tree_view,
                                                         gint wx,
                                                         gint wy,
                                                         gint *bx,
                                                         gint *by);
void                gtk_tree_view_convert_widget_to_tree_coords
                                                        (GtkTreeView *tree_view,
                                                         gint wx,
                                                         gint wy,
                                                         gint *tx,
                                                         gint *ty);
void                gtk_tree_view_enable_model_drag_dest
                                                        (GtkTreeView *tree_view,
                                                         const GtkTargetEntry *targets,
                                                         gint n_targets,
                                                         GdkDragAction actions);
void                gtk_tree_view_enable_model_drag_source
                                                        (GtkTreeView *tree_view,
                                                         GdkModifierType start_button_mask,
                                                         const GtkTargetEntry *targets,
                                                         gint n_targets,
                                                         GdkDragAction actions);
void                gtk_tree_view_unset_rows_drag_source
                                                        (GtkTreeView *tree_view);
void                gtk_tree_view_unset_rows_drag_dest  (GtkTreeView *tree_view);
void                gtk_tree_view_set_drag_dest_row     (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewDropPosition pos);
void                gtk_tree_view_get_drag_dest_row     (GtkTreeView *tree_view,
                                                         GtkTreePath **path,
                                                         GtkTreeViewDropPosition *pos);
gboolean            gtk_tree_view_get_dest_row_at_pos   (GtkTreeView *tree_view,
                                                         gint drag_x,
                                                         gint drag_y,
                                                         GtkTreePath **path,
                                                         GtkTreeViewDropPosition *pos);
GdkPixmap*          gtk_tree_view_create_row_drag_icon  (GtkTreeView *tree_view,
                                                         GtkTreePath *path);
void                gtk_tree_view_set_enable_search     (GtkTreeView *tree_view,
                                                         gboolean enable_search);
gboolean            gtk_tree_view_get_enable_search     (GtkTreeView *tree_view);
gint                gtk_tree_view_get_search_column     (GtkTreeView *tree_view);
void                gtk_tree_view_set_search_column     (GtkTreeView *tree_view,
                                                         gint column);
GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func
                                                        (GtkTreeView *tree_view);
void                gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
                                                         GtkTreeViewSearchEqualFunc search_equal_func,
                                                         gpointer search_user_data,
                                                         GDestroyNotify search_destroy);
GtkEntry*           gtk_tree_view_get_search_entry      (GtkTreeView *tree_view);
void                gtk_tree_view_set_search_entry      (GtkTreeView *tree_view,
                                                         GtkEntry *entry);
void                (*GtkTreeViewSearchPositionFunc)    (GtkTreeView *tree_view,
                                                         GtkWidget *search_dialog,
                                                         gpointer user_data);
GtkTreeViewSearchPositionFunc gtk_tree_view_get_search_position_func
                                                        (GtkTreeView *tree_view);
void                gtk_tree_view_set_search_position_func
                                                        (GtkTreeView *tree_view,
                                                         GtkTreeViewSearchPositionFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);
gboolean            gtk_tree_view_get_fixed_height_mode (GtkTreeView *tree_view);
void                gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view,
                                                         gboolean enable);
gboolean            gtk_tree_view_get_hover_selection   (GtkTreeView *tree_view);
void                gtk_tree_view_set_hover_selection   (GtkTreeView *tree_view,
                                                         gboolean hover);
gboolean            gtk_tree_view_get_hover_expand      (GtkTreeView *tree_view);
void                gtk_tree_view_set_hover_expand      (GtkTreeView *tree_view,
                                                         gboolean expand);
void                (*GtkTreeDestroyCountFunc)          (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         gint children,
                                                         gpointer user_data);
void                gtk_tree_view_set_destroy_count_func
                                                        (GtkTreeView *tree_view,
                                                         GtkTreeDestroyCountFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);
gboolean            (*GtkTreeViewRowSeparatorFunc)      (GtkTreeModel *model,
                                                         GtkTreeIter *iter,
                                                         gpointer data);
GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func
                                                        (GtkTreeView *tree_view);
void                gtk_tree_view_set_row_separator_func
                                                        (GtkTreeView *tree_view,
                                                         GtkTreeViewRowSeparatorFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);
gboolean            gtk_tree_view_get_rubber_banding    (GtkTreeView *tree_view);
void                gtk_tree_view_set_rubber_banding    (GtkTreeView *tree_view,
                                                         gboolean enable);
gboolean            gtk_tree_view_is_rubber_banding_active
                                                        (GtkTreeView *tree_view);
gboolean            gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view);
void                gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view,
                                                         gboolean enabled);
enum                GtkTreeViewGridLines;
GtkTreeViewGridLines gtk_tree_view_get_grid_lines       (GtkTreeView *tree_view);
void                gtk_tree_view_set_grid_lines        (GtkTreeView *tree_view,
                                                         GtkTreeViewGridLines grid_lines);
void                gtk_tree_view_set_tooltip_row       (GtkTreeView *tree_view,
                                                         GtkTooltip *tooltip,
                                                         GtkTreePath *path);
void                gtk_tree_view_set_tooltip_cell      (GtkTreeView *tree_view,
                                                         GtkTooltip *tooltip,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column,
                                                         GtkCellRenderer *cell);
gboolean            gtk_tree_view_get_tooltip_context   (GtkTreeView *tree_view,
                                                         gint *x,
                                                         gint *y,
                                                         gboolean keyboard_tip,
                                                         GtkTreeModel **model,
                                                         GtkTreePath **path,
                                                         GtkTreeIter *iter);
gint                gtk_tree_view_get_tooltip_column    (GtkTreeView *tree_view);
void                gtk_tree_view_set_tooltip_column    (GtkTreeView *tree_view,
                                                         gint column);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkTreeView

Implemented Interfaces

GtkTreeView implements AtkImplementorIface and GtkBuildable.

Properties

  "action-area-orientation"  GtkOrientation        : Read / Write
  "action-area-visible"      gboolean              : Read / Write
  "enable-grid-lines"        GtkTreeViewGridLines  : Read / Write
  "enable-search"            gboolean              : Read / Write
  "enable-tree-lines"        gboolean              : Read / Write
  "expander-column"          GtkTreeViewColumn*    : Read / Write
  "fixed-height-mode"        gboolean              : Read / Write
  "hadjustment"              GtkAdjustment*        : Read / Write
  "headers-clickable"        gboolean              : Read / Write
  "headers-visible"          gboolean              : Read / Write
  "hildon-ui-mode"           HildonUIMode          : Read / Write
  "hover-expand"             gboolean              : Read / Write
  "hover-selection"          gboolean              : Read / Write
  "level-indentation"        gint                  : Read / Write
  "model"                    GtkTreeModel*         : Read / Write
  "reorderable"              gboolean              : Read / Write
  "rubber-banding"           gboolean              : Read / Write
  "rules-hint"               gboolean              : Read / Write
  "search-column"            gint                  : Read / Write
  "show-expanders"           gboolean              : Read / Write
  "tooltip-column"           gint                  : Read / Write
  "vadjustment"              GtkAdjustment*        : Read / Write

Style Properties

  "allow-rules"              gboolean              : Read
  "even-row-color"           GdkColor*             : Read
  "expander-size"            gint                  : Read
  "grid-line-pattern"        gchar*                : Read
  "grid-line-width"          gint                  : Read
  "horizontal-separator"     gint                  : Read
  "indent-expanders"         gboolean              : Read
  "odd-row-color"            GdkColor*             : Read
  "row-ending-details"       gboolean              : Read
  "row-height"               gint                  : Read
  "separator-height"         gint                  : Read
  "tree-line-pattern"        gchar*                : Read
  "tree-line-width"          gint                  : Read
  "vertical-separator"       gint                  : Read

Signals

  "columns-changed"                                : Run Last
  "cursor-changed"                                 : Run Last
  "expand-collapse-cursor-row"                     : Run Last / Action
  "hildon-row-tapped"                              : Run Last / Action
  "move-cursor"                                    : Run Last / Action
  "row-activated"                                  : Run Last / Action
  "row-collapsed"                                  : Run Last
  "row-expanded"                                   : Run Last
  "row-insensitive"                                : Run Last / Action
  "select-all"                                     : Run Last / Action
  "select-cursor-parent"                           : Run Last / Action
  "select-cursor-row"                              : Run Last / Action
  "set-scroll-adjustments"                         : Run Last / Action
  "start-interactive-search"                       : Run Last / Action
  "test-collapse-row"                              : Run Last
  "test-expand-row"                                : Run Last
  "toggle-cursor-row"                              : Run Last / Action
  "unselect-all"                                   : Run Last / Action

Description

Widget that displays any object that implements the GtkTreeModel interface.

Please refer to the tree widget conceptual overview for an overview of all the objects and data types related to the tree widget and how they work together.

Several different coordinate systems are exposed in the GtkTreeView API. These are:

Widget coordinates -- coordinates relative to the widget (usually widget->window.
Bin window coordinates -- coordinates relative to the window that GtkTreeView renders to.
Tree coordinates -- coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree.

Several functions are available for converting between the different coordinate systems. The most common translations are between widget and bin window coordinates and between bin window and tree coordinates. For the former you can use gtk_tree_view_convert_widget_to_bin_window_coords() (and vice versa), for the latter gtk_tree_view_convert_bin_window_to_tree_coords() (and vice versa).

GtkTreeView as GtkBuildable

The GtkTreeView implementation of the GtkBuildable interface accepts GtkTreeViewColumn objects as <child> elements in UI definitions.

Example 19. A UI definition fragment with GtkTreeView

<object class="GtkTreeView" id="treeview">
  <property name="model">liststore1</property>
  <child>
    <object class="GtkTreeViewColumn" id="test-column">
      <property name="title">Test</property>
      <child>
        <object class="GtkCellRendererText" id="test-renderer"/>
        <attributes>
          <attribute name="text">1</attribute>
        </attributes>
      </child>
    </object>
  </child>
</object>

Details

GtkTreeView

typedef struct _GtkTreeView GtkTreeView;


enum GtkTreeViewDropPosition

typedef enum
{
  /* drop before/after this row */
  GTK_TREE_VIEW_DROP_BEFORE,
  GTK_TREE_VIEW_DROP_AFTER,
  /* drop as a child of this row (with fallback to before or after
   * if into is not possible)
   */
  GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
  GTK_TREE_VIEW_DROP_INTO_OR_AFTER
} GtkTreeViewDropPosition;

An enum for determining where a dropped row goes.

GTK_TREE_VIEW_DROP_BEFORE dropped row is inserted before
GTK_TREE_VIEW_DROP_AFTER dropped row is inserted after
GTK_TREE_VIEW_DROP_INTO_OR_BEFORE dropped row becomes a child or is inserted before
GTK_TREE_VIEW_DROP_INTO_OR_AFTER dropped row becomes a child or is inserted after

GtkTreeViewPrivate

typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;

A private struct for internal use only. The definition of this structure is not publically available.


GtkTreeViewColumnDropFunc ()

gboolean            (*GtkTreeViewColumnDropFunc)        (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         GtkTreeViewColumn *prev_column,
                                                         GtkTreeViewColumn *next_column,
                                                         gpointer data);

Function type for determining whether column can be dropped in a particular spot (as determined by prev_column and next_column). In left to right locales, prev_column is on the left of the potential drop spot, and next_column is on the right. In right to left mode, this is reversed. This function should return TRUE if the spot is a valid drop spot. Please note that returning TRUE does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user.

tree_view : A GtkTreeView
column : The GtkTreeViewColumn being dragged
prev_column : A GtkTreeViewColumn on one side of column
next_column : A GtkTreeViewColumn on the other side of column
data : user data
Returns : TRUE, if column can be dropped in this spot

GtkTreeViewMappingFunc ()

void                (*GtkTreeViewMappingFunc)           (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         gpointer user_data);

Function used for gtk_tree_view_map_expanded_rows.

tree_view : A GtkTreeView
path : The path that's expanded
user_data : user data

GtkTreeViewSearchEqualFunc ()

gboolean            (*GtkTreeViewSearchEqualFunc)       (GtkTreeModel *model,
                                                         gint column,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer search_data);

A function used for checking whether a row in model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp() returning 0 for equal strings.

model : the GtkTreeModel being searched
column : the search column set by gtk_tree_view_set_search_column()
key : the key string to compare with
iter : a GtkTreeIter pointing the row of model that should be compared with key.
search_data : user data from gtk_tree_view_set_search_equal_func()
Returns : FALSE if the row matches, TRUE otherwise.

gtk_tree_view_new ()

GtkWidget*          gtk_tree_view_new                   (void);

Creates a new GtkTreeView widget.

Returns : A newly created GtkTreeView widget.

gtk_tree_view_get_level_indentation ()

gint                gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);

Returns the amount, in pixels, of extra indentation for child levels in tree_view.

tree_view : a GtkTreeView.
Returns : the amount of extra indentation for child levels in tree_view. A return value of 0 means that this feature is disabled.

Since 2.12


gtk_tree_view_get_show_expanders ()

gboolean            gtk_tree_view_get_show_expanders    (GtkTreeView *tree_view);

Returns whether or not expanders are drawn in tree_view.

tree_view : a GtkTreeView.
Returns : TRUE if expanders are drawn in tree_view, FALSE otherwise.

Since 2.12


gtk_tree_view_set_level_indentation ()

void                gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
                                                         gint indentation);

Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.

tree_view : a GtkTreeView
indentation : the amount, in pixels, of extra indentation in tree_view.

Since 2.12


gtk_tree_view_set_show_expanders ()

void                gtk_tree_view_set_show_expanders    (GtkTreeView *tree_view,
                                                         gboolean enabled);

Sets whether to draw and enable expanders and indent child rows in tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using gtk_tree_view_set_level_indentation(). This does not have any visible effects for lists.

tree_view : a GtkTreeView
enabled : TRUE to enable expander drawing, FALSE otherwise.

Since 2.12


gtk_tree_view_new_with_model ()

GtkWidget*          gtk_tree_view_new_with_model        (GtkTreeModel *model);

Creates a new GtkTreeView widget with the model initialized to model.

model : the model.
Returns : A newly created GtkTreeView widget.

gtk_tree_view_get_model ()

GtkTreeModel*       gtk_tree_view_get_model             (GtkTreeView *tree_view);

Returns the model the GtkTreeView is based on. Returns NULL if the model is unset.

tree_view : a GtkTreeView
Returns : A GtkTreeModel, or NULL if none is currently being used.

gtk_tree_view_set_model ()

void                gtk_tree_view_set_model             (GtkTreeView *tree_view,
                                                         GtkTreeModel *model);

Sets the model for a GtkTreeView. If the tree_view already has a model set, it will remove it before setting the new model. If model is NULL, then it will unset the old model.

tree_view : A GtkTreeNode.
model : The model.

gtk_tree_view_get_selection ()

GtkTreeSelection*   gtk_tree_view_get_selection         (GtkTreeView *tree_view);

Gets the GtkTreeSelection associated with tree_view.

tree_view : A GtkTreeView.
Returns : A GtkTreeSelection object.

gtk_tree_view_get_hadjustment ()

GtkAdjustment*      gtk_tree_view_get_hadjustment       (GtkTreeView *tree_view);

Gets the GtkAdjustment currently being used for the horizontal aspect.

tree_view : A GtkTreeView
Returns : A GtkAdjustment object, or NULL if none is currently being used.

gtk_tree_view_set_hadjustment ()

void                gtk_tree_view_set_hadjustment       (GtkTreeView *tree_view,
                                                         GtkAdjustment *adjustment);

Sets the GtkAdjustment for the current horizontal aspect.

tree_view : A GtkTreeView
adjustment : The GtkAdjustment to set, or NULL

gtk_tree_view_get_vadjustment ()

GtkAdjustment*      gtk_tree_view_get_vadjustment       (GtkTreeView *tree_view);

Gets the GtkAdjustment currently being used for the vertical aspect.

tree_view : A GtkTreeView
Returns : A GtkAdjustment object, or NULL if none is currently being used.

gtk_tree_view_set_vadjustment ()

void                gtk_tree_view_set_vadjustment       (GtkTreeView *tree_view,
                                                         GtkAdjustment *adjustment);

Sets the GtkAdjustment for the current vertical aspect.

tree_view : A GtkTreeView
adjustment : The GtkAdjustment to set, or NULL

gtk_tree_view_get_headers_visible ()

gboolean            gtk_tree_view_get_headers_visible   (GtkTreeView *tree_view);

Returns TRUE if the headers on the tree_view are visible.

tree_view : A GtkTreeView.
Returns : Whether the headers are visible or not.

gtk_tree_view_set_headers_visible ()

void                gtk_tree_view_set_headers_visible   (GtkTreeView *tree_view,
                                                         gboolean headers_visible);

Sets the visibility state of the headers.

tree_view : A GtkTreeView.
headers_visible : TRUE if the headers are visible

gtk_tree_view_columns_autosize ()

void                gtk_tree_view_columns_autosize      (GtkTreeView *tree_view);

Resizes all columns to their optimal width. Only works after the treeview has been realized.

tree_view : A GtkTreeView.

gtk_tree_view_get_headers_clickable ()

gboolean            gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);

Returns whether all header columns are clickable.

tree_view : A GtkTreeView.
Returns : TRUE if all header columns are clickable, otherwise FALSE

Since 2.10


gtk_tree_view_set_headers_clickable ()

void                gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
                                                         gboolean setting);

Allow the column title buttons to be clicked.

tree_view : A GtkTreeView.
setting : TRUE if the columns are clickable.

gtk_tree_view_set_rules_hint ()

void                gtk_tree_view_set_rules_hint        (GtkTreeView *tree_view,
                                                         gboolean setting);

This function tells GTK+ that the user interface for your application requires users to read across tree rows and associate cells with one another. By default, GTK+ will then render the tree with alternating row colors. Do not use it just because you prefer the appearance of the ruled tree; that's a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors useful from a functional standpoint (since it has lots of columns, generally).

tree_view : a GtkTreeView
setting : TRUE if the tree requires reading across rows

gtk_tree_view_get_rules_hint ()

gboolean            gtk_tree_view_get_rules_hint        (GtkTreeView *tree_view);

Gets the setting set by gtk_tree_view_set_rules_hint().

tree_view : a GtkTreeView
Returns : TRUE if rules are useful for the user of this tree

gtk_tree_view_append_column ()

gint                gtk_tree_view_append_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);

Appends column to the list of columns. If tree_view has "fixed_height" mode enabled, then column must have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

tree_view : A GtkTreeView.
column : The GtkTreeViewColumn to add.
Returns : The number of columns in tree_view after appending.

gtk_tree_view_remove_column ()

gint                gtk_tree_view_remove_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);

Removes column from tree_view.

tree_view : A GtkTreeView.
column : The GtkTreeViewColumn to remove.
Returns : The number of columns in tree_view after removing.

gtk_tree_view_insert_column ()

gint                gtk_tree_view_insert_column         (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         gint position);

This inserts the column into the tree_view at position. If position is -1, then the column is inserted at the end. If tree_view has "fixed_height" mode enabled, then column must have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

tree_view : A GtkTreeView.
column : The GtkTreeViewColumn to be inserted.
position : The position to insert column in.
Returns : The number of columns in tree_view after insertion.

gtk_tree_view_insert_column_with_attributes ()

gint                gtk_tree_view_insert_column_with_attributes
                                                        (GtkTreeView *tree_view,
                                                         gint position,
                                                         const gchar *title,
                                                         GtkCellRenderer *cell,
                                                         ...);

Creates a new GtkTreeViewColumn and inserts it into the tree_view at position. If position is -1, then the newly created column is inserted at the end. The column is initialized with the attributes given. If tree_view has "fixed_height" mode enabled, then the new column will have its sizing property set to be GTK_TREE_VIEW_COLUMN_FIXED.

tree_view : A GtkTreeView
position : The position to insert the new column in.
title : The title to set the header to.
cell : The GtkCellRenderer.
... : A NULL-terminated list of attributes.
Returns : The number of columns in tree_view after insertion.

gtk_tree_view_insert_column_with_data_func ()

gint                gtk_tree_view_insert_column_with_data_func
                                                        (GtkTreeView *tree_view,
                                                         gint position,
                                                         const gchar *title,
                                                         GtkCellRenderer *cell,
                                                         GtkTreeCellDataFunc func,
                                                         gpointer data,
                                                         GDestroyNotify dnotify);

Convenience function that inserts a new column into the GtkTreeView with the given cell renderer and a GtkCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). If tree_view has "fixed_height" mode enabled, then the new column will have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

tree_view : a GtkTreeView
position : Position to insert, -1 for append
title : column title
cell : cell renderer for column
func : function to set attributes of cell renderer
data : data for func
dnotify : destroy notifier for data
Returns : number of columns in the tree view post-insert

gtk_tree_view_get_column ()

GtkTreeViewColumn*  gtk_tree_view_get_column            (GtkTreeView *tree_view,
                                                         gint n);

Gets the GtkTreeViewColumn at the given position in the tree_view.

tree_view : A GtkTreeView.
n : The position of the column, counting from 0.
Returns : The GtkTreeViewColumn, or NULL if the position is outside the range of columns.

gtk_tree_view_get_columns ()

GList*              gtk_tree_view_get_columns           (GtkTreeView *tree_view);

Returns a GList of all the GtkTreeViewColumn s currently in tree_view. The returned list must be freed with g_list_free().

tree_view : A GtkTreeView
Returns : A list of GtkTreeViewColumn s

gtk_tree_view_move_column_after ()

void                gtk_tree_view_move_column_after     (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column,
                                                         GtkTreeViewColumn *base_column);

Moves column to be after to base_column. If base_column is NULL, then column is placed in the first position.

tree_view : A GtkTreeView
column : The GtkTreeViewColumn to be moved.
base_column : The GtkTreeViewColumn to be moved relative to, or NULL.

gtk_tree_view_set_expander_column ()

void                gtk_tree_view_set_expander_column   (GtkTreeView *tree_view,
                                                         GtkTreeViewColumn *column);

Sets the column to draw the expander arrow at. It must be in tree_view. If column is NULL, then the expander arrow is always at the first visible column.

If you do not want expander arrow to appear in your tree, set the expander column to a hidden column.

tree_view : A GtkTreeView
column : NULL, or the column to draw the expander arrow at.

gtk_tree_view_get_expander_column ()

GtkTreeViewColumn*  gtk_tree_view_get_expander_column   (GtkTreeView *tree_view);

Returns the column that is the current expander column. This column has the expander arrow drawn next to it.

tree_view : A GtkTreeView
Returns : The expander column.

gtk_tree_view_set_column_drag_function ()

void                gtk_tree_view_set_column_drag_function
                                                        (GtkTreeView *tree_view,
                                                         GtkTreeViewColumnDropFunc func,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy);

Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to func are: the tree_view, the GtkTreeViewColumn being dragged, the two GtkTreeViewColumn s determining the drop spot, and user_data. If either of the GtkTreeViewColumn arguments for the drop spot are NULL, then they indicate an edge. If func is set to be NULL, then tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.

tree_view : A GtkTreeView.
func : A function to determine which columns are reorderable, or NULL.
user_data : User data to be passed to func, or NULL
destroy : Destroy notifier for user_data, or NULL

gtk_tree_view_scroll_to_point ()

void                gtk_tree_view_scroll_to_point       (GtkTreeView *tree_view,
                                                         gint tree_x,
                                                         gint tree_y);

Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates. The tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell().

If either tree_x or tree_y are -1, then that direction isn't scrolled.

tree_view : a GtkTreeView
tree_x : X coordinate of new top-left pixel of visible area, or -1
tree_y : Y coordinate of new top-left pixel of visible area, or -1

gtk_tree_view_scroll_to_cell ()

void                gtk_tree_view_scroll_to_cell        (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column,
                                                         gboolean use_align,
                                                         gfloat row_align,
                                                         gfloat col_align);

Moves the alignments of tree_view to the position specified by column and path. If column is NULL, then no horizontal scrolling occurs. Likewise, if path is NULL no vertical scrolling occurs. At a minimum, one of column or path need to be non-NULL. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

If use_align is FALSE, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to its current position. If the cell is currently visible on the screen, nothing is done.

This function only works if the model is set, and path is a valid row on the model. If the model changes before the tree_view is realized, the centered path will be modified to reflect this change.

tree_view : A GtkTreeView.
path : The path of the row to move to, or NULL.
column : The GtkTreeViewColumn to move horizontally to, or NULL.
use_align : whether to use alignment arguments, or FALSE.
row_align : The vertical alignment of the row specified by path.
col_align : The horizontal alignment of the column specified by column.

gtk_tree_view_set_cursor ()

void                gtk_tree_view_set_cursor            (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *focus_column,
                                                         gboolean start_editing);

Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is not NULL, then focus is given to the column specified by it. Additionally, if focus_column is specified, and start_editing is TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

tree_view : A GtkTreeView
path : A GtkTreePath
focus_column : A GtkTreeViewColumn, or NULL
start_editing : TRUE if the specified cell should start being edited.

gtk_tree_view_set_cursor_on_cell ()

void                gtk_tree_view_set_cursor_on_cell    (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *focus_column,
                                                         GtkCellRenderer *focus_cell,
                                                         gboolean start_editing);

Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is not NULL, then focus is given to the column specified by it. If focus_column and focus_cell are not NULL, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

tree_view : A GtkTreeView
path : A GtkTreePath
focus_column : A GtkTreeViewColumn, or NULL
focus_cell : A GtkCellRenderer, or NULL
start_editing : TRUE if the specified cell should start being edited.

Since 2.2


gtk_tree_view_get_cursor ()

void                gtk_tree_view_get_cursor            (GtkTreeView *tree_view,
                                                         GtkTreePath **path,
                                                         GtkTreeViewColumn **focus_column);

Fills in path and focus_column with the current path and focus column. If the cursor isn't currently set, then *path will be NULL. If no column currently has focus, then *focus_column will be NULL.

The returned GtkTreePath must be freed with gtk_tree_path_free() when you are done with it.

tree_view : A GtkTreeView
path : A pointer to be filled with the current cursor path, or NULL
focus_column : A pointer to be filled with the current focus column, or NULL

gtk_tree_view_row_activated ()

void                gtk_tree_view_row_activated         (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         GtkTreeViewColumn *column);

Activates the cell determined by path and column.

tree_view : A GtkTreeView
path : The GtkTreePath to be activated.
column : The GtkTreeViewColumn to be activated.

gtk_tree_view_expand_all ()

void                gtk_tree_view_expand_all            (GtkTreeView *tree_view);

Recursively expands all nodes in the tree_view.

tree_view : A GtkTreeView.

gtk_tree_view_collapse_all ()

void                gtk_tree_view_collapse_all          (GtkTreeView *tree_view);

Recursively collapses all visible, expanded nodes in tree_view.

tree_view : A GtkTreeView.

gtk_tree_view_expand_to_path ()

void                gtk_tree_view_expand_to_path        (GtkTreeView *tree_view,
                                                         GtkTreePath *path);

Expands the row at path. This will also expand all parent rows of path as necessary.

tree_view : A GtkTreeView.
path : path to a row.

Since 2.2


gtk_tree_view_expand_row ()

gboolean            gtk_tree_view_expand_row            (GtkTreeView *tree_view,
                                                         GtkTreePath *path,
                                                         gboolean open_all);

Opens the row so its children are visible.

tree_view : a GtkTreeView
path : path to a row
open_all : whether to recursively expand, or just expand immediate children
Returns : TRUE if the row existed and had children

gtk_tree_view_collapse_row ()

gboolean            gtk_tree_view_collapse_row          (GtkTreeView *tree_view,
                                                         GtkTreePath *path);

Collapses a row (hides its child rows, if they exist).

tree_view : a GtkTreeView
path : path to a row in the tree_view
Returns : TRUE if the row was collapsed.

gtk_tree_view_map_expanded_rows ()

void                gtk_tree_view_map_expanded_rows     (GtkTreeView *tree_view,
                                                         GtkTreeViewMappingFunc func,
                                                         gpointer data);

Calls func on all expanded rows.

tree_view : A GtkTreeView
func : A function to be called
data : User data to be passed to the function.

gtk_tree_view_row_expanded ()

gboolean            gtk_tree_view_row_expanded          (GtkTreeView *tree_view,
                                                         GtkTreePath *path);

Returns TRUE if the node pointed to by path is expanded in tree_view.

tree_view : A GtkTreeView.
path : A GtkTreePath to test expansion state.
Returns : TRUE if path is expanded.

gtk_tree_view_set_reorderable ()

void                gtk_tree_view_set_reorderable       (GtkTreeView *tree_view,
                                                         gboolean reorderable);

This function is a convenience function to allow you to reorder models that support the GtkDragSourceIface and the GtkDragDestIface. Both GtkTreeStore and GtkListStore support these. If reorderable is TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's row_inserted and row_deleted signals. The reordering is implemented by setting up the tree view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.

This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.

tree_view : A GtkTreeView.
reorderable</