gi-gtk3-3.0.44: Gtk 3.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.TreeView

Contents

- Exported types
- Methods
  - appendColumn
  - collapseAll
  - collapseRow
  - columnsAutosize
  - convertBinWindowToTreeCoords
  - convertBinWindowToWidgetCoords
  - convertTreeToBinWindowCoords
  - convertTreeToWidgetCoords
  - convertWidgetToBinWindowCoords
  - convertWidgetToTreeCoords
  - createRowDragIcon
  - enableModelDragDest
  - enableModelDragSource
  - expandAll
  - expandRow
  - expandToPath
  - getActivateOnSingleClick
  - getBackgroundArea
  - getBinWindow
  - getCellArea
  - getColumn
  - getColumns
  - getCursor
  - getDestRowAtPos
  - getDragDestRow
  - getEnableSearch
  - getEnableTreeLines
  - getExpanderColumn
  - getFixedHeightMode
  - getGridLines
  - getHadjustment
  - getHeadersClickable
  - getHeadersVisible
  - getHoverExpand
  - getHoverSelection
  - getLevelIndentation
  - getModel
  - getNColumns
  - getPathAtPos
  - getReorderable
  - getRubberBanding
  - getRulesHint
  - getSearchColumn
  - getSearchEntry
  - getSelection
  - getShowExpanders
  - getTooltipColumn
  - getTooltipContext
  - getVadjustment
  - getVisibleRange
  - getVisibleRect
  - insertColumn
  - insertColumnWithDataFunc
  - isBlankAtPos
  - isRubberBandingActive
  - mapExpandedRows
  - moveColumnAfter
  - new
  - newWithModel
  - removeColumn
  - rowActivated
  - rowExpanded
  - scrollToCell
  - scrollToPoint
  - setActivateOnSingleClick
  - setColumnDragFunction
  - setCursor
  - setCursorOnCell
  - setDestroyCountFunc
  - setDragDestRow
  - setEnableSearch
  - setEnableTreeLines
  - setExpanderColumn
  - setFixedHeightMode
  - setGridLines
  - setHadjustment
  - setHeadersClickable
  - setHeadersVisible
  - setHoverExpand
  - setHoverSelection
  - setLevelIndentation
  - setModel
  - setReorderable
  - setRowSeparatorFunc
  - setRubberBanding
  - setRulesHint
  - setSearchColumn
  - setSearchEntry
  - setSearchEqualFunc
  - setSearchPositionFunc
  - setShowExpanders
  - setTooltipCell
  - setTooltipColumn
  - setTooltipRow
  - setVadjustment
  - unsetRowsDragDest
  - unsetRowsDragSource
- Properties
  - activateOnSingleClick
  - enableGridLines
  - enableSearch
  - enableTreeLines
  - expanderColumn
  - fixedHeightMode
  - headersClickable
  - headersVisible
  - hoverExpand
  - hoverSelection
  - levelIndentation
  - model
  - reorderable
  - rubberBanding
  - rulesHint
  - searchColumn
  - showExpanders
  - tooltipColumn
  - ubuntuAlmostFixedHeightMode
- Signals
  - columnsChanged
  - cursorChanged
  - expandCollapseCursorRow
  - moveCursor
  - rowActivated
  - rowCollapsed
  - rowExpanded
  - selectAll
  - selectCursorParent
  - selectCursorRow
  - startInteractiveSearch
  - testCollapseRow
  - testExpandRow
  - toggleCursorRow
  - unselectAll

Description

Widget that displays any object that implements the `TreeModel` interface.

Please refer to the tree widget conceptual overview for an overview of all the objects and data types related to the tree widget and how they work together.

Several different coordinate systems are exposed in the GtkTreeView API. These are:

Coordinate systems in GtkTreeView API:

- Widget coordinates: Coordinates relative to the widget (usually `widget->window`).
- Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.
- Tree coordinates: Coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree.

