Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QTabBar Class Reference

The QTabBar class provides a tab bar, e.g. More...

#include <qtabbar.h>

+ Inheritance diagram for QTabBar:
+ Collaboration diagram for QTabBar:

Public Types

enum  Shape {
  RoundedNorth , RoundedSouth , RoundedWest , RoundedEast ,
  TriangularNorth , TriangularSouth , TriangularWest , TriangularEast
}
 This enum type lists the built-in shapes supported by QTabBar. More...
 
enum  ButtonPosition { LeftSide , RightSide }
 
enum  SelectionBehavior { SelectLeftTab , SelectRightTab , SelectPreviousTab }
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled
}
 

Public Slots

void setCurrentIndex (int index)
 
- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events.
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden.
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.
 
virtual void setVisible (bool visible)
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden).
 
void show ()
 Shows the widget and its child widgets.
 
void hide ()
 Hides the widget.
 
void showMinimized ()
 Shows the widget minimized, as an icon.
 
void showMaximized ()
 Shows the widget maximized.
 
void showFullScreen ()
 Shows the widget in full-screen mode.
 
void showNormal ()
 Restores the widget after it has been maximized or minimized.
 
bool close ()
 Closes this widget.
 
void raise ()
 Raises this widget to the top of the parent widget's stack.
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void currentChanged (int index)
 This signal is emitted when the tab bar's current tab changes.
 
void tabCloseRequested (int index)
 
void tabMoved (int from, int to)
 
void tabBarClicked (int index)
 This signal is emitted when user clicks on a tab at an index.
 
void tabBarDoubleClicked (int index)
 This signal is emitted when the user double clicks on a tab at index.
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 This signal is emitted when the window's title has changed, with the new title as an argument.
 
void windowIconChanged (const QIcon &icon)
 This signal is emitted when the window's icon has changed, with the new icon as an argument.
 
void windowIconTextChanged (const QString &iconText)
 This signal is emitted when the window's icon text has changed, with the new iconText as an argument.
 
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QTabBar (QWidget *parent=nullptr)
 Creates a new tab bar with the given parent.
 
 ~QTabBar ()
 Destroys the tab bar.
 
Shape shape () const
 
void setShape (Shape shape)
 
int addTab (const QString &text)
 Adds a new tab with text text.
 
int addTab (const QIcon &icon, const QString &text)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds a new tab with icon icon and text text.
 
int insertTab (int index, const QString &text)
 Inserts a new tab with text text at position index.
 
int insertTab (int index, const QIcon &icon, const QString &text)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Inserts a new tab with icon icon and text text at position index.
 
void removeTab (int index)
 Removes the tab at position index.
 
void moveTab (int from, int to)
 Moves the item at index position from to index position to.
 
bool isTabEnabled (int index) const
 Returns true if the tab at position index is enabled; otherwise returns false.
 
void setTabEnabled (int index, bool enabled)
 If enabled is true then the tab at position index is enabled; otherwise the item at position index is disabled.
 
bool isTabVisible (int index) const
 Returns true if the tab at position index is visible; otherwise returns false.
 
void setTabVisible (int index, bool visible)
 If visible is true, make the tab at position index visible, otherwise make it hidden.
 
QString tabText (int index) const
 Returns the text of the tab at position index, or an empty string if index is out of range.
 
void setTabText (int index, const QString &text)
 Sets the text of the tab at position index to text.
 
QColor tabTextColor (int index) const
 Returns the text color of the tab with the given index, or a invalid color if index is out of range.
 
void setTabTextColor (int index, const QColor &color)
 Sets the color of the text in the tab with the given index to the specified color.
 
QIcon tabIcon (int index) const
 Returns the icon of the tab at position index, or a null icon if index is out of range.
 
void setTabIcon (int index, const QIcon &icon)
 Sets the icon of the tab at position index to icon.
 
Qt::TextElideMode elideMode () const
 
void setElideMode (Qt::TextElideMode mode)
 
void setTabData (int index, const QVariant &data)
 Sets the data of the tab at position index to data.
 
QVariant tabData (int index) const
 Returns the data of the tab at position index, or a null variant if index is out of range.
 
QRect tabRect (int index) const
 Returns the visual rectangle of the tab at position index, or a null rectangle if index is hidden, or out of range.
 
int tabAt (const QPoint &pos) const
 
int currentIndex () const
 
int count () const
 
QSize sizeHint () const override
 \reimp
 
QSize minimumSizeHint () const override
 \reimp
 
void setDrawBase (bool drawTheBase)
 
bool drawBase () const
 
QSize iconSize () const
 
void setIconSize (const QSize &size)
 
bool usesScrollButtons () const
 
void setUsesScrollButtons (bool useButtons)
 
bool tabsClosable () const
 
void setTabsClosable (bool closable)
 
void setTabButton (int index, ButtonPosition position, QWidget *widget)
 Sets widget on the tab index.
 
QWidget * tabButton (int index, ButtonPosition position) const
 Returns the widget set a tab index and position or \nullptr if one is not set.
 
SelectionBehavior selectionBehaviorOnRemove () const
 
void setSelectionBehaviorOnRemove (SelectionBehavior behavior)
 
bool expanding () const
 
void setExpanding (bool enabled)
 
bool isMovable () const
 
void setMovable (bool movable)
 
bool documentMode () const
 
void setDocumentMode (bool set)
 
bool autoHide () const
 
void setAutoHide (bool hide)
 
bool changeCurrentOnDrag () const
 
void setChangeCurrentOnDrag (bool change)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a widget which is a child of parent, with widget flags set to f.
 
 ~QWidget ()
 Destroys the widget.
 
int devType () const override
 
WId winId () const
 Returns the window system identifier of the widget.
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStyle * style () const
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style.
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false.
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.
 
QRect frameGeometry () const
 
const QRect & geometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
int minimumWidth () const
 
int minimumHeight () const
 
int maximumWidth () const
 
int maximumHeight () const
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).
 
void setMinimumWidth (int minw)
 
