Creates a new gtk.tree_view.TreeView widget.
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.
Connect to ColumnsChanged signal.
Connect to CursorChanged signal.
Connect to ExpandCollapseCursorRow signal.
Connect to MoveCursor signal.
Connect to RowActivated signal.
Connect to RowCollapsed signal.
Connect to RowExpanded signal.
Connect to SelectAll signal.
Connect to SelectCursorParent signal.
Connect to SelectCursorRow signal.
Connect to StartInteractiveSearch signal.
Connect to TestCollapseRow signal.
Connect to TestExpandRow signal.
Connect to ToggleCursorRow signal.
Connect to UnselectAll signal.
Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).
Converts bin_window coordinates 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.
Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).
Creates a cairo.surface.Surface 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 gtk.tree_view.TreeView:reorderable to false.
Turns tree_view into a drag source for automatic DND. Calling this method sets gtk.tree_view.TreeView:reorderable to false.
Recursively expands all nodes in the tree_view.
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 gtk.tree_view.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 gtk.cell_renderer.CellRenderer.render. These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by gtk.tree_view.TreeView.getCellArea, which returns only the cell itself, excluding surrounding borders and the tree expander 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.CellRenderer.render. This function is only valid if tree_view is realized.
Gets the gtk.tree_view_column.TreeViewColumn at the given position in the #tree_view.
Returns a glib.list.List of all the gtk.tree_view_column.TreeViewColumns currently in tree_view. The returned list must be freed with g_list_free ().
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, or null if none has been set. 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.tree_view.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. That is, x and y are relative to an events coordinates. Widget-relative coordinates must be converted using gtk.tree_view.TreeView.convertWidgetToBinWindowCoords. It is primarily for things like popup menus. If path is non-null, then it will be filled with the gtk.tree_path.TreePath at that point. This path should be freed with gtk.tree_path.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 gtk.cell_renderer.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 gtk.tree_view.TreeView.setReorderable.
Returns whether rubber banding is turned on for tree_view. If the selection mode is gtk.types.SelectionMode.Multiple, rubber banding will allow the user to select multiple rows by dragging the mouse.
Gets the column searched on by the interactive search code.
Returns the gtk.entry.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.
Gets the gtk.tree_selection.TreeSelection associated with tree_view.
Returns whether or not expanders are drawn in tree_view.
Returns the column of tree_view’s model which is being used for displaying tooltips on tree_view’s rows.
This function is supposed to be used in a ::query-tooltip signal handler for gtk.tree_view.TreeView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.
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 gtk.tree_view.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.tree_view.TreeView with the given cell renderer and a gtk.types.TreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk.tree_view_column.TreeViewColumn.setCellDataFunc, gtk.tree_view_column.TreeViewColumn.packStart. 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.
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 gtk.tree_view.TreeView.scrollToCell.
Cause the gtk.tree_view.TreeView::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.tree_view_column.TreeViewColumn being dragged, the two gtk.tree_view_column.TreeViewColumns determining the drop spot, and user_data. If either of the gtk.tree_view_column.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.
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.tree_view.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.types.TreeViewColumnSizing.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.types.SelectionMode.Single and gtk.types.SelectionMode.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.tree_view.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 gtk.tree_drag_source_iface.TreeDragSourceIface and the gtk.tree_drag_dest_iface.TreeDragDestIface. Both gtk.tree_store.TreeStore and gtk.list_store.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 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.
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.types.SelectionMode.Multiple, rubber banding will allow the user to select multiple rows by dragging the mouse.
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 gtk.tree_view.TreeViewSearchEqualFunc returns false on matches.
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.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 gtk.tooltip.Tooltip.setTipArea.
If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have gtk.tree_view.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.
Sets the tip area of tooltip to be the area covered by the row at path. See also gtk.tree_view.TreeView.setTooltipColumn for a simpler alternative. See also gtk.tooltip.Tooltip.setTipArea.
Undoes the effect of gtk.tree_view.TreeView.enableModelDragDest. Calling this method sets gtk.tree_view.TreeView:reorderable to false.
Undoes the effect of gtk.tree_view.TreeView.enableModelDragSource. Calling this method sets gtk.tree_view.TreeView:reorderable to false.
Creates a new gtk.tree_view.TreeView widget with the model initialized to model.
Returns the size of a non-scrolling border around the outside of the scrollable.
Retrieves the gtk.adjustment.Adjustment used for horizontal scrolling.
Gets the horizontal gtk.types.ScrollablePolicy.
Retrieves the gtk.adjustment.Adjustment used for vertical scrolling.
Gets the vertical gtk.types.ScrollablePolicy.
Sets the horizontal adjustment of the gtk.scrollable.Scrollable.
Sets the gtk.types.ScrollablePolicy.
Sets the vertical adjustment of the gtk.scrollable.Scrollable.
Sets the gtk.types.ScrollablePolicy.
Obtains the current default reading direction.
Sets the default reading direction for widgets.
Enable or disable an action installed with gtk.widget_class.WidgetClass.installAction.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
Looks up the action in the action groups associated with widget and its ancestors, and activates it.
Activates the default.activate action from widget.
Adds controller to widget so that it will receive events.
Adds a style class to widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
This function is only used by gtk.widget.Widget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for widget in the coordinate space of target.
Computes whether a container should give this widget extra space when possible.
Translates the given point in widget's coordinates to coordinates relative to target’s coordinate system.
Computes a matrix suitable to describe a transformation from widget's coordinate system into target's coordinate system.
Tests if the point at (x, y) is contained in widget.
Creates a new pango.context.Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new pango.layout.Layout with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Notifies the user about an input-related error on this widget.
Returns the baseline that has currently been allocated to widget.
Returns the height that has currently been allocated to widget.
Returns the width that has currently been allocated to widget.
Gets the first ancestor of widget with type widget_type.
Returns the baseline that has currently been allocated to widget.
Determines whether the input focus can enter widget or any of its children.
Queries whether widget can be the target of pointer events.
Gets the value set with gtk.widget.Widget.setChildVisible.
Gets the clipboard object for widget.
Gets the current foreground color for the widget’s CSS style.
Returns the list of style classes applied to widget.
Returns the CSS name that is used for self.
Queries the cursor set on widget.
Gets the reading direction for a particular widget.
Get the gdk.display.Display for the toplevel window associated with this widget.
Returns the widget’s first child.
Returns the current focus child of widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Determines whether widget can own the input focus.
Gets the font map of widget.
Returns the cairo.font_options.FontOptions of widget.
Obtains the frame clock for a widget.
Gets the horizontal alignment of widget.
Returns the current value of the has-tooltip property.
Returns the content height of the widget.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk.widget.Widget.setHexpand has been used to explicitly set the expand flag on this widget.
Returns the widget’s last child.
Retrieves the layout manager used by widget.
Whether the widget is mapped.
Gets the bottom margin of widget.
Gets the end margin of widget.
Gets the start margin of widget.
Gets the top margin of widget.
Retrieves the name of a widget.
Returns the nearest gtk.native.Native ancestor of widget.
Returns the widget’s next sibling.
#Fetches the requested opacity for this widget.
Returns the widget’s overflow value.
Gets a pango.context.Context with the appropriate font map, font description, and base direction for this widget.
Returns the parent widget of widget.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of widget.
Determines whether widget is realized.
Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Returns the gtk.root.Root widget of widget.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Gets the size request that was explicitly set for the widget using gtk.widget.Widget.setSizeRequest.
Returns the widget state as a flag set.
Returns the style context associated to widget.
Fetch an object build from the template XML for widget_type in this widget instance.
Gets the contents of the tooltip for widget.
Gets the contents of the tooltip for widget.
Gets the vertical alignment of widget.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk.widget.Widget.setVexpand has been used to explicitly set the expand flag on this widget.
Determines whether the widget is visible.
Returns the content width of the widget.
Causes widget to have the keyboard focus for the gtk.window.Window it's inside.
Returns whether css_class is currently applied to widget.
Determines whether widget is the current default widget within its toplevel.
Determines if the widget has the global input focus.
Determines if the widget should show a visible indication that it has the global input focus.
Reverses the effects of gtk.widget.Widget.show.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts group into widget.
Inserts widget into the child widget list of parent.
Inserts widget into the child widget list of parent.
Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
Determines whether widget can be drawn to.
Determines if the widget is the focus widget within its toplevel.
Returns the widget’s effective sensitivity.
Determines whether the widget and all its parents are marked as visible.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Causes a widget to be mapped if it isn’t already.
Measures widget in the orientation orientation and for the given for_size.
Emits the ::mnemonic-activate signal.
Returns a gio.list_model.ListModel to track the children of widget.
Returns a gio.list_model.ListModel to track the gtk.event_controller.EventControllers of widget.
Finds the descendant of widget closest to the point (x, y).
Flags the widget for a rerun of the vfuncGtk.Widget.size_allocate function.
Schedules this widget to be redrawn in the paint phase of the current or the next frame.
Flags a widget to have its size renegotiated.
Creates the GDK resources associated with a widget.
Removes controller from widget, so that it doesn't process events anymore.
Removes a style from widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk.widget.Widget.addTickCallback.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether widget can be the target of pointer events.
Sets whether widget should be mapped along with its parent.
Clear all style classes applied to widget and replace them with classes.
Sets the cursor to be shown when pointer devices point towards widget.
Sets a named cursor to be shown when pointer devices point towards widget.
Sets the reading direction on a particular widget.
Set child as the current focus child of widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Specifies whether widget can own the input focus.
Sets the font map to use for Pango rendering.
Sets the cairo.font_options.FontOptions used for Pango rendering in this widget.
Sets the horizontal alignment of widget.
Sets the has-tooltip property on widget to has_tooltip.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget.
Sets the bottom margin of widget.
Sets the end margin of widget.
Sets the start margin of widget.
Sets the top margin of widget.
Sets a widgets name.
Request the widget to be rendered partially transparent.
Sets how widget treats content that is drawn outside the widget's content area.
Sets parent as the parent widget of widget.
Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets markup as the contents of the tooltip, which is marked up with Pango markup.
Sets text as the contents of the tooltip.
Sets the vertical alignment of widget.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets the visibility state of widget.
Returns whether widget should contribute to the measuring and allocation of its parent.
Flags a widget to be displayed.
Snapshot the a child of widget.
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations.
Triggers a tooltip query on the display where the toplevel of widget is located.
Causes a widget to be unmapped if it’s currently mapped.
Dissociate widget from its parent.
Causes a widget to be unrealized (frees all GDK resources associated with the widget).
Turns off flag values for the current widget state.
Connect to Destroy signal.
Connect to DirectionChanged signal.
Connect to Hide signal.
Connect to KeynavFailed signal.
Connect to Map signal.
Connect to MnemonicActivate signal.
Connect to MoveFocus signal.
Connect to QueryTooltip signal.
Connect to Realize signal.
Connect to Show signal.
Connect to StateFlagsChanged signal.
Connect to Unmap signal.
Connect to Unrealize signal.
Returns the size of a non-scrolling border around the outside of the scrollable.
Retrieves the gtk.adjustment.Adjustment used for horizontal scrolling.
Gets the horizontal gtk.types.ScrollablePolicy.
Retrieves the gtk.adjustment.Adjustment used for vertical scrolling.
Gets the vertical gtk.types.ScrollablePolicy.
Sets the horizontal adjustment of the gtk.scrollable.Scrollable.
Sets the gtk.types.ScrollablePolicy.
Sets the vertical adjustment of the gtk.scrollable.Scrollable.
Sets the gtk.types.ScrollablePolicy.
Deprecated: Use gtk.list_view.ListView for lists, and gtk.column_view.ColumnView for tabular lists
A widget for displaying both trees and lists
Widget that displays any object that implements the gtk.tree_model.TreeModel 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 gtk.tree_view.TreeView API. These are:
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.TreeView.convertWidgetToBinWindowCoords (and vice versa), for the latter gtk.tree_view.TreeView.convertBinWindowToTreeCoords (and vice versa).
gtk.tree_view.TreeView as gtk.buildable.Buildable
The gtk.tree_view.TreeView implementation of the gtk.buildable.Buildable interface accepts gtk.tree_view_column.TreeViewColumn objects as <child> elements and exposes the internal gtk.tree_selection.TreeSelection in UI definitions.
An example of a UI definition fragment with gtk.tree_view.TreeView:
CSS nodes
gtk.tree_view.TreeView 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.