// 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::{Annot, AnnotExternalDataType, AnnotMarkupReplyType, Rectangle};
use glib::{prelude::*, translate::*};
use std::fmt;

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

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

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

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

/// Trait containing all [`struct@AnnotMarkup`] methods.
///
/// # Implementors
///
/// [`AnnotCircle`][struct@crate::AnnotCircle], [`AnnotFileAttachment`][struct@crate::AnnotFileAttachment], [`AnnotFreeText`][struct@crate::AnnotFreeText], [`AnnotMarkup`][struct@crate::AnnotMarkup]
pub trait AnnotMarkupExt: IsA<AnnotMarkup> + sealed::Sealed + 'static {
    /// Returns the date and time when the annotation was created
    ///
    /// # Returns
    ///
    /// a [`glib::Date`][crate::glib::Date] representing the date and time
    ///  when the annotation was created, or [`None`]
    #[doc(alias = "poppler_annot_markup_get_date")]
    #[doc(alias = "get_date")]
    fn date(&self) -> Option<glib::Date> {
        unsafe {
            from_glib_full(ffi::poppler_annot_markup_get_date(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the external data type of `self`.
    ///
    /// # Returns
    ///
    /// [`AnnotExternalDataType`][crate::AnnotExternalDataType] of `self`.
    #[doc(alias = "poppler_annot_markup_get_external_data")]
    #[doc(alias = "get_external_data")]
    fn external_data(&self) -> AnnotExternalDataType {
        unsafe {
            from_glib(ffi::poppler_annot_markup_get_external_data(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the label text of `self`.
    ///
    /// # Returns
    ///
    /// the label text of `self`.
    #[doc(alias = "poppler_annot_markup_get_label")]
    #[doc(alias = "get_label")]
    fn label(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::poppler_annot_markup_get_label(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the opacity value of `self`.
    ///
    /// # Returns
    ///
    /// the opacity value of `self`,
    ///  between 0 (transparent) and 1 (opaque)
    #[doc(alias = "poppler_annot_markup_get_opacity")]
    #[doc(alias = "get_opacity")]
    fn opacity(&self) -> f64 {
        unsafe { ffi::poppler_annot_markup_get_opacity(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the state of the popup window related to `self`.
    ///
    /// # Returns
    ///
    /// the state of `self`. [`true`] if it's open, [`false`] in
    ///  other case.
    #[doc(alias = "poppler_annot_markup_get_popup_is_open")]
    #[doc(alias = "get_popup_is_open")]
    fn is_popup_is_open(&self) -> bool {
        unsafe {
            from_glib(ffi::poppler_annot_markup_get_popup_is_open(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the rectangle of the popup window related to `self`.
    ///
    /// # Returns
    ///
    /// [`true`] if [`Rectangle`][crate::Rectangle] was correctly filled, [`false`] otherwise
    ///
    /// ## `poppler_rect`
    /// a [`Rectangle`][crate::Rectangle] to store the popup rectangle
    #[doc(alias = "poppler_annot_markup_get_popup_rectangle")]
    #[doc(alias = "get_popup_rectangle")]
    fn popup_rectangle(&self) -> Option<Rectangle> {
        unsafe {
            let mut poppler_rect = Rectangle::uninitialized();
            let ret = from_glib(ffi::poppler_annot_markup_get_popup_rectangle(
                self.as_ref().to_glib_none().0,
                poppler_rect.to_glib_none_mut().0,
            ));
            if ret {
                Some(poppler_rect)
            } else {
                None
            }
        }
    }

    /// Gets the reply type of `self`.
    ///
    /// # Returns
    ///
    /// [`AnnotMarkupReplyType`][crate::AnnotMarkupReplyType] of `self`.
    #[doc(alias = "poppler_annot_markup_get_reply_to")]
    #[doc(alias = "get_reply_to")]
    fn reply_to(&self) -> AnnotMarkupReplyType {
        unsafe {
            from_glib(ffi::poppler_annot_markup_get_reply_to(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrives the subject text of `self`.
    ///
    /// # Returns
    ///
    /// the subject text of `self`.
    #[doc(alias = "poppler_annot_markup_get_subject")]
    #[doc(alias = "get_subject")]
    fn subject(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::poppler_annot_markup_get_subject(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Return [`true`] if the markup annotation has a popup window associated
    ///
    /// # Returns
    ///
    /// [`true`], if `self` has popup, [`false`] otherwise
    #[doc(alias = "poppler_annot_markup_has_popup")]
    fn has_popup(&self) -> bool {
        unsafe {
            from_glib(ffi::poppler_annot_markup_has_popup(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the label text of `self`, replacing the current one
    /// ## `label`
    /// a text string containing the new label, or [`None`]
    #[doc(alias = "poppler_annot_markup_set_label")]
    fn set_label(&self, label: Option<&str>) {
        unsafe {
            ffi::poppler_annot_markup_set_label(
                self.as_ref().to_glib_none().0,
                label.to_glib_none().0,
            );
        }
    }

    /// Sets the opacity of `self`. This value applies to
    /// all visible elements of `self` in its closed state,
    /// but not to the pop-up window that appears when it's openened
    /// ## `opacity`
    /// a constant opacity value, between 0 (transparent) and 1 (opaque)
    #[doc(alias = "poppler_annot_markup_set_opacity")]
    fn set_opacity(&self, opacity: f64) {
        unsafe {
            ffi::poppler_annot_markup_set_opacity(self.as_ref().to_glib_none().0, opacity);
        }
    }

    /// Associates a new popup window for editing contents of `self`.
    /// Popup window shall be displayed by viewers at `popup_rect` on the page.
    /// ## `popup_rect`
    /// a [`Rectangle`][crate::Rectangle]
    #[doc(alias = "poppler_annot_markup_set_popup")]
    fn set_popup(&self, popup_rect: &mut Rectangle) {
        unsafe {
            ffi::poppler_annot_markup_set_popup(
                self.as_ref().to_glib_none().0,
                popup_rect.to_glib_none_mut().0,
            );
        }
    }

    /// Sets the state of the popup window related to `self`.
    /// ## `is_open`
    /// whether popup window should initially be displayed open
    #[doc(alias = "poppler_annot_markup_set_popup_is_open")]
    fn set_popup_is_open(&self, is_open: bool) {
        unsafe {
            ffi::poppler_annot_markup_set_popup_is_open(
                self.as_ref().to_glib_none().0,
                is_open.into_glib(),
            );
        }
    }

    /// Sets the rectangle of the popup window related to `self`.
    /// This doesn't have any effect if `self` doesn't have a
    /// popup associated, use [`set_popup()`][Self::set_popup()] to associate
    /// a popup window to a [`AnnotMarkup`][crate::AnnotMarkup].
    /// ## `poppler_rect`
    /// a [`Rectangle`][crate::Rectangle] to set
    #[doc(alias = "poppler_annot_markup_set_popup_rectangle")]
    fn set_popup_rectangle(&self, poppler_rect: &mut Rectangle) {
        unsafe {
            ffi::poppler_annot_markup_set_popup_rectangle(
                self.as_ref().to_glib_none().0,
                poppler_rect.to_glib_none_mut().0,
            );
        }
    }
}

impl<O: IsA<AnnotMarkup>> AnnotMarkupExt for O {}

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