Libraries:Gtk:Gtk:TreeView

Types

T

Inherits from:

Gtk.Gtk.Container.T, Gtk.Gtk.Widget.T, Gtk.Gtk.Object.T, Gtk.GObject.Object.T

Widget that displays any object that implements the GtkTreeModel interface.

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

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

Widget coordinates -- coordinates relative to the widget (usually widget->window.

Bin window coordinates -- coordinates relative to the window that GtkTreeView renders to.

Tree coordinates -- coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree.

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

GtkTreeView as GtkBuildable

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

Example 23. 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>

Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T

ModeGetType() : Gtk.GObject.Type.T

New() : Gtk.Gtk.TreeView.T

Creates a new T widget.

Returns

A newly created T widget.

NewWithModel(model @ Gtk.Gtk.TreeModel.T) : Gtk.Gtk.TreeView.T

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

model	the model.
Returns	A newly created T widget.

Methods

:AppendColumn(self @ T, column @ Gtk.Gtk.TreeViewColumn.T) : Std.Integer.SmallT

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

tree_view	A T.
column	The Gtk.Gtk.TreeViewColumn.T to add.
Returns	The number of columns in tree_view after appending.

:CollapseAll(self @ T) : Std.Object.T

Recursively collapses all visible, expanded nodes in tree_view.

tree_view

A T.

:CollapseRow(self @ T, path @ Gtk.Gtk.TreePath.T) : Std.Symbol.T

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

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

:ColumnsAutosize(self @ T) : Std.Object.T

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

tree_view

A T.

:ConvertBinWindowToTreeCoords(self @ T, bx @ Std.Integer.SmallT, by @ Std.Integer.SmallT, tx @ Std.Object.T, ty @ Std.Object.T) : Std.Object.T

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

tree_view	a T
bx	X coordinate relative to bin_window
by	Y coordinate relative to bin_window
tx	return location for tree X coordinate. [out]
ty	return location for tree Y coordinate. [out]

:ConvertBinWindowToWidgetCoords(self @ T, bx @ Std.Integer.SmallT, by @ Std.Integer.SmallT, wx @ Std.Object.T, wy @ Std.Object.T) : Std.Object.T

Converts bin_window coordinates (see GetBinWindow) to widget relative coordinates.

tree_view	a T
bx	bin_window X coordinate
by	bin_window Y coordinate
wx	return location for widget X coordinate. [out]
wy	return location for widget Y coordinate. [out]

:ConvertTreeToBinWindowCoords(self @ T, tx @ Std.Integer.SmallT, ty @ Std.Integer.SmallT, bx @ Std.Object.T, by @ Std.Object.T) : Std.Object.T

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

tree_view	a T
tx	tree X coordinate
ty	tree Y coordinate
bx	return location for X coordinate relative to bin_window. [out]
by	return location for Y coordinate relative to bin_window. [out]

:ConvertTreeToWidgetCoords(self @ T, tx @ Std.Integer.SmallT, ty @ Std.Integer.SmallT, wx @ Std.Object.T, wy @ Std.Object.T) : Std.Object.T

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

tree_view	a T
tx	X coordinate relative to the tree
ty	Y coordinate relative to the tree
wx	return location for widget X coordinate. [out]
wy	return location for widget Y coordinate. [out]

:ConvertWidgetToBinWindowCoords(self @ T, wx @ Std.Integer.SmallT, wy @ Std.Integer.SmallT, bx @ Std.Object.T, by @ Std.Object.T) : Std.Object.T

Converts widget coordinates to coordinates for the bin_window (see GetBinWindow).

tree_view	a T
wx	X coordinate relative to the widget
wy	Y coordinate relative to the widget
bx	return location for bin_window X coordinate. [out]
by	return location for bin_window Y coordinate. [out]

:ConvertWidgetToTreeCoords(self @ T, wx @ Std.Integer.SmallT, wy @ Std.Integer.SmallT, tx @ Std.Object.T, ty @ Std.Object.T) : Std.Object.T

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

tree_view	a T
wx	X coordinate relative to the widget
wy	Y coordinate relative to the widget
tx	return location for tree X coordinate. [out]
ty	return location for tree Y coordinate. [out]

:CreateRowDragIcon(self @ T, path @ Gtk.Gtk.TreePath.T) : Gtk.Gdk.Pixmap.T

Creates a Gtk.Gdk.Pixmap.T representation of the row at path. This image is used for a drag icon.

tree_view	a T
path	a Gtk.Gtk.TreePath.T in tree_view
Returns	a newly-allocated pixmap of the drag icon. [transfer none]

:EnableModelDragDest(self @ T, targets @ Gtk.Gtk.TargetEntry.T, n_targets @ Std.Integer.SmallT, actions @ Std.Integer.SmallT) : Std.Object.T

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

tree_view	a T
targets	the table of targets that the drag will support. [array length=n_targets]
n_targets	the number of items in targets
actions	the bitmask of possible actions for a drag from this widget

:EnableModelDragSource(self @ T, start_button_mask @ Std.Integer.SmallT, targets @ Gtk.Gtk.TargetEntry.T, n_targets @ Std.Integer.SmallT, actions @ Std.Integer.SmallT) : Std.Object.T

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

tree_view	a T
start_button_mask	Mask of allowed buttons to start drag
targets	the table of targets that the drag will support
n_targets	the number of items in targets
actions	the bitmask of possible actions for a drag from this widget

:ExpandAll(self @ T) : Std.Object.T

Recursively expands all nodes in the tree_view.

tree_view

A T.

:ExpandRow(self @ T, path @ Gtk.Gtk.TreePath.T, open_all @ Std.Symbol.T) : Std.Symbol.T

Opens the row so its children are visible.

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

:ExpandToPath(self @ T, path @ Gtk.Gtk.TreePath.T) : Std.Object.T

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

tree_view	A T.
path	path to a row.

:GetBackgroundArea(self @ T, path @ Gtk.Gtk.TreePath.T, column @ Gtk.Gtk.TreeViewColumn.T, rect @ Gtk.Gdk.Rectangle.T) : Std.Object.T

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.Gtk.CellRenderer.Render. These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by GetCellArea, which returns only the cell itself, excluding surrounding borders and the tree expander area.

tree_view	a T
path	a Gtk.Gtk.TreePath.T for the row, or NULL to get only horizontal coordinates. [allow-none]
column	a Gtk.Gtk.TreeViewColumn.T for the column, or NULL to get only vertical coordiantes. [allow-none]
rect	rectangle to fill with cell background rect. [out]

:GetBinWindow(self @ T) : Gtk.Gdk.Window.T

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.

tree_view	A T
Returns	A Gtk.Gdk.Window.T, or NULL when tree_view hasn't been realized yet. [transfer none]

:GetCellArea(self @ T, path @ Gtk.Gtk.TreePath.T, column @ Gtk.Gtk.TreeViewColumn.T, rect @ Gtk.Gdk.Rectangle.T) : Std.Object.T

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.Gtk.CellRenderer.Render. This function is only valid if tree_view is realized.

tree_view	a T
path	a Gtk.Gtk.TreePath.T for the row, or NULL to get only horizontal coordinates. [allow-none]
column	a Gtk.Gtk.TreeViewColumn.T for the column, or NULL to get only vertical coordinates. [allow-none]
rect	rectangle to fill with cell rect. [out]

:GetColumn(self @ T, n @ Std.Integer.SmallT) : Gtk.Gtk.TreeViewColumn.T

Gets the Gtk.Gtk.TreeViewColumn.T at the given position in the tree_view.

tree_view	A T.
n	The position of the column, counting from 0.
Returns	The Gtk.Gtk.TreeViewColumn.T, or NULL if the position is outside the range of columns. [transfer none]

:GetColumns(self @ T) : Std.Object.T

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

tree_view	A T
Returns	A list of Gtk.Gtk.TreeViewColumn.T s. [element-type GtkTreeViewColumn][transfer container]

:GetCursor(self @ T, path, focus_column) : Std.Object.T

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

The returned Gtk.Gtk.TreePath.T must be freed with Gtk.Gtk.TreePath.Free when you are done with it.

tree_view	A T
path	A pointer to be filled with the current cursor path, or NULL. [out][transfer full][allow-none]
focus_column	A pointer to be filled with the current focus column, or NULL. [out][transfer none][allow-none]

:GetDestRowAtPos(self @ T, drag_x @ Std.Integer.SmallT, drag_y @ Std.Integer.SmallT, path @ Std.Object.T, pos @ Std.Object.T) : Std.Symbol.T

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.

tree_view	a T
drag_x	the position to determine the destination row for
drag_y	the position to determine the destination row for
path	Return location for the path of the highlighted row, or NULL. [out][allow-none]
pos	Return location for the drop position, or NULL. [out][allow-none]
Returns	whether there is a row at the given position, TRUE if this is indeed the case.

:GetDragDestRow(self @ T, path @ Std.Object.T, pos @ Std.Object.T) : Std.Object.T

Gets information about the row that is highlighted for feedback.

tree_view	a T
path	Return location for the path of the highlighted row, or NULL. [out][allow-none]
pos	Return location for the drop position, or NULL. [out][allow-none]

:GetEnableSearch(self @ T) : Std.Symbol.T

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

tree_view	A T
Returns	whether or not to let the user search interactively

:GetEnableTreeLines(self @ T) : Std.Symbol.T

Returns whether or not tree lines are drawn in tree_view.

tree_view	a T.
Returns	TRUE if tree lines are drawn in tree_view, FALSE otherwise.

:GetExpanderColumn(self @ T) : Gtk.Gtk.TreeViewColumn.T

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

tree_view	A T
Returns	The expander column. [transfer none]

:GetFixedHeightMode(self @ T) : Std.Symbol.T

Returns whether fixed height mode is turned on for tree_view.

tree_view	a T
Returns	TRUE if tree_view is in fixed height mode

:GetGridLines(self @ T) : Gtk.Gtk.TreeViewGridLines.T

Returns which grid lines are enabled in tree_view.

tree_view	a T
Returns	a Gtk.Gtk.TreeViewGridLines.T value indicating which grid lines are enabled.

:GetHadjustment(self @ T) : Gtk.Gtk.Adjustment.T

Gets the Gtk.Gtk.Adjustment.T currently being used for the horizontal aspect.

tree_view	A T
Returns	A Gtk.Gtk.Adjustment.T object, or NULL if none is currently being used. [transfer none]

:GetHeadersClickable(self @ T) : Std.Symbol.T

Returns whether all header columns are clickable.

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

:GetHeadersVisible(self @ T) : Std.Symbol.T

Returns TRUE if the headers on the tree_view are visible.

tree_view	A T.
Returns	Whether the headers are visible or not.

:GetHoverExpand(self @ T) : Std.Symbol.T

Returns whether hover expansion mode is turned on for tree_view.

tree_view	a T
Returns	TRUE if tree_view is in hover expansion mode

:GetHoverSelection(self @ T) : Std.Symbol.T

Returns whether hover selection mode is turned on for tree_view.

tree_view	a T
Returns	TRUE if tree_view is in hover selection mode

:GetLevelIndentation(self @ T) : Std.Integer.SmallT

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

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

:GetModel(self @ T) : Gtk.Gtk.TreeModel.T

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

tree_view	a T
Returns	A Gtk.Gtk.TreeModel.T, or NULL if none is currently being used. [transfer none]

:GetPathAtPos(self @ T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT, path, column, cell_x @ Std.Object.T, cell_y @ Std.Object.T) : Std.Symbol.T

Finds the path at the point (x, y), relative to bin_window coordinates (please see 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.Gtk.TreePath.T at that point. This path should be freed with Gtk.Gtk.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.Gtk.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.

For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see ConvertWidgetToBinWindowCoords.

tree_view	A T.
x	The x position to be identified (relative to bin_window).
y	The y position to be identified (relative to bin_window).
path	A pointer to a Gtk.Gtk.TreePath.T pointer to be filled in, or NULL. [out][allow-none]
column	A pointer to a Gtk.Gtk.TreeViewColumn.T pointer to be filled in, or NULL. [out][transfer none][allow-none]
cell_x	A pointer where the X coordinate relative to the cell can be placed, or NULL. [out][allow-none]
cell_y	A pointer where the Y coordinate relative to the cell can be placed, or NULL. [out][allow-none]
Returns	TRUE if a row exists at that coordinate.

:GetReorderable(self @ T) : Std.Symbol.T

Retrieves whether the user can reorder the tree via drag-and-drop. See SetReorderable.

tree_view	a T
Returns	TRUE if the tree can be reordered.

:GetRowSeparatorFunc(self @ T) : Std.Function.T

Returns the current row separator function.

tree_view	a T
Returns	the current row separator function.

:GetRubberBanding(self @ T) : Std.Symbol.T

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

tree_view	a T
Returns	TRUE if rubber banding in tree_view is enabled.

:GetRulesHint(self @ T) : Std.Symbol.T

Gets the setting set by SetRulesHint.

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

:GetSearchColumn(self @ T) : Std.Integer.SmallT

Gets the column searched on by the interactive search code.

tree_view	A T
Returns	the column the interactive search code searches in.

:GetSearchEntry(self @ T) : Gtk.Gtk.Entry.T

Returns the Gtk.Gtk.Entry.T 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.

tree_view	A T
Returns	the entry currently in use as search entry. [transfer none]

:GetSearchEqualFunc(self @ T) : Std.Function.T

Returns the compare function currently in use.

tree_view	A T
Returns	the currently used compare function for the search code.

:GetSearchPositionFunc(self @ T) : Std.Function.T

Returns the positioning function currently in use.

tree_view	A T
Returns	the currently used function for positioning the search dialog.

:GetSelection(self @ T) : Gtk.Gtk.TreeSelection.T

Gets the Gtk.Gtk.TreeSelection.T associated with tree_view.

tree_view	A T.
Returns	A Gtk.Gtk.TreeSelection.T object. [transfer none]

:GetShowExpanders(self @ T) : Std.Symbol.T

Returns whether or not expanders are drawn in tree_view.

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

:GetTooltipColumn(self @ T) : Std.Integer.SmallT

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

tree_view	a T
Returns	the index of the tooltip column that is currently being used, or -1 if this is disabled.

:GetTooltipContext(self @ T, x @ Std.Object.T, y @ Std.Object.T, keyboard_tip @ Std.Symbol.T, model @ Std.Object.T, path @ Std.Object.T, iter @ Gtk.Gtk.TreeIter.T) : Std.Symbol.T

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

The return value indicates whether there is a tree view row at the given coordinates (TRUE) or not (FALSE) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. When TRUE, then any of model, path and iter which have been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to tree_view's bin_window if keyboard_tooltip is FALSE.

tree_view	a T
x	the x coordinate (relative to widget coordinates). [inout]
y	the y coordinate (relative to widget coordinates). [inout]
keyboard_tip	whether this is a keyboard tooltip or not
model	a pointer to receive a Gtk.Gtk.TreeModel.T or NULL. [out][allow-none]
path	a pointer to receive a Gtk.Gtk.TreePath.T or NULL. [out][allow-none]
iter	a pointer to receive a Gtk.Gtk.TreeIter.T or NULL. [out][allow-none]
Returns	whether or not the given tooltip context points to a row.

:GetVadjustment(self @ T) : Gtk.Gtk.Adjustment.T

Gets the Gtk.Gtk.Adjustment.T currently being used for the vertical aspect.

tree_view	A T
Returns	A Gtk.Gtk.Adjustment.T object, or NULL if none is currently being used. [transfer none]

:GetVisibleRange(self @ T, start_path @ Std.Object.T, end_path @ Std.Object.T) : Std.Symbol.T

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

The paths should be freed with Gtk.Gtk.TreePath.Free after use.

tree_view	A T
start_path	Return location for start of region, or NULL. [out][allow-none]
end_path	Return location for end of region, or NULL. [out][allow-none]
Returns	TRUE, if valid paths were placed in start_path and end_path.

:GetVisibleRect(self @ T, visible_rect @ Gtk.Gdk.Rectangle.T) : Std.Object.T

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

tree_view	a T
visible_rect	rectangle to fill. [out]

:InsertColumn(self @ T, column @ Gtk.Gtk.TreeViewColumn.T, position @ Std.Integer.SmallT) : Std.Integer.SmallT

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

tree_view	A T.
column	The Gtk.Gtk.TreeViewColumn.T to be inserted.
position	The position to insert column in.
Returns	The number of columns in tree_view after insertion.

:InsertColumnWithAttributes(self @ T, position @ Std.Integer.SmallT, title @ Std.String.T, cell @ Gtk.Gtk.CellRenderer.T, ... @ Std.Object.T) : Std.Integer.SmallT

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

tree_view	A T
position	The position to insert the new column in.
title	The title to set the header to.
cell	The Gtk.Gtk.CellRenderer.T.
Returns	The number of columns in tree_view after insertion.

:InsertColumnWithDataFunc(self @ T, position @ Std.Integer.SmallT, title @ Std.String.T, cell @ Gtk.Gtk.CellRenderer.T, func @ Std.Function.T, data @ Std.Address.T, dnotify @ Std.Function.T) : Std.Integer.SmallT

Convenience function that inserts a new column into the T with the given cell renderer and a GtkCellDataFunc to set cell renderer attributes (normally using data from the model). See also Gtk.Gtk.TreeViewColumn.SetCellDataFunc, Gtk.Gtk.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.

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

:IsRubberBandingActive(self @ T) : Std.Symbol.T

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

tree_view	a T
Returns	TRUE if a rubber banding operation is currently being done in tree_view.

:MapExpandedRows(self @ T, func @ Std.Function.T, data @ Std.Address.T) : Std.Object.T

Calls func on all expanded rows.

tree_view	A T
func	A function to be called. [scope call]
data	User data to be passed to the function.

:MoveColumnAfter(self @ T, column @ Gtk.Gtk.TreeViewColumn.T, base_column @ Gtk.Gtk.TreeViewColumn.T) : Std.Object.T

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

tree_view	A T
column	The Gtk.Gtk.TreeViewColumn.T to be moved.
base_column	The Gtk.Gtk.TreeViewColumn.T to be moved relative to, or NULL. [allow-none]

:RemoveColumn(self @ T, column @ Gtk.Gtk.TreeViewColumn.T) : Std.Integer.SmallT

Removes column from tree_view.

tree_view	A T.
column	The Gtk.Gtk.TreeViewColumn.T to remove.
Returns	The number of columns in tree_view after removing.

:RowActivated(self @ T, path @ Gtk.Gtk.TreePath.T, column @ Gtk.Gtk.TreeViewColumn.T) : Std.Object.T

Activates the cell determined by path and column.

tree_view	A T
path	The Gtk.Gtk.TreePath.T to be activated.
column	The Gtk.Gtk.TreeViewColumn.T to be activated.

:RowExpanded(self @ T, path @ Gtk.Gtk.TreePath.T) : Std.Symbol.T

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

tree_view	A T.
path	A Gtk.Gtk.TreePath.T to test expansion state.
Returns	TRUE if path is expanded.

:ScrollToCell(self @ T, path @ Gtk.Gtk.TreePath.T, column @ Gtk.Gtk.TreeViewColumn.T, use_align @ Std.Symbol.T, row_align @ Std.Real.T, col_align @ Std.Real.T) : Std.Object.T

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

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

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

tree_view	A T.
path	The path of the row to move to, or NULL. [allow-none]
column	The Gtk.Gtk.TreeViewColumn.T to move horizontally to, or NULL. [allow-none]
use_align	whether to use alignment arguments, or FALSE.
row_align	The vertical alignment of the row specified by path.
col_align	The horizontal alignment of the column specified by column.

:ScrollToPoint(self @ T, tree_x @ Std.Integer.SmallT, tree_y @ Std.Integer.SmallT) : Std.Object.T

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

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

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

:SetColumnDragFunction(self @ T, func @ Std.Function.T, user_data, destroy @ Std.Function.T) : Std.Object.T

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.Gtk.TreeViewColumn.T being dragged, the two Gtk.Gtk.TreeViewColumn.T s determining the drop spot, and user_data. If either of the Gtk.Gtk.TreeViewColumn.T arguments for the drop spot are NULL, then they indicate an edge. If func is set to be NULL, then tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.

tree_view	A T.
func	A function to determine which columns are reorderable, or NULL. [allow-none]
user_data	User data to be passed to func, or NULL. [allow-none]
destroy	Destroy notifier for user_data, or NULL. [allow-none]

:SetCursor(self @ T, path @ Gtk.Gtk.TreePath.T, focus_column @ Gtk.Gtk.TreeViewColumn.T, start_editing @ Std.Symbol.T) : Std.Object.T

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.

If path is invalid for model, the current cursor (if any) will be unset and the function will return without failing.

tree_view	A T
path	A Gtk.Gtk.TreePath.T
focus_column	A Gtk.Gtk.TreeViewColumn.T, or NULL. [allow-none]
start_editing	TRUE if the specified cell should start being edited.

:SetCursorOnCell(self @ T, path @ Gtk.Gtk.TreePath.T, focus_column @ Gtk.Gtk.TreeViewColumn.T, focus_cell @ Gtk.Gtk.CellRenderer.T, start_editing @ Std.Symbol.T) : Std.Object.T

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.

If path is invalid for model, the current cursor (if any) will be unset and the function will return without failing.

tree_view	A T
path	A Gtk.Gtk.TreePath.T
focus_column	A Gtk.Gtk.TreeViewColumn.T, or NULL. [allow-none]
focus_cell	A Gtk.Gtk.CellRenderer.T, or NULL. [allow-none]
start_editing	TRUE if the specified cell should start being edited.

:SetDestroyCountFunc(self @ T, func @ Std.Function.T, data @ Std.Address.T, destroy @ Std.Function.T) : Std.Object.T

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.

tree_view	A T
func	Function to be called when a view row is destroyed, or NULL. [allow-none]
data	User data to be passed to func, or NULL. [allow-none]
destroy	Destroy notifier for data, or NULL. [allow-none]

:SetDragDestRow(self @ T, path @ Gtk.Gtk.TreePath.T, pos @ Gtk.Gtk.TreeViewDropPosition.T) : Std.Object.T

Sets the row that is highlighted for feedback.

tree_view	a T
path	The path of the row to highlight, or NULL. [allow-none]
pos	Specifies whether to drop before, after or into the row

:SetEnableSearch(self @ T, enable_search @ Std.Symbol.T) : Std.Object.T

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

Note that even if this is FALSE, the user can still initiate a search using the "start-interactive-search" key binding.

tree_view	A T
enable_search	TRUE, if the user can search interactively

:SetEnableTreeLines(self @ T, enabled @ Std.Symbol.T) : Std.Object.T

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

tree_view	a T
enabled	TRUE to enable tree line drawing, FALSE otherwise.

:SetExpanderColumn(self @ T, column @ Gtk.Gtk.TreeViewColumn.T) : Std.Object.T

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

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

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

:SetFixedHeightMode(self @ T, enable @ Std.Symbol.T) : Std.Object.T

Enables or disables the fixed height mode of tree_view. Fixed height mode speeds up T 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.Gtk.TreeViewColumnSizing.Fixed.

tree_view	a T
enable	TRUE to enable fixed height mode

:SetGridLines(self @ T, grid_lines @ Gtk.Gtk.TreeViewGridLines.T) : Std.Object.T

Sets which grid lines to draw in tree_view.

tree_view	a T
grid_lines	a Gtk.Gtk.TreeViewGridLines.T value indicating which grid lines to enable.

:SetHadjustment(self @ T, adjustment @ Gtk.Gtk.Adjustment.T) : Std.Object.T

Sets the Gtk.Gtk.Adjustment.T for the current horizontal aspect.

tree_view	A T
adjustment	The Gtk.Gtk.Adjustment.T to set, or NULL. [allow-none]

:SetHeadersClickable(self @ T, setting @ Std.Symbol.T) : Std.Object.T

Allow the column title buttons to be clicked.

tree_view	A T.
setting	TRUE if the columns are clickable.

:SetHeadersVisible(self @ T, headers_visible @ Std.Symbol.T) : Std.Object.T

Sets the visibility state of the headers.

tree_view	A T.
headers_visible	TRUE if the headers are visible

:SetHoverExpand(self @ T, expand @ Std.Symbol.T) : Std.Object.T

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

tree_view	a T
expand	TRUE to enable hover selection mode

:SetHoverSelection(self @ T, hover @ Std.Symbol.T) : Std.Object.T

Enables of 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.Gtk.SelectionMode.Single and Gtk.Gtk.SelectionMode.Browse.

tree_view	a T
hover	TRUE to enable hover selection mode

:SetLevelIndentation(self @ T, indentation @ Std.Integer.SmallT) : Std.Object.T

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

tree_view	a T
indentation	the amount, in pixels, of extra indentation in tree_view.

:SetModel(self @ T, model @ Gtk.Gtk.TreeModel.T) : Std.Object.T

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

tree_view	A GtkTreeNode.
model	The model. [allow-none]

:SetReorderable(self @ T, reorderable @ Std.Symbol.T) : Std.Object.T

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

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

tree_view	A T.
reorderable	TRUE, if the tree can be reordered.

:SetRowSeparatorFunc(self @ T, func @ Std.Function.T, data @ Std.Address.T, destroy @ Std.Function.T) : Std.Object.T

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.

tree_view	a T
func	a Gtk.Gtk.TreeViewRowSeparatorFunc
data	user data to pass to func, or NULL. [allow-none]
destroy	destroy notifier for data, or NULL. [allow-none]

:SetRubberBanding(self @ T, enable @ Std.Symbol.T) : Std.Object.T

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

tree_view	a T
enable	TRUE to enable rubber banding

:SetRulesHint(self @ T, setting @ Std.Symbol.T) : Std.Object.T

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

tree_view	a T
setting	TRUE if the tree requires reading across rows

:SetSearchColumn(self @ T, column @ Std.Integer.SmallT) : Std.Object.T

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

If the search column is set, users can use the "start-interactive-search" key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search.

Note that column refers to a column of the current model. The search column is reset to -1 when the model is changed.

tree_view	A T
column	the column of the model to search in, or -1 to disable searching

:SetSearchEntry(self @ T, entry @ Gtk.Gtk.Entry.T) : Std.Object.T

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.

tree_view	A T
entry	the entry the interactive search code of tree_view should use or NULL. [allow-none]

:SetSearchEqualFunc(self @ T, search_equal_func @ Std.Function.T, search_user_data @ Std.Address.T, search_destroy @ Std.Function.T) : Std.Object.T

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

tree_view	A T
search_equal_func	the compare function to use during the search
search_user_data	user data to pass to search_equal_func, or NULL. [allow-none]
search_destroy	Destroy notifier for search_user_data, or NULL. [allow-none]

:SetSearchPositionFunc(self @ T, func @ Std.Function.T, data @ Std.Address.T, destroy @ Std.Function.T) : Std.Object.T

Sets the function to use when positioning the search dialog.

tree_view	A T
func	the function to use to position the search dialog, or NULL to use the default search position function. [allow-none]
data	user data to pass to func, or NULL. [allow-none]
destroy	Destroy notifier for data, or NULL. [allow-none]

:SetShowExpanders(self @ T, enabled @ Std.Symbol.T) : Std.Object.T

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 SetLevelIndentation. This does not have any visible effects for lists.

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

:SetTooltipCell(self @ T, tooltip @ Gtk.Gtk.Tooltip.T, path @ Gtk.Gtk.TreePath.T, column @ Gtk.Gtk.TreeViewColumn.T, cell @ Gtk.Gtk.CellRenderer.T) : Std.Object.T

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.Gtk.Tooltip.SetTipArea.

Note that if path is not specified and cell is set and part of a column containing the expander, the tooltip might not show and hide at the correct position. In such cases path must be set to the current node under the mouse cursor for this function to operate correctly.

See also SetTooltipColumn for a simpler alternative.

tree_view	a T
tooltip	a Gtk.Gtk.Tooltip.T
path	a Gtk.Gtk.TreePath.T or NULL. [allow-none]
column	a Gtk.Gtk.TreeViewColumn.T or NULL. [allow-none]
cell	a Gtk.Gtk.CellRenderer.T or NULL. [allow-none]

:SetTooltipColumn(self @ T, column @ Std.Integer.SmallT) : Std.Object.T

If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have T 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.

When enabled, "has-tooltip" will be set to TRUE and tree_view will connect a "query-tooltip" signal handler.

Note that the signal handler sets the text with Gtk.Gtk.Tooltip.SetMarkup, so &, <, etc have to be escaped in the text.

tree_view	a T
column	an integer, which is a valid column number for tree_view's model

:SetTooltipRow(self @ T, tooltip @ Gtk.Gtk.Tooltip.T, path @ Gtk.Gtk.TreePath.T) : Std.Object.T

Sets the tip area of tooltip to be the area covered by the row at path. See also SetTooltipColumn for a simpler alternative. See also Gtk.Gtk.Tooltip.SetTipArea.

tree_view	a T
tooltip	a Gtk.Gtk.Tooltip.T
path	a Gtk.Gtk.TreePath.T

:SetVadjustment(self @ T, adjustment @ Gtk.Gtk.Adjustment.T) : Std.Object.T

Sets the Gtk.Gtk.Adjustment.T for the current vertical aspect.

tree_view	A T
adjustment	The Gtk.Gtk.Adjustment.T to set, or NULL. [allow-none]

:TreeToWidgetCoords(self @ T, tx @ Std.Integer.SmallT, ty @ Std.Integer.SmallT, wx @ Std.Object.T, wy @ Std.Object.T) : Std.Object.T

Warning

TreeToWidgetCoords has been deprecated since version 2.12 and should not be used in newly-written code. Due to historial reasons the name of this function is incorrect. For converting bin_window coordinates to coordinates relative to bin_window, please see ConvertBinWindowToWidgetCoords.

:UnsetRowsDragDest(self @ T) : Std.Object.T

Undoes the effect of EnableModelDragDest. Calling this method sets "reorderable" to FALSE.

tree_view

a T

:UnsetRowsDragSource(self @ T) : Std.Object.T

Undoes the effect of EnableModelDragSource. Calling this method sets "reorderable" to FALSE.

tree_view

a T

:WidgetToTreeCoords(self @ T, wx @ Std.Integer.SmallT, wy @ Std.Integer.SmallT, tx @ Std.Object.T, ty @ Std.Object.T) : Std.Object.T

Warning

WidgetToTreeCoords has been deprecated since version 2.12 and should not be used in newly-written code. Due to historial reasons the name of this function is incorrect. For converting coordinates relative to the widget to bin_window coordinates, please see ConvertWidgetToBinWindowCoords.

TreeView