Struct CLIPBOARD

pub struct CLIPBOARD;

Clipboard service.

This service synchronizes with the UI update cycle, the getter methods provide the same data for all requests in the same update pass, even if the system clipboard happens to change mid update, the setter methods only set the system clipboard at the end of the update pass.

This service needs a running view-process to actually interact with the system clipboard, in a headless app without renderer (no view-process) the service will always return ClipboardError::ViewProcessOffline.

Implementations

impl CLIPBOARD

pub fn text(&self) -> Result<Option<Txt>, ClipboardError>

Gets a text string from the clipboard.

pub fn set_text( &self, txt: impl Into<Txt>, ) -> ReadOnlyVar<Response<Result<bool, ClipboardError>>, ArcVar<Response<Result<bool, ClipboardError>>>>

Sets the text string on the clipboard after the current update.

Returns a response var that updates to Ok(true) is the text is put on the clipboard, Ok(false) if another request made on the same update pass replaces this one or Err(ClipboardError).

pub fn image( &self, ) -> Result<Option<ReadOnlyVar<Img, ArcVar<Img>>>, ClipboardError>

Gets an image from the clipboard.

The image is loaded in parallel and cached by the IMAGES service.

pub fn set_image( &self, img: Img, ) -> ReadOnlyVar<Response<Result<bool, ClipboardError>>, ArcVar<Response<Result<bool, ClipboardError>>>>

Set the image on the clipboard after the current update, if it is loaded.

Returns a response var that updates to Ok(true) is the text is put on the clipboard, Ok(false) if another request made on the same update pass replaces this one or Err(ClipboardError).

pub fn file_list(&self) -> Result<Option<Vec<PathBuf>>, ClipboardError>

Gets a file list from the clipboard.

pub fn set_file_list( &self, list: impl Into<Vec<PathBuf>>, ) -> ReadOnlyVar<Response<Result<bool, ClipboardError>>, ArcVar<Response<Result<bool, ClipboardError>>>>

Sets the file list on the clipboard after the current update.

Returns a response var that updates to Ok(true) is the text is put on the clipboard, Ok(false) if another request made on the same update pass replaces this one or Err(ClipboardError).

pub fn extension( &self, data_type: impl Into<Txt>, ) -> Result<Option<IpcBytes>, ClipboardError>

Gets custom data from the clipboard.

The current view-process must support data_type.

pub fn set_extension( &self, data_type: impl Into<Txt>, data: IpcBytes, ) -> ReadOnlyVar<Response<Result<bool, ClipboardError>>, ArcVar<Response<Result<bool, ClipboardError>>>>

Set a custom data on the clipboard.

The current view-process must support data_type after the current update.

Returns a response var that updates to Ok(true) is the text is put on the clipboard, Ok(false) if another request made on the same update pass replaces this one or Err(ClipboardError).