Skip to content

Commit 9174339

Browse files
Added Auto-Hide functionality to README.md
1 parent 407c70a commit 9174339

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ know it from Visual Studio.
7373
- [Tab-menu for easy handling of many tabbed dock widgets](#tab-menu-for-easy-handling-of-many-tabbed-dock-widgets)
7474
- [Many different ways to detach dock widgets](#many-different-ways-to-detach-dock-widgets)
7575
- [Supports deletion of dynamically created dock widgets](#supports-deletion-of-dynamically-created-dock-widgets)
76+
- [Auto-Hide Functionality](#auto-hide-functionality)
7677
- [Python Bindings](#python-bindings)
7778
- [PySide6](#pyside6)
7879
- [PyQt5](#pyqt5)
@@ -182,6 +183,31 @@ You can detach dock widgets and also dock areas in the following ways:
182183

183184
Normally clicking the close button of a dock widget will just hide the widget and the user can show it again using the toggleView() action of the dock widget. This is meant for user interfaces with a static amount of widgets. But the advanced docking system also supports dynamic dock widgets that will get deleted on close. If you set the dock widget flag `DockWidgetDeleteOnClose` for a certain dock widget, then it will be deleted as soon as you close this dock widget. This enables the implementation of user interfaces with dynamically created editors, like in word processing applications or source code development tools.
184185

186+
### Auto-Hide Functionality
187+
188+
The 4.0 release of ADS added the new **Auto-Hide** feature. Thanks to the initial
189+
contribution by an ADS user, it was possible to close this long standing feature
190+
request. The "Auto Hide" feature
191+
allows to display more information using less screen space by hiding or showing
192+
windows pinned to one of the four dock container borders. The Advanced Docking
193+
System supports "Auto-Hide" functionality for **all** dock containers - that means,
194+
for the main window and for each floating widget. Here is short list of all
195+
auto hide features:
196+
197+
- supported for the main window and all floating dock containers
198+
- supports showing and hiding via mouse click or mouse hover
199+
- respects opaque / non opaque splitter resizing flag
200+
- context menu for pinning a dock widget or a complete dock area to a certain border
201+
- configuration option to configure if the pin button should pin the current
202+
dock widget tab or a complete dock area
203+
- click the pin button holding the Ctrl key to pin a complete dock area
204+
- fully CSS styleable
205+
- backward compatible state file format - is is possible to load older dock manager
206+
state files without auto hide support and older versions can load the new state
207+
files with Auto-Hide state information
208+
209+
More about the auto hide configuration options in the [online documentation...](doc/user-guide.md#auto-hide-configuration-flags)
210+
185211
## Python Bindings
186212

187213
![Python Logo](doc/python_logo.png)

0 commit comments

Comments
 (0)