#include <qmainwindowlayout_p.h>

Inheritance diagram for QMainWindowLayout:

Collaboration diagram for QMainWindowLayout:

Public Types
enum	VersionMarkers { VersionMarker = 0xff }

Public Types inherited from QLayout
enum	SizeConstraint { SetDefaultConstraint , SetNoConstraint , SetMinimumSize , SetFixedSize , SetMaximumSize , SetMinAndMaxSize }
	The possible values are: More...

Public Member Functions
	QMainWindowLayout (QMainWindow mainwindow, QLayout parentLayout)

	~QMainWindowLayout ()

void	setDockOptions (QMainWindow::DockOptions opts)

QWidget *	centralWidget () const

void	setCentralWidget (QWidget *cw)

void	saveState (QDataStream &stream) const

bool	restoreState (QDataStream &stream)

void	addItem (QLayoutItem *item) override
	Implemented in subclasses to add an item.

void	setGeometry (const QRect &r) override
	\reimp

QLayoutItem *	itemAt (int index) const override
	Must be implemented in subclasses to return the layout item at index.

QLayoutItem *	takeAt (int index) override
	Must be implemented in subclasses to remove the layout item at index from the layout, and return the item.

int	count () const override
	Must be implemented in subclasses to return the number of items in the layout.

QSize	sizeHint () const override
	Implemented in subclasses to return the preferred size of this item.

QSize	minimumSize () const override
	Returns the minimum size of this layout.

void	invalidate () override
	\reimp

void	hover (QLayoutItem *hoverTarget, const QPoint &mousePos)

bool	plug (QLayoutItem *widgetItem)

QLayoutItem *	unplug (QWidget *widget, QDockWidgetPrivate::DragScope scope)

void	revert (QLayoutItem *widgetItem)

void	applyState (QMainWindowLayoutState &newState, bool animate=true)

void	applyRestoredState ()

void	restore (bool keepSavedState=false)

void	animationFinished (QWidget *widget)

Public Member Functions inherited from QLayout
	QLayout (QWidget *parent=nullptr)
	Constructs a new top-level QLayout, with parent parent.

	~QLayout ()

virtual int	spacing () const

virtual void	setSpacing (int)

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

void	setContentsMargins (const QMargins &margins)

void	unsetContentsMargins ()

void	getContentsMargins (int left, int top, int right, int bottom) const

QMargins	contentsMargins () const

QRect	contentsRect () const

bool	setAlignment (QWidget *w, Qt::Alignment alignment)
	Sets the alignment for widget w to alignment and returns true if w is found in this layout (not including child layouts); otherwise returns `false`.

bool	setAlignment (QLayout *l, Qt::Alignment alignment)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the alignment for the layout l to alignment and returns `true` if l is found in this layout (not including child layouts); otherwise returns `false`.

void	setSizeConstraint (SizeConstraint)

SizeConstraint	sizeConstraint () const

void	setMenuBar (QWidget *w)
	Tells the geometry manager to place the menu bar widget at the top of parentWidget(), outside QWidget::contentsMargins().

QWidget *	menuBar () const
	Returns the menu bar set for this layout, or \nullptr if no menu bar is set.

QWidget *	parentWidget () const
	Returns the parent widget of this layout, or \nullptr if this layout is not installed on any widget.

QRect	geometry () const override
	\reimp

bool	activate ()
	Redoes the layout for parentWidget() if necessary.

void	update ()
	Updates the layout for parentWidget().

void	addWidget (QWidget *w)
	Adds widget w to this layout in a manner specific to the layout.

void	removeWidget (QWidget *w)
	Removes the widget widget from the layout.

void	removeItem (QLayoutItem *)
	Removes the layout item item from the layout.

Qt::Orientations	expandingDirections () const override
	Returns whether this layout can make use of more space than sizeHint().

QSize	maximumSize () const override
	Returns the maximum size of this layout.

virtual int	indexOf (const QWidget *) const
	Searches for widget widget in this layout (not including child layouts).

virtual int	indexOf (const QLayoutItem *) const

