Struct dui::clipboard::Clipboard

pub struct Clipboard(_);

An element that allows access to the clipboard.

You can use only one for the entire application because it does not store any data inside. Or you can simply create and drop every time you need to copy or paste.

See the clipboard module documentation for more details on how the system clipboard works.

Other platform-dependent attributes can be found on the [IUP Clipboard Documentation][1]. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/elem/iupclipboard.html

Ownership

The clipboard must be manually destroyed, thus for the user safety it returns a guarded object on the new constructor.

Please refer to the crate level documentation of IUP-Rust (the main doc page) for details on ownership of elements.

Methods

impl Clipboard

pub fn new() -> Guard<Clipboard>

Creates a new clipboard operarator.

pub fn clear(&mut self) -> Self

Clears any data on the clipboard.

pub fn add_format<S: Into<String>>(&mut self, format: S) -> Self

Register a custom format for clipboard data given its name.

pub fn has_text(&mut self) -> bool

Informs if there is a text available at the clipboard.

pub fn set_text<S: Into<String>>(&mut self, text: S) -> Self

Copy text into the clipboard.

pub fn text(&mut self) -> Option<String>

Paste text off the clipboard.

pub fn has_image(&mut self) -> bool

Informs if there is a image available at the clipboard.

pub fn set_image<I: ImageElement>(&mut self, image: &I) -> Self

Copy text into the clipboard.

pub fn has_data<S: Into<String>>(&mut self, format: S) -> bool

Informs if there is data of the specified format available at the clipboard.

pub fn set_data<S, D>(&mut self, format: S, data: D) -> Self where
    S: Into<String>,
    D: AsRef<[u8]>, 

Copy data from the specified format into the clipboard.

pub fn data<S: Into<String>>(&mut self, format: S) -> Option<Vec<u8>>

Paste data from the specified format off the clipboard.

Trait Implementations

impl Element for Clipboard

fn raw(&self) -> *mut Ihandle

Gets the raw IUP handle associated with this element.

unsafe fn from_raw_unchecked(ih: *mut Ihandle) -> Self

Constructs an Element from a raw IUP handle.

unsafe fn target_classname() -> &'static str

Gets the [class name][1] the derived object should be targeting. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html

fn from_handle(handle: Handle) -> Result<Self, Handle>

Constructs a specialized Element object from a general Handle if they are compatible.

fn from_name<S: Into<String>>(name: S) -> Option<Handle>

Constructs from a name associated with a element handle (with Element::add_handle_name or LED).

fn from_raw(ih: *mut Ihandle) -> Self

Constructs an Element from a raw IUP handle.

unsafe fn classname(&self) -> &CStr

Gets the [class name][1] of this element. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html

fn destroy(self)

Destroys an interface element and all its children.

fn does_attrib_exist(&self, cname: &CString) -> bool

Checks if a specific attribute exists in the element.

fn attribs(&self) -> Vec<String>

Returns the names of all attributes of an element that are set in its internal hash table only.

fn set_attrib<S1, S2>(&mut self, name: S1, value: S2) -> Self where
    S1: Into<String>,
    S2: Into<String>, 

Sets an interface element attribute.

fn attrib<S: Into<String>>(&self, name: S) -> Option<String>

Gets an interface element attribute.

fn set_attrib_data<S1>(&mut self, name: S1, data: *const c_void) -> Self where
    S1: Into<String>, 

Sets a raw interface element attribute.

fn attrib_data<S1>(&mut self, name: S1) -> *mut c_void where
    S1: Into<String>, 

Gets a raw interface element attribute.

fn set_attrib_handle<S1, E>(&mut self, name: S1, elem: E) -> Self where
    S1: Into<String>,
    E: Element, 

Associates a element with an attribute.

fn attrib_handle<S1>(&mut self, name: S1) -> Option<Handle> where
    S1: Into<String>, 

Gets the handle associated with an attribute.

fn clear_attrib<S: Into<String>>(&mut self, name: S) -> Self

Clears the value associated with an attribute and use the default value.

fn reset_attrib<S: Into<String>>(&mut self, name: S) -> Self

Removes an attribute from element and its children if the attrib is inheritable.

fn handle_name(&self) -> Option<String>

Returns the identifier of an interface element that has an associated handle name using Element::add_handle_name or using LED.

fn add_handle_name<S: Into<String>>(&self, name: S) -> Option<Handle>

Associates a handle name with an interface element.

fn clear_handle_name<S: Into<String>>(name: S) -> Option<Handle>

Clears the handle name association on the specified name.

impl Debug for Clipboard

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for Clipboard

impl Clone for Clipboard

fn clone(&self) -> Clipboard

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DestroyCb for Clipboard

fn set_destroy_cb<F>(&mut self, cb: F) -> Self where
    F: Callback<(Self,)>, 

fn remove_destroy_cb(&mut self) -> Option<Box<Callback<(Self,)>>>

impl From<Clipboard> for Handle

fn from(elem: Clipboard) -> Handle

Performs the conversion.