Wt  4.11.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
Wt::WTreeTableNode Class Reference

A specialized tree node which allows additional data to be associated with each node. More...

#include <Wt/WTreeTableNode.h>

Inheritance diagram for Wt::WTreeTableNode:
[legend]

Public Member Functions

 WTreeTableNode (const WString &labelText, std::unique_ptr< WIconPair > labelIcon=nullptr)
 Creates a new tree table node.
 
void setColumnWidget (int column, std::unique_ptr< WWidget > item)
 Sets a widget to be displayed in the given column for this node.
 
WWidgetcolumnWidget (int column)
 Returns the widget set for a column.
 
WTreeTabletable () const
 Returns the table for this node.
 
virtual void insertChildNode (int index, std::unique_ptr< WTreeNode > node) override
 Inserts a child node.
 
- Public Member Functions inherited from Wt::WTreeNode
 WTreeNode (const WString &labelText, std::unique_ptr< WIconPair > labelIcon=nullptr)
 Creates a tree node with the given label.
 
 ~WTreeNode ()
 Destructor.
 
virtual WTreetree () const
 Returns the tree.
 
WTextlabel () const
 Returns the label.
 
WIconPairlabelIcon () const
 Returns the label icon.
 
void setLabelIcon (std::unique_ptr< WIconPair > labelIcon)
 Sets the label icon.
 
WTreeNodeaddChildNode (std::unique_ptr< WTreeNode > node)
 Adds a child node.
 
std::unique_ptr< WTreeNoderemoveChildNode (WTreeNode *node)
 Removes a child node.
 
std::vector< WTreeNode * > childNodes () const
 Returns the list of children.
 
virtual int displayedChildCount () const
 Returns the number of children that should be displayed.
 
void setChildCountPolicy (ChildCountPolicy policy)
 Configures how and when the child count should be displayed.
 
ChildCountPolicy childCountPolicy () const
 Returns the child count policy.
 
void setLoadPolicy (ContentLoading loadPolicy)
 Sets the load policy for this tree.
 
bool isExpanded () const
 Returns whether this node is expanded.
 
virtual void setSelectable (bool selectable) override
 Allows this node to be selected.
 
virtual bool isSelectable () const
 Returns if this node may be selected.
 
WTreeNodeparentNode () const
 Returns the parent node.
 
void setNodeVisible (bool visible)
 Sets the visibility of the node itself.
 
void setChildrenDecorated (bool decorated)
 Sets whether this node's children are decorated.
 
void setInteractive (bool interactive)
 Sets whether this node is interactive.
 
void expand ()
 Expands this node.
 
void collapse ()
 Collapses this node.
 
EventSignal< WMouseEvent > & expanded ()
 Signal emitted when the node is expanded by the user.
 
EventSignal< WMouseEvent > & collapsed ()
 Signal emitted when the node is collapsed by the user.
 
Signal< bool > & selected ()
 Signal that is emitted when the node is added or removed from the selection
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget ()
 Creates a WCompositeWidget.
 
 WCompositeWidget (std::unique_ptr< WWidget > implementation)
 Creates a WCompositeWidget with given implementation.
 
virtual std::vector< WWidget * > children () const override
 Returns child widgets.
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget) override
 Removes a child widget.
 
virtual void setObjectName (const std::string &name) override
 Sets an object name.
 
virtual std::string objectName () const override
 Returns the object name.
 
virtual const std::string id () const override
 Returns the (unique) identifier for this object.
 
virtual void setPositionScheme (PositionScheme scheme) override
 Sets the CSS position scheme.
 
virtual PositionScheme positionScheme () const override
 Returns the CSS position scheme.
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
 Sets CSS offsets for a non-statically positioned widget.
 
virtual WLength offset (Side s) const override
 Returns a CSS offset.
 
virtual void resize (const WLength &width, const WLength &height) override
 Resizes the widget.
 
virtual WLength width () const override
 Returns the width.
 
