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
// 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
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
use crate::SectionModel;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
glib::wrapper! {
/// [`SliceListModel`][crate::SliceListModel] is a list model that presents a slice of another model.
///
/// This is useful when implementing paging by setting the size to the number
/// of elements per page and updating the offset whenever a different page is
/// opened.
///
/// [`SliceListModel`][crate::SliceListModel] passes through sections from the underlying model.
///
/// ## Properties
///
///
/// #### `item-type`
/// The type of items. See [`ListModelExtManual::item_type()`][crate::gio::prelude::ListModelExtManual::item_type()].
///
/// Readable
///
///
/// #### `model`
/// Child model to take slice from.
///
/// Readable | Writeable
///
///
/// #### `n-items`
/// The number of items. See [`ListModelExtManual::n_items()`][crate::gio::prelude::ListModelExtManual::n_items()].
///
/// Readable
///
///
/// #### `offset`
/// Offset of slice.
///
/// Readable | Writeable
///
///
/// #### `size`
/// Maximum size of slice.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`], [`SectionModelExt`][trait@crate::prelude::SectionModelExt]
#[doc(alias = "GtkSliceListModel")]
pub struct SliceListModel(Object<ffi::GtkSliceListModel, ffi::GtkSliceListModelClass>) @implements gio::ListModel, SectionModel;
match fn {
type_ => || ffi::gtk_slice_list_model_get_type(),
}
}
#[cfg(not(any(feature = "v4_12")))]
glib::wrapper! {
#[doc(alias = "GtkSliceListModel")]
pub struct SliceListModel(Object<ffi::GtkSliceListModel, ffi::GtkSliceListModelClass>) @implements gio::ListModel;
match fn {
type_ => || ffi::gtk_slice_list_model_get_type(),
}
}
impl SliceListModel {
/// Creates a new slice model.
///
/// It presents the slice from @offset to offset + @size
/// of the given @model.
/// ## `model`
/// The model to use
/// ## `offset`
/// the offset of the slice
/// ## `size`
/// maximum size of the slice
///
/// # Returns
///
/// A new [`SliceListModel`][crate::SliceListModel]
#[doc(alias = "gtk_slice_list_model_new")]
pub fn new(model: Option<impl IsA<gio::ListModel>>, offset: u32, size: u32) -> SliceListModel {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_slice_list_model_new(
model.map(|p| p.upcast()).into_glib_ptr(),
offset,
size,
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`SliceListModel`] objects.
///
/// This method returns an instance of [`SliceListModelBuilder`](crate::builders::SliceListModelBuilder) which can be used to create [`SliceListModel`] objects.
pub fn builder() -> SliceListModelBuilder {
SliceListModelBuilder::new()
}
/// Gets the model that is currently being used or [`None`] if none.
///
/// # Returns
///
/// The model in use
#[doc(alias = "gtk_slice_list_model_get_model")]
#[doc(alias = "get_model")]
pub fn model(&self) -> Option<gio::ListModel> {
unsafe { from_glib_none(ffi::gtk_slice_list_model_get_model(self.to_glib_none().0)) }
}
/// Gets the offset set via gtk_slice_list_model_set_offset().
///
/// # Returns
///
/// The offset
#[doc(alias = "gtk_slice_list_model_get_offset")]
#[doc(alias = "get_offset")]
pub fn offset(&self) -> u32 {
unsafe { ffi::gtk_slice_list_model_get_offset(self.to_glib_none().0) }
}
/// Gets the size set via gtk_slice_list_model_set_size().
///
/// # Returns
///
/// The size
#[doc(alias = "gtk_slice_list_model_get_size")]
#[doc(alias = "get_size")]
pub fn size(&self) -> u32 {
unsafe { ffi::gtk_slice_list_model_get_size(self.to_glib_none().0) }
}
/// Sets the model to show a slice of.
///
/// The model's item type must conform to @self's item type.
/// ## `model`
/// The model to be sliced
#[doc(alias = "gtk_slice_list_model_set_model")]
pub fn set_model(&self, model: Option<&impl IsA<gio::ListModel>>) {
unsafe {
ffi::gtk_slice_list_model_set_model(
self.to_glib_none().0,
model.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the offset into the original model for this slice.
///
/// If the offset is too large for the sliced model,
/// @self will end up empty.
/// ## `offset`
/// the new offset to use
#[doc(alias = "gtk_slice_list_model_set_offset")]
pub fn set_offset(&self, offset: u32) {
unsafe {
ffi::gtk_slice_list_model_set_offset(self.to_glib_none().0, offset);
}
}
/// Sets the maximum size. @self will never have more items
/// than @size.
///
/// It can however have fewer items if the offset is too large
/// or the model sliced from doesn't have enough items.
/// ## `size`
/// the maximum size
#[doc(alias = "gtk_slice_list_model_set_size")]
pub fn set_size(&self, size: u32) {
unsafe {
ffi::gtk_slice_list_model_set_size(self.to_glib_none().0, size);
}
}
#[doc(alias = "model")]
pub fn connect_model_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_model_trampoline<F: Fn(&SliceListModel) + 'static>(
this: *mut ffi::GtkSliceListModel,
_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::model\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_model_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "offset")]
pub fn connect_offset_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_offset_trampoline<F: Fn(&SliceListModel) + 'static>(
this: *mut ffi::GtkSliceListModel,
_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::offset\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_offset_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "size")]
pub fn connect_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_size_trampoline<F: Fn(&SliceListModel) + 'static>(
this: *mut ffi::GtkSliceListModel,
_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::size\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_size_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for SliceListModel {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`SliceListModel`] 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 SliceListModelBuilder {
builder: glib::object::ObjectBuilder<'static, SliceListModel>,
}
impl SliceListModelBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Child model to take slice from.
pub fn model(self, model: &impl IsA<gio::ListModel>) -> Self {
Self {
builder: self.builder.property("model", model.clone().upcast()),
}
}
/// Offset of slice.
pub fn offset(self, offset: u32) -> Self {
Self {
builder: self.builder.property("offset", offset),
}
}
/// Maximum size of slice.
pub fn size(self, size: u32) -> Self {
Self {
builder: self.builder.property("size", size),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`SliceListModel`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> SliceListModel {
self.builder.build()
}
}