Skip to content

Commit 59b4dfb

Browse files
Updated documentation
1 parent bfa5124 commit 59b4dfb

3 files changed

+66
-1
lines changed
13.4 KB
Loading
13.1 KB
Loading

doc/user-guide.md

+66-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
- [Auto Hide Dock Widgets](#auto-hide-dock-widgets)
3333
- [Pinning Auto-Hide Widgets to a certain border](#pinning-auto-hide-widgets-to-a-certain-border)
3434
- [Show / Hide Auto-Hide Widgets via Mouse Over](#show--hide-auto-hide-widgets-via-mouse-over)
35+
- [Drag \& Drop to Auto-Hide](#drag--drop-to-auto-hide)
36+
- [Auto-Hide Tab Insertion Order](#auto-hide-tab-insertion-order)
37+
- [Auto-Hide Tab Sorting](#auto-hide-tab-sorting)
38+
- [Auto-Hide Drag to Float / Dock](#auto-hide-drag-to-float--dock)
39+
- [Auto-Hide Context Menu](#auto-hide-context-menu)
3540
- [Adding Auto Hide Widgets](#adding-auto-hide-widgets)
3641
- [Setting Auto-Hide Flags](#setting-auto-hide-flags)
3742
- [`AutoHideFeatureEnabled`](#autohidefeatureenabled)
@@ -472,7 +477,14 @@ possible in various web browsers.
472477
473478
### `DisableTabTextEliding`
474479
475-
Set this flag to disable eliding of tab texts in dock area tabs.
480+
Set this flag to disable eliding of tab texts in dock area tabs:
481+
482+
![DisableTabTextEliding true](cfg_flag_DisableTabTextEliding_true.png)
483+
484+
The flag is disabled by default and the text in all tabs is elided to show as
485+
many tabs as possible even if there is not much space:
486+
487+
![DisableTabTextEliding false](cfg_flag_DisableTabTextEliding_false.png)
476488
477489
## Auto-Hide Configuration Flags
478490
@@ -510,6 +522,59 @@ the Auto-Hide widget is shown, if the user hovers over the Auto-Hide tab and is
510522
collapsed if the mouse cursor leaves the Auto-Hide widget. Showing and hiding
511523
by mouse click still works if this feature is enabled.
512524
525+
### Drag & Drop to Auto-Hide
526+
527+
You can easily drag any dock widget or any floating widget to the
528+
borders of a window to pin it as a auto-hide tab in one of the 4 sidebars.
529+
If you drag a dock widget close the one of the four window borders, special
530+
drop overlays will be shown to indicate the drop area for auto-hide widgets:
531+
532+
![Auo-Hide drag to Sidebar](AutoHide_Drag_to_Sidebar.gif)
533+
534+
Of course, this also works with dock areas:
535+
536+
![Auo-Hide drag Dock Area](AutoHide_Drag_DockArea.gif)
537+
538+
If you drag a dock widget or dock area into a sidebar, then you even have
539+
control over where tabs are inserted. Simply drag your mouse over a specific
540+
auto-hide tab, and your dragged dock widget will be inserted before this tab.
541+
Drag to the sidebar area behind the last tab, and the dragged widget will be
542+
appended as last tab. In the following screen capture, the **Image Viewer 1** will
543+
be inserted before the **Table 0** Auto-Hide tab and the **Image Viewer 2**
544+
is appended behind the last tab:
545+
546+
![Auo-Hide tab insert order](AutoHide_Tab_Insert_Order.gif)
547+
548+
### Auto-Hide Tab Insertion Order
549+
550+
It is also possible to drag Auto-Hide tabs to a new auto-hide position.
551+
That means, you can drag them to a different border or sidebar:
552+
553+
![Auto-Hide change sidebar](AutoHide_Change_Sidebar.gif)
554+
555+
### Auto-Hide Tab Sorting
556+
557+
You can drag Auto-Hide tabs to a new position in the current sidebar
558+
to sort them:
559+
560+
![Auo-Hide sort tabs](AutoHide_Sort_Tabs.gif)
561+
562+
### Auto-Hide Drag to Float / Dock
563+
564+
But that is not all. You can also simply move Auto-Hide tabs to another
565+
floating widget or dock them via drag and drop:
566+
567+
![Auo-Hide drag to float or dock](AutoHide_Drag_to_Float_or_Dock.gif)
568+
569+
### Auto-Hide Context Menu
570+
571+
All Auto-Hide tabs now have a context menu, that provides all the functionality
572+
that you know from Dock widget tabs. With the **Pin To...** item from the
573+
context menu it is very easy to move an Auto-Hide tab to a different Auto-Hide
574+
sidebar:
575+
576+
![Auo-Hide context menu](AutoHide_Context_Menu.png)
577+
513578
### Adding Auto Hide Widgets
514579
515580
Adding an auto hide widget is similar to adding a dock widget, simply call

0 commit comments

Comments
 (0)