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:

Public Member Functions
	InitialOption ()=default
	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
bool	preservesCurrentTab () const
bool	startsHidden () const

Public Attributes
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.

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 167 of file KDDockWidgets.h.

Constructor & Destructor Documentation

InitialOption() [1/5]

KDDockWidgets::InitialOption::InitialOption ( )

default

InitialOption() [2/5]

KDDockWidgets::InitialOption::InitialOption ( InitialVisibilityOption  v )

inline

Definition at line 173 of file KDDockWidgets.h.

InitialOption() [3/5]

KDDockWidgets::InitialOption::InitialOption ( Size  size )

inline

Definition at line 178 of file KDDockWidgets.h.

InitialOption() [4/5]

KDDockWidgets::InitialOption::InitialOption ( InitialVisibilityOption  v, Size  size  )

inline

Definition at line 183 of file KDDockWidgets.h.

InitialOption() [5/5]

KDDockWidgets::InitialOption::InitialOption ( DefaultSizeMode  mode )

inline

Definition at line 229 of file KDDockWidgets.h.

Member Function Documentation

hasPreferredLength()

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

inline

Definition at line 204 of file KDDockWidgets.h.

preferredLength()

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

inline

Definition at line 199 of file KDDockWidgets.h.

References Qt::Horizontal.

preservesCurrentTab()

bool KDDockWidgets::InitialOption::preservesCurrentTab ( ) const

inline

Definition at line 194 of file KDDockWidgets.h.

References KDDockWidgets::PreserveCurrentTab.

Referenced by c_KDDockWidgets__InitialOption__preservesCurrentTab(), and KDDockWidgets::Core::Group::insertWidget().

startsHidden()

bool KDDockWidgets::InitialOption::startsHidden ( ) const

inline

Definition at line 189 of file KDDockWidgets.h.

References KDDockWidgets::StartHidden.

Referenced by KDDockWidgets::Core::MDILayout::addDockWidget(), KDDockWidgets::Core::DropArea::addDockWidget(), KDDockWidgets::Core::DropArea::addWidget(), c_KDDockWidgets__InitialOption__startsHidden(), and KDDockWidgets::Core::Group::insertWidget().

Member Data Documentation

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 226 of file KDDockWidgets.h.

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 215 of file KDDockWidgets.h.

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

---

The documentation for this struct was generated from the following file:

• KDDockWidgets.h