bool	isEmpty () const override
	\reimp

QSizePolicy::ControlTypes	controlTypes () const override
	\reimp

virtual QLayoutItem *	replaceWidget (QWidget from, QWidget to, Qt::FindChildOptions options=Qt::FindChildrenRecursively)

int	totalMinimumHeightForWidth (int w) const

int	totalHeightForWidth (int w) const

QSize	totalMinimumSize () const

QSize	totalMaximumSize () const

QSize	totalSizeHint () const

QLayout *	layout () override
	\reimp

void	setEnabled (bool)
	Enables this layout if enable is true, otherwise disables it.

bool	isEnabled () const
	Returns `true` if the layout is enabled; otherwise returns `false`.

void	setAlignment (Qt::Alignment a)
	Sets the alignment of this item to alignment.

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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

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 QLayoutItem
	QLayoutItem (Qt::Alignment alignment=Qt::Alignment())
	Constructs a layout item with an alignment.

virtual	~QLayoutItem ()
	Destroys the QLayoutItem.

virtual bool	hasHeightForWidth () const
	Returns `true` if this layout's preferred height depends on its width; otherwise returns `false`.

virtual int	heightForWidth (int) const
	Returns the preferred height for this layout item, given the width, which is not used in this default implementation.

virtual int	minimumHeightForWidth (int) const
	Returns the minimum height this widget needs for the given width, w.

virtual QWidget *	widget () const
	If this item manages a QWidget, returns that widget.

virtual QSpacerItem *	spacerItem ()
	If this item is a QSpacerItem, it is returned as a QSpacerItem; otherwise \nullptr is returned.

Qt::Alignment	alignment () const
	Returns the alignment of this item.

void	setAlignment (Qt::Alignment a)
	Sets the alignment of this item to alignment.

Public Member Functions inherited from QMainWindowLayoutSeparatorHelper< QMainWindowLayout >
	QMainWindowLayoutSeparatorHelper ()=default

Public Attributes
QMainWindowLayoutState	layoutState

QMainWindowLayoutState	savedState

std::unique_ptr< QMainWindowLayoutState >	restoredState

QMainWindow::DockOptions	dockOptions

QLayoutItem *	statusbar

QBasicTimer	discardRestoredStateTimer

QSize	szHint

QSize	minSize

QWidgetAnimator	widgetAnimator

QList< int >	currentGapPos

QRect	currentGapRect

QWidget *	pluggingWidget

bool	isInApplyState = false

Public Attributes inherited from QMainWindowLayoutSeparatorHelper< QMainWindowLayout >
QList< int >	hoverSeparator

QPoint	hoverPos

Protected Member Functions
void	timerEvent (QTimerEvent *e) override
	This event handler can be reimplemented in a subclass to receive timer events for the object.

Protected Member Functions inherited from QLayout
void	widgetEvent (QEvent *)

void	childEvent (QChildEvent *e) override
	\reimp

void	addChildLayout (QLayout *l)
	This function is called from `addLayout()` or `insertLayout()` functions in subclasses to add layout childLayout as a sub-layout.

void	addChildWidget (QWidget *w)
	This function is called from `addWidget()` functions in subclasses to add w as a managed widget of a layout.

bool	adoptLayout (QLayout *layout)

QRect	alignmentRect (const QRect &) const
	Returns the rectangle that should be covered when the geometry of this layout is set to r, provided that this layout supports setAlignment().

	QLayout (QLayoutPrivate &d, QLayout , QWidget )

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

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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.

Static Public Member Functions inherited from QLayout
static QSize	closestAcceptableSize (const QWidget *w, const QSize &s)
	Returns a size that satisfies all size constraints on widget, including heightForWidth() and that is as close as possible to size.

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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QLayoutItem
Qt::Alignment	align

Properties inherited from QLayout
int	spacing
	the spacing between widgets inside the layout

QMargins	contentsMargins

SizeConstraint	sizeConstraint
	the resize mode of the layout

Properties inherited from QObject
QString	objectName
	the name of this object

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

