KDDockWidgets API Documentation 2.1
|
#include <DropArea_c.h>
Public Types | |
typedef void(* | Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent) |
Public Member Functions | |
DropArea_wrapper (KDDockWidgets::Core::View *parent, QFlags< KDDockWidgets::MainWindowOption > options, bool isMDIWrapper=false) | |
~DropArea_wrapper () | |
void | _addDockWidget (KDDockWidgets::Core::DockWidget *dw, KDDockWidgets::Location location, KDDockWidgets::Core::Item *relativeTo, KDDockWidgets::InitialOption initialOption) |
void | addDockWidget (KDDockWidgets::Core::DockWidget *dw, KDDockWidgets::Location location, KDDockWidgets::Core::DockWidget *relativeTo, KDDockWidgets::InitialOption initialOption={}) |
void | addMultiSplitter (KDDockWidgets::Core::DropArea *splitter, KDDockWidgets::Location location, KDDockWidgets::Core::Group *relativeToGroup=nullptr, KDDockWidgets::InitialOption option=KDDockWidgets::DefaultSizeMode::Fair) |
void | addWidget (KDDockWidgets::Core::View *widget, KDDockWidgets::Location location, KDDockWidgets::Core::Item *relativeToItem=nullptr, KDDockWidgets::InitialOption option=KDDockWidgets::DefaultSizeMode::Fair) |
KDDockWidgets::Core::Item * | centralFrame () const |
bool | containsDockWidget (KDDockWidgets::Core::DockWidget *arg__1) const |
KDDockWidgets::DropLocation | currentDropLocation () const |
KDDockWidgets::Core::DropIndicatorOverlay * | dropIndicatorOverlay () const |
bool | hasSingleFloatingGroup () const |
bool | hasSingleGroup () const |
bool | isMDIWrapper () const |
void | layoutEqually () |
void | layoutParentContainerEqually (KDDockWidgets::Core::DockWidget *arg__1) |
KDDockWidgets::Core::DockWidget * | mdiDockWidgetWrapper () const |
void | removeHover () |
virtual void | setParentView_impl (KDDockWidgets::Core::View *parent) |
virtual void | setParentView_impl_nocallback (KDDockWidgets::Core::View *parent) |
Public Member Functions inherited from KDDockWidgets::Core::DropArea | |
DropArea (View *parent, MainWindowOptions options, bool isMDIWrapper=false) | |
~DropArea () | |
void | _addDockWidget (DockWidget *dw, KDDockWidgets::Location location, Item *relativeTo, const InitialOption &initialOption) |
void | addDockWidget (DockWidget *dw, KDDockWidgets::Location location, DockWidget *relativeTo, const InitialOption &initialOption={}) |
void | addMultiSplitter (Core::DropArea *splitter, KDDockWidgets::Location location, Core::Group *relativeToGroup=nullptr, const InitialOption &option=DefaultSizeMode::Fair) |
void | addWidget (View *widget, KDDockWidgets::Location location, Core::Item *relativeToItem=nullptr, const InitialOption &option=DefaultSizeMode::Fair) |
Adds a widget to this MultiSplitter. | |
Vector< QString > | affinities () const |
Core::Item * | centralFrame () const |
bool | containsDockWidget (DockWidget *) const |
DropLocation | currentDropLocation () const |
bool | deserialize (const LayoutSaver::MultiSplitter &) override |
bool | drop (WindowBeingDragged *droppedWindow, Point globalPos) |
Called when a user drops a widget via DND. | |
DropIndicatorOverlay * | dropIndicatorOverlay () const |
Vector< Core::Group * > | groups () const |
bool | hasSingleFloatingGroup () const |
bool | hasSingleGroup () const |
DropLocation | hover (WindowBeingDragged *draggedWindow, Point globalPos) |
bool | isMDIWrapper () const |
void | layoutEqually () |
See docs for MainWindowBase::layoutEqually() | |
void | layoutEqually (Core::ItemBoxContainer *) |
overload that just resizes widgets within a sub-tree | |
void | layoutParentContainerEqually (DockWidget *) |
Core::DockWidget * | mdiDockWidgetWrapper () const |
Returns the helper dock widget for implementing DockWidgetOption_MDINestable. | |
int | numSideBySide_recursive (Qt::Orientation) const |
Returns the number of items layed-out horizontally or vertically But honours nesting. | |
Rect | rectForDrop (const WindowBeingDragged *wbd, KDDockWidgets::Location location, const Core::Item *relativeTo) const |
void | removeHover () |
Core::ItemBoxContainer * | rootItem () const |
Vector< Core::LayoutingSeparator * > | separators () const |
returns the list of separators | |
Public Member Functions inherited from KDDockWidgets::Core::Layout | |
Layout (ViewType, View *) | |
~Layout () | |
Core::DropArea * | asDropArea () const |
LayoutingHost * | asLayoutingHost () const |
Core::MDILayout * | asMDILayout () const |
bool | checkSanity () const |
Runs some sanity checks. Returns true if everything is OK. | |
void | clearLayout () |
clears the layout | |
bool | containsGroup (const Core::Group *) const |
Returns true if this layout contains the specified group. | |
bool | containsItem (const Core::Item *) const |
Returns true if this layout contains the specified item. | |
int | count () const |
Returns the number of Item objects in this layout. This includes non-visible (placeholder) Items too. | |
Layout::Private * | d_ptr () |
Vector< Core::DockWidget * > | dockWidgets () const |
Returns the list of dock widgets contained in this layout. | |
void | dumpLayout () const |
dumps the layout to stderr | |
Core::FloatingWindow * | floatingWindow () const |
Vector< Core::Group * > | groups () const |
Returns this list of Group objects contained in this layout. | |
bool | isInMainWindow (bool honourNesting=false) const |
Returns whether this layout is in a MainWindow. | |
Core::Item * | itemForGroup (const Core::Group *group) const |
returns the Item that holds group in this layout | |
Vector< Core::Item * > | items () const |
The list of items in this layout. | |
int | layoutHeight () const |
returns the contents height. Usually it's the same height as the respective parent MultiSplitter. | |
Size | layoutMaximumSizeHint () const |
returns the layout's maximum size hint | |
Size | layoutMinimumSize () const |
returns the layout's minimum size setLayoutMinimumSize | |
Size | layoutSize () const |
Returns the size of the contents. | |
int | layoutWidth () const |
returns the contents width. Usually it's the same width as the respective parent MultiSplitter. | |
Core::MainWindow * | mainWindow (bool honourNesting=false) const |
void | onCloseEvent (CloseEvent *) |
int | placeholderCount () const |
Returns the number of placeholder items in this layout. This is the same as count minus visibleCount. | |
void | removeItem (Core::Item *item) |
Removes an item from this MultiSplitter. | |
void | restorePlaceholder (Core::DockWidget *dw, Core::Item *, int tabIndex) |
restores the dockwidget dw to its previous position | |
Core::ItemContainer * | rootItem () const |
LayoutSaver::MultiSplitter | serialize () const |
void | setLayoutSize (Size) |
setter for the contents size The "contents size" is just the size() of this layout. However, since resizing QWidgets is async and we need it to be sync. As sometimes adding widgets will increase the MultiSplitter size (due to widget's min-size constraints). | |
void | updateSizeConstraints () |
Updates the min size of this layout. | |
void | viewAboutToBeDeleted () |
int | visibleCount () const |
Returns the number of visible Items in this layout. Which is count minus placeholderCount. | |
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 KDDockWidgets::Core::Group * | createCentralGroup (QFlags< KDDockWidgets::MainWindowOption > options) |
Static Public Member Functions inherited from KDDockWidgets::Core::DropArea | |
static Core::Group * | createCentralGroup (MainWindowOptions options) |
Static Public Member Functions inherited from KDDockWidgets::Core::Layout | |
static Layout * | fromLayoutingHost (LayoutingHost *) |
Public Attributes | |
Callback_setParentView_impl | m_setParentView_implCallback = nullptr |
Additional Inherited Members | |
Protected Member Functions inherited from KDDockWidgets::Core::Layout | |
Vector< Core::Group * > | groupsFrom (View *groupOrMultiSplitter) const |
returns the groups contained in groupOrMultiSplitter- If groupOrMultiSplitter- is a Group, it returns a list of 1 element, with that group If groupOrMultiSplitter- is a MultiSplitter then it returns a list of all groups it contains | |
void | setLayoutMinimumSize (Size) |
setter for the minimum size minimumSize | |
void | setRootItem (Core::ItemContainer *root) |
void | unrefOldPlaceholders (const Vector< Core::Group * > &groupsBeingAdded) const |
Removes unneeded placeholder items when adding new groups. | |
Protected Attributes inherited from KDDockWidgets::Core::Controller | |
bool | m_inDtor = false |
Definition at line 25 of file KDDWBindingsCore/DropArea_c.h.
typedef void(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent) |
Definition at line 48 of file KDDWBindingsCore/DropArea_c.h.
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::~DropArea_wrapper | ( | ) |
Definition at line 114 of file KDDWBindingsCore/DropArea_c.cpp.
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::DropArea_wrapper | ( | KDDockWidgets::Core::View * | parent, |
QFlags< KDDockWidgets::MainWindowOption > | options, | ||
bool | isMDIWrapper = false |
||
) |
Definition at line 33 of file KDDWBindingsCore/DropArea_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::_addDockWidget | ( | KDDockWidgets::Core::DockWidget * | dw, |
KDDockWidgets::Location | location, | ||
KDDockWidgets::Core::Item * | relativeTo, | ||
KDDockWidgets::InitialOption | initialOption | ||
) |
Definition at line 37 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::_addDockWidget().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::addDockWidget | ( | KDDockWidgets::Core::DockWidget * | dw, |
KDDockWidgets::Location | location, | ||
KDDockWidgets::Core::DockWidget * | relativeTo, | ||
KDDockWidgets::InitialOption | initialOption = {} |
||
) |
Definition at line 41 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::addDockWidget().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::addMultiSplitter | ( | KDDockWidgets::Core::DropArea * | splitter, |
KDDockWidgets::Location | location, | ||
KDDockWidgets::Core::Group * | relativeToGroup = nullptr , |
||
KDDockWidgets::InitialOption | option = KDDockWidgets::DefaultSizeMode::Fair |
||
) |
Definition at line 45 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::addMultiSplitter().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::addWidget | ( | KDDockWidgets::Core::View * | widget, |
KDDockWidgets::Location | location, | ||
KDDockWidgets::Core::Item * | relativeToItem = nullptr , |
||
KDDockWidgets::InitialOption | option = KDDockWidgets::DefaultSizeMode::Fair |
||
) |
Definition at line 49 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::addWidget().
KDDockWidgets::Core::Item * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::centralFrame | ( | ) | const |
Definition at line 53 of file KDDWBindingsCore/DropArea_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::containsDockWidget | ( | KDDockWidgets::Core::DockWidget * | arg__1 | ) | const |
Definition at line 57 of file KDDWBindingsCore/DropArea_c.cpp.
|
static |
Definition at line 61 of file KDDWBindingsCore/DropArea_c.cpp.
Referenced by c_static_KDDockWidgets__Core__DropArea__createCentralGroup_MainWindowOptions().
KDDockWidgets::DropLocation KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::currentDropLocation | ( | ) | const |
Definition at line 65 of file KDDWBindingsCore/DropArea_c.cpp.
KDDockWidgets::Core::DropIndicatorOverlay * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::dropIndicatorOverlay | ( | ) | const |
Definition at line 69 of file KDDWBindingsCore/DropArea_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::hasSingleFloatingGroup | ( | ) | const |
Definition at line 73 of file KDDWBindingsCore/DropArea_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::hasSingleGroup | ( | ) | const |
Definition at line 77 of file KDDWBindingsCore/DropArea_c.cpp.
bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::isMDIWrapper | ( | ) | const |
Definition at line 81 of file KDDWBindingsCore/DropArea_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::layoutEqually | ( | ) |
Definition at line 85 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::layoutEqually().
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::layoutParentContainerEqually | ( | KDDockWidgets::Core::DockWidget * | arg__1 | ) |
Definition at line 89 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::layoutParentContainerEqually().
KDDockWidgets::Core::DockWidget * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::mdiDockWidgetWrapper | ( | ) | const |
Definition at line 93 of file KDDWBindingsCore/DropArea_c.cpp.
void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::removeHover | ( | ) |
Definition at line 97 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::DropArea::removeHover().
|
virtual |
Reimplemented from KDDockWidgets::Core::Controller.
Definition at line 101 of file KDDWBindingsCore/DropArea_c.cpp.
References m_setParentView_implCallback, and KDDockWidgets::Core::Controller::setParentView_impl().
|
virtual |
Definition at line 110 of file KDDWBindingsCore/DropArea_c.cpp.
References KDDockWidgets::Core::Controller::setParentView_impl().
Referenced by c_KDDockWidgets__Core__DropArea__setParentView_impl_View().
Callback_setParentView_impl KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::DropArea_wrapper::m_setParentView_implCallback = nullptr |
Definition at line 49 of file KDDWBindingsCore/DropArea_c.h.
Referenced by setParentView_impl().