KDDockWidgets API Documentation 2.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
KDDockWidgets::InitialOption Struct Reference

Struct describing the preferred dock widget size and visibility when adding it to a layout. More...

#include <KDDockWidgets.h>

Inheritance diagram for KDDockWidgets::InitialOption:
Inheritance graph
[legend]

Public Member Functions

 InitialOption ()
 
 InitialOption (DefaultSizeMode mode)
 
 InitialOption (InitialVisibilityOption v)
 
 InitialOption (InitialVisibilityOption v, Size size)
 
 InitialOption (Size size)
 
bool hasPreferredLength (Qt::Orientation o) const
 
int preferredLength (Qt::Orientation o) const
 Returns preferred height if the container is vertical, otherwise preferred width.
 
bool preservesCurrentTab () const
 
bool startsHidden () const
 

Public Attributes

NeighbourSqueezeStrategy neighbourSqueezeStrategy = s_defaultNeighbourSqueezeStrategy
 
Size preferredSize
 Allows to control the size a dock widget should get when docked.
 
InitialVisibilityOption visibility = InitialVisibilityOption::StartVisible
 Allows a dock widget to be docked as hidden.
 

Static Public Attributes

static NeighbourSqueezeStrategy s_defaultNeighbourSqueezeStrategy = NeighbourSqueezeStrategy::AllNeighbours
 

Detailed Description

Struct describing the preferred dock widget size and visibility when adding it to a layout.

You can pass this to MainWindowBase::addDockWidget() to give an hint of your preferred size and visibility.

See below the documentation for InitialOption::visibility and InitialOption::preferredSize.

See also
MainWindowBase::addDockWidget()

Definition at line 175 of file KDDockWidgets.h.

Constructor & Destructor Documentation

◆ InitialOption() [1/5]

InitialOption::InitialOption ( )

Definition at line 60 of file KDDockWidgets.cpp.

◆ InitialOption() [2/5]

InitialOption::InitialOption ( InitialVisibilityOption  v)

Definition at line 64 of file KDDockWidgets.cpp.

◆ InitialOption() [3/5]

InitialOption::InitialOption ( Size  size)

Definition at line 69 of file KDDockWidgets.cpp.

◆ InitialOption() [4/5]

InitialOption::InitialOption ( InitialVisibilityOption  v,
Size  size 
)

Definition at line 74 of file KDDockWidgets.cpp.

◆ InitialOption() [5/5]

InitialOption::InitialOption ( DefaultSizeMode  mode)

Definition at line 80 of file KDDockWidgets.cpp.

Member Function Documentation

◆ hasPreferredLength()

bool KDDockWidgets::InitialOption::hasPreferredLength ( Qt::Orientation  o) const
inline

Definition at line 200 of file KDDockWidgets.h.

◆ preferredLength()

int KDDockWidgets::InitialOption::preferredLength ( Qt::Orientation  o) const
inline

Returns preferred height if the container is vertical, otherwise preferred width.

Definition at line 195 of file KDDockWidgets.h.

References Qt::Horizontal.

◆ preservesCurrentTab()

bool KDDockWidgets::InitialOption::preservesCurrentTab ( ) const
inline

◆ startsHidden()

bool KDDockWidgets::InitialOption::startsHidden ( ) const
inline

Member Data Documentation

◆ neighbourSqueezeStrategy

NeighbourSqueezeStrategy KDDockWidgets::InitialOption::neighbourSqueezeStrategy = s_defaultNeighbourSqueezeStrategy

Definition at line 225 of file KDDockWidgets.h.

◆ preferredSize

Size KDDockWidgets::InitialOption::preferredSize

Allows to control the size a dock widget should get when docked.

If an invalid or empty size is passed then KDDW's default heuristics are applied.

Note that usually only the width or the height will be honoured: For example, when adding a dock widget to the left then only the preferred width will be taken into account, as the height will simply fill the whole layout.

Definition at line 222 of file KDDockWidgets.h.

◆ s_defaultNeighbourSqueezeStrategy

NeighbourSqueezeStrategy InitialOption::s_defaultNeighbourSqueezeStrategy = NeighbourSqueezeStrategy::AllNeighbours
static

◆ visibility

InitialVisibilityOption KDDockWidgets::InitialOption::visibility = InitialVisibilityOption::StartVisible

Allows a dock widget to be docked as hidden.

Next time you call DockWidget::show() it will be shown at that place. This avoids flickering, as no show()/hide() workarounds are needed.

Definition at line 211 of file KDDockWidgets.h.

Referenced by KDDockWidgets::Core::DropArea::_addDockWidget().


The documentation for this struct 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