// 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::Buildable;
use crate::CellArea;
use crate::CellLayout;
use crate::CellRenderer;
use crate::Orientable;
use crate::Orientation;
use glib::object::Cast;
use glib::object::IsA;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// A cell area that renders GtkCellRenderers into a row or a column
    ///
    /// The [`CellAreaBox`][crate::CellAreaBox] renders cell renderers into a row or a column
    /// depending on its [`Orientation`][crate::Orientation].
    ///
    /// GtkCellAreaBox uses a notion of packing. Packing
    /// refers to adding cell renderers with reference to a particular position
    /// in a [`CellAreaBox`][crate::CellAreaBox]. There are two reference positions: the
    /// start and the end of the box.
    /// When the [`CellAreaBox`][crate::CellAreaBox] is oriented in the [`Orientation::Vertical`][crate::Orientation::Vertical]
    /// orientation, the start is defined as the top of the box and the end is
    /// defined as the bottom. In the [`Orientation::Horizontal`][crate::Orientation::Horizontal] orientation
    /// start is defined as the left side and the end is defined as the right
    /// side.
    ///
    /// Alignments of [`CellRenderer`][crate::CellRenderer]s rendered in adjacent rows can be
    /// configured by configuring the [`CellAreaBox`][crate::CellAreaBox] align child cell property
    /// with gtk_cell_area_cell_set_property() or by specifying the "align"
    /// argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end().
    ///
    /// # Implements
    ///
    /// [`CellAreaExt`][trait@crate::prelude::CellAreaExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`CellLayoutExt`][trait@crate::prelude::CellLayoutExt], [`OrientableExt`][trait@crate::prelude::OrientableExt], [`CellAreaExtManual`][trait@crate::prelude::CellAreaExtManual], [`CellLayoutExtManual`][trait@crate::prelude::CellLayoutExtManual]
    #[doc(alias = "GtkCellAreaBox")]
    pub struct CellAreaBox(Object<ffi::GtkCellAreaBox>) @extends CellArea, @implements Buildable, CellLayout, Orientable;

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

impl CellAreaBox {
    /// Creates a new [`CellAreaBox`][crate::CellAreaBox].
    ///
    /// # Returns
    ///
    /// a newly created [`CellAreaBox`][crate::CellAreaBox]
    #[doc(alias = "gtk_cell_area_box_new")]
    pub fn new() -> CellAreaBox {
        assert_initialized_main_thread!();
        unsafe { CellArea::from_glib_none(ffi::gtk_cell_area_box_new()).unsafe_cast() }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`CellAreaBox`] objects.
    ///
    /// This method returns an instance of [`CellAreaBoxBuilder`](crate::builders::CellAreaBoxBuilder) which can be used to create [`CellAreaBox`] objects.
    pub fn builder() -> CellAreaBoxBuilder {
        CellAreaBoxBuilder::default()
    }

    /// Gets the spacing added between cell renderers.
    ///
    /// # Returns
    ///
    /// the space added between cell renderers in @self.
    #[doc(alias = "gtk_cell_area_box_get_spacing")]
    #[doc(alias = "get_spacing")]
    pub fn spacing(&self) -> i32 {
        unsafe { ffi::gtk_cell_area_box_get_spacing(self.to_glib_none().0) }
    }

    /// Adds @renderer to @self, packed with reference to the end of @self.
    ///
    /// The @renderer is packed after (away from end of) any other
    /// [`CellRenderer`][crate::CellRenderer] packed with reference to the end of @self.
    /// ## `renderer`
    /// the [`CellRenderer`][crate::CellRenderer] to add
    /// ## `expand`
    /// whether @renderer should receive extra space when the area receives
    /// more than its natural size
    /// ## `align`
    /// whether @renderer should be aligned in adjacent rows
    /// ## `fixed`
    /// whether @renderer should have the same size in all rows
    #[doc(alias = "gtk_cell_area_box_pack_end")]
    pub fn pack_end(
        &self,
        renderer: &impl IsA<CellRenderer>,
        expand: bool,
        align: bool,
        fixed: bool,
    ) {
        unsafe {
            ffi::gtk_cell_area_box_pack_end(
                self.to_glib_none().0,
                renderer.as_ref().to_glib_none().0,
                expand.into_glib(),
                align.into_glib(),
                fixed.into_glib(),
            );
        }
    }

    /// Adds @renderer to @self, packed with reference to the start of @self.
    ///
    /// The @renderer is packed after any other [`CellRenderer`][crate::CellRenderer] packed
    /// with reference to the start of @self.
    /// ## `renderer`
    /// the [`CellRenderer`][crate::CellRenderer] to add
    /// ## `expand`
    /// whether @renderer should receive extra space when the area receives
    /// more than its natural size
    /// ## `align`
    /// whether @renderer should be aligned in adjacent rows
    /// ## `fixed`
    /// whether @renderer should have the same size in all rows
    #[doc(alias = "gtk_cell_area_box_pack_start")]
    pub fn pack_start(
        &self,
        renderer: &impl IsA<CellRenderer>,
        expand: bool,
        align: bool,
        fixed: bool,
    ) {
        unsafe {
            ffi::gtk_cell_area_box_pack_start(
                self.to_glib_none().0,
                renderer.as_ref().to_glib_none().0,
                expand.into_glib(),
                align.into_glib(),
                fixed.into_glib(),
            );
        }
    }

    /// Sets the spacing to add between cell renderers in @self.
    /// ## `spacing`
    /// the space to add between [`CellRenderer`][crate::CellRenderer]s
    #[doc(alias = "gtk_cell_area_box_set_spacing")]
    pub fn set_spacing(&self, spacing: i32) {
        unsafe {
            ffi::gtk_cell_area_box_set_spacing(self.to_glib_none().0, spacing);
        }
    }

    #[doc(alias = "spacing")]
    pub fn connect_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_spacing_trampoline<F: Fn(&CellAreaBox) + 'static>(
            this: *mut ffi::GtkCellAreaBox,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::spacing\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_spacing_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for CellAreaBox {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`CellAreaBox`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct CellAreaBoxBuilder {
    spacing: Option<i32>,
    focus_cell: Option<CellRenderer>,
    orientation: Option<Orientation>,
}

impl CellAreaBoxBuilder {
    // rustdoc-stripper-ignore-next
    /// Create a new [`CellAreaBoxBuilder`].
    pub fn new() -> Self {
        Self::default()
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`CellAreaBox`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> CellAreaBox {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        if let Some(ref spacing) = self.spacing {
            properties.push(("spacing", spacing));
        }
        if let Some(ref focus_cell) = self.focus_cell {
            properties.push(("focus-cell", focus_cell));
        }
        if let Some(ref orientation) = self.orientation {
            properties.push(("orientation", orientation));
        }
        glib::Object::new::<CellAreaBox>(&properties)
            .expect("Failed to create an instance of CellAreaBox")
    }

    /// The amount of space to reserve between cells.
    pub fn spacing(mut self, spacing: i32) -> Self {
        self.spacing = Some(spacing);
        self
    }

    /// The cell in the area that currently has focus
    pub fn focus_cell(mut self, focus_cell: &impl IsA<CellRenderer>) -> Self {
        self.focus_cell = Some(focus_cell.clone().upcast());
        self
    }

    /// The orientation of the orientable.
    pub fn orientation(mut self, orientation: Orientation) -> Self {
        self.orientation = Some(orientation);
        self
    }
}

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