Gtk-3.0 ▶ Gtk ▶ SelectionDataAbstract

constructor

• new SelectionData(): SelectionData

  Returns SelectionData

Static$gtype

copy

• copy(): SelectionData

  Makes a copy of a Gtk.SelectionData-struct and its data.

  Returns SelectionData

  a pointer to a copy of data.

free

• free(): void

  Frees a Gtk.SelectionData-struct returned from gtk_selection_data_copy().

  Returns void

get_data

• get_data(): Uint8Array

  Retrieves the raw data of the selection along with its length.

  Returns Uint8Array

  the raw data of the selection

get_data_type

• get_data_type(): Gdk.Atom

  Retrieves the data type of the selection.

  Returns Gdk.Atom

  the data type of the selection.

get_display

• get_display(): Gdk.Display

  Retrieves the display of the selection.

  Returns Gdk.Display

  the display of the selection.

get_format

• get_format(): number

  Retrieves the format of the selection.

  Returns number

  the format of the selection.

get_length

• get_length(): number

  Retrieves the length of the raw data of the selection.

  Returns number

  the length of the data of the selection.

get_pixbuf

• get_pixbuf(): GdkPixbuf.Pixbuf

  Gets the contents of the selection data as a GdkPixbuf.Pixbuf.

  Returns GdkPixbuf.Pixbuf

  if the selection data contained a recognized image type and it could be converted to a GdkPixbuf.Pixbuf, a newly allocated pixbuf is returned, otherwise null. If the result is non-null it must be freed with g_object_unref().

get_selection

• get_selection(): Gdk.Atom

  Retrieves the selection Gdk.Atom of the selection data.

  Returns Gdk.Atom

  the selection Gdk.Atom of the selection data.

get_target

• get_target(): Gdk.Atom

  Retrieves the target of the selection.

  Returns Gdk.Atom

  the target of the selection.

get_targets

• get_targets(): [boolean, Gdk.Atom[]]

  Gets the contents of selection_data as an array of targets. This can be used to interpret the results of getting the standard TARGETS target that is always supplied for any selection.

  Returns [boolean, Gdk.Atom[]]

  true if selection_data contains a valid array of targets, otherwise false.

get_text

• get_text(): string

  Gets the contents of the selection data as a UTF-8 string.

  Returns string

  if the selection data contained a recognized text type and it could be converted to UTF-8, a newly allocated string containing the converted text, otherwise null. If the result is non-null it must be freed with g_free().

get_uris

• get_uris(): string[]

  Gets the contents of the selection data as array of URIs.

  Since 3.24.37, this may involve using the FileTransfer portal to send files between sandboxed apps.

  Returns string[]

  if the selection data contains a list of URIs, a newly allocated null-terminated string array containing the URIs, otherwise null. If the result is non-null it must be freed with g_strfreev().

set

• set(
      type: Gdk.Atom,
      format: number,
      data: string | Uint8Array<ArrayBufferLike>,
  ): void

  Stores new data into a Gtk.SelectionData object. Should only be called from a selection handler callback. Zero-terminates the stored data.

  Parameters

  • type: Gdk.Atom

    the type of selection data

  • format: number

    format (number of bits in a unit)

  • data: string | Uint8Array<ArrayBufferLike>

    pointer to the data (will be copied)

  Returns void

set_pixbuf

• set_pixbuf(pixbuf: GdkPixbuf.Pixbuf): boolean

  Sets the contents of the selection from a GdkPixbuf.Pixbuf The pixbuf is converted to the form determined by selection_data->target.

  Parameters

  • pixbuf: GdkPixbuf.Pixbuf

    a GdkPixbuf.Pixbuf

  Returns boolean

  true if the selection was successfully set, otherwise false.

set_text

• set_text(str: string, len: number): boolean

  Sets the contents of the selection from a UTF-8 encoded string. The string is converted to the form determined by selection_data->target.

  Parameters

  • str: string

    a UTF-8 string

  • len: number

    the length of str, or -1 if str is nul-terminated.

  Returns boolean

  true if the selection was successfully set, otherwise false.

set_uris

• set_uris(uris: string[]): boolean

  Sets the contents of the selection from a list of URIs. The string is converted to the form determined by selection_data->target.

  Since 3.24.37, this may involve using the FileTransfer portal to send files between sandboxed apps.

  Parameters

  • uris: string[]

    a null-terminated array of strings holding URIs

  Returns boolean

  true if the selection was successfully set, otherwise false.

targets_include_image

• targets_include_image(writable: boolean): boolean

  Given a Gtk.SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a GdkPixbuf.Pixbuf.

  Parameters

  • writable: boolean

    whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format

  Returns boolean

  true if selection_data holds a list of targets, and a suitable target for images is included, otherwise false.

targets_include_rich_text

• targets_include_rich_text(buffer: Gtk.TextBuffer): boolean

  Given a Gtk.SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide rich text.

  Parameters

  • buffer: Gtk.TextBuffer

    a Gtk.TextBuffer

  Returns boolean

  true if selection_data holds a list of targets, and a suitable target for rich text is included, otherwise false.

targets_include_text

• targets_include_text(): boolean

  Given a Gtk.SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide text.

  Returns boolean

  true if selection_data holds a list of targets, and a suitable target for text is included, otherwise false.

targets_include_uri

• targets_include_uri(): boolean

  Given a Gtk.SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a list or URIs.

  Returns boolean

  true if selection_data holds a list of targets, and a suitable target for URI lists is included, otherwise false.