KDDockWidgets::DockWidgetInstantiator Class Reference

Indirection helper to instantiate dock widgets from QML. More...

#include <DockWidgetInstantiator.h>

Inheritance diagram for KDDockWidgets::DockWidgetInstantiator:

Collaboration diagram for KDDockWidgets::DockWidgetInstantiator:

Signals
void	actualTitleBarChanged ()
void	affinitiesChanged ()
void	closed ()
void	dockWidgetChanged ()
void	guestViewChanged (QQuickItem *)
void	iconChanged ()
void	isFloatingChanged (bool)
void	isFocusedChanged (bool)
void	isOpenChanged (bool)
void	isOverlayedChanged (bool)
void	optionsChanged (KDDockWidgets::DockWidgetOptions)
void	removedFromSideBar ()
void	sourceChanged ()
void	titleChanged (const QString &title)
void	uniqueNameChanged ()
void	windowActiveAboutToChange (bool activated)

Public Member Functions
	DockWidgetInstantiator ()
	~DockWidgetInstantiator () override
QObject *	actualTitleBar () const
Q_INVOKABLE void	addDockWidgetAsTab (QQuickItem *other, KDDockWidgets::InitialVisibilityOption={})
Q_INVOKABLE void	addDockWidgetToContainingWindow (QQuickItem *other, KDDockWidgets::Location location, QQuickItem *relativeTo=nullptr, QSize initialSize={}, KDDockWidgets::InitialVisibilityOption={})
QVector< QString >	affinities () const
Q_INVOKABLE bool	close ()
KDDockWidgets::Core::DockWidget *	controller () const
Q_INVOKABLE void	deleteDockWidget ()
KDDockWidgets::QtQuick::DockWidget *	dockWidget () const
Q_INVOKABLE void	forceClose ()
bool	isFloating () const
bool	isFocused () const
bool	isOpen () const
Q_INVOKABLE void	moveToSideBar ()
Q_INVOKABLE void	open ()
Q_INVOKABLE void	raise ()
void	setAffinities (const QVector< QString > &)
Q_INVOKABLE void	setAsCurrentTab ()
void	setFloating (bool)
void	setSource (const QString &)
void	setTitle (const QString &title)
void	setUniqueName (const QString &)
Q_INVOKABLE void	show ()
QString	source () const
QString	title () const
QString	uniqueName () const

Protected Member Functions
void	classBegin () override
void	componentComplete () override

Properties
QObject *	actualTitleBar
QVector< QString >	affinities
KDDockWidgets::QtQuick::DockWidget *	dockWidget
bool	isFloating
bool	isFocused
bool	isOpen
QString	source
QString	title
QString	uniqueName

Detailed Description

Indirection helper to instantiate dock widgets from QML.

"DockWidget {}" in QML won't create a KDDockWidget::DockWidget directly, but instead an DockWidgetInstantiator. DockWidgetInstantiator will then create the DockWidget instance only when the QML parsing ends (and all properties are set)

This allows to pass the correct uniqueName to DockWidget's ctor.

Definition at line 35 of file DockWidgetInstantiator.h.

Constructor & Destructor Documentation

DockWidgetInstantiator()

DockWidgetInstantiator::DockWidgetInstantiator

(

)

Definition at line 48 of file DockWidgetInstantiator.cpp.

~DockWidgetInstantiator()

DockWidgetInstantiator::~DockWidgetInstantiator ( )

override

Definition at line 53 of file DockWidgetInstantiator.cpp.

Member Function Documentation

actualTitleBar()

QObject * DockWidgetInstantiator::actualTitleBar

(

)

const

Definition at line 94 of file DockWidgetInstantiator.cpp.

References dockWidget.

actualTitleBarChanged

void KDDockWidgets::DockWidgetInstantiator::actualTitleBarChanged ( )

signal

Referenced by componentComplete().

addDockWidgetAsTab()

void DockWidgetInstantiator::addDockWidgetAsTab	(	QQuickItem *	other,
		KDDockWidgets::InitialVisibilityOption	option = {}
	)

Definition at line 137 of file DockWidgetInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem().

addDockWidgetToContainingWindow()

void DockWidgetInstantiator::addDockWidgetToContainingWindow	(	QQuickItem *	other,
		KDDockWidgets::Location	location,
		QQuickItem *	relativeTo = nullptr,
		QSize	initialSize = {},
		KDDockWidgets::InitialVisibilityOption	option = {}
	)

