Class

Gtk.TreeView

Description [src]

class Gtk.TreeView : Gtk.Widget {
  parent_instance: GtkWidget
}

A widget for displaying both trees and lists

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.

Coordinate systems in GtkTreeView API

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 and exposes the internal GtkTreeSelection in UI definitions.

An example of 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>
  <child internal-child="selection">
    <object class="GtkTreeSelection" id="selection">
      <signal name="changed" handler="on_treeview_selection_changed"/>
    </object>
  </child>
</object>

CSS nodes

treeview.view
├── header
│   ├── button
│   │   ╰── [sort-indicator]
┊   ┊
│   ╰── button
│       ╰── [sort-indicator]
│
├── [rubberband]
╰── [dndtarget]

GtkTreeView has a main CSS node with name treeview and style class .view. It has a subnode with name header, which is the parent for all the column header widgets’ CSS nodes.

Each column header consists of a button, which among other content, has a child with name sort-indicator, which carries the .ascending or .descending style classes when the column header should show a sort indicator. The CSS is expected to provide a suitable image using the -gtk-icon-source property.

For rubberband selection, a subnode with name rubberband is used.

For the drop target location during DND, a subnode with name dndtarget is used.

Hierarchy

Hierarchy for Gtk.TreeView

Ancestors

Constructors

gtk_tree_view_new

Creates a new GtkTreeView widget.

gtk_tree_view_new_with_model

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

Instance methods

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

gtk_tree_view_collapse_all

Recursively collapses all visible, expanded nodes in tree_view.

gtk_tree_view_collapse_row

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

gtk_tree_view_columns_autosize

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

gtk_tree_view_convert_bin_window_to_tree_coords

Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

gtk_tree_view_convert_bin_window_to_widget_coords

Converts bin_window coordinates to widget relative coordinates.

gtk_tree_view_convert_tree_to_bin_window_coords

Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

gtk_tree_view_convert_tree_to_widget_coords

Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

gtk_tree_view_convert_widget_to_bin_window_coords

Converts widget coordinates to coordinates for the bin_window.

gtk_tree_view_convert_widget_to_tree_coords

Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

gtk_tree_view_create_row_drag_icon

Creates a #cairo_surface_t representation of the row at path. This image is used for a drag icon.

gtk_tree_view_enable_model_drag_dest

Turns tree_view into a drop destination for automatic DND. Calling this method sets GtkTreeView:reorderable to FALSE.

gtk_tree_view_enable_model_drag_source

Turns tree_view into a drag source for automatic DND. Calling this method sets GtkTreeView:reorderable to FALSE.

gtk_tree_view_expand_all

Recursively expands all nodes in the tree_view.

gtk_tree_view_expand_row

Opens the row so its children are visible.

gtk_tree_view_expand_to_path

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

gtk_tree_view_get_activate_on_single_click

Gets the setting set by gtk_tree_view_set_activate_on_single_click().

gtk_tree_view_get_background_area

Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by path and the column specified by column. If path is NULL, or points to a node not found in the tree, the y and height fields of the rectangle will be filled with 0. If column is NULL, the x and width fields will be filled with 0. The returned rectangle is equivalent to the background_area passed to gtk_cell_renderer_render(). These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by gtk_tree_view_get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.

gtk_tree_view_get_cell_area

Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by path and the column specified by column. If path is NULL, or points to a path not currently displayed, the y and height fields of the rectangle will be filled with 0. If column is NULL, the x and width fields will be filled with 0. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the cell_area passed to gtk_cell_renderer_render(). This function is only valid if tree_view is realized.

gtk_tree_view_get_column

Gets the GtkTreeViewColumn at the given position in the #tree_view.

gtk_tree_view_get_columns

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

gtk_tree_view_get_cursor

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.

gtk_tree_view_get_dest_row_at_pos

Determines the destination row for a given position. drag_x and drag_y are expected to be in widget coordinates. This function is only meaningful if tree_view is realized. Therefore this function will always return FALSE if tree_view is not realized or does not have a model.

gtk_tree_view_get_drag_dest_row

Gets information about the row that is highlighted for feedback.

gtk_tree_view_get_enable_search

Returns whether or not the tree allows to start interactive searching by typing in text.

gtk_tree_view_get_enable_tree_lines

Returns whether or not tree lines are drawn in tree_view.

gtk_tree_view_get_expander_column

Returns the column that is the current expander column, or NULL if none has been set. This column has the expander arrow drawn next to it.

gtk_tree_view_get_fixed_height_mode

Returns whether fixed height mode is turned on for tree_view.

gtk_tree_view_get_grid_lines

Returns which grid lines are enabled in tree_view.

gtk_tree_view_get_headers_clickable

Returns whether all header columns are clickable.

gtk_tree_view_get_headers_visible

