The DockWidget class provides a widget that can be docked inside a DockWindow or floated as a top-level window on the desktop. 更多...

#include <qxdock/dockwidget.h>

类 QxDock::DockWidget 继承关系图:

[图例]

Public 类型
enum	DockWidgetFeature { DockWidgetClosable = 0x001 , DockWidgetMovable = 0x002 , DockWidgetFloatable = 0x004 , DockWidgetDeleteOnClose = 0x008 , CustomCloseHandling = 0x010 , DockWidgetFocusable = 0x020 , DockWidgetForceCloseWithArea = 0x040 , NoTab = 0x080 , DeleteContentOnClose = 0x100 , DockWidgetPinnable = 0x200 , DefaultDockWidgetFeatures , AllDockWidgetFeatures = DefaultDockWidgetFeatures \| DockWidgetDeleteOnClose \| CustomCloseHandling , DockWidgetAlwaysCloseAndDelete = DockWidgetForceCloseWithArea \| DockWidgetDeleteOnClose , GloballyLockableFeatures = DockWidgetClosable \| DockWidgetMovable \| DockWidgetFloatable \| DockWidgetPinnable , NoDockWidgetFeatures = 0x000 }

enum	ToggleViewActionMode { ActionModeToggle , ActionModeShow }
	This mode configures the behavior of the toggle view action. 更多...

enum	MinimumSizeHintMode { MinimumSizeHintFromDockWidget , MinimumSizeHintFromContent , MinimumSizeHintFromDockWidgetMinimumSize , MinimumSizeHintFromContentMinimumSize }
	The mode of the minimumSizeHint() that is returned by the DockWidget minimumSizeHint() function. 更多...

enum	WidgetInsertMode { AutoScrollArea , ForceScrollArea , ForceNoScrollArea }
	Sets the widget for the dock widget to widget. 更多...

enum	State { StateHidden , StateDocked , StateFloating }

enum	ToolBarStyleSource { ToolBarStyleFromDockWindow , ToolBarStyleFromDockWidget }

using	Super = QFrame

using	FactoryFunc = std::function< QWidget (QWidget )>

Public 成员函数
	DockWidget (const QString &title, QWidget *parent=nullptr)
	This constructor creates a dock widget with the given title.

	~DockWidget ()

void	setWidget (QWidget *w, WidgetInsertMode insertMode=AutoScrollArea)
	Sets the widget for the dock widget to widget.

QWidget *	widget () const
	Returns the widget for the dock widget.

QWidget *	takeWidget ()
	Remove the widget from the dock and give ownership back to the caller

DockTab *	tab () const
	Returns the tab widget of this dock widget that is shown in the dock title bar

DockWidgetFeatures	features () const
	This property holds whether the dock widget is movable, closable, and floatable.

void	setFeatures (DockWidgetFeatures features)
	Sets, whether the dock widget is movable, closable, and floatable.

void	setFeature (DockWidgetFeature flag, bool on)
	Sets the feature flag for this dock widget if on is true; otherwise clears the flag.

void	notifyFeaturesChanged ()
	Triggers notification of feature change signals and functions

DockWindow *	dockWindow () const
	Returns the dock window that manages the dock widget or 0 if the widget has not been assigned to any dock window yet

DockContainer *	dockContainer () const
	Returns the dock container widget this dock panel belongs to or 0 if this dock widget has not been docked yet

DockFloatingContainer *	dockFloatingContainer () const
	This function return the floating DockContainer if is isFloating() is true and a nullptr if this dock widget is not floating.

DockPanel *	dockPanel () const
	Returns the dock panel this dock widget belongs to or 0 if this dock widget has not been docked yet

bool	isFloating () const
	This property holds whether the dock widget is floating.

bool	isInFloatingContainer () const
	The function returns true, if the dock widget is floating and it also returns true if it is docked inside of a floating container.

bool	isClosed () const
	Returns true, if this dock widget is closed.

bool	isFullScreen () const
	Returns true if the dock widget is floating and if the floating dock container is full screen

bool	isTabbed () const
	Returns true if this dock widget is in a dock panel, that contains at least 2 opened dock widgets

bool	isCurrentTab () const
	Returns true if this dock widget is the current one in the dock panel that contains it.

bool	isCentralWidget () const
	Returns true if the dock widget is set as central widget of it's dock window

QAction *	toggleViewAction () const
	Returns a checkable action that can be used to show or close this dock widget.

void	setToggleViewAction (QAction *action)
	Use provided action to be the default toggle view action for this dock widget.

