QToolBox(3qt)

NAME
QToolBox - Column of tabbed widget items

SYNOPSIS
#include <qtoolbox.h>

Inherits QFrame.

  Public Members
QToolBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )
int addItem ( QWidget * w, const QString & label )
int addItem ( QWidget * item, const QIconSet & iconSet, const QString & label )
int insertItem ( int index, QWidget * item, const QString & label )
int insertItem ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )
int removeItem ( QWidget * item )
void setItemEnabled ( int index, bool enabled )
bool isItemEnabled ( int index ) const
void setItemLabel ( int index, const QString & label )
QString itemLabel ( int index ) const
void setItemIconSet ( int index, const QIconSet & iconSet )
QIconSet itemIconSet ( int index ) const
void setItemToolTip ( int index, const QString & toolTip )
QString itemToolTip ( int index ) const
QWidget * currentItem () const
void setCurrentItem ( QWidget * item )
int currentIndex () const
QWidget * item ( int index ) const
int indexOf ( QWidget * item ) const
int count () const

  Public Slots
void setCurrentIndex ( int index )

  Signals
void currentChanged ( int index )

  Properties
int count - the number of items contained in the toolbox (read only)
int currentIndex - the index of the current item, or -1 if the toolbox is empty

  Protected Members
virtual void itemInserted ( int index )
virtual void itemRemoved ( int index )

DESCRIPTION
The QToolBox class provides a column of tabbed widget items.

A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a QWidget.

Each item has an itemLabel(), an optional icon, itemIconSet(), an optional itemToolTip(), and a widget. The item's attributes can be changed with setItemLabel(), setItemIconSet() and setItemToolTip().

Items are added using addItem(), or inserted at particular positions using insertItem(). The total number of items is given by count(). Items can be deleted with delete, or removed from the toolbox with removeItem(). Combining removeItem() and insertItem() allows to move items to different positions.

The current item widget is returned by currentItem() and set with setCurrentItem(). If you prefer you can work in terms of indexes using currentIndex(), setCurrentIndex(), indexOf() and item().

The currentChanged() signal is emitted when the current item is changed.

See also QTabWidget and Advanced Widgets.

MEMBER FUNCTION DOCUMENTATION

QToolBox::QToolBox ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )
Constructs a toolbox called name with parent parent and flags f.

int QToolBox::addItem ( QWidget * item, const QIconSet & iconSet, const QString & label )
Adds the widget item in a new tab at bottom of the toolbox. The new tab's label is set to label, and the iconSet is displayed to the left of the label. Returns the new tab's index.

int QToolBox::addItem ( QWidget * w, const QString & label )
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Adds the widget w in a new tab at bottom of the toolbox. The new tab's label is set to label. Returns the new tab's index.

int QToolBox::count () const
Returns the number of items contained in the toolbox. See the "count" property for details.

void QToolBox::currentChanged ( int index ) [signal]
This signal is emitted when the current item changed. The new current item's index is passed in index, or -1 if there is no current item.

int QToolBox::currentIndex () const
Returns the index of the current item, or -1 if the toolbox is empty. See the "currentIndex" property for details.

QWidget * QToolBox::currentItem () const
Returns the toolbox's current item, or 0 if the toolbox is empty.

int QToolBox::indexOf ( QWidget * item ) const
Returns the index of item item, or -1 if the item does not exist.

int QToolBox::insertItem ( int index, QWidget * item, const QIconSet & iconSet, const QString & label )
Inserts the widget item at position index, or at the bottom of the toolbox if index is out of range. The new item's label is set to label, and the iconSet is displayed to the left of the label. Returns the new item's index.

int QToolBox::insertItem ( int index, QWidget * item, const QString & label )
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts the widget item at position index, or at the bottom of the toolbox if index is out of range. The new item's label is set to label. Returns the new item's index.

bool QToolBox::isItemEnabled ( int index ) const
Returns TRUE if the item at position index is enabled; otherwise returns FALSE.

QWidget * QToolBox::item ( int index ) const
Returns the item at position index, or 0 if there is no such item.

QIconSet QToolBox::itemIconSet ( int index ) const
Returns the icon of the item at position index, or a null icon if index is out of range.

void QToolBox::itemInserted ( int index ) [virtual protected]
This virtual handler is called after a new item was added or inserted at position index.

QString QToolBox::itemLabel ( int index ) const
Returns the label of the item at position index, or a null string if index is out of range.

void QToolBox::itemRemoved ( int index ) [virtual protected]
This virtual handler is called after an item was removed from position index.

QString QToolBox::itemToolTip ( int index ) const
Returns the tooltip of the item at position index, or a null string if index is out of range.

int QToolBox::removeItem ( QWidget * item )
Removes the widget item from the toolbox. Note that the widget is not deleted. Returns the removed widget's index, or -1 if the widget was not in this tool box.

void QToolBox::setCurrentIndex ( int index ) [slot]
Sets the index of the current item, or -1 if the toolbox is empty to index. See the "currentIndex" property for details.

void QToolBox::setCurrentItem ( QWidget * item )
Sets the current item to be item.

void QToolBox::setItemEnabled ( int index, bool enabled )
If enabled is TRUE then the item at position index is enabled; otherwise item index is disabled.

void QToolBox::setItemIconSet ( int index, const QIconSet & iconSet )
Sets the icon of the item at position index to iconSet.

void QToolBox::setItemLabel ( int index, const QString & label )
Sets the label of the item at position index to label.

void QToolBox::setItemToolTip ( int index, const QString & toolTip )
Sets the tooltip of the item at position index to toolTip.

  Property Documentation

int count
This property holds the number of items contained in the toolbox.

Get this property's value with count().

int currentIndex
This property holds the index of the current item, or -1 if the toolbox is empty.

Set this property's value with setCurrentIndex() and get this property's value with currentIndex().

See also currentItem(), indexOf(), and item().

SEE ALSO
http://doc.trolltech.com/qtoolbox.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qtoolbox.3) and the Qt version (3.3.8).