The default ViewFactory for QtQuick frontend. More...

#include <ViewFactory.h>

Inheritance diagram for KDDockWidgets::QtQuick::ViewFactory:

[legend]

Collaboration diagram for KDDockWidgets::QtQuick::ViewFactory:

[legend]

Public Member Functions
	ViewFactory ()=default

	~ViewFactory () override
	Destructor. Don't delete ViewFactory directly, it's owned by the framework.

KDDockWidgets::Core::Action *	createAction (Core::DockWidget , const char debugName) const override
	Creates a QAction if QtWidgets, or an equivalent fallback if QtQuick/Flutter Not needed to be overridden by users.

Core::ClassicIndicatorWindowViewInterface *	createClassicIndicatorWindow (Core::ClassicDropIndicatorOverlay , Core::View parent=nullptr) const override
	Creates the window that will show the actual drop indicators. They need a higher z-order, so this is actually a separate window, not parented to the main window.

Core::View *	createDockWidget (const QString &uniqueName, DockWidgetOptions options={}, LayoutSaverOptions layoutSaverOptions={}, Qt::WindowFlags windowFlags={}) const override
	Creates a dock widget. This is only used by MainWindow's persistent widget feature. In all other cases users will instantiate DockWidget directly.

virtual Core::View *	createDockWidget (const QString &uniqueName, QQmlEngine *, DockWidgetOptions options={}, LayoutSaverOptions layoutSaverOptions={}, Qt::WindowFlags windowFlags={}) const

Core::View *	createDropArea (Core::DropArea , Core::View parent) const override
	Called by the framework to create a DropArea view.

Core::View *	createFloatingWindow (Core::FloatingWindow , Core::MainWindow parent=nullptr, Qt::WindowFlags windowFlags={}) const override
	Called by the framework to create a FloatingWindow view Override to provide your own FloatingWindow sub-class.

Core::View *	createGroup (Core::Group , Core::View parent) const override
	Called by the framework to create a Frame view Override to provide your own Frame sub-class. A group is the widget that holds the titlebar and tab-widget which holds the DockWidgets.

Core::View *	createMDILayout (Core::MDILayout , Core::View parent) const override
	Called by the framework to create a MDI Layout view.

Core::View *	createRubberBand (Core::View *parent) const override
	Called by the framework to create a RubberBand view to show as drop zone.

Core::View *	createSegmentedDropIndicatorOverlayView (Core::SegmentedDropIndicatorOverlay controller, Core::View parent) const override
	Creates the view that will parent the segmented drop indicators.

Core::View *	createSeparator (Core::Separator , Core::View parent=nullptr) const override
	Called by the framework to create a Separator view Override to provide your own Separator sub-class. The Separator allows the user to resize nested dock widgets.

Core::View *	createSideBar (Core::SideBar , Core::View parent) const override
	Called by the framework to create a SideBar view.

Core::View *	createStack (Core::Stack , Core::View parent) const override
	Called by the framework to create a Stack view Override to provide your own Stack sub-class.

Core::View *	createTabBar (Core::TabBar tabBar, Core::View parent) const override
	Called by the framework to create a TabBar view Override to provide your own TabBar sub-class.

Core::View *	createTitleBar (Core::TitleBar , Core::View parent) const override
	Called by the framework to create a TitleBar view Override to provide your own TitleBar sub-class. Just forward the `controller` and `parent` arguments to the TitleBar view ctor.

virtual QUrl	dockwidgetFilename () const
	Called by C++.

virtual QUrl	floatingWindowFilename () const

virtual QUrl	groupFilename () const

QIcon	iconForButtonType (TitleBarButtonType type, qreal dpr) const override

virtual QUrl	separatorFilename () const

virtual Q_INVOKABLE QUrl	tabbarFilename () const

virtual Q_INVOKABLE QUrl	titleBarFilename () const
	Called by QML.

Public Member Functions inherited from KDDockWidgets::Core::ViewFactory
	ViewFactory ()=default

virtual QString	classicIndicatorsPath () const
	The path to a folder containing the classic_indicator png files.

virtual Icon	iconForButtonType (TitleBarButtonType type, double dpr) const =0
	Returns the icon to be used with the specified `type`.

Static Public Member Functions
static ViewFactory *	self ()

