#include <qdockwidget_p.h>

Inheritance diagram for QDockWidgetLayout:

Collaboration diagram for QDockWidgetLayout:

Public Types
enum	Role { Content , CloseButton , FloatButton , TitleBar , RoleCount }
Public Types inherited from QLayout
enum	SizeConstraint { SetDefaultConstraint , SetNoConstraint , SetMinimumSize , SetFixedSize , SetMaximumSize , SetMinAndMaxSize }
	Describes how the layout constrains the size of the widget. More...

Public Member Functions
	QDockWidgetLayout (QWidget *parent=nullptr)
	~QDockWidgetLayout ()
void	addItem (QLayoutItem *item) override
	Implemented in subclasses to add an item.
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	maximumSize () const override
	Implemented in subclasses to return the maximum size of this item.
QSize	minimumSize () const override
	Implemented in subclasses to return the minimum size of this item.
QSize	sizeHint () const override
	Implemented in subclasses to return the preferred size of this item.
QSize	sizeFromContent (const QSize &content, bool floating) const
void	setGeometry (const QRect &r) override
	\reimp
QWidget *	widgetForRole (Role r) const
void	setWidgetForRole (Role r, QWidget *w)
QLayoutItem *	itemForRole (Role r) const
QRect	titleArea () const
int	minimumTitleWidth () const
int	titleHeight () const
void	updateMaxSize ()
bool	nativeWindowDeco () const
bool	nativeWindowDeco (bool floating) const
void	setVerticalTitleBar (bool b)
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 constraint)
SizeConstraint	sizeConstraint () const
void	setSizeConstraints (SizeConstraint horizontal, SizeConstraint vertical)
void	setHorizontalSizeConstraint (SizeConstraint constraint)
SizeConstraint	horizontalSizeConstraint () const
void	setVerticalSizeConstraint (SizeConstraint constraint)
SizeConstraint	verticalSizeConstraint () 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.
void	invalidate () override
	\reimp
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	minimumSize () const override
	Returns the minimum size of this layout.
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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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.

Static Public Member Functions
static bool	wmSupportsNativeWindowDeco ()
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)

Public Attributes
bool	verticalTitleBar

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.
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	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
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 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.
SizeConstraint	horizontalSizeConstraint
	The horizontal size constraint.
SizeConstraint	verticalSizeConstraint
	The vertical size constraint.
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 124 of file qdockwidget_p.h.

Member Enumeration Documentation

◆ Role

enum QDockWidgetLayout::Role

Enumerator
Content
CloseButton
FloatButton
TitleBar
RoleCount

Definition at line 143 of file qdockwidget_p.h.

Constructor & Destructor Documentation

◆ QDockWidgetLayout()

QDockWidgetLayout::QDockWidgetLayout ( QWidget * parent = nullptr )

explicit

Definition at line 203 of file qdockwidget.cpp.

◆ ~QDockWidgetLayout()

QDockWidgetLayout::~QDockWidgetLayout ( )

Definition at line 208 of file qdockwidget.cpp.

Member Function Documentation

◆ addItem()

void QDockWidgetLayout::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 255 of file qdockwidget.cpp.

◆ count()

int QDockWidgetLayout::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 291 of file qdockwidget.cpp.

◆ itemAt()

QLayoutItem * QDockWidgetLayout::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 261 of file qdockwidget.cpp.

◆ itemForRole()

QLayoutItem * QDockWidgetLayout::itemForRole ( Role r ) const

Definition at line 406 of file qdockwidget.cpp.

◆ maximumSize()

QSize QDockWidgetLayout::maximumSize ( ) const

overridevirtual

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

Implements QLayoutItem.

Definition at line 378 of file qdockwidget.cpp.

◆ minimumSize()

QSize QDockWidgetLayout::minimumSize ( ) const

overridevirtual

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

Implements QLayoutItem.

Definition at line 389 of file qdockwidget.cpp.

◆ minimumTitleWidth()

int QDockWidgetLayout::minimumTitleWidth ( ) const

Definition at line 440 of file qdockwidget.cpp.

◆ nativeWindowDeco() [1/2]

bool QDockWidgetLayout::nativeWindowDeco ( ) const

Returns true if the dock widget managed by this layout should have a native window decoration or if Qt needs to draw it.

Definition at line 217 of file qdockwidget.cpp.

◆ nativeWindowDeco() [2/2]

bool QDockWidgetLayout::nativeWindowDeco ( bool floating ) const

Returns true if the dock widget managed by this layout should have a native window decoration or if Qt needs to draw it. The floating parameter overrides the floating current state of the dock widget.

Definition at line 249 of file qdockwidget.cpp.

◆ setGeometry()

void QDockWidgetLayout::setGeometry ( const QRect & r )

overridevirtual

\reimp

Reimplemented from QLayout.

Definition at line 491 of file qdockwidget.cpp.

◆ setVerticalTitleBar()

void QDockWidgetLayout::setVerticalTitleBar ( bool b )

Definition at line 556 of file qdockwidget.cpp.

◆ setWidgetForRole()

void QDockWidgetLayout::setWidgetForRole	(	Role	r,
		QWidget *	w )

Definition at line 411 of file qdockwidget.cpp.

◆ sizeFromContent()

QSize QDockWidgetLayout::sizeFromContent	(	const QSize &	content,
		bool	floating ) const

Definition at line 301 of file qdockwidget.cpp.

◆ sizeHint()

QSize QDockWidgetLayout::sizeHint ( ) const

overridevirtual

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

Implements QLayoutItem.

Definition at line 367 of file qdockwidget.cpp.

◆ takeAt()

QLayoutItem * QDockWidgetLayout::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 274 of file qdockwidget.cpp.

◆ titleArea()

QRect QDockWidgetLayout::titleArea ( ) const

inline

Definition at line 148 of file qdockwidget_p.h.

◆ titleHeight()

int QDockWidgetLayout::titleHeight ( ) const

Definition at line 468 of file qdockwidget.cpp.

◆ updateMaxSize()

void QDockWidgetLayout::updateMaxSize ( )

◆ widgetForRole()

QWidget * QDockWidgetLayout::widgetForRole ( Role r ) const

Definition at line 400 of file qdockwidget.cpp.

◆ wmSupportsNativeWindowDeco()

bool QDockWidgetLayout::wmSupportsNativeWindowDeco ( )

static

Returns true if the window manager can draw natively the windows decoration of a dock widget

Definition at line 232 of file qdockwidget.cpp.

Member Data Documentation

◆ verticalTitleBar

bool QDockWidgetLayout::verticalTitleBar

Definition at line 159 of file qdockwidget_p.h.

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

qtbase/src/widgets/widgets/qdockwidget_p.h (3f9569c505c0949efee336a83cb247e4e5a4658c)
qtbase/src/widgets/widgets/qdockwidget.cpp (87806f5cad6e4ce75a899598c15c126995682562)

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Role

Constructor & Destructor Documentation

◆ QDockWidgetLayout()

◆ ~QDockWidgetLayout()

Member Function Documentation

◆ addItem()

◆ count()

◆ itemAt()

◆ itemForRole()

◆ maximumSize()

◆ minimumSize()

◆ minimumTitleWidth()

◆ nativeWindowDeco() [1/2]

◆ nativeWindowDeco() [2/2]

◆ setGeometry()

◆ setVerticalTitleBar()

◆ setWidgetForRole()

◆ sizeFromContent()

◆ sizeHint()

◆ takeAt()

◆ titleArea()

◆ titleHeight()

◆ updateMaxSize()

◆ widgetForRole()

◆ wmSupportsNativeWindowDeco()

Member Data Documentation

◆ verticalTitleBar