The QSplitter class implements a splitter widget. More...

#include <qsplitter.h>

Inheritance diagram for QSplitter:

Collaboration diagram for QSplitter:

Signals
void	splitterMoved (int pos, int index)

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	customContextMenuRequested (const QPoint &pos)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QSplitter (QWidget *parent=nullptr)

	QSplitter (Qt::Orientation, QWidget *parent=nullptr)

	~QSplitter ()

void	addWidget (QWidget *widget)

void	insertWidget (int index, QWidget *widget)

QWidget *	replaceWidget (int index, QWidget *widget)

void	setOrientation (Qt::Orientation)

Qt::Orientation	orientation () const

void	setChildrenCollapsible (bool)

bool	childrenCollapsible () const

void	setCollapsible (int index, bool)

bool	isCollapsible (int index) const

void	setOpaqueResize (bool opaque=true)

bool	opaqueResize () const

void	refresh ()

QSize	sizeHint () const override

QSize	minimumSizeHint () const override

QList< int >	sizes () const

void	setSizes (const QList< int > &list)

QByteArray	saveState () const

bool	restoreState (const QByteArray &state)

int	handleWidth () const

void	setHandleWidth (int)

int	indexOf (QWidget *w) const

QWidget *	widget (int index) const

int	count () const

void	getRange (int index, int , int ) const

QSplitterHandle *	handle (int index) const

void	setStretchFactor (int index, int stretch)

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QFrame ()

int	frameStyle () const

void	setFrameStyle (int)

int	frameWidth () const

Shape	frameShape () const

void	setFrameShape (Shape)

Shadow	frameShadow () const

void	setFrameShadow (Shadow)

int	lineWidth () const

void	setLineWidth (int)

int	midLineWidth () const

void	setMidLineWidth (int)

QRect	frameRect () const

void	setFrameRect (const QRect &)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QWidget ()

int	devType () const override

WId	winId () const

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)

bool	isWindow () const

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const

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)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int 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)

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setFixedSize (const QSize &)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFixedHeight (int h)

QPointF	mapToGlobal (const QPointF &) const

QPoint	mapToGlobal (const QPoint &) const

QPointF	mapFromGlobal (const QPointF &) const

QPoint	mapFromGlobal (const QPoint &) const

QPointF	mapToParent (const QPointF &) const

QPoint	mapToParent (const QPoint &) const

QPointF	mapFromParent (const QPointF &) const

QPoint	mapFromParent (const QPoint &) const

QPointF	mapTo (const QWidget *, const QPointF &) const

QPoint	mapTo (const QWidget *, const QPoint &) const

QPointF	mapFrom (const QWidget *, const QPointF &) const

QPoint	mapFrom (const QWidget *, const QPoint &) const

QWidget *	window () const

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)

QPalette::ColorRole	backgroundRole () const

void	setForegroundRole (QPalette::ColorRole)

QPalette::ColorRole	foregroundRole () const

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const

QFontInfo	fontInfo () const

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)

void	setMask (const QRegion &)

QRegion	mask () const

void	clearMask ()

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))

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())

void	ungrabGesture (Qt::GestureType 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 &)

QString	windowRole () const

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

QString	accessibleName () const

void	setAccessibleName (const QString &name)

QString	accessibleDescription () const

void	setAccessibleDescription (const QString &description)

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 ()

void	clearFocus ()

void	setFocus (Qt::FocusReason reason)

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)

QWidget *	focusProxy () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()

void	grabMouse (const QCursor &)

void	releaseMouse ()

void	grabKeyboard ()

void	releaseKeyboard ()

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)

void	releaseShortcut (int id)

void	setShortcutEnabled (int id, bool enable=true)

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)

void	update (const QRect &)

void	update (const QRegion &)

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &)

void	repaint (const QRegion &)

void	stackUnder (QWidget *)

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const

bool	isHidden () const

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const

void	setWindowState (Qt::WindowStates state)

void	overrideWindowState (Qt::WindowStates state)

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

virtual int	heightForWidth (int) const

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)
	The setContentsMargins function sets the margins around the widget's contents. More...

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins. More...

QRect	contentsRect () const

QLayout *	layout () const

void	setLayout (QLayout *)

void	updateGeometry ()

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &)

QWidget *	focusWidget () const

