GI.Gtk.Objects.TreeView

Widget that displays any object that implements the 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 treeViewConvertWidgetToBinWindowCoords (and vice versa), for the latter treeViewConvertBinWindowToTreeCoords (and vice versa).

GtkTreeView as GtkBuildable

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

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

CSS nodes

plain code

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.

Exported types

newtype TreeView

Constructors

TreeView (ManagedPtr TreeView)

Instances

GObject TreeView

Methods

gobjectType :: TreeView -> IO GType

IsImplementorIface TreeView

IsObject TreeView

IsWidget TreeView

IsTreeView TreeView

IsContainer TreeView

IsScrollable TreeView

IsBuildable TreeView

class GObject o => IsTreeView o

Instances

(GObject a, UnknownAncestorError Constraint TreeView a) => IsTreeView a

IsTreeView TreeView

toTreeView :: (MonadIO m, IsTreeView o) => o -> m TreeView

noTreeView :: Maybe TreeView

Methods

appendColumn

treeViewAppendColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView.

-> b

column: The TreeViewColumn to add.

-> m Int32

Returns: The number of columns in treeView after appending.

Appends column to the list of columns. If treeView has “fixed_height” mode enabled, then column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

collapseAll

treeViewCollapseAll

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m ()

Recursively collapses all visible, expanded nodes in treeView.

collapseRow

treeViewCollapseRow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> TreePath

path: path to a row in the treeView

-> m Bool

Returns: True if the row was collapsed.

Collapses a row (hides its child rows, if they exist).

columnsAutosize

treeViewColumnsAutosize

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m ()

Resizes all columns to their optimal width. Only works after the treeview has been realized.

convertBinWindowToTreeCoords

treeViewConvertBinWindowToTreeCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

bx: X coordinate relative to bin_window

-> Int32

by: Y coordinate relative to bin_window

-> m (Int32, Int32)

Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

Since: 2.12

convertBinWindowToWidgetCoords

treeViewConvertBinWindowToWidgetCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

bx: bin_window X coordinate

-> Int32

by: bin_window Y coordinate

-> m (Int32, Int32)

Converts bin_window coordinates (see treeViewGetBinWindow) to widget relative coordinates.

Since: 2.12

convertTreeToBinWindowCoords

treeViewConvertTreeToBinWindowCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

tx: tree X coordinate

-> Int32

ty: tree Y coordinate

-> m (Int32, Int32)

Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

Since: 2.12

convertTreeToWidgetCoords

treeViewConvertTreeToWidgetCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

tx: X coordinate relative to the tree

-> Int32

ty: Y coordinate relative to the tree

-> m (Int32, Int32)

Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

Since: 2.12

convertWidgetToBinWindowCoords

treeViewConvertWidgetToBinWindowCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

wx: X coordinate relative to the widget

-> Int32

wy: Y coordinate relative to the widget

-> m (Int32, Int32)

Converts widget coordinates to coordinates for the bin_window (see treeViewGetBinWindow).

Since: 2.12

convertWidgetToTreeCoords

treeViewConvertWidgetToTreeCoords

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

wx: X coordinate relative to the widget

-> Int32

wy: Y coordinate relative to the widget

-> m (Int32, Int32)

Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

Since: 2.12

createRowDragIcon

treeViewCreateRowDragIcon

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> TreePath

path: a TreePath in treeView

-> m Surface

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

Creates a Surface representation of the row at path. This image is used for a drag icon.

enableModelDragDest

treeViewEnableModelDragDest

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> [TargetEntry]

targets: the table of targets that the drag will support

-> [DragAction]

actions: the bitmask of possible actions for a drag from this widget

-> m ()

Turns treeView into a drop destination for automatic DND. Calling this method sets TreeView:reorderable to False.

enableModelDragSource

treeViewEnableModelDragSource

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> [ModifierType]

startButtonMask: Mask of allowed buttons to start drag

-> [TargetEntry]

targets: the table of targets that the drag will support

-> [DragAction]

actions: the bitmask of possible actions for a drag from this widget

-> m ()

Turns treeView into a drag source for automatic DND. Calling this method sets TreeView:reorderable to False.

expandAll

treeViewExpandAll

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m ()

Recursively expands all nodes in the treeView.

expandRow

treeViewExpandRow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> TreePath

path: path to a row

-> Bool

openAll: whether to recursively expand, or just expand immediate children

-> m Bool

Returns: True if the row existed and had children

Opens the row so its children are visible.

expandToPath

treeViewExpandToPath

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> TreePath

path: path to a row.

-> m ()

Expands the row at path. This will also expand all parent rows of path as necessary.

Since: 2.2

getActivateOnSingleClick

treeViewGetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

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

Gets the setting set by treeViewSetActivateOnSingleClick.

Since: 3.8

getBackgroundArea

treeViewGetBackgroundArea

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: a TreeView

-> Maybe TreePath

path: a TreePath for the row, or Nothing to get only horizontal coordinates

-> Maybe b

column: a TreeViewColumn for the column, or Nothing to get only vertical coordiantes

-> m Rectangle

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 Nothing, 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 Nothing, the x and width fields will be filled with 0. The returned rectangle is equivalent to the backgroundArea passed to cellRendererRender. These background areas tile to cover the entire bin window. Contrast with the cellArea, returned by treeViewGetCellArea, which returns only the cell itself, excluding surrounding borders and the tree expander area.

getBinWindow

treeViewGetBinWindow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m (Maybe Window)

