Wt::WTree Class Reference
A widget that represents a navigatable tree. More...
#include <Wt/WTree>
Inheritance diagram for Wt::WTree:
Public Types | |
| typedef std::set< WTreeNode * > | WTreeNodeSet |
| Typedef for a set of WTreeNode's. | |
Public Member Functions | |
| WTree (WContainerWidget *parent=0) | |
| Create a new tree. | |
| void | setTreeRoot (WTreeNode *root) |
| Set the tree root node. | |
| WTreeNode * | treeRoot () const |
| Get the root node. | |
| void | setSelectionMode (SelectionMode mode) |
| Set the selection mode. | |
| SelectionMode | selectionMode () const |
| Get the selection mode. | |
| const WTreeNodeSet & | selectedNodes () const |
| Get the set of selected tree nodes. | |
| void | select (const WTreeNodeSet &nodes) |
| Set a selection of tree nodes. | |
| void | select (WTreeNode *node, bool selected=true) |
| Select or unselect the given node. | |
| bool | isSelected (WTreeNode *node) const |
| Return if the given node is currently selected. | |
| void | clearSelection () |
| Clear the current selection. | |
Public Attributes | |
| Signal | itemSelectionChanged |
| Signal that is emitted when the selection changes. | |
Detailed Description
A widget that represents a navigatable tree.WTree provides a tree widget, and coordinates selection functionality.
Unlike the MVC-based WTreeView widget, the tree renders a widget hierarchy, rather than a hierarhical standard model. This provides extra flexibility (as any widget can be used as contents), at the cost of server-side, client-side and bandwidth resources (especially for large tree tables).
The tree is implemented as a hierarchy of WTreeNode widgets.
Selection is rendered by calling WTreeNode::renderSelected(bool). Only tree nodes that are selectable may participate in the selection.
Member Function Documentation
| void Wt::WTree::setTreeRoot | ( | WTreeNode * | root | ) |
| WTreeNode* Wt::WTree::treeRoot | ( | ) | const [inline] |
| void Wt::WTree::setSelectionMode | ( | SelectionMode | mode | ) |
Set the selection mode.
The default selection mode is Wt::NoSelection.
