From 3f5bfc31390b54ff18206c8e62793f2cdfff3d43 Mon Sep 17 00:00:00 2001 From: Uwe Kindler Date: Tue, 14 Apr 2020 20:00:59 +0200 Subject: [PATCH] Added new sections to user-guide.md --- doc/user-guide.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/doc/user-guide.md b/doc/user-guide.md index b4c01a9..5bad694 100644 --- a/doc/user-guide.md +++ b/doc/user-guide.md @@ -53,4 +53,38 @@ If the flag is set (default configuration) each dock area has a close button. If this flag is cleared, dock areas do not have a close button. -![DockAreaHasCloseButton true](cfg_flag_DockAreaHasCloseButton_false.png) \ No newline at end of file +![DockAreaHasCloseButton true](cfg_flag_DockAreaHasCloseButton_false.png) + +### `DockAreaCloseButtonClosesTab` + +If the flag is set, the dock area close button closes the active tab, +if not set, it closes the complete dock area (default). + +### `OpaqueSplitterResize` + +The advanced docking system uses standard QSplitters as resize separators and thus supports opaque and non-opaque resizing functionality of QSplitter. In some rare cases, for very complex widgets or on slow machines resizing via separator on the fly may cause flicking and glaring of rendered content inside a widget. This global dock manager flag configures the resizing behaviour of the splitters. If this flag is set, then widgets are resized dynamically (opaquely) while interactively moving the splitters. If you select the predefined configuration `DefaultOpaqueConfig`, then this is the configured behaviour. + +![Opaque resizing](opaque_resizing.gif) + +If this flag is cleared, the widget resizing is deferred until the mouse button is released - this is some kind of lazy resizing separator. If you select the predefined +configuration `DefaultNonOpaqueConfig`, then this is the configured behaviour. + +![Non-opaque resizing](non_opaque_resizing.gif) + +### `XmlAutoFormattingEnabled` + +If enabled, the XML writer automatically adds line-breaks and indentation to +empty sections between elements (ignorable whitespace). This is used, when +the current state or perspective is saved. It is disabled by default. + +### `XmlCompressionEnabled` + +If enabled, the XML output will be compressed and is not human readable anymore. +This ie enabled by default to minimize the size of the saved data. + +### `TabCloseButtonIsToolButton` + +If enabled the tab close buttons will be `QToolButtons` instead of `QPushButtons` - +disabled by default. Normally the default configuration should be ok but if your +application requires `QToolButtons` instead of `QPushButtons` for styling reasons +or for any other reasons, then you can enable this flag.