KDDockWidgets::MainWindowInstantiator Class Reference

A wrapper to workaround the limitation that QtQuick can't pass arguments through MainWindow's ctor So instead, user instantiates a MainWindowWrapper in QML and calls init. More...

#include <MainWindowInstantiator.h>

Inheritance diagram for KDDockWidgets::MainWindowInstantiator:

Collaboration diagram for KDDockWidgets::MainWindowInstantiator:

Signals
void	optionsChanged ()
void	uniqueNameChanged ()

Public Member Functions
	MainWindowInstantiator ()
	ctor, called by QML engine
Q_INVOKABLE void	addDockWidget (QQuickItem *dockWidget, KDDockWidgets::Location location, QQuickItem *relativeTo=nullptr, QSize initialSize={}, KDDockWidgets::InitialVisibilityOption={})
	See KDDockWidgets::Core::MainWindow::addDockWidget()
Q_INVOKABLE void	addDockWidgetAsTab (QQuickItem *dockWidget)
	See KDDockWidgets::Core::MainWindow::addDockWidgetAsTab()
QVector< QString >	affinities () const
Q_INVOKABLE void	clearSideBarOverlay (bool deleteFrame=true)
Q_INVOKABLE bool	closeDockWidgets (bool force=false)
bool	isMDI () const
Q_INVOKABLE void	layoutEqually ()
Q_INVOKABLE void	layoutParentContainerEqually (QQuickItem *dockWidget)
Q_INVOKABLE void	moveToSideBar (QQuickItem *)
Q_INVOKABLE void	moveToSideBar (QQuickItem *, KDDockWidgets::SideBarLocation)
KDDockWidgets::MainWindowOptions	options () const
Q_INVOKABLE void	overlayOnSideBar (QQuickItem *)
Q_INVOKABLE void	restoreFromSideBar (QQuickItem *)
void	setOptions (KDDockWidgets::MainWindowOptions)
void	setUniqueName (const QString &)
Q_INVOKABLE bool	sideBarIsVisible (KDDockWidgets::SideBarLocation) const
Q_INVOKABLE void	toggleOverlayOnSideBar (QQuickItem *)
QString	uniqueName () const

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

Properties
QVector< QString >	affinities
bool	isMDI
KDDockWidgets::MainWindowOptions	options
QString	uniqueName

Detailed Description

A wrapper to workaround the limitation that QtQuick can't pass arguments through MainWindow's ctor So instead, user instantiates a MainWindowWrapper in QML and calls init.

Definition at line 30 of file MainWindowInstantiator.h.

Constructor & Destructor Documentation

MainWindowInstantiator()

MainWindowInstantiator::MainWindowInstantiator

(

)

ctor, called by QML engine

Definition at line 26 of file MainWindowInstantiator.cpp.

Member Function Documentation

addDockWidget()

void MainWindowInstantiator::addDockWidget	(	QQuickItem *	dockWidget,
		KDDockWidgets::Location	location,
		QQuickItem *	relativeTo = nullptr,
		QSize	initialSize = {},
		KDDockWidgets::InitialVisibilityOption	option = {}
	)

See KDDockWidgets::Core::MainWindow::addDockWidget()

Definition at line 66 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidget(), and KDDockWidgets::QtQuick::Platform::dockWidgetForItem().

addDockWidgetAsTab()

void MainWindowInstantiator::addDockWidgetAsTab

(

QQuickItem *

dockWidget

)

See KDDockWidgets::Core::MainWindow::addDockWidgetAsTab()

Definition at line 86 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidgetAsTab(), and KDDockWidgets::QtQuick::Platform::dockWidgetForItem().

affinities()

QVector< QString > MainWindowInstantiator::affinities

(

)

const

Definition at line 56 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::affinities().

classBegin()

void MainWindowInstantiator::classBegin ( )

overrideprotected

Definition at line 176 of file MainWindowInstantiator.cpp.

clearSideBarOverlay()

void MainWindowInstantiator::clearSideBarOverlay

(

bool

deleteFrame = true

)

Definition at line 155 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::clearSideBarOverlay().

