QxDock::DockManager类 参考

The dock manager that maintains the complete docking system. 更多...

#include <qxdock/dockmanager.h>

Public 类型
enum	ConfigFlag {   ActiveTabHasCloseButton = 0x0001 , DockAreaHasCloseButton = 0x0002 , DockAreaCloseButtonClosesTab = 0x0004 , OpaqueSplitterResize = 0x0008 ,   XmlAutoFormattingEnabled = 0x0010 , XmlCompressionEnabled = 0x0020 , TabCloseButtonIsToolButton = 0x0040 , AllTabsHaveCloseButton = 0x0080 ,   RetainTabSizeWhenCloseButtonHidden = 0x0100 , DragPreviewIsDynamic = 0x0400 , DragPreviewShowsContentPixmap = 0x0800 , DragPreviewHasWindowFrame = 0x1000 ,   AlwaysShowTabs = 0x2000 , DockAreaHasUndockButton = 0x4000 , DockAreaHasTabsMenuButton = 0x8000 , DockAreaHideDisabledButtons = 0x10000 ,   DockAreaDynamicTabsMenuButtonVisibility = 0x20000 , FloatingContainerHasWidgetTitle = 0x40000 , FloatingContainerHasWidgetIcon = 0x80000 , HideSingleCentralWidgetTitleBar = 0x100000 ,   FocusHighlighting = 0x200000 , EqualSplitOnInsertion = 0x400000 , FloatingContainerForceNativeTitleBar = 0x800000 , FloatingContainerForceQWidgetTitleBar = 0x1000000 ,   MiddleMouseButtonClosesTab = 0x2000000 , DisableTabTextEliding = 0x4000000 , ShowTabTextOnlyForActiveTab = 0x8000000 , DefaultDockAreaButtons = DockAreaHasCloseButton | DockAreaHasUndockButton | DockAreaHasTabsMenuButton ,   DefaultBaseConfig , DefaultOpaqueConfig = DefaultBaseConfig | OpaqueSplitterResize | DragPreviewShowsContentPixmap , DefaultNonOpaqueConfig = DefaultBaseConfig | DragPreviewShowsContentPixmap , NonOpaqueWithWindowFrame = DefaultNonOpaqueConfig | DragPreviewHasWindowFrame }
	These global configuration flags configure some global dock manager settings. 更多...
enum	AutoHideFlag {   AutoHideFeatureEnabled = 0x01 , DockAreaHasAutoHideButton = 0x02 , AutoHideButtonTogglesArea = 0x04 , AutoHideButtonCheckable = 0x08 ,   AutoHideSideBarsIconOnly = 0x10 , AutoHideShowOnMouseOver = 0x20 , AutoHideCloseButtonCollapsesDock = 0x40 , AutoHideHasCloseButton = 0x80 ,   AutoHideHasMinimizeButton = 0x100 , DefaultAutoHideConfig = AutoHideFeatureEnabled | DockAreaHasAutoHideButton | AutoHideHasMinimizeButton }
	These global configuration flags configure some dock manager auto hide settings Set the dock manager flags, before you create the dock manager instance. 更多...

Public 成员函数
	DockManager ()
	~DockManager ()

静态 Public 成员函数
static ConfigFlags	configFlags ()
static void	setConfigFlags (const ConfigFlags flags)
static void	setConfigFlag (ConfigFlag flag, bool on=true)
static bool	testConfigFlag (ConfigFlag flag)
static AutoHideFlags	autoHideConfigFlags ()
static void	setAutoHideConfigFlags (const AutoHideFlags flags)
static void	setAutoHideConfigFlag (AutoHideFlag flag, bool on=true)
static bool	testAutoHideConfigFlag (AutoHideFlag flag)
static DockIconProvider &	iconProvider ()
	Returns the global icon provider.
static int	startDragDistance ()
	The distance the user needs to move the mouse with the left button hold down before a dock widget start floating
template<class QWidgetPtr >
static void	setWidgetFocus (QWidgetPtr widget)
static QString	floatingContainersTitle ()
	Returns the title used by all FloatingContainer that does not reflect the title of the current dock widget.
static void	setFloatingContainersTitle (const QString &title)
	Set a custom title for all FloatingContainer that does not reflect the title of the current dock widget.

详细描述

The dock manager that maintains the complete docking system.

With the configuration flags you can globally control the functionality of the docking system.

在文件 dockmanager.h 第 19 行定义.

成员枚举类型说明

AutoHideFlag

enum QxDock::DockManager::AutoHideFlag

These global configuration flags configure some dock manager auto hide settings Set the dock manager flags, before you create the dock manager instance.

枚举值
AutoHideFeatureEnabled
DockAreaHasAutoHideButton
AutoHideButtonTogglesArea
AutoHideButtonCheckable
AutoHideSideBarsIconOnly
AutoHideShowOnMouseOver
AutoHideCloseButtonCollapsesDock
AutoHideHasCloseButton
AutoHideHasMinimizeButton
DefaultAutoHideConfig

