GtkTreeView

Description

A widget for displaying both trees and lists

Methods and Functions

gtkTreeViewNew(show = TRUE)
gtkTreeViewNewWithModel(model = NULL, show = TRUE)
gtkTreeViewGetModel(object)
gtkTreeViewSetModel(object, model = NULL)
gtkTreeViewGetSelection(object)
gtkTreeViewGetHadjustment(object)
gtkTreeViewSetHadjustment(object, adjustment)
gtkTreeViewGetVadjustment(object)
gtkTreeViewSetVadjustment(object, adjustment)
gtkTreeViewGetHeadersVisible(object)
gtkTreeViewSetHeadersVisible(object, headers.visible)
gtkTreeViewColumnsAutosize(object)
gtkTreeViewSetHeadersClickable(object, active)
gtkTreeViewSetRulesHint(object, setting)
gtkTreeViewGetRulesHint(object)
gtkTreeViewAppendColumn(object, column)
gtkTreeViewRemoveColumn(object, column)
gtkTreeViewInsertColumn(object, column, position)
gtkTreeViewInsertColumnWithAttributes(object, position, title, cell, ...)
gtkTreeViewInsertColumnWithDataFunc(object, position, title, cell, func, data = NULL)
gtkTreeViewGetColumn(object, n)
gtkTreeViewGetColumns(object)
gtkTreeViewMoveColumnAfter(object, column, base.column = NULL)
gtkTreeViewSetExpanderColumn(object, column)
gtkTreeViewGetExpanderColumn(object)
gtkTreeViewSetColumnDragFunction(object, func, user.data = NULL)
gtkTreeViewScrollToPoint(object, tree.x, tree.y)
gtkTreeViewScrollToCell(object, path, column = NULL, use.align = FALSE, row.align = 0, col.align = 0)
gtkTreeViewSetCursor(object, path, focus.column = NULL, start.editing = FALSE)
gtkTreeViewSetCursorOnCell(object, path, focus.column = NULL, focus.cell = NULL, start.editing = FALSE)
gtkTreeViewGetCursor(object)
gtkTreeViewRowActivated(object, path, column)
gtkTreeViewExpandAll(object)
gtkTreeViewCollapseAll(object)
gtkTreeViewExpandToPath(object, path)
gtkTreeViewExpandRow(object, path, open.all)
gtkTreeViewCollapseRow(object, path)
gtkTreeViewMapExpandedRows(object, func, data = NULL)
gtkTreeViewRowExpanded(object, path)
gtkTreeViewSetReorderable(object, reorderable)
gtkTreeViewGetReorderable(object)
gtkTreeViewGetPathAtPos(object, x, y)
gtkTreeViewGetCellArea(object, path, column)
gtkTreeViewGetBackgroundArea(object, path, column)
gtkTreeViewGetVisibleRect(object)
gtkTreeViewGetVisibleRange(object)
gtkTreeViewGetBinWindow(object)
gtkTreeViewWidgetToTreeCoords(object, wx, wy)
gtkTreeViewTreeToWidgetCoords(object, tx, ty)
gtkTreeViewEnableModelDragDest(object, targets, actions)
gtkTreeViewEnableModelDragSource(object, start.button.mask, targets, actions)
gtkTreeViewUnsetRowsDragSource(object)
gtkTreeViewUnsetRowsDragDest(object)
gtkTreeViewSetDragDestRow(object, path, pos)
gtkTreeViewGetDragDestRow(object, path, pos)
gtkTreeViewGetDestRowAtPos(object, drag.x, drag.y)
gtkTreeViewCreateRowDragIcon(object, path)
gtkTreeViewSetEnableSearch(object, enable.search)
gtkTreeViewGetEnableSearch(object)
gtkTreeViewGetSearchColumn(object)
gtkTreeViewSetSearchColumn(object, column)
gtkTreeViewGetSearchEqualFunc(object)
gtkTreeViewSetSearchEqualFunc(object, search.equal.func, search.user.data = NULL)
gtkTreeViewGetFixedHeightMode(object)
gtkTreeViewSetFixedHeightMode(object, enable)
gtkTreeViewGetHoverSelection(object)
gtkTreeViewSetHoverSelection(object, hover)
gtkTreeViewGetHoverExpand(object)
gtkTreeViewSetHoverExpand(object, expand)
gtkTreeViewSetDestroyCountFunc(object, func, data = NULL)
gtkTreeViewGetRowSeparatorFunc(object)
gtkTreeViewSetRowSeparatorFunc(object, func, data = NULL)
gtkTreeView(model = NULL, show = TRUE)

Hierarchy

  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkTreeView

Interfaces

GtkTreeView implements AtkImplementorIface.

Detailed Description

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.

Structures

GtkTreeView

undocumented

Convenient Construction

gtkTreeView is the result of collapsing the constructors of GtkTreeView (gtkTreeViewNew, gtkTreeViewNewWithModel) and accepts a subset of its arguments matching the required arguments of one of its delegate constructors.

Enums and Flags

GtkTreeViewDropPosition

An enum for determining where a dropped row goes.

before

undocumented

after

undocumented

into-or-before

undocumented

into-or-after

undocumented

User Functions

GtkTreeViewColumnDropFunc(tree.view, column, prev.column, next.column, data)

Function type for determining whether column can be dropped in a particular spot (as determined by prev.column and next.column). In left to right locales, prev.column is on the left of the potential drop spot, and next.column is on the right. In right to left mode, this is reversed. This function should return TRUE if the spot is a valid drop spot. Please note that returning TRUE does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user.

tree.view

[GtkTreeView] A GtkTreeView

column

[GtkTreeViewColumn] The GtkTreeViewColumn being dragged

