gio/auto/

themed_icon.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::{ffi, Icon};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// `GThemedIcon` is an implementation of [`Icon`][crate::Icon] that supports icon
    /// themes.
    ///
    /// `GThemedIcon` contains a list of all of the icons present in an icon
    /// theme, so that icons can be looked up quickly. `GThemedIcon` does
    /// not provide actual pixmaps for icons, just the icon names.
    /// Ideally something like `Gtk::IconTheme::choose_icon()` should be used to
    /// resolve the list of names so that fallback icons work nicely with
    /// themes that inherit other themes.
    ///
    /// ## Properties
    ///
    ///
    /// #### `name`
    ///  The icon name.
    ///
    /// Writeable | Construct Only
    ///
    ///
    /// #### `names`
    ///  A [`None`]-terminated array of icon names.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `use-default-fallbacks`
    ///  Whether to use the default fallbacks found by shortening the icon name
    /// at '-' characters. If the "names" array has more than one element,
    /// ignores any past the first.
    ///
    /// For example, if the icon name was "gnome-dev-cdrom-audio", the array
    /// would become
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// {
    ///   "gnome-dev-cdrom-audio",
    ///   "gnome-dev-cdrom",
    ///   "gnome-dev",
    ///   "gnome",
    ///   NULL
    /// };
    /// ```
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`IconExt`][trait@crate::prelude::IconExt]
    #[doc(alias = "GThemedIcon")]
    pub struct ThemedIcon(Object<ffi::GThemedIcon, ffi::GThemedIconClass>) @implements Icon;

    match fn {
        type_ => || ffi::g_themed_icon_get_type(),
    }
}

impl ThemedIcon {
    /// Creates a new themed icon for @iconname.
    /// ## `iconname`
    /// a string containing an icon name.
    ///
    /// # Returns
    ///
    /// a new #GThemedIcon.
    #[doc(alias = "g_themed_icon_new")]
    pub fn new(iconname: &str) -> ThemedIcon {
        unsafe { from_glib_full(ffi::g_themed_icon_new(iconname.to_glib_none().0)) }
    }

    /// Creates a new themed icon for @iconnames.
    /// ## `iconnames`
    /// an array of strings containing icon names.
    ///
    /// # Returns
    ///
    /// a new #GThemedIcon
    #[doc(alias = "g_themed_icon_new_from_names")]
    #[doc(alias = "new_from_names")]
    pub fn from_names(iconnames: &[&str]) -> ThemedIcon {
        let len = iconnames.len() as _;
        unsafe {
            from_glib_full(ffi::g_themed_icon_new_from_names(
                iconnames.to_glib_none().0,
                len,
            ))
        }
    }

    /// Creates a new themed icon for @iconname, and all the names
    /// that can be created by shortening @iconname at '-' characters.
    ///
    /// In the following example, @icon1 and @icon2 are equivalent:
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// const char *names[] = {
    ///   "gnome-dev-cdrom-audio",
    ///   "gnome-dev-cdrom",
    ///   "gnome-dev",
    ///   "gnome"
    /// };
    ///
    /// icon1 = g_themed_icon_new_from_names (names, 4);
    /// icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
    /// ```
    /// ## `iconname`
    /// a string containing an icon name
    ///
    /// # Returns
    ///
    /// a new #GThemedIcon.
    #[doc(alias = "g_themed_icon_new_with_default_fallbacks")]
    #[doc(alias = "new_with_default_fallbacks")]
    pub fn with_default_fallbacks(iconname: &str) -> ThemedIcon {
        unsafe {
            from_glib_full(ffi::g_themed_icon_new_with_default_fallbacks(
                iconname.to_glib_none().0,
            ))
        }
    }

    /// Append a name to the list of icons from within @self.
    ///
    /// Note that doing so invalidates the hash computed by prior calls
    /// to g_icon_hash().
    /// ## `iconname`
    /// name of icon to append to list of icons from within @self.
    #[doc(alias = "g_themed_icon_append_name")]
    pub fn append_name(&self, iconname: &str) {
        unsafe {
            ffi::g_themed_icon_append_name(self.to_glib_none().0, iconname.to_glib_none().0);
        }
    }

    /// Gets the names of icons from within @self.
    ///
    /// # Returns
    ///
    /// a list of icon names.
    #[doc(alias = "g_themed_icon_get_names")]
    #[doc(alias = "get_names")]
    pub fn names(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::g_themed_icon_get_names(
                self.to_glib_none().0,
            ))
        }
    }

    /// Prepend a name to the list of icons from within @self.
    ///
    /// Note that doing so invalidates the hash computed by prior calls
    /// to g_icon_hash().
    /// ## `iconname`
    /// name of icon to prepend to list of icons from within @self.
    #[doc(alias = "g_themed_icon_prepend_name")]
    pub fn prepend_name(&self, iconname: &str) {
        unsafe {
            ffi::g_themed_icon_prepend_name(self.to_glib_none().0, iconname.to_glib_none().0);
        }
    }

    /// Whether to use the default fallbacks found by shortening the icon name
    /// at '-' characters. If the "names" array has more than one element,
    /// ignores any past the first.
    ///
    /// For example, if the icon name was "gnome-dev-cdrom-audio", the array
    /// would become
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// {
    ///   "gnome-dev-cdrom-audio",
    ///   "gnome-dev-cdrom",
    ///   "gnome-dev",
    ///   "gnome",
    ///   NULL
    /// };
    /// ```
    #[doc(alias = "use-default-fallbacks")]
    pub fn uses_default_fallbacks(&self) -> bool {
        ObjectExt::property(self, "use-default-fallbacks")
    }

    #[doc(alias = "names")]
    pub fn connect_names_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_names_trampoline<F: Fn(&ThemedIcon) + 'static>(
            this: *mut ffi::GThemedIcon,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::names".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_names_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}