Returns TRUE if the headers on the tree_view are visible.

gtk_tree_view_get_hover_expand

Returns whether hover expansion mode is turned on for tree_view.

gtk_tree_view_get_hover_selection

Returns whether hover selection mode is turned on for tree_view.

gtk_tree_view_get_level_indentation

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

gtk_tree_view_get_model

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

gtk_tree_view_get_n_columns

Queries the number of columns in the given tree_view.

gtk_tree_view_get_path_at_pos

Finds the path at the point (x, y), relative to bin_window coordinates. That is, x and y are relative to an events coordinates. Widget-relative coordinates must be converted using gtk_tree_view_convert_widget_to_bin_window_coords(). It is primarily for things like popup menus. If path is non-NULL, then it will be filled with the GtkTreePath at that point. This path should be freed with gtk_tree_path_free(). If column is non-NULL, then it will be filled with the column at that point. cell_x and cell_y return the coordinates relative to the cell background (i.e. the background_area passed to gtk_cell_renderer_render()). This function is only meaningful if tree_view is realized. Therefore this function will always return FALSE if tree_view is not realized or does not have a model.

gtk_tree_view_get_reorderable

Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable().

gtk_tree_view_get_row_separator_func

Returns the current row separator function.

gtk_tree_view_get_rubber_banding

Returns whether rubber banding is turned on for tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

gtk_tree_view_get_search_column

Gets the column searched on by the interactive search code.

gtk_tree_view_get_search_entry

Returns the GtkEntry which is currently in use as interactive search entry for tree_view. In case the built-in entry is being used, NULL will be returned.

gtk_tree_view_get_search_equal_func

Returns the compare function currently in use.

gtk_tree_view_get_selection

Gets the GtkTreeSelection associated with tree_view.

gtk_tree_view_get_show_expanders

Returns whether or not expanders are drawn in tree_view.

gtk_tree_view_get_tooltip_column

Returns the column of tree_view’s model which is being used for displaying tooltips on tree_view’s rows.

gtk_tree_view_get_tooltip_context

This function is supposed to be used in a GtkWidget::query-tooltip signal handler for GtkTreeView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.

gtk_tree_view_get_visible_range

Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.

gtk_tree_view_get_visible_rect

Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

gtk_tree_view_insert_column

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.

gtk_tree_view_insert_column_with_attributes

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.

gtk_tree_view_insert_column_with_data_func

Convenience function that inserts a new column into the GtkTreeView with the given cell renderer and a GtkTreeCellDataFunc 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.

gtk_tree_view_is_blank_at_pos

Determine whether the point (x, y) in tree_view is blank, that is no cell content nor an expander arrow is drawn at the location. If so, the location can be considered as the background. You might wish to take special action on clicks on the background, such as clearing a current selection, having a custom context menu or starting rubber banding.

gtk_tree_view_is_rubber_banding_active

Returns whether a rubber banding operation is currently being done in tree_view.

gtk_tree_view_map_expanded_rows

Calls func on all expanded rows.

gtk_tree_view_move_column_after

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

gtk_tree_view_remove_column

Removes column from tree_view.

gtk_tree_view_row_activated

Activates the cell determined by path and column.

gtk_tree_view_row_expanded

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

gtk_tree_view_scroll_to_cell

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.

gtk_tree_view_scroll_to_point

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

gtk_tree_view_set_activate_on_single_click

Cause the GtkTreeView::row-activated signal to be emitted on a single click instead of a double click.

gtk_tree_view_set_column_drag_function

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.

gtk_tree_view_set_cursor

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.

gtk_tree_view_set_cursor_on_cell

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.

gtk_tree_view_set_drag_dest_row

Sets the row that is highlighted for feedback. If path is NULL, an existing highlight is removed.

gtk_tree_view_set_enable_search

If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called “typeahead find”).

gtk_tree_view_set_enable_tree_lines

Sets whether to draw lines interconnecting the expanders in tree_view. This does not have any visible effects for lists.

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

gtk_tree_view_set_fixed_height_mode

Enables or disables the fixed height mode of tree_view. Fixed height mode speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type GTK_TREE_VIEW_COLUMN_FIXED.

gtk_tree_view_set_grid_lines

Sets which grid lines to draw in tree_view.

gtk_tree_view_set_headers_clickable

Allow the column title buttons to be clicked.

gtk_tree_view_set_headers_visible

Sets the visibility state of the headers.

gtk_tree_view_set_hover_expand

Enables or disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

gtk_tree_view_set_hover_selection

Enables or disables the hover selection mode of tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes GTK_SELECTION_SINGLE and GTK_SELECTION_BROWSE.

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

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

gtk_tree_view_set_reorderable

This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface. 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 GtkTreeModel::row-inserted and GtkTreeModel::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.