void	setToggleViewActionMode (ToggleViewActionMode mode)
	Configures the behavior of the toggle view action.

void	setToggleViewActionChecked (bool checked)
	This function changes the toggle view action without emitting any signal

virtual QList< QAction * >	titleBarActions () const

void	setTitleBarActions (QList< QAction * > actions)
	Set the actions that will be shown in the dock title bar if this dock widget is the active tab.

MinimumSizeHintMode	minimumSizeHintMode () const
	Get the minimum size hint mode configured by setMinimumSizeHintMode

void	setMinimumSizeHintMode (MinimumSizeHintMode mode)
	Configures the minimum size hint that is returned by the minimumSizeHint() function.

virtual QSize	minimumSizeHint () const override

QIcon	icon () const

void	setIcon (const QIcon &icon)

QToolBar *	toolBar () const
	This function returns the dock widget top tool bar.

void	setToolBar (QToolBar *toolBar)
	Assign a new tool bar that is shown above the content widget.

ToolBarStyleSource	toolBarStyleSource () const

void	setToolBarStyleSource (ToolBarStyleSource source)
	Configures, if the dock widget uses the global tool bar styles from dock window or if it uses its own tool bar style

Qt::ToolButtonStyle	toolBarStyle (State state) const

void	setToolBarStyle (Qt::ToolButtonStyle style, State state)
	This function sets the tool button style for the given dock widget state.

QSize	toolBarIconSize (State state) const

void	setToolBarIconSize (const QSize &iconSize, State state)
	This function sets the tool button icon size for the given state.

DockSideTab *	sideTab () const
	Returns the side tab widget for this dock, if this dock widget is in a auto hide container.

void	setSideTab (DockSideTab *sideTab)
	Assign a side tab widget if this dock widget is an auto hide container

bool	isAutoHide () const

DockAutoHideContainer *	autoHideContainer () const
	Returns the auto hide dock container of this dock widget or 0 if there is none

Qx::DockSideBarArea	autoHideArea () const
	Returns the auto hide side bar area or Qx::DockSideBarNone if, this is not an autohide dock widget

void	setWidgetFactory (FactoryFunc createWidget, WidgetInsertMode insertMode=AutoScrollArea)
	Only used when the feature flag DeleteContentOnClose is set.

void	setTabToolTip (const QString &text)

void	toggleView (bool open=true)
	This property controls whether the dock widget is open or closed.

void	deleteDockWidget ()
	This function will delete the dock widget and its content from the docking system

void	closeDockWidget ()
	Closes the dock widget.

void	requestCloseDockWidget ()
	Request closing of the dock widget.

void	setAutoHide (bool enable, Qx::DockSideBarArea area=Qx::DockSideBarNone, int tabIndex=-1)
	Sets the dock widget into auto hide mode if this feature is enabled via DockManager::setAutoHideFlags(DockManager::AutoHideFeatureEnabled)

void	toggleAutoHide (Qx::DockSideBarArea area=Qx::DockSideBarNone)
	Switches the dock widget to auto hide mode or vice versa depending on its current state.

void	setAsCurrentTab ()
	Makes this dock widget the current tab in its dock panel.

void	raise ()
	Brings the dock widget to the front This means:

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	This function complements showFullScreen() to restore the widget after it has been in full screen mode.

void	setFloating ()
	This function will make a docked widget floating

void	setToolBarFloatingStyle (bool floating)
	Adjusts the toolbar icon sizes according to the floating state

void	viewToggled (bool open)

void	closeRequested ()

void	closed ()

void	topLevelChanged (bool topLevel)
	This signal is emitted when the floating property changes.

void	titleChanged (const QString &title)

void	visibilityChanged (bool visible)
	This signal is emitted when the dock widget becomes visible (or invisible).

void	featuresChanged (DockWidget::DockWidgetFeatures features)

Protected 成员函数
void	setDockWindow (DockWindow *window)
	Assigns the dock window that manages this dock widget

void	setDockPanel (DockPanel *panel)
	If this dock widget is inserted into a dock panel, the dock panel will be registered on this widget via this function.

void	setClosedState (bool closed)

void	emitTopLevelChanged (bool floating)
	Use this function to emit a top level changed event.

void	toggleViewInternal (bool open)
	Internal toggle view function that does not check if the widget already is in the given state

bool	closeDockWidgetInternal (bool forceClose=false)
	Internal close dock widget implementation.

void	flagAsUnassigned ()
	This is a helper function for the dock manager to flag this widget as unassigned.