virtual WLength height () const override
 Returns the height.
 
virtual void setMinimumSize (const WLength &width, const WLength &height) override
 Sets a minimum size.
 
virtual WLength minimumWidth () const override
 Returns the minimum width.
 
virtual WLength minimumHeight () const override
 Returns the minimum height.
 
virtual void setMaximumSize (const WLength &width, const WLength &height) override
 Sets a maximum size.
 
virtual WLength maximumWidth () const override
 Returns the maximum width.
 
virtual WLength maximumHeight () const override
 Returns the maximum height.
 
virtual void setLineHeight (const WLength &height) override
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const override
 Returns the CSS line height for contained text.
 
virtual void setFloatSide (Side s) override
 Specifies a CSS float side.
 
virtual Side floatSide () const override
 Returns the CSS float side.
 
virtual void setClearSides (WFlags< Side > sides) override
 Sets the sides that should be cleared of floats.
 
virtual WFlags< SideclearSides () const override
 Returns the sides that should remain empty.
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
 Sets CSS margins around the widget.
 
virtual WLength margin (Side side) const override
 Returns a CSS margin set.
 
virtual void setHiddenKeepsGeometry (bool enabled) override
 Sets whether the widget keeps its geometry when hidden.
 
virtual bool hiddenKeepsGeometry () const override
 Returns whether the widget keeps its geometry when hidden.
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
 Hides or shows the widget.
 
virtual bool isHidden () const override
 Returns whether the widget is set hidden.
 
virtual bool isVisible () const override
 Returns whether the widget is visible.
 
virtual void setDisabled (bool disabled) override
 Sets whether the widget is disabled.
 
virtual bool isDisabled () const override
 Returns whether the widget is set disabled.
 
virtual bool isEnabled () const override
 Returns whether the widget is enabled.
 
virtual void setPopup (bool popup) override
 Lets the widget overlay over other sibling widgets.
 
virtual bool isPopup () const override
 Returns whether the widget is overlayed.
 
virtual void setInline (bool isInline) override
 Sets whether the widget is displayed inline or as a block.
 
virtual bool isInline () const override
 Returns whether the widget is displayed inline or as block.
 
virtual void setDecorationStyle (const WCssDecorationStyle &style) override
 Sets a CSS decoration style.
 
virtual WCssDecorationStyledecorationStyle () override
 Returns the decoration style of this widget.
 
virtual void setStyleClass (const WString &styleClass) override
 Sets (one or more) CSS style classes.
 
virtual WString styleClass () const override
 Returns the CSS style class.
 
virtual void addStyleClass (const WString &styleClass, bool force=false) override
 Adds a CSS style class.
 
virtual void removeStyleClass (const WString &styleClass, bool force=false) override
 Removes a CSS style class.
 
virtual bool hasStyleClass (const WString &styleClass) const override
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto) override
 Sets the vertical alignment.
 
virtual AlignmentFlag verticalAlignment () const override
 Returns the vertical alignment.
 
virtual WLength verticalAlignmentLength () const override
 Returns the fixed vertical alignment that was set.
 
virtual void setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
 Sets a tooltip.
 
virtual WString toolTip () const override
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
 Enable deferred tooltip.
 
virtual void refresh () override
 Refresh the widget.
 
virtual void setAttributeValue (const std::string &name, const WString &value) override
 Sets an attribute value.
 
virtual WString attributeValue (const std::string &name) const override
 Returns an attribute value.
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value) override
 Sets a JavaScript member.
 
virtual std::string javaScriptMember (const std::string &name) const override
 Returns the value of a JavaScript member.
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args) override
 Calls a JavaScript member.
 
virtual void load () override
 Loads content just before the widget is used.
 
virtual bool loaded () const override
 Returns whether this widget has been loaded.
 
virtual void setCanReceiveFocus (bool enabled) override
 Sets whether the widget can receive focus.
 
virtual bool canReceiveFocus () const override
 Returns whether the widget can receive focus.
 
