mirrors/Qt-Advanced-Docking-System
1
0
Fork 0
mirror of https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System.git synced 2025-04-01 02:42:39 +08:00
Code

Add documentation.

Browse Source
This commit is contained in:
Cynthia Pang 2023-10-10 15:44:12 +08:00
parent 4f25ad4aed
commit 7f42306c47
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/user-guide.md
View File

@ -41,6 +41,7 @@
- [`AutoHideSideBarsIconOnly`](#autohidesidebarsicononly) - [`AutoHideSideBarsIconOnly`](#autohidesidebarsicononly)
- [`AutoHideShowOnMouseOver`](#autohideshowonmouseover) - [`AutoHideShowOnMouseOver`](#autohideshowonmouseover)
- [`AutoHideCloseButtonCollapsesDock`](#autohideclosebuttoncollapsesdock) - [`AutoHideCloseButtonCollapsesDock`](#autohideclosebuttoncollapsesdock)
- [`AutoHideDockHasMinimizeButton`](#autohidedockhasminimizebutton)
- [DockWidget Feature Flags](#dockwidget-feature-flags) - [DockWidget Feature Flags](#dockwidget-feature-flags)
- [`DockWidgetClosable`](#dockwidgetclosable) - [`DockWidgetClosable`](#dockwidgetclosable)
- [`DockWidgetMovable`](#dockwidgetmovable) - [`DockWidgetMovable`](#dockwidgetmovable)
@ -51,6 +52,7 @@
- [`DockWidgetForceCloseWithArea`](#dockwidgetforceclosewitharea) - [`DockWidgetForceCloseWithArea`](#dockwidgetforceclosewitharea)
- [`NoTab`](#notab) - [`NoTab`](#notab)
- [`DeleteContentOnClose`](#deletecontentonclose) - [`DeleteContentOnClose`](#deletecontentonclose)
- [`AutoHideDockWidgetClosable`](#autohidedockwidgetclosable)
- [Central Widget](#central-widget) - [Central Widget](#central-widget)
- [Empty Dock Area](#empty-dock-area) - [Empty Dock Area](#empty-dock-area)
- [Custom Close Handling](#custom-close-handling) - [Custom Close Handling](#custom-close-handling)
@ -610,6 +612,11 @@ closing it.
![AutoHideCloseButtonCollapsesDock true](cfg_flag_AutoHideCloseButtonCollapsesDock_true.gif) ![AutoHideCloseButtonCollapsesDock true](cfg_flag_AutoHideCloseButtonCollapsesDock_true.gif)
### `AutoHideDockHasMinimizeButton`
Similar to the reason for `AutoHideCloseButtonCollapsesDock`, if this flag is set,
the auto hide widget will have a minimize button that collapses the auto hide widget.
## DockWidget Feature Flags ## DockWidget Feature Flags
### `DockWidgetClosable` ### `DockWidgetClosable`
@ -661,6 +668,10 @@ Deletes only the contained widget on close, keeping the dock widget intact and
in place. Attempts to rebuild the contents widget on show if there is a widget in place. Attempts to rebuild the contents widget on show if there is a widget
factory set. See [issue #365](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/pull/365) for more details. factory set. See [issue #365](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/pull/365) for more details.
### `AutoHideDockWidgetClosable`
If set, the close button in the auto hide widget will be enabled.
## Central Widget ## Central Widget
The Advanced Docking System has been developed to overcome the limitations of The Advanced Docking System has been developed to overcome the limitations of