void setMinimumHeight (int minh)
 
void setMaximumWidth (int maxw)
 
void setMaximumHeight (int maxh)
 
QSize sizeIncrement () const
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.
 
void setFixedSize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights.
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths.
 
QPointF mapToGlobal (const QPointF &) const
 Translates the widget coordinate pos to global screen coordinates.
 
QPoint mapToGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromGlobal (const QPointF &) const
 Translates the global screen coordinate pos to widget coordinates.
 
QPoint mapFromGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapToParent (const QPointF &) const
 Translates the widget coordinate pos to a coordinate in the parent widget.
 
QPoint mapToParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromParent (const QPointF &) const
 Translates the parent widget coordinate pos to widget coordinates.
 
QPoint mapFromParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapTo (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos to the coordinate system of parent.
 
QPoint mapTo (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QWidget * window () const
 Returns the window for this widget, i.e.
 
QWidget * nativeParentWidget () const
 
QWidget * topLevelWidget () const
 
const QPalette & palette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role.
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget.
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role.
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role.
 
const QFont & font () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font.
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font.
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false.
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.
 
void setMask (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.
 
QRegion mask () const
 Returns the mask currently set on a widget.
 
void clearMask ()
 Removes any mask set by setMask().
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags.
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type.
 
QString styleSheet () const
 
QString windowTitle () const
 
void setWindowIcon (const QIcon &icon)
 
QIcon windowIcon () const
 
void setWindowIconText (const QString &)
 
QString windowIconText () const
 
void setWindowRole (const QString &)
 Sets the window's role to role.
 
QString windowRole () const
 Returns the window's role, or an empty string.
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
Qt::LayoutDirection layoutDirection () const
 
void unsetLayoutDirection ()
 
void setLocale (const QLocale &locale)
 
QLocale locale () const
 
void unsetLocale ()
 
bool isRightToLeft () const
 
bool isLeftToRight () const
 
bool isActiveWindow () const
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window.
 
void clearFocus ()
 Takes keyboard input focus from the widget.
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w.
 
QWidget * focusProxy () const
 Returns the focus proxy, or \nullptr if there is no focus proxy.
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 Grabs the mouse input.
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 Releases the mouse grab.
 
void grabKeyboard ()
 Grabs the keyboard input.
 
void releaseKeyboard ()
 Releases the keyboard grab.
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system.
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.
 
void update (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.
 
void update (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void repaint (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.
 
void repaint (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.
 
void repaint (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack.
 
void move (int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).
 
void move (const QPoint &)
 
void resize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents.
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false.
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false.
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 Returns the current window state.
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState.
 
void overrideWindowState (Qt::WindowStates state)
 
QSizePolicy sizePolicy () const
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w.
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur.
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.
 
void setContentsMargins (const QMargins &margins)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins.
 
QRect contentsRect () const
 Returns the area inside the widget's margins.
 
QLayout * layout () const
 Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout.
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry.
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags.
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward.
 
void scroll (int dx, int dy, const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.
 
QWidget * focusWidget () const
 Returns the last child of this widget that setFocus had been called on.
 
QWidget * nextInFocusChain () const
 Returns the next widget in this widget's focus chain.
 
QWidget * previousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain.
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions.
 
void addActions (const QList< QAction * > &actions)
 Appends the actions actions to this widget's list of actions.
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 Inserts the actions actions to this widget's list of actions, before the action before.
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before.
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions.
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions.
 
QAction * addAction (const QString &text)
 
QAction * addAction (const QIcon &icon, const QString &text)
 
QAction * addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
QAction * addAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction * addAction (const QString &text, Args &&...args)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction * addAction (const QIcon &icon, const QString &text, Args &&...args)
 
QWidget * parentWidget () const
 Returns the parent of this widget, or \nullptr if it does not have any parent widget.
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e.g.
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system.
 
Qt::WindowType windowType () const
 Returns the window type of this widget.
 
QWidget * childAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.
 
QWidget * childAt (const QPoint &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false.
 
QPaintEngine * paintEngine () const override
 Returns the widget's paint engine.
 
void ensurePolished () const
 Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStore * backingStore () const
 
QWindow * windowHandle () const
 If this is a native widget, return the associated QWindow.
 
QScreen * screen () const
 Returns the screen the widget is on.
 
void setScreen (QScreen *)
 Sets the screen on which the widget should be shown to screen.
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery) const
 This method is only relevant for input widgets.
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
bool paintingActive () const
 
int width () const
 
int height () const
 
int widthMM () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
qreal devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int colorCount () const
 
int depth () const
 

Protected Member Functions

virtual QSize tabSizeHint (int index) const
 Returns the size hint for the tab at position index.
 
virtual QSize minimumTabSizeHint (int index) const
 Returns the minimum tab size hint for the tab at position index.
 
virtual void tabInserted (int index)
 This virtual handler is called after a new tab was added or inserted at position index.
 
virtual void tabRemoved (int index)
 This virtual handler is called after a tab was removed from position index.
 
virtual void tabLayoutChange ()
 This virtual handler is called whenever the tab layout changes.
 
bool event (QEvent *) override
 \reimp
 
void resizeEvent (QResizeEvent *) override
 \reimp
 
void showEvent (QShowEvent *) override
 \reimp
 
void hideEvent (QHideEvent *) override
 \reimp
 
void paintEvent (QPaintEvent *) override
 \reimp
 
void mousePressEvent (QMouseEvent *) override
 \reimp
 
void mouseMoveEvent (QMouseEvent *) override
 \reimp
 
void mouseReleaseEvent (QMouseEvent *) override
 \reimp
 
void mouseDoubleClickEvent (QMouseEvent *) override
 \reimp
 
void keyPressEvent (QKeyEvent *) override
 \reimp
 
void changeEvent (QEvent *) override
 \reimp
 
void timerEvent (QTimerEvent *event) override
 \reimp
 
virtual void initStyleOption (QStyleOptionTab *option, int tabIndex) const
 Initialize option with the values from the tab at tabIndex.
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 This is the main event handler; it handles event event.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.
 
virtual void focusInEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.
 
virtual void focusOutEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.
 
virtual void enterEvent (QEnterEvent *event)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.
 
virtual void leaveEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.
 
virtual void moveEvent (QMoveEvent *event)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.
 
virtual void closeEvent (QCloseEvent *event)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.
 
virtual void actionEvent (QActionEvent *event)
 This event handler is called with the given event whenever the widget's actions are changed.
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.
 
int metric (PaintDeviceMetric) const override
 Internal implementation of the virtual QPaintDevice::metric() function.
 
void initPainter (QPainter *painter) const override
 Initializes the painter pen, background and font to the same as the given widget's.
 
QPaintDevice * redirected (QPoint *offset) const override
 
QPainter * sharedPainter () const override
 
virtual void inputMethodEvent (QInputMethodEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window.
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources.
 
virtual bool focusNextPrevChild (bool next)
 Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
 

Properties

Shape shape
 the shape of the tabs in the tab bar
 
int currentIndex
 the index of the tab bar's visible tab
 
int count
 the number of tabs in the tab bar
 
bool drawBase
 defines whether or not tab bar should draw its base.
 
QSize iconSize
 The size for icons in the tab bar.
 
Qt::TextElideMode elideMode
 how to elide text in the tab bar
 
bool usesScrollButtons
 Whether or not a tab bar should use buttons to scroll tabs when it has many tabs.
 
bool tabsClosable
 Whether or not a tab bar should place close buttons on each tab.
 
SelectionBehavior selectionBehaviorOnRemove
 What tab should be set as current when removeTab is called if the removed tab is also the current tab.
 
bool expanding
 When expanding is true QTabBar will expand the tabs to use the empty space.
 
bool movable
 This property holds whether the user can move the tabs within the tabbar area.
 
bool documentMode
 Whether or not the tab bar is rendered in a mode suitable for the main window.
 
bool autoHide
 If true, the tab bar is automatically hidden when it contains less than 2 tabs.
 
bool changeCurrentOnDrag
 If true, then the current tab is automatically changed when dragging over the tabbar.
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget
 
bool enabled
 whether the widget is enabled
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget
 
int x
 the x coordinate of the widget relative to its parent including any window frame
 
int y
 the y coordinate of the widget relative to its parent and including any window frame
 
QPoint pos
 the position of the widget within its parent widget
 
QSize frameSize
 the size of the widget including any window frame
 
QSize size
 the size of the widget excluding any window frame
 
int width
 the width of the widget excluding any window frame
 
int height
 the height of the widget excluding any window frame
 
QRect rect
 the internal geometry of the widget excluding any window frame
 
QRect childrenRect
 the bounding rectangle of the widget's children
 
QRegion childrenRegion
 the combined region occupied by the widget's children
 
QSizePolicy sizePolicy
 the default layout behavior of the widget
 
QSize minimumSize
 the widget's minimum size
 
QSize maximumSize
 the widget's maximum size in pixels
 
int minimumWidth
 the widget's minimum width in pixels
 
int minimumHeight
 the widget's minimum height in pixels
 
int maximumWidth
 the widget's maximum width in pixels
 
int maximumHeight
 the widget's maximum height in pixels
 
QSize sizeIncrement
 the size increment of the widget
 
QSize baseSize
 the base size of the widget
 
QPalette palette
 the widget's palette
 
QFont font
 the font currently set for the widget
 
QCursor cursor
 the cursor shape for this widget
 
bool mouseTracking
 whether mouse tracking is enabled for the widget
 
bool tabletTracking
 whether tablet tracking is enabled for the widget
 
bool isActiveWindow
 whether this widget's window is the active window
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu
 
bool updatesEnabled
 whether updates are enabled
 
bool visible
 whether the widget is visible
 
bool minimized
 whether this widget is minimized (iconified)
 
bool maximized
 whether this widget is maximized
 
bool fullScreen
 whether the widget is shown in full screen mode
 
QSize sizeHint
 the recommended size for the widget
 
QSize minimumSizeHint
 the recommended minimum size for the widget
 
bool acceptDrops
 whether drop events are enabled for this widget
 
QString windowTitle
 the window title (caption)
 
QIcon windowIcon
 the widget's icon
 
QString windowIconText
 the text to be displayed on the icon of a minimized window
 
double windowOpacity
 The level of opacity for the window.
 
bool windowModified
 whether the document shown in the window has unsaved changes
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget.
 
bool autoFillBackground
 whether the widget background is filled automatically
 
QString styleSheet
 the widget's style sheet
 
QLocale locale
 the widget's locale
 
QString windowFilePath
 the file path associated with a widget
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order.
 
static void setTabOrder (std::initializer_list< QWidget * > widgets)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static QWidget * mouseGrabber ()
 Returns the widget that is currently grabbing the mouse input.
 
static QWidget * keyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input.
 
static QWidget * find (WId)
 Returns a pointer to the widget with window identifier/handle id.
 
static QWidget * createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Creates a QWidget that makes it possible to embed window into a QWidget-based application.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
 
- Protected Slots inherited from QWidget
void updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
 Updates the widget's micro focus and informs input methods that the state specified by query has changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 
- Related Symbols inherited from QWidget
 \macro QWIDGETSIZE_MAX
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

The QTabBar class provides a tab bar, e.g.

for use in tabbed dialogs.

\inmodule QtWidgets

QTabBar is straightforward to use; it draws the tabs using one of the predefined \l{QTabBar::Shape}{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 \l{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 \l shape property defines the tabs' appearance. The choice of shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use \l RoundedNorth. Tab controls in windows other than dialogs almost always use either \l RoundedSouth or \l TriangularSouth. Many spreadsheets and other tab controls in which all the pages are essentially similar use \l TriangularSouth, whereas \l RoundedSouth is used mostly when the pages are different (e.g. a multi-page tool palette). The default in QTabBar is \l 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, \l 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:

\list

For subclasses, you might also need the tabRect() functions which returns the visual geometry of a single tab.

\table 100% \row

  • \inlineimage {fusion-tabbar.png} {Screenshot of a Fusion style tab bar}
  • A tab bar shown in the \l{Qt Widget Gallery}{Fusion widget style}. \row
  • \inlineimage {fusion-tabbar-truncated.png} {Screenshot of a truncated Fusion tab bar}
  • A truncated tab bar shown in the Fusion widget style. \endtable
See also
QTabWidget

Definition at line 18 of file qtabbar.h.

Member Enumeration Documentation

◆ ButtonPosition

enum QTabBar::ButtonPosition
Since
4.5

This enum type lists the location of the widget on a tab.

\value LeftSide Left side of the tab.

\value RightSide Right side of the tab.

Enumerator
LeftSide 
RightSide 

Definition at line 47 of file qtabbar.h.

◆ SelectionBehavior

enum QTabBar::SelectionBehavior
Since
4.5

This enum type lists the behavior of QTabBar when a tab is removed and the tab being removed is also the current tab.

\value SelectLeftTab Select the tab to the left of the one being removed.

\value SelectRightTab Select the tab to the right of the one being removed.

\value SelectPreviousTab Select the previously selected tab.

Enumerator
SelectLeftTab 
SelectRightTab 
SelectPreviousTab 

Definition at line 52 of file qtabbar.h.

◆ Shape

enum QTabBar::Shape

This enum type lists the built-in shapes supported by QTabBar.

Treat these as hints as some styles may not render some of the shapes. However, position should be honored.

\value RoundedNorth The normal rounded look above the pages

\value RoundedSouth The normal rounded look below the pages

\value RoundedWest The normal rounded look on the left side of the pages

\value RoundedEast The normal rounded look on the right side the pages

\value TriangularNorth Triangular tabs above the pages.

\value TriangularSouth Triangular tabs similar to those used in the Excel spreadsheet, for example

\value TriangularWest Triangular tabs on the left of the pages.

\value TriangularEast Triangular tabs on the right of the pages.

Enumerator
RoundedNorth 
RoundedSouth 
RoundedWest 
RoundedEast 
TriangularNorth 
TriangularSouth 
TriangularWest 
TriangularEast 

Definition at line 42 of file qtabbar.h.

Constructor & Destructor Documentation

◆ QTabBar()

QTabBar::QTabBar ( QWidget * parent = nullptr)
explicit

Creates a new tab bar with the given parent.

Definition at line 849 of file qtabbar.cpp.

◆ ~QTabBar()

QTabBar::~QTabBar ( )

Destroys the tab bar.

Definition at line 860 of file qtabbar.cpp.

Member Function Documentation

◆ addTab() [1/2]

int QTabBar::addTab ( const QIcon & icon,
const QString & text )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds a new tab with icon icon and text text.

Returns the new tab's index.

Definition at line 927 of file qtabbar.cpp.

References icon, insertTab(), and text.

+ Here is the call graph for this function:

◆ addTab() [2/2]

int QTabBar::addTab ( const QString & text)

Adds a new tab with text text.

Returns the new tab's index.

Definition at line 916 of file qtabbar.cpp.

References insertTab(), and text.

+ Here is the call graph for this function:

◆ autoHide()

bool QTabBar::autoHide ( ) const

Definition at line 2732 of file qtabbar.cpp.

References d.

◆ changeCurrentOnDrag()

bool QTabBar::changeCurrentOnDrag ( ) const

Definition at line 2763 of file qtabbar.cpp.

References d.

◆ changeEvent()

void QTabBar::changeEvent ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2451 of file qtabbar.cpp.

References QWidget::changeEvent(), d, QEvent::FontChange, Q_FALLTHROUGH, QStyle::SH_TabBar_ElideMode, QStyle::SH_TabBar_PreferNoArrows, QWidget::style(), QEvent::StyleChange, and QStyle::styleHint().

+ Here is the call graph for this function:

◆ count()

int QTabBar::count ( ) const

Definition at line 1478 of file qtabbar.cpp.

References d.

◆ currentChanged

void QTabBar::currentChanged ( int index)
signal

This signal is emitted when the tab bar's current tab changes.

The new current has the given index, or -1 if there isn't a new one (for example, if there are no tab in the QTabBar)

Referenced by moveTab(), removeTab(), setCurrentIndex(), and QTabWidget::setTabBar().

+ Here is the caller graph for this function:

◆ currentIndex()

int QTabBar::currentIndex ( ) const

Definition at line 1391 of file qtabbar.cpp.

References d.

◆ documentMode()

bool QTabBar::documentMode ( ) const

Definition at line 2708 of file qtabbar.cpp.

◆ drawBase()

bool QTabBar::drawBase ( ) const

Definition at line 906 of file qtabbar.cpp.

References d.

◆ elideMode()

Qt::TextElideMode QTabBar::elideMode ( ) const

Definition at line 2500 of file qtabbar.cpp.

References d.

◆ event()

bool QTabBar::event ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1672 of file qtabbar.cpp.

References d, QEvent::DragEnter, QEvent::DragLeave, QEvent::DragMove, QEvent::Drop, QWidget::event(), QEvent::HoverEnter, QEvent::HoverLeave, QEvent::HoverMove, i, isTabEnabled(), QObject::killTimer(), QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, QEvent::Move, QHelpEvent::pos(), QWidget::pos, QSinglePointEvent::position(), position(), setCurrentIndex(), QStyle::SH_TabBar_ChangeCurrentDelay, QEvent::Shortcut, QTabBarPrivate::Tab::shortcutId, QWhatsThis::showText(), QToolTip::showText(), QObject::startTimer(), QWidget::style(), tabAt(), tabRect(), QEvent::ToolTip, QPointF::toPoint(), QWidget::update(), and QEvent::WhatsThis.

+ Here is the call graph for this function:

◆ expanding()

bool QTabBar::expanding ( ) const

Definition at line 2659 of file qtabbar.cpp.

References d.

◆ hideEvent()

void QTabBar::hideEvent ( QHideEvent * )
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1664 of file qtabbar.cpp.

References d.

◆ iconSize()

QSize QTabBar::iconSize ( ) const

Definition at line 1454 of file qtabbar.cpp.

References d, QStyle::pixelMetric(), QStyle::PM_TabBarIconSize, and QWidget::style().

+ Here is the call graph for this function:

◆ initStyleOption()

void QTabBar::initStyleOption ( QStyleOptionTab * option,
int tabIndex ) const
protectedvirtual

Initialize option with the values from the tab at tabIndex.

This method is useful for subclasses when they need a QStyleOptionTab, but don't want to fill in all the information themselves.

See also
QStyleOption::initFrom(), QTabWidget::initStyleOption()

Definition at line 202 of file qtabbar.cpp.

References d, QFontMetrics::elidedText(), QWidget::fontMetrics(), QStyle::SE_TabBarTabText, QWidget::style(), QStyle::subElementRect(), textRect, Qt::TextShowMnemonic, and QRect::width().

Referenced by insertTab(), and paintEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ insertTab() [1/2]

int QTabBar::insertTab ( int index,
const QIcon & icon,
const QString & text )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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.

Definition at line 954 of file qtabbar.cpp.

References QTabBarPrivate::closeTab(), QObjectPrivate::connect(), currentIndex, d, QWidget::grabShortcut(), icon, initStyleOption(), QKeySequence::mnemonic(), opt, qMax(), qMin(), setCurrentIndex(), setTabButton(), QStyle::SH_TabBar_CloseButtonPosition, QWidget::style(), QStyle::styleHint(), tabAt(), tabInserted(), tabRect(), and text.

+ Here is the call graph for this function:

◆ insertTab() [2/2]

int QTabBar::insertTab ( int index,
const QString & text )

Inserts a new tab with text text at position index.

If index is out of range, the new tab is appended. Returns the new tab's index.

Definition at line 937 of file qtabbar.cpp.

References insertTab(), and text.

Referenced by addTab(), addTab(), and insertTab().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isMovable()

bool QTabBar::isMovable ( ) const

Definition at line 2684 of file qtabbar.cpp.

References d.

Referenced by QTabWidget::isMovable().

+ Here is the caller graph for this function:

◆ isTabEnabled()

bool QTabBar::isTabEnabled ( int index) const

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

Definition at line 1102 of file qtabbar.cpp.

References d.

Referenced by event().

+ Here is the caller graph for this function:

◆ isTabVisible()

bool QTabBar::isTabVisible ( int index) const

Returns true if the tab at position index is visible; otherwise returns false.

Since
5.15

Definition at line 1136 of file qtabbar.cpp.

References d.

Referenced by setTabEnabled().

+ Here is the caller graph for this function:

◆ keyPressEvent()

void QTabBar::keyPressEvent ( QKeyEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2364 of file qtabbar.cpp.

References d, QWidget::isRightToLeft(), Qt::Key_Left, and Qt::Key_Right.

+ Here is the call graph for this function:

◆ minimumSizeHint()

QSize QTabBar::minimumSizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 1502 of file qtabbar.cpp.

References d, QWidget::height, QRect::size(), sizeHint(), QRect::united(), verticalTabs(), and QSize::width().

+ Here is the call graph for this function:

◆ minimumTabSizeHint()

QSize QTabBar::minimumTabSizeHint ( int index) const
protectedvirtual

Returns the minimum tab size hint for the tab at position index.

Since
5.0

Definition at line 1551 of file qtabbar.cpp.

References computeElidedText(), d, QWidget::size, tabSizeHint(), and QTabBarPrivate::Tab::text.

+ Here is the call graph for this function:

◆ mouseDoubleClickEvent()

void QTabBar::mouseDoubleClickEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2350 of file qtabbar.cpp.

References d, emit, mousePressEvent(), QWidget::pos, tabAt(), and tabBarDoubleClicked().

+ Here is the call graph for this function:

◆ mouseMoveEvent()

void QTabBar::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2160 of file qtabbar.cpp.

References d, i, QWidget::isRightToLeft(), Qt::LeftButton, Qt::NoButton, QApplication::startDragDistance, tabAt(), tabRect(), QWidget::update(), and verticalTabs().

+ Here is the call graph for this function:

◆ mousePressEvent()

void QTabBar::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2122 of file qtabbar.cpp.

References d, emit, Qt::LeftButton, QWidget::pos, QWidget::repaint(), setCurrentIndex(), QStyle::SH_TabBar_SelectMouseType, QWidget::style(), tabBarClicked(), and tabRect().

Referenced by mouseDoubleClickEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mouseReleaseEvent()

void QTabBar::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2312 of file qtabbar.cpp.

References ANIMATION_DURATION, d, QRect::height(), i, Qt::LeftButton, QEvent::MouseButtonRelease, qAbs(), qMin(), setCurrentIndex(), QStyle::SH_TabBar_SelectMouseType, QWidget::style(), QStyle::styleHint(), tabRect(), QWidget::update(), verticalTabs(), and QRect::width().

+ Here is the call graph for this function:

◆ moveTab()

void QTabBar::moveTab ( int from,
int to )

Moves the item at index position from to index position to.

Since
4.5
See also
tabMoved(), tabLayoutChange()

Definition at line 2007 of file qtabbar.cpp.

References currentChanged(), d, direction, emit, i, QWidget::isRightToLeft(), qMax(), qMin(), tabLayoutChange(), tabMoved(), QWidget::update(), verticalTabs(), and QWidget::width.

+ Here is the call graph for this function:

◆ paintEvent()

void QTabBar::paintEvent ( QPaintEvent * )
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1801 of file qtabbar.cpp.

References QRect::bottom(), QStyle::CE_TabBarTab, d, QPalette::Disabled, i, QStyleOption::initFrom(), QTabBarPrivate::initStyleBaseOption(), initStyleOption(), QRect::left(), opt, QStyle::PE_FrameTabBarBase, QStyle::PE_IndicatorTabTearLeft, QStyle::PE_IndicatorTabTearRight, QStyle::pixelMetric(), QStyle::PM_TabBarTabOverlap, QWidget::rect, QRect::right(), QStyle::SE_TabBarScrollLeftButton, QStyle::SE_TabBarScrollRightButton, QStyle::SE_TabBarTearIndicatorLeft, QStyle::SE_TabBarTearIndicatorRight, QWidget::size, QStyle::State_Enabled, QWidget::style(), QStyle::subElementRect(), tabRect(), QRect::top(), and verticalTabs().

+ Here is the call graph for this function:

◆ removeTab()

void QTabBar::removeTab ( int index)

Removes the tab at position index.

See also
SelectionBehavior

Definition at line 1009 of file qtabbar.cpp.

References currentChanged(), currentIndex, d, emit, Q_FALLTHROUGH, qBound(), QWidget::releaseShortcut(), SelectLeftTab, SelectPreviousTab, SelectRightTab, setCurrentIndex(), tabAt(), tabRect(), tabRemoved(), and QWidget::update().

Referenced by QTabWidgetPrivate::removeTab().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ resizeEvent()

void QTabBar::resizeEvent ( QResizeEvent * )
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1787 of file qtabbar.cpp.

References d, and QWidget::updateGeometry().

+ Here is the call graph for this function:

◆ selectionBehaviorOnRemove()

QTabBar::SelectionBehavior QTabBar::selectionBehaviorOnRemove ( ) const

Definition at line 2637 of file qtabbar.cpp.

References d.

◆ setAutoHide()

void QTabBar::setAutoHide ( bool hide)

Definition at line 2738 of file qtabbar.cpp.

References d, QWidget::hide(), and QWidget::setVisible().

+ Here is the call graph for this function:

◆ setChangeCurrentOnDrag()

void QTabBar::setChangeCurrentOnDrag ( bool change)

Definition at line 2769 of file qtabbar.cpp.

References d.

◆ setCurrentIndex

void QTabBar::setCurrentIndex ( int index)
slot

Definition at line 1400 of file qtabbar.cpp.

References currentChanged(), d, emit, QWidget::hasFocus(), QWidget::isVisible(), QWidget::size, tabRect(), tabSizeHint(), and QWidget::update().

Referenced by event(), insertTab(), mousePressEvent(), mouseReleaseEvent(), removeTab(), setTabEnabled(), setTabVisible(), showEvent(), and timerEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDocumentMode()

void QTabBar::setDocumentMode ( bool set)

Definition at line 2713 of file qtabbar.cpp.

References d, and QWidget::enabled.

◆ setDrawBase()

void QTabBar::setDrawBase ( bool drawTheBase)

Definition at line 897 of file qtabbar.cpp.

References d, drawBase, and QWidget::update().

Referenced by QTabWidgetPrivate::init().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setElideMode()

void QTabBar::setElideMode ( Qt::TextElideMode mode)

Definition at line 2506 of file qtabbar.cpp.

References d.

◆ setExpanding()

void QTabBar::setExpanding ( bool enabled)

Definition at line 2665 of file qtabbar.cpp.

References d, and QWidget::enabled.

◆ setIconSize()

void QTabBar::setIconSize ( const QSize & size)

Definition at line 1464 of file qtabbar.cpp.

References d, QWidget::size, QWidget::update(), and QWidget::updateGeometry().

+ Here is the call graph for this function:

◆ setMovable()

void QTabBar::setMovable ( bool movable)

Definition at line 2690 of file qtabbar.cpp.

References d, and movable.

Referenced by QTabWidget::setMovable().

+ Here is the caller graph for this function:

◆ setSelectionBehaviorOnRemove()

void QTabBar::setSelectionBehaviorOnRemove ( QTabBar::SelectionBehavior behavior)

Definition at line 2643 of file qtabbar.cpp.

References d.

◆ setShape()

void QTabBar::setShape ( Shape shape)

Definition at line 878 of file qtabbar.cpp.

References d, and shape.

Referenced by QTabWidgetPrivate::updateTabBarPosition().

+ Here is the caller graph for this function:

◆ setTabButton()

void QTabBar::setTabButton ( int index,
ButtonPosition position,
QWidget * widget )

Sets widget on the tab index.

The widget is placed on the left or right hand side depending on the position.

Since
4.5

Any previously set widget in position is hidden. Setting widget to \nullptr will hide the current widget at position.

The tab bar will take ownership of the widget and so all widgets set here will be deleted by the tab bar when it is destroyed unless you separately reparent the widget after setting some other widget (or \nullptr).

See also
tabsClosable()

Definition at line 2791 of file qtabbar.cpp.

References d, QWidget::hide(), LeftSide, QWidget::lower(), position(), QWidget::setParent(), QWidget::show(), QWidget::update(), and widget.

Referenced by insertTab(), and setTabsClosable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTabData()

void QTabBar::setTabData ( int index,
const QVariant & data )

Sets the data of the tab at position index to data.

Definition at line 1319 of file qtabbar.cpp.

References d.

◆ setTabEnabled()

void QTabBar::setTabEnabled ( int index,
bool enabled )

If enabled is true then the tab at position index is enabled; otherwise the item at position index is disabled.

Definition at line 1114 of file qtabbar.cpp.

References d, QWidget::enabled, isTabVisible(), setCurrentIndex(), QWidget::setShortcutEnabled(), and QWidget::update().

+ Here is the call graph for this function:

◆ setTabIcon()

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

Sets the icon of the tab at position index to icon.

Definition at line 1249 of file qtabbar.cpp.

References d, icon, QIcon::isNull(), tabRect(), and QWidget::update().

+ Here is the call graph for this function:

◆ setTabsClosable()

void QTabBar::setTabsClosable ( bool closable)

Definition at line 2563 of file qtabbar.cpp.

References QTabBarPrivate::closeTab(), QObjectPrivate::connect(), d, i, LeftSide, RightSide, setTabButton(), QStyle::SH_TabBar_CloseButtonPosition, QWidget::style(), QStyle::styleHint(), tabButton(), and QWidget::update().

Referenced by QTabWidget::setTabsClosable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTabText()

void QTabBar::setTabText ( int index,
const QString & text )

Sets the text of the tab at position index to text.

Definition at line 1189 of file qtabbar.cpp.

References d, QWidget::grabShortcut(), QKeySequence::mnemonic(), QWidget::releaseShortcut(), QWidget::setShortcutEnabled(), and text.

+ Here is the call graph for this function:

◆ setTabTextColor()

void QTabBar::setTabTextColor ( int index,
const 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.

See also
tabTextColor()

Definition at line 1225 of file qtabbar.cpp.

References d, tabRect(), and QWidget::update().

+ Here is the call graph for this function:

◆ setTabVisible()

void QTabBar::setTabVisible ( int index,
bool visible )

If visible is true, make the tab at position index visible, otherwise make it hidden.

Since
5.15

Definition at line 1149 of file qtabbar.cpp.

References d, setCurrentIndex(), QWidget::setShortcutEnabled(), QWidget::update(), and QWidget::visible.

+ Here is the call graph for this function:

◆ setUsesScrollButtons()

void QTabBar::setUsesScrollButtons ( bool useButtons)

Definition at line 2533 of file qtabbar.cpp.

References d.

◆ shape()

QTabBar::Shape QTabBar::shape ( ) const

Definition at line 872 of file qtabbar.cpp.

References d.

◆ showEvent()

void QTabBar::showEvent ( QShowEvent * )
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1650 of file qtabbar.cpp.

References d, and setCurrentIndex().

+ Here is the call graph for this function:

◆ sizeHint()

QSize QTabBar::sizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 1487 of file qtabbar.cpp.

References d, QRect::size(), and QRect::united().

Referenced by minimumSizeHint().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tabAt()

int QTabBar::tabAt ( const QPoint & position) const
Since
4.3 Returns the index of the tab that covers position or -1 if no tab covers position;

Definition at line 1368 of file qtabbar.cpp.

References contains(), QRect::contains(), d, i, position(), and tabRect().

Referenced by event(), insertTab(), mouseDoubleClickEvent(), mouseMoveEvent(), and removeTab().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tabBarClicked

void QTabBar::tabBarClicked ( int index)
signal

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

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

Since
5.2

Referenced by mousePressEvent(), and QTabWidget::setTabBar().

+ Here is the caller graph for this function:

◆ tabBarDoubleClicked

void QTabBar::tabBarDoubleClicked ( int index)
signal

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

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

Since
5.2

Referenced by mouseDoubleClickEvent(), and QTabWidget::setTabBar().

+ Here is the caller graph for this function:

◆ tabButton()

QWidget * QTabBar::tabButton ( int index,
ButtonPosition position ) const

Returns the widget set a tab index and position or \nullptr if one is not set.

Definition at line 2821 of file qtabbar.cpp.

References d, LeftSide, and position().

Referenced by QMacStyle::drawPrimitive(), and setTabsClosable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tabCloseRequested

void QTabBar::tabCloseRequested ( int index)
signal
Since
4.5

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

See also
setTabsClosable()

Referenced by QTabWidget::setTabBar().

+ Here is the caller graph for this function:

◆ tabData()

QVariant QTabBar::tabData ( int index) const

Returns the data of the tab at position index, or a null variant if index is out of range.

Definition at line 1330 of file qtabbar.cpp.

References d.

◆ tabIcon()

QIcon QTabBar::tabIcon ( int index) const

Returns the icon of the tab at position index, or a null icon if index is out of range.

Definition at line 1238 of file qtabbar.cpp.

References d.

◆ tabInserted()

void QTabBar::tabInserted ( int index)
protectedvirtual

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

See also
tabRemoved()

Definition at line 1622 of file qtabbar.cpp.

References Q_UNUSED.

Referenced by insertTab().

+ Here is the caller graph for this function:

◆ tabLayoutChange()

void QTabBar::tabLayoutChange ( )
protectedvirtual

This virtual handler is called whenever the tab layout changes.

See also
tabRect()

Definition at line 1643 of file qtabbar.cpp.

Referenced by moveTab().

+ Here is the caller graph for this function:

◆ tabMoved

void QTabBar::tabMoved ( int from,
int to )
signal
Since
4.5

This signal is emitted when the tab has moved the tab at index position from to index position to.

note: QTabWidget will automatically move the page when this signal is emitted from its tab bar.

See also
moveTab()

Referenced by moveTab(), and QTabWidget::setTabBar().

+ Here is the caller graph for this function:

◆ tabRect()

QRect QTabBar::tabRect ( int index) const

Returns the visual rectangle of the tab at position index, or a null rectangle if index is hidden, or out of range.

Definition at line 1342 of file qtabbar.cpp.

References d, QWidget::layoutDirection, QWidget::rect, QRect::translate(), verticalTabs(), and QStyle::visualRect().

Referenced by event(), QTabWidget::initStyleOption(), insertTab(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), paintEvent(), removeTab(), setCurrentIndex(), setTabIcon(), setTabTextColor(), and tabAt().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tabRemoved()

void QTabBar::tabRemoved ( int index)
protectedvirtual

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

See also
tabInserted()

Definition at line 1633 of file qtabbar.cpp.

References Q_UNUSED.

Referenced by removeTab().

+ Here is the caller graph for this function:

◆ tabsClosable()

bool QTabBar::tabsClosable ( ) const

Definition at line 2557 of file qtabbar.cpp.

References d.

◆ tabSizeHint()

QSize QTabBar::tabSizeHint ( int index) const
protectedvirtual

Returns the size hint for the tab at position index.

Definition at line 1565 of file qtabbar.cpp.

References QStyle::CT_TabBarTab, d, QSet< T >::end(), QSet< T >::find(), QWidget::fontMetrics(), QSize::height(), QStyleOptionButton::icon, QStyleOptionButton::iconSize, iconSize, QSet< T >::insert(), QIcon::isNull(), QSize::isNull(), it, opt, QStyle::pixelMetric(), QStyle::PM_TabBarTabHSpace, QStyle::PM_TabBarTabVSpace, qMax(), QStyle::sizeFromContents(), QWidget::style(), QStyleOptionButton::text, Qt::TextShowMnemonic, verticalTabs(), and QSize::width().

Referenced by minimumTabSizeHint(), and setCurrentIndex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tabText()

QString QTabBar::tabText ( int index) const

Returns the text of the tab at position index, or an empty string if index is out of range.

Definition at line 1178 of file qtabbar.cpp.

References d.

◆ tabTextColor()

QColor QTabBar::tabTextColor ( int index) const

Returns the text color of the tab with the given index, or a invalid color if index is out of range.

See also
setTabTextColor()

Definition at line 1210 of file qtabbar.cpp.

References d.

◆ timerEvent()

void QTabBar::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 2475 of file qtabbar.cpp.

References d, QObject::killTimer(), setCurrentIndex(), and QObject::timerEvent().

+ Here is the call graph for this function:

◆ usesScrollButtons()

bool QTabBar::usesScrollButtons ( ) const

Definition at line 2528 of file qtabbar.cpp.

Property Documentation

◆ autoHide

QTabBar::autoHide
readwrite

If true, the tab bar is automatically hidden when it contains less than 2 tabs.

Since
5.4

By default, this property is false.

See also
QWidget::visible

Definition at line 35 of file qtabbar.h.

Referenced by QTabWidgetPrivate::isAutoHidden().

◆ changeCurrentOnDrag

QTabBar::changeCurrentOnDrag
readwrite

If true, then the current tab is automatically changed when dragging over the tabbar.

Since
5.4
Note
You should also set acceptDrops property to true to make this feature work.

By default, this property is false.

Definition at line 36 of file qtabbar.h.

◆ count

QTabBar::count
read

the number of tabs in the tab bar

Definition at line 24 of file qtabbar.h.

Referenced by QTabWidgetPrivate::isAutoHidden().

◆ currentIndex

QTabBar::currentIndex
readwrite

the index of the tab bar's visible tab

The current index is -1 if there is no current tab.

Definition at line 23 of file qtabbar.h.

Referenced by insertTab(), and removeTab().

◆ documentMode

QTabBar::documentMode
readwrite

Whether or not the tab bar is rendered in a mode suitable for the main window.

Since
4.5

This property is used as a hint for styles to draw the tabs in a different way then they would normally look in a tab widget. On \macos this will look similar to the tabs in Safari or Sierra's Terminal.app.

See also
QTabWidget::documentMode

Definition at line 34 of file qtabbar.h.

Referenced by QMacStyle::drawPrimitive().

◆ drawBase

QTabBar::drawBase
readwrite

defines whether or not tab bar should draw its base.

If true then QTabBar draws a base in relation to the styles overlap. Otherwise only the tabs are drawn.

See also
QStyle::pixelMetric(), QStyle::PM_TabBarBaseOverlap, QStyleOptionTabBarBase

Definition at line 25 of file qtabbar.h.

Referenced by setDrawBase().

◆ elideMode

QTabBar::elideMode
readwrite

how to elide text in the tab bar

Since
4.2

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.

See also
QTabWidget::elideMode, usesScrollButtons, QStyle::SH_TabBar_ElideMode

Definition at line 27 of file qtabbar.h.

◆ expanding

QTabBar::expanding
readwrite

When expanding is true QTabBar will expand the tabs to use the empty space.

Since
4.5

By default the value is true.

See also
QTabWidget::documentMode

Definition at line 32 of file qtabbar.h.

◆ iconSize

QTabBar::iconSize
readwrite

The size for icons in the tab bar.

Since
4.1

The default value is style-dependent. iconSize is a maximum size; icons that are smaller are not scaled up.

See also
QTabWidget::iconSize

Definition at line 26 of file qtabbar.h.

Referenced by tabSizeHint().

◆ movable

QTabBar::movable
readwrite

This property holds whether the user can move the tabs within the tabbar area.

Since
4.5

By default, this property is false;

Definition at line 33 of file qtabbar.h.

Referenced by setMovable().

◆ selectionBehaviorOnRemove

QTabBar::selectionBehaviorOnRemove
readwrite

What tab should be set as current when removeTab is called if the removed tab is also the current tab.

Since
4.5

By default the value is SelectRightTab.

See also
removeTab()

Definition at line 30 of file qtabbar.h.

◆ shape

QTabBar::shape
readwrite

the shape of the tabs in the tab bar

Possible values for this property are described by the Shape enum.

Definition at line 22 of file qtabbar.h.

Referenced by setShape().

◆ tabsClosable

QTabBar::tabsClosable
readwrite

Whether or not a tab bar should place close buttons on each tab.

Since
4.5

When tabsClosable is set to true a close button will appear on the tab on either the left or right hand side depending upon the style. When the button is clicked the tab the signal tabCloseRequested will be emitted.

By default the value is false.

See also
setTabButton(), tabRemoved()

Definition at line 29 of file qtabbar.h.

Referenced by QTabWidget::tabsClosable().

◆ usesScrollButtons

QTabBar::usesScrollButtons
readwrite

Whether or not a tab bar should use buttons to scroll tabs when it has many tabs.

Since
4.2

When there are too many tabs in a tab bar for its size, the tab bar can either choose to expand its size or to add buttons that allow you to scroll through the tabs.

By default the value is style-dependent.

See also
elideMode, QTabWidget::usesScrollButtons, QStyle::SH_TabBar_PreferNoArrows

Definition at line 28 of file qtabbar.h.

The documentation for this class was generated from the following files: