GI.Dazzle.Objects.Tree

No description available in the introspection data.

Exported types

newtype Tree

Memory-managed wrapper type.

Constructors

Tree (ManagedPtr Tree)

Instances

Eq Tree

Defined in GI.Dazzle.Objects.Tree

Methods

(==) :: Tree -> Tree -> Bool

(/=) :: Tree -> Tree -> Bool

GObject Tree

Defined in GI.Dazzle.Objects.Tree

ManagedPtrNewtype Tree

Defined in GI.Dazzle.Objects.Tree

Methods

toManagedPtr :: Tree -> ManagedPtr Tree

TypedObject Tree

Defined in GI.Dazzle.Objects.Tree

Methods

glibType :: IO GType

HasParentTypes Tree

Defined in GI.Dazzle.Objects.Tree

IsGValue (Maybe Tree)

Convert Tree to and from GValue. See toGValue and fromGValue.

Defined in GI.Dazzle.Objects.Tree

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Tree -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Tree)

type ParentTypes Tree

Defined in GI.Dazzle.Objects.Tree

type ParentTypes Tree = '[TreeView, Container, Widget, Object, ImplementorIface, Buildable, Scrollable]

class (GObject o, IsDescendantOf Tree o) => IsTree o

Type class for types which can be safely cast to Tree, for instance with toTree.

Instances

(GObject o, IsDescendantOf Tree o) => IsTree o

Defined in GI.Dazzle.Objects.Tree

toTree :: (MonadIO m, IsTree o) => o -> m Tree

Cast to Tree, 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

Methods

activate, add, addAccelerator, addBuilder, 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, expandToNode, expandToPath, findChildNode, findCustom, findItem, 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, rebuild, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeBuilder, removeColumn, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, rowActivated, rowExpanded, runDispose, scrollToCell, scrollToNode, scrollToPoint, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unselectAll, 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, getContextMenu, 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, getRoot, getRootWindow, getRubberBanding, getRulesHint, getScaleFactor, getScreen, getSearchColumn, getSearchEntry, getSelected, getSelection, getSensitive, getSettings, getShowExpanders, getShowIcons, 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, setContextMenu, setCursor, setCursorOnCell, setData, setDataFull, setDestroyCountFunc, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setDragDestRow, setEnableSearch, setEnableTreeLines, setEvents, setExpanderColumn, setFilter, 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, setRoot, setRowSeparatorFunc, setRubberBanding, setRulesHint, setSearchColumn, setSearchEntry, setSearchEqualFunc, setSearchPositionFunc, setSensitive, setShowExpanders, setShowIcons, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipCell, setTooltipColumn, setTooltipMarkup, setTooltipRow, setTooltipText, setTooltipWindow, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setVscrollPolicy, setWindow.

addBuilder

treeAddBuilder

Arguments

:: (HasCallStack, MonadIO m, IsTree a, IsTreeBuilder b)

=> a

self: A Tree.

-> b

builder: A TreeBuilder to add.

-> m ()

Add a builder to the tree.

expandToNode

treeExpandToNode :: (HasCallStack, MonadIO m, IsTree a, IsTreeNode b) => a -> b -> m ()

No description available in the introspection data.

findChildNode

treeFindChildNode

Arguments

:: (HasCallStack, MonadIO m, IsTree a, IsTreeNode b)

=> a

self: A Tree

-> b

node: A TreeNode

-> TreeFindFunc

findFunc: A callback to locate the child

-> m (Maybe TreeNode)

Returns: A TreeNode or Nothing.

Searches through the direct children of node for a matching child. findFunc should return True if the child matches, otherwise False.

findCustom

treeFindCustom

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

self: A Tree

-> EqualFunc

equalFunc: A EqualFunc

-> Ptr ()

key: the key for equalFunc

-> m (Maybe TreeNode)

Returns: A TreeNode or Nothing.

Walks the entire tree looking for the first item that matches given equalFunc and key.

The first parameter to equalFunc will always be key. The second parameter will be the nodes TreeNode:item property.

findItem

treeFindItem

Arguments

:: (HasCallStack, MonadIO m, IsTree a, IsObject b)

=> a

self: A Tree.

-> Maybe b

item: A Object or Nothing.

-> m (Maybe TreeNode)

Returns: A TreeNode or Nothing.

Finds a TreeNode with an item property matching item.

getContextMenu

treeGetContextMenu

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

-> m (Maybe MenuModel)

Returns: A MenuModel or Nothing.

No description available in the introspection data.

getRoot

treeGetRoot

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

-> m (Maybe TreeNode)

Returns: A TreeNode or Nothing.

Retrieves the root node of the tree. The root node is not a visible node in the self, but a placeholder for all other builders to build upon.

getSelected

treeGetSelected

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

self: A Tree.

-> m TreeNode

