TreeView

A widget for displaying both trees and lists

Widget that displays any object that implements the [iface@Gtk.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 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 [method@Gtk.TreeView.convert_widget_to_bin_window_coords] (and vice versa), for the latter [method@Gtk.TreeView.convert_bin_window_to_tree_coords] (and vice versa).

GtkTreeView as GtkBuildable

The GtkTreeView implementation of the GtkBuildable interface accepts [class@Gtk.TreeViewColumn] objects as <child> elements and exposes the internal [class@Gtk.TreeSelection] 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.

class TreeView : Widget , ScrollableIF {}

Constructors

this
this(GtkTreeView* gtkTreeView, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new #GtkTreeView widget.

this
this(TreeModelIF model)

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

Members

Functions

addOnColumnsChanged
gulong addOnColumnsChanged(void delegate(TreeView) dlg, ConnectFlags connectFlags)

The number of columns of the treeview has changed.

addOnCursorChanged
gulong addOnCursorChanged(void delegate(TreeView) dlg, ConnectFlags connectFlags)

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

addOnExpandCollapseCursorRow
gulong addOnExpandCollapseCursorRow(bool delegate(bool, bool, bool, TreeView) dlg, ConnectFlags connectFlags)
addOnMoveCursor
gulong addOnMoveCursor(bool delegate(GtkMovementStep, int, bool, bool, TreeView) dlg, ConnectFlags connectFlags)

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

addOnRowActivated
gulong addOnRowActivated(void delegate(TreePath, TreeViewColumn, TreeView) dlg, ConnectFlags connectFlags)

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.

addOnRowCollapsed
gulong addOnRowCollapsed(void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags)

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

addOnRowExpanded
gulong addOnRowExpanded(void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags)

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

addOnSelectAll
gulong addOnSelectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorParent
gulong addOnSelectCursorParent(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorRow
gulong addOnSelectCursorRow(bool delegate(bool, TreeView) dlg, ConnectFlags connectFlags)
addOnStartInteractiveSearch
gulong addOnStartInteractiveSearch(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnTestCollapseRow
gulong addOnTestCollapseRow(bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags)

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.

addOnTestExpandRow
gulong addOnTestExpandRow(bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags)

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.

addOnToggleCursorRow
gulong addOnToggleCursorRow(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnUnselectAll
gulong addOnUnselectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
appendColumn
int appendColumn(TreeViewColumn 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.

collapseAll
void collapseAll()

Recursively collapses all visible, expanded nodes in @tree_view.

collapseRow
bool collapseRow(TreePath path)

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

columnsAutosize
void columnsAutosize()

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

convertBinWindowToTreeCoords
void convertBinWindowToTreeCoords(int bx, int by, int tx, int ty)

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

convertBinWindowToWidgetCoords
void convertBinWindowToWidgetCoords(int bx, int by, int wx, int wy)

Converts bin_window coordinates to widget relative coordinates.

convertTreeToBinWindowCoords
void convertTreeToBinWindowCoords(int tx, int ty, int bx, int by)

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

convertTreeToWidgetCoords
void convertTreeToWidgetCoords(int tx, int ty, int wx, int wy)

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

convertWidgetToBinWindowCoords
void convertWidgetToBinWindowCoords(int wx, int wy, int bx, int by)

Converts widget coordinates to coordinates for the bin_window.

convertWidgetToTreeCoords
void convertWidgetToTreeCoords(int wx, int wy, int tx, int ty)

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

createRowDragIcon
PaintableIF createRowDragIcon(TreePath path)

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

enableModelDragDest
void enableModelDragDest(ContentFormats formats, GdkDragAction actions)

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

enableModelDragSource
void enableModelDragSource(GdkModifierType startButtonMask, ContentFormats formats, GdkDragAction actions)

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

expandAll
void expandAll()

Recursively expands all nodes in the @tree_view.

expandRow
bool expandRow(TreePath path, bool openAll)

Opens the row so its children are visible.

expandToPath
void expandToPath(TreePath path)

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

getActivateOnSingleClick
bool getActivateOnSingleClick()

Gets the setting set by gtk_tree_view_set_activate_on_single_click().

getBackgroundArea
void getBackgroundArea(TreePath path, TreeViewColumn column, GdkRectangle rect)

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.

getCellArea
void getCellArea(TreePath path, TreeViewColumn column, GdkRectangle rect)

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.

getColumn
TreeViewColumn getColumn(int n)

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

getColumns
ListG getColumns()

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

getCursor
void getCursor(TreePath path, TreeViewColumn focusColumn)

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.

getDestRowAtPos
bool getDestRowAtPos(int dragX, int dragY, TreePath path, GtkTreeViewDropPosition 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.

getDragDestRow
void getDragDestRow(TreePath path, GtkTreeViewDropPosition pos)

Gets information about the row that is highlighted for feedback.

getEnableSearch
bool getEnableSearch()

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

getEnableTreeLines
bool getEnableTreeLines()

Returns whether or not tree lines are drawn in @tree_view.

getExpanderColumn
TreeViewColumn getExpanderColumn()

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.

getFixedHeightMode
bool getFixedHeightMode()

Returns whether fixed height mode is turned on for @tree_view.

getGridLines
GtkTreeViewGridLines getGridLines()

Returns which grid lines are enabled in @tree_view.

getHeadersClickable
bool getHeadersClickable()

Returns whether all header columns are clickable.

getHeadersVisible
bool getHeadersVisible()

Returns %TRUE if the headers on the @tree_view are visible.

getHoverExpand
bool getHoverExpand()

Returns whether hover expansion mode is turned on for @tree_view.

getHoverSelection
bool getHoverSelection()

Returns whether hover selection mode is turned on for @tree_view.

getLevelIndentation
int getLevelIndentation()

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

getModel
TreeModelIF getModel()

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

getNColumns
uint getNColumns()

Queries the number of columns in the given @tree_view.

getPathAtPos
bool getPathAtPos(int x, int y, TreePath path, TreeViewColumn column, int cellX, int cellY)

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.

getReorderable
bool getReorderable()

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

getRowSeparatorFunc
GtkTreeViewRowSeparatorFunc getRowSeparatorFunc()

Returns the current row separator function.

getRubberBanding
bool getRubberBanding()

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.

getSearchColumn
int getSearchColumn()

Gets the column searched on by the interactive search code.

getSearchEntry
EditableIF getSearchEntry()

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.

getSearchEqualFunc
GtkTreeViewSearchEqualFunc getSearchEqualFunc()

Returns the compare function currently in use.

getSelection
TreeSelection getSelection()

Gets the #GtkTreeSelection associated with @tree_view.

getShowExpanders
bool getShowExpanders()

Returns whether or not expanders are drawn in @tree_view.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTooltipColumn
int getTooltipColumn()

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

getTooltipContext
bool getTooltipContext(int x, int y, bool keyboardTip, TreeModelIF model, TreePath path, TreeIter iter)

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.

getTreeViewStruct
GtkTreeView* getTreeViewStruct(bool transferOwnership)

Get the main Gtk struct

getVisibleRange
bool getVisibleRange(TreePath startPath, TreePath endPath)

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

getVisibleRect
void getVisibleRect(GdkRectangle visibleRect)

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.

insertColumn
int insertColumn(TreeViewColumn column, int 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.

insertColumnWithDataFunc
int insertColumnWithDataFunc(int position, string title, CellRenderer cell, GtkTreeCellDataFunc func, void* data, GDestroyNotify dnotify)

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.

isBlankAtPos
bool isBlankAtPos(int x, int y, TreePath path, TreeViewColumn column, int cellX, int cellY)

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.

isRubberBandingActive
bool isRubberBandingActive()

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

mapExpandedRows
void mapExpandedRows(GtkTreeViewMappingFunc func, void* data)

Calls @func on all expanded rows.

moveColumnAfter
void moveColumnAfter(TreeViewColumn column, TreeViewColumn baseColumn)

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

removeColumn
int removeColumn(TreeViewColumn column)

Removes @column from @tree_view.

rowActivated
void rowActivated(TreePath path, TreeViewColumn column)

Activates the cell determined by @path and @column.

rowExpanded
bool rowExpanded(TreePath path)

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

scrollToCell
void scrollToCell(TreePath path, TreeViewColumn column, bool useAlign, float rowAlign, float colAlign)

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.

scrollToPoint
void scrollToPoint(int treeX, int treeY)

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

setActivateOnSingleClick
void setActivateOnSingleClick(bool single)

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

setColumnDragFunction
void setColumnDragFunction(GtkTreeViewColumnDropFunc func, void* userData, 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.

setCursor
void setCursor(TreePath path, TreeViewColumn focusColumn, bool startEditing)

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.

setCursorOnCell
void setCursorOnCell(TreePath path, TreeViewColumn focusColumn, CellRenderer focusCell, bool startEditing)

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.

setDragDestRow
void setDragDestRow(TreePath path, GtkTreeViewDropPosition pos)

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

setEnableSearch
void setEnableSearch(bool enableSearch)

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

setEnableTreeLines
void setEnableTreeLines(bool enabled)

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

setExpanderColumn
void setExpanderColumn(TreeViewColumn 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.

setFixedHeightMode
void setFixedHeightMode(bool enable)

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.

setGridLines
void setGridLines(GtkTreeViewGridLines gridLines)

Sets which grid lines to draw in @tree_view.

setHeadersClickable
void setHeadersClickable(bool setting)

Allow the column title buttons to be clicked.

setHeadersVisible
void setHeadersVisible(bool headersVisible)

Sets the visibility state of the headers.

setHoverExpand
void setHoverExpand(bool expand)

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

setHoverSelection
void setHoverSelection(bool hover)

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.

setLevelIndentation
void setLevelIndentation(int 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.

setModel
void setModel(TreeModelIF 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.

setReorderable
void setReorderable(bool 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.

setRowSeparatorFunc
void setRowSeparatorFunc(GtkTreeViewRowSeparatorFunc func, void* data, GDestroyNotify destroy)

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.

setRubberBanding
void setRubberBanding(bool enable)

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.

setSearchColumn
void setSearchColumn(int column)

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

setSearchEntry
void setSearchEntry(EditableIF 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.

setSearchEqualFunc
void setSearchEqualFunc(GtkTreeViewSearchEqualFunc searchEqualFunc, void* searchUserData, GDestroyNotify searchDestroy)

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

setShowExpanders
void setShowExpanders(bool 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.

setTooltipCell
void setTooltipCell(Tooltip tooltip, TreePath path, TreeViewColumn column, CellRenderer 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().

setTooltipColumn
void setTooltipColumn(int 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.

setTooltipRow
void setTooltipRow(Tooltip tooltip, TreePath path)

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

unsetRowsDragDest
void unsetRowsDragDest()

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

unsetRowsDragSource
void unsetRowsDragSource()

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

Mixins

__anonymous
mixin ScrollableT!(GtkTreeView)
Undocumented in source.

Static functions

getType
GType getType()

Variables

gtkTreeView
GtkTreeView* gtkTreeView;

the main Gtk struct

Inherited Members

From Widget

gtkWidget
GtkWidget* gtkWidget;

the main Gtk struct

getWidgetStruct
GtkWidget* getWidgetStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

__anonymous
mixin AccessibleT!(GtkWidget)
Undocumented in source.
__anonymous
mixin BuildableT!(GtkWidget)
Undocumented in source.
__anonymous
mixin ConstraintTargetT!(GtkWidget)
Undocumented in source.
getType
GType getType()
getDefaultDirection
GtkTextDirection getDefaultDirection()

Obtains the current default reading direction.

setDefaultDirection
void setDefaultDirection(GtkTextDirection dir)

Sets the default reading direction for widgets.

actionSetEnabled
void actionSetEnabled(string actionName, bool enabled)

Enable or disable an action installed with gtk_widget_class_install_action().

activate
bool activate()

For widgets that can be “activated” (buttons, menu items, etc.) this function activates them.

activateActionVariant
bool activateActionVariant(string name, Variant args)

Looks up the action in the action groups associated with @widget and its ancestors, and activates it.

activateDefault
void activateDefault()

Activates the default.activate action from @widget.

addController
void addController(EventController controller)

Adds @controller to @widget so that it will receive events.

addCssClass
void addCssClass(string cssClass)

Adds a style class to @widget.

addMnemonicLabel
void addMnemonicLabel(Widget label)

Adds a widget to the list of mnemonic labels for this widget.

addTickCallback
uint addTickCallback(GtkTickCallback callback, void* userData, GDestroyNotify notify)

Queues an animation frame update and adds a callback to be called before each frame.

allocate
void allocate(int width, int height, int baseline, Transform transform)

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

childFocus
bool childFocus(GtkDirectionType direction)

Called by widgets as the user moves around the window using keyboard shortcuts.

computeBounds
bool computeBounds(Widget target, Rect outBounds)

Computes the bounds for @widget in the coordinate space of @target.

computeExpand
bool computeExpand(GtkOrientation orientation)

Computes whether a container should give this widget extra space when possible.

computePoint
bool computePoint(Widget target, Point point, Point outPoint)

Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.

computeTransform
bool computeTransform(Widget target, Matrix outTransform)

Computes a matrix suitable to describe a transformation from @widget's coordinate system into @target's coordinate system.

contains
bool contains(double x, double y)

Tests if the point at (@x, @y) is contained in @widget.

createPangoContext
PgContext createPangoContext()

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

createPangoLayout
PgLayout createPangoLayout(string text)

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

dragCheckThreshold
bool dragCheckThreshold(int startX, int startY, int currentX, int currentY)

Checks to see if a drag movement has passed the GTK drag threshold.

errorBell
void errorBell()

Notifies the user about an input-related error on this widget.

getAllocatedBaseline
int getAllocatedBaseline()

Returns the baseline that has currently been allocated to @widget.

getAllocatedHeight
int getAllocatedHeight()

Returns the height that has currently been allocated to @widget.

getAllocatedWidth
int getAllocatedWidth()

Returns the width that has currently been allocated to @widget.

getAllocation
void getAllocation(GtkAllocation allocation)

Retrieves the widget’s allocation.

getAncestor
Widget getAncestor(GType widgetType)

Gets the first ancestor of @widget with type @widget_type.

getCanFocus
bool getCanFocus()

Determines whether the input focus can enter @widget or any of its children.

getCanTarget
bool getCanTarget()

Queries whether @widget can be the target of pointer events.

getChildVisible
bool getChildVisible()

Gets the value set with gtk_widget_set_child_visible().

getClipboard
Clipboard getClipboard()

Gets the clipboard object for @widget.

getCssClasses
string[] getCssClasses()

Returns the list of style classes applied to @widget.

getCssName
string getCssName()

Returns the CSS name that is used for @self.

getCursor
Cursor getCursor()

Queries the cursor set on @widget.

getDirection
GtkTextDirection getDirection()

Gets the reading direction for a particular widget.

getDisplay
Display getDisplay()

Get the GdkDisplay for the toplevel window associated with this widget.

getFirstChild
Widget getFirstChild()

Returns the widgets first child.

getFocusChild
Widget getFocusChild()

Returns the current focus child of @widget.

getFocusOnClick
bool getFocusOnClick()

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

getFocusable
bool getFocusable()

Determines whether @widget can own the input focus.

getFontMap
PgFontMap getFontMap()

Gets the font map of @widget.

getFontOptions
FontOption getFontOptions()

Returns the cairo_font_options_t used for Pango rendering.

getFrameClock
FrameClock getFrameClock()

Obtains the frame clock for a widget.

getHalign
GtkAlign getHalign()

Gets the horizontal alignment of @widget.

getHasTooltip
bool getHasTooltip()

Returns the current value of the has-tooltip property.

getHeight
int getHeight()

Returns the content height of the widget.

getHexpand
bool getHexpand()

Gets whether the widget would like any available extra horizontal space.

getHexpandSet
bool getHexpandSet()

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

getLastChild
Widget getLastChild()

Returns the widgets last child.

getLayoutManager
LayoutManager getLayoutManager()

Retrieves the layout manager used by @widget

getMapped
bool getMapped()

Whether the widget is mapped.

getMarginBottom
int getMarginBottom()

Gets the bottom margin of @widget.

getMarginEnd
int getMarginEnd()

Gets the end margin of @widget.

getMarginStart
int getMarginStart()

Gets the start margin of @widget.

getMarginTop
int getMarginTop()

Gets the top margin of @widget.

getName
string getName()

Retrieves the name of a widget.

getNative
NativeIF getNative()

Returns the GtkNative widget that contains @widget.

getNextSibling
Widget getNextSibling()

Returns the widgets next sibling.

getOpacity
double getOpacity()

#Fetches the requested opacity for this widget.

getOverflow
GtkOverflow getOverflow()

Returns the widgets overflow value.

getPangoContext
PgContext getPangoContext()

Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.

getParent
Widget getParent()

Returns the parent widget of @widget.

getPreferredSize
void getPreferredSize(Requisition minimumSize, Requisition naturalSize)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

getPrevSibling
Widget getPrevSibling()

Returns the widgets previous sibling.

getPrimaryClipboard
Clipboard getPrimaryClipboard()

Gets the primary clipboard of @widget.

getRealized
bool getRealized()

Determines whether @widget is realized.

getReceivesDefault
bool getReceivesDefault()

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.

getRequestMode
GtkSizeRequestMode getRequestMode()

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

getRoot
RootIF getRoot()

Returns the GtkRoot widget of @widget.

getScaleFactor
int getScaleFactor()

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

getSensitive
bool getSensitive()

Returns the widget’s sensitivity.

getSettings
Settings getSettings()

Gets the settings object holding the settings used for this widget.

getSize
int getSize(GtkOrientation orientation)

Returns the content width or height of the widget.

getSizeRequest
void getSizeRequest(int width, int height)

Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request().

getStateFlags
GtkStateFlags getStateFlags()

Returns the widget state as a flag set.

getStyleContext
StyleContext getStyleContext()

Returns the style context associated to @widget.

getTemplateChild
ObjectG getTemplateChild(GType widgetType, string name)

Fetch an object build from the template XML for @widget_type in this @widget instance.

getTooltipMarkup
string getTooltipMarkup()

Gets the contents of the tooltip for @widget.

getTooltipText
string getTooltipText()

Gets the contents of the tooltip for @widget.

getValign
GtkAlign getValign()

Gets the vertical alignment of @widget.

getVexpand
bool getVexpand()

Gets whether the widget would like any available extra vertical space.

getVexpandSet
bool getVexpandSet()

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

getVisible
bool getVisible()

Determines whether the widget is visible.

getWidth
int getWidth()

Returns the content width of the widget.

grabFocus
bool grabFocus()

Causes @widget to have the keyboard focus for the GtkWindow it's inside.

hasCssClass
bool hasCssClass(string cssClass)

Returns whether @css_class is currently applied to @widget.

hasDefault
bool hasDefault()

Determines whether @widget is the current default widget within its toplevel.

hasFocus
bool hasFocus()

Determines if the widget has the global input focus.

hasVisibleFocus
bool hasVisibleFocus()

Determines if the widget should show a visible indication that it has the global input focus.

hide
void hide()

Reverses the effects of gtk_widget_show().

inDestruction
bool inDestruction()

Returns whether the widget is currently being destroyed.

initTemplate
void initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup
void insertActionGroup(string name, ActionGroupIF group)

Inserts @group into @widget.

insertAfter
void insertAfter(Widget parent, Widget previousSibling)

Inserts @widget into the child widget list of @parent.

insertBefore
void insertBefore(Widget parent, Widget nextSibling)

Inserts @widget into the child widget list of @parent.

isAncestor
bool isAncestor(Widget ancestor)

Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

isDrawable
bool isDrawable()

Determines whether @widget can be drawn to.

isFocus
bool isFocus()

Determines if the widget is the focus widget within its toplevel.

isSensitive
bool isSensitive()

Returns the widget’s effective sensitivity.

isVisible
bool isVisible()

Determines whether the widget and all its parents are marked as visible.

keynavFailed
bool keynavFailed(GtkDirectionType direction)

Emits the ::keynav-failed signal on the widget.

listMnemonicLabels
ListG listMnemonicLabels()

Returns the widgets for which this widget is the target of a mnemonic.

map
void map()

Causes a widget to be mapped if it isn’t already.

measure
void measure(GtkOrientation orientation, int forSize, int minimum, int natural, int minimumBaseline, int naturalBaseline)

Measures @widget in the orientation @orientation and for the given @for_size.

mnemonicActivate
bool mnemonicActivate(bool groupCycling)

Emits the GtkWidget::mnemonic-activate signal.

observeChildren
ListModelIF observeChildren()

Returns a GListModel to track the children of @widget.

observeControllers
ListModelIF observeControllers()

Returns a GListModel to track the [class@Gtk.EventController]s of @widget.

pick
Widget pick(double x, double y, GtkPickFlags flags)

Finds the descendant of @widget closest to the screen at the point (@x, @y).

queueAllocate
void queueAllocate()

Flags the widget for a rerun of the GtkWidgetClass::size_allocate function.

queueDraw
void queueDraw()

Schedules this widget to be redrawn in paint phase of the current or the next frame.

queueResize
void queueResize()

Flags a widget to have its size renegotiated.

realize
void realize()

Creates the GDK resources associated with a widget.

removeController
void removeController(EventController controller)

Removes @controller from @widget, so that it doesn't process events anymore.

removeCssClass
void removeCssClass(string cssClass)

Removes a style from @widget.

removeMnemonicLabel
void removeMnemonicLabel(Widget label)

Removes a widget from the list of mnemonic labels for this widget.

removeTickCallback
void removeTickCallback(uint id)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

setCanFocus
void setCanFocus(bool canFocus)

Specifies whether the input focus can enter the widget or any of its children.

setCanTarget
void setCanTarget(bool canTarget)

Sets whether @widget can be the target of pointer events.

setChildVisible
void setChildVisible(bool childVisible)

Sets whether @widget should be mapped along with its parent.

setCssClasses
void setCssClasses(string[] classes)

Will clear all style classes applied to @widget and replace them with @classes.

setCursor
void setCursor(Cursor cursor)

Sets the cursor to be shown when pointer devices point towards @widget.

setCursorFromName
void setCursorFromName(string name)

Sets a named cursor to be shown when pointer devices point towards @widget.

setDirection
void setDirection(GtkTextDirection dir)

Sets the reading direction on a particular widget.

setFocusChild
void setFocusChild(Widget child)

Set @child as the current focus child of @widget.

setFocusOnClick
void setFocusOnClick(bool focusOnClick)

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

setFocusable
void setFocusable(bool focusable)

Specifies whether @widget can own the input focus.

setFontMap
void setFontMap(PgFontMap fontMap)

Sets the font map to use for Pango rendering.

setFontOptions
void setFontOptions(FontOption options)

Sets the cairo_font_options_t used for Pango rendering in this widget.

setHalign
void setHalign(GtkAlign align_)

Sets the horizontal alignment of @widget.

setHasTooltip
void setHasTooltip(bool hasTooltip)

Sets the has-tooltip property on @widget to @has_tooltip.

setHexpand
void setHexpand(bool expand)

Sets whether the widget would like any available extra horizontal space.

setHexpandSet
void setHexpandSet(bool set)

Sets whether the hexpand flag will be used.

setLayoutManager
void setLayoutManager(LayoutManager layoutManager)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.

setMarginBottom
void setMarginBottom(int margin)

Sets the bottom margin of @widget.

setMarginEnd
void setMarginEnd(int margin)

Sets the end margin of @widget.

setMarginStart
void setMarginStart(int margin)

Sets the start margin of @widget.

setMarginTop
void setMarginTop(int margin)

Sets the top margin of @widget.

setName
void setName(string name)

Sets a widgets name.

setOpacity
void setOpacity(double opacity)

Request the @widget to be rendered partially transparent.

setOverflow
void setOverflow(GtkOverflow overflow)

Sets how @widget treats content that is drawn outside the widget's content area.

setParent
void setParent(Widget parent)

Sets @parent as the parent widget of @widget.

setReceivesDefault
void setReceivesDefault(bool receivesDefault)

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.

setSensitive
void setSensitive(bool sensitive)

Sets the sensitivity of a widget.

setSizeRequest
void setSizeRequest(int width, int height)

Sets the minimum size of a widget.

setStateFlags
void setStateFlags(GtkStateFlags flags, bool clear)

Turns on flag values in the current widget state.

setTooltipMarkup
void setTooltipMarkup(string markup)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup.

setTooltipText
void setTooltipText(string text)

Sets @text as the contents of the tooltip.

setValign
void setValign(GtkAlign align_)

Sets the vertical alignment of @widget.

setVexpand
void setVexpand(bool expand)

Sets whether the widget would like any available extra vertical space.

setVexpandSet
void setVexpandSet(bool set)

Sets whether the vexpand flag will be used.

setVisible
void setVisible(bool visible)

Sets the visibility state of @widget.

shouldLayout
bool shouldLayout()

Returns whether @widget should contribute to the measuring and allocation of its parent.

show
void show()

Flags a widget to be displayed.

sizeAllocate
void sizeAllocate(GtkAllocation* allocation, int baseline)

Allocates widget with a transformation that translates the origin to the position in @allocation.

snapshotChild
void snapshotChild(Widget child, Snapshot snapshot)

Snapshot the a child of @widget.

translateCoordinates
bool translateCoordinates(Widget destWidget, double srcX, double srcY, double destX, double destY)

Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations.

triggerTooltipQuery
void triggerTooltipQuery()

Triggers a tooltip query on the display where the toplevel of @widget is located.

unmap
void unmap()

Causes a widget to be unmapped if it’s currently mapped.

unparent
void unparent()

Dissociate @widget from its parent.

unrealize
void unrealize()

Causes a widget to be unrealized (frees all GDK resources associated with the widget).

unsetStateFlags
void unsetStateFlags(GtkStateFlags flags)

Turns off flag values for the current widget state.

addOnDestroy
gulong addOnDestroy(void delegate(Widget) dlg, ConnectFlags connectFlags)

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

addOnDirectionChanged
gulong addOnDirectionChanged(void delegate(GtkTextDirection, Widget) dlg, ConnectFlags connectFlags)

Emitted when the text direction of a widget changes.

addOnHide
gulong addOnHide(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is hidden.

addOnKeynavFailed
gulong addOnKeynavFailed(bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags)

Emitted if keyboard navigation fails.

addOnMap
gulong addOnMap(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is going to be mapped.

addOnMnemonicActivate
gulong addOnMnemonicActivate(bool delegate(bool, Widget) dlg, ConnectFlags connectFlags)

Emitted when a widget is activated via a mnemonic.

addOnMoveFocus
gulong addOnMoveFocus(void delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags)

Emitted when the focus is moved.

addOnQueryTooltip
gulong addOnQueryTooltip(bool delegate(int, int, bool, Tooltip, Widget) dlg, ConnectFlags connectFlags)

Emitted when the widgets tooltip is about to be shown.

addOnRealize
gulong addOnRealize(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is associated with a GdkSurface.

addOnShow
gulong addOnShow(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is shown.

addOnStateFlagsChanged
gulong addOnStateFlagsChanged(void delegate(GtkStateFlags, Widget) dlg, ConnectFlags connectFlags)

Emitted when the widget state changes.

addOnUnmap
gulong addOnUnmap(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is going to be unmapped.

addOnUnrealize
gulong addOnUnrealize(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when the GdkSurface associated with @widget is destroyed.

From ScrollableIF

getScrollableStruct
GtkScrollable* getScrollableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getBorder
bool getBorder(Border border)

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

getHadjustment
Adjustment getHadjustment()

Retrieves the GtkAdjustment used for horizontal scrolling.

getHscrollPolicy
GtkScrollablePolicy getHscrollPolicy()

Gets the horizontal GtkScrollablePolicy.

getVadjustment
Adjustment getVadjustment()

Retrieves the GtkAdjustment used for vertical scrolling.

getVscrollPolicy
GtkScrollablePolicy getVscrollPolicy()

Gets the vertical GtkScrollablePolicy.

setHadjustment
void setHadjustment(Adjustment hadjustment)

Sets the horizontal adjustment of the GtkScrollable.

setHscrollPolicy
void setHscrollPolicy(GtkScrollablePolicy policy)

Sets the GtkScrollablePolicy.

setVadjustment
void setVadjustment(Adjustment vadjustment)

Sets the vertical adjustment of the GtkScrollable.

setVscrollPolicy
void setVscrollPolicy(GtkScrollablePolicy policy)

Sets the GtkScrollablePolicy.

Meta