Wt  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
Wt::Ext::Panel Class Reference

A container with a title and standard GUI elements. More...

#include <Wt/Ext/Panel>

Inheritance diagram for Wt::Ext::Panel:
Inheritance graph
[legend]

Public Member Functions

 Panel (WContainerWidget *parent=0)
 Create a new panel. More...
 
 ~Panel ()
 Destruct a panel.
 
void setTopToolBar (ToolBar *toolBar)
 Set a tool bar at the top of the panel. More...
 
ToolBartopToolBar () const
 Return the top tool bar. More...
 
void setBottomToolBar (ToolBar *bottomBar)
 Set a tool bar at the bottom of the panel. More...
 
ToolBarbottomToolBar () const
 Return the top tool bar. More...
 
void addFooterButton (Button *button)
 Add a button to the footer of the panel. More...
 
void removeFooterButton (Button *button)
 Remove a button from the footer of the panel. More...
 
const std::vector< Button * > & footerButtons () const
 Retrn the list of footer buttons. More...
 
void setTitle (const WString &title)
 Set a title. More...
 
const WStringtitle () const
 Get the title. More...
 
void setTitleBar (bool enable)
 Show or hide a title bar for the panel. More...
 
bool titleBar () const
 Get the title bar. More...
 
void setAnimate (bool on)
 Set to use animations for the expand/collapse operation. More...
 
bool animate () const
 Return if using animations for expand/collapse. More...
 
void setAutoScrollBars (bool on)
 Option to show scroll bars when needed. More...
 
bool autoScrollBars () const
 Return if showing scroll bars when needed. More...
 
void setBorder (bool show)
 Change the border around the panel. More...
 
bool border () const
 Get the border setting. More...
 
void setCollapsed (bool on)
 Set the panel expanded or callapsed. More...
 
void collapse ()
 Collapse the panel. More...
 
void expand ()
 Expand the panel. More...
 
bool isCollapsed () const
 Return if the panel is collapsed. More...
 
void setCollapsible (bool on)
 Allow the user to collapse/expand the panel. More...
 
bool isCollapsible () const
 Return if the user may collapse/expand the panel. More...
 
void setResizable (bool on)
 Allow the user to resize the panel. More...
 
bool isResizable () const
 Return if the user may resize the panel. More...
 
JSignalcollapsed ()
 Signal emitted when the panel is collapsed. More...
 
JSignalexpanded ()
 Signal emitted when the panel is expanded. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
- Public Member Functions inherited from Wt::Ext::Container
 Container (WContainerWidget *parent=0)
 Create a new container. More...
 
virtual ~Container ()
 Destroy the container.
 
void setLayout (WLayout *layout)
 Set a layout manager for the container. More...
 
WLayoutlayout ()
 Get the layout manager that was set for the container. More...
 
- Public Member Functions inherited from Wt::Ext::Component
void setEnabled (bool how)
 Enables or disables the widget. More...
 
void enable ()
 Enables the widget.
 
void disable ()
 Disables the widget.
 
- Public Member Functions inherited from Wt::Ext::Widget
 ~Widget ()
 Delete a widget.
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget (WContainerWidget *parent=0)
 Construct a WebWidget with a given parent. 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 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())
 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 void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
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 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 &id)
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &javascript)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
void setLoadLaterWhenInvisible (bool)
 Change the way the widget is loaded when invisible. More...
 
const std::vector< WWidget * > & children () const
 Returns contained widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. 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 bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual void setFocus (bool focus)
 Sets focus. 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...
 
EventSignalblurred ()
 Signal emitted when the widget lost focus. More...
 
