History

DOCS: add clipboard documentations

nanahi committed 1 year ago

Commit b97e3b91 parent 510d6343 files · +34 −0Browse files

Unified · Split

3 files
  1. DOCS/interface-changes/clipboard.txt +2 −0
  2. DOCS/man/input.rst +17 −0
  3. DOCS/man/options.rst +15 −0
DOCS/interface-changes/clipboard.txt+2−0
@@ -0,0 +1,2 @@
1add `--clipboard-enable` and `--clipboard-monitor` options
2add `clipboard` property
DOCS/man/input.rst+17−0
@@ -3894,6 +3894,23 @@ Property list · 3893 unmodified lines
3894 3894
3895 This property is read-only, and change notification is not supported.3895 This property is read-only, and change notification is not supported.
3896 3896
3897``clipboard``
3898 The clipboard contents, only works when native clipboard
3899 (``--clipboard-enable``) is supported on the platform.
3900 Depending on the platform, some sub-properties, writing to properties,
3901 or change notifications are not currently functional.
3902
3903 This has a number of sub-properties:
3904
3905 ``clipboard/text`` (RW)
3906 The text content in the clipboard (Windows and Wayland only).
3907 Writing to this property sets the text clipboard content (Windows only).
3908
3909 .. note::
3910
3911 On Wayland, the clipboard content is only updated when the compositor
3912 sends a selection data offer (typically when VO window is focused).
3913
3897Inconsistencies between options and properties3914Inconsistencies between options and properties
3898----------------------------------------------3915----------------------------------------------
3899 3916
DOCS/man/options.rst+15−0
@@ -7814,3 +7814,18 @@ Miscellaneous · 7813 unmodified lines
7814 code is the same.)7814 code is the same.)
7815 7815
7816 Conversion is not applied to metadata that is updated at runtime.7816 Conversion is not applied to metadata that is updated at runtime.
7817
7818``--clipboard-enable=<yes|no>``
7819 (Windows and Wayland only)
7820
7821 Enable native clipboard support (default: yes). This allows reading and
7822 writing to the ``clipboard`` property to get and set clipboard contents.
7823
7824``--clipboard-monitor=<yes|no>``
7825 (Windows only)
7826
7827 Enable clipboard monitoring so that the ``clipboard`` property can be
7828 observed for content changes (default: no). This only affects clipboard
7829 implementations which use polling to monitor clipboard updates.
7830 Other platforms currently ignore this option and always/never notify
7831 changes.

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