Class Clipboard

A class abstracting the OS clipboad functionality and allowing to set and get data.

Index

Constructors

Methods

getObject getResource getSerializedObject getText setComponent setObject setResource setSceneObjects setSerializedObject setText setTexture

Constructors

constructor

new Clipboard(): Clipboard

Returns Clipboard

Inherited from ClipboardGenerated.constructor

Methods

`Static`getObject

getObject<T>(type: ClassOf<T>): T
Returns the object stored in the clipboard or null if no object is stored.
Type Parameters
- T
Parameters
- type: ClassOf<T>
Returns T
The stored object or null if no object is stored or the stored object is not of type type.

`Static`getResource

getResource(): Resource

Returns a resource handle from the clipboard.

Returns Resource

Inherited from ClipboardGenerated.getResource

`Static`getSerializedObject

getSerializedObject(): SerializedObject

Returns the SerializedObject stored in the clipboard, or nullptr if none.

Returns SerializedObject

Inherited from ClipboardGenerated.getSerializedObject

`Static`getText

getText(): string

Reads a string from the clipboard and returns it. If there is no string in the clipboard it returns an empty string.

Returns string

Note
Both wide and normal strings will be read, but normal strings will be converted to a wide string before returning.

Note
Thread safe.

Inherited from ClipboardGenerated.getText

`Static`setComponent

setComponent(component: Component): void
Sets a component in the clipboard.
Parameters
- component: Component
Returns void

Inherited from ClipboardGenerated.setComponent

`Static`setObject

setObject(object: any): void
Stores an object in the clipboard.
Parameters
- object: any
Returns void

`Static`setResource

setResource(resource: Resource | ResourceHandle<Resource>): boolean
Set a resource handle in the clipboard.
Parameters
- resource: Resource | ResourceHandle<Resource>
Returns boolean

Inherited from ClipboardGenerated.setResource

`Static`setSceneObjects

setSceneObjects(sceneObjects: SceneObject[]): void
Set scene objects to the clipboard.
Parameters
- sceneObjects: SceneObject[]
  The scene objects to serialize on the clipboard.
Returns void

Inherited from ClipboardGenerated.setSceneObjects

`Static`setSerializedObject

setSerializedObject(serializedObject: SerializedObject): void
Serializes the given IReflectable into the clipboard as a SerializedObject.
Parameters
- serializedObject: SerializedObject
Returns void

Inherited from ClipboardGenerated.setSerializedObject

`Static`setText

setText(text: string): void
Set some text to the clipboard.
Parameters
- text: string
Returns void

Note
Thread safe.

Inherited from ClipboardGenerated.setText

`Static`setTexture

setTexture(pixelData: PixelData): void
Set texture to clipboard.
Parameters
- pixelData: PixelData
  The pixel information to serialize.
Returns void

Inherited from ClipboardGenerated.setTexture