Container that manages a number of dock panels with single dock widgets or tabyfied dock widgets in each area. 更多...

#include <qxdock/dockcontainer.h>

类 QxDock::DockContainer 继承关系图:

[图例]

Public 类型
using	Super = QFrame

Public 成员函数
	DockContainer (DockWindow window, QWidget parent=nullptr)

virtual	~DockContainer ()

DockPanel *	addDockWidget (Qx::DockWidgetArea area, DockWidget w, DockPanel p=nullptr, int index=-1)
	Adds dockwidget into the given area.

void	removeDockWidget (DockWidget *w)

virtual unsigned int	zOrderIndex () const

bool	isInFrontOf (DockContainer *other) const
	This function returns true if this container widgets z order index is higher than the index of the container widget given in other parameter

DockWindow *	dockWindow () const

DockPanel *	dockPanelAt (const QPoint &globalPos) const

DockPanel *	dockPanel (int index) const

QList< DockPanel * >	openedDockPanels () const
	Returns the list of dock panels that are not closed If all dock widgets in a dock panel are closed, the dock panel will be closed

QList< DockWidget * >	openedDockWidgets () const
	Returns a list for all open dock widgets in all open dock panels

bool	hasOpenDockPanels () const
	This function returns true, if the container has open dock panels.

bool	hasTopLevelDockWidget () const
	This function returns true if this dock panel has only one single visible dock widget.

int	dockPanelCount () const

int	visibleDockPanelCount () const

DockWidget::DockWidgetFeatures	features () const
	This functions returns the dock widget features of all dock widget in this container.

bool	isFloating () const

DockFloatingContainer *	floatingWidget () const
	If this dock container is in a floating widget, this function returns the floating widget.

void	closeOtherAreas (DockPanel *keepOpenPanel)

DockSideBar *	autoHideSideBar (Qx::DockSideBarArea area) const

QList< DockAutoHideContainer * >	autoHideWidgets () const

QRect	contentRect () const
	Returns the content rectangle mapped to global space.

void	dockAreasAdded ()

void	dockAreasRemoved ()

void	autoHideWidgetCreated (DockAutoHideContainer *autoHideWidget)

void	dockAreaViewToggled (DockPanel *panel, bool open)

Protected 成员函数
DockSplitter *	rootSplitter () const
	Access function for the internal root splitter

void	createRootSplitter ()

void	addDockPanel (DockPanel *panel, Qx::DockWidgetArea area=Qx::CenterDockWidgetArea)

void	removeDockPanel (DockPanel *panel)

QList< QPointer< DockPanel > >	removeAllDockPanels ()
	Remove all dock panles and returns the list of removed dock panles

DockWidget *	topLevelDockWidget () const
	If hasTopLevelDockWidget() returns true, this function returns the one and only visible dock widget.

DockPanel *	topLevelDockPanel () const

DockPanel *	lastAddedDockPanel (Qx::DockWidgetArea area) const
	This function returns the last added dock panel for the given area identifier or 0 if no dock panel has been added for the given area

QList< DockWidget * >	dockWidgets () const
	This function returns a list of all dock widgets in this container.

void	updateSplitterHandles (QSplitter *splitter)
	This function forces the dock container widget to update handles of splitters based on resize modes of dock widgets contained in the container.

void	dropFloatingWidget (DockFloatingContainer *floatingWidget, const QPoint &targetPos)
	Drop floating widget into the container

void	dropWidget (QWidget widget, Qx::DockWidgetArea dropArea, DockPanel targetPanel, int tabIndex=-1)
	Drop a dock panel or a dock widget given in widget parameter.

void	createSideTabBarWidgets ()

DockAutoHideContainer *	createAndSetupAutoHideContainer (Qx::DockSideBarArea area, DockWidget *w, int tabIndex=-1)
	Creates and initializes a dockwidget auto hide container into the given area.

void	registerAutoHideWidget (DockAutoHideContainer *autoHideWidget)

