A factory class for allowing the user to customize some internal widgets. This is optional, and if not provided, a default one will be used, DefaultWidgetFactory. More...

#include <FrameworkWidgetFactory.h>

Inheritance diagram for KDDockWidgets::FrameworkWidgetFactory:

[legend]

Collaboration diagram for KDDockWidgets::FrameworkWidgetFactory:

[legend]

Public Member Functions
	FrameworkWidgetFactory ()=default

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

virtual DropIndicatorOverlayInterface *	createDropIndicatorOverlay (DropArea *dropArea) const =0
	Called internally by the framework to create a DropIndicatorOverlayInterface Override to provide your own DropIndicatorOverlayInterface sub-class.

virtual FloatingWindow *	createFloatingWindow (Frame frame, MainWindowBase parent=nullptr, QRect suggestedGeometry={}) const =0
	Called internally by the framework to create a FloatingWindow Override to provide your own FloatingWindow sub-class. If overridden then you also need to override the overloads above.

virtual FloatingWindow *	createFloatingWindow (MainWindowBase *parent=nullptr, FloatingWindowFlags=FloatingWindowFlag::FromGlobalConfig) const =0
	Called internally by the framework to create a FloatingWindow Override to provide your own FloatingWindow sub-class. If overridden then you also need to override the overloads below.

virtual Frame *	createFrame (QWidgetOrQuick *parent=nullptr, FrameOptions options=FrameOption_None) const =0
	Called internally by the framework to create a Frame class Override to provide your own Frame sub-class. A frame is the widget that holds the titlebar and tab-widget which holds the DockWidgets.

virtual QWidgetOrQuick *	createRubberBand (QWidgetOrQuick *parent) const =0
	Called internally by the framework to create a RubberBand to show as drop zone Returns a rubber band.

virtual Layouting::Separator *	createSeparator (Layouting::Widget *parent=nullptr) const =0
	Called internally by the framework to create a Separator Override to provide your own Separator sub-class. The Separator allows the user to resize nested dock widgets.

virtual SideBar *	createSideBar (SideBarLocation loc, MainWindowBase *parent) const =0
	Called internally by the framework to create a SideBar.

virtual TabBar *	createTabBar (TabWidget *parent=nullptr) const =0
	Called internally by the framework to create a TabBar Override to provide your own TabBar sub-class.

virtual TabWidget *	createTabWidget (Frame *parent, TabWidgetOptions options=TabWidgetOption_None) const =0
	Called internally by the framework to create a TabWidget Override to provide your own TabWidget sub-class.

virtual TitleBar *	createTitleBar (FloatingWindow *floatingWindow) const =0
	Called internally by the framework to create a TitleBar Override to provide your own TitleBar sub-class. If overridden then you also need to override the overload above.

virtual TitleBar *	createTitleBar (Frame *frame) const =0
	Called internally by the framework to create a TitleBar Override to provide your own TitleBar sub-class. If overridden then you also need to override the overload below.

virtual QAbstractButton *	createTitleBarButton (QWidget *parent, TitleBarButtonType) const =0
	Called internally by the framework to create a title bar button `parent` the button's parent.

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual	~QObject ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

A factory class for allowing the user to customize some internal widgets. This is optional, and if not provided, a default one will be used, DefaultWidgetFactory.

Deriving from DefaultWidgetFactory is recommended, unless you need to override all methods.

Sub-classing FrameworkWidgetFactory allows for fine-grained customization and styling of some non-public widgets, such as titlebars, dock widget frame and tab widgets.

To set your own factory see Config::setFrameworkWidgetFactory()

Will also be useful to provide a QtQuickWidget factory in the future.

See also: Config::setFrameworkWidgetFactory()

Definition at line 71 of file FrameworkWidgetFactory.h.

Constructor & Destructor Documentation

◆ FrameworkWidgetFactory()

KDDockWidgets::FrameworkWidgetFactory::FrameworkWidgetFactory ( )

default

◆ ~FrameworkWidgetFactory()

FrameworkWidgetFactory::~FrameworkWidgetFactory ( )

virtual

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

Definition at line 53 of file FrameworkWidgetFactory.cpp.

Member Function Documentation

◆ createDropIndicatorOverlay()

virtual DropIndicatorOverlayInterface * KDDockWidgets::FrameworkWidgetFactory::createDropIndicatorOverlay ( DropArea * dropArea ) const

pure virtual

Called internally by the framework to create a DropIndicatorOverlayInterface Override to provide your own DropIndicatorOverlayInterface sub-class.

Parameters

dropArea Just forward to DropIndicatorOverlayInterface's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createFloatingWindow() [1/2]

virtual FloatingWindow * KDDockWidgets::FrameworkWidgetFactory::createFloatingWindow	(	Frame *	frame,
		MainWindowBase *	parent = `nullptr`,
		QRect	suggestedGeometry = `{}`
	)		const

