Gtk.TreeView Members

The members of Gtk.TreeView are listed below.

See Also: Inherited members from Gtk.Container

Public Constructors

Creates a new Gtk.TreeView object.
TreeView constructor
Creates a new Gtk.TreeView object.
Internal constructor

Protected Constructors

Protected Constructor.

Public Properties

[read-only]
BinWindowGdk.Window. The window that this TreeView renders to.
[write-only]
ColumnDragFunctionTreeViewColumnDropFunc. The function for determining where a column may be dropped when dragged.
[read-only]
ColumnsTreeViewColumn[]. A list of all the columns currently in this TreeView.
[write-only]
DestroyCountFuncTreeDestroyCountFunc. This property 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.
EnableGridLinesTreeViewGridLines. Indicates which grid lines are drawn.
EnableSearchbool. View allows user to search through columns interactively.
EnableTreeLinesbool. Indicates if connecting lines are drawn for expanders.
[read-only]
EvenRowColorGdk.Color. This property contains the background color that is used for all odd rows.
ExpanderColumnTreeViewColumn. Set the column for the expander column.
FixedHeightModebool. Whether or not to assume all rows are the same height.
[read-only]
static
GTypeGLib.GType. GType Property.
HadjustmentAdjustment. Horizontal Adjustment for the widget.
HeadersClickablebool. Column headers respond to click events.
HeadersVisiblebool. Show the column header buttons.
HoverExpandbool. Documentation for this section has not yet been entered.
HoverSelectionbool. Whether a row should be highlighted when the cursor is over it.
[read-only]
IsRubberBandingActivebool. Documentation for this section has not yet been entered.
LevelIndentationint. Extra indentation amount for each level of the hierarchy.
ModelTreeModel. The model for the TreeView.
[read-only]
OddRowColorGdk.Color. This property contains the background color that is used for all even rows.
Reorderablebool. Allows to reorder rows in the view (this enables the internal drag and drop of TreeView rows).
RowSeparatorFuncTreeViewRowSeparatorFunc. Callback function to indicate whether or not a given row of the tree view should be rendered as a separator.
RubberBandingbool. Indicates if Rubberbanding multi-selection is supported.
RulesHintbool. Whether to display alternating, shaded rows in the k.TreeView.
SearchColumnint. Model column to search through when searching through code.
SearchEntryEntry. Identifies a custom search entry widget for the view.
SearchEqualFuncTreeViewSearchEqualFunc. The compare function for the interactive search capabilities.
SearchPositionFuncTreeViewSearchPositionFunc. Delegate to use when positioning the search dialog for the view.
[read-only]
SelectionTreeSelection. Gets the Gtk.TreeSelection associated with the TreeView.
ShowExpandersbool. Indicates if expanders are shown.
TooltipColumnint. Documentation for this section has not yet been entered.
VadjustmentAdjustment. Vertical Adjustment for the widget.
[read-only]
VisibleRectGdk.Rectangle. Returns the currently-visible region of the tree view, in tree view coordinates.

Public Methods