void	saveState (QXmlStreamWriter &s) const

virtual bool	event (QEvent *e) override
	Emits titleChanged signal if title change event occurs

静态 Protected 成员函数
static void	emitTopLevelEventForWidget (DockWidget *topLevelDockWidget, bool floating)
	Call this function to emit a topLevelChanged() signal and to update the dock panel tool bar visibility

友元
class	DockContainer

class	DockPanel

class	DockWindow

class	DockWindowPrivate

class	DockTitleBarPrivate

class	DockFloatingContainer

class	DockAutoHideContainer

详细描述

The DockWidget class provides a widget that can be docked inside a DockWindow or floated as a top-level window on the desktop.

在文件 dockwidget.h 第 30 行定义.

成员类型定义说明

◆ FactoryFunc

using QxDock::DockWidget::FactoryFunc = std::function<QWidget *(QWidget *)>

在文件 dockwidget.h 第 190 行定义.

◆ Super

using QxDock::DockWidget::Super = QFrame

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

成员枚举类型说明

◆ DockWidgetFeature

enum QxDock::DockWidget::DockWidgetFeature

枚举值
DockWidgetClosable
DockWidgetMovable
DockWidgetFloatable
DockWidgetDeleteOnClose
CustomCloseHandling
DockWidgetFocusable
DockWidgetForceCloseWithArea
NoTab
DeleteContentOnClose
DockWidgetPinnable
DefaultDockWidgetFeatures
AllDockWidgetFeatures
DockWidgetAlwaysCloseAndDelete
GloballyLockableFeatures
NoDockWidgetFeatures

在文件 dockwidget.h 第 36 行定义.

◆ MinimumSizeHintMode

enum QxDock::DockWidget::MinimumSizeHintMode

The mode of the minimumSizeHint() that is returned by the DockWidget minimumSizeHint() function.

To ensure, that a dock widget does not block resizing, the dock widget reimplements minimumSizeHint() function to return a very small minimum size hint. If you would like to adhere the minimumSizeHint() from the content widget, then set the minimumSizeHintMode() to MinimumSizeHintFromContent. If you would like to use the minimumSize() value of the content widget or the dock widget, then you can use the MinimumSizeHintFromDockWidgetMinimumSize or MinimumSizeHintFromContentMinimumSize modes.

枚举值
MinimumSizeHintFromDockWidget
MinimumSizeHintFromContent
MinimumSizeHintFromDockWidgetMinimumSize
MinimumSizeHintFromContentMinimumSize

在文件 dockwidget.h 第 91 行定义.

◆ State

enum QxDock::DockWidget::State

枚举值
StateHidden
StateDocked
StateFloating

在文件 dockwidget.h 第 121 行定义.

◆ ToggleViewActionMode

enum QxDock::DockWidget::ToggleViewActionMode

This mode configures the behavior of the toggle view action.

If the mode if ActionModeToggle, then the toggle view action is a checkable action to show / hide the dock widget. If the mode is ActionModeShow, then the action is not checkable an it will always show the dock widget if clicked. If the mode is ActionModeShow, the user can only close the DockWidget with the close button.

枚举值
ActionModeToggle
ActionModeShow

在文件 dockwidget.h 第 75 行定义.

◆ ToolBarStyleSource

enum QxDock::DockWidget::ToolBarStyleSource

枚举值
ToolBarStyleFromDockWindow
ToolBarStyleFromDockWidget

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

◆ WidgetInsertMode

enum QxDock::DockWidget::WidgetInsertMode

Sets the widget for the dock widget to widget.

The InsertMode defines how the widget is inserted into the dock widget. The content of a dock widget should be resizable do a very small size to prevent the dock widget from blocking the resizing. To ensure, that a dock widget can be resized very well, it is better to insert the content+ widget into a scroll area or to provide a widget that is already a scroll area or that contains a scroll area. If the InsertMode is AutoScrollArea, the DockWidget tries to automatically detect how to insert the given widget. If the widget is derived from QScrollArea (i.e. an QAbstractItemView), then the widget is inserted directly. If the given widget is not a scroll area, the widget will be inserted into a scroll area. To force insertion into a scroll area, you can also provide the InsertMode ForceScrollArea. To prevent insertion into a scroll area, you can provide the InsertMode ForceNoScrollArea

枚举值
AutoScrollArea
ForceScrollArea
ForceNoScrollArea

在文件 dockwidget.h 第 115 行定义.

构造及析构函数说明

