Export clipping state externally
So that UI can reflect if it is currently possible to drag the viewport or not.
This commit is contained in:
15
docs/API.md
15
docs/API.md
@@ -31,6 +31,11 @@ protocol stream.
|
||||
| -------- | --------- | -----------
|
||||
| `power` | `boolean` | Machine power control is available
|
||||
|
||||
`clippingViewport` *Read only*
|
||||
- Is a `boolean` indicating if the remote session is currently being
|
||||
clipped to its container. Only relevant if `clipViewport` is
|
||||
enabled.
|
||||
|
||||
`clipViewport`
|
||||
- Is a `boolean` indicating if the remote session should be clipped
|
||||
to its container. When disabled scrollbars will be shown to handle
|
||||
@@ -94,6 +99,10 @@ protocol stream.
|
||||
- The `clipboard` event is fired when clipboard data is received from
|
||||
the server.
|
||||
|
||||
[`clippingviewport`](#clippingviewport)
|
||||
- The `clippingviewport` event is fired when `RFB.clippingViewport` is
|
||||
updated.
|
||||
|
||||
[`connect`](#connect)
|
||||
- The `connect` event is fired when the `RFB` object has completed
|
||||
the connection and handshaking with the server.
|
||||
@@ -227,6 +236,12 @@ The `capabilities` event is fired whenever an entry is added or removed
|
||||
from `RFB.capabilities`. The `detail` property is an `Object` with the
|
||||
property `capabilities` containing the new value of `RFB.capabilities`.
|
||||
|
||||
#### clippingviewport
|
||||
|
||||
The `clippingviewport` event is fired whenever `RFB.clippingViewport`
|
||||
changes between `true` and `false`. The `detail` property is a `boolean`
|
||||
with the new value of `RFB.clippingViewport`.
|
||||
|
||||
#### clipboard
|
||||
|
||||
The `clipboard` event is fired when the server has sent clipboard data.
|
||||
|
||||
Reference in New Issue
Block a user