KDDockWidgets API Documentation 2.0
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
KDDockWidgets::DockWidgetInstantiator Class Reference

Indirection helper to instantiate dock widgets from QML. More...

#include <DockWidgetInstantiator.h>

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

Signals

void actualTitleBarChanged ()
 
void closed ()
 
void dockWidgetChanged ()
 
void guestViewChanged (QQuickItem *)
 
void iconChanged ()
 
void isFloatingChanged (bool)
 
void isFocusedChanged (bool)
 
void isOpenChanged (bool)
 
void isOverlayedChanged (bool)
 
void optionsChanged (KDDockWidgets::DockWidgetOptions)
 
void removedFromSideBar ()
 
void sourceChanged ()
 
void titleChanged (const QString &title)
 
void uniqueNameChanged ()
 
void windowActiveAboutToChange (bool activated)
 

Public Member Functions

QObjectactualTitleBar () const
 
Q_INVOKABLE void addDockWidgetAsTab (QQuickItem *other, KDDockWidgets::InitialVisibilityOption={})
 
Q_INVOKABLE void addDockWidgetToContainingWindow (QQuickItem *other, KDDockWidgets::Location location, QQuickItem *relativeTo=nullptr, QSize initialSize={}, KDDockWidgets::InitialVisibilityOption={})
 
Q_INVOKABLE bool close ()
 
KDDockWidgets::Core::DockWidgetcontroller () const
 
Q_INVOKABLE void deleteDockWidget ()
 
KDDockWidgets::QtQuick::DockWidgetdockWidget () const
 
Q_INVOKABLE void forceClose ()
 
bool isFloating () const
 
bool isFocused () const
 
bool isOpen () const
 
Q_INVOKABLE void moveToSideBar ()
 
Q_INVOKABLE void open ()
 
Q_INVOKABLE void raise ()
 
Q_INVOKABLE void setAsCurrentTab ()
 
void setFloating (bool)
 
void setSource (const QString &)
 
void setTitle (const QString &title)
 
void setUniqueName (const QString &)
 
Q_INVOKABLE void show ()
 
QString source () const
 
QString title () const
 
QString uniqueName () const
 

Protected Member Functions

void classBegin () override
 
void componentComplete () override
 

Properties

QObjectactualTitleBar
 
KDDockWidgets::QtQuick::DockWidgetdockWidget
 
bool isFloating
 
bool isFocused
 
bool isOpen
 
QString source
 
QString title
 
QString uniqueName
 

Detailed Description

Indirection helper to instantiate dock widgets from QML.

"DockWidget {}" in QML won't create a KDDockWidget::DockWidget directly, but instead an DockWidgetInstantiator. DockWidgetInstantiator will then create the DockWidget instance only when the QML parsing ends (and all properties are set)

This allows to pass the correct uniqueName to DockWidget's ctor.

Definition at line 35 of file DockWidgetInstantiator.h.

Member Function Documentation

◆ actualTitleBar()

QObject * DockWidgetInstantiator::actualTitleBar ( ) const

Definition at line 58 of file DockWidgetInstantiator.cpp.

References dockWidget.

◆ actualTitleBarChanged

void KDDockWidgets::DockWidgetInstantiator::actualTitleBarChanged ( )
signal

Referenced by componentComplete().

◆ addDockWidgetAsTab()

void DockWidgetInstantiator::addDockWidgetAsTab ( QQuickItem *  other,
KDDockWidgets::InitialVisibilityOption  option = {} 
)

◆ addDockWidgetToContainingWindow()

void DockWidgetInstantiator::addDockWidgetToContainingWindow ( QQuickItem *  other,
KDDockWidgets::Location  location,
QQuickItem *  relativeTo = nullptr,
QSize  initialSize = {},
KDDockWidgets::InitialVisibilityOption  option = {} 
)

◆ classBegin()

void DockWidgetInstantiator::classBegin ( )
overrideprotected

Definition at line 175 of file DockWidgetInstantiator.cpp.

◆ close()

Q_INVOKABLE bool DockWidgetInstantiator::close ( )

◆ closed

void KDDockWidgets::DockWidgetInstantiator::closed ( )
signal

Referenced by componentComplete().

◆ componentComplete()

void DockWidgetInstantiator::componentComplete ( )
overrideprotected

◆ controller()

KDDockWidgets::Core::DockWidget * DockWidgetInstantiator::controller ( ) const

Definition at line 53 of file DockWidgetInstantiator.cpp.

◆ deleteDockWidget()

void DockWidgetInstantiator::deleteDockWidget ( )

Deletes the dock widget

Deleting involves deleting the controller (Core::DockWidget), the view (View::DockWidget) and this instantiator itself as well.

It's more usual to just hide dock widgets though.

Definition at line 169 of file DockWidgetInstantiator.cpp.

◆ dockWidget()

QtQuick::DockWidget * DockWidgetInstantiator::dockWidget ( ) const

◆ dockWidgetChanged

void KDDockWidgets::DockWidgetInstantiator::dockWidgetChanged ( )
signal

Referenced by componentComplete().

◆ forceClose()

void DockWidgetInstantiator::forceClose ( )

◆ guestViewChanged