◆ DockWidget()

QxDock::DockWidget::DockWidget	(	const QString &	title,
		QWidget *	parent = `nullptr`
	)

explicit

This constructor creates a dock widget with the given title.

The title is the text that is shown in the window title when the dock widget is floating and it is the title that is shown in the titlebar or the tab of this dock widget if it is tabified. The object name of the dock widget is also set to the title. The object name is required by the dock window to properly save and restore the state of the dock widget. That means, the title needs to be unique. If your title is not unique or if you would like to change the title during runtime, you need to set a unique object name explicitly by calling setObjectName() after construction. Use the layoutFlags to configure the layout of the dock widget.

在文件 dockwidget.cpp 第 278 行定义.

◆ ~DockWidget()

QxDock::DockWidget::~DockWidget ( )

在文件 dockwidget.cpp 第 301 行定义.

成员函数说明

◆ autoHideArea()

Qx::DockSideBarArea QxDock::DockWidget::autoHideArea ( ) const

Returns the auto hide side bar area or Qx::DockSideBarNone if, this is not an autohide dock widget

在文件 dockwidget.cpp 第 848 行定义.

◆ autoHideContainer()

DockAutoHideContainer * QxDock::DockWidget::autoHideContainer ( ) const

Returns the auto hide dock container of this dock widget or 0 if there is none

在文件 dockwidget.cpp 第 833 行定义.

◆ closed()

void QxDock::DockWidget::closed ( )

◆ closeDockWidget()

void QxDock::DockWidget::closeDockWidget ( )

Closes the dock widget.

The function forces closing of the dock widget even for CustomCloseHandling.

在文件 dockwidget.cpp 第 932 行定义.

◆ closeDockWidgetInternal()

bool QxDock::DockWidget::closeDockWidgetInternal ( bool forceClose = false )

protected

Internal close dock widget implementation.

The function returns true if the dock widget has been closed or hidden

在文件 dockwidget.cpp 第 1213 行定义.

◆ closeRequested()

void QxDock::DockWidget::closeRequested ( )

◆ deleteDockWidget()

void QxDock::DockWidget::deleteDockWidget ( )

This function will delete the dock widget and its content from the docking system

在文件 dockwidget.cpp 第 918 行定义.

◆ dockContainer()

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

Returns the dock container widget this dock panel belongs to or 0 if this dock widget has not been docked yet

在文件 dockwidget.cpp 第 444 行定义.

◆ dockFloatingContainer()

DockFloatingContainer * QxDock::DockWidget::dockFloatingContainer ( ) const

This function return the floating DockContainer if is isFloating() is true and a nullptr if this dock widget is not floating.

在文件 dockwidget.cpp 第 458 行定义.

◆ dockPanel()

DockPanel * QxDock::DockWidget::dockPanel ( ) const

Returns the dock panel this dock widget belongs to or 0 if this dock widget has not been docked yet

在文件 dockwidget.cpp 第 468 行定义.

◆ dockWindow()

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

Returns the dock window that manages the dock widget or 0 if the widget has not been assigned to any dock window yet

在文件 dockwidget.cpp 第 434 行定义.

◆ emitTopLevelChanged()

void QxDock::DockWidget::emitTopLevelChanged ( bool floating )

protected

Use this function to emit a top level changed event.

Do never use emit topLevelChanged(). Always use this function because it only emits a signal if the floating state has really changed

在文件 dockwidget.cpp 第 1152 行定义.

◆ emitTopLevelEventForWidget()

void QxDock::DockWidget::emitTopLevelEventForWidget	(	DockWidget *	topLevelDockWidget,
		bool	floating
	)

staticprotected

Call this function to emit a topLevelChanged() signal and to update the dock panel tool bar visibility

在文件 dockwidget.cpp 第 1139 行定义.

◆ event()

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

overrideprotectedvirtual

Emits titleChanged signal if title change event occurs

在文件 dockwidget.cpp 第 1277 行定义.

◆ features()

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

This property holds whether the dock widget is movable, closable, and floatable.

By default, this property is set to a combination of DockWidgetClosable, DockWidgetMovable and DockWidgetFloatable.

在文件 dockwidget.cpp 第 383 行定义.

◆ featuresChanged()

void QxDock::DockWidget::featuresChanged ( DockWidget::DockWidgetFeatures features )

◆ flagAsUnassigned()

void QxDock::DockWidget::flagAsUnassigned ( )

protected

This is a helper function for the dock manager to flag this widget as unassigned.