Definition at line 454 of file qmainwindowlayout_p.h.

Member Enumeration Documentation

◆ VersionMarkers

enum QMainWindowLayout::VersionMarkers

Enumerator
VersionMarker

Definition at line 550 of file qmainwindowlayout_p.h.

Constructor & Destructor Documentation

◆ QMainWindowLayout()

QMainWindowLayout::QMainWindowLayout	(	QMainWindow *	mainwindow,
		QLayout *	parentLayout )

Definition at line 2653 of file qmainwindowlayout.cpp.

References QInternal::DockCount, i, pluggingWidget, QStyle::PM_DockWidgetSeparatorExtent, sep, QObject::setObjectName(), QObject::setParent(), and QTabWidget::South.

Here is the call graph for this function:

◆ ~QMainWindowLayout()

QMainWindowLayout::~QMainWindowLayout ( )

Definition at line 2689 of file qmainwindowlayout.cpp.

References QMainWindowLayoutState::deleteAllLayoutItems(), QMainWindowLayoutState::deleteCentralWidgetItem(), layoutState, and statusbar.

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

void QMainWindowLayout::addItem ( QLayoutItem * item )

overridevirtual

Implemented in subclasses to add an item.

How it is added is specific to each subclass.

This function is not usually called in application code. To add a widget to a layout, use the addWidget() function; to add a child layout, use the addLayout() function provided by the relevant QLayout subclass.

{Note:} The ownership of item is transferred to the layout, and it's the layout's responsibility to delete it.

See also: addWidget(), QBoxLayout::addLayout(), QGridLayout::addLayout()

Implements QLayout.

Definition at line 2331 of file qmainwindowlayout.cpp.

References qWarning.

◆ animationFinished()

void QMainWindowLayout::animationFinished ( QWidget * widget )

Definition at line 2522 of file qmainwindowlayout.cpp.

References QDockAreaLayoutInfo::clear(), QDockAreaLayoutInfo::indexOf(), info, item, Q_ASSERT, QGraphicsItem::show(), and widget.

Here is the call graph for this function:

◆ applyRestoredState()

void QMainWindowLayout::applyRestoredState ( )

restoredState stores what we earlier read from storage, but it couldn't be applied as the mainwindow wasn't large enough (yet) to fit the state. Usually, the restored state would be applied lazily in setGeometry below. However, if the mainwindow's layout is modified (e.g. by a call to tabify or splitDockWidgets), then we have to forget the restored state as it might contain dangling pointers (QDockWidgetLayoutItem has a copy constructor that copies the layout item pointer, and splitting or tabify might have to delete some of those layout structures).

Functions that might result in the QMainWindowLayoutState storing dangling pointers have to call this function first, so that the restoredState becomes the actual state first, and is forgotten afterwards.

Definition at line 2260 of file qmainwindowlayout.cpp.

◆ applyState()

void QMainWindowLayout::applyState	(	QMainWindowLayoutState &	newState,
		bool	animate = true )

Definition at line 3151 of file qmainwindowlayout.cpp.

References QMainWindow::AnimatedDocks, QInternal::DockCount, dockOptions, QObject::findChildren(), Qt::FindDirectChildrenOnly, i, isInApplyState, newState(), QObject::parent(), QLayout::parentWidget(), and sep.

Referenced by hover(), and restoreState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ centralWidget()

QWidget * QMainWindowLayout::centralWidget ( ) const

Definition at line 2725 of file qmainwindowlayout.cpp.

References QMainWindowLayoutState::centralWidget(), and layoutState.

Here is the call graph for this function:

◆ count()

int QMainWindowLayout::count ( ) const

overridevirtual

Must be implemented in subclasses to return the number of items in the layout.

See also: itemAt()

Implements QLayout.

Definition at line 2181 of file qmainwindowlayout.cpp.

◆ hover()

void QMainWindowLayout::hover	(	QLayoutItem *	hoverTarget,
		const QPoint &	mousePos )

Definition at line 2965 of file qmainwindowlayout.cpp.

