KDDockWidgets.h File Reference

File with KDDockWidgets namespace-level enums and methods. More...

#include "kddockwidgets/docks_export.h"
#include "QtCompat_p.h"

Include dependency graph for KDDockWidgets.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	KDDockWidgets::InitialOption
	Struct describing the preferred dock widget size and visibility when adding it to a layout. More...

Namespaces
namespace	KDDockWidgets
	Class to abstract QAction, so code still works with QtQuick and Flutter.
namespace	KDDockWidgets::Core
namespace	KDDockWidgets::Flutter
namespace	KDDockWidgets::QtCommon
namespace	KDDockWidgets::QtQuick
namespace	KDDockWidgets::QtWidgets

Macros
#define	KDDW_DELETE_COPY_CTOR(NAME)
#define	KDDW_UNUSED(name)   (( void )name);

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

Functions
template<typename T >
T	KDDockWidgets::bound (T minVal, T value, T maxVal)
bool	KDDockWidgets::fuzzyCompare (double a, double b, double epsilon=0.0001)
void DOCKS_EXPORT	KDDockWidgets::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.
DOCKS_EXPORT const char *	KDDockWidgets::spdlogLoggerName ()

Detailed Description

File with KDDockWidgets namespace-level enums and methods.

Author

Sérgio Martins <sergi.nosp@m.o.ma.nosp@m.rtins.nosp@m.@kda.nosp@m.b.com>

Definition in file KDDockWidgets.h.

Macro Definition Documentation

KDDW_DELETE_COPY_CTOR

#define KDDW_DELETE_COPY_CTOR

(

NAME

)

Value:

    NAME(const NAME &) = delete;            \
    NAME(const NAME &&) = delete;           \
    NAME &operator=(const NAME &) = delete; \
    NAME &operator=(const NAME &&) = delete;

Definition at line 438 of file KDDockWidgets.h.

KDDW_UNUSED

#define KDDW_UNUSED

(

name

)

(( void )name);

Definition at line 444 of file KDDockWidgets.h.