ads Namespace Reference

Namespaces
	internal

Classes
class	CDockAreaLayout
class	CDockAreaTabBar
class	CDockAreaTitleBar
class	CDockAreaWidget
class	CDockComponentsFactory
class	CDockContainerWidget
class	CDockFocusController
class	CDockingStateReader
class	CDockManager
class	CDockSplitter
class	CDockWidget
class	CDockWidgetTab
class	CElidingLabel
class	CFloatingDockContainer
class	CFloatingDragPreview
class	CFloatingWidgetTitleBar
class	CIconProvider
class	CSpacerWidget
class	CTitleBarButton
struct	DockAreaTabBarPrivate
struct	DockAreaTitleBarPrivate
struct	DockAreaWidgetPrivate
class	DockContainerWidgetPrivate
struct	DockFocusControllerPrivate
struct	DockManagerPrivate
struct	DockOverlayCrossPrivate
struct	DockOverlayPrivate
struct	DockSplitterPrivate
struct	DockWidgetPrivate
struct	DockWidgetTabPrivate
struct	ElidingLabelPrivate
struct	FloatingDockContainerPrivate
struct	FloatingDragPreviewPrivate
struct	FloatingWidgetTitleBarPrivate
	Private data class of public interface CFloatingWidgetTitleBar. More...
struct	IconProviderPrivate
class	IFloatingWidget

Typedefs
using	DockAreaLayout = CDockAreaLayout
using	tCloseButton = QToolButton
using	tMaximizeButton = QToolButton
using	tTabLabel = CElidingLabel
using	tTitleBarButton = QToolButton

Enumerations
enum	DockWidgetArea {   NoDockWidgetArea = 0x00, LeftDockWidgetArea = 0x01, RightDockWidgetArea = 0x02, TopDockWidgetArea = 0x04,   BottomDockWidgetArea = 0x08, CenterDockWidgetArea = 0x10, InvalidDockWidgetArea = NoDockWidgetArea, OuterDockAreas = TopDockWidgetArea | LeftDockWidgetArea | RightDockWidgetArea | BottomDockWidgetArea,   AllDockAreas = OuterDockAreas | CenterDockWidgetArea }
enum	eBitwiseOperator { BitwiseAnd, BitwiseOr }
enum	eDragState { DraggingInactive, DraggingMousePressed, DraggingTab, DraggingFloatingWidget }
enum	eDropMode { DropModeIntoArea, DropModeIntoContainer, DropModeInvalid }
enum	eIcon {   TabCloseIcon, DockAreaMenuIcon, DockAreaUndockIcon, DockAreaCloseIcon,   IconCount }
enum	eStateFileVersion { InitialVersion = 0, Version1 = 1, CurrentVersion = Version1 }
enum	TitleBarButton { TitleBarButtonTabsMenu, TitleBarButtonUndock, TitleBarButtonClose }

Functions
static int	areaAlignment (const DockWidgetArea area)
static int	areaIdToIndex (DockWidgetArea area)
const CDockComponentsFactory *	componentsFactory ()
static std::unique_ptr< CDockComponentsFactory >	DefaultFactory (new CDockComponentsFactory())
static void	insertWidgetIntoSplitter (QSplitter *Splitter, QWidget *widget, bool Append)
static void	updateDockAreaFocusStyle (CDockAreaWidget *DockArea, bool Focused)
static void	updateDockWidgetFocusStyle (CDockWidget *DockWidget, bool Focused)

Variables
static const char *const	ACTION_PROPERTY = "action"
static const DockWidgetAreas	DefaultAllowedAreas = AllDockAreas
static const char *const	INDEX_PROPERTY = "index"
static CDockManager::ConfigFlags	StaticConfigFlags = CDockManager::DefaultNonOpaqueConfig
static unsigned int	zOrderCounter = 0
static unsigned int	zOrderCounter = 0

Typedef Documentation

DockAreaLayout

using ads::DockAreaLayout = typedef CDockAreaLayout

Definition at line 238 of file DockAreaWidget.cpp.

tCloseButton

using ads::tCloseButton = typedef QToolButton

Definition at line 48 of file FloatingWidgetTitleBar.cpp.

tMaximizeButton

using ads::tMaximizeButton = typedef QToolButton

Definition at line 49 of file FloatingWidgetTitleBar.cpp.

tTabLabel

typedef CElidingLabel ads::tTabLabel

Definition at line 58 of file DockWidgetTab.cpp.

tTitleBarButton

using ads::tTitleBarButton = typedef QToolButton

