// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, AnnotFlag, AnnotType, Color, Rectangle};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    ///
    ///
    /// # Implements
    ///
    /// [`AnnotExt`][trait@crate::prelude::AnnotExt]
    #[doc(alias = "PopplerAnnot")]
    pub struct Annot(Object<ffi::PopplerAnnot>);

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

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

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Annot>> Sealed for T {}
}

/// Trait containing all [`struct@Annot`] methods.
///
/// # Implementors
///
/// [`AnnotMarkup`][struct@crate::AnnotMarkup], [`Annot`][struct@crate::Annot]
pub trait AnnotExt: IsA<Annot> + sealed::Sealed + 'static {
    /// Gets the type of `self`
    ///
    /// # Returns
    ///
    /// [`AnnotType`][crate::AnnotType] of `self`.
    #[doc(alias = "poppler_annot_get_annot_type")]
    #[doc(alias = "get_annot_type")]
    fn annot_type(&self) -> AnnotType {
        unsafe {
            from_glib(ffi::poppler_annot_get_annot_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the color of `self`.
    ///
    /// # Returns
    ///
    /// a new allocated [`Color`][crate::Color] with the color values of
    ///  `self`, or [`None`]. It must be freed with `g_free()` when done.
    #[doc(alias = "poppler_annot_get_color")]
    #[doc(alias = "get_color")]
    fn color(&self) -> Option<Color> {
        unsafe { from_glib_full(ffi::poppler_annot_get_color(self.as_ref().to_glib_none().0)) }
    }

    /// Retrieves the contents of `self`.
    ///
    /// # Returns
    ///
    /// a new allocated string with the contents of `self`. It
    ///  must be freed with `g_free()` when done.
    #[doc(alias = "poppler_annot_get_contents")]
    #[doc(alias = "get_contents")]
    fn contents(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::poppler_annot_get_contents(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the flag field specifying various characteristics of the
    /// `self`.
    ///
    /// # Returns
    ///
    /// the flag field of `self`.
    #[doc(alias = "poppler_annot_get_flags")]
    #[doc(alias = "get_flags")]
    fn flags(&self) -> AnnotFlag {
        unsafe { from_glib(ffi::poppler_annot_get_flags(self.as_ref().to_glib_none().0)) }
    }

    /// Retrieves the last modification data of `self`. The returned
    /// string will be either a PDF format date or a text string.
    /// See also `poppler_date_parse()`
    ///
    /// # Returns
    ///
    /// a new allocated string with the last modification data of
    ///  `self`. It must be freed with `g_free()` when done.
    #[doc(alias = "poppler_annot_get_modified")]
    #[doc(alias = "get_modified")]
    fn modified(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::poppler_annot_get_modified(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the name of `self`.
    ///
    /// # Returns
    ///
    /// a new allocated string with the name of `self`. It must
    ///  be freed with `g_free()` when done.
    #[doc(alias = "poppler_annot_get_name")]
    #[doc(alias = "get_name")]
    fn name(&self) -> Option<glib::GString> {
        unsafe { from_glib_full(ffi::poppler_annot_get_name(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the page index to which `self` is associated, or -1 if unknown
    ///
    /// # Returns
    ///
    /// page index or -1
    #[doc(alias = "poppler_annot_get_page_index")]
    #[doc(alias = "get_page_index")]
    fn page_index(&self) -> i32 {
        unsafe { ffi::poppler_annot_get_page_index(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the rectangle representing the page coordinates where the
    /// annotation `self` is placed.
    ///
    /// # Returns
    ///
    ///
    /// ## `poppler_rect`
    /// a [`Rectangle`][crate::Rectangle] to store the annotation's coordinates
    #[doc(alias = "poppler_annot_get_rectangle")]
    #[doc(alias = "get_rectangle")]
    fn rectangle(&self) -> Rectangle {
        unsafe {
            let mut poppler_rect = Rectangle::uninitialized();
            ffi::poppler_annot_get_rectangle(
                self.as_ref().to_glib_none().0,
                poppler_rect.to_glib_none_mut().0,
            );
            poppler_rect
        }
    }

    /// Sets the color of `self`.
    /// ## `poppler_color`
    /// a [`Color`][crate::Color], or [`None`]
    #[doc(alias = "poppler_annot_set_color")]
    fn set_color(&self, poppler_color: Option<&Color>) {
        unsafe {
            ffi::poppler_annot_set_color(
                self.as_ref().to_glib_none().0,
                mut_override(poppler_color.to_glib_none().0),
            );
        }
    }

    /// Sets the contents of `self` to the given value,
    /// replacing the current contents.
    /// ## `contents`
    /// a text string containing the new contents
    #[doc(alias = "poppler_annot_set_contents")]
    fn set_contents(&self, contents: &str) {
        unsafe {
            ffi::poppler_annot_set_contents(
                self.as_ref().to_glib_none().0,
                contents.to_glib_none().0,
            );
        }
    }

    /// Sets the flag field specifying various characteristics of the
    /// `self`.
    /// ## `flags`
    /// a [`AnnotFlag`][crate::AnnotFlag]
    #[doc(alias = "poppler_annot_set_flags")]
    fn set_flags(&self, flags: AnnotFlag) {
        unsafe {
            ffi::poppler_annot_set_flags(self.as_ref().to_glib_none().0, flags.into_glib());
        }
    }

    /// Move the annotation to the rectangle representing the page coordinates
    /// where the annotation `self` should be placed.
    /// ## `poppler_rect`
    /// a [`Rectangle`][crate::Rectangle] with the new annotation's coordinates
    #[doc(alias = "poppler_annot_set_rectangle")]
    fn set_rectangle(&self, poppler_rect: &mut Rectangle) {
        unsafe {
            ffi::poppler_annot_set_rectangle(
                self.as_ref().to_glib_none().0,
                poppler_rect.to_glib_none_mut().0,
            );
        }
    }
}

impl<O: IsA<Annot>> AnnotExt for O {}