Update documentation

This commit is contained in:
Simon Long 2024-05-03 15:32:55 +01:00
parent 19a57c6ea4
commit 5b60f3c80f
3 changed files with 21 additions and 56 deletions

View file

@ -909,40 +909,6 @@ situation.
option has been exposed for unusual use-cases. It is equivalent to
Openbox's `<hideDelay>`. Default is 250 ms.
## MAGNIFIER
```
<magnifier>
<width>400</width>
<height>400</height>
<initScale>2</initScale>
<borderColour>#ff0000</borderColour>
<borderWidth>1</borderWidth>
<useFilter>true</useFilter>
</magnifier>
```
*<magnifier><width>*
The width of the magnifier window in pixels.
*<magnifier><height>*
The height of the magnifier window in pixels.
*<magnifier><initScale>*
The number of times by which the magnified image is scaled. This
is the default value at boot time; this can be modified at run-time
in a keyboard or mouse binding by calling 'ZoomIn' or 'ZoomOut'.
*<magnifier><borderColour>* [#RRGGBB]
The colour of the magnfier border as an RGB value.
*<magnifier><borderWidth>*
The width of the magnifier window border in pixels.
*<magnifier><useFilter>* [yes|no|default]
Whether to apply a bilinear filter to the magnified image, or
just to use nearest-neighbour.
## ENVIRONMENT VARIABLES
*XCURSOR_THEME* and *XCURSOR_SIZE* are supported to set cursor theme

View file

@ -277,6 +277,27 @@ elements are not listed here, but are supported.
*window.inactive.border.color*. This is obsolete, but supported for
backward compatibility as some themes still contain it.
*magnifier.width*
Width of magnifier window in pixels.
*magnifier.height*
Height of magnifier window in pixels.
*magnifier.border.width*
Width of magnifier window border in pixels.
*magnifier.border.color*
Color of the magnfier window border.
*magnifier.init-scale*
Initial number of times by which magnified image is scaled. Value
is the default at boot; can be modified at run-time in a keyboard
or mouse binding by calling 'ZoomIn' or 'ZoomOut'.
*magnifier.filter*
Set to 1 to apply a bilinear filter to the magnified image.
Set to 0 to use nearest-neighbour.
# BUTTONS
The images used for the titlebar icons are referred to as buttons.

View file

@ -590,26 +590,4 @@
<ignoreButtonReleasePeriod>250</ignoreButtonReleasePeriod>
</menu>
<!--
Magnifier settings
'width' sets the width in pixels of the magnifier window.
'height' sets the height in pixels of the magnifier window.
'initScale' sets the initial magnification factor at boot.
'borderColour' is an XML RGB string with a leading # which sets the
colour of the border of the magnifier window.
'borderWidth' sets the width in pixels of the border of the
magnifier window.
'useFilter' sets whether to use a bilinear filter on the magnified
output or simply to take nearest pixel.
-->
<magnifier>
<width>400</width>
<height>400</height>
<initScale>2</initScale>
<borderColour>#ff0000</borderColour>
<borderWidth>1</borderWidth>
<useFilter>true</useFilter>
</magnifier>
</labwc_config>