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]

List of all members.

Public Member Functions

 WPanel (WContainerWidget *parent=0)
 Construct a panel.
void setTitle (const WString &title)
 Set a title.
WString title () const
 Get the title.
void setTitleBar (bool enable)
 Show or hide a title bar for the panel.
bool titleBar () const
 Returns if a title bar is set.
void setCollapsible (bool on)
 Make the panel collapsible.
bool isCollapsible () const
 Returns if the panel can be collapsed by the user.
void setCollapsed (bool on)
 Set the panel expanded or collapsed.
bool isCollapsed () const
 Returns if the panel is collapsed.
void collapse ()
 Collapse the panel.
void expand ()
 Collapse the panel.
void setCentralWidget (WWidget *)
 Set the central widget.
WWidgetcentralWidget () const
 Return the central widget.
Signalcollapsed ()
 Signal emitted when the panel is collapsed.
Signalexpanded ()
 Signal emitted when the panel is expanded.


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-1.png

Two panels: the top panel is collapsed, and the bottom panel expanded

Note:
This widget is in development. It will provide features similar to the Ext::Panel.
See also:
Ext::Panel

Member Function Documentation

void Wt::WPanel::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).

The default value is "" (no title).

See also:
title(), setTitleBar(bool)

WString Wt::WPanel::title (  )  const

Get the title.

See also:
setTitle(const WString&)

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

Show or hide a 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)

bool Wt::WPanel::titleBar (  )  const [inline]

Returns if a title bar is set.

See also:
setTitleBar(bool)

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

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

bool Wt::WPanel::isCollapsible (  )  const [inline]

Returns if the panel can be collapsed by the user.

See also:
setCollapsible(bool)

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

Set the panel expanded or collapsed.

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

The default value is false.

See also:
setCollapsible(bool)

bool Wt::WPanel::isCollapsed (  )  const

Returns if the panel is collapsed.

See also:
setCollapsed(bool)

collapsed(), expanded()

void Wt::WPanel::collapse (  ) 

Collapse the panel.

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

See also:
setCollapsible(bool), expand()

void Wt::WPanel::expand (  ) 

Collapse the panel.

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

See also:
setCollapsible(bool), expand()

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

Set 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).

WWidget* Wt::WPanel::centralWidget (  )  const [inline]

Return the central widget.

See also:
setCentralWidget()

Signal& Wt::WPanel::collapsed (  )  [inline]

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

Signal& Wt::WPanel::expanded (  )  [inline]

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


Generated on Tue Nov 3 15:34:33 2009 for Wt by doxygen 1.5.6