gtk/auto/

selection_data.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{TextBuffer, ffi};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct SelectionData(Boxed<ffi::GtkSelectionData>);

    match fn {
        copy => |ptr| ffi::gtk_selection_data_copy(ptr),
        free => |ptr| ffi::gtk_selection_data_free(ptr),
        type_ => || ffi::gtk_selection_data_get_type(),
    }
}

impl SelectionData {
    /// Retrieves the data type of the selection.
    ///
    /// # Returns
    ///
    /// the data type of the selection.
    #[doc(alias = "gtk_selection_data_get_data_type")]
    #[doc(alias = "get_data_type")]
    pub fn data_type(&self) -> gdk::Atom {
        unsafe { from_glib_none(ffi::gtk_selection_data_get_data_type(self.to_glib_none().0)) }
    }

    /// Retrieves the display of the selection.
    ///
    /// # Returns
    ///
    /// the display of the selection.
    #[doc(alias = "gtk_selection_data_get_display")]
    #[doc(alias = "get_display")]
    pub fn display(&self) -> Option<gdk::Display> {
        unsafe { from_glib_none(ffi::gtk_selection_data_get_display(self.to_glib_none().0)) }
    }

    /// Retrieves the format of the selection.
    ///
    /// # Returns
    ///
    /// the format of the selection.
    #[doc(alias = "gtk_selection_data_get_format")]
    #[doc(alias = "get_format")]
    pub fn format(&self) -> i32 {
        unsafe { ffi::gtk_selection_data_get_format(self.to_glib_none().0) }
    }

    /// Retrieves the length of the raw data of the selection.
    ///
    /// # Returns
    ///
    /// the length of the data of the selection.
    #[doc(alias = "gtk_selection_data_get_length")]
    #[doc(alias = "get_length")]
    pub fn length(&self) -> i32 {
        unsafe { ffi::gtk_selection_data_get_length(self.to_glib_none().0) }
    }

    /// Gets the contents of the selection data as a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf].
    ///
    /// # Returns
    ///
    /// if the selection data
    ///  contained a recognized image type and it could be converted to a
    ///  [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf], a newly allocated pixbuf is returned, otherwise
    ///  [`None`]. If the result is non-[`None`] it must be freed with
    ///  `g_object_unref()`.
    #[doc(alias = "gtk_selection_data_get_pixbuf")]
    #[doc(alias = "get_pixbuf")]
    pub fn pixbuf(&self) -> Option<gdk_pixbuf::Pixbuf> {
        unsafe { from_glib_full(ffi::gtk_selection_data_get_pixbuf(self.to_glib_none().0)) }
    }

    /// Retrieves the selection [`gdk::Atom`][crate::gdk::Atom] of the selection data.
    ///
    /// # Returns
    ///
    /// the selection [`gdk::Atom`][crate::gdk::Atom] of the selection data.
    #[doc(alias = "gtk_selection_data_get_selection")]
    #[doc(alias = "get_selection")]
    pub fn selection(&self) -> gdk::Atom {
        unsafe { from_glib_none(ffi::gtk_selection_data_get_selection(self.to_glib_none().0)) }
    }

    /// Retrieves the target of the selection.
    ///
    /// # Returns
    ///
    /// the target of the selection.
    #[doc(alias = "gtk_selection_data_get_target")]
    #[doc(alias = "get_target")]
    pub fn target(&self) -> gdk::Atom {
        unsafe { from_glib_none(ffi::gtk_selection_data_get_target(self.to_glib_none().0)) }
    }