Returns: A Window, or Nothing when treeView hasn’t been realized yet.

Returns the window that treeView renders to. This is used primarily to compare to event->window to confirm that the event on treeView is on the right window.

getCellArea

treeViewGetCellArea

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: a TreeView

-> Maybe TreePath

path: a TreePath for the row, or Nothing to get only horizontal coordinates

-> Maybe b

column: a TreeViewColumn for the column, or Nothing to get only vertical coordinates

-> m Rectangle

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 Nothing, or points to a path not currently displayed, the y and height fields of the rectangle will be filled with 0. If column is Nothing, 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 cellArea passed to cellRendererRender. This function is only valid if treeView is realized.

getColumn

treeViewGetColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Int32

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

-> m (Maybe TreeViewColumn)

Returns: The TreeViewColumn, or Nothing if the position is outside the range of columns.

Gets the TreeViewColumn at the given position in the tree_view.

getColumns

treeViewGetColumns

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m [TreeViewColumn]

Returns: A list of TreeViewColumn s

Returns a List of all the TreeViewColumn s currently in treeView. The returned list must be freed with g_list_free ().

getCursor

treeViewGetCursor

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m (Maybe TreePath, Maybe TreeViewColumn)

Fills in path and focusColumn with the current path and focus column. If the cursor isn’t currently set, then *path will be Nothing. If no column currently has focus, then *focusColumn will be Nothing.

The returned TreePath must be freed with treePathFree when you are done with it.

getDestRowAtPos

treeViewGetDestRowAtPos

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

dragX: the position to determine the destination row for

-> Int32

dragY: the position to determine the destination row for

-> m (Bool, Maybe TreePath, TreeViewDropPosition)

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

Determines the destination row for a given position. dragX and dragY are expected to be in widget coordinates. This function is only meaningful if treeView is realized. Therefore this function will always return False if treeView is not realized or does not have a model.

getDragDestRow

treeViewGetDragDestRow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m (Maybe TreePath, TreeViewDropPosition)

Gets information about the row that is highlighted for feedback.

getEnableSearch

treeViewGetEnableSearch

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m Bool

Returns: whether or not to let the user search interactively

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

getEnableTreeLines

treeViewGetEnableTreeLines

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView.

-> m Bool

Returns: True if tree lines are drawn in treeView, False otherwise.

Returns whether or not tree lines are drawn in treeView.

Since: 2.10

getExpanderColumn

treeViewGetExpanderColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m TreeViewColumn

Returns: The expander column.

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

getFixedHeightMode

treeViewGetFixedHeightMode

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if treeView is in fixed height mode

Returns whether fixed height mode is turned on for treeView.

Since: 2.6

getGridLines

treeViewGetGridLines

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m TreeViewGridLines

Returns: a TreeViewGridLines value indicating which grid lines are enabled.

Returns which grid lines are enabled in treeView.

Since: 2.10

getHadjustment

treeViewGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m Adjustment

Returns: A Adjustment object, or Nothing if none is currently being used.

Deprecated: (Since version 3.0)Use scrollableGetHadjustment

Gets the Adjustment currently being used for the horizontal aspect.

getHeadersClickable

treeViewGetHeadersClickable

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m Bool

Returns: True if all header columns are clickable, otherwise False

Returns whether all header columns are clickable.

Since: 2.10

getHeadersVisible

treeViewGetHeadersVisible

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m Bool

Returns: Whether the headers are visible or not.

Returns True if the headers on the treeView are visible.

getHoverExpand

treeViewGetHoverExpand

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if treeView is in hover expansion mode

Returns whether hover expansion mode is turned on for treeView.

Since: 2.6

getHoverSelection

treeViewGetHoverSelection

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if treeView is in hover selection mode

Returns whether hover selection mode is turned on for treeView.

Since: 2.6

getLevelIndentation

treeViewGetLevelIndentation

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView.

-> m Int32

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

Returns the amount, in pixels, of extra indentation for child levels in treeView.

Since: 2.12

getModel

treeViewGetModel

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m (Maybe TreeModel)

Returns: A TreeModel, or Nothing if none is currently being used.

Returns the model the TreeView is based on. Returns Nothing if the model is unset.

getNColumns

treeViewGetNColumns

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Word32

Returns: The number of columns in the treeView

Queries the number of columns in the given treeView.

Since: 3.4

getPathAtPos

treeViewGetPathAtPos

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Int32

x: The x position to be identified (relative to bin_window).

-> Int32

y: The y position to be identified (relative to bin_window).

-> m (Bool, Maybe TreePath, Maybe TreeViewColumn, Int32, Int32)

Returns: True if a row exists at that coordinate.

Finds the path at the point (x, y), relative to bin_window coordinates (please see treeViewGetBinWindow). That is, x and y are relative to an events coordinates. x and y must come from an event on the treeView only where event->window == gtk_tree_view_get_bin_window (). It is primarily for things like popup menus. If path is non-Nothing, then it will be filled with the TreePath at that point. This path should be freed with treePathFree. If column is non-Nothing, then it will be filled with the column at that point. cellX and cellY return the coordinates relative to the cell background (i.e. the backgroundArea passed to cellRendererRender). This function is only meaningful if treeView is realized. Therefore this function will always return False if treeView is not realized or does not have a model.

For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see treeViewConvertWidgetToBinWindowCoords.

getReorderable

treeViewGetReorderable

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if the tree can be reordered.