gtk_tree_view_set_row_separator_func

Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is NULL, no separators are drawn. This is the default value.

gtk_tree_view_set_rubber_banding

Enables or disables rubber banding in tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

gtk_tree_view_set_search_column

Sets column as the column where the interactive search code should search in for the current model.

gtk_tree_view_set_search_entry

Sets the entry which the interactive search code will use for this tree_view. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing NULL for entry will make the interactive search code use the built-in popup entry again.

gtk_tree_view_set_search_equal_func

Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality GtkTreeViewSearchEqualFunc returns FALSE on matches.

gtk_tree_view_set_show_expanders

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.

gtk_tree_view_set_tooltip_cell

Sets the tip area of tooltip to the area path, column and cell have in common. For example if path is NULL and column is set, the tip area will be set to the full area covered by column. See also gtk_tooltip_set_tip_area().

gtk_tree_view_set_tooltip_column

If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have GtkTreeView handle these automatically for you. column should be set to the column in tree_view’s model containing the tooltip texts, or -1 to disable this feature.

gtk_tree_view_set_tooltip_row

Sets the tip area of tooltip to be the area covered by the row at path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area().

gtk_tree_view_unset_rows_drag_dest

Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets GtkTreeView:reorderable to FALSE.

gtk_tree_view_unset_rows_drag_source

Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets GtkTreeView:reorderable to FALSE.

Methods inherited from GtkWidget (159)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border

Returns the size of a non-scrolling border around the outside of the scrollable.

gtk_scrollable_get_hadjustment

Retrieves the GtkAdjustment used for horizontal scrolling.

gtk_scrollable_get_hscroll_policy

Gets the horizontal GtkScrollablePolicy.

gtk_scrollable_get_vadjustment

Retrieves the GtkAdjustment used for vertical scrolling.

gtk_scrollable_get_vscroll_policy

Gets the vertical GtkScrollablePolicy.

gtk_scrollable_set_hadjustment

Sets the horizontal adjustment of the GtkScrollable.

gtk_scrollable_set_hscroll_policy

Sets the GtkScrollablePolicy.

gtk_scrollable_set_vadjustment

Sets the vertical adjustment of the GtkScrollable.

gtk_scrollable_set_vscroll_policy

Sets the GtkScrollablePolicy.

Properties

Gtk.TreeView:activate-on-single-click

The activate-on-single-click property specifies whether the “row-activated” signal will be emitted after a single click.

Gtk.TreeView:enable-grid-lines
No description available.
Gtk.TreeView:enable-search
No description available.
Gtk.TreeView:enable-tree-lines
No description available.
Gtk.TreeView:expander-column
No description available.
Gtk.TreeView:fixed-height-mode

Setting the ::fixed-height-mode property to TRUE speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more information on this option.

Gtk.TreeView:headers-clickable
No description available.
Gtk.TreeView:headers-visible
No description available.
Gtk.TreeView:hover-expand

Enables or disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

Gtk.TreeView:hover-selection

Enables or disables the hover selection mode of tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes GTK_SELECTION_SINGLE and GTK_SELECTION_BROWSE.

Gtk.TreeView:level-indentation

Extra indentation for each level.

Gtk.TreeView:model
No description available.
Gtk.TreeView:reorderable
No description available.
Gtk.TreeView:rubber-banding
No description available.
Gtk.TreeView:search-column
No description available.
Gtk.TreeView:show-expanders

TRUE if the view has expanders.

Gtk.TreeView:tooltip-column
No description available.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkScrollable (4)
Gtk.Scrollable:hadjustment

Horizontal GtkAdjustment of the scrollable widget.

Gtk.Scrollable:hscroll-policy

Determines when horizontal scrolling should start.

Gtk.Scrollable:vadjustment

Vertical GtkAdjustment of the scrollable widget.

Gtk.Scrollable:vscroll-policy

Determines when vertical scrolling should start.

Signals

Gtk.TreeView::columns-changed

The number of columns of the treeview has changed.

Gtk.TreeView::cursor-changed

The position of the cursor (focused cell) has changed.

Gtk.TreeView::expand-collapse-cursor-row
No description available.
Gtk.TreeView::move-cursor

The GtkTreeView::move-cursor signal is a [keybinding signal][GtkSignalAction] which gets emitted when the user presses one of the cursor keys.

Gtk.TreeView::row-activated

The “row-activated” signal is emitted when the method gtk_tree_view_row_activated() is called, when the user double clicks a treeview row with the “activate-on-single-click” property set to FALSE, or when the user single clicks a row when the “activate-on-single-click” property set to TRUE. It is also emitted when a non-editable row is selected and one of the keys: Space, Shift+Space, Return or Enter is pressed.

Gtk.TreeView::row-collapsed

The given row has been collapsed (child nodes are hidden).

