TreeView

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:

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.

class TreeView : Container , ScrollableIF {}

Constructors

this
this(GtkTreeView* gtkTreeView)

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
void addOnColumnsChanged(void delegate(TreeView) dlg, ConnectFlags connectFlags)

The number of columns of the treeview has changed.

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

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

addOnExpandCollapseCursorRow
void addOnExpandCollapseCursorRow(bool delegate(gboolean, gboolean, gboolean, TreeView) dlg, ConnectFlags connectFlags)
addOnMoveCursor
void addOnMoveCursor(bool delegate(GtkMovementStep, gint, TreeView) dlg, ConnectFlags connectFlags)
addOnRowActivated
void 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 For selection handling refer to the tree widget conceptual overview as well as GtkTreeSelection.

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

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

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

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

addOnSelectAll
void addOnSelectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorParent
void addOnSelectCursorParent(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorRow
void addOnSelectCursorRow(bool delegate(gboolean, TreeView) dlg, ConnectFlags connectFlags)
addOnStartInteractiveSearch
void addOnStartInteractiveSearch(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnTestCollapseRow
void 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. FALSE to allow collapsing, TRUE to reject

addOnTestExpandRow
void 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. FALSE to allow expansion, TRUE to reject

addOnToggleCursorRow
void addOnToggleCursorRow(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnUnselectAll
void addOnUnselectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)

See Also GtkTreeViewColumn, GtkTreeSelection, GtkTreeModel, GtkTreeView drag-and-drop, GtkTreeSortable, GtkTreeModelSort, GtkListStore, GtkTreeStore, GtkCellRenderer, GtkCellEditable, GtkCellRendererPixbuf, GtkCellRendererText, GtkCellRendererToggle

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
int 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). Since 2.12

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

Converts bin_window coordinates (see gtk_tree_view_get_bin_window()) to widget relative coordinates. Since 2.12

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. Since 2.12

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. Since 2.12

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

Converts widget coordinates to coordinates for the bin_window (see gtk_tree_view_get_bin_window()). Since 2.12

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

createRowDragIcon
Surface 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(GtkTargetEntry[] targets, GdkDragAction actions)

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

enableModelDragSource
void enableModelDragSource(GdkModifierType startButtonMask, GtkTargetEntry[] targets, GdkDragAction actions)

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

expandAll
void expandAll()

Recursively expands all nodes in the tree_view.

expandRow
int expandRow(TreeIter iter, TreeModelIF model, int openAll)

Expands the row of the iter.

expandRow
int expandRow(TreePath path, int 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. Since 2.2

getActivateOnSingleClick
int getActivateOnSingleClick()

Gets the setting set by gtk_tree_view_set_activate_on_single_click().

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

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

getCellArea
void getCellArea(TreePath path, TreeViewColumn column, Rectangle 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. The returned GtkTreePath must be freed with gtk_tree_path_free() when you are done with it.

getDestRowAtPos
int 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
int getEnableSearch()

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

getEnableTreeLines
int getEnableTreeLines()

Returns whether or not tree lines are drawn in tree_view. Since 2.10

getExpanderColumn
TreeViewColumn getExpanderColumn()

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

getFixedHeightMode
int getFixedHeightMode()

Returns whether fixed height mode is turned on for tree_view. Since 2.6

getGridLines
GtkTreeViewGridLines getGridLines()

Returns which grid lines are enabled in tree_view. Since 2.10

getHeadersClickable
int getHeadersClickable()

Returns whether all header columns are clickable. Since 2.10

getHeadersVisible
int getHeadersVisible()

Returns TRUE if the headers on the tree_view are visible.

getHoverExpand
int getHoverExpand()

Returns whether hover expansion mode is turned on for tree_view. Since 2.6

getHoverSelection
int getHoverSelection()

Returns whether hover selection mode is turned on for tree_view. Since 2.6

getLevelIndentation
int getLevelIndentation()

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

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

getReorderable
int 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. Since 2.6

getRubberBanding
int 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. Since 2.10

getRulesHint
int getRulesHint()

Gets the setting set by gtk_tree_view_set_rules_hint().

getSearchColumn
int getSearchColumn()

Gets the column searched on by the interactive search code.

getSearchEntry
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. Since 2.10

getSearchEqualFunc
GtkTreeViewSearchEqualFunc getSearchEqualFunc()

Returns the compare function currently in use.

getSearchPositionFunc
GtkTreeViewSearchPositionFunc getSearchPositionFunc()

Returns the positioning function currently in use. Since 2.10

getSelectedIter
TreeIter getSelectedIter()

gets the first selected iter or null if no rows are selected

getSelectedIters
TreeIter[] getSelectedIters()
getSelection
TreeSelection getSelection()

Gets the GtkTreeSelection associated with tree_view.

getShowExpanders
int getShowExpanders()

Returns whether or not expanders are drawn in tree_view. Since 2.12

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. Since 2.12

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

This function is supposed to be used in a "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. Since 2.12

getTreeViewStruct
GtkTreeView* getTreeViewStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getVisibleRange
int 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. The paths should be freed with gtk_tree_path_free() after use. Since 2.8

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

insertEditableColumn
gint insertEditableColumn(int position, string title, CellRenderer renderer, bool editable)

Inserts a column and sets it's attributes

isBlankAtPos
int 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. 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.

isRubberBandingActive
int isRubberBandingActive()

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

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
int rowExpanded(TreePath path)

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

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

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(). If either tree_x or tree_y are -1, then that direction isn't scrolled.

setActivateOnSingleClick
void setActivateOnSingleClick(int single)

Cause the "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, int 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.

setCursorOnCell
void setCursorOnCell(TreePath path, TreeViewColumn focusColumn, CellRenderer focusCell, int 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. Since 2.2

setDestroyCountFunc
void setDestroyCountFunc(GtkTreeDestroyCountFunc func, void* data, GDestroyNotify destroy)

Warning gtk_tree_view_set_destroy_count_func has been deprecated since version 3.4 and should not be used in newly-written code. Accessibility does not need the function anymore. 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.

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

setEnableTreeLines
void setEnableTreeLines(int enabled)

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

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. If you do not want expander arrow to appear in your tree, set the expander column to a hidden column.

setFixedHeightMode
void setFixedHeightMode(int 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. Since 2.6

setGridLines
void setGridLines(GtkTreeViewGridLines gridLines)

Sets which grid lines to draw in tree_view. Since 2.10

setHeadersClickable
void setHeadersClickable(int setting)

Allow the column title buttons to be clicked.

setHeadersVisible
void setHeadersVisible(int headersVisible)

Sets the visibility state of the headers.

setHoverExpand
void setHoverExpand(int expand)

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

setHoverSelection
void setHoverSelection(int 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. Since 2.6

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. Since 2.12

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

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. Since 2.6

setRubberBanding
void setRubberBanding(int 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. Since 2.10

setRulesHint
void setRulesHint(int setting)

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

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

setSearchEntry
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. Since 2.10

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.

setSearchPositionFunc
void setSearchPositionFunc(GtkTreeViewSearchPositionFunc func, void* data, GDestroyNotify destroy)

Sets the function to use when positioning the search dialog. Since 2.10

setShowExpanders
void setShowExpanders(int 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. Since 2.12

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
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(). 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. Since 2.12

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. 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_tooltip_set_markup(), so , <, etc have to be escaped in the text. Since 2.12

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

unsetRowsDragDest
void unsetRowsDragDest()

Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets "reorderable" to FALSE.

unsetRowsDragSource
void unsetRowsDragSource()

Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets "reorderable" to FALSE.

Mixins

__anonymous
mixin ScrollableT!(GtkTreeView)
Undocumented in source.

Static functions

callBackColumnsChanged
void callBackColumnsChanged(GtkTreeView* treeViewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCursorChanged
void callBackCursorChanged(GtkTreeView* treeViewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackExpandCollapseCursorRow
gboolean callBackExpandCollapseCursorRow(GtkTreeView* treeviewStruct, gboolean arg1, gboolean arg2, gboolean arg3, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveCursor
gboolean callBackMoveCursor(GtkTreeView* treeviewStruct, GtkMovementStep arg1, gint arg2, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackRowActivated
void callBackRowActivated(GtkTreeView* treeViewStruct, GtkTreePath* path, GtkTreeViewColumn* column, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackRowCollapsed
void callBackRowCollapsed(GtkTreeView* treeViewStruct, GtkTreeIter* iter, GtkTreePath* path, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackRowExpanded
void callBackRowExpanded(GtkTreeView* treeViewStruct, GtkTreeIter* iter, GtkTreePath* path, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectAll
gboolean callBackSelectAll(GtkTreeView* treeviewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectCursorParent
gboolean callBackSelectCursorParent(GtkTreeView* treeviewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectCursorRow
gboolean callBackSelectCursorRow(GtkTreeView* treeviewStruct, gboolean arg1, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackStartInteractiveSearch
gboolean callBackStartInteractiveSearch(GtkTreeView* treeviewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackTestCollapseRow
gboolean callBackTestCollapseRow(GtkTreeView* treeViewStruct, GtkTreeIter* iter, GtkTreePath* path, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackTestExpandRow
gboolean callBackTestExpandRow(GtkTreeView* treeViewStruct, GtkTreeIter* iter, GtkTreePath* path, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackToggleCursorRow
gboolean callBackToggleCursorRow(GtkTreeView* treeviewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackUnselectAll
gboolean callBackUnselectAll(GtkTreeView* treeviewStruct, TreeView _treeView)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkTreeView
GtkTreeView* gtkTreeView;

the main Gtk struct

onColumnsChangedListeners
void delegate(TreeView)[] onColumnsChangedListeners;
Undocumented in source.
onCursorChangedListeners
void delegate(TreeView)[] onCursorChangedListeners;
Undocumented in source.
onExpandCollapseCursorRowListeners
bool delegate(gboolean, gboolean, gboolean, TreeView)[] onExpandCollapseCursorRowListeners;
Undocumented in source.
onMoveCursorListeners
bool delegate(GtkMovementStep, gint, TreeView)[] onMoveCursorListeners;
Undocumented in source.
onRowActivatedListeners
void delegate(TreePath, TreeViewColumn, TreeView)[] onRowActivatedListeners;
Undocumented in source.
onRowCollapsedListeners
void delegate(TreeIter, TreePath, TreeView)[] onRowCollapsedListeners;
Undocumented in source.
onRowExpandedListeners
void delegate(TreeIter, TreePath, TreeView)[] onRowExpandedListeners;
Undocumented in source.
onSelectAllListeners
bool delegate(TreeView)[] onSelectAllListeners;
Undocumented in source.
onSelectCursorParentListeners
bool delegate(TreeView)[] onSelectCursorParentListeners;
Undocumented in source.
onSelectCursorRowListeners
bool delegate(gboolean, TreeView)[] onSelectCursorRowListeners;
Undocumented in source.
onStartInteractiveSearchListeners
bool delegate(TreeView)[] onStartInteractiveSearchListeners;
Undocumented in source.
onTestCollapseRowListeners
bool delegate(TreeIter, TreePath, TreeView)[] onTestCollapseRowListeners;
Undocumented in source.
onTestExpandRowListeners
bool delegate(TreeIter, TreePath, TreeView)[] onTestExpandRowListeners;
Undocumented in source.
onToggleCursorRowListeners
bool delegate(TreeView)[] onToggleCursorRowListeners;
Undocumented in source.
onUnselectAllListeners
bool delegate(TreeView)[] onUnselectAllListeners;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as GtkWindow, GtkFrame, or GtkButton; for more complicated layout containers such as GtkBox or GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can't place the same widget inside two different containers.

remove
void remove(Widget widget)

Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode().

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

setFocusVadjustment
void setFocusVadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().

setFocusHadjustment
void setFocusHadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()

Warning gtk_container_resize_children is deprecated and should not be used in newly-written code. 3.10

childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a "child-notify" signal for the child property child_property on widget. This is an analogue of g_object_notify() for child properties. Also see gtk_widget_child_notify().

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each child of container, including children that are considered "internal" (implementation details of the container). "Internal" children generally weren't added by the user of the container, but were added by the container implementation itself. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). Virtual: forall

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic "draw" calls to all children that don't have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its "draw" function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received. gtk_container_propagate_draw() takes care of translating the origin of cr, and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling gtk_widget_draw() on the child directly. In most cases, a container can simply either inherit the "draw" implementation from GtkContainer, or do some drawing and then chain to the ::draw implementation from GtkContainer.

getFocusChain
int getFocusChain(ListG focusableWidgets)

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(GtkContainerClass* cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

classHandleBorderWidth
void classHandleBorderWidth(GtkContainerClass* klass)

Modifies a subclass of GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must "opt in" to the parent class handling border_width for them.

From ScrollableIF

getScrollableTStruct
GtkScrollable* getScrollableTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

getHadjustment
Adjustment getHadjustment()

Retrieves the GtkAdjustment used for horizontal scrolling.

setHadjustment
void setHadjustment(Adjustment hadjustment)

Sets the horizontal adjustment of the GtkScrollable.

getVadjustment
Adjustment getVadjustment()

Retrieves the GtkAdjustment used for vertical scrolling.

setVadjustment
void setVadjustment(Adjustment vadjustment)

Sets the vertical adjustment of the GtkScrollable.

getHscrollPolicy
GtkScrollablePolicy getHscrollPolicy()

Gets the horizontal GtkScrollablePolicy.

setHscrollPolicy
void setHscrollPolicy(GtkScrollablePolicy policy)

Sets the GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

getVscrollPolicy
GtkScrollablePolicy getVscrollPolicy()

Gets the vertical GtkScrollablePolicy.

setVscrollPolicy
void setVscrollPolicy(GtkScrollablePolicy policy)

Sets the GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

Meta