KDDockWidgets API Documentation 2.1
|
#include <FloatingWindow_c.h>
Public Types | |
typedef bool(* | Callback_isMDI) (void *) |
typedef bool(* | Callback_isWindow) (void *) |
typedef void(* | Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent) |
typedef KDDockWidgets::Core::DockWidget *(* | Callback_singleDockWidget) (void *) |
Public Member Functions | |
FloatingWindow_wrapper (KDDockWidgets::Core::Group *group, KDDockWidgets::Rect suggestedGeometry, KDDockWidgets::Core::MainWindow *parent=nullptr) | |
FloatingWindow_wrapper (KDDockWidgets::Rect suggestedGeometry, KDDockWidgets::Core::MainWindow *parent=nullptr) | |
~FloatingWindow_wrapper () | |
void | addDockWidget (KDDockWidgets::Core::DockWidget *arg__1, KDDockWidgets::Location location, KDDockWidgets::Core::DockWidget *relativeTo, KDDockWidgets::InitialOption arg__4={}) |
bool | allDockWidgetsHave (KDDockWidgets::DockWidgetOption arg__1) const |
bool | allDockWidgetsHave (KDDockWidgets::LayoutSaverOption arg__1) const |
bool | anyDockWidgetsHas (KDDockWidgets::DockWidgetOption arg__1) const |
bool | anyDockWidgetsHas (KDDockWidgets::LayoutSaverOption arg__1) const |
bool | anyNonClosable () const |
bool | anyNonDockable () const |
bool | beingDeleted () const |
KDDockWidgets::Margins | contentMargins () const |
KDDockWidgets::Rect | dragRect () const |
KDDockWidgets::Core::DropArea * | dropArea () const |
bool | hasSingleDockWidget () const |
bool | hasSingleGroup () const |
bool | isInDragArea (KDDockWidgets::Point globalPoint) const |
virtual bool | isMDI () const |
virtual bool | isMDI_nocallback () const |
bool | isUtilityWindow () const |
virtual bool | isWindow () const |
virtual bool | isWindow_nocallback () const |
KDDockWidgets::Core::Layout * | layout () const |
KDDockWidgets::Core::MainWindow * | mainWindow () const |
void | maybeCreateResizeHandler () |
KDDockWidgets::Core::DropArea * | multiSplitter () const |
void | scheduleDeleteLater () |
virtual void | setParentView_impl (KDDockWidgets::Core::View *parent) |
virtual void | setParentView_impl_nocallback (KDDockWidgets::Core::View *parent) |
void | setSuggestedGeometry (KDDockWidgets::Rect suggestedRect) |
KDDockWidgets::Core::Group * | singleFrame () const |
bool | supportsMaximizeButton () const |
bool | supportsMinimizeButton () const |
KDDockWidgets::Core::TitleBar * | titleBar () const |
void | updateTitleAndIcon () |
void | updateTitleBarVisibility () |
int | userType () const |
Public Member Functions inherited from KDDockWidgets::Core::FloatingWindow | |
FloatingWindow (Core::Group *group, Rect suggestedGeometry, MainWindow *parent=nullptr) | |
FloatingWindow (Rect suggestedGeometry, MainWindow *parent=nullptr, FloatingWindowFlags requestedFlags=FloatingWindowFlag::FromGlobalConfig) | |
virtual | ~FloatingWindow () override |
void | addDockWidget (DockWidget *, KDDockWidgets::Location location, DockWidget *relativeTo, const InitialOption &={}) |
Adds the dock widget to the specified location. | |
Vector< QString > | affinities () const |
bool | allDockWidgetsHave (DockWidgetOption) const |
Returns whether all dock widgets have the specified option set. | |
bool | allDockWidgetsHave (LayoutSaverOption) const |
Returns whether all dock widgets have the specified layout saver option set. | |
bool | anyDockWidgetsHas (DockWidgetOption) const |
Returns whether at least one dock widget has the specified option set. | |
bool | anyDockWidgetsHas (LayoutSaverOption) const |
Returns whether at least one dock widget has the specified layout saver option set. | |
bool | anyNonClosable () const |
bool | anyNonDockable () const |
bool | beingDeleted () const |
Returns whether a deleteLater has already been issued. | |
Margins | contentMargins () const |
Returns the contents margins. | |
bool | deserialize (const LayoutSaver::FloatingWindow &) |
Vector< DockWidget * > | dockWidgets () const |
Private * | dptr () const |
Rect | dragRect () const |
DropArea * | dropArea () const |
FloatingWindowFlags | floatingWindowFlags () const |
Returns the per-floating window flags. | |
void | focus (Qt::FocusReason reason) |
Core::Group::List | groups () const |
bool | hasSingleDockWidget () const |
checks if this FloatingWindow only has one dockwidget. This is a more specific case than hasSingleGroup(), it implies not only a single group, but that group must only have 1 dock widget. | |
bool | hasSingleGroup () const |
checks if this FloatingWindow only has one group. If true it means there's no side-by-side dock widgets here. There's only 1 group. Note that despite having only 1 group it can still have multiple DockWidgets, as they can be tabbed into the single group. | |
bool | isInDragArea (Point globalPoint) const |
Returns whether globalPoint is inside the title bar (or, when there's no title-bar, the draggable empty area of a tab bar) | |
bool | isMDI () const override |
bool | isUtilityWindow () const |
Returns whether this window is a tool window Tool windows don't usually appear in the task bar. | |
bool | isWindow () const override |
WindowState | lastWindowManagerState () const |
Layout * | layout () const |
Returns the Layout. | |
MainWindow * | mainWindow () const |
Returns the MainWindow which is the transient parent of this FloatingWindow Can be nullptr if you create dock widgets before the main window. Can also be some arbitrary value if you have more than one main window. | |
std::unique_ptr< WindowBeingDragged > | makeWindow () override |
void | maybeCreateResizeHandler () |
Core::DropArea * | multiSplitter () const |
Returns the MultiSplitter. | |
void | scheduleDeleteLater () |
Equivalent to deleteLater() but sets beingDeleted() to true. | |
LayoutSaver::FloatingWindow | serialize () const |
void | setLastWindowManagerState (WindowState) |
void | setSuggestedGeometry (Rect suggestedRect, SuggestedGeometryHints=SuggestedGeometryHint_None) |
Equivalent to setGeometry(), but the value might be adjusted. | |
Core::DockWidget * | singleDockWidget () const override final |
Core::Group * | singleFrame () const |
If this floating window has only one Frame, it's returned, otherwise nullptr. | |
bool | supportsMaximizeButton () const |
Returns whether this floating window supports showing a maximize button. | |
bool | supportsMinimizeButton () const |
Returns whether this floating window supports showing a minimize button. | |
Core::TitleBar * | titleBar () const |
Returns the title bar. | |
void | updateTitleAndIcon () |
updates the title and the icon | |
void | updateTitleBarVisibility () |
int | userType () const |
Public Member Functions inherited from KDDockWidgets::Core::Controller | |
Controller (ViewType type, View *) | |
virtual | ~Controller () |
bool | close () |
void | destroyLater () |
Controller::Private * | dptr () const |
Rect | geometry () const |
int | height () const |
bool | inDtor () const |
bool | is (ViewType) const |
Returns whether this controller is of the specified type. | |
bool | isFixedHeight () const |
bool | isFixedWidth () const |
bool | isVisible () const |
Point | mapToGlobal (Point) const |
Point | pos () const |
Rect | rect () const |
void | setParentView (View *parent) |
void | setVisible (bool) |
void | show () const |
Size | size () const |
ViewType | type () const |
Returns the type of this controller. | |
View * | view () const |
Returns the view associated with this controller, if any. | |
int | width () const |
std::shared_ptr< View > | window () const |
int | x () const |
int | y () const |
Static Public Member Functions | |
static void | ensureRectIsOnScreen (KDDockWidgets::Rect &geometry) |
Static Public Member Functions inherited from KDDockWidgets::Core::FloatingWindow | |
static void | ensureRectIsOnScreen (Rect &geometry) |
Public Attributes | |
Callback_isMDI | m_isMDICallback = nullptr |
Callback_isWindow | m_isWindowCallback = nullptr |
Callback_setParentView_impl | m_setParentView_implCallback = nullptr |
Callback_singleDockWidget | m_singleDockWidgetCallback = nullptr |
Additional Inherited Members | |
Static Public Attributes inherited from KDDockWidgets::Core::FloatingWindow | |
static Qt::WindowFlags | s_windowFlagsOverride = {} |
Allows the user app to specify which window flags to use, instead of KDDWs default ones Bugs caused by this won't be supported, as the amount of combinations that could go wrong can be open ended. | |
Protected Attributes inherited from KDDockWidgets::Core::FloatingWindow | |
WindowState | m_lastWindowManagerState = WindowState::None |
Core::TitleBar *const | m_titleBar |
Protected Attributes inherited from KDDockWidgets::Core::Controller | |
bool | m_inDtor = false |
Definition at line 25 of file FloatingWindow_c.h.
typedef bool(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::Callback_isMDI) (void *) |
Definition at line 66 of file FloatingWindow_c.h.
typedef bool(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::Callback_isWindow) (void *) |
Definition at line 68 of file FloatingWindow_c.h.
typedef void(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent) |
Definition at line 70 of file FloatingWindow_c.h.
typedef KDDockWidgets::Core::DockWidget *(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::Callback_singleDockWidget) (void *) |
Definition at line 72 of file FloatingWindow_c.h.
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::~FloatingWindow_wrapper | ( | ) |
Definition at line 196 of file FloatingWindow_c.cpp.
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::FloatingWindow_wrapper | ( | KDDockWidgets::Core::Group * | group, |
KDDockWidgets::Rect | suggestedGeometry, | ||
KDDockWidgets::Core::MainWindow * | parent = nullptr |
||
) |
Definition at line 33 of file FloatingWindow_c.cpp.
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::FloatingWindow_wrapper | ( | KDDockWidgets::Rect | suggestedGeometry, |
KDDockWidgets::Core::MainWindow * | parent = nullptr |
||
) |
Definition at line 37 of file FloatingWindow_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::addDockWidget | ( | KDDockWidgets::Core::DockWidget * | arg__1, |
KDDockWidgets::Location | location, | ||
KDDockWidgets::Core::DockWidget * | relativeTo, | ||
KDDockWidgets::InitialOption | arg__4 = {} |
||
) |
Definition at line 41 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::addDockWidget().
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::allDockWidgetsHave | ( | KDDockWidgets::DockWidgetOption | arg__1 | ) | const |
Definition at line 45 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::allDockWidgetsHave | ( | KDDockWidgets::LayoutSaverOption | arg__1 | ) | const |
Definition at line 49 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::anyDockWidgetsHas | ( | KDDockWidgets::DockWidgetOption | arg__1 | ) | const |
Definition at line 53 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::anyDockWidgetsHas | ( | KDDockWidgets::LayoutSaverOption | arg__1 | ) | const |
Definition at line 57 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::anyNonClosable | ( | ) | const |
Definition at line 61 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::anyNonDockable | ( | ) | const |
Definition at line 65 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::beingDeleted | ( | ) | const |
Definition at line 69 of file FloatingWindow_c.cpp.
KDDockWidgets::Margins KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::contentMargins | ( | ) | const |
Definition at line 73 of file FloatingWindow_c.cpp.
KDDockWidgets::Rect KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::dragRect | ( | ) | const |
Definition at line 77 of file FloatingWindow_c.cpp.
KDDockWidgets::Core::DropArea * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::dropArea | ( | ) | const |
Definition at line 81 of file FloatingWindow_c.cpp.
|
static |
Definition at line 85 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::ensureRectIsOnScreen(), and KDDockWidgets::Core::Controller::geometry().
Referenced by c_static_KDDockWidgets__Core__FloatingWindow__ensureRectIsOnScreen_Rect().
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::hasSingleDockWidget | ( | ) | const |
Definition at line 89 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::hasSingleGroup | ( | ) | const |
Definition at line 93 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::isInDragArea | ( | KDDockWidgets::Point | globalPoint | ) | const |
Definition at line 97 of file FloatingWindow_c.cpp.
|
virtual |
Definition at line 101 of file FloatingWindow_c.cpp.
References m_isMDICallback.
|
virtual |
Definition at line 110 of file FloatingWindow_c.cpp.
Referenced by c_KDDockWidgets__Core__FloatingWindow__isMDI().
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::isUtilityWindow | ( | ) | const |
Definition at line 114 of file FloatingWindow_c.cpp.
|
virtual |
Definition at line 118 of file FloatingWindow_c.cpp.
References m_isWindowCallback.
|
virtual |
Definition at line 127 of file FloatingWindow_c.cpp.
Referenced by c_KDDockWidgets__Core__FloatingWindow__isWindow().
KDDockWidgets::Core::Layout * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::layout | ( | ) | const |
Definition at line 131 of file FloatingWindow_c.cpp.
KDDockWidgets::Core::MainWindow * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::mainWindow | ( | ) | const |
Definition at line 135 of file FloatingWindow_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::maybeCreateResizeHandler | ( | ) |
Definition at line 139 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::maybeCreateResizeHandler().
KDDockWidgets::Core::DropArea * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::multiSplitter | ( | ) | const |
Definition at line 143 of file FloatingWindow_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::scheduleDeleteLater | ( | ) |
Definition at line 147 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::scheduleDeleteLater().
|
virtual |
Reimplemented from KDDockWidgets::Core::Controller.
Definition at line 151 of file FloatingWindow_c.cpp.
References m_setParentView_implCallback, and KDDockWidgets::Core::Controller::setParentView_impl().
|
virtual |
Definition at line 160 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::Controller::setParentView_impl().
Referenced by c_KDDockWidgets__Core__FloatingWindow__setParentView_impl_View().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::setSuggestedGeometry | ( | KDDockWidgets::Rect | suggestedRect | ) |
Definition at line 164 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::setSuggestedGeometry().
KDDockWidgets::Core::Group * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::singleFrame | ( | ) | const |
Definition at line 168 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::supportsMaximizeButton | ( | ) | const |
Definition at line 172 of file FloatingWindow_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::supportsMinimizeButton | ( | ) | const |
Definition at line 176 of file FloatingWindow_c.cpp.
KDDockWidgets::Core::TitleBar * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::titleBar | ( | ) | const |
Definition at line 180 of file FloatingWindow_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::updateTitleAndIcon | ( | ) |
Definition at line 184 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::updateTitleAndIcon().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::updateTitleBarVisibility | ( | ) |
Definition at line 188 of file FloatingWindow_c.cpp.
References KDDockWidgets::Core::FloatingWindow::updateTitleBarVisibility().
int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::userType | ( | ) | const |
Definition at line 192 of file FloatingWindow_c.cpp.
Callback_isMDI KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::m_isMDICallback = nullptr |
Definition at line 67 of file FloatingWindow_c.h.
Referenced by isMDI().
Callback_isWindow KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::m_isWindowCallback = nullptr |
Definition at line 69 of file FloatingWindow_c.h.
Referenced by isWindow().
Callback_setParentView_impl KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::m_setParentView_implCallback = nullptr |
Definition at line 71 of file FloatingWindow_c.h.
Referenced by setParentView_impl().
Callback_singleDockWidget KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::FloatingWindow_wrapper::m_singleDockWidgetCallback = nullptr |
Definition at line 73 of file FloatingWindow_c.h.