Represents a dock widget. More...

#include <DockWidgetQuick.h>

Inheritance diagram for KDDockWidgets::DockWidgetQuick:

[legend]

Collaboration diagram for KDDockWidgets::DockWidgetQuick:

[legend]

Signals
void	frameGeometryChanged (QRect)
	The geometry of the frame container this dock widget is in changed For example, when dragging a dockwidget.

Signals inherited from KDDockWidgets::DockWidgetBase
void	aboutToDeleteOnClose ()
	Emitted when this dock widget is about to be deleted due to Option_DeleteOnClose.

void	actualTitleBarChanged ()
	Emitted when the title bar that serves this dock widget changes.

void	hidden ()
	signal emitted when the DockWidget is hidden. As in QEvent::Hide.

void	iconChanged ()
	signal emitted when the icon changed

void	isFloatingChanged (bool)
	emitted when isFloating changes

void	isFocusedChanged (bool)
	emitted when isFocused changes

void	isOverlayedChanged (bool)
	emitted when isOverlayed changes

void	optionsChanged (KDDockWidgets::DockWidgetBase::Options)
	emitted when the options change

void	parentChanged ()
	signal emitted when the parent changed QtQuick already has QQuickItem::parentChanged(), so add it only for QtWidgets here.

void	removedFromSideBar ()
	emitted when this dock widget is removed from a side-bar. Only relevant for the auto-hide/sidebar feature

void	shown ()
	signal emitted when the DockWidget is shown. As in QEvent::Show.

void	titleChanged (const QString &title)
	signal emitted when the title changed

void	widgetChanged (KDDockWidgets::QWidgetOrQuick *)
	emitted when the hosted widget changed

void	windowActiveAboutToChange (bool activated)
	Emitted when the top-level window this dock widget is in is activated or deactivated This is convenience to replace tracking dockWidget->window(), since the window changes when docking and undocking.

Public Member Functions
	DockWidgetQuick (const QString &uniqueName, Options options={}, LayoutSaverOptions layoutSaverOptions=LayoutSaverOptions(), QQmlEngine *engine=nullptr)
	constructs a new DockWidget

	~DockWidgetQuick () override
	destructor

TitleBar *	actualTitleBar () const
	Returns the title bar.

QObject *	actualTitleBarObj () const
	Returns the title bar Qt6 requires us to include TitleBar_p.h, so instead the Q_PROPERTY uses QObject so we don't include private headers in public headers.

Q_INVOKABLE KDDockWidgets::Frame *	frame () const

QQuickItem *	frameVisualItem () const
	Returns the visual item which represents Frame in the screen Equivalent to Frame::visualItem().

QSize	maximumSize () const override
	Reimplemented for internal purposes. .

QSize	minimumSize () const override
	Reimplemented for internal purposes. .

Q_INVOKABLE void	onGeometryUpdated ()
	Called by QtQuick when min-size changes.

void	setWidget (const QString &qmlFilename)

Q_INVOKABLE void	setWidget (QQuickItem *widget)
	Reimplemented for internal purposes. .

void	setWidget (QWidgetAdapter *widget) override
	Reimplemented for internal purposes. .

Public Member Functions inherited from KDDockWidgets::DockWidgetBase
	DockWidgetBase (const QString &uniqueName, Options options=KDDockWidgets::DockWidgetBase::Options(), LayoutSaverOptions layoutSaverOptions=KDDockWidgets::DockWidgetBase::LayoutSaverOptions())
	constructs a new DockWidget

	~DockWidgetBase () override
	destructor

Q_INVOKABLE void	addDockWidgetAsTab (KDDockWidgets::DockWidgetBase *other, KDDockWidgets::InitialOption initialOption={})
	docks `other` widget into this one. Tabs will be shown if not already.

Q_INVOKABLE void	addDockWidgetToContainingWindow (KDDockWidgets::DockWidgetBase other, KDDockWidgets::Location location, KDDockWidgets::DockWidgetBase relativeTo=nullptr, KDDockWidgets::InitialOption initialOption={})
	docks `other` widget into the window that contains this one. Equivalent to MainWindow::addDockWidget() with the difference that it also supports the case where the top-level window is a FloatingWindow instead of MainWindow.

QStringList	affinities () const
	Returns the affinity name. Empty by default.

