Function

GtkClipboardget_for_display

since: 2.2

Declaration [src]

GtkClipboard*
gtk_clipboard_get_for_display (
  GdkDisplay* display,
  GdkAtom selection
)

Description [src]

Returns the clipboard object for the given selection. Cut/copy/paste menu items and keyboard shortcuts should use the default clipboard, returned by passing GDK_SELECTION_CLIPBOARD for selection. (GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD for backwards compatibility reasons.) The currently-selected object or text should be provided on the clipboard identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard to the default clipboard, i.e. they copy the selection to what the user sees as the clipboard.

(Passing #GDK_NONE is the same as using gdk_atom_intern ("CLIPBOARD", FALSE).

See the FreeDesktop Clipboard Specification for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY” selections under the X window system. On Win32 the

GDK_SELECTION_PRIMARY clipboard is essentially ignored.)

It’s possible to have arbitrary named clipboards; if you do invent new clipboards, you should prefix the selection name with an underscore (because the ICCCM requires that nonstandard atoms are underscore-prefixed), and namespace it as well. For example, if your application called “Foo” has a special-purpose clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”.

Available since: 2.2

Parameters

display

Type: GdkDisplay

The GdkDisplay for which the clipboard is to be retrieved or created.

The data is owned by the caller of the function.

selection

Type: GdkAtom

A GdkAtom which identifies the clipboard to use.

Return value

Type: GtkClipboard

The appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent and, since it is owned by GTK+, must not be freed or unrefd.

The data is owned by the called function.