KDDockWidgets API Documentation 2.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper Class Reference

#include <DockRegistry_c.h>

Inheritance diagram for KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper:
Collaboration graph
[legend]

Public Member Functions

 ~DockRegistry_wrapper ()
 
void checkSanityAll (bool dumpDebug=false)
 
void clear ()
 
bool containsDockWidget (const QString &uniqueName) const
 
bool containsMainWindow (const QString &uniqueName) const
 
KDDockWidgets::Core::DockWidgetdockByName (const QString &arg__1) const
 
void ensureAllFloatingWidgetsAreMorphed ()
 
KDDockWidgets::Core::DockWidgetfocusedDockWidget () const
 
KDDockWidgets::Core::GroupgroupInMDIResize () const
 
bool hasFloatingWindows () const
 
bool isEmpty (bool excludeBeingDeleted=false) const
 
bool isSane () const
 
bool itemIsInMainWindow (const KDDockWidgets::Core::Item *arg__1) const
 
KDDockWidgets::Core::LayoutlayoutForItem (const KDDockWidgets::Core::Item *arg__1) const
 
KDDockWidgets::Core::MainWindowmainWindowByName (const QString &arg__1) const
 
void registerDockWidget (KDDockWidgets::Core::DockWidget *arg__1)
 
void registerFloatingWindow (KDDockWidgets::Core::FloatingWindow *arg__1)
 
void registerGroup (KDDockWidgets::Core::Group *arg__1)
 
void registerLayout (KDDockWidgets::Core::Layout *arg__1)
 
void registerLayoutSaver ()
 
void registerMainWindow (KDDockWidgets::Core::MainWindow *arg__1)
 
KDDockWidgets::Core::SideBarsideBarForDockWidget (const KDDockWidgets::Core::DockWidget *arg__1) const
 
void unregisterDockWidget (KDDockWidgets::Core::DockWidget *arg__1)
 
void unregisterFloatingWindow (KDDockWidgets::Core::FloatingWindow *arg__1)
 
void unregisterGroup (KDDockWidgets::Core::Group *arg__1)
 
void unregisterLayout (KDDockWidgets::Core::Layout *arg__1)
 
void unregisterLayoutSaver ()
 
void unregisterMainWindow (KDDockWidgets::Core::MainWindow *arg__1)
 
- Public Member Functions inherited from KDDockWidgets::DockRegistry
 ~DockRegistry ()
 
bool affinitiesMatch (const Vector< QString > &affinities1, const Vector< QString > &affinities2) const
 
void checkSanityAll (bool dumpDebug=false)
 Calls Layout::checkSanity() on all layouts.
 
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
 
Q_INVOKABLE KDDockWidgets::Core::DockWidgetdockByName (const QString &, KDDockWidgets::DockRegistry::DockByNameFlags={}) const
 
Vector< QStringdockWidgetNames () 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::FloatingWindowfloatingWindowForHandle (Core::WId hwnd) const
 returns the FloatingWindow with handle hwnd
 
