mirrors/Qt-Advanced-Docking-System
1
0
Fork 0
mirror of https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System.git synced 2024-12-26 08:01:32 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fixed some documentation typos

Browse Source
This commit is contained in:
Uwe Kindler 2022-10-25 19:57:40 +02:00
parent 8ef696f6f2
commit 00e4dc14ba
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -153,7 +153,7 @@ If this flag is cleared, the widget resizing is deferred until the mouse button
### Opaque and non-opaque undocking ### Opaque and non-opaque undocking
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 immediatelly. 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 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. 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.
The drag preview widget can be configured by a number of global dock manager flags: The drag preview widget can be configured by a number of global dock manager flags:
- `DragPreviewIsDynamic`: if this flag is enabled, the preview will be adjusted dynamically to the drop area - `DragPreviewIsDynamic`: if this flag is enabled, the preview will be adjusted dynamically to the drop area
@ -416,7 +416,7 @@ D-Tect X is a X-ray inspection software for industrial radiography. It is a stat
HiveWE is a Warcraft III world editor. It focusses on speed and ease of use, HiveWE is a Warcraft III world editor. It focusses on speed and ease of use,
especially for large maps where the regular World Editor is often too slow and clunky. especially for large maps where the regular World Editor is often too slow and clunky.
It has a JASS editor with syntax hightlighting, tabs, code completion and more. It has a JASS editor with syntax highlighting, tabs, code completion and more.
The JASS editor uses the Qt Advanced Docking System for the management and layout The JASS editor uses the Qt Advanced Docking System for the management and layout
of the open editor windows. of the open editor windows.

15
doc/user-guide.md
View File

@ -47,7 +47,7 @@
## Configuration Flags ## Configuration Flags
The Advanced Docking System has a number of global configuration options to The Advanced Docking System has a number of global configuration options to
configure the design and the functionality of the docking system. Eachs configure the design and the functionality of the docking system. Each
configuration will be explained in detail in the following sections. configuration will be explained in detail in the following sections.
### Setting Configuration Flags ### Setting Configuration Flags
@ -67,9 +67,9 @@ d->DockManager = new CDockManager(this);
If you set the configurations flags, you can set individual flags using the If you set the configurations flags, you can set individual flags using the
function `CDockManager::setConfigFlag` or you can set all flags using function `CDockManager::setConfigFlag` or you can set all flags using
the function `CDockManager::setConfigFlags`. Instead of settings all the function `CDockManager::setConfigFlags`. Instead of settings all
flags individualy, it is better to pick a predefined set of configuration flags individually, it is better to pick a predefined set of configuration
flags and then modify individual flags. The following predefined flags and then modify individual flags. The following predefined
configurations are avilable configurations are available
- `DefaultNonOpaqueConfig` - uses non opaque splitter resizing and non opaque docking - `DefaultNonOpaqueConfig` - uses non opaque splitter resizing and non opaque docking
- `DefaultOpaqueConfig` - uses opaque splitter resizing and opaque docking - `DefaultOpaqueConfig` - uses opaque splitter resizing and opaque docking
@ -160,11 +160,11 @@ constant, that means, if enabled, the tabs need more space.
### `OpaqueUndocking` ### `OpaqueUndocking`
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 immediatelly. You can compare this with opaque splitter resizing. 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.
![OpaqueUndocking true](opaque_undocking.gif) ![OpaqueUndocking true](opaque_undocking.gif)
If you would like to test opaque undocking, you should set the pedefined config If you would like to test opaque undocking, you should set the predefined config
flags `CDockManager::DefaultOpaqueConfig`. flags `CDockManager::DefaultOpaqueConfig`.
```c++ ```c++
@ -324,7 +324,7 @@ still has a titlebar to drag it out of the main window.
If this is enabled, the docking system is able to highlight the tab and the If this is enabled, the docking system is able to highlight the tab and the
components of a dock area with a different style (i.e. a different color). components of a dock area with a different style (i.e. a different color).
This option is disabled by default and needs to be enabled explicitely This option is disabled by default and needs to be enabled explicitly
because it adds some overhead. The dock manager needs to react on focus because it adds some overhead. The dock manager needs to react on focus
changes and dock widget dragging to highlight the right dock widget. You should changes and dock widget dragging to highlight the right dock widget. You should
enable it only, if you really need it for your application. enable it only, if you really need it for your application.
@ -344,7 +344,7 @@ be set to true and you can use this property to style the focused dock
widget differently. The picture above uses the following styling: widget differently. The picture above uses the following styling:
```css ```css
/* Color the tab with the nhighlight color */ /* Color the tab with the highlight color */
ads--CDockWidgetTab[focused="true"] ads--CDockWidgetTab[focused="true"]
{ {
background: palette(highlight); background: palette(highlight);
@ -626,3 +626,4 @@ just call the function for settings the stylesheet with an empty string.
```c++ ```c++
DockManager->setStyleSheet(""); DockManager->setStyleSheet("");
``` ```