When calling the restore function, it may happen, that the saved state contains less dock widgets then currently available. All widgets whose data is not contained in the saved state, are flagged as unassigned after the restore process. If the user shows an unassigned dock widget, a floating widget will be created to take up the dock widget.

在文件 dockwidget.cpp 第 1255 行定义.

◆ icon()

QIcon QxDock::DockWidget::icon ( ) const

在文件 dockwidget.cpp 第 675 行定义.

◆ isAutoHide()

bool QxDock::DockWidget::isAutoHide ( ) const

在文件 dockwidget.cpp 第 823 行定义.

◆ isCentralWidget()

bool QxDock::DockWidget::isCentralWidget ( ) const

Returns true if the dock widget is set as central widget of it's dock window

在文件 dockwidget.cpp 第 554 行定义.

◆ isClosed()

bool QxDock::DockWidget::isClosed ( ) const

Returns true, if this dock widget is closed.

在文件 dockwidget.cpp 第 510 行定义.

◆ isCurrentTab()

bool QxDock::DockWidget::isCurrentTab ( ) const

Returns true if this dock widget is the current one in the dock panel that contains it.

If the dock widget is the only opened dock widget in a dock panel, the true is returned

在文件 dockwidget.cpp 第 545 行定义.

◆ isFloating()

bool QxDock::DockWidget::isFloating ( ) const

This property holds whether the dock widget is floating.

A dock widget is only floating, if it is the one and only widget inside of a floating container. If there are more than one dock widget in a floating container, the all dock widgets are docked and not floating.

在文件 dockwidget.cpp 第 480 行定义.

◆ isFullScreen()

bool QxDock::DockWidget::isFullScreen ( ) const

Returns true if the dock widget is floating and if the floating dock container is full screen

在文件 dockwidget.cpp 第 520 行定义.

◆ isInFloatingContainer()

bool QxDock::DockWidget::isInFloatingContainer ( ) const

The function returns true, if the dock widget is floating and it also returns true if it is docked inside of a floating container.

在文件 dockwidget.cpp 第 493 行定义.

◆ isTabbed()

bool QxDock::DockWidget::isTabbed ( ) const

Returns true if this dock widget is in a dock panel, that contains at least 2 opened dock widgets

在文件 dockwidget.cpp 第 533 行定义.

◆ minimumSizeHint()

QSize QxDock::DockWidget::minimumSizeHint ( ) const

overridevirtual

在文件 dockwidget.cpp 第 654 行定义.

◆ minimumSizeHintMode()

DockWidget::MinimumSizeHintMode QxDock::DockWidget::minimumSizeHintMode ( ) const

Get the minimum size hint mode configured by setMinimumSizeHintMode

在文件 dockwidget.cpp 第 637 行定义.

◆ notifyFeaturesChanged()

void QxDock::DockWidget::notifyFeaturesChanged ( )

Triggers notification of feature change signals and functions

在文件 dockwidget.cpp 第 420 行定义.

◆ raise()

void QxDock::DockWidget::raise ( )

Brings the dock widget to the front This means:

If the dock widget is tabbed with other dock widgets but its tab is not current, it's made current.
If the dock widget is floating, QWindow::raise() is called. This only applies if the dock widget is already open. If closed, does nothing.

在文件 dockwidget.cpp 第 1014 行定义.

◆ requestCloseDockWidget()

void QxDock::DockWidget::requestCloseDockWidget ( )

Request closing of the dock widget.

For DockWidget with default close handling, the function does the same like closeDockWidget() but if the flas CustomCloseHandling is set, the function only emits the closeRequested() signal.

在文件 dockwidget.cpp 第 943 行定义.

◆ saveState()

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

protected

在文件 dockwidget.cpp 第 1265 行定义.

◆ setAsCurrentTab()

void QxDock::DockWidget::setAsCurrentTab ( )

Makes this dock widget the current tab in its dock panel.

The function only has an effect, if the dock widget is open. A call to this function will not toggle the view, so if it is closed, nothing will happen

在文件 dockwidget.cpp 第 999 行定义.

◆ setAutoHide()

void QxDock::DockWidget::setAutoHide	(	bool	enable,
		Qx::DockSideBarArea	area = `Qx::DockSideBarNone`,
		int	tabIndex = `-1`
	)

Sets the dock widget into auto hide mode if this feature is enabled via DockManager::setAutoHideFlags(DockManager::AutoHideFeatureEnabled)

在文件 dockwidget.cpp 第 957 行定义.

◆ setClosedState()

