gtk.TreeView

class TreeView : gtk.Container.Container, gtk.ScrollableIF.ScrollableIF;
Widget that displays any object that implements the #GtkTreeModel interface.

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

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

![](tree-view-coordinates.png)

Coordinate systems in GtkTreeView API:

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

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

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

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

# GtkTreeView as GtkBuildable

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

An example of a UI definition fragment with GtkTreeView: |[ <object class="GtkTreeView" id="treeview"> <property name="model">liststore1</property> <child> <object class="GtkTreeViewColumn" id="test-column"> <property name="title">Test</property> <child> <object class="GtkCellRendererText" id="test-renderer"/> 1 </child> </object> </child> <child internal-child="selection"> <object class="GtkTreeSelection" id="selection"> </object> </child> </object> ]|

# CSS nodes

|[ treeview.view ├── header │ ├── ┊ ┊ │ ╰── │ ╰── [rubberband] ]|

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

protected GtkTreeView* gtkTreeView ;
the main Gtk struct

GtkTreeView* getTreeViewStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkTreeView* gtkTreeView, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

int expandRow (TreeIter iter, TreeModelIF model, bool openAll);
Expands the row of the iter.

Params:
TreeIter iter
bool openAll

TreeIter getSelectedIter ();
gets the first selected iter or null if no rows are selected

TreeIter[] getSelectedIters ();
int insertEditableColumn (int position, string title, CellRenderer renderer, bool editable);
Inserts a column and sets it's attributes

Params:
int position
string title
CellRenderer renderer
bool editable

Returns:
number of columns including the new one

static GType getType ();
this();
Creates a new #GtkTreeView widget.

Returns:
A newly created #GtkTreeView widget.

Throws:
ConstructionException GTK+ fails to create the object.

this(TreeModelIF model);
Creates a new #GtkTreeView widget with the model initialized to @model.

Params:
TreeModelIF model the model.

Returns:
A newly created #GtkTreeView widget.

Throws:
ConstructionException GTK+ fails to create the object.

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.

Params:
TreeViewColumn column The #GtkTreeViewColumn to add.

Returns:
The number of columns in @tree_view after appending.

void collapseAll ();
Recursively collapses all visible, expanded nodes in @tree_view.

bool collapseRow (TreePath path);
Collapses a row (hides its child rows, if they exist).

Params:
TreePath path path to a row in the @tree_view

Returns:
%TRUE if the row was collapsed.

void columnsAutosize ();
Resizes all columns to their optimal width. Only works after the treeview has been realized.

void convertBinWindowToTreeCoords (int bx, int by, out int tx, out int ty);
Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

Params:
int bx X coordinate relative to bin_window
int by Y coordinate relative to bin_window
int tx return location for tree X coordinate
int ty return location for tree Y coordinate

Since:
2.12

void convertBinWindowToWidgetCoords (int bx, int by, out int wx, out int wy);
Converts bin_window coordinates (see gtk_tree_view_get_bin_window()) to widget relative coordinates.

Params:
int bx bin_window X coordinate
int by bin_window Y coordinate
int wx return location for widget X coordinate
int wy return location for widget Y coordinate

Since:
2.12

void convertTreeToBinWindowCoords (int tx, int ty, out int bx, out int by);
Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

Params:
int tx tree X coordinate
int ty tree Y coordinate
int bx return location for X coordinate relative to bin_window
int by return location for Y coordinate relative to bin_window

Since:
2.12

void convertTreeToWidgetCoords (int tx, int ty, out int wx, out int wy);
Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

Params:
int tx X coordinate relative to the tree
int ty Y coordinate relative to the tree
int wx return location for widget X coordinate
int wy return location for widget Y coordinate

Since:
2.12

void convertWidgetToBinWindowCoords (int wx, int wy, out int bx, out int by);
Converts widget coordinates to coordinates for the bin_window (see gtk_tree_view_get_bin_window()).

Params:
int wx X coordinate relative to the widget
int wy Y coordinate relative to the widget
int bx return location for bin_window X coordinate
int by return location for bin_window Y coordinate

Since:
2.12