closeDockWidgets()

bool MainWindowInstantiator::closeDockWidgets

(

bool

force = false

)

Definition at line 171 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::closeDockWidgets().

componentComplete()

void MainWindowInstantiator::componentComplete ( )

overrideprotected

Definition at line 181 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::View::asMainWindowController(), QString::isEmpty(), KDDockWidgets::MainWindowOption_MDI, and KDDockWidgets::DockRegistry::self().

isMDI()

bool MainWindowInstantiator::isMDI

(

)

const

Definition at line 61 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::isMDI().

layoutEqually()

void MainWindowInstantiator::layoutEqually

(

)

Definition at line 95 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::layoutEqually().

layoutParentContainerEqually()

void MainWindowInstantiator::layoutParentContainerEqually

(

QQuickItem *

dockWidget

)

Definition at line 101 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::layoutParentContainerEqually().

moveToSideBar() [1/2]

void MainWindowInstantiator::moveToSideBar

(

QQuickItem *

dockWidget

)

Definition at line 110 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::moveToSideBar().

moveToSideBar() [2/2]

void MainWindowInstantiator::moveToSideBar	(	QQuickItem *	dockWidget,
		KDDockWidgets::SideBarLocation	loc
	)

Definition at line 119 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::moveToSideBar().

options()

MainWindowOptions MainWindowInstantiator::options

(

)

const

Definition at line 43 of file MainWindowInstantiator.cpp.

optionsChanged

void KDDockWidgets::MainWindowInstantiator::optionsChanged ( )

signal

Referenced by setOptions().

overlayOnSideBar()

void MainWindowInstantiator::overlayOnSideBar

(

QQuickItem *

dockWidget

)

Definition at line 137 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::overlayOnSideBar().

restoreFromSideBar()

void MainWindowInstantiator::restoreFromSideBar

(

QQuickItem *

dockWidget

)

Definition at line 128 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::restoreFromSideBar().

setOptions()

void MainWindowInstantiator::setOptions

(

KDDockWidgets::MainWindowOptions

)

Definition at line 48 of file MainWindowInstantiator.cpp.

References options, and optionsChanged().

setUniqueName()

void MainWindowInstantiator::setUniqueName

(

const QString &

name

)

Definition at line 35 of file MainWindowInstantiator.cpp.

References uniqueNameChanged().

sideBarIsVisible()

bool MainWindowInstantiator::sideBarIsVisible

(

KDDockWidgets::SideBarLocation

loc

)

const

Definition at line 166 of file MainWindowInstantiator.cpp.

References KDDockWidgets::Core::MainWindow::sideBarIsVisible().

toggleOverlayOnSideBar()

void MainWindowInstantiator::toggleOverlayOnSideBar

(

QQuickItem *

dockWidget

)

Definition at line 146 of file MainWindowInstantiator.cpp.

References KDDockWidgets::QtQuick::Platform::dockWidgetForItem(), and KDDockWidgets::Core::MainWindow::toggleOverlayOnSideBar().

uniqueName()

QString MainWindowInstantiator::uniqueName

(

)

const

Definition at line 30 of file MainWindowInstantiator.cpp.

uniqueNameChanged

void KDDockWidgets::MainWindowInstantiator::uniqueNameChanged ( )

signal

Referenced by setUniqueName().

Property Documentation

affinities

QVector<QString> KDDockWidgets::MainWindowInstantiator::affinities

read

Definition at line 37 of file MainWindowInstantiator.h.

isMDI

bool KDDockWidgets::MainWindowInstantiator::isMDI

read

Definition at line 36 of file MainWindowInstantiator.h.

options

KDDockWidgets::MainWindowOptions KDDockWidgets::MainWindowInstantiator::options

readwrite

Definition at line 34 of file MainWindowInstantiator.h.

Referenced by setOptions().

uniqueName

QString KDDockWidgets::MainWindowInstantiator::uniqueName

readwrite

Definition at line 33 of file MainWindowInstantiator.h.

---

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

• MainWindowInstantiator.h
• MainWindowInstantiator.cpp