From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qtoolbox.html | 248 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 248 insertions(+) create mode 100644 doc/html/qtoolbox.html (limited to 'doc/html/qtoolbox.html') diff --git a/doc/html/qtoolbox.html b/doc/html/qtoolbox.html new file mode 100644 index 0000000..d87097b --- /dev/null +++ b/doc/html/qtoolbox.html @@ -0,0 +1,248 @@ + + + + + +QToolBox Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QToolBox Class Reference

+ +

The QToolBox class provides a column of tabbed widget +items. +More... +

#include <qtoolbox.h> +

Inherits QFrame. +

List of all member functions. +

Public Members

+ +

Public Slots

+ +

Signals

+ +

Properties

+ +

Protected Members

+ +

Detailed 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(). + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.3