Method

GtkClipboardwait_for_rich_text

since: 2.10

Declaration [src]

guint8*
gtk_clipboard_wait_for_rich_text (
  GtkClipboard* clipboard,
  GtkTextBuffer* buffer,
  GdkAtom* format,
  gsize* length
)

Description [src]

Requests the contents of the clipboard as rich text. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

Available since: 2.10

Parameters

buffer

Type: GtkTextBuffer

A GtkTextBuffer.

The data is owned by the caller of the method.

format

Type: GdkAtom

Return location for the format of the returned data.

The argument will be set by the function.

The returned data is owned by the instance.

length

Type: gsize*

Return location for the length of the returned data.

The argument will be set by the function.

Return value

Type: An array of guint8

A newly-allocated binary block of data which must be freed with g_free(), or NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.).

The length of the array is in the length argument.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.

The return value can be NULL.