Wt: Wt::WPanel Class Reference

Wt 4.10.4

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

A WPanel provides a container with a title bar. More...

`#include <Wt/WPanel.h>`

Inheritance diagram for Wt::WPanel:
[legend]

## Public Member Functions
| WPanel ()
| Creates a panel.
void | setTitle (const WString &title)
| Sets a title.
WString | title () const
| Returns the title.
void | setTitleBar (bool enable)
| Shows or hides the title bar for the panel.
bool | titleBar () const
| Returns if a title bar is set.
WContainerWidget * | titleBarWidget () const
| Returns the title bar widget.
void | setCollapsible (bool on)
| Makes the panel collapsible.
bool | isCollapsible () const
| Returns if the panel can be collapsed by the user.
void | setCollapsed (bool on)
| Sets the panel expanded or collapsed.
bool | isCollapsed () const
| Returns if the panel is collapsed.
void | collapse ()
| Collapses the panel.
void | expand ()
| Collapses the panel.
void | setAnimation (const WAnimation &transition)
| Sets an animation.
void | setCentralWidget (std::unique_ptr< WWidget > widget)
| Sets the central widget.
WWidget * | centralWidget () const
| Returns the central widget.
Signal & | collapsed ()
| Signal emitted when the panel is collapsed.
Signal & | expanded ()
| Signal emitted when the panel is expanded.
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< WWidget > | removeWidget (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< Side > | clearSides () 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 WCssDecorationStyle & | decorationStyle () 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 WWidget * | find (const std::string &name) override
| Finds a descendent widget by name.
virtual WWidget * | findById (const std::string &name) override
| Finds a descendent widget by id.
virtual void | setSelectable (bool selectable) override
| Sets as selectable.
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.
template<typename Widget >
std::unique_ptr< Widget > | removeWidget (Widget *widget)
| Removes a child widget.
void | setFocus ()
| Sets focus.
Public Member Functions inherited from Wt::WWidget
virtual | ~WWidget ()
| Destructor.
WWidget * | parent () const
| Returns the parent widget.
template<typename Widget >
std::unique_ptr< Widget > | removeWidget (Widget *widget)
| Removes a child widget.
std::unique_ptr< WWidget > | removeFromParent ()
| 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 >
Child * | addChild (std::unique_ptr< Child > child)
| Add a child WObject, returning a raw pointer.
std::unique_ptr< WObject > | removeChild (WObject *child)
| Remove a child WObject, so its lifetime is no longer determined by this WObject.
template<typename Child >
std::unique_ptr< Child > | removeChild (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
void | enableAjax () override
| Progresses to an Ajax-enabled widget.
Protected Member Functions inherited from Wt::WCompositeWidget
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>
W * | setNewImplementation (Args &&... args)
| Creates the implementation widget and sets it, returning a raw pointer.
WWidget * | implementation ()
| 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.
Protected Member Functions inherited from Wt::WObject

## 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()
Static Public Member Functions inherited from Wt::WObject
Static Public Attributes inherited from Wt::WWidget
Protected Types inherited from Wt::WWidget
Static Protected Attributes inherited from Wt::WWidget

## Detailed Description

A WPanel provides a container with a title bar.

The panel provides a container with an optional title bar, and an optional collapse icon.

Usage example:

auto panel = std::make_unique<Wt::WPanel>();
panel->setTitle("A panel");
panel->setCentralWidget(std::make_unique<Wt::WText>("This is the panel contents"));
panel->setCollapsible(true);
Two panels: one collapsed and one expanded (default theme)
Two panels: one collapsed and one expanded (polished theme)

## Member Function Documentation

## ◆ centralWidget()

WWidget * Wt::WPanel::centralWidget | ( |  | ) | const

Returns the central widget.

See also
  setCentralWidget()

## ◆ collapse()

void Wt::WPanel::collapse | ( |  | ) |

Collapses the panel.

When isCollapsible() is true, the panel is collapsed to minimize screen real-estate.

See also
  setCollapsible(bool), expand()

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but collapsing and expanding from C++, and the accompanying signals is not supported.

## ◆ collapsed()

Signal & Wt::WPanel::collapsed | ( |  | ) |

Signal emitted when the panel is collapsed.

Signal emitted when the panel is collapsed. The signal is only emitted when the panel is collapsed by the user using the collapse icon in the tible bar, not when calling setCollapsed(bool).

See also
  expanded()

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but it's not possible to set the animation.

## ◆ enableAjax()

void Wt::WPanel::enableAjax | ( |  | ) |
| overrideprotectedvirtual

Progresses to an Ajax-enabled widget.

This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

See also
  WApplication::enableAjax()

Reimplemented from Wt::WCompositeWidget.

## ◆ expand()

void Wt::WPanel::expand | ( |  | ) |

Collapses the panel.

When isCollapsible() is true, the panel is expanded to its original state.

See also
  setCollapsible(bool), expand()

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but collapsing and expanding from C++, and the accompanying signals is not supported.

## ◆ expanded()

Signal & Wt::WPanel::expanded | ( |  | ) |

Signal emitted when the panel is expanded.

Signal emitted when the panel is expanded. The signal is only emitted when the panel is expanded by the user using the expand icon in the title bar, not when calling setCollapsed(bool).

See also
  collapsed()

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but it's not possible to set the animation.

## ◆ isCollapsed()

bool Wt::WPanel::isCollapsed | ( |  | ) | const

Returns if the panel is collapsed.

See also
  setCollapsed(bool)
  collapsed(), expanded()

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but collapsing and expanding from C++, and the accompanying signals is not supported.

## ◆ isCollapsible()

bool Wt::WPanel::isCollapsible | ( |  | ) | const

Returns if the panel can be collapsed by the user.

See also
  setCollapsible(bool)

## ◆ setAnimation()

void Wt::WPanel::setAnimation | ( | const WAnimation & | transition | ) |

Sets an animation.

The animation is used when collapsing or expanding the panel.

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but it's not possible to set the animation.

## ◆ setCentralWidget()

void Wt::WPanel::setCentralWidget | ( | std::unique_ptr< WWidget > | widget | ) |

Sets the central widget.

Sets the widget that is the contents of the panel.

The default value is `0` (no widget set).

## ◆ setCollapsed()

void Wt::WPanel::setCollapsed | ( | bool | on | ) |

Sets the panel expanded or collapsed.

When `on` is `true`, equivalent to collapse(), otherwise to expand().

The default value is `false`.

If the panel is collapsed, the Wt-collapsed style class is added.

See also
  setCollapsible(bool)

Note
  It is possible to make a WPanel collapsible with WBootstrap5Theme, but collapsing and expanding from C++, and the accompanying signals is not supported.

## ◆ setCollapsible()

void Wt::WPanel::setCollapsible | ( | bool | on | ) |

Makes the panel collapsible.

When `on` is `true`, a collapse/expand icon is added to the title bar. This also calls setTitleBar(true) to enable the title bar.

Additionally, the Wt-collapsible class is added to the panel.

The default value is `false`.

See also
  setTitleBar(bool), setCollapsed(bool), isCollapsed()

## ◆ setTitle()

void Wt::WPanel::setTitle | ( | const WString & | title | ) |

Sets a title.

The panel title is set in the title bar. This method also makes the title bar visible by calling setTitleBar(true).

The default value is "" (no title).

See also
  title(), setTitleBar(bool)

## ◆ setTitleBar()

void Wt::WPanel::setTitleBar | ( | bool | enable | ) |

Shows or hides the title bar for the panel.

The title bar appears at the top of the panel.

The default value is `false:` the title bar is not shown unless a title is set or the panel is made collapsible.

If the title bar is hidden, the panel is automatically made non-collapsible, and expands if it was collapsed.

See also
  setTitle(const WString&), setCollapsible(bool)

## ◆ title()

WString Wt::WPanel::title | ( |  | ) | const

Returns the title.

See also
  setTitle(const WString&)

## ◆ titleBar()

bool Wt::WPanel::titleBar | ( |  | ) | const

Returns if a title bar is set.

See also
  setTitleBar(bool)

## ◆ titleBarWidget()

WContainerWidget * Wt::WPanel::titleBarWidget | ( |  | ) | const

Returns the title bar widget.

The title bar widget contains the collapse/expand icon (if the panel isCollapsible()), and the title text (if a title was set using setTitle()). You can access the title bar widget to customize the contents of the title.

The method returns `0` if titleBar() is `false`. You need to call setTitleBar() first.

See also
  setTitleBar()