/usr/include/Wt/WTree is in libwt-dev 3.3.3+dfsg-4.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WTREE_H_
#define WTREE_H_
#include <set>
#include <Wt/WCompositeWidget>
#include <Wt/WSignalMapper>
namespace Wt {
namespace Impl {
class SentinelTreeNode;
}
class WTreeNode;
/*! \class WTree Wt/WTree Wt/WTree
* \brief A widget that represents a navigatable tree
*
* %WTree provides a tree widget, and coordinates selection
* functionality.
*
* Unlike the MVC-based WTreeView, 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 \link WTreeNode::setSelectable(bool) selectable\endlink
* may participate in the selection.
*
* \if cpp
* Usage example:
* \code
* Wt::WIconPair *folderIcon = new Wt::WIconPair("icons/yellow-folder-closed.png",
* "icons/yellow-folder-open.png", false);
*
* Wt::WTree *tree = new Wt::WTree();
* tree->setSelectionMode(Wt::SingleSelection);
*
* Wt::WTreeNode *root = new Wt::WTreeNode("Tree root", folderIcon);
* root->setStyleClass("example-tree");
* tree->setTreeRoot(root);
* root->label()->setTextFormat(Wt::PlainText);
* root->setImagePack("resources/");
* root->setLoadPolicy(Wt::WTreeNode::NextLevelLoading);
* root->addChildNode(new Wt::WTreeNode("one"));
* root->addChildNode(new Wt::WTreeNode("two"));
*
* Wt::WTreeNode *three = new Wt::WTreeNode("three");
* three->addChildNode(new WTreeNode("three: one"));
* three->addChildNode(new WTreeNode("three: two"));
* root->addChildNode(three);
*
* root->expand();
* \endcode
* \endif
*
* A screenshot of the tree:
* <TABLE border="0" align="center"> <TR> <TD>
* \image html WTree-default-1.png "An example WTree (default)"
* </TD> <TD>
* \image html WTree-polished-1.png "An example WTree (polished)"
* </TD> </TR> </TABLE>
*
* \sa WTreeNode, WTreeTable, WTreeView
*/
class WT_API WTree : public WCompositeWidget
{
public:
/*! \brief Creates a new tree.
*/
WTree(WContainerWidget *parent = 0);
/*! \brief Sets the tree root node.
*
* The initial value is \c 0.
*/
void setTreeRoot(WTreeNode *root);
/*! \brief Returns the root node.
*
* \sa setTreeRoot()
*/
WTreeNode *treeRoot() const { return treeRoot_; }
/*! \brief Sets the selection mode.
*
* The default selection mode is Wt::NoSelection.
*/
void setSelectionMode(SelectionMode mode);
/*! \brief Returns the selection mode.
*/
SelectionMode selectionMode() const { return selectionMode_; }
/*! \brief Typedef for a set of WTreeNode's.
*/
typedef std::set<WTreeNode *> WTreeNodeSet;
/*! \brief Returns the set of selected tree nodes.
*/
const WTreeNodeSet& selectedNodes() const { return selection_; }
/*! \brief Sets a selection of tree nodes.
*/
void select(const WTreeNodeSet& nodes);
/*! \brief Selects or unselect the given <i>node</i>.
*/
void select(WTreeNode *node, bool selected = true);
/*! \brief Returns if the given <i>node</i> is currently selected.
*/
bool isSelected(WTreeNode *node) const;
/*! \brief Clears the current selection.
*/
void clearSelection();
/*! \brief %Signal that is emitted when the selection changes.
*/
Signal<>& itemSelectionChanged() { return itemSelectionChanged_; }
private:
WTreeNode *treeRoot_;
Impl::SentinelTreeNode *sentinelRoot_;
SelectionMode selectionMode_;
WTreeNodeSet selection_;
Signal<> itemSelectionChanged_;
void onClick(WTreeNode *node, WMouseEvent event);
void selectRange(WTreeNode *from, WTreeNode *to);
void extendSelection(WTreeNode *node);
protected:
void nodeRemoved(WTreeNode *node);
void nodeAdded(WTreeNode * const node);
friend class Impl::SentinelTreeNode;
};
}
#endif // WTREE_H_
|