virtual void setFocus (bool focus) override
 Sets focus.
 
virtual bool setFirstFocus () override
 Set focus on the widget's first descendant.
 
virtual bool hasFocus () const override
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index) override
 Sets the tab index.
 
virtual int tabIndex () const override
 Returns the tab index.
 
virtual void setId (const std::string &id) override
 Sets the CSS Id.
 
virtual WWidgetfind (const std::string &name) override
 Finds a descendent widget by name.
 
virtual WWidgetfindById (const std::string &name) override
 Finds a descendent widget by id.
 
virtual void doJavaScript (const std::string &js) override
 Executes the given JavaScript statements when the widget is rendered or updated.
 
virtual void propagateSetEnabled (bool enabled) override
 Propagates that a widget was enabled or disabled through children.
 
virtual bool scrollVisibilityEnabled () const final override
 Returns whether scroll visibility detection is enabled for this widget.
 
virtual void setScrollVisibilityEnabled (bool enabled) final override
 Sets whether scroll visibility detection is enabled for this widget.
 
virtual int scrollVisibilityMargin () const final override
 Returns the margin around the viewport within which the widget is considered visible.
 
virtual void setScrollVisibilityMargin (int margin) final override
 Sets the margin around the viewport within which the widget is considered visible.
 
virtual Signal< bool > & scrollVisibilityChanged () final override
 Signal triggered when the scroll visibility of this widget changes.
 
virtual bool isScrollVisible () const final override
 Returns whether this widget is currently considered scroll visible.
 
virtual void setThemeStyleEnabled (bool enabled) final override
 Sets whether theme styling for a widget is enabled or disabled.
 
virtual bool isThemeStyleEnabled () const final override
 Returns whether this widget is currently styled by the chosen theme.
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget)
 Removes a child widget.
 
template<typename Widget >
std::unique_ptr< Widget > removeWidget (Widget *widget)
 Removes a child widget.
 
void setFocus ()
 Sets focus.
 
virtual void setFocus (bool focus)=0
 Sets focus.
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor.
 
WWidgetparent () const
 Returns the parent widget.
 
template<typename Widget >
std::unique_ptr< Widget > removeWidget (Widget *widget)
 Removes a child widget.
 
std::unique_ptr< WWidgetremoveFromParent ()
 Removes the widget from its parent.
 
void setWidth (const WLength &width)
 Sets the width.
 
void setHeight (const WLength &height)
 Sets the height.
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
 Positions a widget next to another widget.
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node.
 
void setFocus ()
 Sets focus.
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping.
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping.
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation.
 
bool isRendered () const
 Returns whether the widget is rendered.
 
void hide ()
 Hides the widget.
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation.
 
void show ()
 Shows the widget.
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation.
 
void enable ()
 Enables the widget.
 
void disable ()
 Disable thes widget.
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware.
 
- Public Member Functions inherited from Wt::WObject
void addChild (std::unique_ptr< WObject > child)
 Add a child WObject whose lifetime is determined by this WObject.
 
template<typename Child >
ChildaddChild (std::unique_ptr< Child > child)
 Add a child WObject, returning a raw pointer.
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
template<typename Child >
std::unique_ptr< ChildremoveChild (Child *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations.
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation.
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation.
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance.
 
void isNotStateless ()
 Marks the current function as not stateless.
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method.
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 Default constructor.
 
virtual ~observable ()
 Destructor.
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...)) noexcept
 Protects a method call against object destruction.
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...) const) const noexcept
 Protects a const method call against object destruction.
 
template<typename Function >
auto bindSafe (const Function &function) noexcept
 Protects a function against object destruction.
 

Protected Member Functions

virtual void setTable (WTreeTable *table)
 Sets the table for this node.
 
- Protected Member Functions inherited from Wt::WTreeNode
 WTreeNode ()
 Creates a tree node with empty labelArea().
 
