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

Fixed some documentation typos

Browse Source
This commit is contained in:
Uwe Kindler 2020-09-03 15:31:11 +02:00
parent 8fe9461872
commit 6846c96146
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/user-guide.md
View File

@ -435,14 +435,14 @@ in a splitter:
### `FloatingContainerForceNativeTitleBar` (Linux only) ### `FloatingContainerForceNativeTitleBar` (Linux only)
Since release 3.6 the library supports native titlebars and window decorations Since release 3.6 the library supports native title bars and window decorations
for floating widgets on Linux (thanks to a user contribution). for floating widgets on Linux (thanks to a user contribution).
Native titlebars and window decorations are supported by most Linux window Native title bars and window decorations are supported by most Linux window
managers, such as Compiz or Xfwm. Some window managers like KWin do not properly managers, such as Compiz or Xfwm. Some window managers like KWin do not properly
support this feature. Native floating widgets look better because of the native support this feature. Native floating widgets look better because of the native
styling and the support all window manager features like snapping to window styling and the support all window manager features like snapping to window
borders or maximizing. The library tries to detect the window manager and borders or maximizing. The library tries to detect the window manager during
activates native window decorations if possible: runtime and activates native window decorations if possible:
![FloatingContainerForceNativeTitleBar true](cfg_flag_FloatingContainerForceNativeTitleBar_true.png) ![FloatingContainerForceNativeTitleBar true](cfg_flag_FloatingContainerForceNativeTitleBar_true.png)
@ -453,13 +453,13 @@ flag, if you set the environment variable `ADS_UseNativeTitle` to 0 or 1.
### `FloatingContainerForceQWidgetTitleBar` (Linux only) ### `FloatingContainerForceQWidgetTitleBar` (Linux only)
If your window manager (i.e. KWin) does not properly support native floating If your window manager (i.e. KWin) does not properly support native floating
windows, the docking library falls back to QWidget based titlebars for windows, the docking library falls back to QWidget based floating widget
floating widgets. title bars.
![FloatingContainerForceNativeTitleBar false](cfg_flag_FloatingContainerForceNativeTitleBar_false.png) ![FloatingContainerForceNativeTitleBar false](cfg_flag_FloatingContainerForceNativeTitleBar_false.png)
If you would like to overwrite autodetection, thne you can activate this flag If you would like to overwrite autodetection, then you can activate this flag
to force QWidget based titlebars. You can overwrite autodetection and this to force QWidget based title bars. You can overwrite autodetection and this
flag, if you set the environment variable `ADS_UseNativeTitle` to 0 or 1. flag, if you set the environment variable `ADS_UseNativeTitle` to 0 or 1.
## Central Widget ## Central Widget
@ -473,21 +473,24 @@ now supports a central widget.
In the Advanced Docking System a central widget is a docking widget that is In the Advanced Docking System a central widget is a docking widget that is
neither closable nor movable or floatable. A central widget has no title bar neither closable nor movable or floatable. A central widget has no title bar
and so it is not possible for the user to hide, close or drag the central and so it is not possible for the user to hide, close or drag the central
widget. Tf there is a central widget, then also the distribution of the sizes widget. If there is a central widget, then also the distribution of the sizes
for the dock widgets around the central widget is different. If there is no for the dock widgets around the central widget is different. If there is no
central widget and the main windo is resized, then the available space is central widget and the main window is resized, then the available space is
distributed to all dock widgets. If a central widget exists, then only the distributed to all dock widgets. If a central widget exists, then only the
central widget is resized when resizing the main window. The dock widgets around central widget is resized when resizing the main window. The dock widgets around
the central widget keep their sizes. The following animation shows this: the central widget keep their sizes. The following animation shows this:
![Central Widget](central_widget.gif) ![Central Widget](central_widget.gif)
To set a centra widget, you just need to call the To set a centra widget, you just need to pass your central dock widget
to the dock manager `setCentralWidget` function:
```c++ ```c++
auto* CentralDockArea = DockManager->setCentralWidget(CentralDockWidget); auto* CentralDockArea = DockManager->setCentralWidget(CentralDockWidget);
``` ```
See the `centralwidget` example to learn how it works.
## Styling ## Styling
The Advanced Docking System supports styling via [Qt Style Sheets](https://doc.qt.io/qt-5/stylesheet.html). All components like splitters, tabs, buttons, titlebar and The Advanced Docking System supports styling via [Qt Style Sheets](https://doc.qt.io/qt-5/stylesheet.html). All components like splitters, tabs, buttons, titlebar and