Member Function Documentation

QTabWidget::​QTabWidget(QWidget * parent = 0)

Constructs a tabbed widget with parent parent.

QTabWidget::​~QTabWidget()

Destroys the tabbed widget.

int QTabWidget::​addTab(QWidget * page, const QString & label)

Adds a tab with the given page and label to the tab widget, and returns the index of the tab in the tab bar.

If the tab's label contains an ampersand, the letter following the ampersand is used as a shortcut for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes a shortcut which will move the focus to this tab.

Note: If you call addTab() after show(), the layout system will try to adjust to the changes in its widgets hierarchy and may cause flicker. To prevent this, you can set the QWidget::updatesEnabled property to false prior to changes; remember to set the property to true when the changes are done, making the widget receive paint events again.

See also insertTab().

int QTabWidget::​addTab(QWidget * page, const QIcon & icon, const QString & label)

This is an overloaded function.

Adds a tab with the given page, icon, and label to the tab widget, and returns the index of the tab in the tab bar.

This function is the same as addTab(), but with an additional icon.

[virtual protected] void QTabWidget::​changeEvent(QEvent * ev)

Reimplemented from QWidget::changeEvent().

void QTabWidget::​clear()

Removes all the pages, but does not delete them. Calling this function is equivalent to calling removeTab() until the tab widget is empty.

QWidget * QTabWidget::​cornerWidget(Qt::Corner corner = Qt::TopRightCorner) const

Returns the widget shown in the corner of the tab widget or 0.

See also setCornerWidget().

QWidget * QTabWidget::​currentWidget() const

Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be).

See also currentIndex() and setCurrentWidget().

[virtual protected] bool QTabWidget::​event(QEvent * ev)

Reimplemented from QObject::event().

[virtual] bool QTabWidget::​hasHeightForWidth() const

Reimplemented from QWidget::hasHeightForWidth().

[virtual] int QTabWidget::​heightForWidth(int width) const

Reimplemented from QWidget::heightForWidth().

int QTabWidget::​indexOf(QWidget * w) const

Returns the index position of the page occupied by the widget w, or -1 if the widget cannot be found.

[protected] void QTabWidget::​initStyleOption(QStyleOptionTabWidgetFrame * option) const

Initialize option with the values from this QTabWidget. This method is useful for subclasses when they need a QStyleOptionTabWidgetFrame, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom() and QTabBar::initStyleOption().

int QTabWidget::​insertTab(int index, QWidget * page, const QString & label)

Inserts a tab with the given label and page into the tab widget at the specified index, and returns the index of the inserted tab in the tab bar.

The label is displayed in the tab and may vary in appearance depending on the configuration of the tab widget.

If the tab's label contains an ampersand, the letter following the ampersand is used as a shortcut for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes a shortcut which will move the focus to this tab.

If index is out of range, the tab is simply appended. Otherwise it is inserted at the specified position.

If the QTabWidget was empty before this function is called, the new page becomes the current page. Inserting a new tab at an index less than or equal to the current index will increment the current index, but keep the current page.

Note: If you call insertTab() after show(), the layout system will try to adjust to the changes in its widgets hierarchy and may cause flicker. To prevent this, you can set the QWidget::updatesEnabled property to false prior to changes; remember to set the property to true when the changes are done, making the widget receive paint events again.

See also addTab().

int QTabWidget::​insertTab(int index, QWidget * page, const QIcon & icon, const QString & label)

This is an overloaded function.

Inserts a tab with the given label, page, and icon into the tab widget at the specified index, and returns the index of the inserted tab in the tab bar.

This function is the same as insertTab(), but with an additional icon.

bool QTabWidget::​isTabEnabled(int index) const

Returns true if the page at position index is enabled; otherwise returns false.

See also setTabEnabled() and QWidget::isEnabled().

[virtual protected] void QTabWidget::​keyPressEvent(QKeyEvent * e)

Reimplemented from QWidget::keyPressEvent().

[virtual] QSize QTabWidget::​minimumSizeHint() const

Reimplemented from QWidget::minimumSizeHint().

Returns a suitable minimum size for the tab widget.

[virtual protected] void QTabWidget::​paintEvent(QPaintEvent * event)

Reimplemented from QWidget::paintEvent().

Paints the tab widget's tab bar in response to the paint event.

void QTabWidget::​removeTab(int index)

Removes the tab at position index from this stack of widgets. The page widget itself is not deleted.

See also addTab() and insertTab().

[virtual protected] void QTabWidget::​resizeEvent(QResizeEvent * e)

Reimplemented from QWidget::resizeEvent().

void QTabWidget::​setCornerWidget(QWidget * widget, Qt::Corner corner = Qt::TopRightCorner)

Sets the given widget to be shown in the specified corner of the tab widget. The geometry of the widget is determined based on the widget's sizeHint() and the style().

Only the horizontal element of the corner will be used.

Passing 0 shows no widget in the corner.

Any previously set corner widget is hidden.

All widgets set here will be deleted by the tab widget when it is destroyed unless you separately reparent the widget after setting some other corner widget (or 0).

Note: Corner widgets are designed for North and South tab positions; other orientations are known to not work properly.

See also cornerWidget() and setTabPosition().

[slot] void QTabWidget::​setCurrentWidget(QWidget * widget)

Makes widget the current widget. The widget used must be a page in this tab widget.

See also addTab(), setCurrentIndex(), and currentWidget().

[protected] void QTabWidget::​setTabBar(QTabBar * tb)

Replaces the dialog's QTabBar heading with the tab bar tb. Note that this must be called before any tabs have been added, or the behavior is undefined.

See also tabBar().

void QTabWidget::​setTabEnabled(int index, bool enable)

If enable is true, the page at position index is enabled; otherwise the page at position index is disabled. The page's tab is redrawn appropriately.

QTabWidget uses QWidget::setEnabled() internally, rather than keeping a separate flag.

Note that even a disabled tab/page may be visible. If the page is visible already, QTabWidget will not hide it; if all the pages are disabled, QTabWidget will show one of them.

See also isTabEnabled() and QWidget::setEnabled().

void QTabWidget::​setTabIcon(int index, const QIcon & icon)

This is an overloaded function.

Sets the icon for the tab at position index.

See also tabIcon().

void QTabWidget::​setTabText(int index, const QString & label)

Defines a new label for the page at position index's tab.

If the provided text contains an ampersand character ('&'), a shortcut is automatically created for it. The character that follows the '&' will be used as the shortcut key. Any previous shortcut will be overwritten, or cleared if no shortcut is defined by the text. See the QShortcut documentation for details (to display an actual ampersand, use '&&').

See also tabText().

void QTabWidget::​setTabToolTip(int index, const QString & tip)

Sets the tab tool tip for the page at position index to tip.

See also tabToolTip().

void QTabWidget::​setTabWhatsThis(int index, const QString & text)

Sets the What's This help text for the page at position index to text.

This function was introduced in Qt 4.1.

See also tabWhatsThis().

[virtual protected] void QTabWidget::​showEvent(QShowEvent *)

Reimplemented from QWidget::showEvent().

[virtual] QSize QTabWidget::​sizeHint() const

Reimplemented from QWidget::sizeHint().

QTabBar * QTabWidget::​tabBar() const

Returns the current QTabBar.

See also setTabBar().

[signal] void QTabWidget::​tabBarClicked(int index)

This signal is emitted when user clicks on a tab at an index.

index refers to the tab clicked, or -1 if no tab is under the cursor.

This function was introduced in Qt 5.2.

[signal] void QTabWidget::​tabBarDoubleClicked(int index)

This signal is emitted when the user double clicks on a tab at an index.

index is the index of a clicked tab, or -1 if no tab is under the cursor.

This function was introduced in Qt 5.2.

[signal] void QTabWidget::​tabCloseRequested(int index)

This signal is emitted when the close button on a tab is clicked. The index is the index that should be removed.

This function was introduced in Qt 4.5.

See also setTabsClosable().

QIcon QTabWidget::​tabIcon(int index) const

Returns the icon for the tab on the page at position index.

See also setTabIcon().

[virtual protected] void QTabWidget::​tabInserted(int index)

This virtual handler is called after a new tab was added or inserted at position index.

See also tabRemoved().

[virtual protected] void QTabWidget::​tabRemoved(int index)

This virtual handler is called after a tab was removed from position index.

See also tabInserted().

QString QTabWidget::​tabText(int index) const

Returns the label text for the tab on the page at position index.

See also setTabText().

QString QTabWidget::​tabToolTip(int index) const

Returns the tab tool tip for the page at position index or an empty string if no tool tip has been set.

See also setTabToolTip().

QString QTabWidget::​tabWhatsThis(int index) const

Returns the What's This help text for the page at position index, or an empty string if no help text has been set.

This function was introduced in Qt 4.1.

See also setTabWhatsThis().

QWidget * QTabWidget::​widget(int index) const

Returns the tab page at index position index or 0 if the index is out of range.