void	removeAutoHideWidget (DockAutoHideContainer *autoHideWidget)

void	handleAutoHideWidgetEvent (QEvent e, QWidget w)

void	saveState (QXmlStreamWriter &s) const

bool	restoreState (DockStateReader &s, bool testing)

virtual bool	event (QEvent *e) override
	Handles activation events to update zOrderIndex

友元
class	DockPanel

class	DockFloatingContainer

class	DockFloatingContainerPrivate

class	DockWidget

class	DockFloatingPreview

class	DockAutoHideContainer

class	DockWindow

class	DockAutoHideContainerPrivate

class	DockSideBar

class	DockSideTabPrivate

class	DockWindowPrivate

详细描述

Container that manages a number of dock panels with single dock widgets or tabyfied dock widgets in each area.

Each window that support docking has a DockContainer. That means the main application window and all floating windows contain a DockContainer instance.

在文件 dockcontainer.h 第 34 行定义.

成员类型定义说明

◆ Super

using QxDock::DockContainer::Super = QFrame

在文件 dockcontainer.h 第 38 行定义.

构造及析构函数说明

◆ DockContainer()

QxDock::DockContainer::DockContainer	(	DockWindow *	window,
		QWidget *	parent = `nullptr`
	)

explicit

在文件 dockcontainer.cpp 第 928 行定义.

◆ ~DockContainer()

QxDock::DockContainer::~DockContainer ( )

virtual

在文件 dockcontainer.cpp 第 946 行定义.

成员函数说明

◆ addDockPanel()

void QxDock::DockContainer::addDockPanel	(	DockPanel *	panel,
		Qx::DockWidgetArea	area = `Qx::CenterDockWidgetArea`
	)

protected

在文件 dockcontainer.cpp 第 1238 行定义.

◆ addDockWidget()

DockPanel * QxDock::DockContainer::addDockWidget	(	Qx::DockWidgetArea	area,
		DockWidget *	w,
		DockPanel *	p = `nullptr`,
		int	index = `-1`
	)

Adds dockwidget into the given area.

If p is not null, then the area parameter indicates the area into the panel. If p is null, the Dockwidget will be dropped into the container.

返回: Returns the dock panel that contains the new DockWidget

在文件 dockcontainer.cpp 第 970 行定义.

◆ autoHideSideBar()

DockSideBar * QxDock::DockContainer::autoHideSideBar ( Qx::DockSideBarArea area ) const

在文件 dockcontainer.cpp 第 1185 行定义.

◆ autoHideWidgetCreated()

void QxDock::DockContainer::autoHideWidgetCreated ( DockAutoHideContainer * autoHideWidget )

◆ autoHideWidgets()

QList< DockAutoHideContainer * > QxDock::DockContainer::autoHideWidgets ( ) const

在文件 dockcontainer.cpp 第 1191 行定义.

◆ closeOtherAreas()

void QxDock::DockContainer::closeOtherAreas ( DockPanel * keepOpenPanel )

在文件 dockcontainer.cpp 第 1164 行定义.

◆ contentRect()

QRect QxDock::DockContainer::contentRect ( ) const

Returns the content rectangle mapped to global space.

The content rectangle is the rectangle of the dock container minus the auto hide side bars. So that means, it is the geometry of the internal root splitter mapped to global space.

在文件 dockcontainer.cpp 第 1203 行定义.

◆ createAndSetupAutoHideContainer()

DockAutoHideContainer * QxDock::DockContainer::createAndSetupAutoHideContainer	(	Qx::DockSideBarArea	area,
		DockWidget *	w,
		int	tabIndex = `-1`
	)

protected

Creates and initializes a dockwidget auto hide container into the given area.

Initializing inserts the tabs into the side tab widget and hides it Returns nullptr if you try and insert into an area where the configuration is not enabled

在文件 dockcontainer.cpp 第 1528 行定义.

◆ createRootSplitter()

void QxDock::DockContainer::createRootSplitter ( )

