Wt
3.2.3
|
A container widget that stacks its widgets on top of each other. More...
#include <Wt/WStackedWidget>
Public Member Functions | |
WStackedWidget (WContainerWidget *parent=0) | |
Creates a new stack. | |
virtual void | addWidget (WWidget *widget) |
Adds a child widget to this container. | |
int | currentIndex () const |
Returns the index of the widget that is currently shown. | |
WWidget * | currentWidget () const |
Returns the widget that is currently shown. | |
void | insertWidget (int index, WWidget *widget) |
Insert a widget at a given index. | |
void | setCurrentIndex (int index) |
Changes the current widget. | |
void | setCurrentIndex (int index, const WAnimation &animation, bool autoReverse=true) |
Changes the current widget using a custom animation. | |
void | setCurrentWidget (WWidget *widget) |
Changes the current widget. | |
void | setTransitionAnimation (const WAnimation &animation, bool autoReverse=false) |
Specifies an animation used during transitions. |
A container widget that stacks its widgets on top of each other.
This is a container widget which at all times has only one item visible. The widget accomplishes this using setHidden(bool) on the children.
Using currentIndex() and setCurrentIndex(int index) you can retrieve or set the visible widget.
WStackedWidget, like WContainerWidget, is by default not inline.
The widget is rendered using an HTML <div>
tag and does not provide styling. It can be styled using inline or external CSS as appropriate.
void Wt::WStackedWidget::addWidget | ( | WWidget * | widget | ) | [virtual] |
Adds a child widget to this container.
This is equivalent to passing this container as the parent when constructing the child. The widget is appended to the list of children, and thus also layed-out at the end.
Reimplemented from Wt::WContainerWidget.
int Wt::WStackedWidget::currentIndex | ( | ) | const |
Returns the index of the widget that is currently shown.
WWidget * Wt::WStackedWidget::currentWidget | ( | ) | const |
Returns the widget that is currently shown.
void Wt::WStackedWidget::setCurrentIndex | ( | int | index | ) |
Changes the current widget.
The widget with index index
is made visible, while all other widgets are hidden.
The change of current widget is done using the animation settings specified by setTransitionAnimation().
The default value for current index is 0 (provided thath
void Wt::WStackedWidget::setCurrentIndex | ( | int | index, |
const WAnimation & | animation, | ||
bool | autoReverse = true |
||
) |
Changes the current widget using a custom animation.
void Wt::WStackedWidget::setCurrentWidget | ( | WWidget * | widget | ) |
Changes the current widget.
The widget widget
, which must have been added before, is made visible, while all other widgets are hidden.
void Wt::WStackedWidget::setTransitionAnimation | ( | const WAnimation & | animation, |
bool | autoReverse = false |
||
) |
Specifies an animation used during transitions.
The animation is used to hide the previously current widget and show the next current widget using setCurrentIndex().
The initial value for animation
is WAnimation(), specifying no animation.
When autoReverse
is set to true
, then the reverse animation is chosen when the new index precedes the current index. This only applies to WAnimation::SlideLeft, WAnimation::SlideRight, WAnimation::SlideUp or WAnimation::SlideDown transition effects.