1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
// 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
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::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! {
/// 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 `GtkCellRenderers` rendered in adjacent rows can be
/// configured by configuring the [`CellAreaBox`][crate::CellAreaBox] align child cell property
/// with [`CellAreaExt::cell_set_property()`][crate::prelude::CellAreaExt::cell_set_property()] or by specifying the "align"
/// argument to [`CellAreaBoxExt::pack_start()`][crate::prelude::CellAreaBoxExt::pack_start()] and [`CellAreaBoxExt::pack_end()`][crate::prelude::CellAreaBoxExt::pack_end()].
///
/// # Implements
///
/// [`CellAreaBoxExt`][trait@crate::prelude::CellAreaBoxExt], [`CellAreaExt`][trait@crate::prelude::CellAreaExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`CellLayoutExt`][trait@crate::prelude::CellLayoutExt], [`OrientableExt`][trait@crate::prelude::OrientableExt], [`BuildableExtManual`][trait@crate::prelude::BuildableExtManual]
#[doc(alias = "GtkCellAreaBox")]
pub struct CellAreaBox(Object<ffi::GtkCellAreaBox, ffi::GtkCellAreaBoxClass>) @extends CellArea, @implements Buildable, CellLayout, Orientable;
match fn {
type_ => || ffi::gtk_cell_area_box_get_type(),
}
}
impl CellAreaBox {
pub const NONE: Option<&'static CellAreaBox> = None;
/// 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()
}
}
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
}
}
/// Trait containing all [`struct@CellAreaBox`] methods.
///
/// # Implementors
///
/// [`CellAreaBox`][struct@crate::CellAreaBox]
pub trait CellAreaBoxExt: 'static {
/// 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")]
fn spacing(&self) -> i32;
/// 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")]
fn pack_end(&self, renderer: &impl IsA<CellRenderer>, expand: bool, align: bool, fixed: bool);
/// 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")]
fn pack_start(&self, renderer: &impl IsA<CellRenderer>, expand: bool, align: bool, fixed: bool);
/// Sets the spacing to add between cell renderers in `self`.
/// ## `spacing`
/// the space to add between `GtkCellRenderers`
#[doc(alias = "gtk_cell_area_box_set_spacing")]
fn set_spacing(&self, spacing: i32);
#[doc(alias = "spacing")]
fn connect_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<CellAreaBox>> CellAreaBoxExt for O {
fn spacing(&self) -> i32 {
unsafe { ffi::gtk_cell_area_box_get_spacing(self.as_ref().to_glib_none().0) }
}
fn pack_end(&self, renderer: &impl IsA<CellRenderer>, expand: bool, align: bool, fixed: bool) {
unsafe {
ffi::gtk_cell_area_box_pack_end(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
expand.into_glib(),
align.into_glib(),
fixed.into_glib(),
);
}
}
fn pack_start(
&self,
renderer: &impl IsA<CellRenderer>,
expand: bool,
align: bool,
fixed: bool,
) {
unsafe {
ffi::gtk_cell_area_box_pack_start(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
expand.into_glib(),
align.into_glib(),
fixed.into_glib(),
);
}
}
fn set_spacing(&self, spacing: i32) {
unsafe {
ffi::gtk_cell_area_box_set_spacing(self.as_ref().to_glib_none().0, spacing);
}
}
fn connect_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_spacing_trampoline<P: IsA<CellAreaBox>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkCellAreaBox,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(CellAreaBox::from_glib_borrow(this).unsafe_cast_ref())
}
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::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for CellAreaBox {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("CellAreaBox")
}
}