protected

在文件 dockcontainer.cpp 第 1232 行定义.

◆ createSideTabBarWidgets()

void QxDock::DockContainer::createSideTabBarWidgets ( )

protected

在文件 dockcontainer.cpp 第 1491 行定义.

◆ dockAreasAdded()

void QxDock::DockContainer::dockAreasAdded ( )

◆ dockAreasRemoved()

void QxDock::DockContainer::dockAreasRemoved ( )

◆ dockAreaViewToggled()

void QxDock::DockContainer::dockAreaViewToggled	(	DockPanel *	panel,
		bool	open
	)

◆ dockPanel()

DockPanel * QxDock::DockContainer::dockPanel ( int index ) const

在文件 dockcontainer.cpp 第 1040 行定义.

◆ dockPanelAt()

DockPanel * QxDock::DockContainer::dockPanelAt ( const QPoint & globalPos ) const

在文件 dockcontainer.cpp 第 1027 行定义.

◆ dockPanelCount()

int QxDock::DockContainer::dockPanelCount ( ) const

在文件 dockcontainer.cpp 第 1110 行定义.

◆ dockWidgets()

QList< DockWidget * > QxDock::DockContainer::dockWidgets ( ) const

protected

This function returns a list of all dock widgets in this container.

It may be possible, depending on the implementation, that dock widgets, that are not visible to the user have no parent widget. Therefore simply calling findChildren() would not work here. Therefore this function iterates over all dock panels and creates a list that contains all dock widgets returned from all dock panels.

在文件 dockcontainer.cpp 第 1376 行定义.

◆ dockWindow()

DockWindow * QxDock::DockContainer::dockWindow ( ) const

在文件 dockcontainer.cpp 第 1021 行定义.

◆ dropFloatingWidget()

void QxDock::DockContainer::dropFloatingWidget	(	DockFloatingContainer *	floatingWidget,
		const QPoint &	targetPos
	)

protected

Drop floating widget into the container

在文件 dockcontainer.cpp 第 1403 行定义.

◆ dropWidget()

void QxDock::DockContainer::dropWidget	(	QWidget *	widget,
		Qx::DockWidgetArea	dropArea,
		DockPanel *	targetPanel,
		int	tabIndex = `-1`
	)

protected

Drop a dock panel or a dock widget given in widget parameter.

If the targetPanel is a nullptr, then the dropArea indicates the drop area for the container. If the given targetPanel is not a nullptr, then the dropArea indicates the drop area in the given targetPanel

在文件 dockcontainer.cpp 第 1471 行定义.

◆ event()

bool QxDock::DockContainer::event ( QEvent * e )

overrideprotectedvirtual

Handles activation events to update zOrderIndex

在文件 dockcontainer.cpp 第 1699 行定义.

◆ features()

DockWidget::DockWidgetFeatures QxDock::DockContainer::features ( ) const

This functions returns the dock widget features of all dock widget in this container.

A bitwise and is used to combine the flags of all dock widgets. That means, if only dock widget does not support a certain flag, the whole dock are does not support the flag.

在文件 dockcontainer.cpp 第 1134 行定义.

◆ floatingWidget()

DockFloatingContainer * QxDock::DockContainer::floatingWidget ( ) const

If this dock container is in a floating widget, this function returns the floating widget.

Else, it returns a nullptr.

在文件 dockcontainer.cpp 第 1159 行定义.

◆ handleAutoHideWidgetEvent()

void QxDock::DockContainer::handleAutoHideWidgetEvent	(	QEvent *	e,
		QWidget *	w
	)

protected

在文件 dockcontainer.cpp 第 1556 行定义.

◆ hasOpenDockPanels()

bool QxDock::DockContainer::hasOpenDockPanels ( ) const

This function returns true, if the container has open dock panels.

This functions is a little bit faster than calling openedDockPanels().isEmpty() because it returns as soon as it finds an open dock panel

