History

DOCS/man/input: document user-data/osc/margins

This property is used by the built-in OSC and some third-party OSC scripts to indicate the margin they occupy so that other scripts such as console.lua can use this value to position UI elements.

nanahi committed 2 years ago

Commit 9133ce71 parent d302fe01 file · +8 −0Browse files

Unified · Split

DOCS/man/input.rst+8−0
@@ -3555,6 +3555,14 @@ Property list · 3554 unmodified lines
3555 upon, and writing to these properties may prevent builtin scripts from working3555 upon, and writing to these properties may prevent builtin scripts from working
3556 properly.3556 properly.
3557 3557
3558 Currently, the following properties have defined special semantics:
3559
3560 ``user-data/osc/margins``
3561 This property is written by an OSC implementation to indicate the margins that it
3562 occupies. Its sub-properties ``l``, ``r``, ``t``, and ``b`` should all be set to
3563 the left, right, top, and bottom margins respectively.
3564 Values are between 0.0 and 1.0, normalized to window width/height.
3565
3558 Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be3566 Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be
3559 read, written, or observed.3567 read, written, or observed.
3560 3568

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t