QWidget *	nextInFocusChain () const

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain. More...

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	insertActions (QAction before, const QList< QAction > &actions)

void	insertAction (QAction before, QAction action)

void	removeAction (QAction *action)

QList< QAction * >	actions () const

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

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)

Qt::WindowType	windowType () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

void	setAttribute (Qt::WidgetAttribute, bool on=true)

bool	testAttribute (Qt::WidgetAttribute) const

QPaintEngine *	paintEngine () const override

void	ensurePolished () const

bool	isAncestorOf (const QWidget *child) const

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const

QScreen *	screen () const

void	setScreen (QScreen *)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

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 QSplitterHandle *	createHandle ()

void	childEvent (QChildEvent *) override

bool	event (QEvent *) override

void	resizeEvent (QResizeEvent *) override

void	changeEvent (QEvent *) override

void	moveSplitter (int pos, int index)

void	setRubberBand (int position)

int	closestLegalPosition (int, int)

Protected Member Functions inherited from QFrame
void	paintEvent (QPaintEvent *) override

void	drawFrame (QPainter *)

	QFrame (QFramePrivate &dd, QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

virtual void	initStyleOption (QStyleOptionFrame *option) const

Protected Member Functions inherited from QWidget
virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	actionEvent (QActionEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

int	metric (PaintDeviceMetric) const override

void	initPainter (QPainter *painter) const override

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)

virtual bool	focusNextPrevChild (bool next)

bool	focusNextChild ()

bool	focusPreviousChild ()

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	customEvent (QEvent *event)

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
Qt::Orientation	orientation
	the orientation of the splitter More...

bool	opaqueResize

int	handleWidth
	the width of the splitter handles More...

bool	childrenCollapsible
	whether child widgets can be resized down to size 0 by the user More...

Properties inherited from QFrame
Shape	frameShape
	the frame shape value from the frame style More...

Shadow	frameShadow
	the frame shadow value from the frame style More...

int	lineWidth
	the line width More...

int	midLineWidth
	the width of the mid-line More...

int	frameWidth
	the width of the frame that is drawn. More...

QRect	frameRect
	the frame's rectangle More...

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget More...

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget More...

bool	enabled
	whether the widget is enabled More...

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame More...

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame More...

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More...

int	x
	the x coordinate of the widget relative to its parent including any window frame More...

int	y
	the y coordinate of the widget relative to its parent and including any window frame More...

QPoint	pos
	the position of the widget within its parent widget More...

QSize	frameSize
	the size of the widget including any window frame More...

QSize	size
	the size of the widget excluding any window frame More...

int	width
	the width of the widget excluding any window frame More...

int	height
	the height of the widget excluding any window frame More...

QRect	rect
	the internal geometry of the widget excluding any window frame More...

QRect	childrenRect
	the bounding rectangle of the widget's children More...

QRegion	childrenRegion
	the combined region occupied by the widget's children More...

QSizePolicy	sizePolicy
	the default layout behavior of the widget More...

QSize	minimumSize
	the widget's minimum size More...

QSize	maximumSize
	the widget's maximum size in pixels More...

int	minimumWidth
	the widget's minimum width in pixels More...

int	minimumHeight
	the widget's minimum height in pixels More...

int	maximumWidth
	the widget's maximum width in pixels More...

int	maximumHeight
	the widget's maximum height in pixels More...

QSize	sizeIncrement
	the size increment of the widget More...

QSize	baseSize
	the base size of the widget More...

QPalette	palette
	the widget's palette More...

QFont	font
	the font currently set for the widget More...

QCursor	cursor
	the cursor shape for this widget More...

bool	mouseTracking
	whether mouse tracking is enabled for the widget More...

bool	tabletTracking
	whether tablet tracking is enabled for the widget More...

bool	isActiveWindow
	whether this widget's window is the active window More...

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus More...

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus More...

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu More...

bool	updatesEnabled
	whether updates are enabled More...

bool	visible
	whether the widget is visible More...

bool	minimized
	whether this widget is minimized (iconified) More...

bool	maximized
	whether this widget is maximized More...

bool	fullScreen
	whether the widget is shown in full screen mode More...

QSize	sizeHint
	the recommended size for the widget More...

QSize	minimumSizeHint
	the recommended minimum size for the widget More...

bool	acceptDrops
	whether drop events are enabled for this widget More...

QString	windowTitle
	the window title (caption) More...

QIcon	windowIcon
	the widget's icon More...

QString	windowIconText
	the text to be displayed on the icon of a minimized window More...

double	windowOpacity
	The level of opacity for the window. More...

bool	windowModified
	whether the document shown in the window has unsaved changes More...

QString	accessibleName
	the widget's name as seen by assistive technologies More...

QString	accessibleDescription
	the widget's description as seen by assistive technologies More...

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget. More...

bool	autoFillBackground
	whether the widget background is filled automatically More...

QString	styleSheet
	the widget's style sheet More...

QLocale	locale
	the widget's locale More...

QString	windowFilePath
	the file path associated with a widget More...

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Friends
class	QSplitterHandle

Additional Inherited Members
Public Types inherited from QFrame
enum	Shape { NoFrame = 0 , Box = 0x0001 , Panel = 0x0002 , WinPanel = 0x0003 , HLine = 0x0004 , VLine = 0x0005 , StyledPanel = 0x0006 }

enum	Shadow { Plain = 0x0010 , Raised = 0x0020 , Sunken = 0x0030 }

enum	StyleMask { Shadow_Mask = 0x00f0 , Shape_Mask = 0x000f }

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()

void	update ()

void	repaint ()

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)

