gtk4/auto/grid_layout.rs
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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
// 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::{ffi, BaselinePosition, LayoutManager};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// [`GridLayout`][crate::GridLayout] is a layout manager which arranges child widgets in
/// rows and columns.
///
/// Children have an "attach point" defined by the horizontal and vertical
/// index of the cell they occupy; children can span multiple rows or columns.
/// The layout properties for setting the attach points and spans are set
/// using the [`GridLayoutChild`][crate::GridLayoutChild] associated to each child widget.
///
/// The behaviour of [`GridLayout`][crate::GridLayout] when several children occupy the same
/// grid cell is undefined.
///
/// [`GridLayout`][crate::GridLayout] can be used like a [`BoxLayout`][crate::BoxLayout] if all children are
/// attached to the same row or column; however, if you only ever need a
/// single row or column, you should consider using [`BoxLayout`][crate::BoxLayout].
///
/// ## Properties
///
///
/// #### `baseline-row`
/// The row to align to the baseline, when `GtkWidget:valign` is set
/// to [`Align::Baseline`][crate::Align::Baseline].
///
/// Readable | Writeable
///
///
/// #### `column-homogeneous`
/// Whether all the columns in the grid have the same width.
///
/// Readable | Writeable
///
///
/// #### `column-spacing`
/// The amount of space between to consecutive columns.
///
/// Readable | Writeable
///
///
/// #### `row-homogeneous`
/// Whether all the rows in the grid have the same height.
///
/// Readable | Writeable
///
///
/// #### `row-spacing`
/// The amount of space between to consecutive rows.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`LayoutManagerExt`][trait@crate::prelude::LayoutManagerExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkGridLayout")]
pub struct GridLayout(Object<ffi::GtkGridLayout, ffi::GtkGridLayoutClass>) @extends LayoutManager;
match fn {
type_ => || ffi::gtk_grid_layout_get_type(),
}
}
impl GridLayout {
/// Creates a new [`GridLayout`][crate::GridLayout].
///
/// # Returns
///
/// the newly created [`GridLayout`][crate::GridLayout]
#[doc(alias = "gtk_grid_layout_new")]
pub fn new() -> GridLayout {
assert_initialized_main_thread!();
unsafe { LayoutManager::from_glib_full(ffi::gtk_grid_layout_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`GridLayout`] objects.
///
/// This method returns an instance of [`GridLayoutBuilder`](crate::builders::GridLayoutBuilder) which can be used to create [`GridLayout`] objects.
pub fn builder() -> GridLayoutBuilder {
GridLayoutBuilder::new()
}
/// Retrieves the row set with gtk_grid_layout_set_baseline_row().
///
/// # Returns
///
/// the global baseline row
#[doc(alias = "gtk_grid_layout_get_baseline_row")]
#[doc(alias = "get_baseline_row")]
#[doc(alias = "baseline-row")]
pub fn baseline_row(&self) -> i32 {
unsafe { ffi::gtk_grid_layout_get_baseline_row(self.to_glib_none().0) }
}
/// Checks whether all columns of @self should have the same width.
///
/// # Returns
///
/// [`true`] if the columns are homogeneous, and [`false`] otherwise
#[doc(alias = "gtk_grid_layout_get_column_homogeneous")]
#[doc(alias = "get_column_homogeneous")]
#[doc(alias = "column-homogeneous")]
pub fn is_column_homogeneous(&self) -> bool {
unsafe {
from_glib(ffi::gtk_grid_layout_get_column_homogeneous(
self.to_glib_none().0,
))
}
}
/// Retrieves the spacing set with gtk_grid_layout_set_column_spacing().
///
/// # Returns
///
/// the spacing between consecutive columns
#[doc(alias = "gtk_grid_layout_get_column_spacing")]
#[doc(alias = "get_column_spacing")]
#[doc(alias = "column-spacing")]
pub fn column_spacing(&self) -> u32 {
unsafe { ffi::gtk_grid_layout_get_column_spacing(self.to_glib_none().0) }
}
/// Returns the baseline position of @row.
///
/// If no value has been set with
/// [`set_row_baseline_position()`][Self::set_row_baseline_position()],
/// the default value of [`BaselinePosition::Center`][crate::BaselinePosition::Center]
/// is returned.
/// ## `row`
/// a row index
///
/// # Returns
///
/// the baseline position of @row
#[doc(alias = "gtk_grid_layout_get_row_baseline_position")]
#[doc(alias = "get_row_baseline_position")]
pub fn row_baseline_position(&self, row: i32) -> BaselinePosition {
unsafe {
from_glib(ffi::gtk_grid_layout_get_row_baseline_position(
self.to_glib_none().0,
row,
))
}
}
/// Checks whether all rows of @self should have the same height.
///
/// # Returns
///
/// [`true`] if the rows are homogeneous, and [`false`] otherwise
#[doc(alias = "gtk_grid_layout_get_row_homogeneous")]
#[doc(alias = "get_row_homogeneous")]
#[doc(alias = "row-homogeneous")]
pub fn is_row_homogeneous(&self) -> bool {
unsafe {
from_glib(ffi::gtk_grid_layout_get_row_homogeneous(
self.to_glib_none().0,
))
}
}
/// Retrieves the spacing set with gtk_grid_layout_set_row_spacing().
///
/// # Returns
///
/// the spacing between consecutive rows
#[doc(alias = "gtk_grid_layout_get_row_spacing")]
#[doc(alias = "get_row_spacing")]
#[doc(alias = "row-spacing")]
pub fn row_spacing(&self) -> u32 {
unsafe { ffi::gtk_grid_layout_get_row_spacing(self.to_glib_none().0) }
}
/// Sets which row defines the global baseline for the entire grid.
///
/// Each row in the grid can have its own local baseline, but only
/// one of those is global, meaning it will be the baseline in the
/// parent of the @self.
/// ## `row`
/// the row index
#[doc(alias = "gtk_grid_layout_set_baseline_row")]
#[doc(alias = "baseline-row")]
pub fn set_baseline_row(&self, row: i32) {
unsafe {
ffi::gtk_grid_layout_set_baseline_row(self.to_glib_none().0, row);
}
}
/// Sets whether all columns of @self should have the same width.
/// ## `homogeneous`
/// [`true`] to make columns homogeneous
#[doc(alias = "gtk_grid_layout_set_column_homogeneous")]
#[doc(alias = "column-homogeneous")]
pub fn set_column_homogeneous(&self, homogeneous: bool) {
unsafe {
ffi::gtk_grid_layout_set_column_homogeneous(
self.to_glib_none().0,
homogeneous.into_glib(),
);
}
}
/// Sets the amount of space to insert between consecutive columns.
/// ## `spacing`
/// the amount of space between columns, in pixels
#[doc(alias = "gtk_grid_layout_set_column_spacing")]
#[doc(alias = "column-spacing")]
pub fn set_column_spacing(&self, spacing: u32) {
unsafe {
ffi::gtk_grid_layout_set_column_spacing(self.to_glib_none().0, spacing);
}
}
/// Sets how the baseline should be positioned on @row of the
/// grid, in case that row is assigned more space than is requested.
/// ## `row`
/// a row index
/// ## `pos`
/// a [`BaselinePosition`][crate::BaselinePosition]
#[doc(alias = "gtk_grid_layout_set_row_baseline_position")]
pub fn set_row_baseline_position(&self, row: i32, pos: BaselinePosition) {
unsafe {
ffi::gtk_grid_layout_set_row_baseline_position(
self.to_glib_none().0,
row,
pos.into_glib(),
);
}
}
/// Sets whether all rows of @self should have the same height.
/// ## `homogeneous`
/// [`true`] to make rows homogeneous
#[doc(alias = "gtk_grid_layout_set_row_homogeneous")]
#[doc(alias = "row-homogeneous")]
pub fn set_row_homogeneous(&self, homogeneous: bool) {
unsafe {
ffi::gtk_grid_layout_set_row_homogeneous(
self.to_glib_none().0,
homogeneous.into_glib(),
);
}
}
/// Sets the amount of space to insert between consecutive rows.
/// ## `spacing`
/// the amount of space between rows, in pixels
#[doc(alias = "gtk_grid_layout_set_row_spacing")]
#[doc(alias = "row-spacing")]
pub fn set_row_spacing(&self, spacing: u32) {
unsafe {
ffi::gtk_grid_layout_set_row_spacing(self.to_glib_none().0, spacing);
}
}
#[doc(alias = "baseline-row")]
pub fn connect_baseline_row_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_baseline_row_trampoline<F: Fn(&GridLayout) + 'static>(
this: *mut ffi::GtkGridLayout,
_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::baseline-row\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_baseline_row_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "column-homogeneous")]
pub fn connect_column_homogeneous_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_column_homogeneous_trampoline<F: Fn(&GridLayout) + 'static>(
this: *mut ffi::GtkGridLayout,
_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::column-homogeneous\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_column_homogeneous_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "column-spacing")]
pub fn connect_column_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_column_spacing_trampoline<F: Fn(&GridLayout) + 'static>(
this: *mut ffi::GtkGridLayout,
_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::column-spacing\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_column_spacing_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "row-homogeneous")]
pub fn connect_row_homogeneous_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_row_homogeneous_trampoline<F: Fn(&GridLayout) + 'static>(
this: *mut ffi::GtkGridLayout,
_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::row-homogeneous\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_row_homogeneous_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "row-spacing")]
pub fn connect_row_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_row_spacing_trampoline<F: Fn(&GridLayout) + 'static>(
this: *mut ffi::GtkGridLayout,
_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::row-spacing\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_row_spacing_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for GridLayout {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`GridLayout`] 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 GridLayoutBuilder {
builder: glib::object::ObjectBuilder<'static, GridLayout>,
}
impl GridLayoutBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The row to align to the baseline, when `GtkWidget:valign` is set
/// to [`Align::Baseline`][crate::Align::Baseline].
pub fn baseline_row(self, baseline_row: i32) -> Self {
Self {
builder: self.builder.property("baseline-row", baseline_row),
}
}
/// Whether all the columns in the grid have the same width.
pub fn column_homogeneous(self, column_homogeneous: bool) -> Self {
Self {
builder: self
.builder
.property("column-homogeneous", column_homogeneous),
}
}
/// The amount of space between to consecutive columns.
pub fn column_spacing(self, column_spacing: i32) -> Self {
Self {
builder: self.builder.property("column-spacing", column_spacing),
}
}
/// Whether all the rows in the grid have the same height.
pub fn row_homogeneous(self, row_homogeneous: bool) -> Self {
Self {
builder: self.builder.property("row-homogeneous", row_homogeneous),
}
}
/// The amount of space between to consecutive rows.
pub fn row_spacing(self, row_spacing: i32) -> Self {
Self {
builder: self.builder.property("row-spacing", row_spacing),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`GridLayout`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> GridLayout {
assert_initialized_main_thread!();
self.builder.build()
}
}