void QxDock::DockWidget::setClosedState ( bool closed )

protected

在文件 dockwidget.cpp 第 1129 行定义.

◆ setDockPanel()

void QxDock::DockWidget::setDockPanel ( DockPanel * panel )

protected

If this dock widget is inserted into a dock panel, the dock panel will be registered on this widget via this function.

If a dock widget is removed from a dock panel, this function will be called with nullptr value.

在文件 dockwidget.cpp 第 1121 行定义.

◆ setDockWindow()

void QxDock::DockWidget::setDockWindow ( DockWindow * window )

protected

Assigns the dock window that manages this dock widget

在文件 dockwidget.cpp 第 1102 行定义.

◆ setFeature()

void QxDock::DockWidget::setFeature	(	DockWidget::DockWidgetFeature	flag,
		bool	on
	)

Sets the feature flag for this dock widget if on is true; otherwise clears the flag.

在文件 dockwidget.cpp 第 410 行定义.

◆ setFeatures()

void QxDock::DockWidget::setFeatures ( DockWidgetFeatures features )

Sets, whether the dock widget is movable, closable, and floatable.

在文件 dockwidget.cpp 第 396 行定义.

◆ setFloating()

void QxDock::DockWidget::setFloating ( )

This function will make a docked widget floating

在文件 dockwidget.cpp 第 1064 行定义.

◆ setIcon()

void QxDock::DockWidget::setIcon ( const QIcon & icon )

在文件 dockwidget.cpp 第 681 行定义.

◆ setMinimumSizeHintMode()

void QxDock::DockWidget::setMinimumSizeHintMode ( DockWidget::MinimumSizeHintMode mode )

Configures the minimum size hint that is returned by the minimumSizeHint() function.

参见: MinimumSizeHintMode for a detailed description

在文件 dockwidget.cpp 第 648 行定义.

◆ setSideTab()

void QxDock::DockWidget::setSideTab ( DockSideTab * sideTab )

Assign a side tab widget if this dock widget is an auto hide container

在文件 dockwidget.cpp 第 817 行定义.

◆ setTabToolTip()

void QxDock::DockWidget::setTabToolTip ( const QString & text )

在文件 dockwidget.cpp 第 873 行定义.

◆ setTitleBarActions()

void QxDock::DockWidget::setTitleBarActions ( QList< QAction * > actions )

Set the actions that will be shown in the dock title bar if this dock widget is the active tab.

You should not add to many actions to the title bar, because this will remove the available space for the tabs. If you have a number of actions, just add an action with a menu to show a popup menu button in the title bar.

在文件 dockwidget.cpp 第 628 行定义.

◆ setToggleViewAction()

void QxDock::DockWidget::setToggleViewAction ( QAction * action )

Use provided action to be the default toggle view action for this dock widget.

This dock widget now owns the action.

在文件 dockwidget.cpp 第 573 行定义.

◆ setToggleViewActionChecked()

void QxDock::DockWidget::setToggleViewActionChecked ( bool checked )

This function changes the toggle view action without emitting any signal

在文件 dockwidget.cpp 第 605 行定义.

◆ setToggleViewActionMode()

void QxDock::DockWidget::setToggleViewActionMode ( DockWidget::ToggleViewActionMode mode )

Configures the behavior of the toggle view action.

参见: ToggleViewActionMode for a detailed description

在文件 dockwidget.cpp 第 590 行定义.

◆ setToolBar()

void QxDock::DockWidget::setToolBar ( QToolBar * toolBar )

Assign a new tool bar that is shown above the content widget.

The dock widget will become the owner of the tool bar and deletes it on destruction

在文件 dockwidget.cpp 第 713 行定义.

◆ setToolBarFloatingStyle()

void QxDock::DockWidget::setToolBarFloatingStyle ( bool floating )

Adjusts the toolbar icon sizes according to the floating state

在文件 dockwidget.cpp 第 1081 行定义.

◆ setToolBarIconSize()

void QxDock::DockWidget::setToolBarIconSize	(	const QSize &	iconSize,
		DockWidget::State	state
	)

This function sets the tool button icon size for the given state.

If a dock widget is floating, there is more space an increasing the icon size is possible. For docked widgets, small icon sizes, eg. 16 x 16 might be better.

在文件 dockwidget.cpp 第 791 行定义.

◆ setToolBarStyle()

void QxDock::DockWidget::setToolBarStyle	(	Qt::ToolButtonStyle	style,
		DockWidget::State	state
	)

This function sets the tool button style for the given dock widget state.