References applyState(), QList< T >::at(), QObject::children(), currentGapPos, currentGapRect, QInternal::DockCount, dockOptions, fixToolBarOrientation(), QMainWindowLayoutState::gapIndex(), QMainWindow::GroupedDragging, Qt::Horizontal, info, QMainWindowLayoutState::isValid(), isVisible(), layoutState, QWidget::mapFromGlobal(), newState(), QLayout::parentWidget(), pluggingWidget, pos, Q_ASSERT, qCDebug, qobject_cast< QWidget * >(), qt_widget_private(), restore(), QInternal::RightDock, savedState, QWidget::update(), and QLayoutItem::widget().

Here is the call graph for this function:

◆ invalidate()

void QMainWindowLayout::invalidate ( )

overridevirtual

\reimp

Reimplemented from QLayout.

Definition at line 2356 of file qmainwindowlayout.cpp.

References QLayout::invalidate().

Referenced by setCentralWidget(), and setDockOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ itemAt()

QLayoutItem * QMainWindowLayout::itemAt ( int index ) const

overridevirtual

Must be implemented in subclasses to return the layout item at index.

If there is no such item, the function must return \nullptr. Items are numbered consecutively from 0. If an item is deleted, other items will be renumbered.

This function can be used to iterate over a layout. The following code will draw a rectangle for each layout item in the layout structure of the widget.

static void paintLayout(QPainter *painter, QLayoutItem *item)
{
    QLayout *layout = item->layout();
    if (layout) {
        for (int i = 0; i < layout->count(); ++i)
            paintLayout(painter, layout->itemAt(i));
    }
    painter->drawRect(item->geometry());
}
 
void MyWidget::paintEvent(QPaintEvent *)
{
    QPainter painter(this);
    if (layout())
        paintLayout(&painter, layout());
}

See also: count(), takeAt()

Implements QLayout.

Definition at line 2189 of file qmainwindowlayout.cpp.

References ret.

◆ minimumSize()

QSize QMainWindowLayout::minimumSize ( ) const

overridevirtual

Returns the minimum size of this layout.

This is the smallest size that the layout can have while still respecting the specifications.

The returned value doesn't include the space required by QWidget::setContentsMargins() or menuBar().

The default implementation allows unlimited resizing.

Reimplemented from QLayout.

Definition at line 2345 of file qmainwindowlayout.cpp.

References QSize::height(), QSize::isValid(), qMax(), and QSize::width().

Here is the call graph for this function:

◆ plug()

bool QMainWindowLayout::plug ( QLayoutItem * widgetItem )

Definition at line 2445 of file qmainwindowlayout.cpp.

References QMainWindow::AnimatedDocks, Qt::FindDirectChildrenOnly, fixToolBarOrientation(), isVisible(), it, layout, QWidget::layout(), QRect::moveTopLeft(), QStyle::pixelMetric(), QStyle::PM_DockWidgetFrameWidth, Q_ASSERT, QWidget::style(), widget, and QLayoutItem::widget().

Here is the call graph for this function:

◆ restore()

void QMainWindowLayout::restore ( bool keepSavedState = false )

Definition at line 2639 of file qmainwindowlayout.cpp.

References QDockAreaLayoutInfo::clear().

Referenced by hover().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restoreState()

bool QMainWindowLayout::restoreState ( QDataStream & stream )

Definition at line 3198 of file qmainwindowlayout.cpp.

References applyState(), QMainWindowLayoutState::clear(), QMainWindowLayoutState::deleteAllLayoutItems(), QMainWindowLayoutState::fitLayout(), QMainWindowLayoutState::fits(), isVisible(), layoutState, QLayout::parentWidget(), QMainWindowLayoutState::rect, restoredState, QMainWindowLayoutState::restoreState(), savedState, Qt::WindowFullScreen, and Qt::WindowMaximized.

Here is the call graph for this function:

◆ revert()

void QMainWindowLayout::revert ( QLayoutItem * widgetItem )

Definition at line 2427 of file qmainwindowlayout.cpp.

