KDDockWidgets API Documentation 2.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages Concepts
Public Types | Public Member Functions | Static Public Member Functions | List of all members
KDDockWidgets::DockRegistry Class Reference

#include <DockRegistry.h>

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

Public Types

enum class  DockByNameFlag { None = 0 , ConsultRemapping = 1 , CreateIfNotFound , SilentIfNotFound = 4 }
 

Public Member Functions

 ~DockRegistry ()
 
bool affinitiesMatch (const Vector< QString > &affinities1, const Vector< QString > &affinities2) const
 
void clear (const Vector< Core::DockWidget * > &dockWidgets, const Vector< Core::MainWindow * > &mainWindows, const Vector< QString > &affinities)
 clear Overload that only clears the specified dockWidgets and main windows.
 
Q_INVOKABLE void clear (const Vector< QString > &affinities={})
 Closes all dock widgets, and destroys all FloatingWindows This is called before restoring a layout.
 
Vector< Core::DockWidget * > closedDockwidgets (bool honourSkipped) const
 returns all closed DockWidget instances
 
Q_INVOKABLE bool containsDockWidget (const QString &uniqueName) const
 
Q_INVOKABLE bool containsMainWindow (const QString &uniqueName) const
 
CloseReason currentCloseReason ()
 
Q_INVOKABLE KDDockWidgets::Core::DockWidget * dockByName (const QString &, KDDockWidgets::DockRegistry::DockByNameFlags={}) const
 
Vector< QString > dockWidgetNames () const
 Returns a list of all known dock widget unique names.
 
Vector< Core::DockWidget * > dockwidgets () const
 returns all DockWidget instances
 
Vector< Core::DockWidget * > dockWidgets (const Vector< QString > &names)
 overload returning only the ones with the specified names
 
Private * dptr () const
 
void ensureAllFloatingWidgetsAreMorphed ()
 Ensures that all floating DockWidgets have a FloatingWindow as a window.
 
Vector< std::shared_ptr< Core::Window > > floatingQWindows () const
 overload that returns list of QWindow. This is more friendly for supporting both QtWidgets and QtQuick
 
Core::FloatingWindow * floatingWindowForHandle (Core::WId hwnd) const
 returns the FloatingWindow with handle hwnd
 
Core::FloatingWindow * floatingWindowForHandle (std::shared_ptr< Core::Window > windowHandle) const
 returns the FloatingWindow with handle windowHandle
 
Vector< Core::FloatingWindow * > floatingWindows (bool includeBeingDeleted=false, bool honourSkipped=false) const
 returns all FloatingWindow instances. Not necessarily all floating dock widgets, As there might be DockWidgets which weren't morphed yet.
 
Q_INVOKABLE KDDockWidgets::Core::DockWidget * focusedDockWidget () const
 
Core::Group * groupInMDIResize () const
 Returns the Group which is being resized in a MDI layout. nullptr if none.
 
Vector< Core::Group * > groups () const
 returns a list of all Frame instances
 
Q_INVOKABLE bool hasFloatingWindows () const
 returns whether if there's at least one floating window
 
bool isEmpty (bool excludeBeingDeleted=false) const
 returns true if there's 0 dockwidgets, 0 main windows
 
bool isProbablyObscured (std::shared_ptr< Core::Window > target, Core::FloatingWindow *exclude) const
 returns if the specified window has some other window on top (with higher Z) This is an approximation, as we don't have ways to compare Z, so we mostly intersect geometries.
 
bool isProbablyObscured (std::shared_ptr< Core::Window > target, Core::WindowBeingDragged *exclude) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool isSane () const
 
bool itemIsInMainWindow (const Core::Item *) const
 Returns whether the item is in a main window. Nesting is honoured. (MDIArea inside DropArea inside MainWindow, for example)
 
Core::Layout * layoutForItem (const Core::Item *) const
 Returns the Layout where the specified item is in.
 
Vector< Core::MainWindowViewInterface * > mainDockingAreas () const
 returns all MainWindow instances Like mainwindows(), but with better suited for QtQuick and better terminology as we're phasing out the "MainWindow" name there
 
