KDDockWidgets API Documentation  1.5
Public Member Functions | Static Public Attributes | List of all members
KDDockWidgets::DefaultWidgetFactory Class Reference

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

#include <FrameworkWidgetFactory.h>

Inheritance diagram for KDDockWidgets::DefaultWidgetFactory:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgets::DefaultWidgetFactory:
Collaboration graph
[legend]

Public Member Functions

 DefaultWidgetFactory ()=default
 
DropIndicatorOverlayInterface * createDropIndicatorOverlay (DropArea *) const override
 Called internally by the framework to create a DropIndicatorOverlayInterface Override to provide your own DropIndicatorOverlayInterface sub-class. More...
 
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. More...
 
FloatingWindow * createFloatingWindow (MainWindowBase *parent=nullptr) 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. More...
 
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. More...
 
QWidgetOrQuickcreateRubberBand (QWidgetOrQuick *parent) const override
 Called internally by the framework to create a RubberBand to show as drop zone Returns a rubber band. More...
 
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. More...
 
SideBar * createSideBar (SideBarLocation loc, MainWindowBase *parent) const override
 Called internally by the framework to create a SideBar. More...
 
TabBar * createTabBar (TabWidget *parent) const override
 Called internally by the framework to create a TabBar Override to provide your own TabBar sub-class. More...
 
TabWidget * createTabWidget (Frame *parent) const override
 Called internally by the framework to create a TabWidget Override to provide your own TabWidget sub-class. More...
 
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. More...
 
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. More...
 
QAbstractButtoncreateTitleBarButton (QWidget *parent, TitleBarButtonType) const override
 Called internally by the framework to create a title bar button parent the button's parent. More...
 
QIcon iconForButtonType (TitleBarButtonType type, qreal dpr) const override
 Returns the icon to be used with the specified type. More...
 
- Public Member Functions inherited from KDDockWidgets::FrameworkWidgetFactory
 FrameworkWidgetFactory ()=default
 
virtual ~FrameworkWidgetFactory ()
 Destructor.Don't delete FrameworkWidgetFactory directly, it's owned by the framework. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () 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
 
QObjectsender () 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 162 of file FrameworkWidgetFactory.h.

Constructor & Destructor Documentation

◆ DefaultWidgetFactory()

KDDockWidgets::DefaultWidgetFactory::DefaultWidgetFactory ( )
default

Member Function Documentation

◆ 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
dropAreaJust forward to DropIndicatorOverlayInterface's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 98 of file FrameworkWidgetFactory.cpp.

References KDDockWidgets::None, and s_dropIndicatorType.

◆ 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
frameJust forward to FloatingWindow's constructor.
parentJust forward to FloatingWindow's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 93 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ createFloatingWindow() [2/2]

FloatingWindow * DefaultWidgetFactory::createFloatingWindow ( MainWindowBase parent = nullptr) 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
parentJust forward to FloatingWindow's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 88 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ 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
parentjust forward to Frame's constructor
optionsjust forward to Frame's constructor

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 58 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ 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 117 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
parentJust 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
locThe side-bar location without the main window. Just forward into your SideBar sub-class ctor.
parentThe MainWindow. Just forward into your SideBar sub-class ctor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 122 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ 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
parentJust forward to TabBar's's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 73 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ createTabWidget()

TabWidget * DefaultWidgetFactory::createTabWidget ( Frame *  parent) const
overridevirtual

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

Parameters
parentJust forward to TabWidget's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 78 of file FrameworkWidgetFactory.cpp.

References QObject::parent().

◆ 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
floatingWindowJust forward to TitleBar's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 68 of file FrameworkWidgetFactory.cpp.

◆ 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
frameJust forward to TitleBar's constructor.

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 63 of file FrameworkWidgetFactory.cpp.

◆ 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 127 of file FrameworkWidgetFactory.cpp.

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

◆ iconForButtonType()

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

Returns the icon to be used with the specified type.

Parameters
dprthe device pixel ratio of the button

Implements KDDockWidgets::FrameworkWidgetFactory.

Definition at line 239 of file FrameworkWidgetFactory.cpp.

References QIcon::addFile(), KDDockWidgets::Close, KDDockWidgets::Float, KDDockWidgets::iconName(), QString::isEmpty(), and KDDockWidgets::Normal.

Referenced by createTitleBarButton().

Member Data Documentation

◆ s_dropIndicatorType

DropIndicatorType DefaultWidgetFactory::s_dropIndicatorType = DropIndicatorType::Classic
static

Definition at line 190 of file FrameworkWidgetFactory.h.

Referenced by createDropIndicatorOverlay().


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

© 2019-2022 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
KDDockWidgets
Advanced Dock Widget Framework for Qt
https://www.kdab.com/development-resources/qt-tools/kddockwidgets/
Generated on Mon Mar 7 2022 02:01:21 for KDDockWidgets API Documentation by doxygen 1.8.20