Wt  3.3.8
Public Member Functions | List of all members
Wt::WPanel Class Reference

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

#include <Wt/WPanel>

Inheritance diagram for Wt::WPanel:
Inheritance graph
[legend]

Public Member Functions

 WPanel (WContainerWidget *parent=0)
 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...
 
WContainerWidgettitleBarWidget () 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 (WWidget *)
 Sets the central widget. More...
 
WWidgetcentralWidget () const
 Returns the central widget. More...
 
Signalcollapsed ()
 Signal emitted when the panel is collapsed. More...
 
Signalexpanded ()
 Signal emitted when the panel is expanded. More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget (WContainerWidget *parent=0)
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (WWidget *implementation, WContainerWidget *parent)
 Creates a WCompositeWidget with given implementation. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name)
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(finaloverride)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. 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=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
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. 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...
 
void addChild (WObject *child)
 Adds a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

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...
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (WWidget *widget)
 Set the implementation widget. More...
 
WWidgetimplementation ()
 Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
virtual void render (WFlags< RenderFlag > flags)
 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 (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. 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:

Wt::WPanel *panel = new Wt::WPanel();
panel->setTitle("A panel");
panel->setCentralWidget(new Wt::WText("This is the panel contents"));
panel->setCollapsible(true);
WPanel-default-1.png
Two panels: one collapsed and one expanded (default theme)
WPanel-polished-1.png
Two panels: one collapsed and one expanded (polished theme)

Member Function Documentation

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

Returns the central widget.

See also
setCentralWidget()
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()
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()
void Wt::WPanel::expand ( )

Collapses the panel.

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

See also
setCollapsible(bool), expand()
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()
bool Wt::WPanel::isCollapsed ( ) const

Returns if the panel is collapsed.

See also
setCollapsed(bool)
collapsed(), expanded()
bool Wt::WPanel::isCollapsible ( ) const

Returns if the panel can be collapsed by the user.

See also
setCollapsible(bool)
void Wt::WPanel::setAnimation ( const WAnimation transition)

Sets an animation.

The animation is used when collapsing or expanding the panel.

void Wt::WPanel::setCentralWidget ( WWidget w)

Sets the central widget.

Sets the widget that is the contents of the panel. When a widget was previously set, the old widget is deleted first.

The default value is 0 (no widget set).

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.

See also
setCollapsible(bool)
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.

The default value is false.

See also
setTitleBar(bool), setCollapsed(bool), isCollapsed()
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)
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.

See also
setTitle(const WString&), setCollapsible(bool)
WString Wt::WPanel::title ( ) const

Returns the title.

See also
setTitle(const WString&)
bool Wt::WPanel::titleBar ( ) const

Returns if a title bar is set.

See also
setTitleBar(bool)
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()

Generated on Mon Sep 4 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11