FBTree Class Reference
Detailed Description
Tree list view.
- Examples
- UI/Tree.py
Public Member Functions | |
| __init__ () | |
| Constructor. | |
| HFBTreeNode | GetRoot () |
| Get the root node. | |
| Clear () | |
| Clear the tree (remove all nodes). | |
| HFBTreeNode | InsertLast (HFBTreeNode pNode, str pName) |
| Insert node at the end. | |
Public Attributes | |
| FBPropertyEvent | OnSelect |
| Event: A node was selected. | |
| FBPropertyEvent | OnClick |
| Event: Click on a node of the tree. | |
| FBPropertyEvent | OnClickCheck |
| Event: Click on a node checkbox of the tree. | |
| FBPropertyEvent | OnDblClick |
| Event: Double-Click on a node of the tree. | |
| FBPropertyEvent | OnDeselect |
| Event: Deselection on a node of the tree. | |
| FBPropertyEvent | OnExpanded |
| Event: Click on the "+" sign before a non-leaf node. | |
| FBPropertyEvent | OnExpanding |
| Event: Is fired before the node expand. | |
| FBPropertyEvent | OnCollapsed |
| Event: Click on the "-" sign before a non-leaf node. | |
| FBPropertyEvent | OnCollapsing |
| Event: Fired before the node collapse. | |
| FBPropertyEvent | OnChange |
| Event: Change of the selection. | |
| FBPropertyEvent | OnDragAndDrop |
| Event: Drag and drop of an element. | |
| FBPropertyEvent | OnEditNode |
| Event: Called upon node edition. | |
| FBPropertyBase | SelectedCount |
| Read Only Property: Count of selected items. | |
| FBPropertyBase | VisibleItemCount |
| Read Only Property: Count of visible items. | |
| FBPropertyBase | AllowExpansion |
| Read Write Property: When OnExpanding occurs, set this to true to allow expansion. | |
| FBPropertyBase | AllowCollapse |
| Read Write Property: When OnCollapsing occurs, set this to true to allow collapse. | |
| FBPropertyBase | MultiDrag |
| Read Write Property: Tells whether multiple drag/drop is allowed or not. | |
| FBPropertyBase | AutoScroll |
| Read Write Property: If AutoScroll property is True then the tree window will be automatically scrolled when the user drags item(s) over the boundaries of the tree. | |
| FBPropertyBase | Indent |
| Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded. | |
| FBPropertyBase | CheckBoxes |
| Read Write Property: Draw check boxe for each node. | |
| FBPropertyBase | ShowLines |
| Read Write Property: On node selection, will draw entire line selected. | |
| FBPropertyBase | ItemHeight |
| Read Write Property: Height of an item. | |
| FBPropertyBase | MultiSelect |
| Read Write Property: Tells whether multiple selection is allowed or not. | |
| FBPropertyBase | EditNodeOn2Select |
| Read Write Property: Set to true, to allow automatic node editing on second select. | |
| FBPropertyBase | TreeHeight |
| Read Only Property: Height of the tree. | |
| FBPropertyBase | TreeWidth |
| Read Only Property: Width of the tree. | |
| FBPropertyBase | SelectionActive |
| Read Write Property: Tells whether selection is allowed or not. | |
| FBPropertyBase | DeselectOnCollapse |
| Read Write Property: Tells whether node are deselected if parent node is collapsed. | |
| FBPropertyBase | NoSelectOnDrag |
| Read Write Property: Tells whether node are selected if drag is start and node is not already selected. | |
| FBPropertyBase | NoSelectOnRightClick |
| Read Write Property: Tells whether node are selected if right click on node. | |
| FBPropertyBase | HighlightOnRightClick |
| Read Write Property: Hightlight node on right click. | |
| FBPropertyBase | AutoScrollOnExpand |
| Read Write Property: Allow automatic scroll on expand, default is true. | |
| FBPropertyBase | AutoExpandOnDragOver |
| Read Write Property: Allow automatic expand on drag over, default is false. | |
| FBPropertyBase | AutoExpandOnDblClick |
| Read Write Property: Allow automatic expand on double click, default is false. | |
Member Function Documentation
| __init__ | ( | ) |
| HFBTreeNode GetRoot | ( | ) |
| Clear | ( | ) |
Clear the tree (remove all nodes).
| HFBTreeNode InsertLast | ( | HFBTreeNode | pNode, |
| str | pName | ||
| ) |
Insert node at the end.
- Parameters:
-
pNode Node under which the new node will appear. pName Text to display for this node.
- Returns:
- the newly created node.
Member Data Documentation
| FBPropertyEvent OnSelect |
| FBPropertyEvent OnClick |
| FBPropertyEvent OnClickCheck |
Event: Click on a node checkbox of the tree.
| FBPropertyEvent OnDblClick |
Event: Double-Click on a node of the tree.
Use FBEventTreeSelect to cast event.
| FBPropertyEvent OnDeselect |
Event: Deselection on a node of the tree.
| FBPropertyEvent OnExpanded |
Event: Click on the "+" sign before a non-leaf node.
| FBPropertyEvent OnExpanding |
Event: Is fired before the node expand.
To refuse expanding set AllowExpansion to false.
| FBPropertyEvent OnCollapsed |
Event: Click on the "-" sign before a non-leaf node.
| FBPropertyEvent OnCollapsing |
Event: Fired before the node collapse.
To refuse collapsing, set AllowCollapse to false.
| FBPropertyEvent OnChange |
Event: Change of the selection.
| FBPropertyEvent OnDragAndDrop |
Event: Drag and drop of an element.
| FBPropertyEvent OnEditNode |
Event: Called upon node edition.
| FBPropertyBase SelectedCount |
Read Only Property: Count of selected items.
| FBPropertyBase VisibleItemCount |
Read Only Property: Count of visible items.
| FBPropertyBase AllowExpansion |
Read Write Property: When OnExpanding occurs, set this to true to allow expansion.
| FBPropertyBase AllowCollapse |
Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.
| FBPropertyBase MultiDrag |
Read Write Property: Tells whether multiple drag/drop is allowed or not.
| FBPropertyBase AutoScroll |
Read Write Property: If AutoScroll property is True then the tree window will be automatically scrolled when the user drags item(s) over the boundaries of the tree.
| FBPropertyBase Indent |
Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded.
| FBPropertyBase CheckBoxes |
Read Write Property: Draw check boxe for each node.
| FBPropertyBase ShowLines |
Read Write Property: On node selection, will draw entire line selected.
| FBPropertyBase ItemHeight |
Read Write Property: Height of an item.
| FBPropertyBase MultiSelect |
Read Write Property: Tells whether multiple selection is allowed or not.
| FBPropertyBase EditNodeOn2Select |
Read Write Property: Set to true, to allow automatic node editing on second select.
| FBPropertyBase TreeHeight |
Read Only Property: Height of the tree.
| FBPropertyBase TreeWidth |
Read Only Property: Width of the tree.
| FBPropertyBase SelectionActive |
Read Write Property: Tells whether selection is allowed or not.
| FBPropertyBase DeselectOnCollapse |
Read Write Property: Tells whether node are deselected if parent node is collapsed.
| FBPropertyBase NoSelectOnDrag |
Read Write Property: Tells whether node are selected if drag is start and node is not already selected.
| FBPropertyBase NoSelectOnRightClick |
Read Write Property: Tells whether node are selected if right click on node.
| FBPropertyBase HighlightOnRightClick |
Read Write Property: Hightlight node on right click.
| FBPropertyBase AutoScrollOnExpand |
Read Write Property: Allow automatic scroll on expand, default is true.
| FBPropertyBase AutoExpandOnDragOver |
Read Write Property: Allow automatic expand on drag over, default is false.
| FBPropertyBase AutoExpandOnDblClick |
Read Write Property: Allow automatic expand on double click, default is false.