Additional Inherited Members
Static Public Attributes inherited from KDDockWidgets::Core::ViewFactory
static DropIndicatorType	s_dropIndicatorType = DropIndicatorType::Classic
	@ The drop indicator type

Detailed Description

The default ViewFactory for QtQuick frontend.

Definition at line 49 of file qtquick/ViewFactory.h.

Constructor & Destructor Documentation

◆ ViewFactory()

KDDockWidgets::QtQuick::ViewFactory::ViewFactory ( )

default

◆ ~ViewFactory()

ViewFactory::~ViewFactory ( )

overridevirtual

Destructor. Don't delete ViewFactory directly, it's owned by the framework.

Reimplemented from KDDockWidgets::Core::ViewFactory.

Definition at line 49 of file qtquick/ViewFactory.cpp.

Member Function Documentation

◆ createAction()

KDDockWidgets::Core::Action * ViewFactory::createAction	(	Core::DockWidget *	,
		const char *	debugName
	)		const

overridevirtual

Creates a QAction if QtWidgets, or an equivalent fallback if QtQuick/Flutter Not needed to be overridden by users.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 230 of file qtquick/ViewFactory.cpp.

◆ createClassicIndicatorWindow()

Core::ClassicIndicatorWindowViewInterface * ViewFactory::createClassicIndicatorWindow	(	Core::ClassicDropIndicatorOverlay *	,
		Core::View *	parent = `nullptr`
	)		const

overridevirtual

Creates the window that will show the actual drop indicators. They need a higher z-order, so this is actually a separate window, not parented to the main window.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 213 of file qtquick/ViewFactory.cpp.

◆ createDockWidget() [1/2]

Core::View * ViewFactory::createDockWidget	(	const QString &	uniqueName,
		DockWidgetOptions	options = `{}`,
		LayoutSaverOptions	layoutSaverOptions = `{}`,
		Qt::WindowFlags	windowFlags = `{}`
	)		const

overridevirtual

Creates a dock widget. This is only used by MainWindow's persistent widget feature. In all other cases users will instantiate DockWidget directly.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 53 of file qtquick/ViewFactory.cpp.

References createDockWidget().

Referenced by KDDockWidgets::DockWidgetInstantiator::componentComplete(), and createDockWidget().

◆ createDockWidget() [2/2]

Core::View * ViewFactory::createDockWidget	(	const QString &	uniqueName,
		QQmlEngine *	qmlEngine,
		DockWidgetOptions	options = `{}`,
		LayoutSaverOptions	layoutSaverOptions = `{}`,
		Qt::WindowFlags	windowFlags = `{}`
	)		const

virtual

Definition at line 61 of file qtquick/ViewFactory.cpp.

◆ createDropArea()

