DOCS: add clipboard documentations

This commit is contained in:
nanahi
2024-11-22 04:34:11 -05:00
committed by Kacper Michajłow
parent 510d634b5b
commit b97e3b9e4b
3 changed files with 34 additions and 0 deletions

View File

@@ -0,0 +1,2 @@
add `--clipboard-enable` and `--clipboard-monitor` options
add `clipboard` property

View File

@@ -3894,6 +3894,23 @@ Property list
This property is read-only, and change notification is not supported.
``clipboard``
The clipboard contents, only works when native clipboard
(``--clipboard-enable``) is supported on the platform.
Depending on the platform, some sub-properties, writing to properties,
or change notifications are not currently functional.
This has a number of sub-properties:
``clipboard/text`` (RW)
The text content in the clipboard (Windows and Wayland only).
Writing to this property sets the text clipboard content (Windows only).
.. note::
On Wayland, the clipboard content is only updated when the compositor
sends a selection data offer (typically when VO window is focused).
Inconsistencies between options and properties
----------------------------------------------

View File

@@ -7814,3 +7814,18 @@ Miscellaneous
code is the same.)
Conversion is not applied to metadata that is updated at runtime.
``--clipboard-enable=<yes|no>``
(Windows and Wayland only)
Enable native clipboard support (default: yes). This allows reading and
writing to the ``clipboard`` property to get and set clipboard contents.
``--clipboard-monitor=<yes|no>``
(Windows only)
Enable clipboard monitoring so that the ``clipboard`` property can be
observed for content changes (default: no). This only affects clipboard
implementations which use polling to monitor clipboard updates.
Other platforms currently ignore this option and always/never notify
changes.