KDDockWidgets API Documentation 2.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper Class Reference

#include <Layout_c.h>

Inheritance diagram for KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper:
Collaboration graph
[legend]

Public Types

typedef void(* Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent)
 

Public Member Functions

 Layout_wrapper (KDDockWidgets::Core::ViewType arg__1, KDDockWidgets::Core::View *arg__2)
 
 ~Layout_wrapper ()
 
KDDockWidgets::Core::DropAreaasDropArea () const
 
bool checkSanity () const
 
void clearLayout ()
 
bool containsGroup (const KDDockWidgets::Core::Group *arg__1) const
 
bool containsItem (const KDDockWidgets::Core::Item *arg__1) const
 
int count () const
 
void dumpLayout () const
 
KDDockWidgets::Core::FloatingWindowfloatingWindow () const
 
bool isInMainWindow (bool honourNesting=false) const
 
KDDockWidgets::Core::Item * itemForGroup (const KDDockWidgets::Core::Group *group) const
 
int layoutHeight () const
 
KDDockWidgets::Size layoutMaximumSizeHint () const
 
KDDockWidgets::Size layoutMinimumSize () const
 
KDDockWidgets::Size layoutSize () const
 
int layoutWidth () const
 
KDDockWidgets::Core::MainWindowmainWindow (bool honourNesting=false) const
 
int placeholderCount () const
 
void removeItem (KDDockWidgets::Core::Item *item)
 
void restorePlaceholder (KDDockWidgets::Core::DockWidget *dw, KDDockWidgets::Core::Item *arg__2, int tabIndex)
 
void setLayoutMinimumSize (KDDockWidgets::Size arg__1)
 
void setLayoutSize (KDDockWidgets::Size arg__1)
 
virtual void setParentView_impl (KDDockWidgets::Core::View *parent)
 
virtual void setParentView_impl_nocallback (KDDockWidgets::Core::View *parent)
 
void updateSizeConstraints ()
 
void viewAboutToBeDeleted ()
 
int visibleCount () const
 
- Public Member Functions inherited from KDDockWidgets::Core::Layout
 Layout (ViewType, View *)
 
 ~Layout ()
 
Core::DropAreaasDropArea () const
 
LayoutingHost * asLayoutingHost () const
 
Core::MDILayoutasMDILayout () 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 ()
 
virtual bool deserialize (const LayoutSaver::MultiSplitter &)
 
Vector< Core::DockWidget * > dockWidgets () const
 Returns the list of dock widgets contained in this layout.
 
void dumpLayout () const
 dumps the layout to stderr
 
Core::FloatingWindowfloatingWindow () 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::MainWindowmainWindow (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.
 
Viewview () const
 Returns the view associated with this controller, if any.
 
int width () const
 
std::shared_ptr< Viewwindow () const
 
int x () const
 
int y () const
 

Public Attributes

Callback_setParentView_impl m_setParentView_implCallback = nullptr
 

Additional Inherited Members

- Static Public Member Functions inherited from KDDockWidgets::Core::Layout
static LayoutfromLayoutingHost (LayoutingHost *)
 
- 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
 

Detailed Description

Definition at line 24 of file Layout_c.h.

Member Typedef Documentation

◆ Callback_setParentView_impl

typedef void(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent)

Definition at line 55 of file Layout_c.h.

Constructor & Destructor Documentation

◆ ~Layout_wrapper()

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::~Layout_wrapper ( )

Definition at line 146 of file Layout_c.cpp.

◆ Layout_wrapper()

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::Layout_wrapper ( KDDockWidgets::Core::ViewType  arg__1,
KDDockWidgets::Core::View arg__2 
)

Definition at line 33 of file Layout_c.cpp.

Member Function Documentation

◆ asDropArea()

KDDockWidgets::Core::DropArea * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::asDropArea ( ) const

Definition at line 37 of file Layout_c.cpp.

◆ checkSanity()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::checkSanity ( ) const

Definition at line 41 of file Layout_c.cpp.

◆ clearLayout()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::clearLayout ( )

Definition at line 45 of file Layout_c.cpp.

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

◆ containsGroup()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::containsGroup ( const KDDockWidgets::Core::Group arg__1) const

Definition at line 49 of file Layout_c.cpp.

◆ containsItem()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::containsItem ( const KDDockWidgets::Core::Item *  arg__1) const

Definition at line 53 of file Layout_c.cpp.

◆ count()

int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::count ( ) const

Definition at line 57 of file Layout_c.cpp.

◆ dumpLayout()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::dumpLayout ( ) const

Definition at line 61 of file Layout_c.cpp.

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

◆ floatingWindow()

KDDockWidgets::Core::FloatingWindow * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::floatingWindow ( ) const

Definition at line 65 of file Layout_c.cpp.

◆ isInMainWindow()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::isInMainWindow ( bool  honourNesting = false) const

Definition at line 69 of file Layout_c.cpp.

◆ itemForGroup()

KDDockWidgets::Core::Item * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::itemForGroup ( const KDDockWidgets::Core::Group group) const

Definition at line 73 of file Layout_c.cpp.

◆ layoutHeight()

int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::layoutHeight ( ) const

Definition at line 77 of file Layout_c.cpp.

◆ layoutMaximumSizeHint()

KDDockWidgets::Size KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::layoutMaximumSizeHint ( ) const

Definition at line 81 of file Layout_c.cpp.

◆ layoutMinimumSize()

KDDockWidgets::Size KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::layoutMinimumSize ( ) const

Definition at line 85 of file Layout_c.cpp.

◆ layoutSize()

KDDockWidgets::Size KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::layoutSize ( ) const

Definition at line 89 of file Layout_c.cpp.

◆ layoutWidth()

int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::layoutWidth ( ) const

Definition at line 93 of file Layout_c.cpp.

◆ mainWindow()

KDDockWidgets::Core::MainWindow * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::mainWindow ( bool  honourNesting = false) const

Definition at line 97 of file Layout_c.cpp.

◆ placeholderCount()

int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::placeholderCount ( ) const

Definition at line 101 of file Layout_c.cpp.

◆ removeItem()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::removeItem ( KDDockWidgets::Core::Item *  item)

Definition at line 105 of file Layout_c.cpp.

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

◆ restorePlaceholder()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::restorePlaceholder ( KDDockWidgets::Core::DockWidget dw,
KDDockWidgets::Core::Item *  arg__2,
int  tabIndex 
)

Definition at line 109 of file Layout_c.cpp.

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

◆ setLayoutMinimumSize()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::setLayoutMinimumSize ( KDDockWidgets::Size  arg__1)

◆ setLayoutSize()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::setLayoutSize ( KDDockWidgets::Size  arg__1)

Definition at line 117 of file Layout_c.cpp.

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

◆ setParentView_impl()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::setParentView_impl ( KDDockWidgets::Core::View parent)
virtual

◆ setParentView_impl_nocallback()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::setParentView_impl_nocallback ( KDDockWidgets::Core::View parent)
virtual

◆ updateSizeConstraints()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::updateSizeConstraints ( )

◆ viewAboutToBeDeleted()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::viewAboutToBeDeleted ( )

Definition at line 138 of file Layout_c.cpp.

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

◆ visibleCount()

int KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::visibleCount ( ) const

Definition at line 142 of file Layout_c.cpp.

Member Data Documentation

◆ m_setParentView_implCallback

Callback_setParentView_impl KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::Layout_wrapper::m_setParentView_implCallback = nullptr

Definition at line 56 of file Layout_c.h.

Referenced by setParentView_impl().


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