// 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::CoordType;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;
use std::mem;

glib::wrapper! {
    /// The ATK Interface implemented by components
    ///  which expose image or pixmap content on-screen.
    ///
    /// [`Image`][crate::Image] should be implemented by [`Object`][crate::Object] subtypes on behalf of
    /// components which display image/pixmap information onscreen, and
    /// which provide information (other than just widget borders, etc.)
    /// via that image content. For instance, icons, buttons with icons,
    /// toolbar elements, and image viewing panes typically should
    /// implement [`Image`][crate::Image].
    ///
    /// [`Image`][crate::Image] primarily provides two types of information: coordinate
    /// information (useful for screen review mode of screenreaders, and
    /// for use by onscreen magnifiers), and descriptive information. The
    /// descriptive information is provided for alternative, text-only
    /// presentation of the most significant information present in the
    /// image.
    ///
    /// # Implements
    ///
    /// [`AtkImageExt`][trait@crate::prelude::AtkImageExt]
    #[doc(alias = "AtkImage")]
    pub struct Image(Interface<ffi::AtkImage, ffi::AtkImageIface>);

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

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

/// Trait containing all [`struct@Image`] methods.
///
/// # Implementors
///
/// [`Image`][struct@crate::Image], [`NoOpObject`][struct@crate::NoOpObject]
pub trait AtkImageExt: 'static {
    /// Get a textual description of this image.
    ///
    /// # Returns
    ///
    /// a string representing the image description
    #[doc(alias = "atk_image_get_image_description")]
    #[doc(alias = "get_image_description")]
    fn image_description(&self) -> Option<glib::GString>;

    /// Retrieves the locale identifier associated to the [`Image`][crate::Image].
    ///
    /// # Returns
    ///
    /// a string corresponding to the POSIX
    ///  `LC_MESSAGES` locale used by the image description, or
    ///  [`None`] if the image does not specify a locale.
    #[doc(alias = "atk_image_get_image_locale")]
    #[doc(alias = "get_image_locale")]
    fn image_locale(&self) -> Option<glib::GString>;

    /// Gets the position of the image in the form of a point specifying the
    /// images top-left corner.
    ///
    /// If the position can not be obtained (e.g. missing support), x and y are set
    /// to -1.
    /// ## `coord_type`
    /// specifies whether the coordinates are relative to the screen
    /// or to the components top level window
    ///
    /// # Returns
    ///
    ///
    /// ## `x`
    /// address of `gint` to put x coordinate position; otherwise, -1 if value cannot be obtained.
    ///
    /// ## `y`
    /// address of `gint` to put y coordinate position; otherwise, -1 if value cannot be obtained.
    #[doc(alias = "atk_image_get_image_position")]
    #[doc(alias = "get_image_position")]
    fn image_position(&self, coord_type: CoordType) -> (i32, i32);

    /// Get the width and height in pixels for the specified image.
    /// The values of `width` and `height` are returned as -1 if the
    /// values cannot be obtained (for instance, if the object is not onscreen).
    ///
    /// If the size can not be obtained (e.g. missing support), x and y are set
    /// to -1.
    ///
    /// # Returns
    ///
    ///
    /// ## `width`
    /// filled with the image width, or -1 if the value cannot be obtained.
    ///
    /// ## `height`
    /// filled with the image height, or -1 if the value cannot be obtained.
    #[doc(alias = "atk_image_get_image_size")]
    #[doc(alias = "get_image_size")]
    fn image_size(&self) -> (i32, i32);

    /// Sets the textual description for this image.
    /// ## `description`
    /// a string description to set for `self`
    ///
    /// # Returns
    ///
    /// boolean TRUE, or FALSE if operation could
    /// not be completed.
    #[doc(alias = "atk_image_set_image_description")]
    fn set_image_description(&self, description: &str) -> bool;
}

impl<O: IsA<Image>> AtkImageExt for O {
    fn image_description(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::atk_image_get_image_description(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn image_locale(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::atk_image_get_image_locale(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn image_position(&self, coord_type: CoordType) -> (i32, i32) {
        unsafe {
            let mut x = mem::MaybeUninit::uninit();
            let mut y = mem::MaybeUninit::uninit();
            ffi::atk_image_get_image_position(
                self.as_ref().to_glib_none().0,
                x.as_mut_ptr(),
                y.as_mut_ptr(),
                coord_type.into_glib(),
            );
            (x.assume_init(), y.assume_init())
        }
    }

    fn image_size(&self) -> (i32, i32) {
        unsafe {
            let mut width = mem::MaybeUninit::uninit();
            let mut height = mem::MaybeUninit::uninit();
            ffi::atk_image_get_image_size(
                self.as_ref().to_glib_none().0,
                width.as_mut_ptr(),
                height.as_mut_ptr(),
            );
            (width.assume_init(), height.assume_init())
        }
    }

    fn set_image_description(&self, description: &str) -> bool {
        unsafe {
            from_glib(ffi::atk_image_set_image_description(
                self.as_ref().to_glib_none().0,
                description.to_glib_none().0,
            ))
        }
    }
}

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