void	show ()

void	hide ()

void	showMinimized ()

void	showMaximized ()

void	showFullScreen ()

void	showNormal ()

bool	close ()

void	raise ()

void	lower ()

Public Slots inherited from QObject
void	deleteLater ()

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )

static QWidget *	mouseGrabber ()

static QWidget *	keyboardGrabber ()

static QWidget *	find (WId)

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Functions inherited from QWidget
	setupUi (QWidget *widget)

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QSplitter class implements a splitter widget.

\inmodule QtWidgets

A splitter lets the user control the size of child widgets by dragging the boundary between them. Any number of widgets may be controlled by a single splitter. The typical use of a QSplitter is to create several widgets and add them using insertWidget() or addWidget().

The following example will show a QListView, QTreeView, and QTextEdit side by side, with two splitter handles:

If a widget is already inside a QSplitter when insertWidget() or addWidget() is called, it will move to the new position. This can be used to reorder widgets in the splitter later. You can use indexOf(), widget(), and count() to get access to the widgets inside the splitter.

A default QSplitter lays out its children horizontally (side by side); you can use setOrientation(Qt::Vertical) to lay its children out vertically.

By default, all widgets can be as large or as small as the user wishes, between the \l minimumSizeHint() (or \l minimumSize()) and \l maximumSize() of the widgets.

QSplitter resizes its children dynamically by default. If you would rather have QSplitter resize the children only at the end of a resize operation, call setOpaqueResize(false).

The initial distribution of size between the widgets is determined by multiplying the initial size with the stretch factor. You can also use setSizes() to set the sizes of all the widgets. The function sizes() returns the sizes set by the user. Alternatively, you can save and restore the sizes of the widgets from a QByteArray using saveState() and restoreState() respectively.

When you hide() a child, its space will be distributed among the other children. It will be reinstated when you show() it again.

Note: Adding a QLayout to a QSplitter is not supported (either through setLayout() or making the QSplitter a parent of the QLayout); use addWidget() instead (see example above).

See also: QSplitterHandle, QHBoxLayout, QVBoxLayout, QTabWidget

Definition at line 56 of file qsplitter.h.

Constructor & Destructor Documentation

◆ QSplitter() [1/2]

QSplitter::QSplitter ( QWidget * parent = nullptr )

explicit

Constructs a horizontal splitter with the parent argument passed on to the QFrame constructor.

See also: setOrientation()

Definition at line 953 of file qsplitter.cpp.

◆ QSplitter() [2/2]

QSplitter::QSplitter	(	Qt::Orientation	orientation,
		QWidget *	parent = `nullptr`
	)

explicit

Constructs a splitter with the given orientation and parent.

See also: setOrientation()

Definition at line 964 of file qsplitter.cpp.

◆ ~QSplitter()

QSplitter::~QSplitter ( )

Destroys the splitter. All children are deleted.

Definition at line 977 of file qsplitter.cpp.

Member Function Documentation

◆ addWidget()

void QSplitter::addWidget ( QWidget * widget )

