Wt::WPanel Class Reference

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

#include <Wt/WPanel.h>

Inheritance diagram for Wt::WPanel:

Public Member Functions
	WPanel ()
	Creates a panel.
void	setTitle (const WString &title)
	Sets a title. More...
WString	title () const
	Returns the title. More...
void	setTitleBar (bool enable)
	Shows or hides the title bar for the panel. More...
bool	titleBar () const
	Returns if a title bar is set. More...
WContainerWidget *	titleBarWidget () const
	Returns the title bar widget. More...
void	setCollapsible (bool on)
	Makes the panel collapsible. More...
bool	isCollapsible () const
	Returns if the panel can be collapsed by the user. More...
void	setCollapsed (bool on)
	Sets the panel expanded or collapsed. More...
bool	isCollapsed () const
	Returns if the panel is collapsed. More...
void	collapse ()
	Collapses the panel. More...
void	expand ()
	Collapses the panel. More...
void	setAnimation (const WAnimation &transition)
	Sets an animation. More...
void	setCentralWidget (std::unique_ptr< WWidget > widget)
	Sets the central widget. More...
WWidget *	centralWidget () const
	Returns the central widget. More...
Signal &	collapsed ()
	Signal emitted when the panel is collapsed. More...
Signal &	expanded ()
	Signal emitted when the panel is expanded. More...
Public Member Functions inherited from Wt::WCompositeWidget
	WCompositeWidget ()
	Creates a WCompositeWidget. More...
	WCompositeWidget (std::unique_ptr< WWidget > implementation)
	Creates a WCompositeWidget with given implementation. More...
virtual std::vector< WWidget * >	children () const override
	Returns child widgets. More...
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. More...
virtual std::string	objectName () const override
	Returns the object name. More...
virtual const std::string	id () const override
	Returns the (unique) identifier for this object. More...
virtual void	setPositionScheme (PositionScheme scheme) override
	Sets the CSS position scheme. More...
virtual PositionScheme	positionScheme () const override
	Returns the CSS position scheme. More...
virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
	Sets CSS offsets for a non-statically positioned widget. More...
virtual WLength	offset (Side s) const override
	Returns a CSS offset. More...
virtual void	resize (const WLength &width, const WLength &height) override
	Resizes the widget. More...
virtual WLength	width () const override
	Returns the width. More...
virtual WLength	height () const override
	Returns the height. More...
virtual void	setMinimumSize (const WLength &width, const WLength &height) override
	Sets a minimum size. More...
virtual WLength	minimumWidth () const override
	Returns the minimum width. More...
virtual WLength	minimumHeight () const override
	Returns the minimum height. More...
virtual void	setMaximumSize (const WLength &width, const WLength &height) override
	Sets a maximum size. More...
virtual WLength	maximumWidth () const override
	Returns the maximum width. More...
virtual WLength	maximumHeight () const override
	Returns the maximum height. More...
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. More...
virtual void	setFloatSide (Side s) override
	Specifies a CSS float side. More...
virtual Side	floatSide () const override
	Returns the CSS float side. More...
virtual void	setClearSides (WFlags< Side > sides) override
	Sets the sides that should be cleared of floats. More...
virtual WFlags< Side >	clearSides () const override
	Returns the sides that should remain empty. More...
virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
	Sets CSS margins around the widget. More...
virtual WLength	margin (Side side) const override
	Returns a CSS margin set. More...
virtual void	setHiddenKeepsGeometry (bool enabled) override
	Sets whether the widget keeps its geometry when hidden. More...
virtual bool	hiddenKeepsGeometry () const override
	Returns whether the widget keeps its geometry when hidden. More...
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
	Hides or shows the widget. More...
virtual bool	isHidden () const override
	Returns whether the widget is set hidden. More...
virtual bool	isVisible () const override
	Returns whether the widget is visible. More...
virtual void	setDisabled (bool disabled) override
	Sets whether the widget is disabled. More...
virtual bool	isDisabled () const override
	Returns whether the widget is set disabled. More...
virtual bool	isEnabled () const override
	Returns whether the widget is enabled. More...
virtual void	setPopup (bool popup) override
	Lets the widget overlay over other sibling widgets. More...
virtual bool	isPopup () const override
	Returns whether the widget is overlayed. More...
virtual void	setInline (bool isInline) override
	Sets whether the widget is displayed inline or as a block. More...
virtual bool	isInline () const override
	Returns whether the widget is displayed inline or as block. More...
virtual void	setDecorationStyle (const WCssDecorationStyle &style) override
	Sets a CSS decoration style. More...
virtual WCssDecorationStyle &	decorationStyle () override
	Returns the decoration style of this widget. More...
virtual void	setStyleClass (const WString &styleClass) override
	Sets (one or more) CSS style classes. More...
virtual WString	styleClass () const override
	Returns the CSS style class. More...
virtual void	addStyleClass (const WString &styleClass, bool force=false) override
	Adds a CSS style class. More...
virtual void	removeStyleClass (const WString &styleClass, bool force=false) override
	Removes a CSS style class. More...
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. More...
virtual AlignmentFlag	verticalAlignment () const override
	Returns the vertical alignment. More...
virtual WLength	verticalAlignmentLength () const override
	Returns the fixed vertical alignment that was set. More...
virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
	Sets a tooltip. More...