Retrieves whether the user can reorder the tree via drag-and-drop. See treeViewSetReorderable.

getRubberBanding

treeViewGetRubberBanding

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if rubber banding in treeView is enabled.

Returns whether rubber banding is turned on for treeView. 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

treeViewGetRulesHint

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if the hint is set

Deprecated: (Since version 3.14)

Gets the setting set by treeViewSetRulesHint.

getSearchColumn

treeViewGetSearchColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m Int32

Returns: the column the interactive search code searches in.

Gets the column searched on by the interactive search code.

getSearchEntry

treeViewGetSearchEntry

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m Entry

Returns: the entry currently in use as search entry.

Returns the Entry which is currently in use as interactive search entry for treeView. In case the built-in entry is being used, Nothing will be returned.

Since: 2.10

getSelection

treeViewGetSelection

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> m TreeSelection

Returns: A TreeSelection object.

Gets the TreeSelection associated with treeView.

getShowExpanders

treeViewGetShowExpanders

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView.

-> m Bool

Returns: True if expanders are drawn in treeView, False otherwise.

Returns whether or not expanders are drawn in treeView.

Since: 2.12

getTooltipColumn

treeViewGetTooltipColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Int32

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

Returns the column of treeView’s model which is being used for displaying tooltips on treeView’s rows.

Since: 2.12

getTooltipContext

treeViewGetTooltipContext

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

x: the x coordinate (relative to widget coordinates)

-> Int32

y: the y coordinate (relative to widget coordinates)

-> Bool

keyboardTip: whether this is a keyboard tooltip or not

-> m (Bool, Int32, Int32, Maybe TreeModel, TreePath, TreeIter)

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

This function is supposed to be used in a Widget::query-tooltip signal handler for TreeView. The x, y and keyboardTip 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 treeView’s bin_window if keyboardTooltip is False.

Since: 2.12

getVadjustment

treeViewGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m Adjustment

Returns: A Adjustment object, or Nothing if none is currently being used.

Deprecated: (Since version 3.0)Use scrollableGetVadjustment

Gets the Adjustment currently being used for the vertical aspect.

getVisibleRange

treeViewGetVisibleRange

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> m (Bool, TreePath, TreePath)

Returns: True, if valid paths were placed in startPath and endPath.

Sets startPath and endPath to be the first and last visible path. Note that there may be invisible paths in between.

The paths should be freed with treePathFree after use.

Since: 2.8

getVisibleRect

treeViewGetVisibleRect

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Rectangle

Fills visibleRect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with treeViewConvertTreeToBinWindowCoords. Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

insertColumn

treeViewInsertColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView.

-> b

column: The TreeViewColumn to be inserted.

-> Int32

position: The position to insert column in.

-> m Int32

Returns: The number of columns in treeView after insertion.

This inserts the column into the treeView at position. If position is -1, then the column is inserted at the end. If treeView has “fixed_height” mode enabled, then column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

insertColumnWithDataFunc

treeViewInsertColumnWithDataFunc

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsCellRenderer b)

=> a

treeView: a TreeView

-> Int32

position: Position to insert, -1 for append

-> Text

title: column title

-> b

cell: cell renderer for column

-> TreeCellDataFunc

func: function to set attributes of cell renderer

-> m Int32

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

Convenience function that inserts a new column into the TreeView with the given cell renderer and a TreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also treeViewColumnSetCellDataFunc, treeViewColumnPackStart. If treeView has “fixed_height” mode enabled, then the new column will have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

isBlankAtPos

treeViewIsBlankAtPos

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> Int32

x: The x position to be identified (relative to bin_window)

-> Int32

y: The y position to be identified (relative to bin_window)

-> m (Bool, TreePath, TreeViewColumn, Int32, Int32)

Returns: True if the area at the given coordinates is blank, False otherwise.

Determine whether the point (x, y) in treeView 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 treeView where event->window == gtk_tree_view_get_bin_window ().

For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see treeViewConvertWidgetToBinWindowCoords.

The path, column, cellX and cellY arguments will be filled in likewise as for treeViewGetPathAtPos. Please see treeViewGetPathAtPos for more information.

Since: 3.0

isRubberBandingActive

treeViewIsRubberBandingActive

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m Bool

Returns: True if a rubber banding operation is currently being done in treeView.

Returns whether a rubber banding operation is currently being done in treeView.

Since: 2.12

mapExpandedRows

treeViewMapExpandedRows

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> TreeViewMappingFunc

func: A function to be called

-> m ()

Calls func on all expanded rows.

moveColumnAfter

treeViewMoveColumnAfter

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b, IsTreeViewColumn c)

=> a

treeView: A TreeView

-> b

column: The TreeViewColumn to be moved.

-> Maybe c

baseColumn: The TreeViewColumn to be moved relative to, or Nothing.

-> m ()

Moves column to be after to baseColumn. If baseColumn is Nothing, then column is placed in the first position.

new

treeViewNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TreeView

Returns: A newly created TreeView widget.

Creates a new TreeView widget.

newWithModel

treeViewNewWithModel

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a)

=> a

model: the model.

-> m TreeView

Returns: A newly created TreeView widget.

Creates a new TreeView widget with the model initialized to model.

removeColumn

treeViewRemoveColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView.

-> b

column: The TreeViewColumn to remove.

-> m Int32

Returns: The number of columns in treeView after removing.

Removes column from treeView.

rowActivated

treeViewRowActivated

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView

-> TreePath