int	currentTabIndex () const
	Returns the index of the current tab of the tab group this dock widget is in.

Q_INVOKABLE QAction *	floatAction () const
	Returns the QAction that allows to dock/undock the dock widget Useful to put in menus.

KDDockWidgets::FloatingWindowFlags	floatingWindowFlags () const

Q_INVOKABLE void	forceClose ()
	Like QWidget::close() but the hosted widget won't be asked if we should close.

QRect	frameGeometry () const
	Returns the size of the dock widget's parent frame.

bool	hasPreviousDockedLocation () const
	Returns whether this floating dock widget knows its previous docked location Result only makes sense if it's floating.

QIcon	icon (IconPlace place=IconPlace::TitleBar) const
	Returns the dock widget's titlebar, tabbar, or toggle action icon (depending on the passed `place`)

bool	isCurrentTab () const
	Returns true if this dock widget is the current one in the tab widget that contains it. If the dock widget is alone then true is returned, as in this case there will also be a tab widget even though it's invisible.

bool	isFloating () const
	Returns whether the dock widget is floating. Floating means it's not docked and has a window of its own. Note that if you dock a floating dock widget into another floating one then they don't count as floating anymore, as they are side-by-side (or tabbed).

bool	isFocused () const
	Returns whether This or any child of this dock widget is focused Not to be confused with QWidget::hasFocus(), which just refers to 1 widget. This includes variant includes children.

bool	isInMainWindow () const
	Returns whether this dock widget is docked into a main window (as opposed to floating)

bool	isInSideBar () const
	Returns where this dockwidget is in a sidebar Similar to sideBarLocation(), but returns a bool.

bool	isMainWindow () const
	Returns whether widget() is a KDDockWidget::MainWindow.

Q_INVOKABLE bool	isOpen () const
	Returns whether this dock widget is open. Equivalent to calling toggleAction().isChecked() or isVisible()

bool	isOverlayed () const
	Returns whether this dock widget is overlayed from the side-bar.

bool	isPersistentCentralDockWidget () const
	Returns whether this dock widget is the main window persistent central widget This only applies when using MainWindowOption_HasCentralWidget.

bool	isTabbed () const
	returns if this dock widget is tabbed into another

QSize	lastOverlayedSize () const
	returns the last size the widget has when overlayed Empty otherwise

KDDockWidgets::DockWidgetBase::LayoutSaverOptions	layoutSaverOptions () const
	returns the per-dockwidget options which will affect LayoutSaver These are the options which were passed to the constructor

MainWindowBase *	mainWindow () const
	Returns the main window this dock widget is in. nullptr if it's not inside a main window Also returns nullptr if it's minimized to a sidebar.

Q_INVOKABLE void	moveToSideBar ()
	Minimizes this dock widget to the MainWindow's side-bar.

Options	options () const
	Returns the dock widget's options which control behaviour.

Q_INVOKABLE void	raise ()
	Brings the dock widget to the front.

void	setAffinities (const QStringList &)
	Sets the affinity names. Dock widgets can only dock into dock widgets of the same affinity.

void	setAffinityName (const QString &name)

Q_INVOKABLE void	setAsCurrentTab ()
	Makes this dock widget current in its tab group.

bool	setFloating (bool floats)
	setter to make the dock widget float or dock.

void	setFloatingGeometry (QRect geo)
	If this dock widget is floating, then sets its geometry to `geo`.

void	setFloatingWindowFlags (FloatingWindowFlags)
	Sets the desired floating window flags, in case the defaults aren't desired. By default KDDW will use the flags specified in KDDockWidgets::Config to influence many aspects regarding windows (minimize,maximize support for example). You can use this function to override those "global flags" and specify per-dock widget flags. Be sure to not call this before the floating window has already been created. It's suggested to call it before the dock widget is shown.

void	setIcon (const QIcon &icon, IconPlaces places=IconPlace::All)
	Sets an icon to show on title bars and tab bars.

void	setMDIPosition (QPoint pos)
	Sets this dock widgets position to pos within the MDI layout This only applies if the main window is in MDI mode, which it is not by default.

void	setMDISize (QSize size)
	like setMDIPosition(), but for the size.

void	setMDIZ (int z)
	like setMDIPosition(), but for the Z only implemented for QtQuick

void	setOptions (Options)
	Setter for the options. Only Option_NotClosable is allowed to change after construction. For the other options use the constructor only.

