TreeView

Widget that displays any object that implements the gtk.TreeModel 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:

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 TreeView.convertWidgetToBinWindowCoords (and vice versa), for the latter TreeView.convertBinWindowToTreeCoords (and vice versa).

GtkTreeView as GtkBuildable

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

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

# CSS nodes

|[<!-- language="plain" -->
treeview.view
├── header
│   ├── <column header>
┊   ┊
│   ╰── <column 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.

class TreeView : Container , ScrollableIF {

GtkTreeView* gtkTreeView;

GtkTreeView* getTreeViewStruct(bool transferOwnership);

void* getStruct();

this(GtkTreeView* gtkTreeView, bool ownedRef);

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

TreeIter getSelectedIter();

TreeIter[] getSelectedIters();

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

static GType getType();

this(TreeModelIF model);

int appendColumn(TreeViewColumn column);

void collapseAll();

bool collapseRow(TreePath path);

void columnsAutosize();

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

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

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

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

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

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

Surface createRowDragIcon(TreePath path);

void enableModelDragDest(TargetEntry[] targets, GdkDragAction actions);

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

void expandAll();

bool expandRow(TreePath path, bool openAll);

void expandToPath(TreePath path);

bool getActivateOnSingleClick();

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

Window getBinWindow();

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

TreeViewColumn getColumn(int n);

ListG getColumns();

void getCursor(TreePath path, TreeViewColumn focusColumn);

bool getDestRowAtPos(int dragX, int dragY, TreePath path, GtkTreeViewDropPosition pos);

void getDragDestRow(TreePath path, GtkTreeViewDropPosition pos);

bool getEnableSearch();

bool getEnableTreeLines();

TreeViewColumn getExpanderColumn();

bool getFixedHeightMode();

GtkTreeViewGridLines getGridLines();

bool getHeadersClickable();

bool getHeadersVisible();

bool getHoverExpand();

bool getHoverSelection();

int getLevelIndentation();

TreeModelIF getModel();

uint getNColumns();

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

bool getReorderable();

GtkTreeViewRowSeparatorFunc getRowSeparatorFunc();

bool getRubberBanding();

bool getRulesHint();

int getSearchColumn();

Entry getSearchEntry();

GtkTreeViewSearchEqualFunc getSearchEqualFunc();

GtkTreeViewSearchPositionFunc getSearchPositionFunc();

TreeSelection getSelection();

bool getShowExpanders();

int getTooltipColumn();

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

bool getVisibleRange(TreePath startPath, TreePath endPath);

void getVisibleRect(GdkRectangle visibleRect);

int insertColumn(TreeViewColumn column, int position);

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

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

bool isRubberBandingActive();

void mapExpandedRows(GtkTreeViewMappingFunc func, void* data);

void moveColumnAfter(TreeViewColumn column, TreeViewColumn baseColumn);

int removeColumn(TreeViewColumn column);

void rowActivated(TreePath path, TreeViewColumn column);

bool rowExpanded(TreePath path);

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

void scrollToPoint(int treeX, int treeY);

void setActivateOnSingleClick(bool single);

void setColumnDragFunction(GtkTreeViewColumnDropFunc func, void* userData, GDestroyNotify destroy);

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

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

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

void setDragDestRow(TreePath path, GtkTreeViewDropPosition pos);

void setEnableSearch(bool enableSearch);

void setEnableTreeLines(bool enabled);

void setExpanderColumn(TreeViewColumn column);

void setFixedHeightMode(bool enable);

void setGridLines(GtkTreeViewGridLines gridLines);

void setHeadersClickable(bool setting);

void setHeadersVisible(bool headersVisible);

void setHoverExpand(bool expand);

void setHoverSelection(bool hover);

void setLevelIndentation(int indentation);

void setModel(TreeModelIF model);

void setReorderable(bool reorderable);

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

void setRubberBanding(bool enable);

void setRulesHint(bool setting);

void setSearchColumn(int column);

void setSearchEntry(Entry entry);

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

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

void setShowExpanders(bool enabled);

void setTooltipCell(Tooltip tooltip, TreePath path, TreeViewColumn column, CellRenderer cell);

void setTooltipColumn(int column);

void setTooltipRow(Tooltip tooltip, TreePath path);

void unsetRowsDragDest();

void unsetRowsDragSource();

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

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

gulong addOnExpandCollapseCursorRow(bool delegate(bool, bool, bool, TreeView) dlg, ConnectFlags connectFlags);

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

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

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

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

gulong addOnSelectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags);

gulong addOnSelectCursorParent(bool delegate(TreeView) dlg, ConnectFlags connectFlags);

gulong addOnSelectCursorRow(bool delegate(bool, TreeView) dlg, ConnectFlags connectFlags);

gulong addOnStartInteractiveSearch(bool delegate(TreeView) dlg, ConnectFlags connectFlags);

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

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

gulong addOnToggleCursorRow(bool delegate(TreeView) dlg, ConnectFlags connectFlags);

gulong addOnUnselectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkTreeView* gtkTreeView, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new gtk.TreeView widget.
this this(TreeModelIF model): Creates a new gtk.TreeView widget with the model initialized to model.

Members

Functions

addOnColumnsChanged gulong addOnColumnsChanged(void delegate(TreeView) dlg, ConnectFlags connectFlags): The number of columns of the treeview has changed.
addOnCursorChanged gulong addOnCursorChanged(void delegate(TreeView) dlg, ConnectFlags connectFlags): The position of the cursor (focused cell) has changed.
addOnExpandCollapseCursorRow gulong addOnExpandCollapseCursorRow(bool delegate(bool, bool, bool, TreeView) dlg, ConnectFlags connectFlags)
addOnMoveCursor gulong addOnMoveCursor(bool delegate(GtkMovementStep, int, TreeView) dlg, ConnectFlags connectFlags): The move-cursor signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user presses one of the cursor keys.
addOnRowActivated gulong addOnRowActivated(void delegate(TreePath, TreeViewColumn, TreeView) dlg, ConnectFlags connectFlags): The "row-activated" signal is emitted when the method TreeView.rowActivated is called, when the user double clicks a treeview row with the "activate-on-single-click" property set to FALSE, or when the user single clicks a row when the "activate-on-single-click" property set to TRUE. It is also emitted when a non-editable row is selected and one of the keys: Space, Shift+Space, Return or Enter is pressed.
addOnRowCollapsed gulong addOnRowCollapsed(void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags): The given row has been collapsed (child nodes are hidden).
addOnRowExpanded gulong addOnRowExpanded(void delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags): The given row has been expanded (child nodes are shown).
addOnSelectAll gulong addOnSelectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorParent gulong addOnSelectCursorParent(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnSelectCursorRow gulong addOnSelectCursorRow(bool delegate(bool, TreeView) dlg, ConnectFlags connectFlags)
addOnStartInteractiveSearch gulong addOnStartInteractiveSearch(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnTestCollapseRow gulong addOnTestCollapseRow(bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags): The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.
addOnTestExpandRow gulong addOnTestExpandRow(bool delegate(TreeIter, TreePath, TreeView) dlg, ConnectFlags connectFlags): The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.
addOnToggleCursorRow gulong addOnToggleCursorRow(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
addOnUnselectAll gulong addOnUnselectAll(bool delegate(TreeView) dlg, ConnectFlags connectFlags)
appendColumn int appendColumn(TreeViewColumn column): Appends column to the list of columns. If tree_view has “fixed_height” mode enabled, then column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.
collapseAll void collapseAll(): Recursively collapses all visible, expanded nodes in tree_view.
collapseRow bool collapseRow(TreePath path): Collapses a row (hides its child rows, if they exist).
columnsAutosize void columnsAutosize(): Resizes all columns to their optimal width. Only works after the treeview has been realized.
convertBinWindowToTreeCoords void convertBinWindowToTreeCoords(int bx, int by, int tx, int ty): Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).
convertBinWindowToWidgetCoords void convertBinWindowToWidgetCoords(int bx, int by, int wx, int wy): Converts bin_window coordinates (see TreeView.getBinWindow) to widget relative coordinates.
convertTreeToBinWindowCoords void convertTreeToBinWindowCoords(int tx, int ty, int bx, int by): Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.
convertTreeToWidgetCoords void convertTreeToWidgetCoords(int tx, int ty, int wx, int wy): Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.
convertWidgetToBinWindowCoords void convertWidgetToBinWindowCoords(int wx, int wy, int bx, int by): Converts widget coordinates to coordinates for the bin_window (see TreeView.getBinWindow).
convertWidgetToTreeCoords void convertWidgetToTreeCoords(int wx, int wy, int tx, int ty): Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).
createRowDragIcon 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(TargetEntry[] 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, TargetEntry[] 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, bool openAll): Expands the row of the iter.
expandRow bool expandRow(TreePath path, bool openAll): Opens the row so its children are visible.
expandToPath void expandToPath(TreePath path): Expands the row at path. This will also expand all parent rows of path as necessary.
getActivateOnSingleClick bool getActivateOnSingleClick(): Gets the setting set by TreeView.setActivateOnSingleClick.
getBackgroundArea void getBackgroundArea(TreePath path, TreeViewColumn column, GdkRectangle rect): Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by path and the column specified by column. If path is NULL, or points to a node not found in the tree, the y and height fields of the rectangle will be filled with 0. If column is NULL, the x and width fields will be filled with 0. The returned rectangle is equivalent to the background_area passed to CellRenderer.render. These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by TreeView.getCellArea, 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, 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 CellRenderer.render. This function is only valid if tree_view is realized.
getColumn TreeViewColumn getColumn(int n): Gets the gtk.TreeViewColumn at the given position in the tree_view
getColumns ListG getColumns(): Returns a GList of all the gtk.TreeViewColumn s currently in tree_view. The returned list must be freed with g_list_free ().
getCursor void getCursor(TreePath path, TreeViewColumn focusColumn): Fills in path and focus_column with the current path and focus column. If the cursor isn’t currently set, then *path will be NULL. If no column currently has focus, then *focus_column will be NULL.
getDestRowAtPos bool getDestRowAtPos(int dragX, int dragY, TreePath path, GtkTreeViewDropPosition pos): Determines the destination row for a given position. drag_x and drag_y are expected to be in widget coordinates. This function is only meaningful if tree_view is realized. Therefore this function will always return FALSE if tree_view is not realized or does not have a model.
getDragDestRow void getDragDestRow(TreePath path, GtkTreeViewDropPosition pos): Gets information about the row that is highlighted for feedback.
getEnableSearch bool getEnableSearch(): Returns whether or not the tree allows to start interactive searching by typing in text.
getEnableTreeLines bool getEnableTreeLines(): Returns whether or not tree lines are drawn in tree_view.
getExpanderColumn TreeViewColumn getExpanderColumn(): Returns the column that is the current expander column. This column has the expander arrow drawn next to it.
getFixedHeightMode bool getFixedHeightMode(): Returns whether fixed height mode is turned on for tree_view.
getGridLines GtkTreeViewGridLines getGridLines(): Returns which grid lines are enabled in tree_view.
getHeadersClickable bool getHeadersClickable(): Returns whether all header columns are clickable.
getHeadersVisible bool getHeadersVisible(): Returns TRUE if the headers on the tree_view are visible.
getHoverExpand bool getHoverExpand(): Returns whether hover expansion mode is turned on for tree_view.
getHoverSelection bool getHoverSelection(): Returns whether hover selection mode is turned on for tree_view.
getLevelIndentation int getLevelIndentation(): Returns the amount, in pixels, of extra indentation for child levels in tree_view.
getModel TreeModelIF getModel(): Returns the model the gtk.TreeView is based on. Returns NULL if the model is unset.
getNColumns uint getNColumns(): Queries the number of columns in the given tree_view.
getPathAtPos bool getPathAtPos(int x, int y, TreePath path, TreeViewColumn column, int cellX, int cellY): Finds the path at the point (x, y), relative to bin_window coordinates (please see TreeView.getBinWindow). That is, x and y are relative to an events coordinates. x and y must come from an event on the tree_view only where `event->window == gtk_tree_view_get_bin_window ()`. It is primarily for things like popup menus. If path is non-NULL, then it will be filled with the gtk.TreePath at that point. This path should be freed with TreePath.free. If column is non-NULL, then it will be filled with the column at that point. cell_x and cell_y return the coordinates relative to the cell background (i.e. the background_area passed to CellRenderer.render). This function is only meaningful if tree_view is realized. Therefore this function will always return FALSE if tree_view is not realized or does not have a model.
getReorderable bool getReorderable(): Retrieves whether the user can reorder the tree via drag-and-drop. See TreeView.setReorderable.
getRowSeparatorFunc GtkTreeViewRowSeparatorFunc getRowSeparatorFunc(): Returns the current row separator function.
getRubberBanding bool getRubberBanding(): Returns whether rubber banding is turned on for tree_view. If the selection mode is GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.
getRulesHint bool getRulesHint(): Gets the setting set by TreeView.setRulesHint.
getSearchColumn int getSearchColumn(): Gets the column searched on by the interactive search code.
getSearchEntry Entry getSearchEntry(): Returns the gtk.Entry which is currently in use as interactive search entry for tree_view. In case the built-in entry is being used, NULL will be returned.
getSearchEqualFunc GtkTreeViewSearchEqualFunc getSearchEqualFunc(): Returns the compare function currently in use.
getSearchPositionFunc GtkTreeViewSearchPositionFunc getSearchPositionFunc(): Returns the positioning function currently in use.
getSelectedIter TreeIter getSelectedIter(): gets the first selected iter or null if no rows are selected
getSelectedIters TreeIter[] getSelectedIters()
getSelection TreeSelection getSelection(): Gets the gtk.TreeSelection associated with tree_view.
getShowExpanders bool getShowExpanders(): Returns whether or not expanders are drawn in tree_view.
getStruct void* getStruct(): the main Gtk struct as a void*
getTooltipColumn int getTooltipColumn(): Returns the column of tree_view’s model which is being used for displaying tooltips on tree_view’s rows.
getTooltipContext bool getTooltipContext(int x, int y, bool keyboardTip, TreeModelIF model, TreePath path, TreeIter iter): This function is supposed to be used in a query-tooltip signal handler for gtk.TreeView The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.
getTreeViewStruct GtkTreeView* getTreeViewStruct(bool transferOwnership): Get the main Gtk struct
getVisibleRange bool getVisibleRange(TreePath startPath, TreePath endPath): Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.
getVisibleRect void getVisibleRect(GdkRectangle visibleRect): Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with TreeView.convertTreeToBinWindowCoords. 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 gtk.TreeView with the given cell renderer and a GtkTreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also TreeView.columnSetCellDataFunc, TreeView.columnPackStart. 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 int insertEditableColumn(int position, string title, CellRenderer renderer, bool editable): Inserts a column and sets it's attributes
isBlankAtPos bool isBlankAtPos(int x, int y, TreePath path, TreeViewColumn column, int cellX, int cellY): Determine whether the point (x, y) in tree_view is blank, that is no cell content nor an expander arrow is drawn at the location. If so, the location can be considered as the background. You might wish to take special action on clicks on the background, such as clearing a current selection, having a custom context menu or starting rubber banding.
isRubberBandingActive bool isRubberBandingActive(): Returns whether a rubber banding operation is currently being done in tree_view.
mapExpandedRows void mapExpandedRows(GtkTreeViewMappingFunc func, void* data): Calls func on all expanded rows.
moveColumnAfter void moveColumnAfter(TreeViewColumn column, TreeViewColumn baseColumn): Moves column to be after to base_column. If base_column is NULL, then column is placed in the first position.
removeColumn int removeColumn(TreeViewColumn column): Removes column from tree_view.
rowActivated void rowActivated(TreePath path, TreeViewColumn column): Activates the cell determined by path and column.
rowExpanded bool rowExpanded(TreePath path): Returns TRUE if the node pointed to by path is expanded in tree_view.
scrollToCell void scrollToCell(TreePath path, TreeViewColumn column, bool useAlign, float rowAlign, float colAlign): Moves the alignments of tree_view to the position specified by column and path. If column is NULL, then no horizontal scrolling occurs. Likewise, if path is NULL no vertical scrolling occurs. At a minimum, one of column or path need to be non-NULL. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.
scrollToPoint void scrollToPoint(int treeX, int treeY): Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates. The tree_view must be realized before this function is called. If it isn't, you probably want to be using TreeView.scrollToCell.
setActivateOnSingleClick void setActivateOnSingleClick(bool 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 gtk.TreeViewColumn being dragged, the two gtk.TreeViewColumn s determining the drop spot, and user_data. If either of the gtk.TreeViewColumn arguments for the drop spot are NULL, then they indicate an edge. If func is set to be NULL, then tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.
setCursor void setCursor(TreePath path, TreeViewColumn focusColumn, bool startEditing): Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If focus_column is not NULL, then focus is given to the column specified by it. Additionally, if focus_column is specified, and start_editing is TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.
setCursorOnCell void setCursorOnCell(TreePath path, TreeViewColumn focusColumn, CellRenderer focusCell, bool startEditing): Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If focus_column is not NULL, then focus is given to the column specified by it. If focus_column and focus_cell are not NULL, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.
setDestroyCountFunc 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.
setDragDestRow void setDragDestRow(TreePath path, GtkTreeViewDropPosition pos): Sets the row that is highlighted for feedback. If path is NULL, an existing highlight is removed.
setEnableSearch void setEnableSearch(bool enableSearch): If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").
setEnableTreeLines void setEnableTreeLines(bool enabled): Sets whether to draw lines interconnecting the expanders in tree_view. This does not have any visible effects for lists.
setExpanderColumn void setExpanderColumn(TreeViewColumn column): Sets the column to draw the expander arrow at. It must be in tree_view. If column is NULL, then the expander arrow is always at the first visible column.
setFixedHeightMode void setFixedHeightMode(bool enable): Enables or disables the fixed height mode of tree_view. Fixed height mode speeds up gtk.TreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type GTK_TREE_VIEW_COLUMN_FIXED.
setGridLines void setGridLines(GtkTreeViewGridLines gridLines): Sets which grid lines to draw in tree_view.
setHeadersClickable void setHeadersClickable(bool setting): Allow the column title buttons to be clicked.
setHeadersVisible void setHeadersVisible(bool headersVisible): Sets the visibility state of the headers.
setHoverExpand void setHoverExpand(bool expand): Enables or disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.
setHoverSelection void setHoverSelection(bool hover): Enables or disables the hover selection mode of tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes GTK_SELECTION_SINGLE and GTK_SELECTION_BROWSE.
setLevelIndentation void setLevelIndentation(int indentation): Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.
setModel void setModel(TreeModelIF model): Sets the model for a gtk.TreeView If the tree_view already has a model set, it will remove it before setting the new model. If model is NULL, then it will unset the old model.
setReorderable void setReorderable(bool reorderable): This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface Both gtk.TreeStore and gtk.ListStore support these. If reorderable is TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model’s 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.
setRowSeparatorFunc void setRowSeparatorFunc(GtkTreeViewRowSeparatorFunc func, void* data, GDestroyNotify destroy): Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is NULL, no separators are drawn. This is the default value.
setRubberBanding void setRubberBanding(bool enable): Enables or disables rubber banding in tree_view. If the selection mode is GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.
setRulesHint 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".
setSearchColumn void setSearchColumn(int column): Sets column as the column where the interactive search code should search in for the current model.
setSearchEntry void setSearchEntry(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.
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.
setShowExpanders void setShowExpanders(bool enabled): Sets whether to draw and enable expanders and indent child rows in tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using TreeView.setLevelIndentation. This does not have any visible effects for lists.
setTooltipCell void setTooltipCell(Tooltip tooltip, TreePath path, TreeViewColumn column, CellRenderer cell): Sets the tip area of tooltip to the area path, column and cell have in common. For example if path is NULL and column is set, the tip area will be set to the full area covered by column. See also Tooltip.setTipArea.
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 gtk.TreeView handle these automatically for you. column should be set to the column in tree_view’s model containing the tooltip texts, or -1 to disable this feature.
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 TreeView.setTooltipColumn for a simpler alternative. See also Tooltip.setTipArea.
unsetRowsDragDest void unsetRowsDragDest(): Undoes the effect of TreeView.enableModelDragDest. Calling this method sets reorderable to FALSE.
unsetRowsDragSource void unsetRowsDragSource(): Undoes the effect of TreeView.enableModelDragSource. Calling this method sets reorderable to FALSE.

Static functions

getType GType getType()

Variables

gtkTreeView GtkTreeView* gtkTreeView;: the main Gtk struct

Inherited Members

From Container

gtkContainer GtkContainer* gtkContainer;: the main Gtk struct
getContainerStruct GtkContainer* getContainerStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
removeAll void removeAll(): Removes all widgets from the container
getType GType getType()
add void add(Widget widget): Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to 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.
checkResize void checkResize()
childGetProperty void childGetProperty(Widget child, string propertyName, Value value): Gets the value of 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.
childNotify void childNotify(Widget child, string childProperty): Emits a child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(Widget child, string propertyName, Value value): Sets a child property for child and container.
childSetValist void childSetValist(Widget child, string firstPropertyName, void* varArgs): Sets one or more child properties for child and container.
childType GType childType(): Returns the type of the children supported by the container.
forall void forall(GtkCallback callback, void* callbackData): Invokes callback on each direct 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.
foreach_ void foreach_(GtkCallback callback, void* callbackData): Invokes callback on each non-internal child of container. See Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See Container.setBorderWidth.
getChildren ListG getChildren(): Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.
getFocusChain bool 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.
getFocusChild Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.
getFocusHadjustment Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.
getPathForChild WidgetPath getPathForChild(Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode GtkResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
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 gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.
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 before removing it from 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 Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(ListG focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(Widget child): Sets, or unsets if child is NULL, the focused child of container.
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 ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.
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 ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(GtkResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with Container.setFocusChain.
addOnAdd gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)

From ScrollableIF

getScrollableStruct GtkScrollable* getScrollableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getBorder bool getBorder(Border border): Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.
getHadjustment Adjustment getHadjustment(): Retrieves the gtk.Adjustment used for horizontal scrolling.
getHscrollPolicy GtkScrollablePolicy getHscrollPolicy(): Gets the horizontal GtkScrollablePolicy
getVadjustment Adjustment getVadjustment(): Retrieves the gtk.Adjustment used for vertical scrolling.
getVscrollPolicy GtkScrollablePolicy getVscrollPolicy(): Gets the vertical GtkScrollablePolicy
setHadjustment void setHadjustment(Adjustment hadjustment): Sets the horizontal adjustment of the GtkScrollable
setHscrollPolicy void setHscrollPolicy(GtkScrollablePolicy policy): Sets the GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
setVadjustment void setVadjustment(Adjustment vadjustment): Sets the vertical adjustment of the GtkScrollable
setVscrollPolicy void setVscrollPolicy(GtkScrollablePolicy policy): Sets the GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

gtk TreeView classes

TreeView