在文件 dockcontainer.cpp 第 1082 行定义.

◆ hasTopLevelDockWidget()

bool QxDock::DockContainer::hasTopLevelDockWidget ( ) const

This function returns true if this dock panel has only one single visible dock widget.

A top level widget is a real floating widget. Only the isFloating() function of top level widgets may returns true.

在文件 dockcontainer.cpp 第 1100 行定义.

◆ isFloating()

bool QxDock::DockContainer::isFloating ( ) const

在文件 dockcontainer.cpp 第 1148 行定义.

◆ isInFrontOf()

bool QxDock::DockContainer::isInFrontOf ( DockContainer * other ) const

This function returns true if this container widgets z order index is higher than the index of the container widget given in other parameter

在文件 dockcontainer.cpp 第 1016 行定义.

◆ lastAddedDockPanel()

DockPanel * QxDock::DockContainer::lastAddedDockPanel ( Qx::DockWidgetArea area ) const

protected

This function returns the last added dock panel for the given area identifier or 0 if no dock panel has been added for the given area

在文件 dockcontainer.cpp 第 1362 行定义.

◆ openedDockPanels()

QList< DockPanel * > QxDock::DockContainer::openedDockPanels ( ) const

Returns the list of dock panels that are not closed If all dock widgets in a dock panel are closed, the dock panel will be closed

在文件 dockcontainer.cpp 第 1050 行定义.

◆ openedDockWidgets()

QList< DockWidget * > QxDock::DockContainer::openedDockWidgets ( ) const

Returns a list for all open dock widgets in all open dock panels

在文件 dockcontainer.cpp 第 1065 行定义.

◆ registerAutoHideWidget()

void QxDock::DockContainer::registerAutoHideWidget ( DockAutoHideContainer * autoHideWidget )

protected

在文件 dockcontainer.cpp 第 1543 行定义.

◆ removeAllDockPanels()

QList< QPointer< DockPanel > > QxDock::DockContainer::removeAllDockPanels ( )

protected

Remove all dock panles and returns the list of removed dock panles

在文件 dockcontainer.cpp 第 1324 行定义.

◆ removeAutoHideWidget()

void QxDock::DockContainer::removeAutoHideWidget ( DockAutoHideContainer * autoHideWidget )

protected

在文件 dockcontainer.cpp 第 1550 行定义.

◆ removeDockPanel()

void QxDock::DockContainer::removeDockPanel ( DockPanel * panel )

protected

在文件 dockcontainer.cpp 第 1248 行定义.

◆ removeDockWidget()

void QxDock::DockContainer::removeDockWidget ( DockWidget * w )

在文件 dockcontainer.cpp 第 998 行定义.

◆ restoreState()

bool QxDock::DockContainer::restoreState	(	DockStateReader &	s,
		bool	testing
	)

protected

在文件 dockcontainer.cpp 第 1642 行定义.

◆ rootSplitter()

DockSplitter * QxDock::DockContainer::rootSplitter ( ) const

protected

Access function for the internal root splitter

在文件 dockcontainer.cpp 第 1226 行定义.

◆ saveState()

void QxDock::DockContainer::saveState ( QXmlStreamWriter & s ) const

protected

在文件 dockcontainer.cpp 第 1623 行定义.

◆ topLevelDockPanel()

DockPanel * QxDock::DockContainer::topLevelDockPanel ( ) const

protected

在文件 dockcontainer.cpp 第 1349 行定义.

◆ topLevelDockWidget()

DockWidget * QxDock::DockContainer::topLevelDockWidget ( ) const

protected

If hasTopLevelDockWidget() returns true, this function returns the one and only visible dock widget.

Otherwise it returns a nullptr.

在文件 dockcontainer.cpp 第 1336 行定义.

◆ updateSplitterHandles()

void QxDock::DockContainer::updateSplitterHandles ( QSplitter * splitter )

protected

This function forces the dock container widget to update handles of splitters based on resize modes of dock widgets contained in the container.