Definition at line 40 of file DockAreaTitleBar_p.h.

Enumeration Type Documentation

DockWidgetArea

enum ads::DockWidgetArea

Enumerator
NoDockWidgetArea
LeftDockWidgetArea
RightDockWidgetArea
TopDockWidgetArea
BottomDockWidgetArea
CenterDockWidgetArea
InvalidDockWidgetArea
OuterDockAreas
AllDockAreas

Definition at line 73 of file ads_globals.h.

eBitwiseOperator

enum ads::eBitwiseOperator

For bitwise combination of dock wdget features

Enumerator
BitwiseAnd
BitwiseOr

Definition at line 123 of file ads_globals.h.

eDragState

enum ads::eDragState

The different dragging states

Enumerator
DraggingInactive	DraggingInactive.
DraggingMousePressed	DraggingMousePressed.
DraggingTab	DraggingTab.
DraggingFloatingWidget	DraggingFloatingWidget.

Definition at line 99 of file ads_globals.h.

eDropMode

enum ads::eDropMode

Enumerator
DropModeIntoArea	drop widget into a dock area
DropModeIntoContainer	drop into container
DropModeInvalid	invalid mode - do not drop

Definition at line 85 of file DockContainerWidget.cpp.

eIcon

enum ads::eIcon

The different icons used in the UI

Enumerator
TabCloseIcon	TabCloseIcon.
DockAreaMenuIcon	DockAreaMenuIcon.
DockAreaUndockIcon	DockAreaUndockIcon.
DockAreaCloseIcon	DockAreaCloseIcon.
IconCount	just a delimiter for range checks

Definition at line 110 of file ads_globals.h.

eStateFileVersion

enum ads::eStateFileVersion

Internal file version in case the structure changes internally

Enumerator
InitialVersion	InitialVersion.
Version1	Version1.
CurrentVersion	CurrentVersion.

Definition at line 85 of file DockManager.cpp.

TitleBarButton

enum ads::TitleBarButton

Enumerator
TitleBarButtonTabsMenu
TitleBarButtonUndock
TitleBarButtonClose

Definition at line 89 of file ads_globals.h.

Function Documentation

areaAlignment()

static int ads::areaAlignment ( const DockWidgetArea  area )

static

Definition at line 562 of file DockOverlay.cpp.

areaIdToIndex()

static int ads::areaIdToIndex ( DockWidgetArea  area )

static

Converts dock area ID to an index for array access

Definition at line 95 of file DockContainerWidget.cpp.

componentsFactory()

const CDockComponentsFactory* ads::componentsFactory ( )

inline

Convenience function to ease factory instance access

Definition at line 82 of file DockComponentsFactory.h.

DefaultFactory()

static std::unique_ptr<CDockComponentsFactory> ads::DefaultFactory ( new   CDockComponentsFactory() )

static

insertWidgetIntoSplitter()

static void ads::insertWidgetIntoSplitter ( QSplitter *  Splitter, QWidget *  widget, bool  Append  )

static

Helper function to ease insertion of dock area into splitter

Definition at line 112 of file DockContainerWidget.cpp.

updateDockAreaFocusStyle()

static void ads::updateDockAreaFocusStyle ( CDockAreaWidget *  DockArea, bool  Focused  )

static

Definition at line 74 of file DockFocusController.cpp.

updateDockWidgetFocusStyle()

static void ads::updateDockWidgetFocusStyle ( CDockWidget *  DockWidget, bool  Focused  )

static

Definition at line 64 of file DockFocusController.cpp.

Variable Documentation

ACTION_PROPERTY

const char* const ads::ACTION_PROPERTY = "action"

static

Definition at line 62 of file DockAreaWidget.cpp.

DefaultAllowedAreas

const DockWidgetAreas ads::DefaultAllowedAreas = AllDockAreas

static

Definition at line 239 of file DockAreaWidget.cpp.

INDEX_PROPERTY

const char* const ads::INDEX_PROPERTY = "index"

static

Definition at line 61 of file DockAreaWidget.cpp.

StaticConfigFlags

CDockManager::ConfigFlags ads::StaticConfigFlags = CDockManager::DefaultNonOpaqueConfig

static

Definition at line 92 of file DockManager.cpp.

zOrderCounter [1/2]

unsigned int ads::zOrderCounter = 0

static

Definition at line 83 of file DockContainerWidget.cpp.

zOrderCounter [2/2]

unsigned int ads::zOrderCounter = 0

static

Definition at line 360 of file FloatingDockContainer.cpp.