EventSignalfocussed ()
 Signal emitted when the widget recieved focus. 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...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. 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...
 
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::WWebWidget
static WString escapeText (const WString &text, bool newlinesToo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static std::string & escapeText (std::string &text, bool newlinestoo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static bool removeScript (WString &text)
 Remove tags/attributes from text that are not passive (deprecated). More...
 
static std::string jsStringLiteral (const std::string &v, char delimiter= '\'')
 Turn a UTF8 encoded string into a JavaScript string literal. More...
 
- Protected Member Functions inherited from Wt::Ext::Component
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A container with a title and standard GUI elements.

Like a Container, from which Panel derives, a panel organizes its contents using layout managers.

The panel provides standard user-interface elements, such as a title bar, top and bottom tool/menu bars, and footer buttons, and a panel may be configured to be resizable and collapsible.

Typically, panels will be added directly into a layout, and are components to organize your user interface. You may also add a panel to a plain container widget, but then you should set a size for the panel (using WWidget::resize()), in pixels.

When a panel is added to WApplication::root(), as single widget, it acts like a plain Container, and thus none of the panel specific features (tool bars, buttons, etc...) are available. If you want to have a top-level Panel, you need thus to do something like this:

// create the root container
Wt::Ext::Container *rootContainer = new Wt::Ext::Container(app->root());
// create the root panel and fit it inside the container
Wt::Ext::Panel *rootPanel = new Wt::Ext::Panel();
rootContainer->setLayout(new Wt::WFitLayout());
rootContainer->layout()->addWidget(rootPanel);

Constructor & Destructor Documentation

Wt::Ext::Panel::Panel ( WContainerWidget parent = 0)

Create a new panel.

When a parent is specified, or the panel is after construction added to a WContainerWidget, the panel should be given an explicit size in pixels, using WWidget::resize().

Member Function Documentation

void Wt::Ext::Panel::addFooterButton ( Button button)

Add a button to the footer of the panel.

The button is displayed below the contents, but above a bottom tool bar if it is set.

See Also
removeFooterButton(Button *), Dialog::addButton(Button *)
bool Wt::Ext::Panel::animate ( ) const

Return if using animations for expand/collapse.

See Also
setAnimate(bool)
bool Wt::Ext::Panel::autoScrollBars ( ) const

Return if showing scroll bars when needed.

See Also
setAutoScrollBars(bool)
bool Wt::Ext::Panel::border ( ) const

Get the border setting.

See Also
setBorder(bool)
ToolBar* Wt::Ext::Panel::bottomToolBar ( ) const

Return the top tool bar.

See Also
setBottomToolBar(ToolBar *), topToolBar()
void Wt::Ext::Panel::collapse ( )

Collapse the panel.

See Also
setCollapsible(bool on)
JSignal& Wt::Ext::Panel::collapsed ( )

Signal emitted when the panel is collapsed.

See Also
setCollapsible()
void Wt::Ext::Panel::expand ( )

Expand the panel.

See Also
setCollapsible(bool on)
JSignal& Wt::Ext::Panel::expanded ( )

Signal emitted when the panel is expanded.

See Also
setCollapsible()
const std::vector<Button *>& Wt::Ext::Panel::footerButtons ( ) const

Retrn the list of footer buttons.

See Also
addFooterButton(Button *), removeFooterButton(Button *)
bool Wt::Ext::Panel::isCollapsed ( ) const

Return if the panel is collapsed.

See Also
setCollapsed(bool)
collapsed() and expanded() signals
bool Wt::Ext::Panel::isCollapsible ( ) const

Return if the user may collapse/expand the panel.

See Also
setCollapsible()
bool Wt::Ext::Panel::isResizable ( ) const

Return if the user may resize the panel.

See Also
setResizable()
void Wt::Ext::Panel::refresh ( )
virtual

Refresh the widget.

The refresh method is invoked when the locale is changed using WApplication::setLocale() or when the user hit the refresh button.

The widget must actualize its contents in response.

Note
This does *not* rerender the widget! Calling refresh() usually does not have any effect (unless you've reimplemented refresh() to attach to it an effect).

Reimplemented from Wt::WWebWidget.

Reimplemented in Wt::Ext::TableView, Wt::Ext::MessageBox, and Wt::Ext::TabWidget.

void Wt::Ext::Panel::removeFooterButton ( Button button)

Remove a button from the footer of the panel.

Transfers ownership back, and so you must delete the button if you wish to destroy it.

See Also
addFooterButton(Button *), Dialog::removeButton(Button *)
void Wt::Ext::Panel::setAnimate ( bool  on)

Set to use animations for the expand/collapse operation.

By default, the expand/collapse operation of a panel is not animated. This setting is ignored if the panel is not collapsible.

See Also
animate(), setCollapsible(bool)
void Wt::Ext::Panel::setAutoScrollBars ( bool  on)

Option to show scroll bars when needed.

By default, scrollbars are disabled.

void Wt::Ext::Panel::setBorder ( bool  show)

Change the border around the panel.

By default, a panel has a small border around it. Set show false to disable the border.

See Also
border()
void Wt::Ext::Panel::setBottomToolBar ( ToolBar bottomBar)

Set a tool bar at the bottom of the panel.

Note: you can only set a tool bar before the panel is rendered.

See Also
bottomToolBar(), setTopToolBar(ToolBar *)
void Wt::Ext::Panel::setCollapsed ( bool  on)

Set the panel expanded or callapsed.

When on is true, the panel is collapsed, minimizing screen real estate.

Initially, a panel is expanded.

See Also
setCollapsible(bool on)
void Wt::Ext::Panel::setCollapsible ( bool  on)

Allow the user to collapse/expand the panel.

When on is true, a button is added to the title bar, which may be used to collapse/expand the panel.

By default, a panel is not collapsible.

See Also
isCollapsed(), isCollapsible(), setCollapsed(bool)
void Wt::Ext::Panel::setResizable ( bool  on)

Allow the user to resize the panel.

If true, then, depending on the layout the panel is in, a resize handle will be displayed at one of the panel borders.

By default, a panel may not be resized by the user.

void Wt::Ext::Panel::setTitle ( const WString title)

Set a title.

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

When the panel is added to a TabWidget, the title serves as the tab label.

See Also
title(), setTitleBar(bool)
void Wt::Ext::Panel::setTitleBar ( bool  enable)

Show or hide a title bar for the panel.

The title bar appears at the top of the panel, above the contents and the top tool bar (if there is one). By default, the title bar is not shown unless a title is set.

See Also
setTitle(const WString&)
void Wt::Ext::Panel::setTopToolBar ( ToolBar toolBar)

Set a tool bar at the top of the panel.

Note: you can only set a tool bar before the panel is rendered.

See Also
topToolBar(), setBottomToolBar(ToolBar *)
const WString& Wt::Ext::Panel::title ( ) const

Get the title.

See Also
setTitle(const WString&)
bool Wt::Ext::Panel::titleBar ( ) const

Get the title bar.

See Also
setTitleBar(bool)
ToolBar* Wt::Ext::Panel::topToolBar ( ) const

Return the top tool bar.

See Also
setTopToolBar(ToolBar *), bottomToolBar()

Generated on Mon Oct 20 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4