virtual WString	toolTip () const override
	Returns the tooltip.
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
	Enable deferred tooltip. More...
virtual void	refresh () override
	Refresh the widget. More...
virtual void	setAttributeValue (const std::string &name, const WString &value) override
	Sets an attribute value. More...
virtual WString	attributeValue (const std::string &name) const override
	Returns an attribute value. More...
virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override
	Sets a JavaScript member. More...
virtual std::string	javaScriptMember (const std::string &name) const override
	Returns the value of a JavaScript member. More...
virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override
	Calls a JavaScript member. More...
virtual void	load () override
	Loads content just before the widget is used. More...
virtual bool	loaded () const override
	Returns whether this widget has been loaded. More...
virtual void	setCanReceiveFocus (bool enabled) override
	Sets whether the widget can receive focus. More...
virtual bool	canReceiveFocus () const override
	Returns whether the widget can receive focus. More...
virtual void	setFocus (bool focus) override
	Sets focus. More...
virtual bool	setFirstFocus () override
	Set focus on the widget's first descendant. More...
virtual bool	hasFocus () const override
	Returns whether the widget currently has the focus.
virtual void	setTabIndex (int index) override
	Sets the tab index. More...
virtual int	tabIndex () const override
	Returns the tab index. More...
virtual void	setId (const std::string &id) override
	Sets the CSS Id. More...
virtual WWidget *	find (const std::string &name) override
	Finds a descendent widget by name. More...
virtual WWidget *	findById (const std::string &name) override
	Finds a descendent widget by id.
virtual void	setSelectable (bool selectable) override
	Sets as selectable. More...
virtual void	doJavaScript (const std::string &js) override
	Executes the given JavaScript statements when the widget is rendered or updated. More...
virtual void	propagateSetEnabled (bool enabled) override
	Propagates that a widget was enabled or disabled through children. More...
virtual bool	scrollVisibilityEnabled () const final override
	Returns whether scroll visibility detection is enabled for this widget. More...
virtual void	setScrollVisibilityEnabled (bool enabled) final override
	Sets whether scroll visibility detection is enabled for this widget. More...
virtual int	scrollVisibilityMargin () const final override
	Returns the margin around the viewport within which the widget is considered visible. More...
virtual void	setScrollVisibilityMargin (int margin) final override
	Sets the margin around the viewport within which the widget is considered visible. More...
virtual Signal< bool > &	scrollVisibilityChanged () final override
	Signal triggered when the scroll visibility of this widget changes. More...
virtual bool	isScrollVisible () const final override
	Returns whether this widget is currently considered scroll visible. More...
virtual void	setThemeStyleEnabled (bool enabled) final override
	Sets whether theme styling for a widget is enabled or disabled. More...
virtual bool	isThemeStyleEnabled () const final override
	Returns whether this widget is currently styled by the chosen theme. More...
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)
	Removes a child widget.
template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...
void	setFocus ()
	Sets focus. More...
virtual void	setFocus (bool focus)=0
	Sets focus. More...
Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...
WWidget *	parent () const
	Returns the parent widget.
template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...
std::unique_ptr< WWidget >	removeFromParent ()
	Removes the widget from its parent. More...
void	setWidth (const WLength &width)
	Sets the width. More...
void	setHeight (const WLength &height)
	Sets the height. More...
virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
	Positions a widget next to another widget. More...
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. More...
void	setFocus ()
	Sets focus. More...
virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...
virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...
virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...
bool	isRendered () const
	Returns whether the widget is rendered. More...
void	hide ()
	Hides the widget. More...
void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...
void	show ()
	Shows the widget. More...
void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...
void	enable ()
	Enables the widget. More...
void	disable ()
	Disable thes widget. More...
bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...
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. More...
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. More...
void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...
template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)(), void(T::*undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...
void	isNotStateless ()
	Marks the current function as not stateless. More...
template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...
Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
	Default constructor.
virtual	~observable ()
	Destructor. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...)) noexcept
	Protects a method call against object destruction. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
	Protects a const method call against object destruction. More...
template<typename Function >
auto	bindSafe (const Function &function) noexcept
	Protects a function against object destruction. More...

Protected Member Functions
void	enableAjax () override
	Progresses to an Ajax-enabled widget. More...
Protected Member Functions inherited from Wt::WCompositeWidget
void	setImplementation (std::unique_ptr< WWidget > widget)
	Set the implementation widget. More...
template<typename Widget >
Widget *	setImplementation (std::unique_ptr< Widget > widget)
	Sets the implementation widget, returning a raw pointer. More...
template<typename W , typename... Args>
W *	setNewImplementation (Args &&... args)
	Creates the implementation widget and sets it, returning a raw pointer. More...
WWidget *	implementation ()
	Get the implementation widget. More...
virtual int	boxPadding (Orientation orientation) const override
	Returns the widget's built-in padding. More...
virtual int	boxBorder (Orientation orientation) const override
	Returns the widget's built-in border width. More...
virtual void	render (WFlags< RenderFlag > flags) override
	Renders the widget. More...
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. More...
virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...
	WWidget ()
	Creates a widget.
virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...
void	scheduleRender (WFlags< RepaintFlag > flags=None)
	Schedules rerendering of the widget. More...
virtual WStatelessSlot *	getStateless (Method method) override
	On-demand stateless slot implementation. More...

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() More...

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()