It is possible to switch the tool button style depending on the state. If a dock widget is floating, then here are more space and it is possible to select a style that requires more space like Qt::ToolButtonTextUnderIcon. For the docked state Qt::ToolButtonIconOnly might be better.

在文件 dockwidget.cpp 第 763 行定义.

◆ setToolBarStyleSource()

void QxDock::DockWidget::setToolBarStyleSource ( DockWidget::ToolBarStyleSource source )

Configures, if the dock widget uses the global tool bar styles from dock window or if it uses its own tool bar style

在文件 dockwidget.cpp 第 736 行定义.

◆ setWidget()

void QxDock::DockWidget::setWidget	(	QWidget *	w,
		WidgetInsertMode	insertMode = `AutoScrollArea`
	)

Sets the widget for the dock widget to widget.

参见: WidgetInsertMode for a detailed description

在文件 dockwidget.cpp 第 310 行定义.

◆ setWidgetFactory()

void QxDock::DockWidget::setWidgetFactory	(	DockWidget::FactoryFunc	createWidget,
		DockWidget::WidgetInsertMode	insertMode = `AutoScrollArea`
	)

Only used when the feature flag DeleteContentOnClose is set.

Using the flag and setting a widget factory allows to free the resources of the widget of your application while retaining the position the next time you want to show your widget, unlike the flag DockWidgetDeleteOnClose which deletes the dock widget itself. Since we keep the dock widget, all regular features of QxDock should work as normal, including saving and restoring the state of the docking system and using perspectives.

在文件 dockwidget.cpp 第 862 行定义.

◆ showFullScreen()

void QxDock::DockWidget::showFullScreen ( )

Shows the widget in full-screen mode.

Normally this function only affects windows. To make the interface compatible to QDockWidget, this function also maximizes a floating dock widget.

注解
Full-screen mode works fine under Windows, but has certain problems (doe not work) under X (Linux). These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows.

在文件 dockwidget.cpp 第 1039 行定义.

◆ showNormal()

void QxDock::DockWidget::showNormal ( )

This function complements showFullScreen() to restore the widget after it has been in full screen mode.

在文件 dockwidget.cpp 第 1052 行定义.

◆ sideTab()

DockSideTab * QxDock::DockWidget::sideTab ( ) const

Returns the side tab widget for this dock, if this dock widget is in a auto hide container.

If it is not in a auto hide container, then this function returns a nullptr,

在文件 dockwidget.cpp 第 808 行定义.

◆ tab()

DockTab * QxDock::DockWidget::tab ( ) const

Returns the tab widget of this dock widget that is shown in the dock title bar

在文件 dockwidget.cpp 第 371 行定义.

◆ takeWidget()

QWidget * QxDock::DockWidget::takeWidget ( )

Remove the widget from the dock and give ownership back to the caller

在文件 dockwidget.cpp 第 345 行定义.

◆ titleBarActions()

QList< QAction * > QxDock::DockWidget::titleBarActions ( ) const

virtual

在文件 dockwidget.cpp 第 614 行定义.

◆ titleChanged()

void QxDock::DockWidget::titleChanged ( const QString & title )

◆ toggleAutoHide()

void QxDock::DockWidget::toggleAutoHide ( Qx::DockSideBarArea area = Qx::DockSideBarNone )

Switches the dock widget to auto hide mode or vice versa depending on its current state.

在文件 dockwidget.cpp 第 984 行定义.

◆ toggleView()

void QxDock::DockWidget::toggleView ( bool open = true )

This property controls whether the dock widget is open or closed.

The toogleViewAction triggers this slot

在文件 dockwidget.cpp 第 892 行定义.

◆ toggleViewAction()

QAction * QxDock::DockWidget::toggleViewAction ( ) const

Returns a checkable action that can be used to show or close this dock widget.

The action's text is set to the dock widget's window title.

在文件 dockwidget.cpp 第 563 行定义.

◆ toggleViewInternal()

void QxDock::DockWidget::toggleViewInternal ( bool open )

protected

Internal toggle view function that does not check if the widget already is in the given state

在文件 dockwidget.cpp 第 1165 行定义.

◆ toolBar()

QToolBar * QxDock::DockWidget::toolBar ( ) const

This function returns the dock widget top tool bar.

a default empty toolbar is assigned or you need to assign your custom toolbar via setToolBar().

在文件 dockwidget.cpp 第 700 行定义.

◆ toolBarIconSize()

