Skip to content

Commit 6ff39bc

Browse files
committed
Add open auto-hide dock on hover from drag and drop (#663)
1 parent 952131a commit 6ff39bc

File tree

7 files changed

+614
-581
lines changed

7 files changed

+614
-581
lines changed
269 KB
Loading

doc/user-guide.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
- [`AutoHideCloseButtonCollapsesDock`](#autohideclosebuttoncollapsesdock)
5050
- [`AutoHideHasCloseButton`](#autohidehasclosebutton)
5151
- [`AutoHideHasMinimizeButton`](#autohidehasminimizebutton)
52+
- [`AutoHideOpenOnDragHover`](#autohideopenondraghover)
5253
- [DockWidget Feature Flags](#dockwidget-feature-flags)
5354
- [`DockWidgetClosable`](#dockwidgetclosable)
5455
- [`DockWidgetMovable`](#dockwidgetmovable)
@@ -150,7 +151,7 @@ This ie enabled by default to minimize the size of the saved data.
150151
151152
### `TabCloseButtonIsToolButton`
152153
153-
If enabled the tab close buttons will be `QToolButtons` instead of `QPushButtons` -
154+
If enabled the tab close buttons will be `QToolButtons` instead of `QPushButtons` -
154155
disabled by default. Normally the default configuration should be ok but if your
155156
application requires `QToolButtons` instead of `QPushButtons` for styling reasons
156157
or for any other reasons, then you can enable this flag.
@@ -181,7 +182,7 @@ constant, that means, if enabled, the tabs need more space.
181182
182183
### `DragPreviewIsDynamic`
183184
184-
If non-opaque undocking is enabled, this flag defines the behavior of the drag
185+
If non-opaque undocking is enabled, this flag defines the behavior of the drag
185186
preview window. If this flag is enabled, then it will give the user the
186187
impression, that the floating drag preview is dynamically adjusted to the drop
187188
area. In order to give the perfect impression, you should disable the flags
@@ -197,7 +198,7 @@ CDockManager::setConfigFlag(CDockManager::DragPreviewHasWindowFrame, false);
197198

198199
### `DragPreviewShowsContentPixmap`
199200

200-
If non-opaque undocking is enabled, the created drag preview window shows a
201+
If non-opaque undocking is enabled, the created drag preview window shows a
201202
copy of the content of the dock widget / dock are that is dragged, if this
202203
flag is enabled (default).
203204

@@ -210,7 +211,7 @@ like window without any content.
210211

211212
### `DragPreviewHasWindowFrame`
212213

213-
If non-opaque undocking is enabled, then this flag configures if the drag
214+
If non-opaque undocking is enabled, then this flag configures if the drag
214215
preview is frameless (default) or looks like a real window. If it is enabled,
215216
then the drag preview is a transparent window with a system window frame.
216217

@@ -378,7 +379,7 @@ ads--CDockAreaWidget[focused="true"] ads--CDockAreaTitleBar
378379

379380
If you have a content widget that does not support focussing for some reason
380381
(like `QVTKOpenGLStereoWidget` from the [VTK library](https://github.com/Kitware/VTK)),
381-
then you can manually switch the focus by reacting on mouse events. The
382+
then you can manually switch the focus by reacting on mouse events. The
382383
following code shows, how to install en event filter on the `QVTKOpenGLStereoWidget`
383384
to properly switch the focus on `QEvent::MouseButtonPress`:
384385

@@ -422,7 +423,7 @@ bool CMainWindow::eventFilter(QObject *watched, QEvent *event)
422423
### `EqualSplitOnInsertion`
423424

424425
This flag configures how the space is distributed if a new dock widget is
425-
inserted into an existing dock area. The flag is disabled by default. If 3
426+
inserted into an existing dock area. The flag is disabled by default. If 3
426427
dock widgets are inserted with the following code
427428

428429
```c++
@@ -433,7 +434,7 @@ then this is the result, if the flag is disabled:
433434
434435
![EqualSplitOnInsertion false](cfg_flag_EqualSplitOnInsertion_false.png)
435436
436-
If the flag is enabled, then the space is equally distributed to all widgets
437+
If the flag is enabled, then the space is equally distributed to all widgets
437438
in a splitter:
438439
439440
![EqualSplitOnInsertion true](cfg_flag_EqualSplitOnInsertion_true.png)
@@ -501,7 +502,7 @@ for active tabs. Inactive tabs only show their icon:
501502
502503
The Advanced Docking System supports "Auto-Hide" functionality for **all**
503504
dock containers. The "Auto Hide" feature allows to display more information
504-
using less screen space by hiding or showing windows pinned to one of the
505+
using less screen space by hiding or showing windows pinned to one of the
505506
four dock container borders.
506507
507508
Enabling this feature adds a button with a pin icon to each dock area.
@@ -563,7 +564,7 @@ That means, you can drag them to a different border or sidebar:
563564
564565
### Auto-Hide Tab Sorting
565566
566-
You can drag Auto-Hide tabs to a new position in the current sidebar
567+
You can drag Auto-Hide tabs to a new position in the current sidebar
567568
to sort them:
568569
569570
![Auo-Hide sort tabs](AutoHide_Sort_Tabs.gif)
@@ -632,7 +633,7 @@ the other Auto-Hide flags will be evaluated.
632633
633634
### `DockAreaHasAutoHideButton`
634635
635-
If this flag is set (default), then each dock area has a pin button in the title
636+
If this flag is set (default), then each dock area has a pin button in the title
636637
bar to toggle Auto-Hide state.
637638
638639
![DockAreaHasAutoHideButton true](cfg_flag_DockAreaHasAutoHideButton.png)
@@ -676,7 +677,7 @@ works if this feature is enabled.
676677
Some users don't understand the distinction between closing an auto hide dock and
677678
collapsing an auto hide dock. This may lead to situations where they press the
678679
close button (losing the side tab widget) instead of simply clicking outside
679-
the auto hide dock (collapsing the dock).
680+
the auto hide dock (collapsing the dock).
680681
681682
![AutoHideCloseButtonCollapsesDock false](cfg_flag_AutoHideCloseButtonCollapsesDock_false.gif)
682683
@@ -704,6 +705,15 @@ If this flag is set (disabled by default), then each auto hide widget has a mini
704705
705706
![AutoHideHasMinimizeButton](cfg_flag_AutoHideHasMinimizeButton.png)
706707
708+
709+
### `AutoHideOpenOnDragHover`
710+
711+
If this flag is set (disabled by default), then holding a dragging cursor hover an auto-hide collapsed dock's tab will open said dock:
712+
713+
![AutoHideOpenOnDragHover](cfg_flag_AutoHideOpenOnDragHover.gif)
714+
715+
Said dock must be set to accept drops to hide when cursor leaves its scope.
716+
707717
## DockWidget Feature Flags
708718
709719
### `DockWidgetClosable`

0 commit comments

Comments
 (0)