gtk4/auto/list_header.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
// 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, Widget};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// [`ListHeader`][crate::ListHeader] is used by list widgets to represent the headers they
/// display.
///
/// [`ListHeader`][crate::ListHeader] objects are managed just like [`ListItem`][crate::ListItem]
/// objects via their factory, but provide a different set of properties suitable
/// for managing the header instead of individual items.
///
/// ## Properties
///
///
/// #### `child`
/// Widget used for display.
///
/// Readable | Writeable
///
///
/// #### `end`
/// The first position no longer part of this section.
///
/// Readable
///
///
/// #### `item`
/// The item at the start of the section.
///
/// Readable
///
///
/// #### `n-items`
/// Number of items in this section.
///
/// Readable
///
///
/// #### `start`
/// First position of items in this section.
///
/// Readable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkListHeader")]
pub struct ListHeader(Object<ffi::GtkListHeader, ffi::GtkListHeaderClass>);
match fn {
type_ => || ffi::gtk_list_header_get_type(),
}
}
impl ListHeader {
/// Gets the child previously set via gtk_list_header_set_child() or
/// [`None`] if none was set.
///
/// # Returns
///
/// The child
#[doc(alias = "gtk_list_header_get_child")]
#[doc(alias = "get_child")]
pub fn child(&self) -> Option<Widget> {
unsafe { from_glib_none(ffi::gtk_list_header_get_child(self.to_glib_none().0)) }
}
/// Gets the end position in the model of the section that @self is
/// currently the header for.
///
/// If @self is unbound, `GTK_INVALID_LIST_POSITION` is returned.
///
/// # Returns
///
/// The end position of the section
#[doc(alias = "gtk_list_header_get_end")]
#[doc(alias = "get_end")]
pub fn end(&self) -> u32 {
unsafe { ffi::gtk_list_header_get_end(self.to_glib_none().0) }
}
/// Gets the model item at the start of the section.
/// This is the item that occupies the list model at position
/// [`start`][struct@crate::ListHeader#start].
///
/// If @self is unbound, this function returns [`None`].
///
/// # Returns
///
/// The item displayed
#[doc(alias = "gtk_list_header_get_item")]
#[doc(alias = "get_item")]
pub fn item(&self) -> Option<glib::Object> {
unsafe { from_glib_none(ffi::gtk_list_header_get_item(self.to_glib_none().0)) }
}
/// Gets the the number of items in the section.
///
/// If @self is unbound, 0 is returned.
///
/// # Returns
///
/// The number of items in the section
#[doc(alias = "gtk_list_header_get_n_items")]
#[doc(alias = "get_n_items")]
#[doc(alias = "n-items")]
pub fn n_items(&self) -> u32 {
unsafe { ffi::gtk_list_header_get_n_items(self.to_glib_none().0) }
}
/// Gets the start position in the model of the section that @self is
/// currently the header for.
///
/// If @self is unbound, `GTK_INVALID_LIST_POSITION` is returned.
///
/// # Returns
///
/// The start position of the section
#[doc(alias = "gtk_list_header_get_start")]
#[doc(alias = "get_start")]
pub fn start(&self) -> u32 {
unsafe { ffi::gtk_list_header_get_start(self.to_glib_none().0) }
}
/// Sets the child to be used for this listitem.
///
/// This function is typically called by applications when
/// setting up a header so that the widget can be reused when
/// binding it multiple times.
/// ## `child`
/// The list item's child or [`None`] to unset
#[doc(alias = "gtk_list_header_set_child")]
#[doc(alias = "child")]
pub fn set_child(&self, child: Option<&impl IsA<Widget>>) {
unsafe {
ffi::gtk_list_header_set_child(
self.to_glib_none().0,
child.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "child")]
pub fn connect_child_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_child_trampoline<F: Fn(&ListHeader) + 'static>(
this: *mut ffi::GtkListHeader,
_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::child\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_child_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "end")]
pub fn connect_end_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_end_trampoline<F: Fn(&ListHeader) + 'static>(
this: *mut ffi::GtkListHeader,
_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::end\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_end_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "item")]
pub fn connect_item_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_item_trampoline<F: Fn(&ListHeader) + 'static>(
this: *mut ffi::GtkListHeader,
_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::item\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_item_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "n-items")]
pub fn connect_n_items_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_n_items_trampoline<F: Fn(&ListHeader) + 'static>(
this: *mut ffi::GtkListHeader,
_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::n-items\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_n_items_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "start")]
pub fn connect_start_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_start_trampoline<F: Fn(&ListHeader) + 'static>(
this: *mut ffi::GtkListHeader,
_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::start\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_start_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}