|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QWidget
com.trolltech.qt.gui.QTabWidget
public class QTabWidget
The QTabWidget
class provides a stack of tabbed widgets. A tab widget provides a tab bar (see QTabBar
) and a "page area" that is used to display pages related to each tab. By default, the tab bar is shown above the page area, but different configurations are available (see TabPosition
). Each tab is associated with a different widget (called a page). Only the current page is shown in the page area; all the other pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+letter shortcut if it has one.
The normal way to use QTabWidget
is to do the following:
QTabWidget
.QWidget
for each of the pages in the tab dialog, but do not specify parent widgets for them.addTab()
or insertTab()
to put the page widgets into the tab widget, giving each tab a suitable label with an optional keyboard shortcut.tabPosition
, their shape by tabShape
. The signal currentChanged()
is emitted when the user selects a page.
The current page index is available as currentIndex()
, the current page widget with currentWidget()
. You can retrieve a pointer to a page widget with a given index using widget()
, and can find the index position of a widget with indexOf()
. Use setCurrentWidget()
or setCurrentIndex()
to show a particular page.
You can change a tab's text and icon using setTabText()
or setTabIcon()
. A tab and its associated page can be removed with removeTab()
.
Each tab is either enabled or disabled at any given time (see setTabEnabled()
). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled.
Tab widgets can be a very good way to split up a complex dialog. An alternative is to use a QStackedWidget
for which you provide some means of navigating between pages, for example, a QToolBar
or a QListWidget
.
Most of the functionality in QTabWidget
is provided by a QTabBar
(at the top, providing the tabs) and a QStackedWidget
(most of the area, organizing the individual pages).
![]() | ![]() | ![]() |
A Windows XP style tab widget. | A Macintosh style tab widget. | A Plastique style tab widget. |
QTabBar
, QStackedWidget
, QToolBox
, and Tab Dialog Example.
Nested Class Summary | |
---|---|
static class |
QTabWidget.TabPosition
This enum type defines where QTabWidget draws the tab row: |
static class |
QTabWidget.TabShape
This enum type defines the shape of the tabs. |
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QWidget |
---|
QWidget.RenderFlag, QWidget.RenderFlags |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9 |
Field Summary | |
---|---|
QSignalEmitter.Signal1 |
currentChanged
This signal is emitted whenever the current page index changes. |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Constructor Summary | |
---|---|
QTabWidget()
Constructs a tabbed widget with parent parent. |
|
QTabWidget(QWidget parent)
Constructs a tabbed widget with parent parent. |
Method Summary | |
---|---|
int |
addTab(QWidget widget,
QIcon icon,
java.lang.String label)
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. |
int |
addTab(QWidget widget,
java.lang.String arg__2)
Adds a tab with the given page and label to the tab widget, and returns the index of the tab in the tab bar. |
void |
clear()
Removes all the pages, but does not delete them. |
QWidget |
cornerWidget()
Returns the widget shown in the corner of the tab widget or 0. |
QWidget |
cornerWidget(Qt.Corner corner)
Returns the widget shown in the corner of the tab widget or 0. |
int |
count()
This property holds the number of tabs in the tab bar. |
int |
currentIndex()
This property holds the index position of the current tab page. |
QWidget |
currentWidget()
Returns a pointer to the page currently being displayed by the tab dialog. |
Qt.TextElideMode |
elideMode()
This property holds how to elide text in the tab bar. |
static QTabWidget |
fromNativePointer(QNativePointer nativePointer)
|
QSize |
iconSize()
This property holds The size for icons in the tab bar. |
int |
indexOf(QWidget widget)
Returns the index position of the page occupied by the widget w, or -1 if the widget cannot be found. |
protected void |
initStyleOption(QStyleOptionTabWidgetFrame option)
Initialize option with the values from this QTabWidget. |
int |
insertTab(int index,
QWidget widget,
QIcon icon,
java.lang.String label)
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. |
int |
insertTab(int index,
QWidget widget,
java.lang.String arg__3)
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. |
boolean |
isTabEnabled(int index)
Returns true if the the page at position index is enabled; otherwise returns false. |
void |
removeTab(int index)
Removes the tab at position index from this stack of widgets. |
void |
setCornerWidget(QWidget w)
Sets the given widget to be shown in the specified corner of the tab widget. |
void |
setCornerWidget(QWidget w,
Qt.Corner corner)
Sets the given widget to be shown in the specified corner of the tab widget. |
void |
setCurrentIndex(int index)
This property holds the index position of the current tab page. |
void |
setCurrentWidget(QWidget widget)
Makes widget the current widget. |
void |
setElideMode(Qt.TextElideMode arg__1)
This property holds how to elide text in the tab bar. |
void |
setIconSize(QSize size)
This property holds The size for icons in the tab bar. |
protected void |
setTabBar(QTabBar arg__1)
Replaces the dialog's QTabBar heading with the tab bar tb. |
void |
setTabEnabled(int index,
boolean arg__2)
If enable is true, the page at position index is enabled; otherwise the page at position index is disabled. |
void |
setTabIcon(int index,
QIcon icon)
Sets the icon for the tab at position index. |
void |
setTabPosition(QTabWidget.TabPosition arg__1)
This property holds the position of the tabs in this tab widget. |
void |
setTabShape(QTabWidget.TabShape s)
This property holds the shape of the tabs in this tab widget. |
void |
setTabText(int index,
java.lang.String arg__2)
Defines a new label for the page at position index's tab. |
void |
setTabToolTip(int index,
java.lang.String tip)
Sets the tab tool tip for the page at position index to tip. |
void |
setTabWhatsThis(int index,
java.lang.String text)
Sets the What's This help text for the page at position index to text. |
void |
setUsesScrollButtons(boolean useButtons)
This property holds Whether or not a tab bar should use buttons to scroll tabs when it has many tabs. |
protected QTabBar |
tabBar()
Returns the current QTabBar . |
QIcon |
tabIcon(int index)
Returns the icon for the tab on the page at position index. |
protected void |
tabInserted(int index)
This virtual handler is called after a new tab was added or inserted at position index. |
QTabWidget.TabPosition |
tabPosition()
This property holds the position of the tabs in this tab widget. |
protected void |
tabRemoved(int index)
This virtual handler is called after a tab was removed from position index. |
QTabWidget.TabShape |
tabShape()
This property holds the shape of the tabs in this tab widget. |
java.lang.String |
tabText(int index)
Returns the label text for the tab on the page at position index. |
java.lang.String |
tabToolTip(int index)
Returns the tab tool tip for the page at position index or an empty string if no tool tip has been set. |
java.lang.String |
tabWhatsThis(int index)
Returns the What's This help text for the page at position index, or an empty string if no help text has been set. |
boolean |
usesScrollButtons()
This property holds Whether or not a tab bar should use buttons to scroll tabs when it has many tabs. |
QWidget |
widget(int index)
Returns the tab page at index position index or 0 if the index is out of range. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1 currentChanged
QTabWidget
) currentWidget()
, and currentIndex
.
Constructor Detail |
---|
public QTabWidget()
public QTabWidget(QWidget parent)
Method Detail |
---|
public final int addTab(QWidget widget, QIcon icon, java.lang.String label)
This function is the same as addTab()
, but with an additional icon.
public final int addTab(QWidget widget, java.lang.String arg__2)
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 it's 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.
insertTab()
.
public final void clear()
removeTab()
until the tab widget is empty.
public final QWidget cornerWidget()
setCornerWidget()
.
public final QWidget cornerWidget(Qt.Corner corner)
setCornerWidget()
.
public final int count()
public final int currentIndex()
public final QWidget currentWidget()
currentIndex()
, and setCurrentWidget()
.
public final Qt.TextElideMode elideMode()
By default the value is style dependant.
QTabBar::elideMode
, usesScrollButtons
, and QStyle::SH_TabBar_ElideMode
.
public final QSize iconSize()
QTabBar::iconSize
.
public final int indexOf(QWidget widget)
public final int insertTab(int index, QWidget widget, QIcon icon, java.lang.String label)
This function is the same as insertTab()
, but with an additional icon.
public final int insertTab(int index, QWidget widget, java.lang.String arg__3)
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 it's 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.
addTab()
.
public final boolean isTabEnabled(int index)
setTabEnabled()
, and QWidget::isEnabled()
.
public final void removeTab(int index)
addTab()
, and insertTab()
.
public final void setCornerWidget(QWidget w)
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.
cornerWidget()
, and setTabPosition()
.
public final void setCornerWidget(QWidget w, Qt.Corner corner)
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.
cornerWidget()
, and setTabPosition()
.
public final void setCurrentIndex(int index)
public final void setCurrentWidget(QWidget widget)
addTab()
, setCurrentIndex()
, and currentWidget()
.
public final void setElideMode(Qt.TextElideMode arg__1)
By default the value is style dependant.
QTabBar::elideMode
, usesScrollButtons
, and QStyle::SH_TabBar_ElideMode
.
public final void setIconSize(QSize size)
QTabBar::iconSize
.
protected final void setTabBar(QTabBar arg__1)
QTabBar
heading with the tab bar tb. Note that this must be called before any tabs have been added, or the behavior is undefined. tabBar()
.
public final void setTabEnabled(int index, boolean arg__2)
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.
isTabEnabled()
, and QWidget::setEnabled()
.
public final void setTabIcon(int index, QIcon icon)
tabIcon()
.
public final void setTabPosition(QTabWidget.TabPosition arg__1)
TabPosition
enum. TabPosition
.
public final void setTabShape(QTabWidget.TabShape s)
QTabWidget::Rounded
(default) or QTabWidget::Triangular
. TabShape
.
public final void setTabText(int index, java.lang.String arg__2)
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 '&&').
tabText()
.
public final void setTabToolTip(int index, java.lang.String tip)
tabToolTip()
.
public final void setTabWhatsThis(int index, java.lang.String text)
tabWhatsThis()
.
public final void setUsesScrollButtons(boolean useButtons)
By default the value is style dependant.
elideMode
, QTabBar::usesScrollButtons
, and QStyle::SH_TabBar_PreferNoArrows
.
protected final QTabBar tabBar()
QTabBar
. setTabBar()
.
public final QIcon tabIcon(int index)
setTabIcon()
.
public final QTabWidget.TabPosition tabPosition()
TabPosition
enum. TabPosition
.
public final QTabWidget.TabShape tabShape()
QTabWidget::Rounded
(default) or QTabWidget::Triangular
. TabShape
.
public final java.lang.String tabText(int index)
setTabText()
.
public final java.lang.String tabToolTip(int index)
setTabToolTip()
.
public final java.lang.String tabWhatsThis(int index)
setTabWhatsThis()
.
public final boolean usesScrollButtons()
By default the value is style dependant.
elideMode
, QTabBar::usesScrollButtons
, and QStyle::SH_TabBar_PreferNoArrows
.
public final QWidget widget(int index)
protected void tabInserted(int index)
tabRemoved()
.
protected void tabRemoved(int index)
tabInserted()
.
public static QTabWidget fromNativePointer(QNativePointer nativePointer)
protected final void initStyleOption(QStyleOptionTabWidgetFrame option)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |