SnapToRegion: Add documentation

This commit is contained in:
Consolatis 2023-01-07 03:30:10 +01:00
parent 07ee56176d
commit 111f48b485
3 changed files with 41 additions and 0 deletions

View file

@ -46,6 +46,10 @@ Actions are used in menus and keyboard/mouse bindings.
Resize window to fill half the output in the given direction. Supports
directions "left", "up", "right", "down" and "center".
*<action name="SnapToRegion" region="snap-1" />*
Resize and move active window according to the given region.
See labwc-config(5) for further information on how to define regions.
*<action name="NextWindow">*
Cycle focus to next window.

View file

@ -104,6 +104,16 @@ The rest of this man page describes configuration options.
*<snapping><topMaximize>* [yes|no]
Maximize window if Move operation ends on the top edge. Default is yes.
## REGIONS
*<regions><region name="snap-1" x="10%" y="10%" width="80%" height="80%">*
Define snap regions. The regions are calculated based on the usable area
of each output. Usable area in this context means space not exclusively
used by layershell clients like panels. The "%" character is required.
Windows can either be snapped to regions by keeping a keyboard modifier
pressed while moving a window (Ctrl, Alt, Shift, Logo) or by using the
SnapToRegion action. By default there are no regions defined.
## WORKSPACES
*<desktops><names><name>*

View file

@ -81,6 +81,21 @@
</names>
</desktops>
<!-- Percent based regions based on output usable area, % char is required -->
<!--
<regions>
<region name="top-left" x="0%" y="0%" height="50%" width="50%" />
<region name="top" x="0%" y="0%" height="50%" width="100%" />
<region name="top-right" x="50%" y="0%" height="50%" width="50%" />
<region name="left" x="0%" y="0%" height="100%" width="50%" />
<region name="center" x="10%" y="10%" height="80%" width="80%" />
<region name="right" x="50%" y="0%" height="100%" width="50%" />
<region name="bottom-left" x="0%" y="50%" height="50%" width="50%" />
<region name="bottom" x="0%" y="50%" height="50%" width="100%" />
<region name="bottom-right" x="50%" y="50%" height="50%" width="50%" />
</regions>
-->
<!--
Keybind actions are specified in labwc-actions(5)
The following keybind modifiers are supported:
@ -155,6 +170,18 @@
<keybind key="XF86_MonBrightnessDown">
<action name="Execute" command="brightnessctl set 10%-" />
</keybind>
<!-- SnapToRegion via W-Numpad -->
<!--
<keybind key="W-KP_7"><action name="SnapToRegion" region="top-left" /></keybind>
<keybind key="W-KP_8"><action name="SnapToRegion" region="top" /></keybind>
<keybind key="W-KP_9"><action name="SnapToRegion" region="top-right" /></keybind>
<keybind key="W-KP_4"><action name="SnapToRegion" region="left" /></keybind>
<keybind key="W-KP_5"><action name="SnapToRegion" region="center" /></keybind>
<keybind key="W-KP_6"><action name="SnapToRegion" region="right" /></keybind>
<keybind key="W-KP_1"><action name="SnapToRegion" region="bottom-left" /></keybind>
<keybind key="W-KP_2"><action name="SnapToRegion" region="bottom" /></keybind>
<keybind key="W-KP_3"><action name="SnapToRegion" region="bottom-right" /></keybind>
-->
</keyboard>
<!--