|
|
||||||||||
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.QTabBar
public class QTabBar
The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs.
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.
Each tab has a tabText, an optional tabIcon, an optional tabToolTip, optional tabWhatsThis and optional tabData. The tabs's attributes can be changed with setTabText, setTabIcon, setTabToolTip, setTabWhatsThis and setTabData. Each tabs can be enabled or disabled individually with setTabEnabled.
Each tab can display text in a distinct color. The current text color for a tab can be found with the tabTextColor function. Set the text color for a particular tab with setTabTextColor.
Tabs are added using addTab, or inserted at particular positions using insertTab. The total number of tabs is given by count. Tabs can be removed from the tab bar with removeTab. Combining removeTab and insertTab allows you to move tabs to different positions.
The shape property defines the tabs' appearance. The choice of shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use RoundedNorth. Tab controls in windows other than dialogs almost always use either RoundedSouth or TriangularSouth. Many spreadsheets and other tab controls in which all the pages are essentially similar use TriangularSouth, whereas RoundedSouth is used mostly when the pages are different (e.g. a multi-page tool palette). The default in QTabBar is RoundedNorth.
The most important part of QTabBar's API is the currentChanged signal. This is emitted whenever the current tab changes (even at startup, when the current tab changes from 'none'). There is also a slot, setCurrentIndex, which can be used to select a tab programmatically. The function currentIndex returns the index of the current tab, count holds the number of tabs.
QTabBar creates automatic mnemonic keys in the manner of QAbstractButton; e.g. if a tab's label is "&Graphics", Alt+G becomes a shortcut key for switching to that tab.
The following virtual functions may need to be reimplemented in order to tailor the look and feel or store extra data with each tab:
For subclasses, you might also need the tabRect functions which returns the visual geometry of a single tab.
![]() | A tab bar shown in the Plastique widget style. |
![]() | A truncated tab bar shown in the Plastique widget style. |
Nested Class Summary | |
---|---|
static class |
QTabBar.Shape
This enum type lists the built-in shapes supported by QTabBar. |
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.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Field Summary | |
---|---|
QSignalEmitter.Signal1<java.lang.Integer> |
currentChanged
This signal is emitted when the tab bar's current tab changes. |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Constructor Summary | |
---|---|
QTabBar()
Equivalent to QTabBar(0). |
|
QTabBar(QWidget parent)
Creates a new tab bar with the given parent. |
Method Summary | |
---|---|
int |
addTab(QIcon icon,
java.lang.String text)
Adds a new tab with icon icon and text text. |
int |
addTab(java.lang.String text)
Adds a new tab with text text. |
protected void |
changeEvent(QEvent arg__1)
This function is reimplemented for internal reasons. |
int |
count()
Returns the number of tabs in the tab bar. |
int |
currentIndex()
Returns the index of the tab bar's visible tab. |
boolean |
drawBase()
Returns defines whether or not tab bar should draw its base.. |
Qt.TextElideMode |
elideMode()
Returns how to elide text in the tab bar. |
boolean |
event(QEvent arg__1)
This function is reimplemented for internal reasons. |
static QTabBar |
fromNativePointer(QNativePointer nativePointer)
This function returns the QTabBar instance pointed to by nativePointer |
QSize |
iconSize()
Returns The size for icons in the tab bar. |
void |
initStyleOption(QStyleOptionTab option,
int tabIndex)
Initialize option with the values from the tab at tabIndex. |
int |
insertTab(int index,
QIcon icon,
java.lang.String text)
Inserts a new tab with icon icon and text text at position index. |
int |
insertTab(int index,
java.lang.String text)
Inserts a new tab with text text at position index. |
boolean |
isTabEnabled(int index)
Returns true if the tab at position index is enabled; otherwise returns false. |
protected void |
keyPressEvent(QKeyEvent arg__1)
This function is reimplemented for internal reasons. |
QSize |
minimumSizeHint()
This function is reimplemented for internal reasons. |
protected void |
mouseMoveEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
mousePressEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
mouseReleaseEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
paintEvent(QPaintEvent arg__1)
This function is reimplemented for internal reasons. |
void |
removeTab(int index)
Removes the tab at position index. |
protected void |
resizeEvent(QResizeEvent arg__1)
This function is reimplemented for internal reasons. |
void |
setCurrentIndex(int index)
Sets the index of the tab bar's visible tab to index. |
void |
setDrawBase(boolean drawTheBase)
Sets defines whether or not tab bar should draw its base. |
void |
setElideMode(Qt.TextElideMode arg__1)
Sets how to elide text in the tab bar to arg__1. |
void |
setIconSize(QSize size)
Sets The size for icons in the tab bar to size. |
void |
setShape(QTabBar.Shape shape)
Sets the shape of the tabs in the tab bar to shape. |
void |
setTabData(int index,
java.lang.Object data)
Sets the data of the tab at position index to data. |
void |
setTabEnabled(int index,
boolean arg__2)
If arg__2 is true then the tab at position index is enabled; otherwise the item at position index is disabled. |
void |
setTabIcon(int index,
QIcon icon)
Sets the icon of the tab at position index to icon. |
void |
setTabText(int index,
java.lang.String text)
Sets the text of the tab at position index to text. |
void |
setTabTextColor(int index,
QColor color)
Sets the color of the text in the tab with the given index to the specified color. |
void |
setTabToolTip(int index,
java.lang.String tip)
Sets the tool tip of the tab at position index to tip. |
void |
setTabWhatsThis(int index,
java.lang.String text)
Sets the What's This help text of the tab at position index to text. |
void |
setUsesScrollButtons(boolean useButtons)
Sets Whether or not a tab bar should use buttons to scroll tabs when it has many tabs. |
QTabBar.Shape |
shape()
Returns the shape of the tabs in the tab bar. |
protected void |
showEvent(QShowEvent arg__1)
This function is reimplemented for internal reasons. |
QSize |
sizeHint()
This function is reimplemented for internal reasons. |
int |
tabAt(QPoint pos)
Returns the index of the tab that covers pos or -1 if no tab covers pos; |
java.lang.Object |
tabData(int index)
Returns the datad of the tab at position index, or a null variant if index is out of range. |
QIcon |
tabIcon(int index)
Returns the icon of the tab at position index, or a null icon if index is out of range. |
protected void |
tabInserted(int index)
This virtual handler is called after a new tab was added or inserted at position index. |
protected void |
tabLayoutChange()
This virtual handler is called whenever the tab layout changes. |
QRect |
tabRect(int index)
Returns the visual rectangle of the of the tab at position index, or a null rectangle if index is out of range. |
protected void |
tabRemoved(int index)
This virtual handler is called after a tab was removed from position index. |
protected QSize |
tabSizeHint(int index)
Returns the size hint for the tab at position index. |
java.lang.String |
tabText(int index)
Returns the text of the tab at position index, or an empty string if index is out of range. |
QColor |
tabTextColor(int index)
Returns the text color of the tab with the given index, or a invalid color if index is out of range. |
java.lang.String |
tabToolTip(int index)
Returns the tool tip of the tab at position index, or an empty string if index is out of range. |
java.lang.String |
tabWhatsThis(int index)
Returns the What's This help text of the tab at position index, or an empty string if index is out of range. |
boolean |
usesScrollButtons()
Returns Whether or not a tab bar should use buttons to scroll tabs when it has many tabs.. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1<java.lang.Integer> currentChanged
This signal is emitted when the tab bar's current tab changes. The new current has the given index.
Constructor Detail |
---|
public QTabBar()
Equivalent to QTabBar(0).
public QTabBar(QWidget parent)
Creates a new tab bar with the given parent.
Method Detail |
---|
public final int addTab(QIcon icon, java.lang.String text)
Adds a new tab with icon icon and text text. Returns the new tab's index.
public final int addTab(java.lang.String text)
Adds a new tab with text text. Returns the new tab's index.
public final int count()
Returns the number of tabs in the tab bar.
public final int currentIndex()
Returns the index of the tab bar's visible tab.
public final boolean drawBase()
Returns defines whether or not tab bar should draw its base..
If true then QTabBar draws a base in relation to the styles overlab. Otherwise only the tabs are drawn.
public final Qt.TextElideMode elideMode()
Returns how to elide text in the tab bar.
This property controls how items are elided when there is not enough space to show them for a given tab bar size.
By default the value is style dependent.
public final QSize iconSize()
Returns The size for icons in the tab bar.
The default value is style-dependent. iconSize is a maximum size; icons that are smaller are not scaled up.
public final int insertTab(int index, java.lang.String text)
Inserts a new tab with text text at position index. If index is out of range, the new tab is appened. Returns the new tab's index.
public final int insertTab(int index, QIcon icon, java.lang.String text)
Inserts a new tab with icon icon and text text at position index. If index is out of range, the new tab is appended. Returns the new tab's index.
If the QTabBar was empty before this function is called, the inserted tab becomes the current tab.
Inserting a new tab at an index less than or equal to the current index will increment the current index, but keep the current tab.
public final boolean isTabEnabled(int index)
Returns true if the tab at position index is enabled; otherwise returns false.
public final void removeTab(int index)
Removes the tab at position index.
public final void setCurrentIndex(int index)
Sets the index of the tab bar's visible tab to index.
public final void setDrawBase(boolean drawTheBase)
Sets defines whether or not tab bar should draw its base. to drawTheBase.
If true then QTabBar draws a base in relation to the styles overlab. Otherwise only the tabs are drawn.
public final void setElideMode(Qt.TextElideMode arg__1)
Sets how to elide text in the tab bar to arg__1.
This property controls how items are elided when there is not enough space to show them for a given tab bar size.
By default the value is style dependent.
public final void setIconSize(QSize size)
Sets The size for icons in the tab bar to size.
The default value is style-dependent. iconSize is a maximum size; icons that are smaller are not scaled up.
public final void setShape(QTabBar.Shape shape)
Sets the shape of the tabs in the tab bar to shape.
Possible values for this property are described by the Shape enum.
public final void setTabData(int index, java.lang.Object data)
Sets the data of the tab at position index to data.
public final void setTabEnabled(int index, boolean arg__2)
If arg__2 is true then the tab at position index is enabled; otherwise the item at position index is disabled.
public final void setTabIcon(int index, QIcon icon)
Sets the icon of the tab at position index to icon.
public final void setTabText(int index, java.lang.String text)
Sets the text of the tab at position index to text.
public final void setTabTextColor(int index, QColor color)
Sets the color of the text in the tab with the given index to the specified color.
If an invalid color is specified, the tab will use the QTabBar foreground role instead.
public final void setTabToolTip(int index, java.lang.String tip)
Sets the tool tip of the tab at position index to tip.
public final void setTabWhatsThis(int index, java.lang.String text)
Sets the What's This help text of the tab at position index to text.
public final void setUsesScrollButtons(boolean useButtons)
Sets Whether or not a tab bar should use buttons to scroll tabs when it has many tabs. to useButtons.
When there are too many tabs in a tab bar for its size, the tab bar can either choose to expand it's size or to add buttons that allow you to scroll through the tabs.
By default the value is style dependant.
public final QTabBar.Shape shape()
Returns the shape of the tabs in the tab bar.
Possible values for this property are described by the Shape enum.
public final int tabAt(QPoint pos)
Returns the index of the tab that covers pos or -1 if no tab covers pos;
public final java.lang.Object tabData(int index)
Returns the datad of the tab at position index, or a null variant if index is out of range.
public final QIcon tabIcon(int index)
Returns the icon of the tab at position index, or a null icon if index is out of range.
public final QRect tabRect(int index)
Returns the visual rectangle of the of the tab at position index, or a null rectangle if index is out of range.
public final java.lang.String tabText(int index)
Returns the text of the tab at position index, or an empty string if index is out of range.
public final QColor tabTextColor(int index)
Returns the text color of the tab with the given index, or a invalid color if index is out of range.
public final java.lang.String tabToolTip(int index)
Returns the tool tip of the tab at position index, or an empty string if index is out of range.
public final java.lang.String tabWhatsThis(int index)
Returns the What's This help text of the tab at position index, or an empty string if index is out of range.
public final boolean usesScrollButtons()
Returns Whether or not a tab bar should use buttons to scroll tabs when it has many tabs..
When there are too many tabs in a tab bar for its size, the tab bar can either choose to expand it's size or to add buttons that allow you to scroll through the tabs.
By default the value is style dependant.
protected void changeEvent(QEvent arg__1)
This function is reimplemented for internal reasons.
changeEvent
in class QWidget
public boolean event(QEvent arg__1)
This function is reimplemented for internal reasons.
event
in class QWidget
protected void keyPressEvent(QKeyEvent arg__1)
This function is reimplemented for internal reasons.
keyPressEvent
in class QWidget
public QSize minimumSizeHint()
This function is reimplemented for internal reasons.
minimumSizeHint
in class QWidget
protected void mouseMoveEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mouseMoveEvent
in class QWidget
Example
protected void mousePressEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mousePressEvent
in class QWidget
Example
protected void mouseReleaseEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mouseReleaseEvent
in class QWidget
Example
protected void paintEvent(QPaintEvent arg__1)
This function is reimplemented for internal reasons.
paintEvent
in class QWidget
protected void resizeEvent(QResizeEvent arg__1)
This function is reimplemented for internal reasons.
resizeEvent
in class QWidget
Example
protected void showEvent(QShowEvent arg__1)
This function is reimplemented for internal reasons.
showEvent
in class QWidget
visible
,
event,
QShowEventpublic QSize sizeHint()
This function is reimplemented for internal reasons.
sizeHint
in class QWidget
protected void tabInserted(int index)
This virtual handler is called after a new tab was added or inserted at position index.
protected void tabLayoutChange()
This virtual handler is called whenever the tab layout changes.
protected void tabRemoved(int index)
This virtual handler is called after a tab was removed from position index.
protected QSize tabSizeHint(int index)
Returns the size hint for the tab at position index.
public static QTabBar fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.public final void initStyleOption(QStyleOptionTab option, int tabIndex)
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |