KDDockWidgets Namespace Reference

Class to abstract QAction, so code still works with QtQuick and Flutter. More...

Namespaces
namespace	Core
namespace	Debug
namespace	flutter
namespace	Flutter
namespace	QtCommon
namespace	QtQuick
namespace	QtWidgets
namespace	Tests

Classes
class	Config
	Singleton to allow to choose certain behaviours of the framework. More...
class	DockRegistry
class	DockWidgetInstantiator
	Indirection helper to instantiate dock widgets from QML. More...
struct	InitialOption
	Struct describing the preferred dock widget size and visibility when adding it to a layout. More...
class	LayoutSaver
	LayoutSaver allows to save or restore layouts. More...
class	LayoutSaverInstantiator
	A QObject wrapper around LayoutSaver so it can be used in QML. Use it from QML, like: LayoutSaver { id: saver } For C++, just use KDDockWidgets::LayoutSaver directly. More...
class	MainWindowInstantiator
	A wrapper to workaround the limitation that QtQuick can't pass arguments through MainWindow's ctor So instead, user instantiates a MainWindowWrapper in QML and calls init. More...
class	MainWindowMDIInstantiator
	A wrapper to workaround the limitation that QtQuick can't pass arguments through MainWindow's ctor So instead, user instantiates a MainWindowWrapper in QML and calls init. More...
class	SideBarButton

Typedefs
typedef KDDockWidgets::Core::DockWidget *(*	DockWidgetFactoryFunc) (const QString &name)
typedef bool(*	DragAboutToStartFunc) (Core::Draggable *draggable)
typedef void(*	DragEndedFunc) ()
typedef bool(*	DropIndicatorAllowedFunc) (DropLocation location, const Vector< Core::DockWidget * > &source, const Vector< Core::DockWidget * > &target, Core::DropArea *dropArea)
	Function to allow more granularity to disallow where widgets are dropped.
typedef KDDockWidgets::Core::MainWindow *(*	MainWindowFactoryFunc) (const QString &name, KDDockWidgets::MainWindowOptions)
template<typename T , typename... Args>
using	Vector = KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args... >

Enumerations
enum	AddingOption { AddingOption_None = 0 , AddingOption_StartHidden }
	Only here for source-compat with v1.2. Do not use. Use InitialVisibilityOption instead. More...
enum	CursorPosition {   CursorPosition_Undefined = 0 , CursorPosition_Left = 1 , CursorPosition_Right = 2 , CursorPosition_Top = 4 ,   CursorPosition_Bottom = 8 , CursorPosition_TopLeft = CursorPosition_Top | CursorPosition_Left , CursorPosition_TopRight = CursorPosition_Top | CursorPosition_Right , CursorPosition_BottomRight = CursorPosition_Bottom | CursorPosition_Right ,   CursorPosition_BottomLeft = CursorPosition_Bottom | CursorPosition_Left , CursorPosition_Horizontal = CursorPosition_Right | CursorPosition_Left , CursorPosition_Vertical = CursorPosition_Top | CursorPosition_Bottom , CursorPosition_All }
enum class	DefaultSizeMode { ItemSize , Fair , FairButFloor , NoDefaultSizeMode }
enum	DockWidgetOption {   DockWidgetOption_None = 0 , DockWidgetOption_NotClosable , DockWidgetOption_NotDockable = 2 , DockWidgetOption_DeleteOnClose = 4 ,   DockWidgetOption_MDINestable }
	DockWidget options to pass at construction time. More...
enum class	DropIndicatorType { Classic , Segmented , None }
enum	DropLocation {   DropLocation_None = 0 , DropLocation_Left = 1 , DropLocation_Top = 2 , DropLocation_Right = 4 ,   DropLocation_Bottom = 8 , DropLocation_Center = 16 , DropLocation_OutterLeft = 32 , DropLocation_OutterTop = 64 ,   DropLocation_OutterRight = 128 , DropLocation_OutterBottom = 256 , DropLocation_Inner , DropLocation_Outter ,   DropLocation_Horizontal , DropLocation_Vertical }
	Enum describing the different drop indicator types. More...
enum class	FloatingWindowFlag {   None = 0 , FromGlobalConfig = 1 , TitleBarHasMinimizeButton = 2 , TitleBarHasMaximizeButton = 4 ,   KeepAboveIfNotUtilityWindow = 8 , NativeTitleBar = 16 , HideTitleBarWhenTabsVisible = 32 , AlwaysTitleBarWhenFloating = 64 ,   DontUseParentForFloatingWindows = 128 , UseQtWindow = 256 , UseQtTool = 512 }
enum	FrameOption {   FrameOption_None = 0 , FrameOption_AlwaysShowsTabs = 1 , FrameOption_IsCentralFrame = 2 , FrameOption_IsOverlayed = 4 ,   FrameOption_NonDockable = 8 }
enum class	FrontendType { QtWidgets = 1 , QtQuick , Flutter }
enum class	IconPlace { TitleBar = 1 , TabBar = 2 , ToggleAction = 4 , All = ToggleAction | TitleBar | TabBar }
enum class	InitialVisibilityOption { StartVisible = 0 , StartHidden , PreserveCurrentTab }
enum class	LayoutSaverOption { None = 0 , Skip = 1 }
	Options which will affect LayoutSaver save/restore. More...
enum	Location {   Location_None , Location_OnLeft , Location_OnTop , Location_OnRight ,   Location_OnBottom }
enum	MainWindowOption { MainWindowOption_None = 0 , MainWindowOption_HasCentralFrame , MainWindowOption_MDI = 2 , MainWindowOption_HasCentralWidget }
enum	RestoreOption { RestoreOption_None = 0 , RestoreOption_RelativeToMainWindow , RestoreOption_AbsoluteFloatingDockWindows = 2 }
enum class	SideBarLocation {   None = 0 , North , East , West ,   South , Last }
	Each main window supports 4 sidebars. More...
enum	StackOption { StackOption_None = 0 , StackOption_DocumentMode = 1 }
enum	SuggestedGeometryHint { SuggestedGeometryHint_None , SuggestedGeometryHint_PreserveCenter = 1 , SuggestedGeometryHint_GeometryIsFromDocked = 2 }
enum class	TitleBarButtonType {   Close , Float , Minimize , Maximize ,   Normal , AutoHide , UnautoHide }
	describes a type of button you can have in the title bar More...
enum class	WindowState { None = 0 , Minimized = 1 , Maximized = 2 , FullScreen = 4 }

Functions
static FrameOptions	actualOptions (FrameOptions options)
template<typename T >
T	bound (T minVal, T value, T maxVal)
QString	cleanQRCFilename (const QString &filename)
static Core::Controller *	controllerForItem (QQuickItem *item)
static ViewFactory *	createDefaultViewFactory ()
static Core::DropIndicatorOverlay *	createDropIndicatorOverlay (Core::DropArea *dropArea)
void	from_json (const nlohmann::json &j, LayoutSaver::Layout &layout)
void	from_json (const nlohmann::json &j, LayoutSaver::ScreenInfo &screenInfo)
void	from_json (const nlohmann::json &json, LayoutSaver::DockWidget &dw)
void	from_json (const nlohmann::json &json, LayoutSaver::FloatingWindow &window)
void	from_json (const nlohmann::json &json, LayoutSaver::Group &f)
void	from_json (const nlohmann::json &json, LayoutSaver::MainWindow &mw)
void	from_json (const nlohmann::json &json, LayoutSaver::MultiSplitter &s)
void	from_json (const nlohmann::json &json, LayoutSaver::Placeholder &placeHolder)
void	from_json (const nlohmann::json &json, LayoutSaver::Position &pos)
void	from_json (const nlohmann::json &json, typename LayoutSaver::DockWidget::List &list)
bool	fuzzyCompare (double a, double b, double epsilon=0.0001)
static QString	iconName (DropLocation loc, bool active)
static QString	iconName (DropLocation loc, bool active)
void DOCKS_EXPORT	initFrontend (FrontendType)
	Initializes the desired frontend This function should be called before using any docking. Note that if you only built one frontend (by specifying for example -DKDDockWidgets_FRONTENDS=qtwidgets) then KDDW will call this automatically.
template<typename T >
T	jsonValue (const nlohmann::json &json, const char *name, const T &defaultValue)
Controller *	maybeCreateController (Controller *controller, ViewType type, View *view)
QtQuick::Platform *	plat ()
static MyProxy *	proxyStyle ()
void	registerQmlTypes ()
DOCKS_EXPORT const char *	spdlogLoggerName ()
static StackOptions	tabWidgetOptions (FrameOptions options)
void	to_json (nlohmann::json &j, const LayoutSaver::Layout &layout)
void	to_json (nlohmann::json &json, const LayoutSaver::DockWidget &dw)
void	to_json (nlohmann::json &json, const LayoutSaver::FloatingWindow &window)
void	to_json (nlohmann::json &json, const LayoutSaver::Group &f)
void	to_json (nlohmann::json &json, const LayoutSaver::MainWindow &mw)
void	to_json (nlohmann::json &json, const LayoutSaver::MultiSplitter &s)
void	to_json (nlohmann::json &json, const LayoutSaver::Placeholder &placeHolder)
void	to_json (nlohmann::json &json, const LayoutSaver::Position &pos)
void	to_json (nlohmann::json &json, const LayoutSaver::ScreenInfo &screenInfo)
void	to_json (nlohmann::json &json, const typename LayoutSaver::DockWidget::List &list)
template<typename Type >
void	to_json (nlohmann::json &json, const typename Type::List &list)
bool	windowManagerHasTranslucency ()

Variables
static qint64	s_nextId = 1

Detailed Description

Class to abstract QAction, so code still works with QtQuick and Flutter.

DockRegistry is a singleton that knows about all DockWidgets. It's used so we can restore layouts. It's a private implementation detail.

Typedef Documentation

DockWidgetFactoryFunc

typedef KDDockWidgets::Core::DockWidget *(* KDDockWidgets::DockWidgetFactoryFunc) (const QString &name)

Definition at line 35 of file Config.h.

DragAboutToStartFunc

typedef bool(* KDDockWidgets::DragAboutToStartFunc) (Core::Draggable *draggable)

Definition at line 37 of file Config.h.

DragEndedFunc

typedef void(* KDDockWidgets::DragEndedFunc) ()

Definition at line 38 of file Config.h.

DropIndicatorAllowedFunc

typedef bool(* KDDockWidgets::DropIndicatorAllowedFunc) (DropLocation location, const Vector< Core::DockWidget * > &source, const Vector< Core::DockWidget * > &target, Core::DropArea *dropArea)

Function to allow more granularity to disallow where widgets are dropped.

By default, widgets can be dropped to the outer and inner left/right/top/bottom and center. The client app can however provide a lambda via setDropIndicatorAllowedFunc to block (by returning false) any specific locations they desire.

Parameters

location	The drop indicator location to allow or disallow
source	The dock widgets being dragged
target	The dock widgets within an existing docked tab group
dropArea	The target drop area. Can belong to a MainWindow or a FloatingWindow.

Returns

true if the docking is allowed.

See also

setDropIndicatorAllowedFunc

Definition at line 52 of file Config.h.

MainWindowFactoryFunc

typedef KDDockWidgets::Core::MainWindow *(* KDDockWidgets::MainWindowFactoryFunc) (const QString &name, KDDockWidgets::MainWindowOptions)

Definition at line 36 of file Config.h.

Vector

template<typename T , typename... Args>

using KDDockWidgets::Vector = typedef KDToolBox::StlContainerAdaptor::StdVectorAdaptor<T, Args...>

Definition at line 430 of file KDStlContainerAdaptor.h.

Enumeration Type Documentation

AddingOption

enum KDDockWidgets::AddingOption

Only here for source-compat with v1.2. Do not use. Use InitialVisibilityOption instead.

Enumerator
AddingOption_None
AddingOption_StartHidden

Definition at line 144 of file KDDockWidgets.h.

CursorPosition

enum KDDockWidgets::CursorPosition

Enumerator
CursorPosition_Undefined
CursorPosition_Left
CursorPosition_Right
CursorPosition_Top
CursorPosition_Bottom
CursorPosition_TopLeft
CursorPosition_TopRight
CursorPosition_BottomRight
CursorPosition_BottomLeft
CursorPosition_Horizontal
CursorPosition_Vertical
CursorPosition_All

Definition at line 314 of file KDDockWidgets.h.

DefaultSizeMode

enum class KDDockWidgets::DefaultSizeMode

strong

Enumerator
ItemSize	Simply uses the Item::size() of the item being added. Actual used size might be smaller if our window isn't big enough.
Fair	Gives an equal relative size as the items that are already in the layout.
FairButFloor	Equal to fair, but if the item we're adding is smaller than the fair suggestion, then that small size is used.
NoDefaultSizeMode	Don't do any sizing.

Definition at line 132 of file KDDockWidgets.h.

DockWidgetOption

enum KDDockWidgets::DockWidgetOption

DockWidget options to pass at construction time.

Enumerator
DockWidgetOption_None	No option, the default.
DockWidgetOption_NotClosable	The DockWidget can't be closed on the [x], only programmatically.
DockWidgetOption_NotDockable	The DockWidget can't be docked, it's always floating.
DockWidgetOption_DeleteOnClose	Deletes the DockWidget when closed.
DockWidgetOption_MDINestable	EXPERIMENTAL. When this dock widget is being shown in a MDI area it will also allow other dock widgets to be dropped to its sides and tabbed Usually Each MDI "window" corresponds to one DockWidget, with this option each "window" will have a layout with 1 or more dock widgets Run "examples/qtwidgets_mdi_with_docking -n" to see it in action

Definition at line 88 of file KDDockWidgets.h.

DropIndicatorType

enum class KDDockWidgets::DropIndicatorType

strong

Enumerator
Classic	The default.
Segmented	Segmented indicators.
None	Don't show any drop indicators while dragging.

Definition at line 252 of file KDDockWidgets.h.

DropLocation

enum KDDockWidgets::DropLocation

Enum describing the different drop indicator types.

Enumerator
DropLocation_None
DropLocation_Left
DropLocation_Top
DropLocation_Right
DropLocation_Bottom
DropLocation_Center
DropLocation_OutterLeft
DropLocation_OutterTop
DropLocation_OutterRight
DropLocation_OutterBottom
DropLocation_Inner
DropLocation_Outter
DropLocation_Horizontal
DropLocation_Vertical

Definition at line 291 of file KDDockWidgets.h.

FloatingWindowFlag

enum class KDDockWidgets::FloatingWindowFlag

strong

Enumerator
None
FromGlobalConfig
TitleBarHasMinimizeButton
TitleBarHasMaximizeButton
KeepAboveIfNotUtilityWindow
NativeTitleBar
HideTitleBarWhenTabsVisible
AlwaysTitleBarWhenFloating
DontUseParentForFloatingWindows
UseQtWindow
UseQtTool

Definition at line 353 of file KDDockWidgets.h.

FrameOption

enum KDDockWidgets::FrameOption

Enumerator
FrameOption_None
FrameOption_AlwaysShowsTabs
FrameOption_IsCentralFrame
FrameOption_IsOverlayed
FrameOption_NonDockable

Definition at line 334 of file KDDockWidgets.h.

FrontendType

enum class KDDockWidgets::FrontendType

strong

Enumerator
QtWidgets
QtQuick
Flutter

Definition at line 121 of file KDDockWidgets.h.

IconPlace

enum class KDDockWidgets::IconPlace

strong

Enumerator
TitleBar
TabBar
ToggleAction
All

Definition at line 112 of file KDDockWidgets.h.

InitialVisibilityOption

enum class KDDockWidgets::InitialVisibilityOption

strong

Enumerator
StartVisible	The dock widget is made visible when docked.
StartHidden	Don't show the dock widget when adding it.
PreserveCurrentTab	When adding as tabbed, don't change the current index.

Definition at line 150 of file KDDockWidgets.h.

LayoutSaverOption

enum class KDDockWidgets::LayoutSaverOption

strong

Options which will affect LayoutSaver save/restore.

Enumerator
None	Just use the defaults.
Skip	The dock widget won't participate in save/restore. Currently only available for floating windows.

Definition at line 105 of file KDDockWidgets.h.

Location

enum KDDockWidgets::Location

Enumerator
Location_None
Location_OnLeft
Location_OnTop	‍Left docking location
Location_OnRight	‍Top docking location
Location_OnBottom	‍Right docking location ‍Bottom docking location

Definition at line 64 of file KDDockWidgets.h.

MainWindowOption

enum KDDockWidgets::MainWindowOption

Enumerator
MainWindowOption_None
MainWindowOption_HasCentralFrame	‍No option set
MainWindowOption_MDI	‍Makes the MainWindow always have a central group, for tabbing documents
MainWindowOption_HasCentralWidget	‍The layout will be MDI. DockWidgets can have arbitrary positions, not restricted by any layout

Definition at line 73 of file KDDockWidgets.h.

RestoreOption

enum KDDockWidgets::RestoreOption

Enumerator
RestoreOption_None
RestoreOption_RelativeToMainWindow	Skips restoring the main window geometry and the restored dock widgets will use relative sizing. Loading layouts won't change the main window geometry and just use whatever the user has at the moment.
RestoreOption_AbsoluteFloatingDockWindows	Skips scaling of floating dock windows relative to the main window.

Definition at line 241 of file KDDockWidgets.h.

SideBarLocation

enum class KDDockWidgets::SideBarLocation

strong

Each main window supports 4 sidebars.

Enumerator
None
North
East
West
South
Last

Definition at line 269 of file KDDockWidgets.h.

StackOption

enum KDDockWidgets::StackOption

Enumerator
StackOption_None
StackOption_DocumentMode

Definition at line 345 of file KDDockWidgets.h.

SuggestedGeometryHint

enum KDDockWidgets::SuggestedGeometryHint

Enumerator
SuggestedGeometryHint_None
SuggestedGeometryHint_PreserveCenter
SuggestedGeometryHint_GeometryIsFromDocked

Definition at line 260 of file KDDockWidgets.h.

TitleBarButtonType

enum class KDDockWidgets::TitleBarButtonType

strong

describes a type of button you can have in the title bar

Enumerator
Close
Float
Minimize
Maximize
Normal
AutoHide
UnautoHide

Definition at line 279 of file KDDockWidgets.h.

WindowState

enum class KDDockWidgets::WindowState

strong

Enumerator
None
Minimized
Maximized
FullScreen

Definition at line 369 of file KDDockWidgets.h.

Function Documentation

actualOptions()

static FrameOptions KDDockWidgets::actualOptions ( FrameOptions  options )

static

Definition at line 61 of file core/Group.cpp.

References KDDockWidgets::Config::Flag_AlwaysShowTabs, FrameOption_AlwaysShowsTabs, FrameOption_IsCentralFrame, and KDDockWidgets::Config::self().

bound()

template<typename T >

T KDDockWidgets::bound	(	T	minVal,
		T	value,
		T	maxVal
	)

Definition at line 415 of file KDDockWidgets.h.

cleanQRCFilename()

QString KDDockWidgets::cleanQRCFilename ( const QString &  filename )

inline

Definition at line 829 of file qtquick/views/View.cpp.

References QString::right(), QString::size(), and QString::startsWith().

Referenced by KDDockWidgets::QtQuick::View::createItem().

controllerForItem()

static Core::Controller * KDDockWidgets::controllerForItem ( QQuickItem *  item )

static

Definition at line 43 of file qtquick/views/ViewWrapper.cpp.

References KDDockWidgets::Core::DockWidget, KDDockWidgets::Core::DropArea, KDDockWidgets::Core::DropAreaIndicatorOverlay, KDDockWidgets::Core::FIRST, KDDockWidgets::Core::FloatingWindow, KDDockWidgets::Core::Frame, KDDockWidgets::Core::LAST, KDDockWidgets::Core::LayoutItem, KDDockWidgets::Core::MainWindow, KDDockWidgets::Core::MDILayout, KDDockWidgets::Core::None, KDDockWidgets::Core::RubberBand, KDDockWidgets::Core::Separator, KDDockWidgets::Core::SideBar, KDDockWidgets::Core::Stack, KDDockWidgets::Core::TabBar, KDDockWidgets::Core::TitleBar, and KDDockWidgets::Core::ViewWrapper.

createDefaultViewFactory()

static ViewFactory * KDDockWidgets::createDefaultViewFactory ( )

static

Definition at line 38 of file Config.cpp.

References KDDockWidgets::Core::Platform::instance().

createDropIndicatorOverlay()

static Core::DropIndicatorOverlay * KDDockWidgets::createDropIndicatorOverlay ( Core::DropArea *  dropArea )

static

Definition at line 45 of file core/DropArea.cpp.

References Classic, None, KDDockWidgets::Core::ViewFactory::s_dropIndicatorType, and Segmented.

from_json() [1/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	j,
		LayoutSaver::Layout &	layout
	)

Definition at line 744 of file LayoutSaver.cpp.

from_json() [2/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	j,
		LayoutSaver::ScreenInfo &	screenInfo
	)

Definition at line 282 of file LayoutSaver.cpp.

from_json() [3/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::DockWidget &	dw
	)

Definition at line 333 of file LayoutSaver.cpp.

References jsonValue().

from_json() [4/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::FloatingWindow &	window
	)

Definition at line 254 of file LayoutSaver.cpp.

References FromGlobalConfig, QString::isEmpty(), and jsonValue().

from_json() [5/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::Group &	f
	)

Definition at line 125 of file LayoutSaver.cpp.

References jsonValue().

Referenced by from_json().

from_json() [6/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::MainWindow &	mw
	)

Definition at line 202 of file LayoutSaver.cpp.

References East, jsonValue(), North, QString::push_back(), South, and West.

from_json() [7/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::MultiSplitter &	s
	)

Definition at line 158 of file LayoutSaver.cpp.

References QString::fromStdString(), and jsonValue().

from_json() [8/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::Placeholder &	placeHolder
	)

Definition at line 300 of file LayoutSaver.cpp.

References jsonValue().

from_json() [9/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		LayoutSaver::Position &	pos
	)

Definition at line 317 of file LayoutSaver.cpp.

References jsonValue().

from_json() [10/10]

void KDDockWidgets::from_json	(	const nlohmann::json &	json,
		typename LayoutSaver::DockWidget::List &	list
	)

Definition at line 353 of file LayoutSaver.cpp.

References from_json().

fuzzyCompare()

bool KDDockWidgets::fuzzyCompare ( double  a, double  b, double  epsilon = 0.0001  )

inline

Definition at line 420 of file KDDockWidgets.h.

Referenced by c_static_KDDockWidgets__fuzzyCompare_double_double_double().

iconName() [1/2]

static QString KDDockWidgets::iconName ( DropLocation  loc, bool  active  )

static

Definition at line 28 of file qtquick/views/ClassicIndicatorsWindow.cpp.

References DropLocation_Bottom, DropLocation_Center, DropLocation_Horizontal, DropLocation_Inner, DropLocation_Left, DropLocation_None, DropLocation_Outter, DropLocation_OutterBottom, DropLocation_OutterLeft, DropLocation_OutterRight, DropLocation_OutterTop, DropLocation_Right, DropLocation_Top, and DropLocation_Vertical.

Referenced by KDDockWidgets::QtQuick::ViewFactory::iconForButtonType(), KDDockWidgets::QtWidgets::ViewFactory::iconForButtonType(), and KDDockWidgets::QtQuick::ClassicDropIndicatorOverlay::iconName().

iconName() [2/2]

static QString KDDockWidgets::iconName ( DropLocation  loc, bool  active  )

static

Definition at line 68 of file qtwidgets/views/ClassicIndicatorsWindow.cpp.

References DropLocation_Bottom, DropLocation_Center, DropLocation_Horizontal, DropLocation_Inner, DropLocation_Left, DropLocation_None, DropLocation_Outter, DropLocation_OutterBottom, DropLocation_OutterLeft, DropLocation_OutterRight, DropLocation_OutterTop, DropLocation_Right, DropLocation_Top, and DropLocation_Vertical.

initFrontend()

void KDDockWidgets::initFrontend

(

FrontendType

type

)

Initializes the desired frontend This function should be called before using any docking. Note that if you only built one frontend (by specifying for example -DKDDockWidgets_FRONTENDS=qtwidgets) then KDDW will call this automatically.

Definition at line 29 of file KDDockWidgets.cpp.

Referenced by c_static_KDDockWidgets__initFrontend_FrontendType(), KDDockWidgets::Core::Platform::instance(), and main().

jsonValue()

template<typename T >

T KDDockWidgets::jsonValue	(	const nlohmann::json &	json,
		const char *	name,
		const T &	defaultValue
	)

Definition at line 96 of file LayoutSaver.cpp.

Referenced by from_json(), from_json(), from_json(), from_json(), from_json(), from_json(), and from_json().

maybeCreateController()

Controller * KDDockWidgets::maybeCreateController	(	Controller *	controller,
		ViewType	type,
		View *	view
	)

Definition at line 39 of file core/View.cpp.

plat()

QtQuick::Platform * KDDockWidgets::plat ( )

inline

Definition at line 84 of file qtquick/Platform.h.

References KDDockWidgets::Core::Platform::instance().

Referenced by KDDockWidgets::QtQuick::ClassicDropIndicatorOverlay::ClassicDropIndicatorOverlay(), and KDDockWidgets::QtQuick::RubberBand::RubberBand().

proxyStyle()

static MyProxy * KDDockWidgets::proxyStyle ( )

static

Definition at line 61 of file qtwidgets/views/TabBar.cpp.

Referenced by KDDockWidgets::QtWidgets::TabBar::TabBar().

registerQmlTypes()

void KDDockWidgets::registerQmlTypes

(

)

Definition at line 21 of file QmlTypes.cpp.

spdlogLoggerName()

const char * KDDockWidgets::spdlogLoggerName

(

)

Returns the name of the logger used by KDDW You can pass this name to spdlog::get() and change log level

Definition at line 51 of file KDDockWidgets.cpp.

Referenced by c_static_KDDockWidgets__spdlogLoggerName().

tabWidgetOptions()

static StackOptions KDDockWidgets::tabWidgetOptions ( FrameOptions  options )

static

Definition at line 70 of file core/Group.cpp.

References FrameOption_NonDockable, StackOption_DocumentMode, and StackOption_None.

to_json() [1/11]

void KDDockWidgets::to_json	(	nlohmann::json &	j,
		const LayoutSaver::Layout &	layout
	)

Definition at line 734 of file LayoutSaver.cpp.

to_json() [2/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::DockWidget &	dw
	)

Definition at line 326 of file LayoutSaver.cpp.

to_json() [3/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::FloatingWindow &	window
	)

Definition at line 237 of file LayoutSaver.cpp.

to_json() [4/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::Group &	f
	)

Definition at line 114 of file LayoutSaver.cpp.

to_json() [5/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::MainWindow &	mw
	)

Definition at line 179 of file LayoutSaver.cpp.

References East, KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::isEmpty(), North, South, and West.

to_json() [6/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::MultiSplitter &	s
	)

Definition at line 148 of file LayoutSaver.cpp.

to_json() [7/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::Placeholder &	placeHolder
	)

Definition at line 290 of file LayoutSaver.cpp.

to_json() [8/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::Position &	pos
	)

Definition at line 308 of file LayoutSaver.cpp.

to_json() [9/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const LayoutSaver::ScreenInfo &	screenInfo
	)

Definition at line 275 of file LayoutSaver.cpp.

to_json() [10/11]

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const typename LayoutSaver::DockWidget::List &	list
	)

Definition at line 346 of file LayoutSaver.cpp.

to_json() [11/11]

template<typename Type >

void KDDockWidgets::to_json	(	nlohmann::json &	json,
		const typename Type::List &	list
	)

Definition at line 107 of file LayoutSaver.cpp.

windowManagerHasTranslucency()

bool KDDockWidgets::windowManagerHasTranslucency ( )

inline

Definition at line 35 of file qtwidgets/views/ClassicIndicatorsWindow.cpp.

References KDDockWidgets::Config::InternalFlag_DisableTranslucency, and KDDockWidgets::Config::self().

Variable Documentation

s_nextId

qint64 KDDockWidgets::s_nextId = 1

static

Definition at line 37 of file core/View.cpp.