ActivateRow(TreePath, TreeViewColumn)
Activates the cell determined by path and column.
AppendColumn(TreeViewColumn) : int
Appends column to the list of columns.
AppendColumn(string, CellRenderer, CellLayoutDataFunc) : TreeViewColumn
Adds a new Gtk.TreeViewColumn to the TreeView and returns it.
AppendColumn(string, CellRenderer, TreeCellDataFunc) : TreeViewColumn
Adds a new Gtk.TreeViewColumn to the TreeView and returns it.
AppendColumn(string, CellRenderer, params object[]) : TreeViewColumn
Adds a Gtk.CellRenderer with a specific column title and attributes.
CollapseAll()
Recursively collapses all visible and expanded nodes.
CollapseRow(TreePath) : bool
Collapses a row (hides its child rows, if they exist).
ColumnsAutosize()
Resizes all columns to their optimal width.
ConvertBinWindowToTreeCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
ConvertBinWindowToWidgetCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
ConvertTreeToBinWindowCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
ConvertTreeToWidgetCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
ConvertWidgetToBinWindowCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
ConvertWidgetToTreeCoords(int, int, out int, out int)
Documentation for this section has not yet been entered.
CreateRowDragIcon(TreePath) : Gdk.Pixmap
This image is used for a drag icon.
EnableModelDragDest(TargetEntry[], Gdk.DragAction)
Turns this TreeView object into a destination for automatic drag-and-drop.
EnableModelDragSource(Gdk.ModifierType, TargetEntry[], Gdk.DragAction)
Allows the TreeView to be used as a source for drag-and-drop actions.
ExpandAll()
Recursively expands all nodes.
ExpandRow(TreePath, bool) : bool
Opens the row so its children are visible.
ExpandToPath(TreePath)
Expands the treeview so the Path specified is visible.
GetBackgroundArea(TreePath, TreeViewColumn) : Gdk.Rectangle
Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column.
GetCellArea(TreePath, TreeViewColumn) : Gdk.Rectangle
Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column.
GetColumn(int) : TreeViewColumn
Gets the Gtk.TreeViewColumn at the given position in the Gtk.TreeView.
GetCursor(out TreePath, out TreeViewColumn)
Gets the currently selected row and focused column.
GetDestRowAtPos(int, int, out TreePath, out TreeViewDropPosition) : bool
Determines the destination row for a given XY position. This is used by drag-and-drop operations to determine the target rows for the action.
GetDragDestRow(out TreePath, out TreeViewDropPosition)
Gets information about the row that is highlighted for feedback.
GetPathAtPos(int, int, out TreePath) : bool
Finds the path at the point (x, y), relative to widget coordinates.
GetPathAtPos(int, int, out TreePath, out TreeViewColumn) : bool
Finds the path at the point (x, y), relative to widget coordinates.
GetPathAtPos(int, int, out TreePath, out TreeViewColumn, out int, out int) : bool
Finds the path at the point (x, y), relative to widget coordinates.
GetRowExpanded(TreePath) : bool
Returns true if the node pointed to by path is expanded.
GetTooltipContext(out int, out int, bool, out TreeModel, out TreePath, out TreeIter) : bool
Documentation for this section has not yet been entered.
GetVisibleRange(out TreePath, out TreePath) : bool
Gets the visible rows of the view.
GetVisibleRect(Gdk.Rectangle)
Obsolete (and non-functional). Replaced by TreeView.VisibleRect.
InsertColumn(TreeViewColumn, int) : int
This inserts the column into the Gtk.TreeView at position.
InsertColumn(int, string, CellRenderer, CellLayoutDataFunc) : int
Convenience function that inserts a new column into the tree view with the given cell renderer and a Gtk.CellLayoutDataFunc to set cell renderer attributes (normally using data from the model).
InsertColumn(int, string, CellRenderer, params object[]) : int
Convenience function that inserts a new column into the tree view with the given cell renderer and attribute bindings for the cell renderer.
MapExpandedRows(TreeViewMappingFunc)
Calls the given function on all expanded rows.
MoveColumnAfter(TreeViewColumn, TreeViewColumn)
Moves column to be after to base_column.
RemoveColumn(TreeViewColumn) : int
Removes column from Gtk.TreeView.
ScrollToCell(TreePath, TreeViewColumn, bool, float, float)
Moves the alignments of the Gtk.TreeView to the position specified by column and path.
ScrollToPoint(int, int)
Scrolls the Gtk.TreeView 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 window coordinates.
SetColumnDragFunction(TreeViewColumnDropFunc, IntPtr, DestroyNotify)
Sets a user function for determining where a column may be dropped when dragged.
SetCursor(TreePath, TreeViewColumn, bool)
Sets the current keyboard focus to be at path, and selects it.
SetCursorOnCell(TreePath, TreeViewColumn, CellRenderer, bool)
Sets the current keyboard focus to be on the given Gtk.TreePath. This is useful for getting the user's attention to a particular row.
SetDestroyCountFunc(TreeDestroyCountFunc, IntPtr, DestroyNotify)
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(TreePath, TreeViewDropPosition)
Sets the row that is highlighted for drag-and-drop feedback.
SetSearchEqualFunc(TreeViewSearchEqualFunc, IntPtr, DestroyNotify)
Sets the compare function for the interactive search capabilities.
SetTooltipCell(Tooltip, TreePath, TreeViewColumn, CellRenderer)
Documentation for this section has not yet been entered.
SetTooltipRow(Tooltip, TreePath)
Documentation for this section has not yet been entered.
TreeToWidgetCoords(int, int, out int, out int)
Converts tree coordinates to widget coordinates. Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.
UnsetRowsDragDest()
Disables the TreeView as a drag-and-drop destination.
UnsetRowsDragSource()
Disables the TreeView as a drag source for automatic drag and drop actions.
WidgetToTreeCoords(int, int, out int, out int)
Converts widget coordinates to coordinates for the tree window (the full scrollable area of the tree).