Several functions are available for converting between the different coordinate systems. The most common translations are between widget and bin window coordinates and between bin window and tree coordinates. For the former you can use `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:

### xml code

    <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

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

Synopsis

- newtype TreeView = TreeView (ManagedPtr TreeView)
- class (GObject o, IsDescendantOf TreeView o) => IsTreeView o
- toTreeView :: (MonadIO m, IsTreeView o) => o -> m TreeView
- treeViewAppendColumn :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> b -> m Int32
- treeViewCollapseAll :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m ()
- treeViewCollapseRow :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreePath -> m Bool
- treeViewColumnsAutosize :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m ()
- treeViewConvertBinWindowToTreeCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewConvertBinWindowToWidgetCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewConvertTreeToBinWindowCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewConvertTreeToWidgetCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewConvertWidgetToBinWindowCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewConvertWidgetToTreeCoords :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Int32, Int32)
- treeViewCreateRowDragIcon :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreePath -> m Surface
- treeViewEnableModelDragDest :: (HasCallStack, MonadIO m, IsTreeView a) => a -> [TargetEntry] -> [DragAction] -> m ()
- treeViewEnableModelDragSource :: (HasCallStack, MonadIO m, IsTreeView a) => a -> [ModifierType] -> [TargetEntry] -> [DragAction] -> m ()
- treeViewExpandAll :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m ()
- treeViewExpandRow :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreePath -> Bool -> m Bool
- treeViewExpandToPath :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreePath -> m ()
- treeViewGetActivateOnSingleClick :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetBackgroundArea :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> Maybe TreePath -> Maybe b -> m Rectangle
- treeViewGetBinWindow :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m (Maybe Window)
- treeViewGetCellArea :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> Maybe TreePath -> Maybe b -> m Rectangle
- treeViewGetColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> m (Maybe TreeViewColumn)
- treeViewGetColumns :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m [TreeViewColumn]
- treeViewGetCursor :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m (Maybe TreePath, Maybe TreeViewColumn)
- treeViewGetDestRowAtPos :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Bool, Maybe TreePath, TreeViewDropPosition)
- treeViewGetDragDestRow :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m (Maybe TreePath, TreeViewDropPosition)
- treeViewGetEnableSearch :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetEnableTreeLines :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetExpanderColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m TreeViewColumn
- treeViewGetFixedHeightMode :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetGridLines :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m TreeViewGridLines
- treeViewGetHadjustment :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Adjustment
- treeViewGetHeadersClickable :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetHeadersVisible :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetHoverExpand :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetHoverSelection :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetLevelIndentation :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Int32
- treeViewGetModel :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m (Maybe TreeModel)
- treeViewGetNColumns :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Word32
- treeViewGetPathAtPos :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Bool, Maybe TreePath, Maybe TreeViewColumn, Int32, Int32)
- treeViewGetReorderable :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetRubberBanding :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetRulesHint :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetSearchColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Int32
- treeViewGetSearchEntry :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Entry
- treeViewGetSelection :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m TreeSelection
- treeViewGetShowExpanders :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewGetTooltipColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Int32
- treeViewGetTooltipContext :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> Bool -> m (Bool, Int32, Int32, Maybe TreeModel, TreePath, TreeIter)
- treeViewGetVadjustment :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Adjustment
- treeViewGetVisibleRange :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m (Bool, TreePath, TreePath)
- treeViewGetVisibleRect :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Rectangle
- treeViewInsertColumn :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> b -> Int32 -> m Int32
- treeViewInsertColumnWithDataFunc :: (HasCallStack, MonadIO m, IsTreeView a, IsCellRenderer b) => a -> Int32 -> Text -> b -> TreeCellDataFunc -> m Int32
- treeViewIsBlankAtPos :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m (Bool, Maybe TreePath, Maybe TreeViewColumn, Int32, Int32)
- treeViewIsRubberBandingActive :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m Bool
- treeViewMapExpandedRows :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreeViewMappingFunc -> m ()
- treeViewMoveColumnAfter :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b, IsTreeViewColumn c) => a -> b -> Maybe c -> m ()
- treeViewNew :: (HasCallStack, MonadIO m) => m TreeView
- treeViewNewWithModel :: (HasCallStack, MonadIO m, IsTreeModel a) => a -> m TreeView
- treeViewRemoveColumn :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> b -> m Int32
- treeViewRowActivated :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> TreePath -> b -> m ()
- treeViewRowExpanded :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreePath -> m Bool
- treeViewScrollToCell :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> Maybe TreePath -> Maybe b -> Bool -> Float -> Float -> m ()
- treeViewScrollToPoint :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> Int32 -> m ()
- treeViewSetActivateOnSingleClick :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetColumnDragFunction :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Maybe TreeViewColumnDropFunc -> m ()
- treeViewSetCursor :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> TreePath -> Maybe b -> Bool -> m ()
- treeViewSetCursorOnCell :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b, IsCellRenderer c) => a -> TreePath -> Maybe b -> Maybe c -> Bool -> m ()
- treeViewSetDestroyCountFunc :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Maybe TreeDestroyCountFunc -> m ()
- treeViewSetDragDestRow :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Maybe TreePath -> TreeViewDropPosition -> m ()
- treeViewSetEnableSearch :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetEnableTreeLines :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetExpanderColumn :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) => a -> Maybe b -> m ()
- treeViewSetFixedHeightMode :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetGridLines :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreeViewGridLines -> m ()
- treeViewSetHadjustment :: (HasCallStack, MonadIO m, IsTreeView a, IsAdjustment b) => a -> Maybe b -> m ()
- treeViewSetHeadersClickable :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetHeadersVisible :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetHoverExpand :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetHoverSelection :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetLevelIndentation :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> m ()
- treeViewSetModel :: (HasCallStack, MonadIO m, IsTreeView a, IsTreeModel b) => a -> Maybe b -> m ()
- treeViewSetReorderable :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetRowSeparatorFunc :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Maybe TreeViewRowSeparatorFunc -> m ()
- treeViewSetRubberBanding :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetRulesHint :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetSearchColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> m ()
- treeViewSetSearchEntry :: (HasCallStack, MonadIO m, IsTreeView a, IsEntry b) => a -> Maybe b -> m ()
- treeViewSetSearchEqualFunc :: (HasCallStack, MonadIO m, IsTreeView a) => a -> TreeViewSearchEqualFunc -> m ()
- treeViewSetSearchPositionFunc :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Maybe TreeViewSearchPositionFunc -> m ()
- treeViewSetShowExpanders :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Bool -> m ()
- treeViewSetTooltipCell :: (HasCallStack, MonadIO m, IsTreeView a, IsTooltip b, IsTreeViewColumn c, IsCellRenderer d) => a -> b -> Maybe TreePath -> Maybe c -> Maybe d -> m ()
- treeViewSetTooltipColumn :: (HasCallStack, MonadIO m, IsTreeView a) => a -> Int32 -> m ()
- treeViewSetTooltipRow :: (HasCallStack, MonadIO m, IsTreeView a, IsTooltip b) => a -> b -> TreePath -> m ()
- treeViewSetVadjustment :: (HasCallStack, MonadIO m, IsTreeView a, IsAdjustment b) => a -> Maybe b -> m ()
- treeViewUnsetRowsDragDest :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m ()
- treeViewUnsetRowsDragSource :: (HasCallStack, MonadIO m, IsTreeView a) => a -> m ()
- constructTreeViewActivateOnSingleClick :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewActivateOnSingleClick :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewActivateOnSingleClick :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewEnableGridLines :: (IsTreeView o, MonadIO m) => TreeViewGridLines -> m (GValueConstruct o)
- getTreeViewEnableGridLines :: (MonadIO m, IsTreeView o) => o -> m TreeViewGridLines
- setTreeViewEnableGridLines :: (MonadIO m, IsTreeView o) => o -> TreeViewGridLines -> m ()
- constructTreeViewEnableSearch :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewEnableSearch :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewEnableSearch :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewEnableTreeLines :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewEnableTreeLines :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewEnableTreeLines :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- clearTreeViewExpanderColumn :: (MonadIO m, IsTreeView o) => o -> m ()
- constructTreeViewExpanderColumn :: (IsTreeView o, MonadIO m, IsTreeViewColumn a) => a -> m (GValueConstruct o)
- getTreeViewExpanderColumn :: (MonadIO m, IsTreeView o) => o -> m TreeViewColumn
- setTreeViewExpanderColumn :: (MonadIO m, IsTreeView o, IsTreeViewColumn a) => o -> a -> m ()
- constructTreeViewFixedHeightMode :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewHeadersClickable :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewHeadersClickable :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewHeadersClickable :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewHeadersVisible :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewHeadersVisible :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewHeadersVisible :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewHoverExpand :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewHoverExpand :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewHoverExpand :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewHoverSelection :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewHoverSelection :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewHoverSelection :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewLevelIndentation :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getTreeViewLevelIndentation :: (MonadIO m, IsTreeView o) => o -> m Int32
- setTreeViewLevelIndentation :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()
- clearTreeViewModel :: (MonadIO m, IsTreeView o) => o -> m ()
- constructTreeViewModel :: (IsTreeView o, MonadIO m, IsTreeModel a) => a -> m (GValueConstruct o)
- getTreeViewModel :: (MonadIO m, IsTreeView o) => o -> m (Maybe TreeModel)
- setTreeViewModel :: (MonadIO m, IsTreeView o, IsTreeModel a) => o -> a -> m ()
- constructTreeViewReorderable :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewReorderable :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewReorderable :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewRubberBanding :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewRubberBanding :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewRubberBanding :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewRulesHint :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewRulesHint :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewRulesHint :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewSearchColumn :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getTreeViewSearchColumn :: (MonadIO m, IsTreeView o) => o -> m Int32
- setTreeViewSearchColumn :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()
- constructTreeViewShowExpanders :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTreeViewShowExpanders :: (MonadIO m, IsTreeView o) => o -> m Bool
- setTreeViewShowExpanders :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- constructTreeViewTooltipColumn :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getTreeViewTooltipColumn :: (MonadIO m, IsTreeView o) => o -> m Int32
- setTreeViewTooltipColumn :: (MonadIO m, IsTreeView o) => o -> Int32 -> m ()
- constructTreeViewUbuntuAlmostFixedHeightMode :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o)
- setTreeViewUbuntuAlmostFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> Bool -> m ()
- type TreeViewColumnsChangedCallback = IO ()
- afterTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewColumnsChangedCallback) -> m SignalHandlerId
- onTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewColumnsChangedCallback) -> m SignalHandlerId
- type TreeViewCursorChangedCallback = IO ()
- afterTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewCursorChangedCallback) -> m SignalHandlerId
- onTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewCursorChangedCallback) -> m SignalHandlerId
- type TreeViewExpandCollapseCursorRowCallback = Bool -> Bool -> Bool -> IO Bool
- afterTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewExpandCollapseCursorRowCallback) -> m SignalHandlerId
- onTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewExpandCollapseCursorRowCallback) -> m SignalHandlerId
- type TreeViewMoveCursorCallback = MovementStep -> Int32 -> IO Bool
- afterTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewMoveCursorCallback) -> m SignalHandlerId
- onTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewMoveCursorCallback) -> m SignalHandlerId
- type TreeViewRowActivatedCallback = TreePath -> TreeViewColumn -> IO ()
- afterTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowActivatedCallback) -> m SignalHandlerId
- onTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowActivatedCallback) -> m SignalHandlerId
- type TreeViewRowCollapsedCallback = TreeIter -> TreePath -> IO ()
- afterTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowCollapsedCallback) -> m SignalHandlerId
- onTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowCollapsedCallback) -> m SignalHandlerId
- type TreeViewRowExpandedCallback = TreeIter -> TreePath -> IO ()
- afterTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowExpandedCallback) -> m SignalHandlerId
- onTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowExpandedCallback) -> m SignalHandlerId
- type TreeViewSelectAllCallback = IO Bool
- afterTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectAllCallback) -> m SignalHandlerId
- onTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectAllCallback) -> m SignalHandlerId
- type TreeViewSelectCursorParentCallback = IO Bool
- afterTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorParentCallback) -> m SignalHandlerId
- onTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorParentCallback) -> m SignalHandlerId
- type TreeViewSelectCursorRowCallback = Bool -> IO Bool
- afterTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorRowCallback) -> m SignalHandlerId
- onTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorRowCallback) -> m SignalHandlerId
- type TreeViewStartInteractiveSearchCallback = IO Bool
- afterTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewStartInteractiveSearchCallback) -> m SignalHandlerId
- onTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewStartInteractiveSearchCallback) -> m SignalHandlerId
- type TreeViewTestCollapseRowCallback = TreeIter -> TreePath -> IO Bool
- afterTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestCollapseRowCallback) -> m SignalHandlerId
- onTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestCollapseRowCallback) -> m SignalHandlerId
- type TreeViewTestExpandRowCallback = TreeIter -> TreePath -> IO Bool
- afterTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestExpandRowCallback) -> m SignalHandlerId
- onTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestExpandRowCallback) -> m SignalHandlerId
- type TreeViewToggleCursorRowCallback = IO Bool
- afterTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewToggleCursorRowCallback) -> m SignalHandlerId
- onTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewToggleCursorRowCallback) -> m SignalHandlerId
- type TreeViewUnselectAllCallback = IO Bool
- afterTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewUnselectAllCallback) -> m SignalHandlerId
- onTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewUnselectAllCallback) -> m SignalHandlerId

# Exported types

newtype TreeView Source #

Memory-managed wrapper type.

Constructors

TreeView (ManagedPtr TreeView) |

#### Instances

Instances details

Eq TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView Methods (==) :: TreeView -> TreeView -> Bool Source # (/=) :: TreeView -> TreeView -> Bool Source #
GObject TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView
ManagedPtrNewtype TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView Methods toManagedPtr :: TreeView -> ManagedPtr TreeView Source #
TypedObject TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView Methods glibType :: IO GType Source #
HasParentTypes TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView
IsGValue (Maybe TreeView) Source # | Convert `TreeView` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.TreeView Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe TreeView -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe TreeView) Source #
type ParentTypes TreeView Source # |
Instance details Defined in GI.Gtk.Objects.TreeView type ParentTypes TreeView = '[Container, Widget, Object, ImplementorIface, Buildable, Scrollable]

class (GObject o, IsDescendantOf TreeView o) => IsTreeView o Source #

Type class for types which can be safely cast to `TreeView`, for instance with `toTreeView`.

#### Instances

Instances details

(GObject o, IsDescendantOf TreeView o) => IsTreeView o Source # |
Instance details Defined in GI.Gtk.Objects.TreeView

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

Cast to `TreeView`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, appendColumn, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, collapseAll, collapseRow, columnsAutosize, computeExpand, constructChild, convertBinWindowToTreeCoords, convertBinWindowToWidgetCoords, convertTreeToBinWindowCoords, convertTreeToWidgetCoords, convertWidgetToBinWindowCoords, convertWidgetToTreeCoords, createPangoContext, createPangoLayout, createRowDragIcon, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, enableModelDragDest, enableModelDragSource, ensureStyle, errorBell, event, expandAll, expandRow, expandToPath, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, insertColumn, insertColumnWithDataFunc, intersect, isAncestor, isBlankAtPos, isComposited, isDrawable, isFloating, isFocus, isRubberBandingActive, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mapExpandedRows, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, moveColumnAfter, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeColumn, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, rowActivated, rowExpanded, runDispose, scrollToCell, scrollToPoint, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetRowsDragDest, unsetRowsDragSource, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getActivateOnSingleClick, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBackgroundArea, getBinWindow, getBorder, getBorderWidth, getCanDefault, getCanFocus, getCellArea, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getColumn, getColumns, getCompositeName, getCursor, getData, getDestRowAtPos, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getDragDestRow, getEnableSearch, getEnableTreeLines, getEvents, getExpanderColumn, getFixedHeightMode, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getGridLines, getHadjustment, getHalign, getHasTooltip, getHasWindow, getHeadersClickable, getHeadersVisible, getHexpand, getHexpandSet, getHoverExpand, getHoverSelection, getHscrollPolicy, getInternalChild, getLevelIndentation, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModel, getModifierMask, getModifierStyle, getNColumns, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathAtPos, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getReorderable, getRequestMode, getRequisition, getResizeMode, getRootWindow, getRubberBanding, getRulesHint, getScaleFactor, getScreen, getSearchColumn, getSearchEntry, getSelection, getSensitive, getSettings, getShowExpanders, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipColumn, getTooltipContext, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getVadjustment, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleRange, getVisibleRect, getVisual, getVscrollPolicy, getWindow.

#### Setters

setAccelPath, setActivateOnSingleClick, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setColumnDragFunction, setCompositeName, setCursor, setCursorOnCell, setData, setDataFull, setDestroyCountFunc, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setDragDestRow, setEnableSearch, setEnableTreeLines, setEvents, setExpanderColumn, setFixedHeightMode, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setGridLines, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHeadersClickable, setHeadersVisible, setHexpand, setHexpandSet, setHoverExpand, setHoverSelection, setHscrollPolicy, setLevelIndentation, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setModel, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setReorderable, setResizeMode, setRowSeparatorFunc, setRubberBanding, setRulesHint, setSearchColumn, setSearchEntry, setSearchEqualFunc, setSearchPositionFunc, setSensitive, setShowExpanders, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipCell, setTooltipColumn, setTooltipMarkup, setTooltipRow, setTooltipText, setTooltipWindow, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setVscrollPolicy, setWindow.

## appendColumn

treeViewAppendColumn Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a) |
=> a | `treeView`: A `TreeView`.
-> m () |

Recursively collapses all visible, expanded nodes in `treeView`.

## collapseRow

treeViewCollapseRow Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a) |
=> a | `treeView`: A `TreeView`.
-> m () |

Recursively expands all nodes in the `treeView`.

## expandRow

treeViewExpandRow Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 GtkWidgetqueryTooltip), please see `treeViewConvertWidgetToBinWindowCoords`.

## getReorderable

treeViewGetReorderable Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a) |
=> a | `treeView`: A `TreeView`.
-> m TreeSelection | Returns: A `TreeSelection` object.

Gets the `TreeSelection` associated with `treeView`.

## getShowExpanders

treeViewGetShowExpanders Source #

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 Source #

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 Source #

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::queryTooltip 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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 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 GtkWidgetqueryTooltip), 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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m TreeView | Returns: A newly created `TreeView` widget.

Creates a new `TreeView` widget.

## newWithModel

treeViewNewWithModel Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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::rowActivated signal to be emitted on a single click instead of a double click.

Since: 3.8

## setColumnDragFunction

treeViewSetColumnDragFunction Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b) |
=> a | `treeView`: A `TreeView`
-> Maybe 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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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::rowInserted and TreeModel::rowDeleted 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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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:hasTooltip will be set to `True` and `treeView` will connect a Widget::queryTooltip 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 Source #

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 Source #

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 Source #

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 Source #

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

The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click.

Since: 3.8

constructTreeViewActivateOnSingleClick :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`activate-on-single-click`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`activate-on-single-click`” property. When overloading is enabled, this is equivalent to

    get treeView #activateOnSingleClick

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

Set the value of the “`activate-on-single-click`” property. When overloading is enabled, this is equivalent to

    set treeView [ #activateOnSingleClick := value ]

## enableGridLines

No description available in the introspection data.

constructTreeViewEnableGridLines :: (IsTreeView o, MonadIO m) => TreeViewGridLines -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`enable-grid-lines`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`enable-grid-lines`” property. When overloading is enabled, this is equivalent to

    get treeView #enableGridLines

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

Set the value of the “`enable-grid-lines`” property. When overloading is enabled, this is equivalent to

    set treeView [ #enableGridLines := value ]

## enableSearch

No description available in the introspection data.

constructTreeViewEnableSearch :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`enable-search`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`enable-search`” property. When overloading is enabled, this is equivalent to

    get treeView #enableSearch

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

Set the value of the “`enable-search`” property. When overloading is enabled, this is equivalent to

    set treeView [ #enableSearch := value ]

## enableTreeLines

No description available in the introspection data.

constructTreeViewEnableTreeLines :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`enable-tree-lines`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`enable-tree-lines`” property. When overloading is enabled, this is equivalent to

    get treeView #enableTreeLines

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

Set the value of the “`enable-tree-lines`” property. When overloading is enabled, this is equivalent to

    set treeView [ #enableTreeLines := value ]

## expanderColumn

No description available in the introspection data.

clearTreeViewExpanderColumn :: (MonadIO m, IsTreeView o) => o -> m () Source #

Set the value of the “`expander-column`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #expanderColumn

constructTreeViewExpanderColumn :: (IsTreeView o, MonadIO m, IsTreeViewColumn a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`expander-column`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`expander-column`” property. When overloading is enabled, this is equivalent to

    get treeView #expanderColumn

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

Set the value of the “`expander-column`” property. When overloading is enabled, this is equivalent to

    set treeView [ #expanderColumn := value ]

## fixedHeightMode

Setting the fixedHeightMode property to `True` speeds up `TreeView` by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see `treeViewSetFixedHeightMode` for more information on this option.

Since: 2.4

constructTreeViewFixedHeightMode :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`fixed-height-mode`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`fixed-height-mode`” property. When overloading is enabled, this is equivalent to

    get treeView #fixedHeightMode

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

Set the value of the “`fixed-height-mode`” property. When overloading is enabled, this is equivalent to

    set treeView [ #fixedHeightMode := value ]

## headersClickable

No description available in the introspection data.

constructTreeViewHeadersClickable :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`headers-clickable`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`headers-clickable`” property. When overloading is enabled, this is equivalent to

    get treeView #headersClickable

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

Set the value of the “`headers-clickable`” property. When overloading is enabled, this is equivalent to

    set treeView [ #headersClickable := value ]

## headersVisible

No description available in the introspection data.

constructTreeViewHeadersVisible :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`headers-visible`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`headers-visible`” property. When overloading is enabled, this is equivalent to

    get treeView #headersVisible

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

Set the value of the “`headers-visible`” property. When overloading is enabled, this is equivalent to

    set treeView [ #headersVisible := value ]

## hoverExpand

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

This mode is primarily intended for treeviews in popups, e.g. in `ComboBox` or `EntryCompletion`.

Since: 2.6

constructTreeViewHoverExpand :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`hover-expand`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`hover-expand`” property. When overloading is enabled, this is equivalent to

    get treeView #hoverExpand

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

Set the value of the “`hover-expand`” property. When overloading is enabled, this is equivalent to

    set treeView [ #hoverExpand := value ]

## hoverSelection

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

This mode is primarily intended for treeviews in popups, e.g. in `ComboBox` or `EntryCompletion`.

Since: 2.6

constructTreeViewHoverSelection :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`hover-selection`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`hover-selection`” property. When overloading is enabled, this is equivalent to

    get treeView #hoverSelection

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

Set the value of the “`hover-selection`” property. When overloading is enabled, this is equivalent to

    set treeView [ #hoverSelection := value ]

## levelIndentation

Extra indentation for each level.

Since: 2.12

constructTreeViewLevelIndentation :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`level-indentation`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`level-indentation`” property. When overloading is enabled, this is equivalent to

    get treeView #levelIndentation

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

Set the value of the “`level-indentation`” property. When overloading is enabled, this is equivalent to

    set treeView [ #levelIndentation := value ]

## model

No description available in the introspection data.

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

Set the value of the “`model`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #model

constructTreeViewModel :: (IsTreeView o, MonadIO m, IsTreeModel a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`model`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`model`” property. When overloading is enabled, this is equivalent to

    get treeView #model

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

Set the value of the “`model`” property. When overloading is enabled, this is equivalent to

    set treeView [ #model := value ]

## reorderable

No description available in the introspection data.

constructTreeViewReorderable :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`reorderable`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`reorderable`” property. When overloading is enabled, this is equivalent to

    get treeView #reorderable

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

Set the value of the “`reorderable`” property. When overloading is enabled, this is equivalent to

    set treeView [ #reorderable := value ]

## rubberBanding

No description available in the introspection data.

constructTreeViewRubberBanding :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`rubber-banding`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`rubber-banding`” property. When overloading is enabled, this is equivalent to

    get treeView #rubberBanding

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

Set the value of the “`rubber-banding`” property. When overloading is enabled, this is equivalent to

    set treeView [ #rubberBanding := value ]

## rulesHint

Sets a hint to the theme to draw rows in alternating colors.

constructTreeViewRulesHint :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`rules-hint`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`rules-hint`” property. When overloading is enabled, this is equivalent to

    get treeView #rulesHint

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

Set the value of the “`rules-hint`” property. When overloading is enabled, this is equivalent to

    set treeView [ #rulesHint := value ]

## searchColumn

No description available in the introspection data.

constructTreeViewSearchColumn :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`search-column`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`search-column`” property. When overloading is enabled, this is equivalent to

    get treeView #searchColumn

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

Set the value of the “`search-column`” property. When overloading is enabled, this is equivalent to

    set treeView [ #searchColumn := value ]

## showExpanders

`True` if the view has expanders.

Since: 2.12

constructTreeViewShowExpanders :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`show-expanders`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`show-expanders`” property. When overloading is enabled, this is equivalent to

    get treeView #showExpanders

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

Set the value of the “`show-expanders`” property. When overloading is enabled, this is equivalent to

    set treeView [ #showExpanders := value ]

## tooltipColumn

No description available in the introspection data.

constructTreeViewTooltipColumn :: (IsTreeView o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`tooltip-column`” property. This is rarely needed directly, but it is used by `new`.

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

Get the value of the “`tooltip-column`” property. When overloading is enabled, this is equivalent to

    get treeView #tooltipColumn

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

Set the value of the “`tooltip-column`” property. When overloading is enabled, this is equivalent to

    set treeView [ #tooltipColumn := value ]

## ubuntuAlmostFixedHeightMode

No description available in the introspection data.

constructTreeViewUbuntuAlmostFixedHeightMode :: (IsTreeView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`ubuntu-almost-fixed-height-mode`” property. This is rarely needed directly, but it is used by `new`.

setTreeViewUbuntuAlmostFixedHeightMode :: (MonadIO m, IsTreeView o) => o -> Bool -> m () Source #

Set the value of the “`ubuntu-almost-fixed-height-mode`” property. When overloading is enabled, this is equivalent to

    set treeView [ #ubuntuAlmostFixedHeightMode := value ]

# Signals

## columnsChanged

type TreeViewColumnsChangedCallback = IO () Source #

The number of columns of the treeview has changed.

afterTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewColumnsChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the columnsChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #columnsChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewColumnsChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewColumnsChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the columnsChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #columnsChanged callback

## cursorChanged

type TreeViewCursorChangedCallback = IO () Source #

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

afterTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewCursorChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the cursorChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #cursorChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewCursorChanged :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewCursorChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the cursorChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #cursorChanged callback

## expandCollapseCursorRow

type TreeViewExpandCollapseCursorRowCallback = Bool -> Bool -> Bool -> IO Bool Source #

No description available in the introspection data.

afterTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewExpandCollapseCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the expandCollapseCursorRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #expandCollapseCursorRow callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewExpandCollapseCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewExpandCollapseCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the expandCollapseCursorRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #expandCollapseCursorRow callback

## moveCursor

type TreeViewMoveCursorCallback Source #

Arguments

= MovementStep | `step`: the granularity of the move, as a `MovementStep`. `MovementStepLogicalPositions`, `MovementStepVisualPositions`, `MovementStepDisplayLines`, `MovementStepPages` and `MovementStepBufferEnds` are supported. `MovementStepLogicalPositions` and `MovementStepVisualPositions` are treated identically.
-> Int32 | `direction`: the direction to move: +1 to move forwards; -1 to move backwards. The resulting movement is undefined for all other values.
-> IO Bool | Returns: `True` if `step` is supported, `False` otherwise.

The TreeView::moveCursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user presses one of the cursor keys.

Applications should not connect to it, but may emit it with `g_signal_emit_by_name()` if they need to control the cursor programmatically. In contrast to `treeViewSetCursor` and `treeViewSetCursorOnCell` when moving horizontally TreeView::moveCursor does not reset the current selection.

afterTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewMoveCursorCallback) -> m SignalHandlerId Source #

Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #moveCursor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewMoveCursor :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewMoveCursorCallback) -> m SignalHandlerId Source #

Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #moveCursor callback

## rowActivated

type TreeViewRowActivatedCallback Source #

Arguments

= TreePath | `path`: the `TreePath` for the activated row
-> TreeViewColumn | `column`: the `TreeViewColumn` in which the activation occurred
-> IO () |

The "row-activated" signal is emitted when the method `treeViewRowActivated` 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.

For selection handling refer to the tree widget conceptual overview as well as `TreeSelection`.

afterTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowActivatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #rowActivated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewRowActivated :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowActivatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #rowActivated callback

## rowCollapsed

type TreeViewRowCollapsedCallback Source #

Arguments

= TreeIter | `iter`: the tree iter of the collapsed row
-> TreePath | `path`: a tree path that points to the row
-> IO () |

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

afterTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowCollapsedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowCollapsed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #rowCollapsed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewRowCollapsed :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowCollapsedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowCollapsed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #rowCollapsed callback

## rowExpanded

type TreeViewRowExpandedCallback Source #

Arguments

= TreeIter | `iter`: the tree iter of the expanded row
-> TreePath | `path`: a tree path that points to the row
-> IO () |

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

afterTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowExpandedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowExpanded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #rowExpanded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewRowExpanded :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewRowExpandedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the rowExpanded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #rowExpanded callback

## selectAll

type TreeViewSelectAllCallback = IO Bool Source #

No description available in the introspection data.

afterTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectAllCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #selectAll callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewSelectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectAllCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #selectAll callback

## selectCursorParent

type TreeViewSelectCursorParentCallback = IO Bool Source #

No description available in the introspection data.

afterTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorParentCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectCursorParent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #selectCursorParent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewSelectCursorParent :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorParentCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectCursorParent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #selectCursorParent callback

## selectCursorRow

type TreeViewSelectCursorRowCallback = Bool -> IO Bool Source #

No description available in the introspection data.

afterTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectCursorRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #selectCursorRow callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewSelectCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewSelectCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the selectCursorRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #selectCursorRow callback

## startInteractiveSearch

type TreeViewStartInteractiveSearchCallback = IO Bool Source #

No description available in the introspection data.

afterTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewStartInteractiveSearchCallback) -> m SignalHandlerId Source #

Connect a signal handler for the startInteractiveSearch signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #startInteractiveSearch callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewStartInteractiveSearch :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewStartInteractiveSearchCallback) -> m SignalHandlerId Source #

Connect a signal handler for the startInteractiveSearch signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #startInteractiveSearch callback

## testCollapseRow

type TreeViewTestCollapseRowCallback Source #

Arguments

= TreeIter | `iter`: the tree iter of the row to collapse
-> TreePath | `path`: a tree path that points to the row
-> IO Bool | Returns: `False` to allow collapsing, `True` to reject

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.

afterTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestCollapseRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the testCollapseRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #testCollapseRow callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewTestCollapseRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestCollapseRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the testCollapseRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #testCollapseRow callback

## testExpandRow

type TreeViewTestExpandRowCallback Source #

Arguments

= TreeIter | `iter`: the tree iter of the row to expand
-> TreePath | `path`: a tree path that points to the row
-> IO Bool | Returns: `False` to allow expansion, `True` to reject

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.

afterTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestExpandRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the testExpandRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #testExpandRow callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewTestExpandRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewTestExpandRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the testExpandRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #testExpandRow callback

## toggleCursorRow

type TreeViewToggleCursorRowCallback = IO Bool Source #

No description available in the introspection data.

afterTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewToggleCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the toggleCursorRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #toggleCursorRow callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewToggleCursorRow :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewToggleCursorRowCallback) -> m SignalHandlerId Source #

Connect a signal handler for the toggleCursorRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #toggleCursorRow callback

## unselectAll

type TreeViewUnselectAllCallback = IO Bool Source #

No description available in the introspection data.

afterTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewUnselectAllCallback) -> m SignalHandlerId Source #

Connect a signal handler for the unselectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after treeView #unselectAll callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onTreeViewUnselectAll :: (IsTreeView a, MonadIO m) => a -> ((?self :: a) => TreeViewUnselectAllCallback) -> m SignalHandlerId Source #

Connect a signal handler for the unselectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on treeView #unselectAll callback