Struct gtk::SelectionData

pub struct SelectionData(_);

Implementations

impl SelectionData

pub fn get_data_type(&self) -> Atom

Retrieves the data type of the selection.

Returns

the data type of the selection.

pub fn get_display(&self) -> Option<Display>

Retrieves the display of the selection.

Returns

the display of the selection.

pub fn get_format(&self) -> i32

Retrieves the format of the selection.

Returns

the format of the selection.

pub fn get_length(&self) -> i32

Retrieves the length of the raw data of the selection.

Returns

the length of the data of the selection.

pub fn get_pixbuf(&self) -> Option<Pixbuf>

Gets the contents of the selection data as a gdk_pixbuf::Pixbuf.

Returns

if the selection data contained a recognized image type and it could be converted to a gdk_pixbuf::Pixbuf, a newly allocated pixbuf is returned, otherwise None. If the result is non-None it must be freed with gobject::ObjectExt::unref.

pub fn get_selection(&self) -> Atom

Retrieves the selection gdk::Atom of the selection data.

Returns

the selection gdk::Atom of the selection data.

pub fn get_target(&self) -> Atom

Retrieves the target of the selection.

Returns

the target of the selection.

pub fn get_targets(&self) -> Option<Vec<Atom>>

Gets the contents of self 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.

targets

location to store an array of targets. The result stored here must be freed with g_free.

n_atoms

location to store number of items in targets.

Returns

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

pub fn get_text(&self) -> Option<GString>

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

Returns

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 None. If the result is non-None it must be freed with g_free.

pub fn get_uris(&self) -> Vec<GString>

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

Returns

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

pub fn set(&self, type_: &Atom, format: i32, data: &[u8])

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

type_

the type of selection data

format

format (number of bits in a unit)

data

pointer to the data (will be copied)

length

length of the data

pub fn set_pixbuf(&self, pixbuf: &Pixbuf) -> bool

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

pixbuf

a gdk_pixbuf::Pixbuf

Returns

true if the selection was successfully set, otherwise false.

pub fn set_text(&self, str: &str) -> bool

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

str

a UTF-8 string

len

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

Returns

true if the selection was successfully set, otherwise false.

pub fn set_uris(&self, uris: &[&str]) -> bool

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

uris

a None-terminated array of strings holding URIs

Returns

true if the selection was successfully set, otherwise false.

pub fn targets_include_image(&self, writable: bool) -> bool

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

writable

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

Returns

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

pub fn targets_include_rich_text<P: IsA<TextBuffer>>(&self, buffer: &P) -> bool

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

buffer

a TextBuffer

Returns

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

pub fn targets_include_text(&self) -> bool

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

Returns

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

pub fn targets_include_uri(&self) -> bool

Given a 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

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

impl SelectionData

pub fn get_data(&self) -> Vec<u8>

Retrieves the raw data of the selection.

Returns

the raw data of the selection.

Trait Implementations

impl Clone for SelectionData

fn clone(&self) -> SelectionData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SelectionData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for SelectionData

impl Hash for SelectionData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for SelectionData

fn cmp(&self, other: &SelectionData) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SelectionData> for SelectionData

fn eq(&self, other: &SelectionData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SelectionData) -> bool

This method tests for !=.

impl PartialOrd<SelectionData> for SelectionData

fn partial_cmp(&self, other: &SelectionData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SelectionData) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SelectionData) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SelectionData) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SelectionData) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SelectionData

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for SelectionData

impl StructuralPartialEq for SelectionData