Core::FloatingWindowfloatingWindowForHandle (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::DockWidgetfocusedDockWidget () const
 
Core::GroupgroupInMDIResize () 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::LayoutlayoutForItem (const Core::Item *) const
 Returns the Layout where the specified item is in.
 
Vector< Core::Layout * > layouts () const
 returns the list of Layout instances
 
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::MainWindowmainWindowByName (const QString &) const
 
Core::MainWindowmainWindowForHandle (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< QStringmainWindowsNames () 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 registerLayout (Core::Layout *)
 
void registerLayoutSaver ()
 
void registerMainWindow (Core::MainWindow *)
 
Core::SideBarsideBarForDockWidget (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 unregisterLayout (Core::Layout *)
 
void unregisterLayoutSaver ()
 
void unregisterMainWindow (Core::MainWindow *)
 
- Public Member Functions inherited from KDDockWidgets::Core::EventFilterInterface
 EventFilterInterface ()=default
 
 EventFilterInterface (const EventFilterInterface &)=delete
 
virtual ~EventFilterInterface ()
 
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.
 
EventFilterInterfaceoperator= (const EventFilterInterface &)=delete
 

Static Public Member Functions

static KDDockWidgets::DockRegistryself ()
 
- Static Public Member Functions inherited from KDDockWidgets::DockRegistry
static DockRegistryself ()
 

Additional Inherited Members

- Public Types inherited from KDDockWidgets::DockRegistry
enum class  DockByNameFlag { None = 0 , ConsultRemapping = 1 , CreateIfNotFound }
 

Detailed Description

Definition at line 24 of file DockRegistry_c.h.

Constructor & Destructor Documentation

◆ ~DockRegistry_wrapper()

KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::~DockRegistry_wrapper ( )

Definition at line 144 of file DockRegistry_c.cpp.

Member Function Documentation

◆ checkSanityAll()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::checkSanityAll ( bool  dumpDebug = false)

Definition at line 32 of file DockRegistry_c.cpp.

References KDDockWidgets::DockRegistry::checkSanityAll().

◆ clear()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::clear ( )

Definition at line 36 of file DockRegistry_c.cpp.

References KDDockWidgets::DockRegistry::clear().

◆ containsDockWidget()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::containsDockWidget ( const QString uniqueName) const

Definition at line 40 of file DockRegistry_c.cpp.

◆ containsMainWindow()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::containsMainWindow ( const QString uniqueName) const

Definition at line 44 of file DockRegistry_c.cpp.

◆ dockByName()

KDDockWidgets::Core::DockWidget * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::dockByName ( const QString arg__1) const

Definition at line 48 of file DockRegistry_c.cpp.

◆ ensureAllFloatingWidgetsAreMorphed()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::ensureAllFloatingWidgetsAreMorphed ( )

◆ focusedDockWidget()

KDDockWidgets::Core::DockWidget * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::focusedDockWidget ( ) const

Definition at line 56 of file DockRegistry_c.cpp.

◆ groupInMDIResize()

KDDockWidgets::Core::Group * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::groupInMDIResize ( ) const

Definition at line 60 of file DockRegistry_c.cpp.

◆ hasFloatingWindows()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::hasFloatingWindows ( ) const

Definition at line 64 of file DockRegistry_c.cpp.

◆ isEmpty()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::isEmpty ( bool  excludeBeingDeleted = false) const

Definition at line 68 of file DockRegistry_c.cpp.

◆ isSane()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::isSane ( ) const

Definition at line 72 of file DockRegistry_c.cpp.

◆ itemIsInMainWindow()

bool KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::itemIsInMainWindow ( const KDDockWidgets::Core::Item *  arg__1) const

Definition at line 76 of file DockRegistry_c.cpp.

◆ layoutForItem()

KDDockWidgets::Core::Layout * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::layoutForItem ( const KDDockWidgets::Core::Item *  arg__1) const

Definition at line 80 of file DockRegistry_c.cpp.

◆ mainWindowByName()

KDDockWidgets::Core::MainWindow * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::mainWindowByName ( const QString arg__1) const

Definition at line 84 of file DockRegistry_c.cpp.

◆ registerDockWidget()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerDockWidget ( KDDockWidgets::Core::DockWidget arg__1)

◆ registerFloatingWindow()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerFloatingWindow ( KDDockWidgets::Core::FloatingWindow arg__1)

◆ registerGroup()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerGroup ( KDDockWidgets::Core::Group arg__1)

Definition at line 96 of file DockRegistry_c.cpp.

References KDDockWidgets::DockRegistry::registerGroup().

◆ registerLayout()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerLayout ( KDDockWidgets::Core::Layout arg__1)

Definition at line 100 of file DockRegistry_c.cpp.

References KDDockWidgets::DockRegistry::registerLayout().

◆ registerLayoutSaver()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerLayoutSaver ( )

◆ registerMainWindow()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::registerMainWindow ( KDDockWidgets::Core::MainWindow arg__1)

◆ self()

KDDockWidgets::DockRegistry * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::self ( )
static

Definition at line 112 of file DockRegistry_c.cpp.

Referenced by c_static_KDDockWidgets__DockRegistry__self().

◆ sideBarForDockWidget()

KDDockWidgets::Core::SideBar * KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::sideBarForDockWidget ( const KDDockWidgets::Core::DockWidget arg__1) const

Definition at line 116 of file DockRegistry_c.cpp.

◆ unregisterDockWidget()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterDockWidget ( KDDockWidgets::Core::DockWidget arg__1)

◆ unregisterFloatingWindow()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterFloatingWindow ( KDDockWidgets::Core::FloatingWindow arg__1)

◆ unregisterGroup()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterGroup ( KDDockWidgets::Core::Group arg__1)

◆ unregisterLayout()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterLayout ( KDDockWidgets::Core::Layout arg__1)

◆ unregisterLayoutSaver()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterLayoutSaver ( )

◆ unregisterMainWindow()

void KDDockWidgetsBindings_wrappersNS::DockRegistry_wrapper::unregisterMainWindow ( KDDockWidgets::Core::MainWindow arg__1)

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