Skip to content

Commit 5695d0d

Browse files
Added documentation for HideSingleCentralWidgetTitleBar configuration flag
1 parent e091be0 commit 5695d0d

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed
Loading
Loading

doc/user-guide.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- [`DockAreaDynamicTabsMenuButtonVisibility`](#dockareadynamictabsmenubuttonvisibility)
2323
- [`FloatingContainerHasWidgetTitle`](#floatingcontainerhaswidgettitle)
2424
- [`FloatingContainerHasWidgetIcon`](#floatingcontainerhaswidgeticon)
25+
- [`HideSingleCentralWidgetTitleBar`](#hidesinglecentralwidgettitlebar)
2526

2627
## Configuration Flags
2728

@@ -278,3 +279,20 @@ If set, the floating widget icon reflects the icon of the current dock widget
278279
otherwise (default setting) it displays application icon.
279280

280281
![FloatingContainerHasWidgetIcon false](cfg_flag_FloatingContainerHasWidgetIcon_false.png)
282+
283+
### `HideSingleCentralWidgetTitleBar`
284+
285+
If there is only one single visible dock widget in the main dock container (the dock manager) and if this flag is set, then the titlebar of this dock widget will be hidden.
286+
This only makes sense for non draggable and non floatable dock widgets and enables
287+
the creation of some kind of "central" static widget. Because the titlebar is
288+
hidden, it is not possible to drag out the central widget to make it floating
289+
or to close it via the close button.
290+
291+
![HideSingleCentralWidgetTitleBar true](cfg_flag_HideSingleCentralWidgetTitleBar_true.png)
292+
293+
The Advanced Docking System is meant for applications without a static cnetral
294+
widget and normally does not know anything about a central static widget.
295+
Therefore this flag is disabled by default and a central single dock widget
296+
still has a titlebar to drag it out of the main window.
297+
298+
![HideSingleCentralWidgetTitleBar false](cfg_flag_HideSingleCentralWidgetTitleBar_false.png)

0 commit comments

Comments
 (0)