TreeView

public class TreeView : ControlView

Undocumented


                    
                    
                    willExpand

Event raised when an item within this tree view is about to be expanded.

Declaration

Swift

@CancellableActionEventWithSender
<TreeView, TreeView.ItemIndex> public var willExpand: EventSource<SenderEventArgs<TreeView, CancellableActionEventArgs<TreeView.ItemIndex>>> { get }


                    
                    
                    willCollapse

Event raised when an item within this tree view is about to be collapsed.

Declaration

Swift

@CancellableActionEventWithSender
<TreeView, TreeView.ItemIndex> public var willCollapse: EventSource<SenderEventArgs<TreeView, CancellableActionEventArgs<TreeView.ItemIndex>>> { get }


                    
                    
                    willSelect

Event raised when an item within this tree view is about to be selected.

Declaration

Swift

@CancellableActionEventWithSender
<TreeView, TreeView.ItemIndex> public var willSelect: EventSource<SenderEventArgs<TreeView, CancellableActionEventArgs<TreeView.ItemIndex>>> { get }


                    
                    
                    willDeselect

Event raised when one or more items within this tree view are about to be deselected.

Declaration

Swift

@CancellableActionEventWithSender
<TreeView, Set<TreeView.ItemIndex>> public var willDeselect: EventSource<SenderEventArgs<TreeView, CancellableActionEventArgs<Set<TreeView.ItemIndex>>>> { get }


                    
                    
                    didChangeSelection

Event raised after selection changes to this tree view.

Declaration

Swift

@ValueChangedEventWithSender
<TreeView, Set<TreeView.ItemIndex>> public var didChangeSelection: EventSource<SenderEventArgs<TreeView, ValueChangedEventArgs<Set<TreeView.ItemIndex>>>> { get }


                    
                    
                    mouseRightClickedItem

Undocumented

Declaration

Swift

@EventWithSender
<TreeView, TreeView.ItemIndex> public var mouseRightClickedItem: EventSource<SenderEventArgs<TreeView, TreeView.ItemIndex>> { get }

dataSource
The data source queried to generate the items within this tree view.

Changing the data source property clears all selection and expansion state, and triggers an immediate data reload.
Declaration
Swift

public weak var dataSource: TreeViewDataSource? { get set }


                    
                    
                    canBecomeFirstResponder

Declaration

Swift

public override var canBecomeFirstResponder: Bool { get }

canDeselectItemsOnEmptySpaces
If true, items can be deselected by clicking on empty spaces with no tree view items within the bounds of this tree view control.

Defaults to false.
Declaration
Swift

public var canDeselectItemsOnEmptySpaces: Bool
overScrollFactor
A percentage of the display height of the tree view that the scroll view is padded at the bottom in order to create an empty space past the end of the list of items.

Seealso
ScrollView.overScrollFactor
Declaration
Swift

public var overScrollFactor: Double { get set }
style
Specifies the visual style of this tree view.
Declaration
Swift

public var style: VisualStyle { get set }
init()
Undocumented
Declaration
Swift

public override init()

Hierarchy

setupHierarchy()
Declaration
Swift

public override func setupHierarchy()
setupConstraints()
Declaration
Swift

public override func setupConstraints()


                    
                    
                    performInternalLayout()

Declaration

Swift

public override func performInternalLayout()

Events


                    
                    
                    canHandle(_:)

Declaration

Swift

public override func canHandle(_ eventRequest: EventRequest) -> Bool


                    
                    
                    onKeyDown(_:)

Declaration

Swift

public override func onKeyDown(_ event: KeyEventArgs)


                    
                    
                    onMouseClick(_:)

Declaration

Swift

public override func onMouseClick(_ event: MouseEventArgs)

Data/display management

reloadData()
Repopulates the tree view’s items.
Declaration
Swift

public func reloadData()
collapseAll()
Requests that the TreeView collapse all currently expanded items.
Declaration
Swift

public func collapseAll()
collapse(index:)
Requests that the TreeView collapse a given item index.
Declaration
Swift

public func collapse(index: ItemIndex)
expand(index:)
Requests that the TreeView collapse a given item index.
Declaration
Swift

public func expand(index: ItemIndex)
addSelection(_:)
Selects the given items on the interface alongside any currently selected items, triggering a didChangeSelection event in the process.
Declaration
Swift

public func addSelection(_ items: Set<ItemIndex>)
setSelection(_:)
Selects the given items on the interface, deselecting any currently selected items, triggering a didChangeSelection event in the process.
Declaration
Swift

public func setSelection(_ items: Set<ItemIndex>)
clearSelection()
If any items are selected in this tree view, clears their selection, triggering a didChangeSelection event in the process.
Declaration
Swift

public func clearSelection()
HierarchyIndex
Specifies the hierarchical index for a sub-tree.
See more
Declaration
Swift

public struct HierarchyIndex : Hashable, Comparable


                    
                    
                    ItemIndex

Undocumented

Declaration

Swift

public struct ItemIndex : Hashable, Comparable

VisualStyle
Undocumented
See more
Declaration
Swift

struct VisualStyle