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

use crate::AnchorHints;
use crate::Gravity;
use crate::Rectangle;
use glib::translate::*;
#[cfg(any(feature = "v4_2", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_2")))]
use std::mem;

glib::wrapper! {
    /// The [`PopupLayout`][crate::PopupLayout] struct contains information that is
    /// necessary position a [`Popup`][crate::Popup] relative to its parent.
    ///
    /// The positioning requires a negotiation with the windowing system,
    /// since it depends on external constraints, such as the position of
    /// the parent surface, and the screen dimensions.
    ///
    /// The basic ingredients are a rectangle on the parent surface,
    /// and the anchor on both that rectangle and the popup. The anchors
    /// specify a side or corner to place next to each other.
    ///
    /// ![Popup anchors](popup-anchors.png)
    ///
    /// For cases where placing the anchors next to each other would make
    /// the popup extend offscreen, the layout includes some hints for how
    /// to resolve this problem. The hints may suggest to flip the anchor
    /// position to the other side, or to 'slide' the popup along a side,
    /// or to resize it.
    ///
    /// ![Flipping popups](popup-flip.png)
    ///
    /// ![Sliding popups](popup-slide.png)
    ///
    /// These hints may be combined.
    ///
    /// Ultimatively, it is up to the windowing system to determine the position
    /// and size of the popup. You can learn about the result by calling
    /// [``PopupExt::position_x()``][crate::prelude::`PopupExt::position_x()`], [``PopupExt::position_y()``][crate::prelude::`PopupExt::position_y()`],
    /// [``PopupExt::rect_anchor()``][crate::prelude::`PopupExt::rect_anchor()`] and [``PopupExt::surface_anchor()``][crate::prelude::`PopupExt::surface_anchor()`]
    /// after the popup has been presented. This can be used to adjust the rendering.
    /// For example, `Gtk::Popover` changes its arrow position accordingly.
    /// But you have to be careful avoid changing the size of the popover, or it
    /// has to be presented again.
    #[derive(Debug, PartialOrd, Ord, Hash)]
    pub struct PopupLayout(Shared<ffi::GdkPopupLayout>);

    match fn {
        ref => |ptr| ffi::gdk_popup_layout_ref(ptr),
        unref => |ptr| ffi::gdk_popup_layout_unref(ptr),
        type_ => || ffi::gdk_popup_layout_get_type(),
    }
}