WContainerWidgetlabelArea () const
 Accesses the container widget that holds the label area.
 
virtual void populate ()
 Populates the node dynamically on loading.
 
bool populated () const
 Returns whether this node has already been populated.
 
virtual bool expandable ()
 Returns whether this node can be expanded.
 
virtual void renderSelected (bool selected)
 Renders the node to be selected.
 
virtual void descendantRemoved (WTreeNode *node)
 Reacts to the removal of a descendant node.
 
virtual void descendantAdded (WTreeNode *node)
 Reacts to the addition of a descendant node.
 
virtual void doExpand ()
 The actual expand.
 
virtual void doCollapse ()
 The actual collapse.
 
virtual void undoDoExpand ()
 Undo method for doCollapse() stateless implementation.
 
virtual void undoDoCollapse ()
 Undo method for doCollapse() stateless implementation.
 
WIconPairexpandIcon () const
 Accesses the icon pair that allows expansion of the tree node.
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax () override
 Progresses to an Ajax-enabled widget.
 
void setImplementation (std::unique_ptr< WWidget > widget)
 Set the implementation widget.
 
template<typename Widget >
Widget * setImplementation (std::unique_ptr< Widget > widget)
 Sets the implementation widget, returning a raw pointer.
 
template<typename W , typename... Args>
WsetNewImplementation (Args &&... args)
 Creates the implementation widget and sets it, returning a raw pointer.
 
WWidgetimplementation ()
 Get the implementation widget.
 
virtual int boxPadding (Orientation orientation) const override
 Returns the widget's built-in padding.
 
virtual int boxBorder (Orientation orientation) const override
 Returns the widget's built-in border width.
 
virtual void render (WFlags< RenderFlag > flags) override
 Renders the widget.
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager.
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change.
 
 WWidget ()
 Creates a widget.
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event.
 
void scheduleRender (WFlags< RepaintFlag > flags=None)
 Schedules rerendering of the widget.
 
virtual WStatelessSlot * getStateless (Method method) override
 On-demand stateless slot implementation.
 

Additional Inherited Members

- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr()
 

Detailed Description

A specialized tree node which allows additional data to be associated with each node.

Additional data for each column can be set using setColumnWidget().

See also
WTreeNode, WTreeTable

Constructor & Destructor Documentation

◆ WTreeTableNode()

Wt::WTreeTableNode::WTreeTableNode ( const WString labelText,
std::unique_ptr< WIconPair labelIcon = nullptr 
)

Creates a new tree table node.

See also
WTreeNode::WTreeNode()

Member Function Documentation

◆ columnWidget()

WWidget * Wt::WTreeTableNode::columnWidget ( int  column)

Returns the widget set for a column.

Returns the widget set previously using setColumnWidget(), or 0 if no widget was previously set.

◆ insertChildNode()

void Wt::WTreeTableNode::insertChildNode ( int  index,
std::unique_ptr< WTreeNode node 
)
overridevirtual

Inserts a child node.

Inserts the node node at index index.

Reimplemented from Wt::WTreeNode.

◆ setColumnWidget()

void Wt::WTreeTableNode::setColumnWidget ( int  column,
std::unique_ptr< WWidget item 
)

Sets a widget to be displayed in the given column for this node.

Columns are counted starting from 0 for the tree list itself, and 1 for the first additional column.

The node label (in column 0) is not considered a column widget. To set a custom widget in column 0, you can add a widget to the labelArea().

◆ setTable()

void Wt::WTreeTableNode::setTable ( WTreeTable table)
protectedvirtual

Sets the table for this node.

This method is called when the node is inserted, directly, or indirectly into a table.

You may want to reimplement this method if you wish to customize the behaviour of the node depending on table properties. For example to only associate data with the node when the tree list is actually used inside a table.

See also
WTreeTableNode::table()

◆ table()

WTreeTable * Wt::WTreeTableNode::table ( ) const

Returns the table for this node.

See also
WTreeTableNode::setTable()