path: The TreePath to be activated.

-> b

column: The TreeViewColumn to be activated.

-> m ()

Activates the cell determined by path and column.

rowExpanded

treeViewRowExpanded

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> TreePath

path: A TreePath to test expansion state.

-> m Bool

Returns: True if path is expanded.

Returns True if the node pointed to by path is expanded in treeView.

scrollToCell

treeViewScrollToCell

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView.

-> Maybe TreePath

path: The path of the row to move to, or Nothing.

-> Maybe b

column: The TreeViewColumn to move horizontally to, or Nothing.

-> Bool

useAlign: whether to use alignment arguments, or False.

-> Float

rowAlign: The vertical alignment of the row specified by path.

-> Float

colAlign: The horizontal alignment of the column specified by column.

-> m ()

Moves the alignments of treeView to the position specified by column and path. If column is Nothing, then no horizontal scrolling occurs. Likewise, if path is Nothing no vertical scrolling occurs. At a minimum, one of column or path need to be non-Nothing. rowAlign determines where the row is placed, and colAlign 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 useAlign 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 treeView is realized, the centered path will be modified to reflect this change.

scrollToPoint

treeViewScrollToPoint

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

treeX: X coordinate of new top-left pixel of visible area, or -1

-> Int32

treeY: Y coordinate of new top-left pixel of visible area, or -1

-> m ()

Scrolls the tree view such that the top-left corner of the visible area is treeX, treeY, where treeX and treeY are specified in tree coordinates. The treeView must be realized before this function is called. If it isn't, you probably want to be using treeViewScrollToCell.

If either treeX or treeY are -1, then that direction isn’t scrolled.

setActivateOnSingleClick

treeViewSetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

single: True to emit row-activated on a single click

-> m ()

Cause the TreeView::row-activated signal to be emitted on a single click instead of a double click.

Since: 3.8

setColumnDragFunction

treeViewSetColumnDragFunction

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Maybe TreeViewColumnDropFunc

func: A function to determine which columns are reorderable, or Nothing.

-> m ()

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 treeView, the TreeViewColumn being dragged, the two TreeViewColumn s determining the drop spot, and userData. If either of the TreeViewColumn arguments for the drop spot are Nothing, then they indicate an edge. If func is set to be Nothing, then treeView reverts to the default behavior of allowing all columns to be dropped everywhere.

setCursor

treeViewSetCursor

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView

-> TreePath

path: A TreePath

-> Maybe b

focusColumn: A TreeViewColumn, or Nothing

-> Bool

startEditing: True if the specified cell should start being edited.

-> m ()

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 focusColumn is not Nothing, then focus is given to the column specified by it. Additionally, if focusColumn is specified, and startEditing is True, then editing should be started in the specified cell. This function is often followed by gtkWidgetGrabFocus (treeView) 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

treeViewSetCursorOnCell

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b, IsCellRenderer c)

=> a

treeView: A TreeView

-> TreePath

path: A TreePath

-> Maybe b

focusColumn: A TreeViewColumn, or Nothing

-> Maybe c

focusCell: A CellRenderer, or Nothing

-> Bool

startEditing: True if the specified cell should start being edited.

-> m ()

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 focusColumn is not Nothing, then focus is given to the column specified by it. If focusColumn and focusCell are not Nothing, and focusColumn contains 2 or more editable or activatable cells, then focus is given to the cell specified by focusCell. Additionally, if focusColumn is specified, and startEditing is True, then editing should be started in the specified cell. This function is often followed by gtkWidgetGrabFocus (treeView) 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

treeViewSetDestroyCountFunc

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> Maybe TreeDestroyCountFunc

func: Function to be called when a view row is destroyed, or Nothing

-> m ()

Deprecated: (Since version 3.4)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

treeViewSetDragDestRow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Maybe TreePath

path: The path of the row to highlight, or Nothing

-> TreeViewDropPosition

pos: Specifies whether to drop before, after or into the row

-> m ()

Sets the row that is highlighted for feedback. If path is Nothing, an existing highlight is removed.

setEnableSearch

treeViewSetEnableSearch

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> Bool

enableSearch: True, if the user can search interactively

-> m ()

If enableSearch 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

treeViewSetEnableTreeLines

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

enabled: True to enable tree line drawing, False otherwise.

-> m ()

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

Since: 2.10

setExpanderColumn

treeViewSetExpanderColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b)

=> a

treeView: A TreeView

-> b

column: Nothing, or the column to draw the expander arrow at.

-> m ()

Sets the column to draw the expander arrow at. It must be in treeView. If column is Nothing, 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

treeViewSetFixedHeightMode

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

enable: True to enable fixed height mode

-> m ()

Enables or disables the fixed height mode of treeView. Fixed height mode speeds up 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 TreeViewColumnSizingFixed.

Since: 2.6

setGridLines

treeViewSetGridLines

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> TreeViewGridLines

gridLines: a TreeViewGridLines value indicating which grid lines to enable.

-> m ()

Sets which grid lines to draw in treeView.

Since: 2.10

setHadjustment

treeViewSetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsAdjustment b)

=> a

treeView: A TreeView

-> Maybe b

adjustment: The Adjustment to set, or Nothing

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetHadjustment

Sets the Adjustment for the current horizontal aspect.

setHeadersClickable

treeViewSetHeadersClickable

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Bool

setting: True if the columns are clickable.

-> m ()

Allow the column title buttons to be clicked.

setHeadersVisible