Adds the given widget to the splitter's layout after all the other items.

If widget is already in the splitter, it will be moved to the new position.

Note: The splitter takes ownership of the widget.

See also: insertWidget(), widget(), indexOf()

Definition at line 1113 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeEvent()

void QSplitter::changeEvent ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QFrame.

Definition at line 1666 of file qsplitter.cpp.

Here is the call graph for this function:

◆ childEvent()

void QSplitter::childEvent ( QChildEvent * c )

overrideprotectedvirtual

\reimp

Tells the splitter that the child widget described by c has been inserted or removed.

This method is also used to handle the situation where a widget is created with the splitter as a parent but not explicitly added with insertWidget() or addWidget(). This is for compatibility and not the recommended way of putting widgets into a splitter in new code. Please use insertWidget() or addWidget() in new code.

See also: addWidget(), insertWidget()

Reimplemented from QObject.

Definition at line 1297 of file qsplitter.cpp.

Here is the call graph for this function:

◆ childrenCollapsible()

bool QSplitter::childrenCollapsible ( ) const

Definition at line 1051 of file qsplitter.cpp.

◆ closestLegalPosition()

int QSplitter::closestLegalPosition	(	int	pos,
		int	index
	)

protected

Returns the closest legal position to pos of the widget at index.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. Positions are then measured from the right edge of the widget.

See also: getRange()

Definition at line 1482 of file qsplitter.cpp.

◆ count()

int QSplitter::count ( ) const

Returns the number of widgets contained in the splitter's layout.

See also: widget(), handle()

Definition at line 1276 of file qsplitter.cpp.

Here is the caller graph for this function:

◆ createHandle()

QSplitterHandle * QSplitter::createHandle ( )

protectedvirtual

Returns a new splitter handle as a child widget of this splitter. This function can be reimplemented in subclasses to provide support for custom handles.

See also: handle(), indexOf()

Reimplemented in Splitter.

Definition at line 1232 of file qsplitter.cpp.

◆ event()

bool QSplitter::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QFrame.

Definition at line 1365 of file qsplitter.cpp.

Here is the call graph for this function:

◆ getRange()

void QSplitter::getRange	(	int	index,
		int *	min,
		int *	max
	)		const

Returns the valid range of the splitter at index in {min} and *{max} if min and max are not 0.

Definition at line 1465 of file qsplitter.cpp.

◆ handle()

QSplitterHandle * QSplitter::handle ( int index ) const

Returns the handle to the left of (or above) the item in the splitter's layout at the given index, or \nullptr if there is no such item. The handle at index 0 is always hidden.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. The handle will be to the right of the widget at index.

See also: count(), widget(), indexOf(), createHandle(), setHandleWidth()

Definition at line 1249 of file qsplitter.cpp.

◆ handleWidth()

int QSplitter::handleWidth ( ) const

Definition at line 1646 of file qsplitter.cpp.

Here is the call graph for this function:

◆ indexOf()

int QSplitter::indexOf ( QWidget * widget ) const

Returns the index in the splitter's layout of the specified widget, or -1 if widget is not found. This also works for handles.

Handles are numbered from 0. There are as many handles as there are child widgets, but the handle at position 0 is always hidden.

See also: count(), widget()

Definition at line 1214 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertWidget()

void QSplitter::insertWidget	(	int	index,
		QWidget *	widget
	)

Inserts the widget specified into the splitter's layout at the given index.

If widget is already in the splitter, it will be moved to the new position.

If index is an invalid index, then the widget will be inserted at the end.

Note: The splitter takes ownership of the widget.

See also: addWidget(), indexOf(), widget()

Definition at line 1131 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCollapsible()

bool QSplitter::isCollapsible ( int index ) const

Returns true if the widget at index is collapsible, otherwise returns false.

Definition at line 1084 of file qsplitter.cpp.

◆ minimumSizeHint()

QSize QSplitter::minimumSizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 1546 of file qsplitter.cpp.

Here is the call graph for this function:

◆ moveSplitter()

void QSplitter::moveSplitter	(	int	pos,
		int	index
	)

protected

Moves the left or top edge of the splitter handle at index as close as possible to position pos, which is the distance from the left or top edge of the widget.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. pos is then the distance from the right edge of the widget.

See also: splitterMoved(), closestLegalPosition(), getRange()

