// 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;
use crate::IconLookupFlags;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::ptr;

glib::wrapper! {
    /// [`IconTheme`][crate::IconTheme] provides a facility for looking up icons by name
    /// and size. The main reason for using a name rather than simply
    /// providing a filename is to allow different icons to be used
    /// depending on what “icon theme” is selected
    /// by the user. The operation of icon themes on Linux and Unix
    /// follows the [Icon Theme Specification](http://www.freedesktop.org/Standards/icon-theme-spec)
    /// There is a fallback icon theme, named `hicolor`, where applications
    /// should install their icons, but additional icon themes can be installed
    /// as operating system vendors and users choose.
    ///
    /// Named icons are similar to the deprecated [Stock Items][gtkstock],
    /// and the distinction between the two may be a bit confusing.
    /// A few things to keep in mind:
    ///
    /// - Stock images usually are used in conjunction with
    ///  [Stock Items][gtkstock], such as `GTK_STOCK_OK` or
    ///  `GTK_STOCK_OPEN`. Named icons are easier to set up and therefore
    ///  are more useful for new icons that an application wants to
    ///  add, such as application icons or window icons.
    ///
    /// - Stock images can only be loaded at the symbolic sizes defined
    ///  by the [`IconSize`][crate::IconSize] enumeration, or by custom sizes defined
    ///  by `gtk_icon_size_register()`, while named icons are more flexible
    ///  and any pixel size can be specified.
    ///
    /// - Because stock images are closely tied to stock items, and thus
    ///  to actions in the user interface, stock images may come in
    ///  multiple variants for different widget states or writing
    ///  directions.
    ///
    /// A good rule of thumb is that if there is a stock image for what
    /// you want to use, use it, otherwise use a named icon. It turns
    /// out that internally stock images are generally defined in
    /// terms of one or more named icons. (An example of the
    /// more than one case is icons that depend on writing direction;
    /// `GTK_STOCK_GO_FORWARD` uses the two themed icons
    /// “gtk-stock-go-forward-ltr” and “gtk-stock-go-forward-rtl”.)
    ///
    /// In many cases, named themes are used indirectly, via [`Image`][crate::Image]
    /// or stock items, rather than directly, but looking up icons
    /// directly is also simple. The [`IconTheme`][crate::IconTheme] object acts
    /// as a database of all the icons in the current theme. You
    /// can create new [`IconTheme`][crate::IconTheme] objects, but it’s much more
    /// efficient to use the standard icon theme for the [`gdk::Screen`][crate::gdk::Screen]
    /// so that the icon information is shared with other people
    /// looking up icons.
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// GError *error = NULL;
    /// GtkIconTheme *icon_theme;
    /// GdkPixbuf *pixbuf;
    ///
    /// icon_theme = gtk_icon_theme_get_default ();
    /// pixbuf = gtk_icon_theme_load_icon (icon_theme,
    ///                                    "my-icon-name", // icon name
    ///                                    48, // icon size
    ///                                    0,  // flags
    ///                                    &error);
    /// if (!pixbuf)
    ///   {
    ///     g_warning ("Couldn’t load icon: %s", error->message);
    ///     g_error_free (error);
    ///   }
    /// else
    ///   {
    ///     // Use the pixbuf
    ///     g_object_unref (pixbuf);
    ///   }
    /// ```
    ///
    /// # 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")]
    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: '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);

    /// 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>);

    #[doc(alias = "gtk_icon_theme_get_example_icon_name")]
    #[doc(alias = "get_example_icon_name")]
    fn example_icon_name(&self) -> Option<glib::GString>;

    #[doc(alias = "gtk_icon_theme_has_icon")]
    fn has_icon(&self, icon_name: &str) -> bool;

    #[doc(alias = "gtk_icon_theme_list_contexts")]
    fn list_contexts(&self) -> Vec<glib::GString>;

    #[doc(alias = "gtk_icon_theme_list_icons")]
    fn list_icons(&self, context: Option<&str>) -> Vec<glib::GString>;

    #[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>;

    #[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>;

    #[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>;

    #[doc(alias = "gtk_icon_theme_lookup_by_gicon")]
    fn lookup_by_gicon(
        &self,
        icon: &impl IsA<gio::Icon>,
        size: i32,
        flags: IconLookupFlags,
    ) -> Option<IconInfo>;

    #[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>;

    #[doc(alias = "gtk_icon_theme_lookup_icon")]
    fn lookup_icon(&self, icon_name: &str, size: i32, flags: IconLookupFlags) -> Option<IconInfo>;

    #[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>;

    #[doc(alias = "gtk_icon_theme_prepend_search_path")]
    fn prepend_search_path(&self, path: impl AsRef<std::path::Path>);

    #[doc(alias = "gtk_icon_theme_rescan_if_needed")]
    fn rescan_if_needed(&self) -> bool;

    #[doc(alias = "gtk_icon_theme_set_custom_theme")]
    fn set_custom_theme(&self, theme_name: Option<&str>);

    #[doc(alias = "gtk_icon_theme_set_screen")]
    fn set_screen(&self, screen: &gdk::Screen);

    #[doc(alias = "changed")]
    fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<IconTheme>> IconThemeExt for O {
    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,
            );
        }
    }

    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,
            );
        }
    }

    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,
            ))
        }
    }

    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,
            ))
        }
    }

    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,
            ))
        }
    }

    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,
            ))
        }
    }

    fn load_icon(
        &self,
        icon_name: &str,
        size: i32,
        flags: IconLookupFlags,
    ) -> Result<Option<gdk_pixbuf::Pixbuf>, glib::Error> {
        unsafe {
            let mut error = 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))
            }
        }
    }

    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 = 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))
            }
        }
    }

    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 = 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))
            }
        }
    }

    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(),
            ))
        }
    }

    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(),
            ))
        }
    }

    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(),
            ))
        }
    }

    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(),
            ))
        }
    }

    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,
            );
        }
    }

    fn rescan_if_needed(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_icon_theme_rescan_if_needed(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    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,
            );
        }
    }

    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);
        }
    }

    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,
        ) {
            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 _,
                b"changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for IconTheme {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("IconTheme")
    }
}