void convertWidgetToTreeCoords (int wx, int wy, out int tx, out int ty);
Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

Params:
int wx X coordinate relative to the widget
int wy Y coordinate relative to the widget
int tx return location for tree X coordinate
int ty return location for tree Y coordinate

Since:
2.12

Surface createRowDragIcon (TreePath path);
Creates a #cairo_surface_t representation of the row at @path. This image is used for a drag icon.

Params:
TreePath path a #GtkTreePath in @tree_view

Returns:
a newly-allocated surface of the drag icon.

void enableModelDragDest (TargetEntry[] targets, GdkDragAction actions);
Turns @tree_view into a drop destination for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE.

Params:
TargetEntry[] targets the table of targets that the drag will support
nTargets the number of items in @targets
GdkDragAction actions the bitmask of possible actions for a drag from this widget

void enableModelDragSource (GdkModifierType startButtonMask, TargetEntry[] targets, GdkDragAction actions);
Turns @tree_view into a drag source for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE.

Params:
GdkModifierType startButtonMask Mask of allowed buttons to start drag
TargetEntry[] targets the table of targets that the drag will support
nTargets the number of items in @targets
GdkDragAction actions the bitmask of possible actions for a drag from this widget

void expandAll ();
Recursively expands all nodes in the @tree_view.

bool expandRow (TreePath path, bool openAll);
Opens the row so its children are visible.

Params:
TreePath path path to a row
bool openAll whether to recursively expand, or just expand immediate children

Returns:
%TRUE if the row existed and had children

void expandToPath (TreePath path);
Expands the row at @path. This will also expand all parent rows of @path as necessary.

Params:
TreePath path path to a row.

Since:
2.2

bool getActivateOnSingleClick ();
Gets the setting set by gtk_tree_view_set_activate_on_single_click().

Returns:
%TRUE if row-activated will be emitted on a single click

Since:
3.8