Definition at line 1414 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ opaqueResize()

bool QSplitter::opaqueResize ( ) const

Definition at line 1504 of file qsplitter.cpp.

Here is the call graph for this function:

◆ orientation()

Qt::Orientation QSplitter::orientation ( ) const

Definition at line 1028 of file qsplitter.cpp.

◆ refresh()

void QSplitter::refresh ( )

Updates the splitter's state. You should not need to call this function.

Definition at line 991 of file qsplitter.cpp.

◆ replaceWidget()

QWidget * QSplitter::replaceWidget	(	int	index,
		QWidget *	widget
	)

Since: 5.9

Replaces the widget in the splitter's layout at the given index by widget.

Returns the widget that has just been replaced if index is valid and widget is not already a child of the splitter. Otherwise, it returns null and no replacement or addition is made.

The geometry of the newly inserted widget will be the same as the widget it replaces. Its visible and collapsed states are also inherited.

Note: The splitter takes ownership of widget and sets the parent of the replaced widget to null.; Because widget gets \l{QWidget::setParent()}{reparented} into the splitter, its \l{QWidget::}{geometry} may not be set right away, but only after widget will receive the appropriate events.

See also: insertWidget(), indexOf()

Definition at line 1158 of file qsplitter.cpp.

Here is the call graph for this function:

◆ resizeEvent()

void QSplitter::resizeEvent ( QResizeEvent * )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1097 of file qsplitter.cpp.

◆ restoreState()

bool QSplitter::restoreState ( const QByteArray & state )

Restores the splitter's layout to the state specified. Returns true if the state is restored; otherwise returns false.

Typically this is used in conjunction with QSettings to restore the size from a past session. Here is an example:

Restore the splitter's state:

A failure to restore the splitter's layout may result from either invalid or out-of-date data in the supplied byte array.

See also: saveState()

Definition at line 1729 of file qsplitter.cpp.

Here is the caller graph for this function:

◆ saveState()

QByteArray QSplitter::saveState ( ) const

Saves the state of the splitter's layout.

Typically this is used in conjunction with QSettings to remember the size for a future session. A version number is stored as part of the data. Here is an example:

See also: restoreState()

Definition at line 1687 of file qsplitter.cpp.

Here is the caller graph for this function:

◆ setChildrenCollapsible()

void QSplitter::setChildrenCollapsible ( bool collapse )

Definition at line 1045 of file qsplitter.cpp.

◆ setCollapsible()

void QSplitter::setCollapsible	(	int	index,
		bool	collapse
	)

Sets whether the child widget at index is collapsible to collapse.

By default, children are collapsible, meaning that the user can resize them down to size 0, even if they have a non-zero minimumSize() or minimumSizeHint(). This behavior can be changed on a per-widget basis by calling this function, or globally for all the widgets in the splitter by setting the \l childrenCollapsible property.

See also: childrenCollapsible

Definition at line 1070 of file qsplitter.cpp.

◆ setHandleWidth()

void QSplitter::setHandleWidth ( int width )

Definition at line 1656 of file qsplitter.cpp.

◆ setOpaqueResize()

void QSplitter::setOpaqueResize ( bool opaque = true )

Definition at line 1511 of file qsplitter.cpp.

◆ setOrientation()

void QSplitter::setOrientation ( Qt::Orientation orientation )

Definition at line 1008 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRubberBand()

void QSplitter::setRubberBand ( int pos )

protected

Displays a rubber band at position pos. If pos is negative, the rubber band is removed.

Definition at line 1333 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSizes()

void QSplitter::setSizes ( const QList< int > & list )

Sets the child widgets' respective sizes to the values given in the list.

If the splitter is horizontal, the values set the width of each widget in pixels, from left to right. If the splitter is vertical, the height of each widget is set, from top to bottom.

Extra values in the list are ignored. If list contains too few values, the result is undefined, but the program will still be well-behaved.

The overall size of the splitter widget is not affected. Instead, any additional/missing space is distributed amongst the widgets according to the relative weight of the sizes.

If you specify a size of 0, the widget will be invisible. The size policies of the widgets are preserved. That is, a value smaller than the minimal size hint of the respective widget will be replaced by the value of the hint.

See also: sizes()

Definition at line 1629 of file qsplitter.cpp.

Here is the caller graph for this function:

