gtk4/auto/

cell_area_box.rs

// 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
#![allow(deprecated)]

use crate::{ffi, Buildable, CellArea, CellLayout, CellRenderer, Orientable, Orientation};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// List views use widgets for displaying their
    ///   contents
    /// 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().
    ///
    /// ## Properties
    ///
    ///
    /// #### `spacing`
    ///  The amount of space to reserve between cells.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>CellArea</h4></summary>
    ///
    ///
    /// #### `edit-widget`
    ///  The widget currently editing the edited cell
    ///
    /// This property is read-only and only changes as
    /// a result of a call gtk_cell_area_activate_cell().
    ///
    /// Readable
    ///
    ///
    /// #### `edited-cell`
    ///  The cell in the area that is currently edited
    ///
    /// This property is read-only and only changes as
    /// a result of a call gtk_cell_area_activate_cell().
    ///
    /// Readable
    ///
    ///
    /// #### `focus-cell`
    ///  The cell in the area that currently has focus
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>Orientable</h4></summary>
    ///
    ///
    /// #### `orientation`
    ///  The orientation of the orientable.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # 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].
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// a newly created [`CellAreaBox`][crate::CellAreaBox]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[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::new()
    }

    /// Gets the spacing added between cell renderers.
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// the space added between cell renderers in @self.
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[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.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[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.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[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.
    ///
    /// # Deprecated since 4.10
    ///
    /// ## `spacing`
    /// the space to add between [`CellRenderer`][crate::CellRenderer]s
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_cell_area_box_set_spacing")]
    #[doc(alias = "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(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_spacing_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

// 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 {
    builder: glib::object::ObjectBuilder<'static, CellAreaBox>,
}

impl CellAreaBoxBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The amount of space to reserve between cells.
    pub fn spacing(self, spacing: i32) -> Self {
        Self {
            builder: self.builder.property("spacing", spacing),
        }
    }

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

    /// The orientation of the orientable.
    pub fn orientation(self, orientation: Orientation) -> Self {
        Self {
            builder: self.builder.property("orientation", orientation),
        }
    }

    // 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 {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}