Q_INVOKABLE KDDockWidgets::Core::MainWindow * mainWindowByName (const QString &) const
 
Core::MainWindow * mainWindowForHandle (std::shared_ptr< Core::Window > windowHandle) const
 returns the MainWindow with handle windowHandle
 
Vector< Core::MainWindow * > mainwindows () const
 returns all MainWindow instances
 
Vector< Core::MainWindow * > mainWindows (const Vector< QString > &names)
 overload returning only the ones with the specified names
 
Vector< QString > mainWindowsNames () const
 Returns a list of all known main window unique names.
 
Vector< Core::MainWindow * > mainWindowsWithAffinity (const Vector< QString > &affinities) const
 Returns all main windows which match at least one of the affinities.
 
void registerDockWidget (Core::DockWidget *)
 
void registerFloatingWindow (Core::FloatingWindow *)
 
void registerGroup (Core::Group *)
 
void registerLayoutSaver ()
 
void registerMainWindow (Core::MainWindow *)
 
void setCurrentCloseReason (CloseReason)
 
Core::SideBar * sideBarForDockWidget (const Core::DockWidget *) const
 Overload that returns the SideBar itself.
 
SideBarLocation sideBarLocationForDockWidget (const Core::DockWidget *) const
 Returns whether the specified dock widget is in a side bar, and which. SideBarLocation::None is returned if it's not in a sidebar. This is only relevant when using the auto-hide and side-bar feature.
 
Vector< std::shared_ptr< Core::Window > > topLevels (bool excludeFloatingDocks=false) const
 Returns the list with all visiblye top-level parents of our FloatingWindow and MainWindow instances.
 
void unregisterDockWidget (Core::DockWidget *)
 
void unregisterFloatingWindow (Core::FloatingWindow *)
 
void unregisterGroup (Core::Group *)
 
void unregisterLayoutSaver ()
 
void unregisterMainWindow (Core::MainWindow *)
 
- Public Member Functions inherited from KDDockWidgets::Core::EventFilterInterface
 EventFilterInterface ()=default
 
virtual ~EventFilterInterface ()
 
bool enabled () const
 Returns whether mouse filtering is enabled. Default true.
 
virtual bool onDnDEvent (View *, Event *)
 Override to handle drag enter, drag leave, drag move and drop events.
 
virtual bool onExposeEvent (std::shared_ptr< Window >)
 Override to handle expose events for a certain window.
 
virtual bool onMouseButtonMove (View *, MouseEvent *)
 Override to handle when a view receives a mouse press event.
 
virtual bool onMouseButtonRelease (View *, MouseEvent *)
 Override to handle when a view receives a mouse press event.
 
virtual bool onMouseDoubleClick (View *, MouseEvent *)
 Override to handle when a view receives a mouse double click event.
 
virtual bool onMouseEvent (View *, MouseEvent *)
 Provided for convenience, aggregates all other overloads receives all mouse event types, if you return true here then the specialized counterparts won't be called Example, if true is returned here for a mouse press, then onMouseButtonPress() won't be called.
 
virtual bool onMoveEvent (View *)
 Override to handle a move event.
 
void setEnabled (bool)
 

Static Public Member Functions

static DockRegistry * self ()
 

Detailed Description

Definition at line 47 of file DockRegistry.h.

Member Enumeration Documentation

◆ DockByNameFlag

enum class KDDockWidgets::DockRegistry::DockByNameFlag
strong
Enumerator
None 
ConsultRemapping 
CreateIfNotFound 

Creates the dock widget via the user's widget factory in case it doesn't exist.

SilentIfNotFound 

don't print errors if not found, it will be created later

Definition at line 52 of file DockRegistry.h.

Constructor & Destructor Documentation

◆ ~DockRegistry()

DockRegistry::~DockRegistry ( )

Definition at line 72 of file DockRegistry.cpp.

References KDDockWidgets::Core::Platform::instance(), and KDDockWidgets::Core::Platform::removeGlobalEventFilter().

Member Function Documentation

◆ affinitiesMatch()