prev.column

[GtkTreeViewColumn] A GtkTreeViewColumn on one side of column

next.column

[GtkTreeViewColumn] A GtkTreeViewColumn on the other side of column

data

[R object] user data

GtkTreeViewMappingFunc(tree.view, path, user.data)

Function used for gtkTreeViewMapExpandedRows.

tree.view

[GtkTreeView] A GtkTreeView

path

[GtkTreePath] The path that's expanded

user.data

[R object] user data

GtkTreeViewSearchEqualFunc(model, column, key, iter, search.data)

A function used for checking whether a row in model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp() returning 0 for equal strings.

model

[GtkTreeModel] the GtkTreeModel being searched

column

[integer] the search column set by gtkTreeViewSetSearchColumn

key

[character] the key string to compare with

iter

[GtkTreeIter] a GtkTreeIter pointing the row of model that should be compared with key.

search.data

[R object] user data from gtkTreeViewSetSearchEqualFunc

GtkTreeDestroyCountFunc(tree.view, path, children, user.data)

tree.view

[GtkTreeView]

path

[GtkTreePath]

children

[integer]

user.data

[R object]

GtkTreeViewRowSeparatorFunc(model, iter, data)

Function type for determining whether the row pointed to by iter should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the GtkTreeViewRowSeparatorFunc returns.

model

[GtkTreeModel] the GtkTreeModel

iter

[GtkTreeIter] a GtkTreeIter pointing at a row in model

data

[R object] user data

Signals

columns-changed(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

cursor-changed(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

expand-collapse-cursor-row(treeview, arg1, arg2, arg3, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[logical]

arg2

[logical]

arg3

[logical]

user.data

[R object] user data set when the signal handler was connected.

move-cursor(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkMovementStep]

arg2

[integer]

user.data

[R object] user data set when the signal handler was connected.

row-activated(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkTreePath]

arg2

[GtkTreeViewColumn]

user.data

[R object] user data set when the signal handler was connected.

row-collapsed(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkTreeIter]

arg2

[GtkTreePath]

user.data

[R object] user data set when the signal handler was connected.

row-expanded(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkTreeIter]

arg2

[GtkTreePath]

user.data

[R object] user data set when the signal handler was connected.

select-all(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

select-cursor-parent(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

select-cursor-row(treeview, arg1, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[logical]

user.data

[R object] user data set when the signal handler was connected.

set-scroll-adjustments(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkAdjustment]

arg2

[GtkAdjustment]

user.data

[R object] user data set when the signal handler was connected.

start-interactive-search(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

test-collapse-row(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkTreeIter]

arg2

[GtkTreePath]

user.data

[R object] user data set when the signal handler was connected.

test-expand-row(treeview, arg1, arg2, user.data)

treeview

[GtkTreeView] the object which received the signal.

arg1

[GtkTreeIter]

arg2

[GtkTreePath]

user.data

[R object] user data set when the signal handler was connected.

toggle-cursor-row(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

unselect-all(treeview, user.data)

treeview

[GtkTreeView] the object which received the signal.

user.data

[R object] user data set when the signal handler was connected.

Properties

enable-search [logical : Read / Write]

View allows user to search through columns interactively. Default value: TRUE

expander-column [GtkTreeViewColumn : Read / Write]

Set the column for the expander column.

fixed-height-mode [logical : Read / Write]

Setting the ::fixed-height-mode property to TRUE speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtkTreeViewSetFixedHeightMode for more information on this option.

Default value: FALSE Since 2.4

hadjustment [GtkAdjustment : Read / Write]

Horizontal Adjustment for the widget.

headers-clickable [logical : Read / Write]

Column headers respond to click events. Default value: FALSE

headers-visible [logical : Read / Write]

Show the column header buttons. Default value: TRUE

hover-expand [logical : Read / Write]

Enables of disables the hover expansion mode of tree.view. Hover expansion makes rows expand or collaps if the pointer moves over them.

This mode is primarily indended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.

Default value: FALSE Since 2.6

hover-selection [logical : Read / Write]

Enables of disables the hover selection mode of tree.view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes GTK_SELECTION_SINGLE and GTK_SELECTION_BROWSE.

This mode is primarily indended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.

Default value: FALSE Since 2.6

model [GtkTreeModel : Read / Write]

The model for the tree view.

reorderable [logical : Read / Write]

View is reorderable. Default value: FALSE

rules-hint [logical : Read / Write]

Set a hint to the theme engine to draw rows in alternating colors. Default value: FALSE

search-column [integer : Read / Write]

Model column to search through when searching through code. Allowed values: >= -1 Default value: -1

vadjustment [GtkAdjustment : Read / Write]

Vertical Adjustment for the widget.

Style Properties

allow-rules [logical : Read]

Allow drawing of alternating color rows. Default value: TRUE

even-row-color [GdkColor : Read]

Color to use for even rows.

expander-size [integer : Read]

Size of the expander arrow. Allowed values: >= 0 Default value: 12

horizontal-separator [integer : Read]

Horizontal space between cells. Must be an even number. Allowed values: >= 0 Default value: 2

indent-expanders [logical : Read]

Make the expanders indented. Default value: TRUE

odd-row-color [GdkColor : Read]

Color to use for odd rows.

vertical-separator [integer : Read]

Vertical space between cells. Must be an even number. Allowed values: >= 0 Default value: 2

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/gtk/GtkTreeView.html

See Also

GtkTreeViewColumn GtkTreeSelection GtkTreeSortable GtkTreeModelSort GtkListStore GtkTreeStore GtkCellRenderer GtkCellEditable GtkCellRendererPixbuf GtkCellRendererText GtkCellRendererToggle