KDDockWidgets::DefaultWidgetFactory Class Reference

The FrameworkWidgetFactory that's used if none is specified. More...

#include <FrameworkWidgetFactory.h>

Inheritance diagram for KDDockWidgets::DefaultWidgetFactory:

Collaboration diagram for KDDockWidgets::DefaultWidgetFactory:

Public Member Functions
	DefaultWidgetFactory ()=default
void	clearIconCache ()
DropIndicatorOverlayInterface *	createDropIndicatorOverlay (DropArea *) const override
	Called internally by the framework to create a DropIndicatorOverlayInterface Override to provide your own DropIndicatorOverlayInterface sub-class.
FloatingWindow *	createFloatingWindow (Frame *frame, MainWindowBase *parent=nullptr, QRect suggestedGeometry={}) const override
	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.
FloatingWindow *	createFloatingWindow (MainWindowBase *parent=nullptr, FloatingWindowFlags=FloatingWindowFlag::FromGlobalConfig) const override
	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.
Frame *	createFrame (QWidgetOrQuick *parent, FrameOptions) const override
	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.
QWidgetOrQuick *	createRubberBand (QWidgetOrQuick *parent) const override
	Called internally by the framework to create a RubberBand to show as drop zone Returns a rubber band.
Layouting::Separator *	createSeparator (Layouting::Widget *parent=nullptr) const override
	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.
SideBar *	createSideBar (SideBarLocation loc, MainWindowBase *parent) const override
	Called internally by the framework to create a SideBar.
TabBar *	createTabBar (TabWidget *parent) const override
	Called internally by the framework to create a TabBar Override to provide your own TabBar sub-class.
TabWidget *	createTabWidget (Frame *parent, TabWidgetOptions=TabWidgetOption_None) const override
	Called internally by the framework to create a TabWidget Override to provide your own TabWidget sub-class.
TitleBar *	createTitleBar (FloatingWindow *) const override
	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.
TitleBar *	createTitleBar (Frame *) const override
	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.
QAbstractButton *	createTitleBarButton (QWidget *parent, TitleBarButtonType) const override
	Called internally by the framework to create a title bar button parent the button's parent.
QIcon	iconForButtonType (TitleBarButtonType type, qreal dpr) const override
	Returns the icon to be used with the specified type.
Public Member Functions inherited from KDDockWidgets::FrameworkWidgetFactory
	FrameworkWidgetFactory ()=default
virtual	~FrameworkWidgetFactory ()
	Destructor.Don't delete FrameworkWidgetFactory directly, it's owned by the framework.
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

Static Public Attributes
static DropIndicatorType	s_dropIndicatorType = DropIndicatorType::Classic

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

The FrameworkWidgetFactory that's used if none is specified.

Definition at line 167 of file FrameworkWidgetFactory.h.

Constructor & Destructor Documentation

DefaultWidgetFactory()

KDDockWidgets::DefaultWidgetFactory::DefaultWidgetFactory ( )

default

Member Function Documentation

clearIconCache()

void DefaultWidgetFactory::clearIconCache

(

)

Definition at line 296 of file FrameworkWidgetFactory.cpp.

References QMap::clear().

createDropIndicatorOverlay()

DropIndicatorOverlayInterface * DefaultWidgetFactory::createDropIndicatorOverlay ( DropArea *  dropArea ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 99 of file FrameworkWidgetFactory.cpp.

References KDDockWidgets::Classic, KDDockWidgets::None, QObject::qobject_cast(), s_dropIndicatorType, and KDDockWidgets::Segmented.

createFloatingWindow() [1/2]

FloatingWindow * DefaultWidgetFactory::createFloatingWindow ( Frame *  frame, MainWindowBase *  parent = nullptr, QRect  suggestedGeometry = {}  ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 94 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createFloatingWindow() [2/2]

FloatingWindow * DefaultWidgetFactory::createFloatingWindow ( MainWindowBase *  parent = nullptr, FloatingWindowFlags  = FloatingWindowFlag::FromGlobalConfig  ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 88 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createFrame()

Frame * DefaultWidgetFactory::createFrame ( QWidgetOrQuick *  parent, FrameOptions  options  ) const

overridevirtual

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

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 58 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createRubberBand()

QWidgetOrQuick * DefaultWidgetFactory::createRubberBand ( QWidgetOrQuick *  parent ) const

overridevirtual

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

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 118 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QRubberBand::Rectangle.

createSeparator()

Layouting::Separator * DefaultWidgetFactory::createSeparator ( Layouting::Widget *  parent = nullptr ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 83 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

createSideBar()

SideBar * DefaultWidgetFactory::createSideBar ( SideBarLocation  loc, MainWindowBase *  parent  ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 123 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createTabBar()

TabBar * DefaultWidgetFactory::createTabBar ( TabWidget *  parent ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 73 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createTabWidget()

TabWidget * DefaultWidgetFactory::createTabWidget ( Frame *  parent, TabWidgetOptions  options = TabWidgetOption_None  ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 78 of file FrameworkWidgetFactory.cpp.

References QObject::parent(), and QObject::qobject_cast().

createTitleBar() [1/2]

TitleBar * DefaultWidgetFactory::createTitleBar ( FloatingWindow *  floatingWindow ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 68 of file FrameworkWidgetFactory.cpp.

References QObject::qobject_cast().

createTitleBar() [2/2]

TitleBar * DefaultWidgetFactory::createTitleBar ( Frame *  frame ) const

overridevirtual

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.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 63 of file FrameworkWidgetFactory.cpp.

References QObject::qobject_cast().

createTitleBarButton()

QAbstractButton * DefaultWidgetFactory::createTitleBarButton ( QWidget *  parent, TitleBarButtonType    ) const

overridevirtual

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

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 128 of file FrameworkWidgetFactory.cpp.

References iconForButtonType(), QObject::parent(), and QObject::qobject_cast().

iconForButtonType()

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

overridevirtual

Returns the icon to be used with the specified type.

Parameters

dpr	the device pixel ratio of the button

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 240 of file FrameworkWidgetFactory.cpp.

References QIcon::addFile(), KDDockWidgets::AutoHide, QMap::cend(), KDDockWidgets::Close, QMap::constFind(), KDDockWidgets::Float, KDDockWidgets::iconName(), QMap::insert(), QString::isEmpty(), KDDockWidgets::Maximize, KDDockWidgets::Minimize, KDDockWidgets::Normal, QObject::qobject_cast(), and KDDockWidgets::UnautoHide.

Referenced by createTitleBarButton().

Member Data Documentation

s_dropIndicatorType

DropIndicatorType DefaultWidgetFactory::s_dropIndicatorType = DropIndicatorType::Classic

static

Definition at line 196 of file FrameworkWidgetFactory.h.

Referenced by createDropIndicatorOverlay().

---

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

• FrameworkWidgetFactory.h
• FrameworkWidgetFactory.cpp