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:
Syarif Fakhri 2023-06-20 12:29:53 +08:00
parent 9e9d166542
commit 0e9284d602
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/insert_tab_with_dock_order.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 204 KiB

9
doc/user-guide.md
View File

@ -40,6 +40,7 @@
- [`AutoHideSideBarsIconOnly`](#autohidesidebarsicononly)
- [`AutoHideShowOnMouseOver`](#autohideshowonmouseover)
- [`AutoHideCloseButtonCollapsesDock`](#autohideclosebuttoncollapsesdock)
- [`Autohide tab dock order`](#autohide-tab-dock-order)
- [DockWidget Feature Flags](#dockwidget-feature-flags)
- [`DockWidgetClosable`](#dockwidgetclosable)
- [`DockWidgetMovable`](#dockwidgetmovable)
@ -605,6 +606,14 @@ closing it.
![AutoHideCloseButtonCollapsesDock true](cfg_flag_AutoHideCloseButtonCollapsesDock_true.gif)
### Auto Hide Tab Dock Order
Optionally, you may set the auto hide tab order preference, set via `DockWidget->setAutoHideTabOrder(n)`. You must set it to a positive float value (negative float values are ignored). The default value is -1.0 and will be ignored. Setting it to a lower positive float value will order tabs behind docks that have higher float values. For example, if `Dock Widget A` is set to 1.0 and `Dock Widget B` is set to 2.0, `Dock Widget A` will always be inserted behind `Dock Widget B` in the auto hide sidebar.
If some dock widgets have an order but others do not, the widgets without an order set will be skipped. If none of the dock widgets have a set order, then the dock widget with an order set will be set at the end (the default behavior).
![Auto hide tab dock order set](insert_tab_with_dock_order.gif)
## DockWidget Feature Flags
### `DockWidgetClosable`