Clipboard

Object Hierarchy:

Description:

[ CCode ( type_id = "gdk_clipboard_get_type ()" ) ]
public sealed class Clipboard : Object

Represents data shared between applications or inside an application.

To get a `GdkClipboard` object, use [method@Gdk.Display.get_clipboard] or [method@Gdk.Display.get_primary_clipboard]. You can find out about the data that is currently available in a clipboard using [method@Gdk.Clipboard.get_formats].

To make text or image data available in a clipboard, use [method@Gdk.Clipboard.set_text] or [method@Gdk.Clipboard.set_texture]. For other data, you can use [method@Gdk.Clipboard.set_content], which takes a [class@Gdk.ContentProvider] object.

To read textual or image data from a clipboard, use [method@Gdk.Clipboard.read_text_async] or [method@Gdk.Clipboard.read_texture_async]. For other data, use [method@Gdk.Clipboard.read_async], which provides a `GInputStream` object.

Namespace: Gdk

Package: gtk4

Content:

Properties:

public ContentProvider content { get; }
The `GdkContentProvider` or null if the clipboard is empty or contents are provided otherwise.
public Display display { get; construct; }
The `GdkDisplay` that the clipboard belongs to.
public ContentFormats formats { get; }
The possible formats that the clipboard can provide its data in.
public bool local { get; }
true if the contents of the clipboard are owned by this process.

Creation methods:

protected Clipboard ()

Methods:

public void @set (Type type, ...)
Sets the clipboard to contain the value collected from the given varargs.
public unowned ContentProvider? get_content ()
Returns the `GdkContentProvider` currently set on this.
public unowned Display get_display ()
Gets the `GdkDisplay` that the clipboard was created for.
public unowned ContentFormats get_formats ()
Gets the formats that the clipboard can provide its current contents in.
public bool is_local ()
Returns if the clipboard is local.
public async InputStream? read_async (string[] mime_types, int io_priority, Cancellable? cancellable, out unowned string out_mime_type) throws Error
Asynchronously requests an input stream to read the this's contents from.
public async string? read_text_async (Cancellable? cancellable) throws Error
Asynchronously request the this contents converted to a string.
public async Texture? read_texture_async (Cancellable? cancellable) throws Error
Asynchronously request the this contents converted to a `GdkPixbuf`.
public async unowned Value? read_value_async (Type type, int io_priority, Cancellable? cancellable) throws Error
Asynchronously request the this contents converted to the given type.
public bool set_content (ContentProvider? provider)
Sets a new content provider on this.
public void set_text (string text)
Puts the given text into the clipboard.
public void set_texture (Texture texture)
Puts the given texture into the clipboard.
public void set_valist (Type type, va_list args)
Sets the clipboard to contain the value collected from the given args.
public void set_value (Value value)
Sets the this to contain the given value.
public async bool store_async (int io_priority, Cancellable? cancellable) throws Error
Asynchronously instructs the this to store its contents remotely.

Signals:

public signal void changed ()
Emitted when the clipboard changes ownership.

Inherited Members:

All known members inherited from class GLib.Object