Protected Methods

OnColumnsChanged()
Default handler for the TreeView.ColumnsChanged event.
OnCursorChanged()
Default handler for the TreeView.CursorChanged event.
OnExpandCollapseCursorRow(bool, bool, bool) : bool
Default handler for the TreeView.ExpandCollapseCursorRow event.
OnMoveCursor(MovementStep, int) : bool
Default handler for the TreeView.MoveCursor event.
OnRowActivated(TreePath, TreeViewColumn)
Default handler for the TreeView.RowActivated event.
OnRowCollapsed(TreeIter, TreePath)
Default handler for the TreeView.RowCollapsed event.
OnRowExpanded(TreeIter, TreePath)
Default handler for the TreeView.RowExpanded event.
OnScrollAdjustmentsSet(Adjustment, Adjustment)
Default handler for the TreeView.ScrollAdjustmentsSet event.
OnSelectAll() : bool
Default handler for the TreeView.SelectAll event.
OnSelectCursorParent() : bool
Default handler for the TreeView.SelectCursorParent event.
OnSelectCursorRow(bool) : bool
Default handler for the TreeView.SelectCursorRow event.
OnStartInteractiveSearch() : bool
Default handler for the TreeView.StartInteractiveSearch event.
OnTestCollapseRow(TreeIter, TreePath) : bool
Default handler for the TreeView.TestCollapseRow event.
OnTestExpandRow(TreeIter, TreePath) : bool
Default handler for the TreeView.TestExpandRow event.
OnToggleCursorRow() : bool
Default handler for the TreeView.ToggleCursorRow event.
OnUnselectAll() : bool
Default handler for the TreeView.UnselectAll event.

Public Events

ColumnsChangedRaised when the columns of this tree change.
CursorChangedRaised when the cursor changes (rows).
ExpandCollapseCursorRowRaised when the row where the cursor is is expanded or collapsed.
MoveCursorRaised whenever the cursor is moved on this TreeView.
RowActivatedRaised when a row is activated; see TreeView.ActivateRow.
RowCollapsedRaised whenever a row is collapsed.
RowExpandedRaised whenever a row of the TreeView is expanded.
ScrollAdjustmentsSetRaised whenever the scrollbar adjustment units are set.
SelectAllRaised whenever all rows of the TreeView are selected.
SelectCursorParentRaised when the parent row of the current row is selected.
SelectCursorRowRaised when the row the cursor is on is selected.
StartInteractiveSearchRaised when the user begins a search of the tree.
TestCollapseRowRaised when the system wants to know whether a particular row can be collapsed.
TestExpandRowRaised when the widget wants to find out whether a row can be expanded or not.
ToggleCursorRowRaised when the cursor toggles a row.
UnselectAllRaised whenever all rows of the TreeView are specifically deselected.