在文件 dockmanager.h 第 127 行定义.

ConfigFlag

enum QxDock::DockManager::ConfigFlag

These global configuration flags configure some global dock manager settings.

Set the dock manager flags, before you create the dock manager instance.

枚举值
ActiveTabHasCloseButton
DockAreaHasCloseButton
DockAreaCloseButtonClosesTab
OpaqueSplitterResize
XmlAutoFormattingEnabled
XmlCompressionEnabled
TabCloseButtonIsToolButton
AllTabsHaveCloseButton
RetainTabSizeWhenCloseButtonHidden
DragPreviewIsDynamic
DragPreviewShowsContentPixmap
DragPreviewHasWindowFrame
AlwaysShowTabs
DockAreaHasUndockButton
DockAreaHasTabsMenuButton
DockAreaHideDisabledButtons
DockAreaDynamicTabsMenuButtonVisibility
FloatingContainerHasWidgetTitle
FloatingContainerHasWidgetIcon
HideSingleCentralWidgetTitleBar
FocusHighlighting
EqualSplitOnInsertion
FloatingContainerForceNativeTitleBar
FloatingContainerForceQWidgetTitleBar
MiddleMouseButtonClosesTab
DisableTabTextEliding
ShowTabTextOnlyForActiveTab
DefaultDockAreaButtons
DefaultBaseConfig
DefaultOpaqueConfig
DefaultNonOpaqueConfig
NonOpaqueWithWindowFrame

在文件 dockmanager.h 第 26 行定义.

构造及析构函数说明

DockManager()

QxDock::DockManager::DockManager

(

)

在文件 dockmanager.cpp 第 30 行定义.

~DockManager()

QxDock::DockManager::~DockManager

(

)

在文件 dockmanager.cpp 第 35 行定义.

成员函数说明

autoHideConfigFlags()

DockManager::AutoHideFlags QxDock::DockManager::autoHideConfigFlags ( )

static

在文件 dockmanager.cpp 第 60 行定义.

configFlags()

DockManager::ConfigFlags QxDock::DockManager::configFlags ( )

static

在文件 dockmanager.cpp 第 40 行定义.

floatingContainersTitle()

QString QxDock::DockManager::floatingContainersTitle ( )

static

Returns the title used by all FloatingContainer that does not reflect the title of the current dock widget.

If not title was set with setFloatingContainersTitle(), it returns QGuiApplication::applicationDisplayName().

在文件 dockmanager.cpp 第 107 行定义.

iconProvider()

DockIconProvider & QxDock::DockManager::iconProvider ( )

static

Returns the global icon provider.

The icon provider enables the use of custom icons in case using styleheets for icons is not an option.

在文件 dockmanager.cpp 第 85 行定义.

setAutoHideConfigFlag()

void QxDock::DockManager::setAutoHideConfigFlag ( DockManager::AutoHideFlag  flag, bool  on = true  )

static

在文件 dockmanager.cpp 第 70 行定义.

setAutoHideConfigFlags()

void QxDock::DockManager::setAutoHideConfigFlags ( const AutoHideFlags  flags )

static

在文件 dockmanager.cpp 第 65 行定义.

setConfigFlag()

void QxDock::DockManager::setConfigFlag ( DockManager::ConfigFlag  flag, bool  on = true  )

static

在文件 dockmanager.cpp 第 50 行定义.

setConfigFlags()

void QxDock::DockManager::setConfigFlags ( const ConfigFlags  flags )

static

在文件 dockmanager.cpp 第 45 行定义.

setFloatingContainersTitle()

void QxDock::DockManager::setFloatingContainersTitle ( const QString &  title )

static

Set a custom title for all FloatingContainer that does not reflect the title of the current dock widget.

在文件 dockmanager.cpp 第 119 行定义.

setWidgetFocus()

template<class QWidgetPtr >

static void QxDock::DockManager::setWidgetFocus ( QWidgetPtr  widget )

inlinestatic

在文件 dockmanager.h 第 171 行定义.

startDragDistance()

int QxDock::DockManager::startDragDistance ( )

static

The distance the user needs to move the mouse with the left button hold down before a dock widget start floating

在文件 dockmanager.cpp 第 95 行定义.

testAutoHideConfigFlag()

bool QxDock::DockManager::testAutoHideConfigFlag ( DockManager::AutoHideFlag  flag )

static

在文件 dockmanager.cpp 第 75 行定义.

testConfigFlag()

bool QxDock::DockManager::testConfigFlag ( DockManager::ConfigFlag  flag )

static

在文件 dockmanager.cpp 第 55 行定义.

---

该类的文档由以下文件生成:

• src/libs/qxdock/dockmanager.h
• src/libs/qxdock/dockmanager.cpp