References fixToolBarOrientation(), QDockAreaLayoutInfo::indexOf(), widget, and QLayoutItem::widget().

Here is the call graph for this function:

◆ saveState()

void QMainWindowLayout::saveState ( QDataStream & stream ) const

Definition at line 3193 of file qmainwindowlayout.cpp.

References layoutState, and QMainWindowLayoutState::saveState().

Here is the call graph for this function:

◆ setCentralWidget()

void QMainWindowLayout::setCentralWidget ( QWidget * cw )

Definition at line 2730 of file qmainwindowlayout.cpp.

References QLayout::addChildWidget(), QMainWindowLayoutState::centralWidgetItem, invalidate(), QMainWindowLayoutState::isValid(), layoutState, savedState, QMainWindowLayoutState::setCentralWidget(), and QLayoutItem::widget().

Here is the call graph for this function:

◆ setDockOptions()

void QMainWindowLayout::setDockOptions ( QMainWindow::DockOptions opts )

Definition at line 2697 of file qmainwindowlayout.cpp.

References dockOptions, invalidate(), and QMainWindow::VerticalTabs.

Here is the call graph for this function:

◆ setGeometry()

void QMainWindowLayout::setGeometry ( const QRect & r )

overridevirtual

\reimp

Reimplemented from QLayout.

Definition at line 2269 of file qmainwindowlayout.cpp.

References QSize::expandedTo(), QLayout::setGeometry(), and QStyle::visualRect().

Here is the call graph for this function:

◆ sizeHint()

QSize QMainWindowLayout::sizeHint ( ) const

overridevirtual

Implemented in subclasses to return the preferred size of this item.

Implements QLayoutItem.

Definition at line 2334 of file qmainwindowlayout.cpp.

References qMax().

Here is the call graph for this function:

◆ takeAt()

QLayoutItem * QMainWindowLayout::takeAt ( int index )

overridevirtual

Must be implemented in subclasses to remove the layout item at index from the layout, and return the item.

If there is no such item, the function must do nothing and return 0. Items are numbered consecutively from 0. If an item is removed, other items will be renumbered.

The following code fragment shows a safe way to remove all items from a layout:

QLayoutItem *child;
while ((child = layout->takeAt(0)) != nullptr) {
    ...
    delete child->widget(); // delete the widget
    delete child;   // delete the layout item
}

See also: itemAt(), count()

Implements QLayout.

Definition at line 2202 of file qmainwindowlayout.cpp.

References QDockAreaLayoutInfo::remove(), and ret.

Here is the call graph for this function:

◆ timerEvent()

void QMainWindowLayout::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also: startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 2322 of file qmainwindowlayout.cpp.

References QObject::timerEvent(), and QTimerEvent::timerId().

Here is the call graph for this function:

◆ unplug()

QLayoutItem * QMainWindowLayout::unplug	(	QWidget *	widget,
		QDockWidgetPrivate::DragScope	scope )

Unplug widget (QDockWidget or QToolBar) from it's parent container.

If group is true we might actually unplug the group of tabs this widget is part if QMainWindow::GroupedDragging is set. When group is false, the widget itself is always unplugged alone

Returns the QLayoutItem of the dragged element. The layout item is kept in the layout but set as a gap item.

Definition at line 2809 of file qmainwindowlayout.cpp.

References QList< T >::at(), Qt::BottomDockWidgetArea, currentGapPos, currentGapRect, dockOptions, dockWidget, Qt::DockWidgetArea_Mask, QMainWindowLayoutState::fitLayout(), fixToolBarOrientation(), QDockWidgetPrivate::Group, QMainWindow::GroupedDragging, QMainWindowLayoutState::indexOf(), info, item, QMainWindowLayoutState::item(), QMainWindowLayoutState::itemRect(), QLayout::layout(), layoutState, Qt::LeftDockWidgetArea, Qt::NoDockWidgetArea, nullptr, QStyle::PM_TitleBarHeight, Q_ASSERT, Q_UNUSED, qCDebug, Qt::RightDockWidgetArea, savedState, sep, QApplication::style(), Qt::TopDockWidgetArea, QMainWindowLayoutState::unplug(), QLayoutItem::widget(), and QDockAreaLayoutItem::widgetItem.