Definition at line 146 of file DockWidgetInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem().

affinities()

QVector< QString > DockWidgetInstantiator::affinities

(

)

const

Definition at line 216 of file DockWidgetInstantiator.cpp.

affinitiesChanged

void KDDockWidgets::DockWidgetInstantiator::affinitiesChanged ( )

signal

Referenced by setAffinities().

classBegin()

void DockWidgetInstantiator::classBegin ( )

overrideprotected

Definition at line 211 of file DockWidgetInstantiator.cpp.

close()

Q_INVOKABLE bool DockWidgetInstantiator::close

(

)

Definition at line 173 of file DockWidgetInstantiator.cpp.

closed

void KDDockWidgets::DockWidgetInstantiator::closed ( )

signal

Referenced by componentComplete().

componentComplete()

void DockWidgetInstantiator::componentComplete ( )

overrideprotected

Definition at line 229 of file DockWidgetInstantiator.cpp.

References actualTitleBarChanged(), KDDockWidgets::Core::View::asDockWidgetController(), KDDockWidgets::QtQuick::asQQuickItem(), closed(), KDDockWidgets::QtQuick::ViewFactory::createDockWidget(), dockWidget, dockWidgetChanged(), guestViewChanged(), iconChanged(), isFloatingChanged(), isFocusedChanged(), isOpenChanged(), isOverlayedChanged(), optionsChanged(), removedFromSideBar(), KDDockWidgets::DockRegistry::self(), KDDockWidgets::QtQuick::ViewFactory::self(), title, titleChanged(), and windowActiveAboutToChange().

controller()

KDDockWidgets::Core::DockWidget * DockWidgetInstantiator::controller

(

)

const

Definition at line 89 of file DockWidgetInstantiator.cpp.

deleteDockWidget()

void DockWidgetInstantiator::deleteDockWidget

(

)

Deletes the dock widget

Deleting involves deleting the controller (Core::DockWidget), the view (View::DockWidget) and this instantiator itself as well.

It's more usual to just hide dock widgets though.

Definition at line 205 of file DockWidgetInstantiator.cpp.

dockWidget()

QtQuick::DockWidget * DockWidgetInstantiator::dockWidget

(

)

const

Definition at line 80 of file DockWidgetInstantiator.cpp.

dockWidgetChanged

void KDDockWidgets::DockWidgetInstantiator::dockWidgetChanged ( )

signal

Referenced by componentComplete().

forceClose()

void DockWidgetInstantiator::forceClose

(

)

Definition at line 167 of file DockWidgetInstantiator.cpp.

guestViewChanged

void KDDockWidgets::DockWidgetInstantiator::guestViewChanged ( QQuickItem *  )

signal

Referenced by componentComplete().

iconChanged

void KDDockWidgets::DockWidgetInstantiator::iconChanged ( )

signal

Referenced by componentComplete().

isFloating()

bool DockWidgetInstantiator::isFloating

(

)

const

Definition at line 120 of file DockWidgetInstantiator.cpp.

isFloatingChanged

void KDDockWidgets::DockWidgetInstantiator::isFloatingChanged ( bool  )

signal

Referenced by componentComplete().

isFocused()

bool DockWidgetInstantiator::isFocused

(

)

const

Definition at line 115 of file DockWidgetInstantiator.cpp.

isFocusedChanged

void KDDockWidgets::DockWidgetInstantiator::isFocusedChanged ( bool  )

signal

Referenced by componentComplete().

isOpen()

bool DockWidgetInstantiator::isOpen

(

)

const

Definition at line 125 of file DockWidgetInstantiator.cpp.

isOpenChanged

void KDDockWidgets::DockWidgetInstantiator::isOpenChanged ( bool  )

signal

Referenced by componentComplete().

isOverlayedChanged

void KDDockWidgets::DockWidgetInstantiator::isOverlayedChanged ( bool  )

signal

Referenced by componentComplete().

moveToSideBar()

void DockWidgetInstantiator::moveToSideBar

(

)

Definition at line 199 of file DockWidgetInstantiator.cpp.

open()

void DockWidgetInstantiator::open

(

)

Definition at line 181 of file DockWidgetInstantiator.cpp.

Referenced by show().

optionsChanged

