QTabWidget Class Reference

The QTabWidget class provides a stack of tabbed widgets. More...

#include <qtabwidget.h>

Inheritance diagram for QTabWidget:

Collaboration diagram for QTabWidget:

Public Types
enum	TabPosition { North , South , West , East }
	This enum type defines where QTabWidget draws the tab row: More...
enum	TabShape { Rounded , Triangular }
	This enum type defines the shape of the tabs: \value Rounded The tabs are drawn with a rounded look. More...
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 ,   PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB }

Public Slots
void	setCurrentIndex (int index)
void	setCurrentWidget (QWidget *widget)
	Makes widget the current widget.
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 whenever the current page index changes.
void	tabCloseRequested (int index)
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 an 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
	QTabWidget (QWidget *parent=nullptr)
	Constructs a tabbed widget with parent parent.
	~QTabWidget ()
	Destroys the tabbed widget.
int	addTab (QWidget *widget, const QString &)
	Adds a tab with the given page and label to the tab widget, and returns the index of the tab in the tab bar.
int	addTab (QWidget *widget, const QIcon &icon, const QString &label)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds a tab with the given page, icon, and label to the tab widget, and returns the index of the tab in the tab bar.
int	insertTab (int index, QWidget *widget, const QString &)
	Inserts a tab with the given label and page into the tab widget at the specified index, and returns the index of the inserted tab in the tab bar.
int	insertTab (int index, QWidget *widget, const QIcon &icon, const QString &label)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Inserts a tab with the given label, page, and icon into the tab widget at the specified index, and returns the index of the inserted tab in the tab bar.
void	removeTab (int index)
	Removes the tab at position index from this stack of widgets.
bool	isTabEnabled (int index) const
	Returns true if the page at position index is enabled; otherwise returns false.
void	setTabEnabled (int index, bool enabled)
	If enable is true, the page at position index is enabled; otherwise the page at position index is disabled.
bool	isTabVisible (int index) const
	Returns true if the page at position index is visible; otherwise returns false.
void	setTabVisible (int index, bool visible)
	If visible is true, the page at position index is visible; otherwise the page at position index is hidden.
QString	tabText (int index) const
	Returns the label text for the tab on the page at position index.
void	setTabText (int index, const QString &text)
	Defines a new label for the page at position index's tab.
QIcon	tabIcon (int index) const
	Returns the icon for the tab on the page at position index.
void	setTabIcon (int index, const QIcon &icon)
	Sets the icon for the tab at position index.
int	currentIndex () const
QWidget *	currentWidget () const
	Returns a pointer to the page currently being displayed by the tab dialog.
QWidget *	widget (int index) const
	Returns the tab page at index position index or \nullptr if the index is out of range.
int	indexOf (const QWidget *widget) const
	Returns the index position of the page occupied by the widget w, or -1 if the widget cannot be found.
int	count () const
TabPosition	tabPosition () const
void	setTabPosition (TabPosition position)
bool	tabsClosable () const
void	setTabsClosable (bool closeable)
bool	isMovable () const
void	setMovable (bool movable)
TabShape	tabShape () const
void	setTabShape (TabShape s)
QSize	sizeHint () const override
	\reimp
QSize	minimumSizeHint () const override
	\reimp
int	heightForWidth (int width) const override
	\reimp
bool	hasHeightForWidth () const override
	\reimp
void	setCornerWidget (QWidget *w, Qt::Corner corner=Qt::TopRightCorner)
	Sets the given widget to be shown in the specified corner of the tab widget.
QWidget *	cornerWidget (Qt::Corner corner=Qt::TopRightCorner) const
	Returns the widget shown in the corner of the tab widget or \nullptr.
Qt::TextElideMode	elideMode () const
void	setElideMode (Qt::TextElideMode mode)
QSize	iconSize () const
void	setIconSize (const QSize &size)
bool	usesScrollButtons () const
void	setUsesScrollButtons (bool useButtons)
bool	documentMode () const
void	setDocumentMode (bool set)
bool	tabBarAutoHide () const
void	setTabBarAutoHide (bool enabled)
void	clear ()
	Removes all the pages, but does not delete them.