void getBackgroundArea (TreePath path, TreeViewColumn column, out 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.

Params:
TreePath path a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
TreeViewColumn column a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes
GdkRectangle rect rectangle to fill with cell background rect

Window getBinWindow ();
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.

Returns:
A #GdkWindow, or %NULL when @tree_view hasn’t been realized yet.

void getCellArea (TreePath path, TreeViewColumn column, out 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.

Params:
TreePath path a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
TreeViewColumn column a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates
GdkRectangle rect rectangle to fill with cell rect

TreeViewColumn getColumn (int n);
Gets the #GtkTreeViewColumn at the given position in the #tree_view.

Params:
int n The position of the column, counting from 0.

Returns:
The #GtkTreeViewColumn, or %NULL if the position is outside the range of columns.

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

Returns:
A list of #GtkTreeViewColumn s

void getCursor (out TreePath path, out 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.

The returned #GtkTreePath must be freed with gtk_tree_path_free() when you are done with it.

Params:
TreePath path A pointer to be filled with the current cursor path, or %NULL
TreeViewColumn focusColumn A pointer to be filled with the current focus column, or %NULL

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

Params:
int dragX the position to determine the destination row for
int dragY the position to determine the destination row for
TreePath path Return location for the path of the highlighted row, or %NULL.
GtkTreeViewDropPosition pos Return location for the drop position, or %NULL

Returns:
whether there is a row at the given position, %TRUE if this is indeed the case.

void getDragDestRow (out TreePath path, out GtkTreeViewDropPosition pos);
Gets information about the row that is highlighted for feedback.

Params:
TreePath path Return location for the path of the highlighted row, or %NULL.
GtkTreeViewDropPosition pos Return location for the drop position, or %NULL

bool getEnableSearch ();
Returns whether or not the tree allows to start interactive searching by typing in text.

Returns:
whether or not to let the user search interactively

bool getEnableTreeLines ();
Returns whether or not tree lines are drawn in @tree_view.

Returns:
%TRUE if tree lines are drawn in @tree_view, %FALSE otherwise.

Since:
2.10

TreeViewColumn getExpanderColumn ();
Returns the column that is the current expander column. This column has the expander arrow drawn next to it.

Returns:
The expander column.

bool getFixedHeightMode ();
Returns whether fixed height mode is turned on for @tree_view.

Returns:
%TRUE if @tree_view is in fixed height mode

Since:
2.6

GtkTreeViewGridLines getGridLines ();
Returns which grid lines are enabled in @tree_view.

Returns:
a #GtkTreeViewGridLines value indicating which grid lines are enabled.

Since:
2.10

bool getHeadersClickable ();
Returns whether all header columns are clickable.

Returns:
%TRUE if all header columns are clickable, otherwise %FALSE

Since:
2.10

bool getHeadersVisible ();
Returns %TRUE if the headers on the @tree_view are visible.

Returns:
Whether the headers are visible or not.

bool getHoverExpand ();
Returns whether hover expansion mode is turned on for @tree_view.

Returns:
%TRUE if @tree_view is in hover expansion mode

Since:
2.6

bool getHoverSelection ();
Returns whether hover selection mode is turned on for @tree_view.

Returns:
%TRUE if @tree_view is in hover selection mode

Since:
2.6

int getLevelIndentation ();
Returns the amount, in pixels, of extra indentation for child levels in @tree_view.

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

Since:
2.12

TreeModelIF getModel ();
Returns the model the #GtkTreeView is based on. Returns %NULL if the model is unset.

Returns:
A #GtkTreeModel, or %NULL if none is currently being used.

uint getNColumns ();
Queries the number of columns in the given @tree_view.

Returns:
The number of columns in the @tree_view

Since:
3.4

bool getPathAtPos (int x, int y, out TreePath path, out TreeViewColumn column, out int cellX, out int cellY);
Finds the path at the point (@x, @y), relative to bin_window coordinates (please see gtk_tree_view_get_bin_window()). 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 #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.

For converting widget coordinates (eg. the ones you get from

GtkWidget:
:query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords().

Params:
int x The x position to be identified (relative to bin_window).
int y The y position to be identified (relative to bin_window).
TreePath path A pointer to a #GtkTreePath pointer to be filled in, or %NULL
TreeViewColumn column A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL
int cellX A pointer where the X coordinate relative to the cell can be placed, or %NULL
int cellY A pointer where the Y coordinate relative to the cell can be placed, or %NULL

Returns:
%TRUE if a row exists at that coordinate.

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

Returns:
%TRUE if the tree can be reordered.

GtkTreeViewRowSeparatorFunc getRowSeparatorFunc ();
Returns the current row separator function.

Returns:
the current row separator function.

Since:
2.6

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.

Returns:
%TRUE if rubber banding in @tree_view is enabled.

Since:
2.10

bool getRulesHint ();
Gets the setting set by gtk_tree_view_set_rules_hint().

Returns:
%TRUE if the hint is set

int getSearchColumn ();
Gets the column searched on by the interactive search code.

Returns:
the column the interactive search code searches in.

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

Returns:
the entry currently in use as search entry.

Since:
2.10

GtkTreeViewSearchEqualFunc getSearchEqualFunc ();
Returns the compare function currently in use.

Returns:
the currently used compare function for the search code.

GtkTreeViewSearchPositionFunc getSearchPositionFunc ();
Returns the positioning function currently in use.

Returns:
the currently used function for positioning the search dialog.

Since:
2.10

TreeSelection getSelection ();
Gets the #GtkTreeSelection associated with @tree_view.

Returns:
A #GtkTreeSelection object.

bool getShowExpanders ();
Returns whether or not expanders are drawn in @tree_view.

Returns:
%TRUE if expanders are drawn in @tree_view, %FALSE otherwise.

Since:
2.12

int getTooltipColumn ();
Returns the column of @tree_view’s model which is being used for displaying tooltips on @tree_view’s rows.

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

Since:
2.12

bool getTooltipContext (ref int x, ref int y, bool keyboardTip, out TreeModelIF model, out TreePath path, out 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.

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.

Params:
int x the x coordinate (relative to widget coordinates)
int y the y coordinate (relative to widget coordinates)
bool keyboardTip whether this is a keyboard tooltip or not
TreeModelIF model a pointer to receive a #GtkTreeModel or %NULL
TreePath path a pointer to receive a #GtkTreePath or %NULL
TreeIter iter a pointer to receive a #GtkTreeIter or %NULL

Returns:
whether or not the given tooltip context points to a row.

Since:
2.12

bool getVisibleRange (out TreePath startPath, out 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.

The paths should be freed with gtk_tree_path_free() after use.

Params:
TreePath startPath Return location for start of region, or %NULL.
TreePath endPath Return location for end of region, or %NULL.

Returns:
%TRUE, if valid paths were placed in @start_path and @end_path.

Since:
2.8

void getVisibleRect (out 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.

Params:
GdkRectangle visibleRect rectangle to fill

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.

Params:
TreeViewColumn column The #GtkTreeViewColumn to be inserted.
int position The position to insert @column in.

Returns:
The number of columns in @tree_view after insertion.

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.

Params:
int position Position to insert, -1 for append
string title column title
CellRenderer cell cell renderer for column
GtkTreeCellDataFunc func function to set attributes of cell renderer
void* data data for @func
GDestroyNotify dnotify destroy notifier for @data

Returns:
number of columns in the tree view post-insert

bool isBlankAtPos (int x, int y, out TreePath path, out TreeViewColumn column, out int cellX, out 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.

The @x and @y coordinate that are provided must be relative to bin_window coordinates. That is, @x and @y must come from an event on @tree_view where
event->window == gtk_tree_view_get_bin_window ()
.

For converting widget coordinates (eg. the ones you get from

GtkWidget:
:query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords().

The @path, @column, @cell_x and @cell_y arguments will be filled in likewise as for gtk_tree_view_get_path_at_pos(). Please see gtk_tree_view_get_path_at_pos() for more information.

Params:
int x The x position to be identified (relative to bin_window)
int y The y position to be identified (relative to bin_window)
TreePath path A pointer to a #GtkTreePath pointer to be filled in, or %NULL
TreeViewColumn column A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL
int cellX A pointer where the X coordinate relative to the cell can be placed, or %NULL
int cellY A pointer where the Y coordinate relative to the cell can be placed, or %NULL

Returns:
%TRUE if the area at the given coordinates is blank, %FALSE otherwise.

Since:
3.0

bool isRubberBandingActive ();
Returns whether a rubber banding operation is currently being done in @tree_view.

Returns:
%TRUE if a rubber banding operation is currently being done in @tree_view.

Since:
2.12

void mapExpandedRows (GtkTreeViewMappingFunc func, void* data);
Calls @func on all expanded rows.

Params:
GtkTreeViewMappingFunc func A function to be called
void* data User data to be passed to the function.

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.

Params:
TreeViewColumn column The #GtkTreeViewColumn to be moved.
TreeViewColumn baseColumn The #GtkTreeViewColumn to be moved relative to, or %NULL.

int removeColumn (TreeViewColumn column);
Removes @column from @tree_view.

Params:
TreeViewColumn column The #GtkTreeViewColumn to remove.

Returns:
The number of columns in @tree_view after removing.

void rowActivated (TreePath path, TreeViewColumn column);
Activates the cell determined by @path and @column.

Params:
TreePath path The #GtkTreePath to be activated.
TreeViewColumn column The #GtkTreeViewColumn to be activated.

bool rowExpanded (TreePath path);
Returns %TRUE if the node pointed to by @path is expanded in @tree_view.

Params:
TreePath path A #GtkTreePath to test expansion state.

Returns:
%TRUE if #path is expanded.

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.

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.

Params:
TreePath path The path of the row to move to, or %NULL.
TreeViewColumn column The #GtkTreeViewColumn to move horizontally to, or %NULL.
bool useAlign whether to use alignment arguments, or %FALSE.
float rowAlign The vertical alignment of the row specified by @path.
float colAlign The horizontal alignment of the column specified by @column.

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

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

Params:
int treeX X coordinate of new top-left pixel of visible area, or -1
int treeY Y coordinate of new top-left pixel of visible area, or -1

void setActivateOnSingleClick (bool single);
Cause the #GtkTreeView::row-activated signal to be emitted on a single click instead of a double click.

Params:
bool single %TRUE to emit row-activated on a single click

Since:
3.8

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.

Params:
GtkTreeViewColumnDropFunc func A function to determine which columns are reorderable, or %NULL.
void* userData User data to be passed to @func, or %NULL
GDestroyNotify destroy Destroy notifier for @user_data, or %NULL

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.

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

Params:
TreePath path A #GtkTreePath
TreeViewColumn focusColumn A #GtkTreeViewColumn, or %NULL
bool startEditing %TRUE if the specified cell should start being edited.

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.

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

Params:
TreePath path A #GtkTreePath
TreeViewColumn focusColumn A #GtkTreeViewColumn, or %NULL
CellRenderer focusCell A #GtkCellRenderer, or %NULL
bool startEditing %TRUE if the specified cell should start being edited.

Since:
2.2

void setDestroyCountFunc (GtkTreeDestroyCountFunc func, void* data, GDestroyNotify destroy);
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.

Deprecated:
Accessibility does not need the function anymore.

Params:
GtkTreeDestroyCountFunc func Function to be called when a view row is destroyed, or %NULL
void* data User data to be passed to @func, or %NULL
GDestroyNotify destroy Destroy notifier for @data, or %NULL

void setDragDestRow (TreePath path, GtkTreeViewDropPosition pos);
Sets the row that is highlighted for feedback. If @path is %NULL, an existing highlight is removed.

Params:
TreePath path The path of the row to highlight, or %NULL
GtkTreeViewDropPosition pos Specifies whether to drop before, after or into the row

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

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

Params:
bool enableSearch %TRUE, if the user can search interactively

void setEnableTreeLines (bool enabled);
Sets whether to draw lines interconnecting the expanders in @tree_view. This does not have any visible effects for lists.

Params:
bool enabled %TRUE to enable tree line drawing, %FALSE otherwise.

Since:
2.10

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.

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

Params:
TreeViewColumn column %NULL, or the column to draw the expander arrow at.

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.

Params:
bool enable %TRUE to enable fixed height mode

Since:
2.6

void setGridLines (GtkTreeViewGridLines gridLines);
Sets which grid lines to draw in @tree_view.

Params:
GtkTreeViewGridLines gridLines a #GtkTreeViewGridLines value indicating which grid lines to enable.

Since:
2.10

void setHeadersClickable (bool setting);
Allow the column title buttons to be clicked.

Params:
bool setting %TRUE if the columns are clickable.

void setHeadersVisible (bool headersVisible);
Sets the visibility state of the headers.

Params:
bool headersVisible %TRUE if the headers are visible

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.

Params:
bool expand %TRUE to enable hover selection mode

Since:
2.6

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.

Params:
bool hover %TRUE to enable hover selection mode

Since:
2.6

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.

Params:
int indentation the amount, in pixels, of extra indentation in @tree_view.

Since:
2.12

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.

Params:
TreeModelIF model The model.

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.

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.

Params:
bool reorderable %TRUE, if the tree can be reordered.

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.

Params:
GtkTreeViewRowSeparatorFunc func a #GtkTreeViewRowSeparatorFunc
void* data user data to pass to @func, or %NULL
GDestroyNotify destroy destroy notifier for @data, or %NULL

Since:
2.6

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.

Params:
bool enable %TRUE to enable rubber banding

Since:
2.10

void setRulesHint (bool setting);
Sets a hint for the theme to draw even/odd rows in the @tree_view with different colors, also known as "zebra striping".

This function tells the GTK+ theme that the user interface for your application requires users to read across tree rows and associate cells with one another.

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

Params:
bool setting %TRUE if the tree requires reading across rows

void setSearchColumn (int column);
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.

Params:
int column the column of the model to search in, or -1 to disable searching

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

Params:
Entry entry the entry the interactive search code of @tree_view should use or %NULL

Since:
2.10

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.

Params:
GtkTreeViewSearchEqualFunc searchEqualFunc the compare function to use during the search
void* searchUserData user data to pass to @search_equal_func, or %NULL
GDestroyNotify searchDestroy Destroy notifier for @search_user_data, or %NULL

void setSearchPositionFunc (GtkTreeViewSearchPositionFunc func, void* data, GDestroyNotify destroy);
Sets the function to use when positioning the search dialog.

Params:
GtkTreeViewSearchPositionFunc func the function to use to position the search dialog, or %NULL to use the default search position function
void* data user data to pass to @func, or %NULL
GDestroyNotify destroy Destroy notifier for @data, or %NULL

Since:
2.10

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.

Params:
bool enabled %TRUE to enable expander drawing, %FALSE otherwise.

Since:
2.12

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

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 gtk_tree_view_set_tooltip_column() for a simpler alternative.

Params:
Tooltip tooltip a #GtkTooltip
TreePath path a #GtkTreePath or %NULL
TreeViewColumn column a #GtkTreeViewColumn or %NULL
CellRenderer cell a #GtkCellRenderer or %NULL

Since:
2.12

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.

When enabled, #GtkWidget:has-tooltip will be set to %TRUE and @tree_view will connect a #GtkWidget::query-tooltip signal handler.

Note that the signal handler sets the text with gtk_tooltip_set_markup(), so &, <, etc have to be escaped in the text.

Params:
int column an integer, which is a valid column number for @tree_view’s model

Since:
2.12

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

Params:
Tooltip tooltip a #GtkTooltip
TreePath path a #GtkTreePath

Since:
2.12

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

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

gulong addOnColumnsChanged (void delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The number of columns of the treeview has changed.

gulong addOnCursorChanged (void delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The position of the cursor (focused cell) has changed.

gulong addOnExpandCollapseCursorRow (bool delegate(bool, bool, bool, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnMoveCursor (bool delegate(GtkMovementStep, int, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The #GtkTreeView::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user presses one of the cursor keys.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically. In contrast to gtk_tree_view_set_cursor() and gtk_tree_view_set_cursor_on_cell() when moving horizontally #GtkTreeView::move-cursor does not reset the current selection.

Params:
step the granularity of the move, as a #GtkMovementStep. %GTK_MOVEMENT_LOGICAL_POSITIONS, %GTK_MOVEMENT_VISUAL_POSITIONS, %GTK_MOVEMENT_DISPLAY_LINES, %GTK_MOVEMENT_PAGES and %GTK_MOVEMENT_BUFFER_ENDS are supported. %GTK_MOVEMENT_LOGICAL_POSITIONS and %GTK_MOVEMENT_VISUAL_POSITIONS are treated identically.
direction the direction to move: +1 to move forwards; -1 to move backwards. The resulting movement is undefined for all other values.

Returns:
%TRUE if @step is supported, %FALSE otherwise.

gulong addOnRowActivated (void delegate(TreePath, TreeViewColumn, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
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.

For selection handling refer to the [tree widget conceptual overview][TreeWidget] as well as #GtkTreeSelection.

Params:
path the #GtkTreePath for the activated row
column the #GtkTreeViewColumn in which the activation occurred

gulong addOnRowCollapsed (void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The given row has been collapsed (child nodes are hidden).

Params:
iter the tree iter of the collapsed row
path a tree path that points to the row

gulong addOnRowExpanded (void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The given row has been expanded (child nodes are shown).

Params:
iter the tree iter of the expanded row
path a tree path that points to the row

gulong addOnSelectAll (bool delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnSelectCursorParent (bool delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnSelectCursorRow (bool delegate(bool, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnStartInteractiveSearch (bool delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnTestCollapseRow (bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
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.

Params:
iter the tree iter of the row to collapse
path a tree path that points to the row

Returns:
%FALSE to allow collapsing, %TRUE to reject

gulong addOnTestExpandRow (bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
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.

Params:
iter the tree iter of the row to expand
path a tree path that points to the row

Returns:
%FALSE to allow expansion, %TRUE to reject

gulong addOnToggleCursorRow (bool delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
gulong addOnUnselectAll (bool delegate(TreeView) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Page was generated with on Sun Apr 23 22:52:57 2017