void KDDockWidgets::DockWidgetInstantiator::optionsChanged ( KDDockWidgets::DockWidgetOptions  )

signal

Referenced by componentComplete().

raise()

void DockWidgetInstantiator::raise

(

)

Definition at line 193 of file DockWidgetInstantiator.cpp.

removedFromSideBar

void KDDockWidgets::DockWidgetInstantiator::removedFromSideBar ( )

signal

Referenced by componentComplete().

setAffinities()

void DockWidgetInstantiator::setAffinities

(

const QVector< QString > &

affinities

)

Definition at line 221 of file DockWidgetInstantiator.cpp.

References affinities, and affinitiesChanged().

setAsCurrentTab()

void DockWidgetInstantiator::setAsCurrentTab

(

)

Definition at line 161 of file DockWidgetInstantiator.cpp.

setFloating()

void DockWidgetInstantiator::setFloating

(

bool

is

)

Definition at line 130 of file DockWidgetInstantiator.cpp.

setSource()

void DockWidgetInstantiator::setSource

(

const QString &

source

)

Definition at line 74 of file DockWidgetInstantiator.cpp.

References source, and sourceChanged().

setTitle()

void DockWidgetInstantiator::setTitle

(

const QString &

title

)

Definition at line 108 of file DockWidgetInstantiator.cpp.

References title.

setUniqueName()

void DockWidgetInstantiator::setUniqueName

(

const QString &

name

)

Definition at line 63 of file DockWidgetInstantiator.cpp.

References uniqueNameChanged().

show()

void DockWidgetInstantiator::show

(

)

Definition at line 187 of file DockWidgetInstantiator.cpp.

References open().

source()

QString DockWidgetInstantiator::source

(

)

const

Definition at line 69 of file DockWidgetInstantiator.cpp.

sourceChanged

void KDDockWidgets::DockWidgetInstantiator::sourceChanged ( )

signal

Referenced by setSource().

title()

QString DockWidgetInstantiator::title

(

)

const

Definition at line 103 of file DockWidgetInstantiator.cpp.

titleChanged

void KDDockWidgets::DockWidgetInstantiator::titleChanged ( const QString &  title )

signal

Referenced by componentComplete().

uniqueName()

QString DockWidgetInstantiator::uniqueName

(

)

const

Definition at line 58 of file DockWidgetInstantiator.cpp.

uniqueNameChanged

void KDDockWidgets::DockWidgetInstantiator::uniqueNameChanged ( )

signal

Referenced by setUniqueName().

windowActiveAboutToChange

void KDDockWidgets::DockWidgetInstantiator::windowActiveAboutToChange ( bool  activated )

signal

Referenced by componentComplete().

Property Documentation

actualTitleBar

QObject * KDDockWidgets::DockWidgetInstantiator::actualTitleBar

read

Definition at line 42 of file DockWidgetInstantiator.h.

affinities

QVector<QString> KDDockWidgets::DockWidgetInstantiator::affinities

readwrite

Definition at line 47 of file DockWidgetInstantiator.h.

Referenced by setAffinities().

dockWidget

KDDockWidgets::QtQuick::DockWidget * KDDockWidgets::DockWidgetInstantiator::dockWidget

read

Definition at line 40 of file DockWidgetInstantiator.h.

Referenced by actualTitleBar(), and componentComplete().

isFloating

bool KDDockWidgets::DockWidgetInstantiator::isFloating

readwrite

Definition at line 45 of file DockWidgetInstantiator.h.

isFocused

bool KDDockWidgets::DockWidgetInstantiator::isFocused

read

Definition at line 44 of file DockWidgetInstantiator.h.

isOpen

bool KDDockWidgets::DockWidgetInstantiator::isOpen

read

Definition at line 46 of file DockWidgetInstantiator.h.

source

QString KDDockWidgets::DockWidgetInstantiator::source

readwrite

Definition at line 39 of file DockWidgetInstantiator.h.

Referenced by setSource().

title

QString KDDockWidgets::DockWidgetInstantiator::title

readwrite

Definition at line 43 of file DockWidgetInstantiator.h.

Referenced by componentComplete(), and setTitle().

uniqueName

QString KDDockWidgets::DockWidgetInstantiator::uniqueName

readwrite

Definition at line 38 of file DockWidgetInstantiator.h.

---

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

• DockWidgetInstantiator.h
• DockWidgetInstantiator.cpp