Skip to content

Commit

Permalink
DOCS: add clipboard documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
na-na-hi committed Nov 22, 2024
1 parent beca301 commit f5ec552
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions DOCS/interface-changes/clipboard.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
add `--clipboard-enabled` and `--clipboard-monitor` options
add `clipboard` property
12 changes: 12 additions & 0 deletions DOCS/man/input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3893,6 +3893,18 @@ 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).

Inconsistencies between options and properties
----------------------------------------------

Expand Down
15 changes: 15 additions & 0 deletions DOCS/man/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7793,3 +7793,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.

0 comments on commit f5ec552

Please sign in to comment.