    /// 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.
    ///
    /// # Returns
    ///
    /// [`true`] if `self` contains a valid
    ///  array of targets, otherwise [`false`].
    ///
    /// ## `targets`
    ///
    ///  location to store an array of targets. The result stored
    ///  here must be freed with `g_free()`.
    #[doc(alias = "gtk_selection_data_get_targets")]
    #[doc(alias = "get_targets")]
    pub fn targets(&self) -> Option<Vec<gdk::Atom>> {
        unsafe {
            let mut targets = std::ptr::null_mut();
            let mut n_atoms = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_selection_data_get_targets(
                self.to_glib_none().0,
                &mut targets,
                n_atoms.as_mut_ptr(),
            ));
            if ret {
                Some(FromGlibContainer::from_glib_container_num(
                    targets,
                    n_atoms.assume_init() as _,
                ))
            } else {
                None
            }
        }
    }

    /// 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()`.
    #[doc(alias = "gtk_selection_data_get_text")]
    #[doc(alias = "get_text")]
    pub fn text(&self) -> Option<glib::GString> {
        unsafe { from_glib_full(ffi::gtk_selection_data_get_text(self.to_glib_none().0)) }
    }

    /// 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
    ///
    /// 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()`.
    #[doc(alias = "gtk_selection_data_get_uris")]
    #[doc(alias = "get_uris")]
    pub fn uris(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_selection_data_get_uris(
                self.to_glib_none().0,
            ))
        }
    }

    /// Stores new data into a [`SelectionData`][crate::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)
    #[doc(alias = "gtk_selection_data_set")]
    pub fn set(&self, type_: &gdk::Atom, format: i32, data: &[u8]) {
        let length = data.len() as _;
        unsafe {
            ffi::gtk_selection_data_set(
                mut_override(self.to_glib_none().0),
                type_.to_glib_none().0,
                format,
                data.to_glib_none().0,
                length,
            );
        }
    }

    /// target.
    /// ## `pixbuf`
    /// a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf]
    ///
    /// # Returns
    ///
    /// [`true`] if the selection was successfully set,
    ///  otherwise [`false`].
    #[doc(alias = "gtk_selection_data_set_pixbuf")]
    pub fn set_pixbuf(&self, pixbuf: &gdk_pixbuf::Pixbuf) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_set_pixbuf(
                mut_override(self.to_glib_none().0),
                pixbuf.to_glib_none().0,
            ))
        }
    }

    /// 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`].
    #[doc(alias = "gtk_selection_data_set_text")]
    pub fn set_text(&self, str: &str) -> bool {
        let len = str.len() as _;
        unsafe {
            from_glib(ffi::gtk_selection_data_set_text(
                mut_override(self.to_glib_none().0),
                str.to_glib_none().0,
                len,
            ))
        }
    }

    /// target.
    ///
    /// Since 3.24.37, this may involve using the FileTransfer
    /// portal to send files between sandboxed apps.
    /// ## `uris`
    /// a [`None`]-terminated array of
    ///  strings holding URIs
    ///
    /// # Returns
    ///
    /// [`true`] if the selection was successfully set,
    ///  otherwise [`false`].
    #[doc(alias = "gtk_selection_data_set_uris")]
    pub fn set_uris(&self, uris: &[&str]) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_set_uris(
                mut_override(self.to_glib_none().0),
                uris.to_glib_none().0,
            ))
        }
    }

    /// Given a [`SelectionData`][crate::SelectionData] object holding a list of targets,
    /// determines if any of the targets in `targets` can be used to
    /// provide a [`gdk_pixbuf::Pixbuf`][crate::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`].
    #[doc(alias = "gtk_selection_data_targets_include_image")]
    pub fn targets_include_image(&self, writable: bool) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_targets_include_image(
                self.to_glib_none().0,
                writable.into_glib(),
            ))
        }
    }

    /// Given a [`SelectionData`][crate::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`][crate::TextBuffer]
    ///
    /// # Returns
    ///
    /// [`true`] if `self` holds a list of targets,
    ///  and a suitable target for rich text is included,
    ///  otherwise [`false`].
    #[doc(alias = "gtk_selection_data_targets_include_rich_text")]
    pub fn targets_include_rich_text(&self, buffer: &impl IsA<TextBuffer>) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_targets_include_rich_text(
                self.to_glib_none().0,
                buffer.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Given a [`SelectionData`][crate::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`].
    #[doc(alias = "gtk_selection_data_targets_include_text")]
    pub fn targets_include_text(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_targets_include_text(
                self.to_glib_none().0,
            ))
        }
    }

    /// Given a [`SelectionData`][crate::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`].
    #[doc(alias = "gtk_selection_data_targets_include_uri")]
    pub fn targets_include_uri(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_selection_data_targets_include_uri(
                self.to_glib_none().0,
            ))
        }
    }
}