gtk/auto/

icon_theme.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::{IconInfo, IconLookupFlags, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// message);
    ///  g_error_free (error);
    ///  }
    /// else
    ///  {
    ///  // Use the pixbuf
    ///  g_object_unref (pixbuf);
    ///  }
    /// ]|
    ///
    /// ## Signals
    ///
    ///
    /// #### `changed`
    ///  Emitted when the current icon theme is switched or GTK+ detects
    /// that a change has occurred in the contents of the current
    /// icon theme.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`IconThemeExt`][trait@crate::prelude::IconThemeExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkIconTheme")]
    pub struct IconTheme(Object<ffi::GtkIconTheme, ffi::GtkIconThemeClass>);

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

impl IconTheme {
    pub const NONE: Option<&'static IconTheme> = None;

    /// Creates a new icon theme object. Icon theme objects are used
    /// to lookup up an icon by name in a particular icon theme.
    /// Usually, you’ll want to use [`default()`][Self::default()]
    /// or [`for_screen()`][Self::for_screen()] rather than creating
    /// a new icon theme object for scratch.
    ///
    /// # Returns
    ///
    /// the newly created [`IconTheme`][crate::IconTheme] object.
    #[doc(alias = "gtk_icon_theme_new")]
    pub fn new() -> IconTheme {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_icon_theme_new()) }
    }

    /// Gets the icon theme for the default screen. See
    /// [`for_screen()`][Self::for_screen()].
    ///
    /// # Returns
    ///
    /// A unique [`IconTheme`][crate::IconTheme] associated with
    ///  the default screen. This icon theme is associated with
    ///  the screen and can be used as long as the screen
    ///  is open. Do not ref or unref it.
    #[doc(alias = "gtk_icon_theme_get_default")]
    #[doc(alias = "get_default")]
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> Option<IconTheme> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gtk_icon_theme_get_default()) }
    }

    /// Gets the icon theme object associated with `screen`; if this
    /// function has not previously been called for the given
    /// screen, a new icon theme object will be created and
    /// associated with the screen. Icon theme objects are
    /// fairly expensive to create, so using this function
    /// is usually a better choice than calling than [`new()`][Self::new()]
    /// and setting the screen yourself; by using this function
    /// a single icon theme object will be shared between users.
    /// ## `screen`
    /// a [`gdk::Screen`][crate::gdk::Screen]
    ///
    /// # Returns
    ///
    /// A unique [`IconTheme`][crate::IconTheme] associated with
    ///  the given screen. This icon theme is associated with
    ///  the screen and can be used as long as the screen
    ///  is open. Do not ref or unref it.
    #[doc(alias = "gtk_icon_theme_get_for_screen")]
    #[doc(alias = "get_for_screen")]
    pub fn for_screen(screen: &gdk::Screen) -> Option<IconTheme> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gtk_icon_theme_get_for_screen(screen.to_glib_none().0)) }
    }
}

impl Default for IconTheme {
    fn default() -> Self {
        Self::new()
    }
}