◆ setStretchFactor()

void QSplitter::setStretchFactor	(	int	index,
		int	stretch
	)

Updates the size policy of the widget at position index to have a stretch factor of stretch.

stretch is not the effective stretch factor; the effective stretch factor is calculated by taking the initial size of the widget and multiplying it with stretch.

This function is provided for convenience. It is equivalent to

See also: setSizes(), widget()

Definition at line 1783 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sizeHint()

QSize QSplitter::sizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QFrame.

Definition at line 1522 of file qsplitter.cpp.

Here is the call graph for this function:

◆ sizes()

QList< int > QSplitter::sizes ( ) const

Returns a list of the size parameters of all the widgets in this splitter.

If the splitter's orientation is horizontal, the list contains the widgets width in pixels, from left to right; if the orientation is vertical, the list contains the widgets' heights in pixels, from top to bottom.

Giving the values to another splitter's setSizes() function will produce a splitter with the same layout as this one.

Note that invisible widgets have a size of 0.

See also: setSizes()

Definition at line 1592 of file qsplitter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ splitterMoved

void QSplitter::splitterMoved	(	int	pos,
		int	index
	)

signal

This signal is emitted when the splitter handle at a particular index has been moved to position pos.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. pos is then the distance from the right edge of the widget.

See also: moveSplitter()

Here is the caller graph for this function:

◆ widget()

QWidget * QSplitter::widget ( int index ) const

Returns the widget at the given index in the splitter's layout, or \nullptr if there is no such widget.

See also: count(), handle(), indexOf(), insertWidget()

Definition at line 1263 of file qsplitter.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QSplitterHandle

friend class QSplitterHandle

friend

Definition at line 128 of file qsplitter.h.

Property Documentation

◆ childrenCollapsible

QSplitter::childrenCollapsible

readwrite

whether child widgets can be resized down to size 0 by the user

By default, children are collapsible. It is possible to enable and disable the collapsing of individual children using setCollapsible().

See also: setCollapsible()

Definition at line 163 of file qsplitter.h.

◆ handleWidth

QSplitter::handleWidth

readwrite

the width of the splitter handles

By default, this property contains a value that depends on the user's platform and style preferences.

If you set handleWidth to 1 or 0, the actual grab area will grow to overlap a few pixels of its respective widgets.

Definition at line 163 of file qsplitter.h.

◆ opaqueResize

QSplitter::opaqueResize

readwrite

Returns true if widgets are resized dynamically (opaquely) while interactively moving the splitter. Otherwise returns false.

The default resize behavior is style dependent (determined by the SH_Splitter_OpaqueResize style hint). However, you can override it by calling setOpaqueResize()

See also: QStyle::StyleHint

Definition at line 163 of file qsplitter.h.

◆ orientation

QSplitter::orientation

readwrite

the orientation of the splitter

By default, the orientation is horizontal (i.e., the widgets are laid out side by side). The possible orientations are Qt::Horizontal and Qt::Vertical.

See also: QSplitterHandle::orientation()

Definition at line 163 of file qsplitter.h.

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

src/widgets/widgets/qsplitter.h
src/widgets/widgets/qsplitter.cpp

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QSplitter() [1/2]

◆ QSplitter() [2/2]

◆ ~QSplitter()

Member Function Documentation

◆ addWidget()

◆ changeEvent()

◆ childEvent()

◆ childrenCollapsible()

◆ closestLegalPosition()

◆ count()

◆ createHandle()

◆ event()

◆ getRange()

◆ handle()

◆ handleWidth()

◆ indexOf()

◆ insertWidget()

◆ isCollapsible()

◆ minimumSizeHint()

◆ moveSplitter()

◆ opaqueResize()

◆ orientation()

◆ refresh()

◆ replaceWidget()

◆ resizeEvent()

◆ restoreState()

◆ saveState()

◆ setChildrenCollapsible()

◆ setCollapsible()

◆ setHandleWidth()

◆ setOpaqueResize()

◆ setOrientation()

◆ setRubberBand()

◆ setSizes()

◆ setStretchFactor()

◆ sizeHint()

◆ sizes()

◆ splitterMoved

◆ widget()

Friends And Related Function Documentation

◆ QSplitterHandle

Property Documentation

◆ childrenCollapsible

◆ handleWidth

◆ opaqueResize

◆ orientation