Struct gdk4::Clipboard

#[repr(transparent)]
pub struct Clipboard { /* private fields */ }

The Clipboard object represents data shared between applications or inside an application.

To get a Clipboard object, use DisplayExt::clipboard() or DisplayExt::primary_clipboard(). You can find out about the data that is currently available in a clipboard using formats().

To make text or image data available in a clipboard, use set_text() or set_texture(). For other data, you can use set_content(), which takes a ContentProvider object.

To read textual or image data from a clipboard, use read_text_async() or read_texture_async(). For other data, use read_async(), which provides a GInputStream object.

Implementations

impl Clipboard

pub fn content(&self) -> Option<ContentProvider>

Returns the ContentProvider currently set on @self.

If the @self is empty or its contents are not owned by the current process, None will be returned.

Returns

The content of a clipboard if the clipboard does not maintain any content

pub fn display(&self) -> Display

Gets the Display that the clipboard was created for.

Returns

a Display

pub fn formats(&self) -> ContentFormats

Gets the formats that the clipboard can provide its current contents in.

Returns

The formats of the clipboard

pub fn is_local(&self) -> bool

Returns if the clipboard is local.

A clipboard is considered local if it was last claimed by the running application.

Note that content() may return None even on a local clipboard. In this case the clipboard is empty.

Returns

true if the clipboard is local

pub fn read_text_async<P: FnOnce(Result<Option<GString>, Error>) + 'static>(
    &self,
    cancellable: Option<&impl IsA<Cancellable>>,
    callback: P
)

Asynchronously request the @self contents converted to a string.

When the operation is finished @callback will be called. You must then call Gdk::Clipboard::read_text_finish() to get the result.

This is a simple wrapper around read_value_async(). Use that function or read_async() directly if you need more control over the operation.

cancellable

optional GCancellable object

callback

callback to call when the request is satisfied

pub fn read_text_future(
    &self
) -> Pin<Box_<dyn Future<Output = Result<Option<GString>, Error>> + 'static>>

pub fn read_texture_async<P: FnOnce(Result<Option<Texture>, Error>) + 'static>(
    &self,
    cancellable: Option<&impl IsA<Cancellable>>,
    callback: P
)

Asynchronously request the @self contents converted to a gdk_pixbuf::Pixbuf.

When the operation is finished @callback will be called. You must then call Gdk::Clipboard::read_texture_finish() to get the result.

This is a simple wrapper around read_value_async(). Use that function or read_async() directly if you need more control over the operation.

cancellable

optional GCancellable object, None to ignore.

callback

callback to call when the request is satisfied

pub fn read_texture_future(
    &self
) -> Pin<Box_<dyn Future<Output = Result<Option<Texture>, Error>> + 'static>>

pub fn read_value_async<P: FnOnce(Result<Value, Error>) + 'static>(
    &self,
    type_: Type,
    io_priority: Priority,
    cancellable: Option<&impl IsA<Cancellable>>,
    callback: P
)

Asynchronously request the @self contents converted to the given @type_.

When the operation is finished @callback will be called. You must then call Gdk::Clipboard::read_value_finish() to get the resulting GValue.

For local clipboard contents that are available in the given GType, the value will be copied directly. Otherwise, GDK will try to use content_deserialize_async() to convert the clipboard’s data.

type_

a GType to read

io_priority

the I/O priority of the request

cancellable

optional GCancellable object

callback

callback to call when the request is satisfied

pub fn read_value_future(
    &self,
    type_: Type,
    io_priority: Priority
) -> Pin<Box_<dyn Future<Output = Result<Value, Error>> + 'static>>

pub fn set_content(
    &self,
    provider: Option<&impl IsA<ContentProvider>>
) -> Result<(), BoolError>

Sets a new content provider on @self.

The clipboard will claim the Display’s resources and advertise these new contents to other applications.

In the rare case of a failure, this function will return false. The clipboard will then continue reporting its old contents and ignore @provider.

If the contents are read by either an external application or the @self’s read functions, @self will select the best format to transfer the contents and then request that format from @provider.

provider

the new contents of @self or None to clear the clipboard

Returns

true if setting the clipboard succeeded

pub fn set_text(&self, text: &str)

Puts the given @text into the clipboard.

text

Text to put into the clipboard

pub fn set_texture(&self, texture: &impl IsA<Texture>)

Puts the given @texture into the clipboard.

texture

a Texture to put into the clipboard

pub fn store_async<P: FnOnce(Result<(), Error>) + 'static>(
    &self,
    io_priority: Priority,
    cancellable: Option<&impl IsA<Cancellable>>,
    callback: P
)

Asynchronously instructs the @self to store its contents remotely.

If the clipboard is not local, this function does nothing but report success.

The @callback must call Gdk::Clipboard::store_finish().

The purpose of this call is to preserve clipboard contents beyond the lifetime of an application, so this function is typically called on exit. Depending on the platform, the functionality may not be available unless a “clipboard manager” is running.

This function is called automatically when a Gtk::Application is shut down, so you likely don’t need to call it.

io_priority

the I/O priority of the request

cancellable

optional GCancellable object

callback

callback to call when the request is satisfied

pub fn store_future(
    &self,
    io_priority: Priority
) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the clipboard changes ownership.

pub fn connect_content_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_formats_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_local_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl Clipboard

pub fn read_async<Q: FnOnce(Result<(InputStream, GString), Error>) + 'static>(
    &self,
    mime_types: &[&str],
    io_priority: Priority,
    cancellable: Option<&impl IsA<Cancellable>>,
    callback: Q
)

Asynchronously requests an input stream to read the @self’s contents from.

When the operation is finished @callback will be called. You must then call Gdk::Clipboard::read_finish() to get the result of the operation.

The clipboard will choose the most suitable mime type from the given list to fulfill the request, preferring the ones listed first.

mime_types

a None-terminated array of mime types to choose from

io_priority

the I/O priority of the request

cancellable

optional GCancellable object

callback

callback to call when the request is satisfied

pub fn read_future(
    &self,
    mime_types: &[&str],
    io_priority: Priority
) -> Pin<Box<dyn Future<Output = Result<(InputStream, GString), Error>> + 'static>>

Trait Implementations

impl Clone for Clipboard

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Clipboard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Clipboard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Clipboard

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Clipboard

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Clipboard

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Clipboard

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Clipboard

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Clipboard

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Clipboard