在文件 dockcontainer.cpp 第 1394 行定义.

◆ visibleDockPanelCount()

int QxDock::DockContainer::visibleDockPanelCount ( ) const

在文件 dockcontainer.cpp 第 1116 行定义.

◆ zOrderIndex()

unsigned int QxDock::DockContainer::zOrderIndex ( ) const

virtual

在文件 dockcontainer.cpp 第 1006 行定义.

友元及相关函数文档

◆ DockAutoHideContainer

friend class DockAutoHideContainer

friend

在文件 dockcontainer.h 第 107 行定义.

◆ DockAutoHideContainerPrivate

friend class DockAutoHideContainerPrivate

friend

在文件 dockcontainer.h 第 109 行定义.

◆ DockFloatingContainer

friend class DockFloatingContainer

friend

在文件 dockcontainer.h 第 103 行定义.

◆ DockFloatingContainerPrivate

friend class DockFloatingContainerPrivate

friend

在文件 dockcontainer.h 第 104 行定义.

◆ DockFloatingPreview

friend class DockFloatingPreview

friend

在文件 dockcontainer.h 第 106 行定义.

◆ DockPanel

friend class DockPanel

friend

在文件 dockcontainer.h 第 102 行定义.

◆ DockSideBar

friend class DockSideBar

friend

在文件 dockcontainer.h 第 110 行定义.

◆ DockSideTabPrivate

friend class DockSideTabPrivate

friend

在文件 dockcontainer.h 第 111 行定义.

◆ DockWidget

friend class DockWidget

friend

在文件 dockcontainer.h 第 105 行定义.

◆ DockWindow

friend class DockWindow

friend

在文件 dockcontainer.h 第 108 行定义.

◆ DockWindowPrivate

friend class DockWindowPrivate

friend

在文件 dockcontainer.h 第 112 行定义.

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

src/libs/qxdock/dockcontainer.h
src/libs/qxdock/dockcontainer.cpp

Public 类型

Public 成员函数

Protected 成员函数

友元

详细描述

成员类型定义说明

◆ Super

构造及析构函数说明

◆ DockContainer()

◆ ~DockContainer()

成员函数说明

◆ addDockPanel()

◆ addDockWidget()

◆ autoHideSideBar()

◆ autoHideWidgetCreated()

◆ autoHideWidgets()

◆ closeOtherAreas()

◆ contentRect()

◆ createAndSetupAutoHideContainer()

◆ createRootSplitter()

◆ createSideTabBarWidgets()

◆ dockAreasAdded()

◆ dockAreasRemoved()

◆ dockAreaViewToggled()

◆ dockPanel()

◆ dockPanelAt()

◆ dockPanelCount()

◆ dockWidgets()

◆ dockWindow()

◆ dropFloatingWidget()

◆ dropWidget()

◆ event()

◆ features()

◆ floatingWidget()

◆ handleAutoHideWidgetEvent()

◆ hasOpenDockPanels()

◆ hasTopLevelDockWidget()

◆ isFloating()

◆ isInFrontOf()

◆ lastAddedDockPanel()

◆ openedDockPanels()

◆ openedDockWidgets()

◆ registerAutoHideWidget()

◆ removeAllDockPanels()

◆ removeAutoHideWidget()

◆ removeDockPanel()

◆ removeDockWidget()

◆ restoreState()

◆ rootSplitter()

◆ saveState()

◆ topLevelDockPanel()

◆ topLevelDockWidget()

◆ updateSplitterHandles()

◆ visibleDockPanelCount()

◆ zOrderIndex()

友元及相关函数文档

◆ DockAutoHideContainer

◆ DockAutoHideContainerPrivate

◆ DockFloatingContainer

◆ DockFloatingContainerPrivate

◆ DockFloatingPreview

◆ DockPanel

◆ DockSideBar

◆ DockSideTabPrivate

◆ DockWidget

◆ DockWindow

◆ DockWindowPrivate