Gtk.TreeView::row-expanded

The given row has been expanded (child nodes are shown).

Gtk.TreeView::select-all
No description available.
Gtk.TreeView::select-cursor-parent
No description available.
Gtk.TreeView::select-cursor-row
No description available.
Gtk.TreeView::start-interactive-search
No description available.
Gtk.TreeView::test-collapse-row

The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.

Gtk.TreeView::test-expand-row

The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.

Gtk.TreeView::toggle-cursor-row
No description available.
Gtk.TreeView::unselect-all
No description available.
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Class structure

struct GtkTreeViewClass {
  GtkWidgetClass parent_class;
  void (* row_activated) (
    GtkTreeView* tree_view,
    GtkTreePath* path,
    GtkTreeViewColumn* column
  );
  gboolean (* test_expand_row) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  );
  gboolean (* test_collapse_row) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  );
  void (* row_expanded) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  );
  void (* row_collapsed) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  );
  void (* columns_changed) (
    GtkTreeView* tree_view
  );
  void (* cursor_changed) (
    GtkTreeView* tree_view
  );
  gboolean (* move_cursor) (
    GtkTreeView* tree_view,
    GtkMovementStep step,
    int count,
    gboolean extend,
    gboolean modify
  );
  gboolean (* select_all) (
    GtkTreeView* tree_view
  );
  gboolean (* unselect_all) (
    GtkTreeView* tree_view
  );
  gboolean (* select_cursor_row) (
    GtkTreeView* tree_view,
    gboolean start_editing
  );
  gboolean (* toggle_cursor_row) (
    GtkTreeView* tree_view
  );
  gboolean (* expand_collapse_cursor_row) (
    GtkTreeView* tree_view,
    gboolean logical,
    gboolean expand,
    gboolean open_all
  );
  gboolean (* select_cursor_parent) (
    GtkTreeView* tree_view
  );
  gboolean (* start_interactive_search) (
    GtkTreeView* tree_view
  );
  
}
Class members
parent_class
GtkWidgetClass
  No description available.
row_activated
void (* row_activated) (
    GtkTreeView* tree_view,
    GtkTreePath* path,
    GtkTreeViewColumn* column
  )
  No description available.
test_expand_row
gboolean (* test_expand_row) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  )
  No description available.
test_collapse_row
gboolean (* test_collapse_row) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  )
  No description available.
row_expanded
void (* row_expanded) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  )
  No description available.
row_collapsed
void (* row_collapsed) (
    GtkTreeView* tree_view,
    GtkTreeIter* iter,
    GtkTreePath* path
  )
  No description available.
columns_changed
void (* columns_changed) (
    GtkTreeView* tree_view
  )
  No description available.
cursor_changed
void (* cursor_changed) (
    GtkTreeView* tree_view
  )
  No description available.
move_cursor
gboolean (* move_cursor) (
    GtkTreeView* tree_view,
    GtkMovementStep step,
    int count,
    gboolean extend,
    gboolean modify
  )
  No description available.
select_all
gboolean (* select_all) (
    GtkTreeView* tree_view
  )
  No description available.
unselect_all
gboolean (* unselect_all) (
    GtkTreeView* tree_view
  )
  No description available.
select_cursor_row
gboolean (* select_cursor_row) (
    GtkTreeView* tree_view,
    gboolean start_editing
  )
  No description available.
toggle_cursor_row
gboolean (* toggle_cursor_row) (
    GtkTreeView* tree_view
  )
  No description available.
expand_collapse_cursor_row
gboolean (* expand_collapse_cursor_row) (
    GtkTreeView* tree_view,
    gboolean logical,
    gboolean expand,
    gboolean open_all
  )
  No description available.
select_cursor_parent
gboolean (* select_cursor_parent) (
    GtkTreeView* tree_view
  )
  No description available.
start_interactive_search
gboolean (* start_interactive_search) (
    GtkTreeView* tree_view
  )
  No description available.

Virtual methods

Gtk.TreeViewClass.columns_changed
No description available.
Gtk.TreeViewClass.cursor_changed
No description available.
Gtk.TreeViewClass.move_cursor
No description available.
Gtk.TreeViewClass.row_activated

Activates the cell determined by path and column.

Gtk.TreeViewClass.row_collapsed
No description available.
Gtk.TreeViewClass.row_expanded
No description available.
Gtk.TreeViewClass.select_all
No description available.
Gtk.TreeViewClass.select_cursor_parent
No description available.
Gtk.TreeViewClass.select_cursor_row
No description available.
No description available.
Gtk.TreeViewClass.test_collapse_row
No description available.
Gtk.TreeViewClass.test_expand_row
No description available.
Gtk.TreeViewClass.toggle_cursor_row
No description available.
Gtk.TreeViewClass.unselect_all
No description available.