Skip to content

Commit 2730c13

Browse files
Removed OpaqueUndocking documentation
1 parent 9c30169 commit 2730c13

File tree

2 files changed

+4
-41
lines changed

2 files changed

+4
-41
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ know it from Visual Studio.
8484
- [Grouped dragging](#grouped-dragging)
8585
- [Perspectives for fast switching of the complete main window layout](#perspectives-for-fast-switching-of-the-complete-main-window-layout)
8686
- [Opaque and non-opaque splitter resizing](#opaque-and-non-opaque-splitter-resizing)
87-
- [Opaque and non-opaque undocking](#opaque-and-non-opaque-undocking)
87+
- [Cancelable docking process](#cancelable-docking-process)
8888
- [Tab-menu for easy handling of many tabbed dock widgets](#tab-menu-for-easy-handling-of-many-tabbed-dock-widgets)
8989
- [Many different ways to detach dock widgets](#many-different-ways-to-detach-dock-widgets)
9090
- [Supports deletion of dynamically created dock widgets](#supports-deletion-of-dynamically-created-dock-widgets)
@@ -170,17 +170,15 @@ If this flag is cleared, the widget resizing is deferred until the mouse button
170170

171171
![Non-opaque resizing](doc/non_opaque_resizing.gif)
172172

173-
### Opaque and non-opaque undocking
173+
### Cancelable docking process
174174

175-
By default, opaque undocking is active. That means, as soon as you drag a dock widget or a dock area with a number of dock widgets it will be undocked and moved into a floating widget and then the floating widget will be dragged around. That means undocking will take place immediately. You can compare this with opaque splitter resizing. If the flag `OpaqueUndocking` is cleared, then non-opaque undocking is active. In this mode, undocking is more like a standard drag and drop operation. That means, the dragged dock widget or dock area is not undocked immediately. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.
175+
In contrast to the standard Qt docking system, docking with the ADS works more like a drag & drop operation. That means, the dragged dock widget or dock area is not undocked immediately. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.
176176

177177
The drag preview widget can be configured by a number of global dock manager flags:
178178
- `DragPreviewIsDynamic`: if this flag is enabled, the preview will be adjusted dynamically to the drop area
179179
- `DragPreviewShowsContentPixmap`: the created drag preview window shows a static copy of the content of the dock widget / dock are that is dragged
180180
- `DragPreviewHasWindowFrame`: this flag configures if the drag preview is frameless like a QRubberBand or looks like a real window
181181

182-
The best way to test non-opaque undocking is to set the standard flags: `CDockManager::setConfigFlags(CDockManager::DefaultNonOpaqueConfig)`.
183-
184182
### Tab-menu for easy handling of many tabbed dock widgets
185183

186184
Tabs are a good way to quickly switch between dockwidgets in a dockarea. However, if the number of dockwidgets in a dockarea is too large, this may affect the usability of the tab bar. To keep track in this situation, you can use the tab menu. The menu allows you to quickly select the dockwidget you want to activate from a drop down menu.

doc/user-guide.md

+1-36
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
- [`TabCloseButtonIsToolButton`](#tabclosebuttonistoolbutton)
1212
- [`AllTabsHaveCloseButton`](#alltabshaveclosebutton)
1313
- [`RetainTabSizeWhenCloseButtonHidden`](#retaintabsizewhenclosebuttonhidden)
14-
- [`OpaqueUndocking`](#opaqueundocking)
1514
- [`DragPreviewIsDynamic`](#dragpreviewisdynamic)
1615
- [`DragPreviewShowsContentPixmap`](#dragpreviewshowscontentpixmap)
1716
- [`DragPreviewHasWindowFrame`](#dragpreviewhaswindowframe)
@@ -170,37 +169,6 @@ constant, that means, if enabled, the tabs need more space.
170169
171170
![AllTabsHaveCloseButton false](cfg_flag_RetainTabSizeWhenCloseButtonHidden_true.png)
172171
173-
### `OpaqueUndocking`
174-
175-
If this flag is set, opaque undocking is active. That means, as soon as you drag a dock widget or a dock area with a number of dock widgets it will be undocked and moved into a floating widget and then the floating widget will be dragged around. That means undocking will take place immediately. You can compare this with opaque splitter resizing.
176-
177-
![OpaqueUndocking true](opaque_undocking.gif)
178-
179-
If you would like to test opaque undocking, you should set the predefined config
180-
flags `CDockManager::DefaultOpaqueConfig`.
181-
182-
```c++
183-
CDockManager::setConfigFlags(CDockManager::DefaultOpaqueConfig);
184-
```
185-
186-
If this flag is cleared (default), then non-opaque undocking is active. In this mode, undocking is more like a standard drag and drop operation. That means, the dragged dock widget or dock area is not undocked immediatelly. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.
187-
188-
![OpaqueUndocking true](non_opaque_undocking.gif)
189-
190-
The drag preview widget can be configured by a number of global dock manager flags:
191-
192-
- `DragPreviewIsDynamic`
193-
- `DragPreviewShowsContentPixmap`
194-
- `DragPreviewHasWindowFrame`
195-
196-
Non-opaque undocking is enabled by default. If you would like to enable it
197-
explicitely, you can do this by setting the predefined configuration flags
198-
`CDockManager::DefaultNonOpaqueConfig`.
199-
200-
```c++
201-
CDockManager::setConfigFlags(CDockManager::DefaultNonOpaqueConfig);
202-
```
203-
204172
### `DragPreviewIsDynamic`
205173
206174
If non-opaque undocking is enabled, this flag defines the behavior of the drag
@@ -631,10 +599,7 @@ If set, the dock widget will have a close button.
631599
632600
If a dock widget is movable, then it and can be moved to a new position in the
633601
current dock container. Disable this flag to prevent moving of a dock widget
634-
via mouse. If the `OpaqueUndocking` configuration flag is set, then dock widgets
635-
are immediately undocked into floating widgets. That means, moving is only
636-
possible in this case, if the dock widget is also floatable (feature flag
637-
`DockWidgetFloatable` is set).
602+
via mouse.
638603
639604
### `DockWidgetFloatable`
640605

0 commit comments

Comments
 (0)