QSize QxDock::DockWidget::toolBarIconSize ( DockWidget::State state ) const

在文件 dockwidget.cpp 第 775 行定义.

◆ toolBarStyle()

Qt::ToolButtonStyle QxDock::DockWidget::toolBarStyle ( DockWidget::State state ) const

在文件 dockwidget.cpp 第 745 行定义.

◆ toolBarStyleSource()

DockWidget::ToolBarStyleSource QxDock::DockWidget::toolBarStyleSource ( ) const

在文件 dockwidget.cpp 第 726 行定义.

◆ topLevelChanged()

void QxDock::DockWidget::topLevelChanged ( bool topLevel )

This signal is emitted when the floating property changes.

The topLevel parameter is true if the dock widget is now floating; otherwise it is false.

◆ viewToggled()

void QxDock::DockWidget::viewToggled ( bool open )

◆ visibilityChanged()

void QxDock::DockWidget::visibilityChanged ( bool visible )

This signal is emitted when the dock widget becomes visible (or invisible).

This happens when the widget is hidden or shown, as well as when it is docked in a tabbed dock panel and its tab becomes selected or unselected.

◆ widget()

QWidget * QxDock::DockWidget::widget ( ) const

Returns the widget for the dock widget.

This function returns zero if the widget has not been set.

在文件 dockwidget.cpp 第 336 行定义.

友元及相关函数文档

◆ DockAutoHideContainer

friend class DockAutoHideContainer

friend

在文件 dockwidget.h 第 251 行定义.

◆ DockContainer

friend class DockContainer

friend

在文件 dockwidget.h 第 245 行定义.

◆ DockFloatingContainer

friend class DockFloatingContainer

friend

在文件 dockwidget.h 第 250 行定义.

◆ DockPanel

friend class DockPanel

friend

在文件 dockwidget.h 第 246 行定义.

◆ DockTitleBarPrivate

friend class DockTitleBarPrivate

friend

在文件 dockwidget.h 第 249 行定义.

◆ DockWindow

friend class DockWindow

friend

在文件 dockwidget.h 第 247 行定义.

◆ DockWindowPrivate

friend class DockWindowPrivate

friend

在文件 dockwidget.h 第 248 行定义.

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

src/libs/qxdock/dockwidget.h
src/libs/qxdock/dockwidget.cpp

Public 类型

Public 成员函数

Protected 成员函数

静态 Protected 成员函数

友元

详细描述

成员类型定义说明

◆ FactoryFunc

◆ Super

成员枚举类型说明

◆ DockWidgetFeature

◆ MinimumSizeHintMode

◆ State

◆ ToggleViewActionMode

◆ ToolBarStyleSource

◆ WidgetInsertMode

构造及析构函数说明

◆ DockWidget()

◆ ~DockWidget()

成员函数说明

◆ autoHideArea()

◆ autoHideContainer()

◆ closed()

◆ closeDockWidget()

◆ closeDockWidgetInternal()

◆ closeRequested()

◆ deleteDockWidget()

◆ dockContainer()

◆ dockFloatingContainer()

◆ dockPanel()

◆ dockWindow()

◆ emitTopLevelChanged()

◆ emitTopLevelEventForWidget()

◆ event()

◆ features()

◆ featuresChanged()

◆ flagAsUnassigned()

◆ icon()

◆ isAutoHide()

◆ isCentralWidget()

◆ isClosed()

◆ isCurrentTab()

◆ isFloating()

◆ isFullScreen()

◆ isInFloatingContainer()

◆ isTabbed()

◆ minimumSizeHint()

◆ minimumSizeHintMode()

◆ notifyFeaturesChanged()

◆ raise()

◆ requestCloseDockWidget()

◆ saveState()

◆ setAsCurrentTab()

◆ setAutoHide()

◆ setClosedState()

◆ setDockPanel()

◆ setDockWindow()

◆ setFeature()

◆ setFeatures()

◆ setFloating()

◆ setIcon()

◆ setMinimumSizeHintMode()

◆ setSideTab()

◆ setTabToolTip()

◆ setTitleBarActions()

◆ setToggleViewAction()

◆ setToggleViewActionChecked()

◆ setToggleViewActionMode()

◆ setToolBar()

◆ setToolBarFloatingStyle()

◆ setToolBarIconSize()

◆ setToolBarStyle()

◆ setToolBarStyleSource()

◆ setWidget()

◆ setWidgetFactory()

◆ showFullScreen()

◆ showNormal()

◆ sideTab()

◆ tab()

◆ takeWidget()