/// Trait containing all [`struct@IconTheme`] methods.
///
/// # Implementors
///
/// [`IconTheme`][struct@crate::IconTheme]
pub trait IconThemeExt: IsA<IconTheme> + 'static {
    /// Adds a resource path that will be looked at when looking
    /// for icons, similar to search paths.
    ///
    /// This function should be used to make application-specific icons
    /// available as part of the icon theme.
    ///
    /// The resources are considered as part of the hicolor icon theme
    /// and must be located in subdirectories that are defined in the
    /// hicolor icon theme, such as ``path`/16x16/actions/run.png`.
    /// Icons that are directly placed in the resource path instead
    /// of a subdirectory are also considered as ultimate fallback.
    /// ## `path`
    /// a resource path
    #[doc(alias = "gtk_icon_theme_add_resource_path")]
    fn add_resource_path(&self, path: &str) {
        unsafe {
            ffi::gtk_icon_theme_add_resource_path(
                self.as_ref().to_glib_none().0,
                path.to_glib_none().0,
            );
        }
    }

    /// Appends a directory to the search path.
    /// See `gtk_icon_theme_set_search_path()`.
    /// ## `path`
    /// directory name to append to the icon path
    #[doc(alias = "gtk_icon_theme_append_search_path")]
    fn append_search_path(&self, path: impl AsRef<std::path::Path>) {
        unsafe {
            ffi::gtk_icon_theme_append_search_path(
                self.as_ref().to_glib_none().0,
                path.as_ref().to_glib_none().0,
            );
        }
    }

    /// Gets the name of an icon that is representative of the
    /// current theme (for instance, to use when presenting
    /// a list of themes to the user.)
    ///
    /// # Returns
    ///
    /// the name of an example icon or [`None`].
    ///  Free with `g_free()`.
    #[doc(alias = "gtk_icon_theme_get_example_icon_name")]
    #[doc(alias = "get_example_icon_name")]
    fn example_icon_name(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_get_example_icon_name(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Checks whether an icon theme includes an icon
    /// for a particular name.
    /// ## `icon_name`
    /// the name of an icon
    ///
    /// # Returns
    ///
    /// [`true`] if `self` includes an
    ///  icon for `icon_name`.
    #[doc(alias = "gtk_icon_theme_has_icon")]
    fn has_icon(&self, icon_name: &str) -> bool {
        unsafe {
            from_glib(ffi::gtk_icon_theme_has_icon(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
            ))
        }
    }

    /// Gets the list of contexts available within the current
    /// hierarchy of icon themes.
    /// See [`list_icons()`][Self::list_icons()] for details about contexts.
    ///
    /// # Returns
    ///
    /// a `GList` list
    ///  holding the names of all the contexts in the theme. You must first
    ///  free each element in the list with `g_free()`, then free the list
    ///  itself with `g_list_free()`.
    #[doc(alias = "gtk_icon_theme_list_contexts")]
    fn list_contexts(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_icon_theme_list_contexts(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Lists the icons in the current icon theme. Only a subset
    /// of the icons can be listed by providing a context string.
    /// The set of values for the context string is system dependent,
    /// but will typically include such values as “Applications” and
    /// “MimeTypes”. Contexts are explained in the
    /// [Icon Theme Specification](http://www.freedesktop.org/wiki/Specifications/icon-theme-spec).
    /// The standard contexts are listed in the
    /// [Icon Naming Specification](http://www.freedesktop.org/wiki/Specifications/icon-naming-spec).
    /// Also see [`list_contexts()`][Self::list_contexts()].
    /// ## `context`
    /// a string identifying a particular type of
    ///  icon, or [`None`] to list all icons.
    ///
    /// # Returns
    ///
    /// a `GList` list
    ///  holding the names of all the icons in the theme. You must
    ///  first free each element in the list with `g_free()`, then
    ///  free the list itself with `g_list_free()`.
    #[doc(alias = "gtk_icon_theme_list_icons")]
    fn list_icons(&self, context: Option<&str>) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_icon_theme_list_icons(
                self.as_ref().to_glib_none().0,
                context.to_glib_none().0,
            ))
        }
    }

    /// Looks up an icon in an icon theme, scales it to the given size
    /// and renders it into a pixbuf. This is a convenience function;
    /// if more details about the icon are needed, use
    /// [`lookup_icon()`][Self::lookup_icon()] followed by [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    ///
    /// Note that you probably want to listen for icon theme changes and
    /// update the icon. This is usually done by connecting to the
    /// GtkWidget::style-set signal. If for some reason you do not want to
    /// update the icon when the icon theme changes, you should consider
    /// using `gdk_pixbuf_copy()` to make a private copy of the pixbuf
    /// returned by this function. Otherwise GTK+ may need to keep the old
    /// icon theme loaded, which would be a waste of memory.
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `size`
    /// the desired icon size. The resulting icon may not be
    ///  exactly this size; see [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// the rendered icon; this may be
    ///  a newly created icon or a new reference to an internal icon, so
    ///  you must not modify the icon. Use `g_object_unref()` to release
    ///  your reference to the icon. [`None`] if the icon isn’t found.
    #[doc(alias = "gtk_icon_theme_load_icon")]
    fn load_icon(
        &self,
        icon_name: &str,
        size: i32,
        flags: IconLookupFlags,
    ) -> Result<Option<gdk_pixbuf::Pixbuf>, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gtk_icon_theme_load_icon(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
                size,
                flags.into_glib(),
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Looks up an icon in an icon theme for a particular window scale,
    /// scales it to the given size and renders it into a pixbuf. This is a
    /// convenience function; if more details about the icon are needed,
    /// use [`lookup_icon()`][Self::lookup_icon()] followed by
    /// [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    ///
    /// Note that you probably want to listen for icon theme changes and
    /// update the icon. This is usually done by connecting to the
    /// GtkWidget::style-set signal. If for some reason you do not want to
    /// update the icon when the icon theme changes, you should consider
    /// using `gdk_pixbuf_copy()` to make a private copy of the pixbuf
    /// returned by this function. Otherwise GTK+ may need to keep the old
    /// icon theme loaded, which would be a waste of memory.
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `size`
    /// the desired icon size. The resulting icon may not be
    ///  exactly this size; see [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    /// ## `scale`
    /// desired scale
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// the rendered icon; this may be
    ///  a newly created icon or a new reference to an internal icon, so
    ///  you must not modify the icon. Use `g_object_unref()` to release
    ///  your reference to the icon. [`None`] if the icon isn’t found.
    #[doc(alias = "gtk_icon_theme_load_icon_for_scale")]
    fn load_icon_for_scale(
        &self,
        icon_name: &str,
        size: i32,
        scale: i32,
        flags: IconLookupFlags,
    ) -> Result<Option<gdk_pixbuf::Pixbuf>, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gtk_icon_theme_load_icon_for_scale(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
                size,
                scale,
                flags.into_glib(),
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Looks up an icon in an icon theme for a particular window scale,
    /// scales it to the given size and renders it into a cairo surface. This is a
    /// convenience function; if more details about the icon are needed,
    /// use [`lookup_icon()`][Self::lookup_icon()] followed by
    /// [`IconInfo::load_surface()`][crate::IconInfo::load_surface()].
    ///
    /// Note that you probably want to listen for icon theme changes and
    /// update the icon. This is usually done by connecting to the
    /// GtkWidget::style-set signal.
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `size`
    /// the desired icon size. The resulting icon may not be
    ///  exactly this size; see [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    /// ## `scale`
    /// desired scale
    /// ## `for_window`
    /// [`gdk::Window`][crate::gdk::Window] to optimize drawing for, or [`None`]
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// the rendered icon; this may be
    ///  a newly created icon or a new reference to an internal icon, so
    ///  you must not modify the icon. Use `cairo_surface_destroy()` to
    ///  release your reference to the icon. [`None`] if the icon isn’t
    ///  found.
    #[doc(alias = "gtk_icon_theme_load_surface")]
    fn load_surface(
        &self,
        icon_name: &str,
        size: i32,
        scale: i32,
        for_window: Option<&gdk::Window>,
        flags: IconLookupFlags,
    ) -> Result<Option<cairo::Surface>, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gtk_icon_theme_load_surface(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
                size,
                scale,
                for_window.to_glib_none().0,
                flags.into_glib(),
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Looks up an icon and returns a [`IconInfo`][crate::IconInfo] containing information
    /// such as the filename of the icon. The icon can then be rendered
    /// into a pixbuf using [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    ///
    /// When rendering on displays with high pixel densities you should not
    /// use a `size` multiplied by the scaling factor returned by functions
    /// like [`Window::scale_factor()`][crate::gdk::Window::scale_factor()]. Instead, you should use
    /// [`lookup_by_gicon_for_scale()`][Self::lookup_by_gicon_for_scale()], as the assets loaded
    /// for a given scaling factor may be different.
    /// ## `icon`
    /// the [`gio::Icon`][crate::gio::Icon] to look up
    /// ## `size`
    /// desired icon size
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconInfo`][crate::IconInfo] containing
    ///  information about the icon, or [`None`] if the icon wasn’t
    ///  found. Unref with `g_object_unref()`
    #[doc(alias = "gtk_icon_theme_lookup_by_gicon")]
    fn lookup_by_gicon(
        &self,
        icon: &impl IsA<gio::Icon>,
        size: i32,
        flags: IconLookupFlags,
    ) -> Option<IconInfo> {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_by_gicon(
                self.as_ref().to_glib_none().0,
                icon.as_ref().to_glib_none().0,
                size,
                flags.into_glib(),
            ))
        }
    }

    /// Looks up an icon and returns a [`IconInfo`][crate::IconInfo] containing information
    /// such as the filename of the icon. The icon can then be rendered into
    /// a pixbuf using [`IconInfo::load_icon()`][crate::IconInfo::load_icon()].
    /// ## `icon`
    /// the [`gio::Icon`][crate::gio::Icon] to look up
    /// ## `size`
    /// desired icon size
    /// ## `scale`
    /// the desired scale
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconInfo`][crate::IconInfo] containing
    ///  information about the icon, or [`None`] if the icon wasn’t
    ///  found. Unref with `g_object_unref()`
    #[doc(alias = "gtk_icon_theme_lookup_by_gicon_for_scale")]
    fn lookup_by_gicon_for_scale(
        &self,
        icon: &impl IsA<gio::Icon>,
        size: i32,
        scale: i32,
        flags: IconLookupFlags,
    ) -> Option<IconInfo> {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_by_gicon_for_scale(
                self.as_ref().to_glib_none().0,
                icon.as_ref().to_glib_none().0,
                size,
                scale,
                flags.into_glib(),
            ))
        }
    }

    /// Looks up a named icon and returns a [`IconInfo`][crate::IconInfo] containing
    /// information such as the filename of the icon. The icon
    /// can then be rendered into a pixbuf using
    /// [`IconInfo::load_icon()`][crate::IconInfo::load_icon()]. ([`load_icon()`][Self::load_icon()]
    /// combines these two steps if all you need is the pixbuf.)
    ///
    /// When rendering on displays with high pixel densities you should not
    /// use a `size` multiplied by the scaling factor returned by functions
    /// like [`Window::scale_factor()`][crate::gdk::Window::scale_factor()]. Instead, you should use
    /// [`lookup_icon_for_scale()`][Self::lookup_icon_for_scale()], as the assets loaded
    /// for a given scaling factor may be different.
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `size`
    /// desired icon size
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconInfo`][crate::IconInfo] object
    ///  containing information about the icon, or [`None`] if the
    ///  icon wasn’t found.
    #[doc(alias = "gtk_icon_theme_lookup_icon")]
    fn lookup_icon(&self, icon_name: &str, size: i32, flags: IconLookupFlags) -> Option<IconInfo> {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_icon(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
                size,
                flags.into_glib(),
            ))
        }
    }

    /// Looks up a named icon for a particular window scale and returns a
    /// [`IconInfo`][crate::IconInfo] containing information such as the filename of the
    /// icon. The icon can then be rendered into a pixbuf using
    /// [`IconInfo::load_icon()`][crate::IconInfo::load_icon()]. ([`load_icon()`][Self::load_icon()] combines
    /// these two steps if all you need is the pixbuf.)
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `size`
    /// desired icon size
    /// ## `scale`
    /// the desired scale
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconInfo`][crate::IconInfo] object
    ///  containing information about the icon, or [`None`] if the
    ///  icon wasn’t found.
    #[doc(alias = "gtk_icon_theme_lookup_icon_for_scale")]
    fn lookup_icon_for_scale(
        &self,
        icon_name: &str,
        size: i32,
        scale: i32,
        flags: IconLookupFlags,
    ) -> Option<IconInfo> {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_icon_for_scale(
                self.as_ref().to_glib_none().0,
                icon_name.to_glib_none().0,
                size,
                scale,
                flags.into_glib(),
            ))
        }
    }

    /// Prepends a directory to the search path.
    /// See `gtk_icon_theme_set_search_path()`.
    /// ## `path`
    /// directory name to prepend to the icon path
    #[doc(alias = "gtk_icon_theme_prepend_search_path")]
    fn prepend_search_path(&self, path: impl AsRef<std::path::Path>) {
        unsafe {
            ffi::gtk_icon_theme_prepend_search_path(
                self.as_ref().to_glib_none().0,
                path.as_ref().to_glib_none().0,
            );
        }
    }

    /// Checks to see if the icon theme has changed; if it has, any
    /// currently cached information is discarded and will be reloaded
    /// next time `self` is accessed.
    ///
    /// # Returns
    ///
    /// [`true`] if the icon theme has changed and needed
    ///  to be reloaded.
    #[doc(alias = "gtk_icon_theme_rescan_if_needed")]
    fn rescan_if_needed(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_icon_theme_rescan_if_needed(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the name of the icon theme that the [`IconTheme`][crate::IconTheme] object uses
    /// overriding system configuration. This function cannot be called
    /// on the icon theme objects returned from [`IconTheme::default()`][crate::IconTheme::default()]
    /// and [`IconTheme::for_screen()`][crate::IconTheme::for_screen()].
    /// ## `theme_name`
    /// name of icon theme to use instead of
    ///  configured theme, or [`None`] to unset a previously set custom theme
    #[doc(alias = "gtk_icon_theme_set_custom_theme")]
    fn set_custom_theme(&self, theme_name: Option<&str>) {
        unsafe {
            ffi::gtk_icon_theme_set_custom_theme(
                self.as_ref().to_glib_none().0,
                theme_name.to_glib_none().0,
            );
        }
    }

    /// Sets the screen for an icon theme; the screen is used
    /// to track the user’s currently configured icon theme,
    /// which might be different for different screens.
    /// ## `screen`
    /// a [`gdk::Screen`][crate::gdk::Screen]
    #[doc(alias = "gtk_icon_theme_set_screen")]
    fn set_screen(&self, screen: &gdk::Screen) {
        unsafe {
            ffi::gtk_icon_theme_set_screen(self.as_ref().to_glib_none().0, screen.to_glib_none().0);
        }
    }

    /// Emitted when the current icon theme is switched or GTK+ detects
    /// that a change has occurred in the contents of the current
    /// icon theme.
    #[doc(alias = "changed")]
    fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<P: IsA<IconTheme>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkIconTheme,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(IconTheme::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<IconTheme>> IconThemeExt for O {}