treeViewSetHeadersVisible

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Bool

headersVisible: True if the headers are visible

-> m ()

Sets the visibility state of the headers.

setHoverExpand

treeViewSetHoverExpand

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

expand: True to enable hover selection mode

-> m ()

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

Since: 2.6

setHoverSelection

treeViewSetHoverSelection

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

hover: True to enable hover selection mode

-> m ()

Enables or disables the hover selection mode of treeView. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes SelectionModeSingle and SelectionModeBrowse.

Since: 2.6

setLevelIndentation

treeViewSetLevelIndentation

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

indentation: the amount, in pixels, of extra indentation in treeView.

-> m ()

Sets the amount of extra indentation for child levels to use in treeView 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

treeViewSetModel

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeModel b)

=> a

treeView: A TreeView.

-> Maybe b

model: The model.

-> m ()

Sets the model for a TreeView. If the treeView already has a model set, it will remove it before setting the new model. If model is Nothing, then it will unset the old model.

setReorderable

treeViewSetReorderable

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView.

-> Bool

reorderable: True, if the tree can be reordered.

-> m ()

This function is a convenience function to allow you to reorder models that support the TreeDragSourceIface and the TreeDragDestIface. Both TreeStore and 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 TreeModel::row-inserted and TreeModel::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

treeViewSetRowSeparatorFunc

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Maybe TreeViewRowSeparatorFunc

func: a TreeViewRowSeparatorFunc

-> m ()

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 Nothing, no separators are drawn. This is the default value.

Since: 2.6

setRubberBanding

treeViewSetRubberBanding

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

enable: True to enable rubber banding

-> m ()

Enables or disables rubber banding in treeView. 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

treeViewSetRulesHint

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

setting: True if the tree requires reading across rows

-> m ()

Deprecated: (Since version 3.14)

Sets a hint for the theme to draw even/odd rows in the treeView with different colors, also known as "zebra striping".

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

Do not use it just because you prefer the appearance of the ruled tree; that’s a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors useful from a functional standpoint (since it has lots of columns, generally).

setSearchColumn

treeViewSetSearchColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> Int32

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

-> m ()

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

treeViewSetSearchEntry

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsEntry b)

=> a

treeView: A TreeView

-> Maybe b

entry: the entry the interactive search code of treeView should use or Nothing

-> m ()

Sets the entry which the interactive search code will use for this treeView. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing Nothing for entry will make the interactive search code use the built-in popup entry again.

Since: 2.10

setSearchEqualFunc

treeViewSetSearchEqualFunc

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> TreeViewSearchEqualFunc

searchEqualFunc: the compare function to use during the search

-> m ()

Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality TreeViewSearchEqualFunc returns False on matches.

setSearchPositionFunc

treeViewSetSearchPositionFunc

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: A TreeView

-> Maybe TreeViewSearchPositionFunc

func: the function to use to position the search dialog, or Nothing to use the default search position function

-> m ()

Sets the function to use when positioning the search dialog.

Since: 2.10

setShowExpanders

treeViewSetShowExpanders

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Bool

enabled: True to enable expander drawing, False otherwise.

-> m ()

Sets whether to draw and enable expanders and indent child rows in treeView. 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 treeViewSetLevelIndentation. This does not have any visible effects for lists.

Since: 2.12

setTooltipCell

treeViewSetTooltipCell

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTooltip b, IsTreeViewColumn c, IsCellRenderer d)

=> a

treeView: a TreeView

-> b

tooltip: a Tooltip

-> Maybe TreePath

path: a TreePath or Nothing

-> Maybe c

column: a TreeViewColumn or Nothing

-> Maybe d

cell: a CellRenderer or Nothing

-> m ()

Sets the tip area of tooltip to the area path, column and cell have in common. For example if path is Nothing and column is set, the tip area will be set to the full area covered by column. See also tooltipSetTipArea.

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 treeViewSetTooltipColumn for a simpler alternative.

Since: 2.12

setTooltipColumn

treeViewSetTooltipColumn

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> Int32

column: an integer, which is a valid column number for treeView’s model

-> m ()

If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have TreeView handle these automatically for you. column should be set to the column in treeView’s model containing the tooltip texts, or -1 to disable this feature.

When enabled, Widget:has-tooltip will be set to True and treeView will connect a Widget::query-tooltip signal handler.

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

Since: 2.12

setTooltipRow

treeViewSetTooltipRow

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTooltip b)

=> a

treeView: a TreeView

-> b

tooltip: a Tooltip

-> TreePath

path: a TreePath

-> m ()

Sets the tip area of tooltip to be the area covered by the row at path. See also treeViewSetTooltipColumn for a simpler alternative. See also tooltipSetTipArea.

Since: 2.12

setVadjustment

treeViewSetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsAdjustment b)

=> a

treeView: A TreeView

-> Maybe b

adjustment: The Adjustment to set, or Nothing

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetVadjustment

Sets the Adjustment for the current vertical aspect.

unsetRowsDragDest

treeViewUnsetRowsDragDest

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m ()

Undoes the effect of treeViewEnableModelDragDest. Calling this method sets TreeView:reorderable to False.

unsetRowsDragSource

treeViewUnsetRowsDragSource

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a)

=> a

treeView: a TreeView

-> m ()

Undoes the effect of treeViewEnableModelDragSource. Calling this method sets TreeView:reorderable to False.

Properties

activateOnSingleClick