impl PopupLayout {
    /// Create a popup layout description.
    ///
    /// Used together with [``PopupExt::present()``][crate::prelude::`PopupExt::present()`] to describe how a popup
    /// surface should be placed and behave on-screen.
    ///
    /// `anchor_rect` is relative to the top-left corner of the surface's parent.
    /// `rect_anchor` and `surface_anchor` determine anchor points on `anchor_rect`
    /// and surface to pin together.
    ///
    /// The position of `anchor_rect`'s anchor point can optionally be offset using
    /// [``set_offset()``][`Self::set_offset()`], which is equivalent to offsetting the
    /// position of surface.
    /// ## `anchor_rect`
    /// the anchor [`Rectangle`][crate::Rectangle] to align `surface` with
    /// ## `rect_anchor`
    /// the point on `anchor_rect` to align with `surface`'s anchor point
    /// ## `surface_anchor`
    /// the point on `surface` to align with `rect`'s anchor point
    ///
    /// # Returns
    ///
    /// newly created instance of [`PopupLayout`][crate::PopupLayout]
    #[doc(alias = "gdk_popup_layout_new")]
    pub fn new(
        anchor_rect: &Rectangle,
        rect_anchor: Gravity,
        surface_anchor: Gravity,
    ) -> PopupLayout {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gdk_popup_layout_new(
                anchor_rect.to_glib_none().0,
                rect_anchor.into_glib(),
                surface_anchor.into_glib(),
            ))
        }
    }

    /// Makes a copy of `self`.
    ///
    /// # Returns
    ///
    /// a copy of `self`.
    #[doc(alias = "gdk_popup_layout_copy")]
    pub fn copy(&self) -> Option<PopupLayout> {
        unsafe { from_glib_full(ffi::gdk_popup_layout_copy(self.to_glib_none().0)) }
    }

    /// Check whether `self` and `other` has identical layout properties.
    /// ## `other`
    /// another [`PopupLayout`][crate::PopupLayout]
    ///
    /// # Returns
    ///
    /// [`true`] if `self` and `other` have identical layout properties,
    ///  otherwise [`false`].
    #[doc(alias = "gdk_popup_layout_equal")]
    fn equal(&self, other: &PopupLayout) -> bool {
        unsafe {
            from_glib(ffi::gdk_popup_layout_equal(
                self.to_glib_none().0,
                other.to_glib_none().0,
            ))
        }
    }

    /// Get the [`AnchorHints`][crate::AnchorHints].
    ///
    /// # Returns
    ///
    /// the [`AnchorHints`][crate::AnchorHints]
    #[doc(alias = "gdk_popup_layout_get_anchor_hints")]
    #[doc(alias = "get_anchor_hints")]
    pub fn anchor_hints(&self) -> AnchorHints {
        unsafe {
            from_glib(ffi::gdk_popup_layout_get_anchor_hints(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the anchor rectangle.
    ///
    /// # Returns
    ///
    /// The anchor rectangle
    #[doc(alias = "gdk_popup_layout_get_anchor_rect")]
    #[doc(alias = "get_anchor_rect")]
    pub fn anchor_rect(&self) -> Option<Rectangle> {
        unsafe { from_glib_none(ffi::gdk_popup_layout_get_anchor_rect(self.to_glib_none().0)) }
    }

    /// Returns the anchor position on the anchor rectangle.
    ///
    /// # Returns
    ///
    /// the anchor on the anchor rectangle.
    #[doc(alias = "gdk_popup_layout_get_rect_anchor")]
    #[doc(alias = "get_rect_anchor")]
    pub fn rect_anchor(&self) -> Gravity {
        unsafe { from_glib(ffi::gdk_popup_layout_get_rect_anchor(self.to_glib_none().0)) }
    }

    /// Obtains the shadow widths of this layout.
    ///
    /// # Returns
    ///
    ///
    /// ## `left`
    /// return location for the left shadow width
    ///
    /// ## `right`
    /// return location for the right shadow width
    ///
    /// ## `top`
    /// return location for the top shadow width
    ///
    /// ## `bottom`
    /// return location for the bottom shadow width
    #[cfg(any(feature = "v4_2", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_2")))]
    #[doc(alias = "gdk_popup_layout_get_shadow_width")]
    #[doc(alias = "get_shadow_width")]
    pub fn shadow_width(&self) -> (i32, i32, i32, i32) {
        unsafe {
            let mut left = mem::MaybeUninit::uninit();
            let mut right = mem::MaybeUninit::uninit();
            let mut top = mem::MaybeUninit::uninit();
            let mut bottom = mem::MaybeUninit::uninit();
            ffi::gdk_popup_layout_get_shadow_width(
                self.to_glib_none().0,
                left.as_mut_ptr(),
                right.as_mut_ptr(),
                top.as_mut_ptr(),
                bottom.as_mut_ptr(),
            );
            let left = left.assume_init();
            let right = right.assume_init();
            let top = top.assume_init();
            let bottom = bottom.assume_init();
            (left, right, top, bottom)
        }
    }

    /// Returns the anchor position on the popup surface.
    ///
    /// # Returns
    ///
    /// the anchor on the popup surface.
    #[doc(alias = "gdk_popup_layout_get_surface_anchor")]
    #[doc(alias = "get_surface_anchor")]
    pub fn surface_anchor(&self) -> Gravity {
        unsafe {
            from_glib(ffi::gdk_popup_layout_get_surface_anchor(
                self.to_glib_none().0,
            ))
        }
    }

    /// Set new anchor hints.
    ///
    /// The set `anchor_hints` determines how `surface` will be moved
    /// if the anchor points cause it to move off-screen. For example,
    /// [`AnchorHints::FLIP_X`][crate::AnchorHints::FLIP_X] will replace [`Gravity::NorthWest`][crate::Gravity::NorthWest] with
    /// [`Gravity::NorthEast`][crate::Gravity::NorthEast] and vice versa if `surface` extends
    /// beyond the left or right edges of the monitor.
    /// ## `anchor_hints`
    /// the new [`AnchorHints`][crate::AnchorHints]
    #[doc(alias = "gdk_popup_layout_set_anchor_hints")]
    pub fn set_anchor_hints(&self, anchor_hints: AnchorHints) {
        unsafe {
            ffi::gdk_popup_layout_set_anchor_hints(self.to_glib_none().0, anchor_hints.into_glib());
        }
    }

    /// Set the anchor rectangle.
    /// ## `anchor_rect`
    /// the new anchor rectangle
    #[doc(alias = "gdk_popup_layout_set_anchor_rect")]
    pub fn set_anchor_rect(&self, anchor_rect: &Rectangle) {
        unsafe {
            ffi::gdk_popup_layout_set_anchor_rect(
                self.to_glib_none().0,
                anchor_rect.to_glib_none().0,
            );
        }
    }

    /// Offset the position of the anchor rectangle with the given delta.
    /// ## `dx`
    /// x delta to offset the anchor rectangle with
    /// ## `dy`
    /// y delta to offset the anchor rectangle with
    #[doc(alias = "gdk_popup_layout_set_offset")]
    pub fn set_offset(&self, dx: i32, dy: i32) {
        unsafe {
            ffi::gdk_popup_layout_set_offset(self.to_glib_none().0, dx, dy);
        }
    }

    /// Set the anchor on the anchor rectangle.
    /// ## `anchor`
    /// the new rect anchor
    #[doc(alias = "gdk_popup_layout_set_rect_anchor")]
    pub fn set_rect_anchor(&self, anchor: Gravity) {
        unsafe {
            ffi::gdk_popup_layout_set_rect_anchor(self.to_glib_none().0, anchor.into_glib());
        }
    }

    /// Sets the shadow width of the popup.
    ///
    /// The shadow width corresponds to the part of the computed
    /// surface size that would consist of the shadow margin
    /// surrounding the window, would there be any.
    /// ## `left`
    /// width of the left part of the shadow
    /// ## `right`
    /// width of the right part of the shadow
    /// ## `top`
    /// height of the top part of the shadow
    /// ## `bottom`
    /// height of the bottom part of the shadow
    #[cfg(any(feature = "v4_2", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_2")))]
    #[doc(alias = "gdk_popup_layout_set_shadow_width")]
    pub fn set_shadow_width(&self, left: i32, right: i32, top: i32, bottom: i32) {
        unsafe {
            ffi::gdk_popup_layout_set_shadow_width(self.to_glib_none().0, left, right, top, bottom);
        }
    }

    /// Set the anchor on the popup surface.
    /// ## `anchor`
    /// the new popup surface anchor
    #[doc(alias = "gdk_popup_layout_set_surface_anchor")]
    pub fn set_surface_anchor(&self, anchor: Gravity) {
        unsafe {
            ffi::gdk_popup_layout_set_surface_anchor(self.to_glib_none().0, anchor.into_glib());
        }
    }
}

impl PartialEq for PopupLayout {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}

impl Eq for PopupLayout {}