void	setTitle (const QString &title)
	setter for the dock widget's title

void	setUserType (int userType)
	Allows the user to set a type on this dock widget The type is opaque and will not be interpreted by KDDockWidgets. This type is passed to FrameWorkWidgetFactory::createTitleBar(), which the user can override and return different TitleBar subclasses, depending on the type.

virtual void	setWidget (QWidgetOrQuick *widget)
	sets the widget which this dock widget hosts.

Q_INVOKABLE void	show ()
	Equivalent to QWidget::show(), but it's optimized to reduce flickering on some platforms.

SideBarLocation	sideBarLocation () const
	Returns whether this dock widget is in a side bar, and which. SideBarLocation::None is returned if it's not in a sidebar. This is only relevant when using the auto-hide and side-bar feature.

bool	skipsRestore () const
	Returns whether this widget has the LayoutSaverOption::Skip flag.

int	tabIndex () const
	Returns the tab index this dock widget occupies Note that dock widgets are almost always tabbed, even if you don't see the tab bar. A single floating dock widget is still tabbed on a tab widget with a single tab.

QString	title () const
	Returns the dock widget's title. This title is visible in title bars and tab bars.

TitleBar *	titleBar () const
	Returns this dock widget's title bar.

Q_INVOKABLE QAction *	toggleAction () const
	Returns the QAction that allows to hide/show the dock widget Useful to put in menus.

QString	uniqueName () const
	the dock widget's unique name.

int	userType () const

QWidgetOrQuick *	widget () const
	returns the widget which this dock widget hosts

Protected Member Functions
bool	event (QEvent *e) override

Protected Member Functions inherited from KDDockWidgets::DockWidgetBase
void	onCloseEvent (QCloseEvent *e) override

void	onHidden (bool spontaneous)

void	onParentChanged ()

bool	onResize (QSize newSize) override

void	onShown (bool spontaneous)

Properties
QObject *	actualTitleBar

Properties inherited from KDDockWidgets::DockWidgetBase
bool	isFloating

bool	isFocused

KDDockWidgets::DockWidgetBase::Options	options

QString	title

QString	uniqueName

QObject *	widget

Additional Inherited Members
Public Types inherited from KDDockWidgets::DockWidgetBase
enum class	IconPlace { TitleBar = 1 , TabBar = 2 , ToggleAction = 4 , All = ToggleAction \| TitleBar \| TabBar }

enum class	LayoutSaverOption { None = 0 , Skip = 1 }
	Options which will affect LayoutSaver save/restore. More...

typedef QVector< DockWidgetBase * >	List

enum	Option { Option_None = 0 , Option_NotClosable = 1 , Option_NotDockable = 2 , Option_DeleteOnClose = 4 , Option_MDINestable = 8 }
	DockWidget options to pass at construction time. More...

Static Public Member Functions inherited from KDDockWidgets::DockWidgetBase
static DockWidgetBase *	byName (const QString &uniqueName)
	Returns a dock widget by its name This is the same name you passed to DockWidget CTOR. nullptr is returned if the dock widget isn't found.

Detailed Description

Represents a dock widget.

Most of the interface lives in DockWidgetBase, to facilitate sharing with QtQuick.

Definition at line 39 of file DockWidgetQuick.h.

Constructor & Destructor Documentation

◆ DockWidgetQuick()

DockWidgetQuick::DockWidgetQuick	(	const QString &	uniqueName,
		Options	options = `{}`,
		LayoutSaverOptions	layoutSaverOptions = `LayoutSaverOptions()`,
		QQmlEngine *	engine = `nullptr`
	)

explicit

constructs a new DockWidget

Parameters

uniqueName	the name of the dockwidget, should be unique. Use title for user visible text.
options	optional options controlling behaviour
layoutSaverOptions	options regarding LayoutSaver behaviour
engine	the QML engine this dock widget will be created on. If not specified then Config::self().qmlEngine() will be used

There's no parent argument. The DockWidget is either parented to FloatingWindow or MainWindow when visible, or stays without a parent when hidden.

Definition at line 51 of file DockWidgetQuick.cpp.

◆ ~DockWidgetQuick()

DockWidgetQuick::~DockWidgetQuick ( )

override

destructor

Definition at line 60 of file DockWidgetQuick.cpp.

Member Function Documentation