constructTreeViewActivateOnSingleClick :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewActivateOnSingleClick :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewActivateOnSingleClick :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

enableGridLines

constructTreeViewEnableGridLines :: IsTreeView o => TreeViewGridLines -> IO (GValueConstruct o)

getTreeViewEnableGridLines :: (MonadIO m, IsTreeView o) => o -> m TreeViewGridLines

setTreeViewEnableGridLines :: (MonadIO m, IsTreeView o) => o -> TreeViewGridLines -> m ()

enableSearch

constructTreeViewEnableSearch :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewEnableSearch :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewEnableSearch :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

enableTreeLines

constructTreeViewEnableTreeLines :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewEnableTreeLines :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewEnableTreeLines :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

expanderColumn

constructTreeViewExpanderColumn :: (IsTreeView o, IsTreeViewColumn a) => a -> IO (GValueConstruct o)

getTreeViewExpanderColumn :: (MonadIO m, IsTreeView o) => o -> m TreeViewColumn

setTreeViewExpanderColumn :: (MonadIO m, IsTreeView o, IsTreeViewColumn a) => o -> a -> m ()

fixedHeightMode

constructTreeViewFixedHeightMode :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

headersClickable

constructTreeViewHeadersClickable :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewHeadersClickable :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewHeadersClickable :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

headersVisible

constructTreeViewHeadersVisible :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewHeadersVisible :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewHeadersVisible :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

hoverExpand

constructTreeViewHoverExpand :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewHoverExpand :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewHoverExpand :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

hoverSelection

constructTreeViewHoverSelection :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewHoverSelection :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewHoverSelection :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

levelIndentation

constructTreeViewLevelIndentation :: IsTreeView o => Int32 -> IO (GValueConstruct o)

getTreeViewLevelIndentation :: (MonadIO m, IsTreeView o) => o -> m Int32

setTreeViewLevelIndentation :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()

model

clearTreeViewModel :: (MonadIO m, IsTreeView o) => o -> m ()

constructTreeViewModel :: (IsTreeView o, IsTreeModel a) => a -> IO (GValueConstruct o)

getTreeViewModel :: (MonadIO m, IsTreeView o) => o -> m (Maybe TreeModel)

setTreeViewModel :: (MonadIO m, IsTreeView o, IsTreeModel a) => o -> a -> m ()

reorderable

constructTreeViewReorderable :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewReorderable :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewReorderable :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

rubberBanding

constructTreeViewRubberBanding :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewRubberBanding :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewRubberBanding :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

rulesHint

constructTreeViewRulesHint :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewRulesHint :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewRulesHint :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

searchColumn

constructTreeViewSearchColumn :: IsTreeView o => Int32 -> IO (GValueConstruct o)

getTreeViewSearchColumn :: (MonadIO m, IsTreeView o) => o -> m Int32

setTreeViewSearchColumn :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()

showExpanders

constructTreeViewShowExpanders :: IsTreeView o => Bool -> IO (GValueConstruct o)

getTreeViewShowExpanders :: (MonadIO m, IsTreeView o) => o -> m Bool

setTreeViewShowExpanders :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()

tooltipColumn

constructTreeViewTooltipColumn :: IsTreeView o => Int32 -> IO (GValueConstruct o)

getTreeViewTooltipColumn :: (MonadIO m, IsTreeView o) => o -> m Int32

setTreeViewTooltipColumn :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()

Signals

columnsChanged

type C_TreeViewColumnsChangedCallback = Ptr () -> Ptr () -> IO ()

type TreeViewColumnsChangedCallback = IO ()

afterTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> TreeViewColumnsChangedCallback -> m SignalHandlerId

genClosure_TreeViewColumnsChanged :: TreeViewColumnsChangedCallback -> IO Closure

mk_TreeViewColumnsChangedCallback :: C_TreeViewColumnsChangedCallback -> IO (FunPtr C_TreeViewColumnsChangedCallback)

noTreeViewColumnsChangedCallback :: Maybe TreeViewColumnsChangedCallback

onTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> TreeViewColumnsChangedCallback -> m SignalHandlerId

wrap_TreeViewColumnsChangedCallback :: TreeViewColumnsChangedCallback -> Ptr () -> Ptr () -> IO ()

cursorChanged

type C_TreeViewCursorChangedCallback = Ptr () -> Ptr () -> IO ()

type TreeViewCursorChangedCallback = IO ()

afterTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> TreeViewCursorChangedCallback -> m SignalHandlerId

genClosure_TreeViewCursorChanged :: TreeViewCursorChangedCallback -> IO Closure

mk_TreeViewCursorChangedCallback :: C_TreeViewCursorChangedCallback -> IO (FunPtr C_TreeViewCursorChangedCallback)

noTreeViewCursorChangedCallback :: Maybe TreeViewCursorChangedCallback

onTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> TreeViewCursorChangedCallback -> m SignalHandlerId

wrap_TreeViewCursorChangedCallback :: TreeViewCursorChangedCallback -> Ptr () -> Ptr () -> IO ()

expandCollapseCursorRow

type C_TreeViewExpandCollapseCursorRowCallback = Ptr () -> CInt -> CInt -> CInt -> Ptr () -> IO CInt

type TreeViewExpandCollapseCursorRowCallback = Bool -> Bool -> Bool -> IO Bool

afterTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewExpandCollapseCursorRowCallback -> m SignalHandlerId

