Public Member Functions | Public Attributes

FBTree Class Reference

Search for all occurrences

Detailed Description

Tree list view.

Definition at line 1834 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBTree:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBTree ()
 Constructor.
FBTreeNodeGetRoot ()
 Get the root node.
void Clear ()
 Clear the tree (remove all nodes).
FBTreeNodeInsertLast (FBTreeNode *pNode, const char *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.
FBPropertyInt SelectedCount
 Read Only Property: Count of selected items.
FBPropertyInt VisibleItemCount
 Read Only Property: Count of visible items.
FBPropertyBool AllowExpansion
 Read Write Property: When OnExpanding occurs, set this to true to allow expansion.
FBPropertyBool AllowCollapse
 Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.
FBPropertyBool MultiDrag
 Read Write Property: Tells whether multiple drag/drop is allowed or not.
FBPropertyBool 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.
FBPropertyInt Indent
 Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded.
FBPropertyBool CheckBoxes
 Read Write Property: Draw check boxe for each node.
FBPropertyBool ShowLines
 Read Write Property: On node selection, will draw entire line selected
FBPropertyInt ItemHeight
 Read Write Property: Height of an item.
FBPropertyBool MultiSelect
 Read Write Property: Tells whether multiple selection is allowed or not.
FBPropertyBool EditNodeOn2Select
 Read Write Property: Set to true, to allow automatic node editing on second select.
FBPropertyInt TreeHeight
 Read Only Property: Height of the tree.
FBPropertyInt TreeWidth
 Read Only Property: Width of the tree.
FBPropertyBool SelectionActive
 Read Write Property: Tells whether selection is allowed or not.
FBPropertyBool DeselectOnCollapse
 Read Write Property: Tells whether node are deselected if parent node is collapsed.
FBPropertyBool NoSelectOnDrag
 Read Write Property: Tells whether node are selected if drag is start and node is not already selected.
FBPropertyBool NoSelectOnRightClick
 Read Write Property: Tells whether node are selected if right click on node.
FBPropertyBool HighlightOnRightClick
 Read Write Property: Hightlight node on right click.
FBPropertyBool AutoScrollOnExpand
 Read Write Property: Allow automatic scroll on expand, default is true.
FBPropertyBool AutoExpandOnDragOver
 Read Write Property: Allow automatic expand on drag over, default is false.
FBPropertyBool AutoExpandOnDblClick
 Read Write Property: Allow automatic expand on double click, default is false.
FBPropertyListTreeNode SelectedNodes
 Read Only Property: List of selected nodes.

Constructor & Destructor Documentation

FBTree ( )

Constructor.


Member Function Documentation

FBTreeNode* GetRoot ( )

Get the root node.

Returns:
the root node of the tree.
void Clear ( )

Clear the tree (remove all nodes).

FBTreeNode* InsertLast ( FBTreeNode pNode,
const char *  pName 
)

Insert node at the end.

Parameters:
pNodeNode under which the new node will appear.
pNameText to display for this node.
Returns:
the newly created node.

Member Data Documentation

Event: A node was selected.

Use FBEventTreeSelect to cast event.

Definition at line 1857 of file fbcontrols.h.

Event: Click on a node of the tree.

Use OnSelect.

Definition at line 1859 of file fbcontrols.h.

Event: Click on a node checkbox of the tree.

Definition at line 1860 of file fbcontrols.h.

Event: Double-Click on a node of the tree.

Use FBEventTreeSelect to cast event.

Definition at line 1861 of file fbcontrols.h.

Event: Deselection on a node of the tree.

Definition at line 1862 of file fbcontrols.h.

Event: Click on the "+" sign before a non-leaf node

Definition at line 1863 of file fbcontrols.h.

Event: Is fired before the node expand.

To refuse expanding set AllowExpansion to false.

Definition at line 1864 of file fbcontrols.h.

Event: Click on the "-" sign before a non-leaf node.

Definition at line 1865 of file fbcontrols.h.

Event: Fired before the node collapse.

To refuse collapsing, set AllowCollapse to false.

Definition at line 1866 of file fbcontrols.h.

Event: Change of the selection.

Definition at line 1867 of file fbcontrols.h.

Event: Drag and drop of an element.

Definition at line 1868 of file fbcontrols.h.

Event: Called upon node edition.

Definition at line 1869 of file fbcontrols.h.

Read Only Property: Count of selected items.

Definition at line 1871 of file fbcontrols.h.

Read Only Property: Count of visible items.

Definition at line 1872 of file fbcontrols.h.

Read Write Property: When OnExpanding occurs, set this to true to allow expansion.

Definition at line 1873 of file fbcontrols.h.

Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.

Definition at line 1874 of file fbcontrols.h.

Read Write Property: Tells whether multiple drag/drop is allowed or not.

Definition at line 1875 of file fbcontrols.h.

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.

Definition at line 1876 of file fbcontrols.h.

Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded.

Definition at line 1877 of file fbcontrols.h.

Read Write Property: Draw check boxe for each node.

Definition at line 1878 of file fbcontrols.h.

Read Write Property: On node selection, will draw entire line selected

Definition at line 1879 of file fbcontrols.h.

Read Write Property: Height of an item.

Definition at line 1880 of file fbcontrols.h.

Read Write Property: Tells whether multiple selection is allowed or not.

Definition at line 1881 of file fbcontrols.h.

Read Write Property: Set to true, to allow automatic node editing on second select.

Definition at line 1882 of file fbcontrols.h.

Read Only Property: Height of the tree.

Definition at line 1883 of file fbcontrols.h.

Read Only Property: Width of the tree.

Definition at line 1884 of file fbcontrols.h.

Read Write Property: Tells whether selection is allowed or not.

Definition at line 1885 of file fbcontrols.h.

Read Write Property: Tells whether node are deselected if parent node is collapsed.

Definition at line 1886 of file fbcontrols.h.

Read Write Property: Tells whether node are selected if drag is start and node is not already selected.

Definition at line 1887 of file fbcontrols.h.

Read Write Property: Tells whether node are selected if right click on node.

Definition at line 1888 of file fbcontrols.h.

Read Write Property: Hightlight node on right click.

Definition at line 1889 of file fbcontrols.h.

Read Write Property: Allow automatic scroll on expand, default is true.

Definition at line 1890 of file fbcontrols.h.

Read Write Property: Allow automatic expand on drag over, default is false.

Definition at line 1891 of file fbcontrols.h.

Read Write Property: Allow automatic expand on double click, default is false.

Definition at line 1892 of file fbcontrols.h.

Read Only Property: List of selected nodes.

Definition at line 1893 of file fbcontrols.h.


The documentation for this class was generated from the following file:

FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree
FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree FBTree