Here is the call graph for this function:

Member Data Documentation

◆ currentGapPos

QList<int> QMainWindowLayout::currentGapPos

Definition at line 572 of file qmainwindowlayout_p.h.

Referenced by hover(), and unplug().

◆ currentGapRect

QRect QMainWindowLayout::currentGapRect

Definition at line 573 of file qmainwindowlayout_p.h.

Referenced by hover(), and unplug().

◆ discardRestoredStateTimer

QBasicTimer QMainWindowLayout::discardRestoredStateTimer

Definition at line 555 of file qmainwindowlayout_p.h.

◆ dockOptions

QMainWindow::DockOptions QMainWindowLayout::dockOptions

Definition at line 467 of file qmainwindowlayout_p.h.

Referenced by applyState(), hover(), setDockOptions(), and unplug().

◆ isInApplyState

bool QMainWindowLayout::isInApplyState = false

Definition at line 587 of file qmainwindowlayout_p.h.

Referenced by applyState().

◆ layoutState

QMainWindowLayoutState QMainWindowLayout::layoutState

Definition at line 461 of file qmainwindowlayout_p.h.

Referenced by ~QMainWindowLayout(), centralWidget(), hover(), restoreState(), saveState(), setCentralWidget(), and unplug().

◆ minSize

QSize QMainWindowLayout::minSize

mutable

Definition at line 567 of file qmainwindowlayout_p.h.

◆ pluggingWidget

QWidget* QMainWindowLayout::pluggingWidget

Definition at line 574 of file qmainwindowlayout_p.h.

Referenced by QMainWindowLayout(), and hover().

◆ restoredState

std::unique_ptr<QMainWindowLayoutState> QMainWindowLayout::restoredState

Definition at line 462 of file qmainwindowlayout_p.h.

Referenced by restoreState().

◆ savedState

QMainWindowLayoutState QMainWindowLayout::savedState

Definition at line 461 of file qmainwindowlayout_p.h.

Referenced by hover(), restoreState(), setCentralWidget(), and unplug().

◆ statusbar

QLayoutItem* QMainWindowLayout::statusbar

Definition at line 470 of file qmainwindowlayout_p.h.

Referenced by ~QMainWindowLayout().

◆ szHint

QSize QMainWindowLayout::szHint

mutable

Definition at line 566 of file qmainwindowlayout_p.h.

◆ widgetAnimator

QWidgetAnimator QMainWindowLayout::widgetAnimator

Definition at line 571 of file qmainwindowlayout_p.h.

Referenced by QDockAreaLayoutInfo::apply(), and QDockAreaLayout::apply().

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

qtbase/src/widgets/widgets/qmainwindowlayout_p.h (cd2a3e970aaeb8f5f92d9c6e52ede7a82f953150)
qtbase/src/widgets/widgets/qmainwindowlayout.cpp (f97e60a4f0602e1478c888ff1043276966c93387)

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ VersionMarkers

Constructor & Destructor Documentation

◆ QMainWindowLayout()

◆ ~QMainWindowLayout()

Member Function Documentation

◆ addItem()

◆ animationFinished()

◆ applyRestoredState()

◆ applyState()

◆ centralWidget()

◆ count()

◆ hover()

◆ invalidate()

◆ itemAt()

◆ minimumSize()

◆ plug()

◆ restore()

◆ restoreState()

◆ revert()

◆ saveState()

◆ setCentralWidget()

◆ setDockOptions()

◆ setGeometry()

◆ sizeHint()

◆ takeAt()

◆ timerEvent()

◆ unplug()

Member Data Documentation

◆ currentGapPos

◆ currentGapRect

◆ discardRestoredStateTimer

◆ dockOptions

◆ isInApplyState

◆ layoutState

◆ minSize

◆ pluggingWidget

◆ restoredState

◆ savedState

◆ statusbar

◆ szHint

◆ widgetAnimator