genClosure_TreeViewExpandCollapseCursorRow :: TreeViewExpandCollapseCursorRowCallback -> IO Closure

mk_TreeViewExpandCollapseCursorRowCallback :: C_TreeViewExpandCollapseCursorRowCallback -> IO (FunPtr C_TreeViewExpandCollapseCursorRowCallback)

noTreeViewExpandCollapseCursorRowCallback :: Maybe TreeViewExpandCollapseCursorRowCallback

onTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewExpandCollapseCursorRowCallback -> m SignalHandlerId

wrap_TreeViewExpandCollapseCursorRowCallback :: TreeViewExpandCollapseCursorRowCallback -> Ptr () -> CInt -> CInt -> CInt -> Ptr () -> IO CInt

moveCursor

type C_TreeViewMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO CInt

type TreeViewMoveCursorCallback = MovementStep -> Int32 -> IO Bool

afterTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> TreeViewMoveCursorCallback -> m SignalHandlerId

genClosure_TreeViewMoveCursor :: TreeViewMoveCursorCallback -> IO Closure

mk_TreeViewMoveCursorCallback :: C_TreeViewMoveCursorCallback -> IO (FunPtr C_TreeViewMoveCursorCallback)

noTreeViewMoveCursorCallback :: Maybe TreeViewMoveCursorCallback

onTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> TreeViewMoveCursorCallback -> m SignalHandlerId

wrap_TreeViewMoveCursorCallback :: TreeViewMoveCursorCallback -> Ptr () -> CUInt -> Int32 -> Ptr () -> IO CInt

rowActivated

type C_TreeViewRowActivatedCallback = Ptr () -> Ptr TreePath -> Ptr TreeViewColumn -> Ptr () -> IO ()

type TreeViewRowActivatedCallback = TreePath -> TreeViewColumn -> IO ()

afterTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> TreeViewRowActivatedCallback -> m SignalHandlerId

genClosure_TreeViewRowActivated :: TreeViewRowActivatedCallback -> IO Closure

mk_TreeViewRowActivatedCallback :: C_TreeViewRowActivatedCallback -> IO (FunPtr C_TreeViewRowActivatedCallback)

noTreeViewRowActivatedCallback :: Maybe TreeViewRowActivatedCallback

onTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> TreeViewRowActivatedCallback -> m SignalHandlerId

wrap_TreeViewRowActivatedCallback :: TreeViewRowActivatedCallback -> Ptr () -> Ptr TreePath -> Ptr TreeViewColumn -> Ptr () -> IO ()

rowCollapsed

type C_TreeViewRowCollapsedCallback = Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO ()

type TreeViewRowCollapsedCallback = TreeIter -> TreePath -> IO ()

afterTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> TreeViewRowCollapsedCallback -> m SignalHandlerId

genClosure_TreeViewRowCollapsed :: TreeViewRowCollapsedCallback -> IO Closure

mk_TreeViewRowCollapsedCallback :: C_TreeViewRowCollapsedCallback -> IO (FunPtr C_TreeViewRowCollapsedCallback)

noTreeViewRowCollapsedCallback :: Maybe TreeViewRowCollapsedCallback

onTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> TreeViewRowCollapsedCallback -> m SignalHandlerId

wrap_TreeViewRowCollapsedCallback :: TreeViewRowCollapsedCallback -> Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO ()

rowExpanded

type C_TreeViewRowExpandedCallback = Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO ()

type TreeViewRowExpandedCallback = TreeIter -> TreePath -> IO ()

afterTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> TreeViewRowExpandedCallback -> m SignalHandlerId

genClosure_TreeViewRowExpanded :: TreeViewRowExpandedCallback -> IO Closure

mk_TreeViewRowExpandedCallback :: C_TreeViewRowExpandedCallback -> IO (FunPtr C_TreeViewRowExpandedCallback)

noTreeViewRowExpandedCallback :: Maybe TreeViewRowExpandedCallback

onTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> TreeViewRowExpandedCallback -> m SignalHandlerId

wrap_TreeViewRowExpandedCallback :: TreeViewRowExpandedCallback -> Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO ()

selectAll

type C_TreeViewSelectAllCallback = Ptr () -> Ptr () -> IO CInt

type TreeViewSelectAllCallback = IO Bool

afterTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectAllCallback -> m SignalHandlerId

genClosure_TreeViewSelectAll :: TreeViewSelectAllCallback -> IO Closure

mk_TreeViewSelectAllCallback :: C_TreeViewSelectAllCallback -> IO (FunPtr C_TreeViewSelectAllCallback)

noTreeViewSelectAllCallback :: Maybe TreeViewSelectAllCallback

onTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectAllCallback -> m SignalHandlerId

wrap_TreeViewSelectAllCallback :: TreeViewSelectAllCallback -> Ptr () -> Ptr () -> IO CInt

selectCursorParent

type C_TreeViewSelectCursorParentCallback = Ptr () -> Ptr () -> IO CInt

type TreeViewSelectCursorParentCallback = IO Bool

afterTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectCursorParentCallback -> m SignalHandlerId

genClosure_TreeViewSelectCursorParent :: TreeViewSelectCursorParentCallback -> IO Closure

mk_TreeViewSelectCursorParentCallback :: C_TreeViewSelectCursorParentCallback -> IO (FunPtr C_TreeViewSelectCursorParentCallback)

noTreeViewSelectCursorParentCallback :: Maybe TreeViewSelectCursorParentCallback

onTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectCursorParentCallback -> m SignalHandlerId

wrap_TreeViewSelectCursorParentCallback :: TreeViewSelectCursorParentCallback -> Ptr () -> Ptr () -> IO CInt

selectCursorRow

type C_TreeViewSelectCursorRowCallback = Ptr () -> CInt -> Ptr () -> IO CInt

type TreeViewSelectCursorRowCallback = Bool -> IO Bool

afterTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectCursorRowCallback -> m SignalHandlerId

genClosure_TreeViewSelectCursorRow :: TreeViewSelectCursorRowCallback -> IO Closure

mk_TreeViewSelectCursorRowCallback :: C_TreeViewSelectCursorRowCallback -> IO (FunPtr C_TreeViewSelectCursorRowCallback)

noTreeViewSelectCursorRowCallback :: Maybe TreeViewSelectCursorRowCallback

onTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewSelectCursorRowCallback -> m SignalHandlerId

wrap_TreeViewSelectCursorRowCallback :: TreeViewSelectCursorRowCallback -> Ptr () -> CInt -> Ptr () -> IO CInt

startInteractiveSearch

type C_TreeViewStartInteractiveSearchCallback = Ptr () -> Ptr () -> IO CInt

type TreeViewStartInteractiveSearchCallback = IO Bool

afterTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> TreeViewStartInteractiveSearchCallback -> m SignalHandlerId

genClosure_TreeViewStartInteractiveSearch :: TreeViewStartInteractiveSearchCallback -> IO Closure

mk_TreeViewStartInteractiveSearchCallback :: C_TreeViewStartInteractiveSearchCallback -> IO (FunPtr C_TreeViewStartInteractiveSearchCallback)

noTreeViewStartInteractiveSearchCallback :: Maybe TreeViewStartInteractiveSearchCallback

onTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> TreeViewStartInteractiveSearchCallback -> m SignalHandlerId

wrap_TreeViewStartInteractiveSearchCallback :: TreeViewStartInteractiveSearchCallback -> Ptr () -> Ptr () -> IO CInt

testCollapseRow

type C_TreeViewTestCollapseRowCallback = Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO CInt

type TreeViewTestCollapseRowCallback = TreeIter -> TreePath -> IO Bool

afterTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> TreeViewTestCollapseRowCallback -> m SignalHandlerId

genClosure_TreeViewTestCollapseRow :: TreeViewTestCollapseRowCallback -> IO Closure

mk_TreeViewTestCollapseRowCallback :: C_TreeViewTestCollapseRowCallback -> IO (FunPtr C_TreeViewTestCollapseRowCallback)

noTreeViewTestCollapseRowCallback :: Maybe TreeViewTestCollapseRowCallback

onTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> TreeViewTestCollapseRowCallback -> m SignalHandlerId

wrap_TreeViewTestCollapseRowCallback :: TreeViewTestCollapseRowCallback -> Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO CInt

testExpandRow

type C_TreeViewTestExpandRowCallback = Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO CInt

type TreeViewTestExpandRowCallback = TreeIter -> TreePath -> IO Bool

afterTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> TreeViewTestExpandRowCallback -> m SignalHandlerId

genClosure_TreeViewTestExpandRow :: TreeViewTestExpandRowCallback -> IO Closure

mk_TreeViewTestExpandRowCallback :: C_TreeViewTestExpandRowCallback -> IO (FunPtr C_TreeViewTestExpandRowCallback)

noTreeViewTestExpandRowCallback :: Maybe TreeViewTestExpandRowCallback

onTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> TreeViewTestExpandRowCallback -> m SignalHandlerId

wrap_TreeViewTestExpandRowCallback :: TreeViewTestExpandRowCallback -> Ptr () -> Ptr TreeIter -> Ptr TreePath -> Ptr () -> IO CInt

toggleCursorRow

type C_TreeViewToggleCursorRowCallback = Ptr () -> Ptr () -> IO CInt

type TreeViewToggleCursorRowCallback = IO Bool

afterTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewToggleCursorRowCallback -> m SignalHandlerId

genClosure_TreeViewToggleCursorRow :: TreeViewToggleCursorRowCallback -> IO Closure

mk_TreeViewToggleCursorRowCallback :: C_TreeViewToggleCursorRowCallback -> IO (FunPtr C_TreeViewToggleCursorRowCallback)

noTreeViewToggleCursorRowCallback :: Maybe TreeViewToggleCursorRowCallback

onTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> TreeViewToggleCursorRowCallback -> m SignalHandlerId

wrap_TreeViewToggleCursorRowCallback :: TreeViewToggleCursorRowCallback -> Ptr () -> Ptr () -> IO CInt

unselectAll

type C_TreeViewUnselectAllCallback = Ptr () -> Ptr () -> IO CInt

type TreeViewUnselectAllCallback = IO Bool

afterTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> TreeViewUnselectAllCallback -> m SignalHandlerId

genClosure_TreeViewUnselectAll :: TreeViewUnselectAllCallback -> IO Closure

mk_TreeViewUnselectAllCallback :: C_TreeViewUnselectAllCallback -> IO (FunPtr C_TreeViewUnselectAllCallback)

noTreeViewUnselectAllCallback :: Maybe TreeViewUnselectAllCallback

onTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> TreeViewUnselectAllCallback -> m SignalHandlerId

wrap_TreeViewUnselectAllCallback :: TreeViewUnselectAllCallback -> Ptr () -> Ptr () -> IO CInt