void KDDockWidgets::DockWidgetInstantiator::guestViewChanged ( QQuickItem *  )
signal

Referenced by componentComplete().

◆ iconChanged

void KDDockWidgets::DockWidgetInstantiator::iconChanged ( )
signal

Referenced by componentComplete().

◆ isFloating()

bool DockWidgetInstantiator::isFloating ( ) const

◆ isFloatingChanged

void KDDockWidgets::DockWidgetInstantiator::isFloatingChanged ( bool  )
signal

Referenced by componentComplete().

◆ isFocused()

bool DockWidgetInstantiator::isFocused ( ) const

◆ isFocusedChanged

void KDDockWidgets::DockWidgetInstantiator::isFocusedChanged ( bool  )
signal

Referenced by componentComplete().

◆ isOpen()

bool DockWidgetInstantiator::isOpen ( ) const

◆ isOpenChanged

void KDDockWidgets::DockWidgetInstantiator::isOpenChanged ( bool  )
signal

Referenced by componentComplete().

◆ isOverlayedChanged

void KDDockWidgets::DockWidgetInstantiator::isOverlayedChanged ( bool  )
signal

Referenced by componentComplete().

◆ moveToSideBar()

void DockWidgetInstantiator::moveToSideBar ( )

◆ open()

void DockWidgetInstantiator::open ( )

Definition at line 145 of file DockWidgetInstantiator.cpp.

References KDDockWidgets::Core::DockWidget::open().

Referenced by show().

◆ optionsChanged

void KDDockWidgets::DockWidgetInstantiator::optionsChanged ( KDDockWidgets::DockWidgetOptions  )
signal

Referenced by componentComplete().

◆ raise()

void DockWidgetInstantiator::raise ( )

◆ removedFromSideBar

void KDDockWidgets::DockWidgetInstantiator::removedFromSideBar ( )
signal

Referenced by componentComplete().

◆ setAsCurrentTab()

void DockWidgetInstantiator::setAsCurrentTab ( )

◆ setFloating()

void DockWidgetInstantiator::setFloating ( bool  is)

◆ setSource()

void DockWidgetInstantiator::setSource ( const QString source)

Definition at line 38 of file DockWidgetInstantiator.cpp.

References source, and sourceChanged().

◆ setTitle()

void DockWidgetInstantiator::setTitle ( const QString title)

◆ setUniqueName()

void DockWidgetInstantiator::setUniqueName ( const QString name)

Definition at line 27 of file DockWidgetInstantiator.cpp.

References uniqueNameChanged().

◆ show()

void DockWidgetInstantiator::show ( )

Definition at line 151 of file DockWidgetInstantiator.cpp.

References open().

◆ source()

QString DockWidgetInstantiator::source ( ) const

Definition at line 33 of file DockWidgetInstantiator.cpp.

◆ sourceChanged

void KDDockWidgets::DockWidgetInstantiator::sourceChanged ( )
signal

Referenced by setSource().

◆ title()

QString DockWidgetInstantiator::title ( ) const

◆ titleChanged

void KDDockWidgets::DockWidgetInstantiator::titleChanged ( const QString title)
signal

Referenced by componentComplete().

◆ uniqueName()

QString DockWidgetInstantiator::uniqueName ( ) const

Definition at line 22 of file DockWidgetInstantiator.cpp.

◆ uniqueNameChanged

void KDDockWidgets::DockWidgetInstantiator::uniqueNameChanged ( )
signal

Referenced by setUniqueName().

◆ windowActiveAboutToChange

void KDDockWidgets::DockWidgetInstantiator::windowActiveAboutToChange ( bool  activated)
signal

Referenced by componentComplete().

Property Documentation

◆ actualTitleBar

QObject * KDDockWidgets::DockWidgetInstantiator::actualTitleBar
read

Definition at line 42 of file DockWidgetInstantiator.h.

◆ dockWidget

KDDockWidgets::QtQuick::DockWidget * KDDockWidgets::DockWidgetInstantiator::dockWidget
read

Definition at line 40 of file DockWidgetInstantiator.h.

Referenced by actualTitleBar(), and componentComplete().

◆ isFloating

bool KDDockWidgets::DockWidgetInstantiator::isFloating
readwrite

Definition at line 45 of file DockWidgetInstantiator.h.

◆ isFocused

bool KDDockWidgets::DockWidgetInstantiator::isFocused
read

Definition at line 44 of file DockWidgetInstantiator.h.

◆ isOpen

bool KDDockWidgets::DockWidgetInstantiator::isOpen
read

Definition at line 46 of file DockWidgetInstantiator.h.

◆ source

QString KDDockWidgets::DockWidgetInstantiator::source
readwrite

Definition at line 39 of file DockWidgetInstantiator.h.

Referenced by setSource().

◆ title

QString KDDockWidgets::DockWidgetInstantiator::title
readwrite

Definition at line 43 of file DockWidgetInstantiator.h.

Referenced by componentComplete(), and setTitle().

◆ uniqueName

QString KDDockWidgets::DockWidgetInstantiator::uniqueName
readwrite

Definition at line 38 of file DockWidgetInstantiator.h.


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

© 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 by doxygen 1.9.8