pure virtual

Called internally by the framework to create a FloatingWindow Override to provide your own FloatingWindow sub-class. If overridden then you also need to override the overloads above.

Parameters

frame	Just forward to FloatingWindow's constructor.
parent	Just forward to FloatingWindow's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createFloatingWindow() [2/2]

virtual FloatingWindow * KDDockWidgets::FrameworkWidgetFactory::createFloatingWindow	(	MainWindowBase *	parent = `nullptr`,
		FloatingWindowFlags	= `FloatingWindowFlag::FromGlobalConfig`
	)		const

pure virtual

Called internally by the framework to create a FloatingWindow Override to provide your own FloatingWindow sub-class. If overridden then you also need to override the overloads below.

Parameters

parent Just forward to FloatingWindow's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

Referenced by KDDockWidgets::LayoutSaver::restoreLayout().

◆ createFrame()

virtual Frame * KDDockWidgets::FrameworkWidgetFactory::createFrame	(	QWidgetOrQuick *	parent = `nullptr`,
		FrameOptions	options = `FrameOption_None`
	)		const

pure virtual

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

Parameters

parent	just forward to Frame's constructor
options	just forward to Frame's constructor

Implemented in KDDockWidgets::DefaultWidgetFactory.

Referenced by KDDockWidgets::MainWindowBase::overlayOnSideBar().

◆ createRubberBand()

virtual QWidgetOrQuick * KDDockWidgets::FrameworkWidgetFactory::createRubberBand ( QWidgetOrQuick * parent ) const

pure virtual

Called internally by the framework to create a RubberBand to show as drop zone Returns a rubber band.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createSeparator()

virtual Layouting::Separator * KDDockWidgets::FrameworkWidgetFactory::createSeparator ( Layouting::Widget * parent = nullptr ) const

pure virtual

Called internally by the framework to create a Separator 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.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createSideBar()

virtual SideBar * KDDockWidgets::FrameworkWidgetFactory::createSideBar	(	SideBarLocation	loc,
		MainWindowBase *	parent
	)		const

pure virtual

Called internally by the framework to create a SideBar.

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.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createTabBar()

virtual TabBar * KDDockWidgets::FrameworkWidgetFactory::createTabBar ( TabWidget * parent = nullptr ) const

pure virtual

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

Parameters

parent Just forward to TabBar's's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createTabWidget()

virtual TabWidget * KDDockWidgets::FrameworkWidgetFactory::createTabWidget	(	Frame *	parent,
		TabWidgetOptions	options = `TabWidgetOption_None`
	)		const

pure virtual

Called internally by the framework to create a TabWidget Override to provide your own TabWidget sub-class.

Parameters

parent Just forward to TabWidget's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createTitleBar() [1/2]

virtual TitleBar * KDDockWidgets::FrameworkWidgetFactory::createTitleBar ( FloatingWindow * floatingWindow ) const

pure virtual

Called internally by the framework to create a TitleBar Override to provide your own TitleBar sub-class. If overridden then you also need to override the overload above.

Parameters

floatingWindow Just forward to TitleBar's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createTitleBar() [2/2]

virtual TitleBar * KDDockWidgets::FrameworkWidgetFactory::createTitleBar ( Frame * frame ) const

pure virtual

Called internally by the framework to create a TitleBar Override to provide your own TitleBar sub-class. If overridden then you also need to override the overload below.

Parameters

frame Just forward to TitleBar's constructor.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ createTitleBarButton()

virtual QAbstractButton * KDDockWidgets::FrameworkWidgetFactory::createTitleBarButton	(	QWidget *	parent,
		TitleBarButtonType
	)		const

pure virtual

Called internally by the framework to create a title bar button parent the button's parent.

Implemented in KDDockWidgets::DefaultWidgetFactory.

◆ iconForButtonType()

virtual QIcon KDDockWidgets::FrameworkWidgetFactory::iconForButtonType	(	TitleBarButtonType	type,
		qreal	dpr
	)		const

pure virtual

Returns the icon to be used with the specified type.

Parameters

dpr	the device pixel ratio of the button

Implemented in KDDockWidgets::DefaultWidgetFactory.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FrameworkWidgetFactory()

◆ ~FrameworkWidgetFactory()

Member Function Documentation

◆ createDropIndicatorOverlay()

◆ createFloatingWindow() [1/2]

◆ createFloatingWindow() [2/2]

◆ createFrame()

◆ createRubberBand()

◆ createSeparator()

◆ createSideBar()

◆ createTabBar()

◆ createTabWidget()

◆ createTitleBar() [1/2]

◆ createTitleBar() [2/2]

◆ createTitleBarButton()

◆ iconForButtonType()