bool DockRegistry::affinitiesMatch ( const Vector< QString > &  affinities1,
const Vector< QString > &  affinities2 
) const

Definition at line 137 of file DockRegistry.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::isEmpty().

Referenced by mainWindowsWithAffinity().

◆ clear() [1/2]

void KDDockWidgets::DockRegistry::clear ( const Vector< Core::DockWidget * > &  dockWidgets,
const Vector< Core::MainWindow * > &  mainWindows,
const Vector< QString > &  affinities 
)

clear Overload that only clears the specified dockWidgets and main windows.

◆ clear() [2/2]

void DockRegistry::clear ( const Vector< QString > &  affinities = {})

Closes all dock widgets, and destroys all FloatingWindows This is called before restoring a layout.

Parameters
affinitiesif specified only closes dock widgets and main windows with the specified affinities

Definition at line 657 of file DockRegistry.cpp.

References clear().

Referenced by c_KDDockWidgets__DockRegistry__clear(), KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::clear(), and clear().

◆ closedDockwidgets()

DockWidget::List DockRegistry::closedDockwidgets ( bool  honourSkipped) const

returns all closed DockWidget instances

Parameters
honourSkippedIf true, won't include dock widgets with LayoutSaverOption::Skip

Definition at line 514 of file DockRegistry.cpp.

References KDDockWidgets::Core::Controller::isVisible(), KDDockWidgets::Core::DockWidget::layoutSaverOptions(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), and KDDockWidgets::Skip.

◆ containsDockWidget()

bool DockRegistry::containsDockWidget ( const QString &  uniqueName) const

Definition at line 393 of file DockRegistry.cpp.

References dockByName().

Referenced by c_KDDockWidgets__DockRegistry__containsDockWidget_QString().

◆ containsMainWindow()

bool DockRegistry::containsMainWindow ( const QString &  uniqueName) const

Definition at line 398 of file DockRegistry.cpp.

References mainWindowByName().

Referenced by c_KDDockWidgets__DockRegistry__containsMainWindow_QString().

◆ currentCloseReason()

CloseReason DockRegistry::currentCloseReason ( )

Definition at line 262 of file DockRegistry.cpp.

◆ dockByName()

Core::DockWidget * DockRegistry::dockByName ( const QString &  ,
KDDockWidgets::DockRegistry::DockByNameFlags  = {} 
) const

Definition at line 403 of file DockRegistry.cpp.

References ConsultRemapping, CreateIfNotFound, dockByName(), QString::isEmpty(), KDDockWidgets::Config::self(), SilentIfNotFound, and KDDockWidgets::Core::DockWidget::uniqueName().

Referenced by KDDockWidgets::Debug::DebugWindow::DebugWindow(), KDDockWidgets::Core::MainWindowViewInterface::addDockWidget(), KDDockWidgets::Core::DockWidget::byName(), c_KDDockWidgets__DockRegistry__dockByName_QString(), containsDockWidget(), dockByName(), and registerDockWidget().

◆ dockWidgetNames()

Vector< QString > DockRegistry::dockWidgetNames ( ) const

Returns a list of all known dock widget unique names.

Definition at line 163 of file DockRegistry.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), and KDDockWidgets::Core::DockWidget::uniqueName().

◆ dockwidgets()

Core::DockWidget::List DockRegistry::dockwidgets ( ) const

returns all DockWidget instances

Definition at line 483 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Debug::DebugWindow::DebugWindow(), and KDDockWidgets::LayoutSaver::restoredDockWidgets().

◆ dockWidgets()

Core::DockWidget::List DockRegistry::dockWidgets ( const Vector< QString > &  names)

overload returning only the ones with the specified names