QTabBar *	tabBar () const
	Returns the current QTabBar.
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.
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.
QWidget *	childAt (const QPointF &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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 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.
void	showEvent (QShowEvent *) override
	\reimp
void	resizeEvent (QResizeEvent *) override
	\reimp
void	keyPressEvent (QKeyEvent *) override
	\reimp
void	paintEvent (QPaintEvent *) override
	Paints the tab widget's tab bar in response to the paint event.
void	setTabBar (QTabBar *)
	Replaces the dialog's QTabBar heading with the tab bar tb.
void	changeEvent (QEvent *) override
	\reimp
bool	event (QEvent *) override
	\reimp
virtual void	initStyleOption (QStyleOptionTabWidgetFrame *option) const
	Initialize option with the values from this QTabWidget.
Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.
virtual void	mousePressEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.
virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.
virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.
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 void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.
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	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
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
double	getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const

Properties
TabPosition	tabPosition
	the position of the tabs in this tab widget
TabShape	tabShape
	the shape of the tabs in this tab widget
int	currentIndex
	the index position of the current tab page
int	count
	the number of tabs in the tab bar
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	documentMode
	Whether or not the tab widget is rendered in a mode suitable for document pages.
bool	tabsClosable
	whether close buttons are automatically added to each tab.
bool	movable
	This property holds whether the user can move the tabs within the tabbar area.
bool	tabBarAutoHide
	If true, the tab bar is automatically hidden when it contains less than 2 tabs.
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 ()
static int	encodeMetricF (PaintDeviceMetric metric, double value)
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
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QTabWidget class provides a stack of tabbed widgets.

\inmodule QtWidgets

A tab widget provides a tab bar (see QTabBar) and a "page area" that is used to display pages related to each tab. By default, the tab bar is shown above the page area, but different configurations are available (see \l{TabPosition}). Each tab is associated with a different widget (called a page). Only the current page is shown in the page area; all the other pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+{letter} shortcut if it has one.

The normal way to use QTabWidget is to do the following: \list 1

• Create a QTabWidget.
• Create a QWidget for each of the pages in the tab dialog, but do not specify parent widgets for them.
• Insert child widgets into the page widget, using layouts to position them as normal.
• Call addTab() or insertTab() to put the page widgets into the tab widget, giving each tab a suitable label with an optional keyboard shortcut. \endlist

The position of the tabs is defined by \l tabPosition, their shape by \l tabShape.

The signal currentChanged() is emitted when the user selects a page.

The current page index is available as currentIndex(), the current page widget with currentWidget(). You can retrieve a pointer to a page widget with a given index using widget(), and can find the index position of a widget with indexOf(). Use setCurrentWidget() or setCurrentIndex() to show a particular page.

You can change a tab's text and icon using setTabText() or setTabIcon(). A tab and its associated page can be removed with removeTab().

Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled.

Tab widgets can be a very good way to split up a complex dialog. An alternative is to use a QStackedWidget for which you provide some means of navigating between pages, for example, a QToolBar or a QListWidget.

Most of the functionality in QTabWidget is provided by a QTabBar (at the top, providing the tabs) and a QStackedWidget (most of the area, organizing the individual pages).

See also

QTabBar, QStackedWidget, QToolBox, {Tab Dialog Example}

Definition at line 19 of file qtabwidget.h.

Member Enumeration Documentation

TabPosition

enum QTabWidget::TabPosition

This enum type defines where QTabWidget draws the tab row:

\value North The tabs are drawn above the pages. \value South The tabs are drawn below the pages. \value West The tabs are drawn to the left of the pages. \value East The tabs are drawn to the right of the pages.

Enumerator
North
South
West
East

Definition at line 74 of file qtabwidget.h.

TabShape

enum QTabWidget::TabShape

This enum type defines the shape of the tabs: \value Rounded The tabs are drawn with a rounded look.

This is the default shape. \value Triangular The tabs are drawn with a triangular look.

Enumerator
Rounded
Triangular

Definition at line 85 of file qtabwidget.h.

Constructor & Destructor Documentation

QTabWidget()

QTabWidget::QTabWidget ( QWidget * parent = nullptr )

explicit

Constructs a tabbed widget with parent parent.

Definition at line 325 of file qtabwidget.cpp.

~QTabWidget()

QTabWidget::~QTabWidget

(

)

Destroys the tabbed widget.

Definition at line 336 of file qtabwidget.cpp.

Member Function Documentation

addTab() [1/2]

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds a tab with the given page, icon, and label to the tab widget, and returns the index of the tab in the tab bar.

Ownership of page is passed on to the QTabWidget.

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

Definition at line 378 of file qtabwidget.cpp.

addTab() [2/2]

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

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

Ownership of page is passed on to the QTabWidget.

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

Note

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

See also

insertTab()

Definition at line 361 of file qtabwidget.cpp.

changeEvent()

void QTabWidget::changeEvent ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1096 of file qtabwidget.cpp.

clear()

void QTabWidget::clear

(

)

Removes all the pages, but does not delete them.

Calling this function is equivalent to calling removeTab() until the tab widget is empty.

Definition at line 1403 of file qtabwidget.cpp.

cornerWidget()

QWidget * QTabWidget::cornerWidget

(

Qt::Corner

corner = Qt::TopRightCorner

)

const

Returns the widget shown in the corner of the tab widget or \nullptr.

Definition at line 613 of file qtabwidget.cpp.

count()

int QTabWidget::count

(

)

const

Definition at line 1170 of file qtabwidget.cpp.

currentChanged

void QTabWidget::currentChanged ( int index )

signal

This signal is emitted whenever the current page index changes.

The parameter is the new current page index position, or -1 if there isn't a new one (for example, if there are no widgets in the QTabWidget)

See also

currentWidget(), currentIndex

currentIndex()

int QTabWidget::currentIndex

(

)

const

Definition at line 671 of file qtabwidget.cpp.

currentWidget()

QWidget * QTabWidget::currentWidget

(

)

const

Returns a pointer to the page currently being displayed by the tab dialog.

The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be).

