QTabBar

NAME

SYNOPSIS

Inherits QWidget.

Public Members

Public Slots

Signals

Properties

Protected Members

DESCRIPTION

QTabBar is straightforward to use; it draws the tabs using one of the predefined shapes, and emits a signal when a tab is selected. It can be subclassed to tailor the look and feel. Qt also provides a ready-made QTabWidget and a QTabDialog.

The choice of tab shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use RoundedAbove; nobody uses TriangularAbove. Tab controls in windows other than dialogs almost always use either RoundedBelow or TriangularBelow. Many spreadsheets and other tab controls in which all the pages are essentially similar use TriangularBelow, whereas RoundedBelow is used mostly when the pages are different (e.g. a multi-page tool palette).

The most important part of QTabBar's API is the selected() signal. This is emitted whenever the selected page changes (even at startup, when the selected page changes from 'none'). There is also a slot, setCurrentTab(), which can be used to select a page programmatically.

QTabBar creates automatic accelerator keys in the manner of QButton; e.g. if a tab's label is "&Graphics", Alt+G becomes an accelerator key for switching to that tab.

The following virtual functions may need to be reimplemented:

paint() paints a single tab. paintEvent() calls paint() for each tab so that any overlap will look right.

addTab() creates a new tab and adds it to the bar.

selectTab() decides which tab, if any, the user selects with the mouse.

The index of the current tab is returned by currentTab(). The tab with a particular index is returned by tabAt(), the tab with a particular id is returned by tab(). The index of a tab is returned by indexOf(). The current tab can be set by index or tab pointer using one of the setCurrentTab() functions.

See also Advanced Widgets.  

Member Type Documentation

QTabBar::Shape

QTabBar::RoundedAbove - the normal rounded look above the pages

QTabBar::RoundedBelow - the normal rounded look below the pages

QTabBar::TriangularAbove - triangular tabs above the pages (very unusual; included for completeness)

QTabBar::TriangularBelow - triangular tabs similar to those used in the Excel spreadsheet, for example

MEMBER FUNCTION DOCUMENTATION

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

QTabBar::~QTabBar ()

int QTabBar::addTab ( QTab * newTab ) [virtual]

Sets newTab's id to a new id and places the tab just to the right of the existing tabs. If the tab's label contains an ampersand, the letter following the ampersand is used as an accelerator for the tab, e.g. if the label is "Bro&wse" then Alt+W becomes an accelerator which will move the focus to this tab. Returns the id.

See also insertTab().  

int QTabBar::count () const

int QTabBar::currentTab () const

int QTabBar::indexOf ( int id ) const

See also tabAt().  

int QTabBar::insertTab ( QTab * newTab, int index = -1 ) [virtual]

If index is not specified, the tab is simply appended. Otherwise it's inserted at the specified position.

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

See also addTab().  

bool QTabBar::isTabEnabled ( int id ) const

See also setTabEnabled().  

int QTabBar::keyboardFocusTab () const

void QTabBar::layoutChanged () [signal]

void QTabBar::layoutTabs () [virtual]

void QTabBar::paint ( QPainter * p, QTab * t, bool selected ) const [virtual protected]

This virtual function may be reimplemented to change the look of QTabBar. If you decide to reimplement it, you may also need to reimplement sizeHint().  

void QTabBar::paintEvent ( QPaintEvent * e ) [virtual protected]

See also paint().

Reimplemented from QWidget.  

void QTabBar::paintLabel ( QPainter * p, const QRect & br, QTab * t, bool has_focus ) const [virtual protected]

void QTabBar::removeTab ( QTab * t ) [virtual]

void QTabBar::removeToolTip ( int index )

QTab * QTabBar::selectTab ( const QPoint & p ) const [virtual]

See also mousePressEvent() and mouseReleaseEvent().  

void QTabBar::selected ( int id ) [signal]

show() is guaranteed to emit this signal; you can display your page in a slot connected to this signal.  

void QTabBar::setCurrentTab ( int ) [virtual slot]

void QTabBar::setCurrentTab ( QTab * tab ) [virtual slot]

Raises tab and emits the selected() signal unless the tab was already current.

See also currentTab and selected().  

void QTabBar::setShape ( Shape ) [virtual]

void QTabBar::setTabEnabled ( int id, bool enabled ) [virtual]

setTabEnabled() updates the display if this causes a change in id's status.

See also update() and isTabEnabled().  

void QTabBar::setToolTip ( int index, const QString & tip )

Shape QTabBar::shape () const

QTab * QTabBar::tab ( int id ) const

See also count.  

QTab * QTabBar::tabAt ( int index ) const

See also indexOf().  

QPtrList<QTab> * QTabBar::tabList () [protected]

This list is unlikely to be in the order that the QTab elements appear visually. One way of iterating over the tabs is like this:

    for ( uint i = 0; i < myTabBar->count(); ++i ) {


        nextTab = myTabBar->tabAt( i );


        // do something with nextTab


    }

QString QTabBar::toolTip ( int index ) const

Property Documentation

int count

Get this property's value with count().

See also tab().  

int currentTab

If no tab page is currently visible, the property's value is -1. Even if the property's value is not -1, you cannot assume that the user can see the relevant page, or that the tab is enabled. When you need to display something the value of this property represents the best page to display.

When this property is set to id, it will raise the tab with the id id and emit the selected() signal.

See also selected() and isTabEnabled().

Set this property's value with setCurrentTab() and get this property's value with currentTab().  

int keyboardFocusTab

This property contains the id of the tab that has the keyboard focus or -1 if the tab bar does not have the keyboard focus.

Get this property's value with keyboardFocusTab().  

Shape shape

The value of this property is one of the following: RoundedAbove (default), RoundedBelow, TriangularAbove or TriangularBelow.

See also Shape.

Set this property's value with setShape() and get this property's value with shape().

SEE ALSO

COPYRIGHT

AUTHOR

BUGS