QWidgetStack Class Reference

The QWidgetStack class provides a stack of widgets, where the user can see only the top widget. More...

#include <qwidgetstack.h>

Inherits QFrame.

List of all member functions.

Public Members

QWidgetStack ( QWidget * parent = 0, const char * name = 0 )
~QWidgetStack ()
void addWidget ( QWidget *, int )
void removeWidget ( QWidget * )
virtual void show ()
QWidget* widget ( int ) const
int id ( QWidget * ) const
QWidget* visibleWidget () const
virtual bool event ( QEvent * )

Public Slots

void raiseWidget ( int )
void raiseWidget ( QWidget * )

Signals

void aboutToShow ( int )
void aboutToShow ( QWidget * )

Protected Members

virtual void frameChanged ()
void setChildGeometries ()

Detailed Description

The QWidgetStack class provides a stack of widgets, where the user can see only the top widget.

This is often used e.g. in tab and wizard dialogs.

The application programmer can move any widget to the top of the stack at any time using the slot raiseWidget(), and add or remove widgets using addWidget() and removeWidget().

visibleWidget() is the get equivalent of raiseWidget(); it returns a pointer ot the widget that is currently on the top of the stack.

QWidgetStack also provides the ability to manipulate widgets through application-specfied integer IDs, and to translate from widget pointers to IDs using id() and from IDs to widget pointers using widget(). These numeric IDs have and unique (per QWidgetStack, not globally) and cannot be -1, but apart from that QWidgetStack does not attach any meaning to them.

The default widget stack is frame-less and propagates its font and palette to all its children, but you can use the usual QFrame functions (like setFrameStyle()) to add a frame, and use setFontPropagation() and setPalettePropagation() to change the propagation style.

Finally, QWidgetStack provides a signal, aboutToShow(), which is emitted just before a managed widget is shown.

See also: QTabDialog, QTabBar and QFrame.

Member Function Documentation

QWidgetStack::QWidgetStack ( QWidget * parent = 0, const char * name = 0 )

Constructs an empty widget stack.

QWidgetStack::~QWidgetStack ()

Destroys the object and frees any allocated resources.

void QWidgetStack::aboutToShow ( QWidget * ) `[signal]`

This signal is emitted just before a managed widget is shown. The argument is a pointer to the widget.

void QWidgetStack::aboutToShow ( int ) `[signal]`

This signal is emitted just before a managed widget is shown, if that managed widget has a non-zero ID. The argument is the numeric ID of the widget.

void QWidgetStack::addWidget ( QWidget * w, int id )

Adds w to this stack of widgets, with id id.

If w is not a child of this, QWidgetStack moves it using recreate().

bool QWidgetStack::event ( QEvent * e ) `[virtual]`

Reimplemented for internal reasons; the API is not affected.

Reimplemented from QObject.

void QWidgetStack::frameChanged () `[virtual protected]`

Reimpelemented in order to set the children's geometries appropriately.

Reimplemented from QFrame.

int QWidgetStack::id ( QWidget * widget ) const

Returns the ID of the widget. If widget is 0 or is not being managed by this widget stack, this function returns -1.

void QWidgetStack::raiseWidget ( QWidget * w ) `[slot]`

Raises w to the top of the widget stack.

void QWidgetStack::raiseWidget ( int id ) `[slot]`

Raises id to the top of the widget stack.

void QWidgetStack::removeWidget ( QWidget * w )

Removes w from this stack of widgets. Does not delete w. If w is the currently visible widget, no other widget is substituted.

See also: visibleWidget() and raiseWidget().

void QWidgetStack::setChildGeometries () `[protected]`

Fix up the children's geometries.

void QWidgetStack::show () `[virtual]`

Reimplemented in order to set the children's geometries appropriately.

Reimplemented from QWidget.

QWidget * QWidgetStack::visibleWidget () const

Returns a pointer to the currently visible widget (the one on the top of the stack), of 0 if nothing is currently being shown.

See also: aboutToShow(), id() and raiseWidget().

QWidget * QWidgetStack::widget ( int id ) const

Returns a pointer to the widget with ID id. If this widget stack does not manage a widget with ID id, this function return 0.