See also

currentIndex(), setCurrentWidget()

Definition at line 642 of file qtabwidget.cpp.

documentMode()

bool QTabWidget::documentMode

(

)

const

Definition at line 1361 of file qtabwidget.cpp.

elideMode()

Qt::TextElideMode QTabWidget::elideMode

(

)

const

Definition at line 1316 of file qtabwidget.cpp.

event()

bool QTabWidget::event ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1086 of file qtabwidget.cpp.

hasHeightForWidth()

bool QTabWidget::hasHeightForWidth ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 224 of file qtabwidget.cpp.

heightForWidth()

int QTabWidget::heightForWidth ( int width ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 910 of file qtabwidget.cpp.

iconSize()

QSize QTabWidget::iconSize

(

)

const

Definition at line 1294 of file qtabwidget.cpp.

indexOf()

int QTabWidget::indexOf

(

const QWidget *

widget

)

const

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

Definition at line 688 of file qtabwidget.cpp.

initStyleOption()

void QTabWidget::initStyleOption ( QStyleOptionTabWidgetFrame * option ) const

protectedvirtual

Initialize option with the values from this QTabWidget.

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

See also

QStyleOption::initFrom(), QTabBar::initStyleOption()

Definition at line 278 of file qtabwidget.cpp.

insertTab() [1/2]

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Inserts a tab with the given label, page, and icon into the tab widget at the specified index, and returns the index of the inserted tab in the tab bar.

Ownership of page is passed on to the QTabWidget.

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

Definition at line 435 of file qtabwidget.cpp.

insertTab() [2/2]

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

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

Ownership of page is passed on to the QTabWidget.

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

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

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

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

Note

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

See also

addTab()

Definition at line 417 of file qtabwidget.cpp.

isMovable()

bool QTabWidget::isMovable

(

)

const

Definition at line 1048 of file qtabwidget.cpp.

isTabEnabled()

bool QTabWidget::isTabEnabled

(

int

index

)

const

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

See also

setTabEnabled(), QWidget::isEnabled()

Definition at line 504 of file qtabwidget.cpp.

isTabVisible()

bool QTabWidget::isTabVisible

(

int

index

)

const

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

See also

setTabVisible()

Since

5.15

Definition at line 539 of file qtabwidget.cpp.

keyPressEvent()

void QTabWidget::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1111 of file qtabwidget.cpp.

minimumSizeHint()

QSize QTabWidget::minimumSizeHint ( ) const

overridevirtual

\reimp

Returns a suitable minimum size for the tab widget.

Reimplemented from QWidget.

Definition at line 880 of file qtabwidget.cpp.

paintEvent()

void QTabWidget::paintEvent ( QPaintEvent * event )

overrideprotectedvirtual

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

Reimplemented from QWidget.

Definition at line 1254 of file qtabwidget.cpp.

removeTab()

void QTabWidget::removeTab

(

int

index

)

Removes the tab at position index from this stack of widgets.

The page widget itself is not deleted.

See also

addTab(), insertTab()

Definition at line 627 of file qtabwidget.cpp.

resizeEvent()

void QTabWidget::resizeEvent ( QResizeEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 698 of file qtabwidget.cpp.

setCornerWidget()

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

Sets the given widget to be shown in the specified corner of the tab widget.

The geometry of the widget is determined based on the widget's sizeHint() and the style().

Only the horizontal element of the corner will be used.

Passing \nullptr shows no widget in the corner.

Any previously set corner widget is hidden.

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

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

See also

cornerWidget(), setTabPosition()

Definition at line 592 of file qtabwidget.cpp.

setCurrentIndex

void QTabWidget::setCurrentIndex ( int index )

slot

Definition at line 677 of file qtabwidget.cpp.

setCurrentWidget

void QTabWidget::setCurrentWidget ( QWidget * widget )

slot

Makes widget the current widget.

The widget used must be a page in this tab widget.

See also

addTab(), setCurrentIndex(), currentWidget()

Definition at line 654 of file qtabwidget.cpp.

setDocumentMode()

void QTabWidget::setDocumentMode

(

bool

set

)

Definition at line 1367 of file qtabwidget.cpp.

setElideMode()

void QTabWidget::setElideMode

(

Qt::TextElideMode

mode

)

Definition at line 1321 of file qtabwidget.cpp.

setIconSize()

void QTabWidget::setIconSize

(

const QSize &

size

)

Definition at line 1299 of file qtabwidget.cpp.

setMovable()

void QTabWidget::setMovable

(

bool

movable

)

Definition at line 1053 of file qtabwidget.cpp.

setTabBar()

void QTabWidget::setTabBar ( QTabBar * tb )

protected

Replaces the dialog's QTabBar heading with the tab bar tb.

Note that this must be called before any tabs have been added, or the behavior is undefined.

See also

tabBar()

Definition at line 711 of file qtabwidget.cpp.

setTabBarAutoHide()

void QTabWidget::setTabBarAutoHide

(

bool

enabled

)

Definition at line 1393 of file qtabwidget.cpp.

setTabEnabled()

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

If enable is true, the page at position index is enabled; otherwise the page at position index is disabled.

The page's tab is redrawn appropriately.

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

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

See also

isTabEnabled(), QWidget::setEnabled()

Definition at line 524 of file qtabwidget.cpp.

setTabIcon()

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

Sets the icon for the tab at position index.

Definition at line 481 of file qtabwidget.cpp.

setTabPosition()

void QTabWidget::setTabPosition

(

TabPosition

position

)

Definition at line 1001 of file qtabwidget.cpp.

setTabsClosable()

void QTabWidget::setTabsClosable

(

bool

closeable

)

Definition at line 1023 of file qtabwidget.cpp.

setTabShape()

void QTabWidget::setTabShape

(

TabShape

s

)

Definition at line 1074 of file qtabwidget.cpp.

setTabText()

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

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

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

Definition at line 461 of file qtabwidget.cpp.

setTabVisible()

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

If visible is true, the page at position index is visible; otherwise the page at position index is hidden.

The page's tab is redrawn appropriately.

See also

isTabVisible()

Since

5.15

Definition at line 553 of file qtabwidget.cpp.

setUsesScrollButtons()

void QTabWidget::setUsesScrollButtons

(

bool

useButtons

)

Definition at line 1344 of file qtabwidget.cpp.

showEvent()

void QTabWidget::showEvent ( QShowEvent * )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 955 of file qtabwidget.cpp.

sizeHint()

QSize QTabWidget::sizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 837 of file qtabwidget.cpp.

tabBar()

QTabBar * QTabWidget::tabBar

(

)

const

Returns the current QTabBar.

See also

setTabBar()

Definition at line 744 of file qtabwidget.cpp.

tabBarAutoHide()

bool QTabWidget::tabBarAutoHide

(

)

const

Definition at line 1387 of file qtabwidget.cpp.

tabBarClicked

void QTabWidget::tabBarClicked ( int index )

signal

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

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

Since

5.2

tabBarDoubleClicked

void QTabWidget::tabBarDoubleClicked ( int index )

signal

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

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

Since

5.2

tabCloseRequested

void QTabWidget::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()

tabIcon()

QIcon QTabWidget::tabIcon

(

int

index

)

const

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

Definition at line 492 of file qtabwidget.cpp.

tabInserted()

void QTabWidget::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 1233 of file qtabwidget.cpp.

tabPosition()

QTabWidget::TabPosition QTabWidget::tabPosition

(

)

const

Definition at line 995 of file qtabwidget.cpp.

tabRemoved()

void QTabWidget::tabRemoved ( int index )

protectedvirtual

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

See also

tabInserted()

Definition at line 1244 of file qtabwidget.cpp.

tabsClosable()

bool QTabWidget::tabsClosable

(

)

const

Definition at line 1018 of file qtabwidget.cpp.

tabShape()

QTabWidget::TabShape QTabWidget::tabShape

(

)

const

Definition at line 1068 of file qtabwidget.cpp.

tabText()

QString QTabWidget::tabText

(

int

index

)

const

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

Definition at line 472 of file qtabwidget.cpp.

usesScrollButtons()

bool QTabWidget::usesScrollButtons

(

)

const

Definition at line 1339 of file qtabwidget.cpp.

widget()

QWidget * QTabWidget::widget

(

int

index

)

const

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

Definition at line 1158 of file qtabwidget.cpp.

Property Documentation

count

int QTabWidget::count

read

the number of tabs in the tab bar

By default, this property contains a value of 0.

Definition at line 25 of file qtabwidget.h.

currentIndex

int QTabWidget::currentIndex

readwrite

the index position of the current tab page

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

By default, this property contains a value of -1 because there are initially no tabs in the widget.

Definition at line 24 of file qtabwidget.h.

documentMode

bool QTabWidget::documentMode

readwrite

Whether or not the tab widget is rendered in a mode suitable for document pages.

This is the same as document mode on \macos.

Since

4.5

When this property is set the tab widget frame is not rendered. This mode is useful for showing document-type pages where the page covers most of the tab widget area.

See also

elideMode, QTabBar::documentMode, QTabBar::usesScrollButtons, QStyle::SH_TabBar_PreferNoArrows

Definition at line 29 of file qtabwidget.h.

elideMode

Qt::TextElideMode QTabWidget::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

QTabBar::elideMode, usesScrollButtons, QStyle::SH_TabBar_ElideMode

Definition at line 27 of file qtabwidget.h.

iconSize

QSize QTabWidget::iconSize

readwrite

The size for icons in the tab bar.

Since

4.2

The default value is style-dependent. This is the maximum size that the icons will have. Icons are not scaled up if they are of smaller size.

See also

QTabBar::iconSize

Definition at line 26 of file qtabwidget.h.

movable

bool QTabWidget::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 31 of file qtabwidget.h.

tabBarAutoHide

bool QTabWidget::tabBarAutoHide

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 32 of file qtabwidget.h.

tabPosition

TabPosition QTabWidget::tabPosition

readwrite

the position of the tabs in this tab widget

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

By default, this property is set to \l North.

See also

TabPosition

Definition at line 22 of file qtabwidget.h.

tabsClosable

bool QTabWidget::tabsClosable

readwrite

whether close buttons are automatically added to each tab.

Since

4.5

See also

QTabBar::tabsClosable()

Definition at line 30 of file qtabwidget.h.

tabShape

TabShape QTabWidget::tabShape

readwrite

the shape of the tabs in this tab widget

Possible values for this property are QTabWidget::Rounded (default) or QTabWidget::Triangular.

See also

TabShape

Definition at line 23 of file qtabwidget.h.

usesScrollButtons

bool QTabWidget::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, QTabBar::usesScrollButtons, QStyle::SH_TabBar_PreferNoArrows

Definition at line 28 of file qtabwidget.h.

---

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

• qtbase/src/widgets/widgets/qtabwidget.h (323cf718f634e5530ac43fef6f85777daa201570)
• qtbase/src/widgets/widgets/qtabwidget.cpp (8717c1752f9b72ac7c028b722f0a068e84e64eca)