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

glib::wrapper! {
    /// s much more
    /// efficient to use the standard icon theme of the [`Widget`][crate::Widget] so that the
    /// icon information is shared with other people looking up icons.
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// GtkIconTheme *icon_theme;
    /// GtkIconPaintable *icon;
    /// GdkPaintable *paintable;
    ///
    /// icon_theme = gtk_icon_theme_get_for_display (gtk_widget_get_display (my_widget));
    /// icon = gtk_icon_theme_lookup_icon (icon_theme,
    ///                                    "my-icon-name", // icon name
    ///                                    48, // icon size
    ///                                    1,  // scale
    ///                                    0,  // flags);
    /// paintable = GDK_PAINTABLE (icon);
    /// // Use the paintable
    /// g_object_unref (icon);
    /// ```
    ///
    /// ## Properties
    ///
    ///
    /// #### `display`
    ///  The display that this icon theme object is attached to.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `icon-names`
    ///  The icon names that are supported by the icon theme.
    ///
    /// Readable
    ///
    ///
    /// #### `resource-path`
    ///  Resource paths that will be looked at when looking for icons,
    /// similar to search paths.
    ///
    /// 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.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `search-path`
    ///  s home directory.)
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `theme-name`
    ///  The name of the icon theme that is being used.
    ///
    /// Unless set to a different value, this will be the value of
    /// the `GtkSettings:gtk-icon-theme-name` property of the [`Settings`][crate::Settings]
    /// object associated to the display of the icontheme object.
    ///
    /// Readable | Writable
    ///
    /// ## Signals
    ///
    ///
    /// #### `changed`
    ///  Emitted when the icon theme changes.
    ///
    /// This can happen because current icon theme is switched or
    /// because GTK detects that a change has occurred in the
    /// contents of the current icon theme.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkIconTheme")]
    pub struct IconTheme(Object<ffi::GtkIconTheme>);

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

impl IconTheme {
    /// ll want to use
    /// [`for_display()`][Self::for_display()] 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()) }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`IconTheme`] objects.
    ///
    /// This method returns an instance of [`IconThemeBuilder`](crate::builders::IconThemeBuilder) which can be used to create [`IconTheme`] objects.
    pub fn builder() -> IconThemeBuilder {
        IconThemeBuilder::new()
    }

    /// Adds a resource path that will be looked at when looking
    /// for icons, similar to search paths.
    ///
    /// See [`set_resource_path()`][Self::set_resource_path()].
    ///
    /// This function should be used to make application-specific icons
    /// available as part of the icon theme.
    /// ## `path`
    /// a resource path
    #[doc(alias = "gtk_icon_theme_add_resource_path")]
    pub fn add_resource_path(&self, path: &str) {
        unsafe {
            ffi::gtk_icon_theme_add_resource_path(self.to_glib_none().0, path.to_glib_none().0);
        }
    }

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

    /// Returns the display that the [`IconTheme`][crate::IconTheme] object was
    /// created for.
    ///
    /// # Returns
    ///
    /// the display of @icon_theme
    #[doc(alias = "gtk_icon_theme_get_display")]
    #[doc(alias = "get_display")]
    pub fn display(&self) -> Option<gdk::Display> {
        unsafe { from_glib_none(ffi::gtk_icon_theme_get_display(self.to_glib_none().0)) }
    }

    /// Lists the names of icons in the current icon theme.
    ///
    /// # Returns
    ///
    /// a string array
    ///   holding the names of all the icons in the theme. You must
    ///   free the array using g_strfreev().
    #[doc(alias = "gtk_icon_theme_get_icon_names")]
    #[doc(alias = "get_icon_names")]
    #[doc(alias = "icon-names")]
    pub fn icon_names(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_icon_theme_get_icon_names(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the current resource path.
    ///
    /// See [`set_resource_path()`][Self::set_resource_path()].
    ///
    /// # Returns
    ///
    ///
    ///   A list of resource paths
    #[doc(alias = "gtk_icon_theme_get_resource_path")]
    #[doc(alias = "get_resource_path")]
    #[doc(alias = "resource-path")]
    pub fn resource_path(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_icon_theme_get_resource_path(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the current search path.
    ///
    /// See [`set_search_path()`][Self::set_search_path()].
    ///
    /// # Returns
    ///
    ///
    ///   a list of icon theme path directories
    #[doc(alias = "gtk_icon_theme_get_search_path")]
    #[doc(alias = "get_search_path")]
    #[doc(alias = "search-path")]
    pub fn search_path(&self) -> Vec<std::path::PathBuf> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_icon_theme_get_search_path(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the current icon theme name.
    ///
    /// # Returns
    ///
    /// the current icon theme name,
    #[doc(alias = "gtk_icon_theme_get_theme_name")]
    #[doc(alias = "get_theme_name")]
    #[doc(alias = "theme-name")]
    pub fn theme_name(&self) -> glib::GString {
        unsafe { from_glib_full(ffi::gtk_icon_theme_get_theme_name(self.to_glib_none().0)) }
    }

    /// Checks whether an icon theme includes an icon
    /// for a particular `GIcon`.
    /// ## `gicon`
    /// a `GIcon`
    ///
    /// # Returns
    ///
    /// [`true`] if @self includes an icon for @gicon
    #[cfg(feature = "v4_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_2")))]
    #[doc(alias = "gtk_icon_theme_has_gicon")]
    pub fn has_gicon(&self, gicon: &impl IsA<gio::Icon>) -> bool {
        unsafe {
            from_glib(ffi::gtk_icon_theme_has_gicon(
                self.to_glib_none().0,
                gicon.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")]
    pub fn has_icon(&self, icon_name: &str) -> bool {
        unsafe {
            from_glib(ffi::gtk_icon_theme_has_icon(
                self.to_glib_none().0,
                icon_name.to_glib_none().0,
            ))
        }
    }

    /// Looks up a icon for a desired size and window scale.
    ///
    /// The icon can then be rendered by using it as a [`gdk::Paintable`][crate::gdk::Paintable],
    /// or you can get information such as the filename and size.
    /// ## `icon`
    /// the `GIcon` to look up
    /// ## `size`
    /// desired icon size, in application pixels
    /// ## `scale`
    /// the desired scale
    /// ## `direction`
    /// text direction the icon will be displayed in
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconPaintable`][crate::IconPaintable] containing
    ///   information about the icon. Unref with g_object_unref()
    #[doc(alias = "gtk_icon_theme_lookup_by_gicon")]
    pub fn lookup_by_gicon(
        &self,
        icon: &impl IsA<gio::Icon>,
        size: i32,
        scale: i32,
        direction: TextDirection,
        flags: IconLookupFlags,
    ) -> IconPaintable {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_by_gicon(
                self.to_glib_none().0,
                icon.as_ref().to_glib_none().0,
                size,
                scale,
                direction.into_glib(),
                flags.into_glib(),
            ))
        }
    }

    /// Looks up a named icon for a desired size and window scale,
    /// returning a [`IconPaintable`][crate::IconPaintable].
    ///
    /// The icon can then be rendered by using it as a [`gdk::Paintable`][crate::gdk::Paintable],
    /// or you can get information such as the filename and size.
    ///
    /// If the available @icon_name is not available and @fallbacks are
    /// provided, they will be tried in order.
    ///
    /// If no matching icon is found, then a paintable that renders the
    /// "missing icon" icon is returned. If you need to do something else
    /// for missing icons you need to use [`has_icon()`][Self::has_icon()].
    ///
    /// Note that you probably want to listen for icon theme changes and
    /// update the icon. This is usually done by overriding the
    /// GtkWidgetClass.css-changed() function.
    /// ## `icon_name`
    /// the name of the icon to lookup
    /// ## `fallbacks`
    /// fallback names
    /// ## `size`
    /// desired icon size, in application pixels
    /// ## `scale`
    /// the window scale this will be displayed on
    /// ## `direction`
    /// text direction the icon will be displayed in
    /// ## `flags`
    /// flags modifying the behavior of the icon lookup
    ///
    /// # Returns
    ///
    /// a [`IconPaintable`][crate::IconPaintable] object
    ///   containing the icon.
    #[doc(alias = "gtk_icon_theme_lookup_icon")]
    pub fn lookup_icon(
        &self,
        icon_name: &str,
        fallbacks: &[&str],
        size: i32,
        scale: i32,
        direction: TextDirection,
        flags: IconLookupFlags,
    ) -> IconPaintable {
        unsafe {
            from_glib_full(ffi::gtk_icon_theme_lookup_icon(
                self.to_glib_none().0,
                icon_name.to_glib_none().0,
                fallbacks.to_glib_none().0,
                size,
                scale,
                direction.into_glib(),
                flags.into_glib(),
            ))
        }
    }

    /// Sets the resource paths that will be looked at when
    /// looking for icons, similar to search paths.
    ///
    /// 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`
    /// or `@path/scalable/actions/run.svg`.
    ///
    /// Icons that are directly placed in the resource path instead
    /// of a subdirectory are also considered as ultimate fallback,
    /// but they are treated like unthemed icons.
    /// ## `path`
    ///
    ///   NULL-terminated array of resource paths
    ///   that are searched for icons
    #[doc(alias = "gtk_icon_theme_set_resource_path")]
    #[doc(alias = "resource-path")]
    pub fn set_resource_path(&self, path: &[&str]) {
        unsafe {
            ffi::gtk_icon_theme_set_resource_path(self.to_glib_none().0, path.to_glib_none().0);
        }
    }

    /// t found either in the current
    /// icon theme or the default icon theme, and an image file with
    /// the right name is found directly in one of the elements of
    /// @path, then that image will be used for the icon name.
    /// (This is legacy feature, and new icons should be put
    /// into the fallback icon theme, which is called hicolor,
    /// rather than directly on the icon path.)
    /// ## `path`
    /// NULL-terminated
    ///   array of directories that are searched for icon themes
    #[doc(alias = "gtk_icon_theme_set_search_path")]
    #[doc(alias = "search-path")]
    pub fn set_search_path(&self, path: &[&std::path::Path]) {
        unsafe {
            ffi::gtk_icon_theme_set_search_path(self.to_glib_none().0, path.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 [`for_display()`][Self::for_display()].
    /// ## `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_theme_name")]
    #[doc(alias = "theme-name")]
    pub fn set_theme_name(&self, theme_name: Option<&str>) {
        unsafe {
            ffi::gtk_icon_theme_set_theme_name(self.to_glib_none().0, theme_name.to_glib_none().0);
        }
    }

    /// The display that this icon theme object is attached to.
    pub fn set_display<P: IsA<gdk::Display>>(&self, display: Option<&P>) {
        ObjectExt::set_property(self, "display", display)
    }

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

    /// Emitted when the icon theme changes.
    ///
    /// This can happen because current icon theme is switched or
    /// because GTK detects that a change has occurred in the
    /// contents of the current icon theme.
    #[doc(alias = "changed")]
    pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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"changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "display")]
    pub fn connect_display_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_display_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::display".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_display_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "icon-names")]
    pub fn connect_icon_names_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_icon_names_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::icon-names".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_icon_names_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "resource-path")]
    pub fn connect_resource_path_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_resource_path_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::resource-path".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_resource_path_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "search-path")]
    pub fn connect_search_path_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_search_path_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::search-path".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_search_path_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "theme-name")]
    pub fn connect_theme_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_theme_name_trampoline<F: Fn(&IconTheme) + 'static>(
            this: *mut ffi::GtkIconTheme,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::theme-name".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_theme_name_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`IconTheme`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct IconThemeBuilder {
    builder: glib::object::ObjectBuilder<'static, IconTheme>,
}

impl IconThemeBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The display that this icon theme object is attached to.
    pub fn display(self, display: &impl IsA<gdk::Display>) -> Self {
        Self {
            builder: self.builder.property("display", display.clone().upcast()),
        }
    }

    /// Resource paths that will be looked at when looking for icons,
    /// similar to search paths.
    ///
    /// 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.
    pub fn resource_path(self, resource_path: impl Into<glib::StrV>) -> Self {
        Self {
            builder: self.builder.property("resource-path", resource_path.into()),
        }
    }

    /// s home directory.)
    pub fn search_path(self, search_path: impl Into<glib::StrV>) -> Self {
        Self {
            builder: self.builder.property("search-path", search_path.into()),
        }
    }

    /// The name of the icon theme that is being used.
    ///
    /// Unless set to a different value, this will be the value of
    /// the `GtkSettings:gtk-icon-theme-name` property of the [`Settings`][crate::Settings]
    /// object associated to the display of the icontheme object.
    pub fn theme_name(self, theme_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("theme-name", theme_name.into()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`IconTheme`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> IconTheme {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}