Returns: A TreeNode.

Gets the currently selected node in the tree.

getShowIcons

treeGetShowIcons :: (HasCallStack, MonadIO m, IsTree a) => a -> m Bool

No description available in the introspection data.

rebuild

treeRebuild :: (HasCallStack, MonadIO m, IsTree a) => a -> m ()

No description available in the introspection data.

removeBuilder

treeRemoveBuilder

Arguments

:: (HasCallStack, MonadIO m, IsTree a, IsTreeBuilder b)

=> a

self: A Tree.

-> b

builder: A TreeBuilder to remove.

-> m ()

Removes a builder from the tree.

scrollToNode

treeScrollToNode :: (HasCallStack, MonadIO m, IsTree a, IsTreeNode b) => a -> b -> m ()

No description available in the introspection data.

setContextMenu

treeSetContextMenu :: (HasCallStack, MonadIO m, IsTree a, IsMenuModel b) => a -> b -> m ()

No description available in the introspection data.

setFilter

treeSetFilter

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

self: A Tree

-> TreeFilterFunc

filterFunc: A callback to determien visibility.

-> m ()

Sets the filter function to be used to determine visability of a tree node.

setRoot

treeSetRoot

Arguments

:: (HasCallStack, MonadIO m, IsTree a, IsTreeNode b)

=> a

self: A Tree.

-> b

node: A TreeNode.

-> m ()

Sets the root node of the Tree widget. This is used to build the items within the treeview. The item itself will not be added to the self, but the direct children will be.

setShowIcons

treeSetShowIcons :: (HasCallStack, MonadIO m, IsTree a) => a -> Bool -> m ()

No description available in the introspection data.

unselectAll

treeUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

self: A Tree.

-> m ()

Unselects the currently selected node in the tree.

Properties

alwaysExpand

No description available in the introspection data.

constructTreeAlwaysExpand :: (IsTree o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getTreeAlwaysExpand :: (MonadIO m, IsTree o) => o -> m Bool

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

get tree #alwaysExpand

contextMenu

No description available in the introspection data.

constructTreeContextMenu :: (IsTree o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)

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

getTreeContextMenu :: (MonadIO m, IsTree o) => o -> m (Maybe MenuModel)

Get the value of the “context-menu” property. When overloading is enabled, this is equivalent to

get tree #contextMenu

setTreeContextMenu :: (MonadIO m, IsTree o, IsMenuModel a) => o -> a -> m ()

Set the value of the “context-menu” property. When overloading is enabled, this is equivalent to

set tree [ #contextMenu := value ]

root

No description available in the introspection data.

constructTreeRoot :: (IsTree o, MonadIO m, IsTreeNode a) => a -> m (GValueConstruct o)

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

getTreeRoot :: (MonadIO m, IsTree o) => o -> m (Maybe TreeNode)

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

get tree #root

setTreeRoot :: (MonadIO m, IsTree o, IsTreeNode a) => o -> a -> m ()

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

set tree [ #root := value ]

selection

No description available in the introspection data.

clearTreeSelection :: (MonadIO m, IsTree o) => o -> m ()

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

clear #selection

constructTreeSelection :: (IsTree o, MonadIO m, IsTreeNode a) => a -> m (GValueConstruct o)

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

getTreeSelection :: (MonadIO m, IsTree o) => o -> m (Maybe TreeNode)

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

get tree #selection

setTreeSelection :: (MonadIO m, IsTree o, IsTreeNode a) => o -> a -> m ()

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

set tree [ #selection := value ]

showIcons

No description available in the introspection data.

constructTreeShowIcons :: (IsTree o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getTreeShowIcons :: (MonadIO m, IsTree o) => o -> m Bool

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

get tree #showIcons

setTreeShowIcons :: (MonadIO m, IsTree o) => o -> Bool -> m ()

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

set tree [ #showIcons := value ]

Signals

action

type TreeActionCallback = Text -> Text -> Text -> IO ()

No description available in the introspection data.

afterTreeAction :: (IsTree a, MonadIO m) => a -> ((?self :: a) => TreeActionCallback) -> m SignalHandlerId

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

after tree #action 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.

onTreeAction :: (IsTree a, MonadIO m) => a -> ((?self :: a) => TreeActionCallback) -> m SignalHandlerId

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

on tree #action callback

populatePopup

type TreePopulatePopupCallback = Widget -> IO ()

No description available in the introspection data.

afterTreePopulatePopup :: (IsTree a, MonadIO m) => a -> ((?self :: a) => TreePopulatePopupCallback) -> m SignalHandlerId

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

after tree #populatePopup 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.

onTreePopulatePopup :: (IsTree a, MonadIO m) => a -> ((?self :: a) => TreePopulatePopupCallback) -> m SignalHandlerId

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

on tree #populatePopup callback