Core::View * ViewFactory::createDropArea	(	Core::DropArea *	,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a DropArea view.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 166 of file qtquick/ViewFactory.cpp.

◆ createFloatingWindow()

Core::View * ViewFactory::createFloatingWindow	(	Core::FloatingWindow *	controller,
		Core::MainWindow *	parent = `nullptr`,
		Qt::WindowFlags	windowFlags = `{}`
	)		const

overridevirtual

Called by the framework to create a FloatingWindow view Override to provide your own FloatingWindow sub-class.

Parameters

parent Just forward to FloatingWindow's constructor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 96 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem(), and KDDockWidgets::Core::Controller::view().

◆ createGroup()

Core::View * ViewFactory::createGroup	(	Core::Group *	,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a Frame view Override to provide your own Frame sub-class. A group is the widget that holds the titlebar and tab-widget which holds the DockWidgets.

Parameters

parent just forward to Frame's constructor

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 70 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem().

◆ createMDILayout()

Core::View * ViewFactory::createMDILayout	(	Core::MDILayout *	,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a MDI Layout view.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 171 of file qtquick/ViewFactory.cpp.

◆ createRubberBand()

Core::View * ViewFactory::createRubberBand ( Core::View * parent ) const

overridevirtual

Called by the framework to create a RubberBand view to show as drop zone.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 107 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem().

◆ createSegmentedDropIndicatorOverlayView()

Core::View * ViewFactory::createSegmentedDropIndicatorOverlayView	(	Core::SegmentedDropIndicatorOverlay *	controller,
		Core::View *	parent
	)		const

overridevirtual

Creates the view that will parent the segmented drop indicators.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 207 of file qtquick/ViewFactory.cpp.

◆ createSeparator()

Core::View * ViewFactory::createSeparator	(	Core::Separator *	,
		Core::View *	parent = `nullptr`
	)		const

overridevirtual

Called by the framework to create a Separator view Override to provide your own Separator sub-class. The Separator allows the user to resize nested dock widgets.

Parameters

parent Just forward to Separator's constructor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 90 of file qtquick/ViewFactory.cpp.

◆ createSideBar()

Core::View * ViewFactory::createSideBar	(	Core::SideBar *	,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a SideBar view.

Parameters

loc	The side-bar location without the main window. Just forward into your SideBar sub-class ctor.
parent	The MainWindow. Just forward into your SideBar sub-class ctor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 112 of file qtquick/ViewFactory.cpp.

◆ createStack()

Core::View * ViewFactory::createStack	(	Core::Stack *	stack,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a Stack view Override to provide your own Stack sub-class.

Parameters

parent Just forward to Stack's constructor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 85 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem().

◆ createTabBar()

Core::View * ViewFactory::createTabBar	(	Core::TabBar *	tabBar,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a TabBar view Override to provide your own TabBar sub-class.

Parameters

parent Just forward to TabBar's's constructor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 80 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem().

◆ createTitleBar()

Core::View * ViewFactory::createTitleBar	(	Core::TitleBar *	controller,
		Core::View *	parent
	)		const

overridevirtual

Called by the framework to create a TitleBar view Override to provide your own TitleBar sub-class. Just forward the controller and parent arguments to the TitleBar view ctor.

Implements KDDockWidgets::Core::ViewFactory.

Definition at line 75 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::QtQuick::asQQuickItem().

◆ dockwidgetFilename()

QUrl ViewFactory::dockwidgetFilename ( ) const

virtual

Called by C++.

Definition at line 181 of file qtquick/ViewFactory.cpp.

◆ floatingWindowFilename()

QUrl ViewFactory::floatingWindowFilename ( ) const

virtual

Definition at line 191 of file qtquick/ViewFactory.cpp.

◆ groupFilename()

QUrl ViewFactory::groupFilename ( ) const

virtual

Definition at line 186 of file qtquick/ViewFactory.cpp.

◆ iconForButtonType()

QIcon ViewFactory::iconForButtonType	(	TitleBarButtonType	type,
		qreal	dpr
	)		const

override

Definition at line 118 of file qtquick/ViewFactory.cpp.

References QIcon::addFile(), KDDockWidgets::AllTitleBarButtonTypes, KDDockWidgets::AutoHide, KDDockWidgets::Close, KDDockWidgets::Float, KDDockWidgets::iconName(), QString::isEmpty(), KDDockWidgets::Maximize, KDDockWidgets::Minimize, KDDockWidgets::Normal, and KDDockWidgets::UnautoHide.

◆ self()

ViewFactory * ViewFactory::self ( )

static

Definition at line 219 of file qtquick/ViewFactory.cpp.

References KDDockWidgets::Config::self(), and KDDockWidgets::Config::viewFactory().

Referenced by KDDockWidgets::DockWidgetInstantiator::componentComplete().

◆ separatorFilename()

QUrl ViewFactory::separatorFilename ( ) const

virtual

Definition at line 201 of file qtquick/ViewFactory.cpp.

◆ tabbarFilename()

QUrl ViewFactory::tabbarFilename ( ) const

virtual

Definition at line 196 of file qtquick/ViewFactory.cpp.

◆ titleBarFilename()

QUrl ViewFactory::titleBarFilename ( ) const

virtual

Called by QML.

Definition at line 176 of file qtquick/ViewFactory.cpp.

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ViewFactory()

◆ ~ViewFactory()

Member Function Documentation

◆ createAction()

◆ createClassicIndicatorWindow()

◆ createDockWidget() [1/2]

◆ createDockWidget() [2/2]

◆ createDropArea()

◆ createFloatingWindow()

◆ createGroup()

◆ createMDILayout()

◆ createRubberBand()

◆ createSegmentedDropIndicatorOverlayView()

◆ createSeparator()

◆ createSideBar()

◆ createStack()

◆ createTabBar()

◆ createTitleBar()

◆ dockwidgetFilename()

◆ floatingWindowFilename()

◆ groupFilename()

◆ iconForButtonType()

◆ self()

◆ separatorFilename()

◆ tabbarFilename()

◆ titleBarFilename()