Widget that displays any object that implements the gtk.TreeModel interface.
Please refer to the [tree widget conceptual overview]TreeWidget 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:
Coordinate systems in GtkTreeView API:
- 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 TreeView.convertWidgetToBinWindowCoords (and vice versa), for the latter TreeView.convertBinWindowToTreeCoords (and vice versa).
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 |[<!-- language="plain" --> treeview.view ├── header │ ├── <column header> ┊ ┊ │ ╰── <column header> │ ╰── [rubberband]
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. For rubberband selection, a subnode with name rubberband is used.
Sets our main struct and passes it to the parent class.
Creates a new gtk.TreeView widget.
Creates a new gtk.TreeView widget with the model initialized to model.
The number of columns of the treeview has changed.
The position of the cursor (focused cell) has changed.
The "row-activated" signal is emitted when the method TreeView.rowActivated 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.
The given row has been collapsed (child nodes are hidden).
The given row has been expanded (child nodes are shown).
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.
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.
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.
Recursively collapses all visible, expanded nodes in tree_view.
Collapses a row (hides its child rows, if they exist).
Resizes all columns to their optimal width. Only works after the treeview has been realized.
Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).
Converts bin_window coordinates (see TreeView.getBinWindow) to widget relative coordinates.
Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.
Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.
Converts widget coordinates to coordinates for the bin_window (see TreeView.getBinWindow).
Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).
Creates a cairo_surface_t representation of the row at path. This image is used for a drag icon.
Turns tree_view into a drop destination for automatic DND. Calling this method sets reorderable to FALSE.
Turns tree_view into a drag source for automatic DND. Calling this method sets reorderable to FALSE.
Recursively expands all nodes in the tree_view.
Expands the row of the iter.
Opens the row so its children are visible.
Expands the row at path. This will also expand all parent rows of path as necessary.
Gets the setting set by TreeView.setActivateOnSingleClick.
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 CellRenderer.render. These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by TreeView.getCellArea, which returns only the cell itself, excluding surrounding borders and the tree expander area.
Returns the window that tree_view renders to. This is used primarily to compare to event->window to confirm that the event on tree_view is on the right window.
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 CellRenderer.render. This function is only valid if tree_view is realized.
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.
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.
Gets information about the row that is highlighted for feedback.
Returns whether or not the tree allows to start interactive searching by typing in text.
Returns whether or not tree lines are drawn in tree_view.
Returns the column that is the current expander column. This column has the expander arrow drawn next to it.
Returns whether fixed height mode is turned on for tree_view.
Returns which grid lines are enabled in tree_view.
Returns whether all header columns are clickable.
Returns TRUE if the headers on the tree_view are visible.
Returns whether hover expansion mode is turned on for tree_view.
Returns whether hover selection mode is turned on for tree_view.
Returns the amount, in pixels, of extra indentation for child levels in tree_view.
Returns the model the gtk.TreeView is based on. Returns NULL if the model is unset.
Queries the number of columns in the given tree_view.
Finds the path at the point (x, y), relative to bin_window coordinates (please see TreeView.getBinWindow). That is, x and y are relative to an events coordinates. x and y must come from an event on the tree_view only where `event->window == gtk_tree_view_get_bin_window ()`. It is primarily for things like popup menus. If path is non-NULL, then it will be filled with the gtk.TreePath at that point. This path should be freed with TreePath.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 CellRenderer.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.
Retrieves whether the user can reorder the tree via drag-and-drop. See TreeView.setReorderable.
Returns the current row separator function.
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.
Gets the setting set by TreeView.setRulesHint.
Gets the column searched on by the interactive search code.
Returns the gtk.Entry 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.
Returns the compare function currently in use.
Returns the positioning function currently in use.
gets the first selected iter or null if no rows are selected
Gets the gtk.TreeSelection associated with tree_view.
Returns whether or not expanders are drawn in tree_view.
the main Gtk struct as a void*
Returns the column of tree_view’s model which is being used for displaying tooltips on tree_view’s rows.
Get the main Gtk struct
Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.
Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with TreeView.convertTreeToBinWindowCoords. Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.
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.
Convenience function that inserts a new column into the gtk.TreeView with the given cell renderer and a GtkTreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also TreeView.columnSetCellDataFunc, TreeView.columnPackStart. 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.
Inserts a column and sets it's attributes
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.
Returns whether a rubber banding operation is currently being done in tree_view.
Calls func on all expanded rows.
Moves column to be after to base_column. If base_column is NULL, then column is placed in the first position.
Removes column from tree_view.
Activates the cell determined by path and column.
Returns TRUE if the node pointed to by path is expanded in tree_view.
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.
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 TreeView.scrollToCell.
Cause the row-activated signal to be emitted on a single click instead of a double click.
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 gtk.TreeViewColumn being dragged, the two gtk.TreeViewColumn s determining the drop spot, and user_data. If either of the gtk.TreeViewColumn 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.
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.
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.
This function should almost never be used. It is meant for private use by ATK for determining the number of visible children that are removed when the user collapses a row, or a row is deleted.
Sets the row that is highlighted for feedback. If path is NULL, an existing highlight is removed.
If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").
Sets whether to draw lines interconnecting the expanders in tree_view. This does not have any visible effects for lists.
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.
Enables or disables the fixed height mode of tree_view. Fixed height mode speeds up gtk.TreeView 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.
Sets which grid lines to draw in tree_view.
Allow the column title buttons to be clicked.
Sets the visibility state of the headers.
Enables or disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.
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.
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.
Sets the model for a gtk.TreeView 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.
This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface Both gtk.TreeStore and gtk.ListStore 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.
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.
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.
Sets a hint for the theme to draw even/odd rows in the tree_view with different colors, also known as "zebra striping".
Sets column as the column where the interactive search code should search in for the current model.
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.
Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality GtkTreeViewSearchEqualFunc returns FALSE on matches.
Sets the function to use when positioning the search dialog.
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 TreeView.setLevelIndentation. This does not have any visible effects for lists.
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 Tooltip.setTipArea.
If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have gtk.TreeView 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.
the main Gtk struct
the main Gtk struct
Get the main Gtk struct
the main Gtk struct as a void*
Removes all widgets from the container
Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
Gets the value of a child property for child and container.
Gets the values of one or more child properties for child and container.
Emits a child-notify signal for the [child property][child-properties] child_property on the child.
Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.
Sets a child property for child and container.
Sets one or more child properties for child and container.
Returns the type of the children supported by the container.
Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
Invokes callback on each non-internal child of container. See Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
Retrieves the border width of the container. See Container.setBorderWidth.
Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.
Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.
Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.
Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.
Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
Returns the resize mode for the container. See gtk_container_set_resize_mode ().
When a container receives a call to the draw function, it must send synthetic draw calls to all children that don’t have their own gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.
Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
Sets the border width of the container.
Sets a focus chain, overriding the one computed automatically by GTK+.
Sets, or unsets if child is NULL, the focused child of container.
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and Container.setFocusHadjustment for setting the horizontal adjustment.
Sets the reallocate_redraws flag of the container to the given value.
Sets the resize mode for the container.
Removes a focus chain explicitly set with Container.setFocusChain.
Get the main Gtk struct
the main Gtk struct as a void*
Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.
Retrieves the gtk.Adjustment used for horizontal scrolling.
Gets the horizontal GtkScrollablePolicy
Retrieves the gtk.Adjustment used for vertical scrolling.
Gets the vertical GtkScrollablePolicy
Sets the horizontal adjustment of the GtkScrollable
Sets the GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
Sets the vertical adjustment of the GtkScrollable
Sets the GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.