◆ actualTitleBar()

TitleBar * DockWidgetQuick::actualTitleBar ( ) const

Returns the title bar.

Definition at line 133 of file DockWidgetQuick.cpp.

References KDDockWidgets::DockWidgetBase::Frame, and frame().

◆ actualTitleBarObj()

QObject * DockWidgetQuick::actualTitleBarObj ( ) const

Returns the title bar Qt6 requires us to include TitleBar_p.h, so instead the Q_PROPERTY uses QObject so we don't include private headers in public headers.

Definition at line 140 of file DockWidgetQuick.cpp.

References actualTitleBar.

◆ event()

bool DockWidgetQuick::event ( QEvent * e )

overrideprotected

Definition at line 97 of file DockWidgetQuick.cpp.

References KDDockWidgets::DockWidgetBase::actualTitleBarChanged(), QEvent::Close, QEvent::Hide, KDDockWidgets::DockWidgetBase::onCloseEvent(), KDDockWidgets::DockWidgetBase::onHidden(), KDDockWidgets::DockWidgetBase::onParentChanged(), KDDockWidgets::DockWidgetBase::onShown(), QEvent::ParentChange, QEvent::Show, QEvent::spontaneous(), and QEvent::type().

◆ frame()

Frame * DockWidgetQuick::frame ( ) const

Definition at line 161 of file DockWidgetQuick.cpp.

References frame().

Referenced by actualTitleBar(), frame(), frameVisualItem(), and onGeometryUpdated().

◆ frameGeometryChanged

void KDDockWidgets::DockWidgetQuick::frameGeometryChanged ( QRect )

signal

The geometry of the frame container this dock widget is in changed For example, when dragging a dockwidget.

◆ frameVisualItem()

QQuickItem * DockWidgetQuick::frameVisualItem ( ) const

Returns the visual item which represents Frame in the screen Equivalent to Frame::visualItem().

Definition at line 145 of file DockWidgetQuick.cpp.

References frame().

◆ maximumSize()

QSize DockWidgetQuick::maximumSize ( ) const

override

Reimplemented for internal purposes.
.

Definition at line 123 of file DockWidgetQuick.cpp.

References KDDockWidgets::DockWidgetBase::widget.

◆ minimumSize()

QSize DockWidgetQuick::minimumSize ( ) const

override

Reimplemented for internal purposes.
.

Definition at line 113 of file DockWidgetQuick.cpp.

References KDDockWidgets::DockWidgetBase::widget.

◆ onGeometryUpdated()

void DockWidgetQuick::onGeometryUpdated ( )

Called by QtQuick when min-size changes.

Definition at line 153 of file DockWidgetQuick.cpp.

References frame().

◆ setWidget() [1/3]

void DockWidgetQuick::setWidget ( const QString & qmlFilename )

Sets the DockWidget's guest item Similar to DockWidgetBase::setWidget(QQuickItem*)

Definition at line 65 of file DockWidgetQuick.cpp.

References setWidget().

Referenced by setWidget(), and setWidget().

◆ setWidget() [2/3]

void DockWidgetQuick::setWidget ( QQuickItem * widget )

Reimplemented for internal purposes.
.

Definition at line 81 of file DockWidgetQuick.cpp.

References QVariant::fromValue(), and setWidget().

◆ setWidget() [3/3]

void DockWidgetQuick::setWidget ( QWidgetAdapter * widget )

override

Reimplemented for internal purposes.
.

Definition at line 74 of file DockWidgetQuick.cpp.

References KDDockWidgets::DockWidgetBase::setWidget(), and KDDockWidgets::DockWidgetBase::widget.

Property Documentation

◆ actualTitleBar

QObject * KDDockWidgets::DockWidgetQuick::actualTitleBar

read

Definition at line 42 of file DockWidgetQuick.h.

Referenced by actualTitleBarObj().

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

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DockWidgetQuick()

◆ ~DockWidgetQuick()

Member Function Documentation

◆ actualTitleBar()

◆ actualTitleBarObj()

◆ event()

◆ frame()

◆ frameGeometryChanged

◆ frameVisualItem()

◆ maximumSize()

◆ minimumSize()

◆ onGeometryUpdated()

◆ setWidget() [1/3]

◆ setWidget() [2/3]

◆ setWidget() [3/3]

Property Documentation

◆ actualTitleBar