Class SelectionData

Hierarchy

SelectionData

Constructors

constructor

new SelectionData(): Gtk.SelectionData

Returns Gtk.SelectionData

Properties

Static name

name: string

Methods

copy

copy(): Gtk.SelectionData

- Defined in @types/Gjs/Gtk-3.0.d.ts:107737
Makes a copy of a #GtkSelectionData-struct and its data.

Returns Gtk.SelectionData

free

free(): void

- Defined in @types/Gjs/Gtk-3.0.d.ts:107742
Frees a #GtkSelectionData-struct returned from gtk_selection_data_copy().

Returns void

get_data

get_data(): Uint8Array

- Defined in @types/Gjs/Gtk-3.0.d.ts:107750
Retrieves the raw data of the selection along with its length.

Returns Uint8Array

get_data_type

get_data_type(): Gdk.Atom

- Defined in @types/Gjs/Gtk-3.0.d.ts:107746
Retrieves the data type of the selection.

Returns Gdk.Atom

get_display

get_display(): Gdk.Display

- Defined in @types/Gjs/Gtk-3.0.d.ts:107754
Retrieves the display of the selection.

Returns Gdk.Display

get_format

get_format(): number

- Defined in @types/Gjs/Gtk-3.0.d.ts:107758
Retrieves the format of the selection.

Returns number

get_length

get_length(): number

- Defined in @types/Gjs/Gtk-3.0.d.ts:107762
Retrieves the length of the raw data of the selection.

Returns number

get_pixbuf

get_pixbuf(): Pixbuf

- Defined in @types/Gjs/Gtk-3.0.d.ts:107766
Gets the contents of the selection data as a #GdkPixbuf.

Returns Pixbuf

get_selection

get_selection(): Gdk.Atom

- Defined in @types/Gjs/Gtk-3.0.d.ts:107770
Retrieves the selection #GdkAtom of the selection data.

Returns Gdk.Atom

get_target

get_target(): Gdk.Atom

- Defined in @types/Gjs/Gtk-3.0.d.ts:107774
Retrieves the target of the selection.

Returns Gdk.Atom

get_targets

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

- Defined in @types/Gjs/Gtk-3.0.d.ts:107781
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[]]

get_text

get_text(): string

- Defined in @types/Gjs/Gtk-3.0.d.ts:107785
Gets the contents of the selection data as a UTF-8 string.

Returns string

get_uris

get_uris(): string[]

- Defined in @types/Gjs/Gtk-3.0.d.ts:107789
Gets the contents of the selection data as array of URIs.

Returns string[]

set

set(type: Gdk.Atom, format: number, data: Uint8Array): void

- Defined in @types/Gjs/Gtk-3.0.d.ts:107798
Stores new data into a #GtkSelectionData 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: Uint8Array
  
  pointer to the data (will be copied)
Returns void

set_pixbuf

set_pixbuf(pixbuf: Pixbuf): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107805
Sets the contents of the selection from a #GdkPixbuf The pixbuf is converted to the form determined by selection_data->target.

Parameters
- pixbuf: Pixbuf
  
  a #GdkPixbuf
Returns boolean

set_text

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

- Defined in @types/Gjs/Gtk-3.0.d.ts:107813
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

set_uris

set_uris(uris: string[]): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107820
Sets the contents of the selection from a list of URIs. The string is converted to the form determined by selection_data->target.

Parameters
- uris: string[]
  
  a %NULL-terminated array of strings holding URIs
Returns boolean

targets_include_image

targets_include_image(writable: boolean): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107827
Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a #GdkPixbuf.

Parameters
- writable: boolean
  
  whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format
Returns boolean

targets_include_rich_text

targets_include_rich_text(buffer: Gtk.TextBuffer): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107834
Given a #GtkSelectionData 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 #GtkTextBuffer
Returns boolean

targets_include_text

targets_include_text(): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107840
Given a #GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide text.

Returns boolean

targets_include_uri

targets_include_uri(): boolean

- Defined in @types/Gjs/Gtk-3.0.d.ts:107846
Given a #GtkSelectionData 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