Definition at line 488 of file DockRegistry.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::contains(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::size(), and KDDockWidgets::Core::DockWidget::uniqueName().

◆ dptr()

DockRegistry::Private * DockRegistry::dptr ( ) const

Definition at line 267 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Core::DropIndicatorOverlay::DropIndicatorOverlay(), KDDockWidgets::QtWidgets::FloatingWindow::event(), KDDockWidgets::QtWidgets::TitleBar::init(), and KDDockWidgets::QtWidgets::FloatingWindow::init().

◆ ensureAllFloatingWidgetsAreMorphed()

void DockRegistry::ensureAllFloatingWidgetsAreMorphed ( )

Ensures that all floating DockWidgets have a FloatingWindow as a window.

This is to simplify things before saving a layout. So we don't have to care about the case where the window is a DockWidget.

Definition at line 681 of file DockRegistry.cpp.

References KDDockWidgets::Core::DockWidget::d, KDDockWidgets::Core::Controller::isVisible(), KDDockWidgets::Core::View::rootView(), and KDDockWidgets::Core::Controller::view().

Referenced by c_KDDockWidgets__DockRegistry__ensureAllFloatingWidgetsAreMorphed(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::ensureAllFloatingWidgetsAreMorphed().

◆ floatingQWindows()

Window::List DockRegistry::floatingQWindows ( ) const

overload that returns list of QWindow. This is more friendly for supporting both QtWidgets and QtQuick

Definition at line 570 of file DockRegistry.cpp.

References KDDockWidgets::Core::FloatingWindow::beingDeleted(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), KDDockWidgets::Core::Controller::view(), and KDDockWidgets::Core::View::window().

◆ floatingWindowForHandle() [1/2]

Core::FloatingWindow * DockRegistry::floatingWindowForHandle ( Core::WId  hwnd) const

returns the FloatingWindow with handle hwnd

Definition at line 603 of file DockRegistry.cpp.

References KDDockWidgets::Core::Controller::view(), and KDDockWidgets::Core::View::window().

◆ floatingWindowForHandle() [2/2]

Core::FloatingWindow * KDDockWidgets::DockRegistry::floatingWindowForHandle ( std::shared_ptr< Core::Window >  windowHandle) const

returns the FloatingWindow with handle windowHandle

◆ floatingWindows()

Vector< Core::FloatingWindow * > DockRegistry::floatingWindows ( bool  includeBeingDeleted = false,
bool  honourSkipped = false 
) const

returns all FloatingWindow instances. Not necessarily all floating dock widgets, As there might be DockWidgets which weren't morphed yet.

Definition at line 552 of file DockRegistry.cpp.

References KDDockWidgets::Core::FloatingWindow::allDockWidgetsHave(), KDDockWidgets::Core::FloatingWindow::beingDeleted(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), and KDDockWidgets::Skip.

Referenced by KDDockWidgets::Debug::DebugWindow::DebugWindow().

◆ focusedDockWidget()

Core::DockWidget * DockRegistry::focusedDockWidget ( ) const

Returns the dock widget that contains the widget with active focus Doesn't necessarily mean that this DockWidget has QWidget::focus, but that it contains the QApplication::focusObject() widget.

Definition at line 388 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__focusedDockWidget(), and KDDockWidgets::Core::DockWidget::isFocused().

◆ groupInMDIResize()

Core::Group * DockRegistry::groupInMDIResize ( ) const

Returns the Group which is being resized in a MDI layout. nullptr if none.

Definition at line 238 of file DockRegistry.cpp.

References groups(), and KDDockWidgets::Core::Layout::groups().

Referenced by c_KDDockWidgets__DockRegistry__groupInMDIResize().

◆ groups()

Core::Group::List DockRegistry::groups ( ) const

returns a list of all Frame instances

Definition at line 547 of file DockRegistry.cpp.

Referenced by groupInMDIResize().

◆ hasFloatingWindows()

bool DockRegistry::hasFloatingWindows ( ) const

returns whether if there's at least one floating window

Definition at line 587 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__hasFloatingWindows(), and isEmpty().

◆ isEmpty()

bool DockRegistry::isEmpty ( bool  excludeBeingDeleted = false) const

returns true if there's 0 dockwidgets, 0 main windows

Parameters
excludeBeingDeletedif true, any window currently being deleted won't count

Definition at line 129 of file DockRegistry.cpp.

References hasFloatingWindows().

Referenced by c_KDDockWidgets__DockRegistry__isEmpty_bool().

◆ isProbablyObscured() [1/2]

bool KDDockWidgets::DockRegistry::isProbablyObscured ( std::shared_ptr< Core::Window >  target,
Core::FloatingWindow *  exclude 
) const

returns if the specified window has some other window on top (with higher Z) This is an approximation, as we don't have ways to compare Z, so we mostly intersect geometries.

Parameters
targetThe window which we want to know if it's probably obscured
excludeThis window should not be counted as an obscurer. (It's being dragged).

◆ isProbablyObscured() [2/2]

bool KDDockWidgets::DockRegistry::isProbablyObscured ( std::shared_ptr< Core::Window >  target,
Core::WindowBeingDragged *  exclude 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ isSane()

bool DockRegistry::isSane ( ) const

Definition at line 447 of file DockRegistry.cpp.

References QString::isEmpty().

Referenced by c_KDDockWidgets__DockRegistry__isSane().

◆ itemIsInMainWindow()

bool DockRegistry::itemIsInMainWindow ( const Core::Item *  item) const

Returns whether the item is in a main window. Nesting is honoured. (MDIArea inside DropArea inside MainWindow, for example)

Definition at line 292 of file DockRegistry.cpp.

References layoutForItem().

Referenced by c_KDDockWidgets__DockRegistry__itemIsInMainWindow_Item().

◆ layoutForItem()

Core::Layout * DockRegistry::layoutForItem ( const Core::Item *  item) const

Returns the Layout where the specified item is in.

Definition at line 287 of file DockRegistry.cpp.

References KDDockWidgets::Core::Layout::fromLayoutingHost().

Referenced by c_KDDockWidgets__DockRegistry__layoutForItem_Item(), and itemIsInMainWindow().

◆ mainDockingAreas()

Vector< Core::MainWindowViewInterface * > DockRegistry::mainDockingAreas ( ) const

returns all MainWindow instances Like mainwindows(), but with better suited for QtQuick and better terminology as we're phasing out the "MainWindow" name there

Definition at line 533 of file DockRegistry.cpp.

◆ mainWindowByName()

Core::MainWindow * DockRegistry::mainWindowByName ( const QString &  name) const

Definition at line 437 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__mainWindowByName_QString(), containsMainWindow(), and registerMainWindow().

◆ mainWindowForHandle()

Core::MainWindow * DockRegistry::mainWindowForHandle ( std::shared_ptr< Core::Window >  windowHandle) const

returns the MainWindow with handle windowHandle

Definition at line 614 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Core::FloatingWindow::serialize().

◆ mainwindows()

Core::MainWindow::List DockRegistry::mainwindows ( ) const

returns all MainWindow instances

Definition at line 528 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Debug::DebugWindow::DebugWindow(), hackFindParentHarder(), KDDockWidgets::LayoutSaver::restoreLayout(), and KDDockWidgets::Core::FloatingWindow::serialize().

◆ mainWindows()

Core::MainWindow::List DockRegistry::mainWindows ( const Vector< QString > &  names)

overload returning only the ones with the specified names

Definition at line 501 of file DockRegistry.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::contains(), KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), and KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::size().

◆ mainWindowsNames()

Vector< QString > DockRegistry::mainWindowsNames ( ) const

Returns a list of all known main window unique names.

Definition at line 153 of file DockRegistry.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve().

◆ mainWindowsWithAffinity()

Core::MainWindow::List DockRegistry::mainWindowsWithAffinity ( const Vector< QString > &  affinities) const

Returns all main windows which match at least one of the affinities.

Definition at line 273 of file DockRegistry.cpp.

References affinitiesMatch(), and KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve().

Referenced by hackFindParentHarder().

◆ registerDockWidget()

void DockRegistry::registerDockWidget ( Core::DockWidget *  dock)

Definition at line 312 of file DockRegistry.cpp.

References dockByName(), QString::isEmpty(), and KDDockWidgets::Core::DockWidget::uniqueName().

Referenced by KDDockWidgets::Core::DockWidget::DockWidget(), c_KDDockWidgets__DockRegistry__registerDockWidget_DockWidget(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerDockWidget().

◆ registerFloatingWindow()

void DockRegistry::registerFloatingWindow ( Core::FloatingWindow *  fw)

Definition at line 353 of file DockRegistry.cpp.

References KDDockWidgets::Core::Platform::instance(), and KDDockWidgets::Core::Platform::onFloatingWindowCreated().

Referenced by KDDockWidgets::Core::FloatingWindow::FloatingWindow(), c_KDDockWidgets__DockRegistry__registerFloatingWindow_FloatingWindow(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerFloatingWindow().

◆ registerGroup()

void DockRegistry::registerGroup ( Core::Group *  group)

Definition at line 366 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Core::Group::Group(), c_KDDockWidgets__DockRegistry__registerGroup_Group(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerGroup().

◆ registerLayoutSaver()

void DockRegistry::registerLayoutSaver ( )

Definition at line 377 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__registerLayoutSaver(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerLayoutSaver().

◆ registerMainWindow()

void DockRegistry::registerMainWindow ( Core::MainWindow *  mainWindow)

Definition at line 334 of file DockRegistry.cpp.

References KDDockWidgets::Core::Platform::instance(), QString::isEmpty(), mainWindowByName(), KDDockWidgets::Core::Platform::onMainWindowCreated(), and KDDockWidgets::Core::MainWindow::uniqueName().

Referenced by c_KDDockWidgets__DockRegistry__registerMainWindow_MainWindow(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerMainWindow().

◆ self()

DockRegistry * DockRegistry::self ( )
static

Definition at line 301 of file DockRegistry.cpp.

Referenced by KDDockWidgets::CloseReasonSetter::CloseReasonSetter(), KDDockWidgets::Debug::DebugWindow::DebugWindow(), KDDockWidgets::Core::DockWidget::DockWidget(), KDDockWidgets::Core::DropIndicatorOverlay::DropIndicatorOverlay(), KDDockWidgets::Core::FloatingWindow::FloatingWindow(), KDDockWidgets::Core::Group::Group(), KDDockWidgets::CloseReasonSetter::~CloseReasonSetter(), KDDockWidgets::Core::DockWidget::~DockWidget(), KDDockWidgets::Core::FloatingWindow::~FloatingWindow(), KDDockWidgets::Core::Group::~Group(), KDDockWidgets::Core::MainWindowViewInterface::addDockWidget(), KDDockWidgets::Core::MainWindowViewInterface::addDockWidgetAsTab(), KDDockWidgets::Core::DockWidget::addDockWidgetAsTab(), KDDockWidgets::Core::DockWidget::addDockWidgetToContainingWindow(), KDDockWidgets::Core::DockWidget::byName(), KDDockWidgets::DockWidgetInstantiator::componentComplete(), KDDockWidgets::MainWindowInstantiator::componentComplete(), KDDockWidgets::MainWindowMDIInstantiator::componentComplete(), deepestDropAreaInTopLevel(), KDDockWidgets::Core::Group::deserialize(), KDDockWidgets::Core::DockWidget::deserialize(), KDDockWidgets::Core::DropIndicatorOverlay::dropIndicatorVisible(), KDDockWidgets::QtWidgets::FloatingWindow::event(), hackFindParentHarder(), KDDockWidgets::QtWidgets::TitleBar::init(), KDDockWidgets::QtWidgets::FloatingWindow::init(), KDDockWidgets::Core::DockWidget::isFocused(), KDDockWidgets::Core::MainWindowViewInterface::layoutParentContainerEqually(), KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar(), KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar(), KDDockWidgets::Core::TitleBar::onAutoHideClicked(), KDDockWidgets::Core::MainWindowViewInterface::overlayOnSideBar(), KDDockWidgets::LayoutSaver::restoredDockWidgets(), KDDockWidgets::Core::MainWindowViewInterface::restoreFromSideBar(), KDDockWidgets::LayoutSaver::restoreLayout(), KDDockWidgets::Core::FloatingWindow::scheduleDeleteLater(), KDDockWidgets::Core::FloatingWindow::serialize(), KDDockWidgets::QtQuick::Platform::setQmlEngine(), KDDockWidgets::Core::DockWidget::sideBarLocation(), and KDDockWidgets::Core::MainWindowViewInterface::toggleOverlayOnSideBar().

◆ setCurrentCloseReason()

void DockRegistry::setCurrentCloseReason ( CloseReason  reason)

Definition at line 257 of file DockRegistry.cpp.

Referenced by KDDockWidgets::CloseReasonSetter::CloseReasonSetter(), and KDDockWidgets::CloseReasonSetter::~CloseReasonSetter().

◆ sideBarForDockWidget()

Core::SideBar * DockRegistry::sideBarForDockWidget ( const Core::DockWidget *  dw) const

Overload that returns the SideBar itself.

Definition at line 228 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__sideBarForDockWidget_DockWidget(), and sideBarLocationForDockWidget().

◆ sideBarLocationForDockWidget()

SideBarLocation DockRegistry::sideBarLocationForDockWidget ( const Core::DockWidget *  dw) const

Returns whether the specified dock widget is in a side bar, and which. SideBarLocation::None is returned if it's not in a sidebar. This is only relevant when using the auto-hide and side-bar feature.

Definition at line 220 of file DockRegistry.cpp.

References KDDockWidgets::None, and sideBarForDockWidget().

Referenced by KDDockWidgets::Core::DockWidget::sideBarLocation().

◆ topLevels()

Window::List DockRegistry::topLevels ( bool  excludeFloatingDocks = false) const

Returns the list with all visiblye top-level parents of our FloatingWindow and MainWindow instances.

Typically these are the FloatingWindows and MainWindows themselves. However, since a MainWindow can be embedded into another widget (for whatever reason, like a QWinWidget), it means that a top-level can be something else.

Every returned widget is either a FloatingWindow, MainWindow, or something that contains a MainWindow.

If excludeFloatingDocks is true then FloatingWindow won't be returned

Definition at line 627 of file DockRegistry.cpp.

References KDDockWidgets::Core::Controller::isVisible(), KDDockWidgets::Core::Controller::view(), and KDDockWidgets::Core::View::window().

◆ unregisterDockWidget()

void DockRegistry::unregisterDockWidget ( Core::DockWidget *  dock)

Definition at line 323 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Core::DockWidget::~DockWidget(), c_KDDockWidgets__DockRegistry__unregisterDockWidget_DockWidget(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterDockWidget().

◆ unregisterFloatingWindow()

void DockRegistry::unregisterFloatingWindow ( Core::FloatingWindow *  fw)

Definition at line 359 of file DockRegistry.cpp.

References KDDockWidgets::Core::Platform::instance(), and KDDockWidgets::Core::Platform::onFloatingWindowDestroyed().

Referenced by KDDockWidgets::Core::FloatingWindow::~FloatingWindow(), c_KDDockWidgets__DockRegistry__unregisterFloatingWindow_FloatingWindow(), KDDockWidgets::Core::FloatingWindow::scheduleDeleteLater(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterFloatingWindow().

◆ unregisterGroup()

void DockRegistry::unregisterGroup ( Core::Group *  group)

Definition at line 371 of file DockRegistry.cpp.

Referenced by KDDockWidgets::Core::Group::~Group(), c_KDDockWidgets__DockRegistry__unregisterGroup_Group(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterGroup().

◆ unregisterLayoutSaver()

void DockRegistry::unregisterLayoutSaver ( )

Definition at line 382 of file DockRegistry.cpp.

Referenced by c_KDDockWidgets__DockRegistry__unregisterLayoutSaver(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterLayoutSaver().

◆ unregisterMainWindow()

void DockRegistry::unregisterMainWindow ( Core::MainWindow *  mainWindow)

Definition at line 346 of file DockRegistry.cpp.

References KDDockWidgets::Core::Platform::instance(), and KDDockWidgets::Core::Platform::onMainWindowDestroyed().

Referenced by c_KDDockWidgets__DockRegistry__unregisterMainWindow_MainWindow(), and KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterMainWindow().

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