Add async clipboard module to internal API docs

This commit is contained in:
Tobias 2025-06-11 15:48:44 +02:00
parent d9b45d390b
commit 3d5698c71c
1 changed files with 26 additions and 4 deletions

View File

@ -18,6 +18,8 @@ keysym values.
* __Display__ (core/display.js): Efficient 2D rendering abstraction * __Display__ (core/display.js): Efficient 2D rendering abstraction
layered on the HTML5 canvas element. layered on the HTML5 canvas element.
* __Clipboard__ (core/clipboard.js): Clipboard event handler.
* __Websock__ (core/websock.js): Websock client from websockify * __Websock__ (core/websock.js): Websock client from websockify
with transparent binary data support. with transparent binary data support.
[Websock API](https://github.com/novnc/websockify-js/wiki/websock.js) wiki page. [Websock API](https://github.com/novnc/websockify-js/wiki/websock.js) wiki page.
@ -25,10 +27,10 @@ with transparent binary data support.
## 1.2 Callbacks ## 1.2 Callbacks
For the Mouse, Keyboard and Display objects the callback functions are For the Mouse, Keyboard, Display, and Clipboard objects, the callback
assigned to configuration attributes, just as for the RFB object. The functions are assigned to configuration attributes, just as for the RFB
WebSock module has a method named 'on' that takes two parameters: the object. The WebSock module has a method named 'on' that takes two
callback event name, and the callback function. parameters: the callback event name, and the callback function.
## 2. Modules ## 2. Modules
@ -81,3 +83,23 @@ None
| blitImage | (x, y, width, height, arr, offset, from_queue) | Blit pixels (of R,G,B,A) to the display | blitImage | (x, y, width, height, arr, offset, from_queue) | Blit pixels (of R,G,B,A) to the display
| drawImage | (img, x, y) | Draw image and track damage | drawImage | (img, x, y) | Draw image and track damage
| autoscale | (containerWidth, containerHeight) | Scale the display | autoscale | (containerWidth, containerHeight) | Scale the display
## 2.3 Clipboard module
### 2.3.1 Configuration attributes
None
### 2.3.2 Methods
| name | parameters | description
| ------------------ | ----------------- | ------------
| writeClipboard | (text) | An async write text to clipboard
| grab | () | Begin capturing clipboard events
| ungrab | () | Stop capturing clipboard events
### 2.3.3 Callbacks
| name | parameters | description
| ------- | ---------- | ------------
| onpaste | (text) | Called following a target focus event and an async clipboard read