gtk4/auto/filter_list_model.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
// 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 crate::{ffi, Filter};
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! {
/// [`FilterListModel`][crate::FilterListModel] is a list model that filters the elements of
/// the underlying model according to a [`Filter`][crate::Filter].
///
/// It hides some elements from the other model according to
/// criteria given by a [`Filter`][crate::Filter].
///
/// The model can be set up to do incremental filtering, so that
/// filtering long lists doesn't block the UI. See
/// [`set_incremental()`][Self::set_incremental()] for details.
///
/// [`FilterListModel`][crate::FilterListModel] passes through sections from the underlying model.
///
/// ## Properties
///
///
/// #### `filter`
/// The filter for this model.
///
/// Readable | Writeable
///
///
/// #### `incremental`
/// If the model should filter items incrementally.
///
/// Readable | Writeable
///
///
/// #### `item-type`
/// The type of items. See [`ListModelExtManual::item_type()`][crate::gio::prelude::ListModelExtManual::item_type()].
///
/// Readable
///
///
/// #### `model`
/// The model being filtered.
///
/// Readable | Writeable
///
///
/// #### `n-items`
/// The number of items. See [`ListModelExtManual::n_items()`][crate::gio::prelude::ListModelExtManual::n_items()].
///
/// Readable
///
///
/// #### `pending`
/// Number of items not yet filtered.
///
/// Readable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`], [`SectionModelExt`][trait@crate::prelude::SectionModelExt]
#[doc(alias = "GtkFilterListModel")]
pub struct FilterListModel(Object<ffi::GtkFilterListModel, ffi::GtkFilterListModelClass>) @implements gio::ListModel, SectionModel;
match fn {
type_ => || ffi::gtk_filter_list_model_get_type(),
}
}
#[cfg(not(any(feature = "v4_12")))]
glib::wrapper! {
#[doc(alias = "GtkFilterListModel")]
pub struct FilterListModel(Object<ffi::GtkFilterListModel, ffi::GtkFilterListModelClass>) @implements gio::ListModel;
match fn {
type_ => || ffi::gtk_filter_list_model_get_type(),
}
}
impl FilterListModel {
/// Creates a new [`FilterListModel`][crate::FilterListModel] that will filter @model using the given
/// @filter.
/// ## `model`
/// the model to sort
/// ## `filter`
/// filter
///
/// # Returns
///
/// a new [`FilterListModel`][crate::FilterListModel]
#[doc(alias = "gtk_filter_list_model_new")]
pub fn new(
model: Option<impl IsA<gio::ListModel>>,
filter: Option<impl IsA<Filter>>,
) -> FilterListModel {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_filter_list_model_new(
model.map(|p| p.upcast()).into_glib_ptr(),
filter.map(|p| p.upcast()).into_glib_ptr(),
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`FilterListModel`] objects.
///
/// This method returns an instance of [`FilterListModelBuilder`](crate::builders::FilterListModelBuilder) which can be used to create [`FilterListModel`] objects.
pub fn builder() -> FilterListModelBuilder {
FilterListModelBuilder::new()
}
/// Gets the [`Filter`][crate::Filter] currently set on @self.
///
/// # Returns
///
/// The filter currently in use
#[doc(alias = "gtk_filter_list_model_get_filter")]
#[doc(alias = "get_filter")]
pub fn filter(&self) -> Option<Filter> {
unsafe { from_glib_none(ffi::gtk_filter_list_model_get_filter(self.to_glib_none().0)) }
}
/// Returns whether incremental filtering is enabled.
///
/// See [`set_incremental()`][Self::set_incremental()].
///
/// # Returns
///
/// [`true`] if incremental filtering is enabled
#[doc(alias = "gtk_filter_list_model_get_incremental")]
#[doc(alias = "get_incremental")]
#[doc(alias = "incremental")]
pub fn is_incremental(&self) -> bool {
unsafe {
from_glib(ffi::gtk_filter_list_model_get_incremental(
self.to_glib_none().0,
))
}
}
/// Gets the model currently filtered or [`None`] if none.
///
/// # Returns
///
/// The model that gets filtered
#[doc(alias = "gtk_filter_list_model_get_model")]
#[doc(alias = "get_model")]
pub fn model(&self) -> Option<gio::ListModel> {
unsafe { from_glib_none(ffi::gtk_filter_list_model_get_model(self.to_glib_none().0)) }
}
/// Returns the number of items that have not been filtered yet.
///
/// You can use this value to check if @self is busy filtering by
/// comparing the return value to 0 or you can compute the percentage
/// of the filter remaining by dividing the return value by the total
/// number of items in the underlying model:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// pending = gtk_filter_list_model_get_pending (self);
/// model = gtk_filter_list_model_get_model (self);
/// percentage = pending / (double) g_list_model_get_n_items (model);
/// ```
///
/// If no filter operation is ongoing - in particular when
/// [`incremental`][struct@crate::FilterListModel#incremental] is [`false`] - this
/// function returns 0.
///
/// # Returns
///
/// The number of items not yet filtered
#[doc(alias = "gtk_filter_list_model_get_pending")]
#[doc(alias = "get_pending")]
pub fn pending(&self) -> u32 {
unsafe { ffi::gtk_filter_list_model_get_pending(self.to_glib_none().0) }
}
/// Sets the filter used to filter items.
/// ## `filter`
/// filter to use
#[doc(alias = "gtk_filter_list_model_set_filter")]
#[doc(alias = "filter")]
pub fn set_filter(&self, filter: Option<&impl IsA<Filter>>) {
unsafe {
ffi::gtk_filter_list_model_set_filter(
self.to_glib_none().0,
filter.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the filter model to do an incremental sort.
///
/// When incremental filtering is enabled, the [`FilterListModel`][crate::FilterListModel] will not
/// run filters immediately, but will instead queue an idle handler that
/// incrementally filters the items and adds them to the list. This of course
/// means that items are not instantly added to the list, but only appear
/// incrementally.
///
/// When your filter blocks the UI while filtering, you might consider
/// turning this on. Depending on your model and filters, this may become
/// interesting around 10,000 to 100,000 items.
///
/// By default, incremental filtering is disabled.
///
/// See [`pending()`][Self::pending()] for progress information
/// about an ongoing incremental filtering operation.
/// ## `incremental`
/// [`true`] to enable incremental filtering
#[doc(alias = "gtk_filter_list_model_set_incremental")]
#[doc(alias = "incremental")]
pub fn set_incremental(&self, incremental: bool) {
unsafe {
ffi::gtk_filter_list_model_set_incremental(
self.to_glib_none().0,
incremental.into_glib(),
);
}
}
/// Sets the model to be filtered.
///
/// Note that GTK makes no effort to ensure that @model conforms to
/// the item type of @self. It assumes that the caller knows what they
/// are doing and have set up an appropriate filter to ensure that item
/// types match.
/// ## `model`
/// The model to be filtered
#[doc(alias = "gtk_filter_list_model_set_model")]
#[doc(alias = "model")]
pub fn set_model(&self, model: Option<&impl IsA<gio::ListModel>>) {
unsafe {
ffi::gtk_filter_list_model_set_model(
self.to_glib_none().0,
model.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
#[doc(alias = "filter")]
pub fn connect_filter_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_filter_trampoline<F: Fn(&FilterListModel) + 'static>(
this: *mut ffi::GtkFilterListModel,
_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::filter\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_filter_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "incremental")]
pub fn connect_incremental_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_incremental_trampoline<F: Fn(&FilterListModel) + 'static>(
this: *mut ffi::GtkFilterListModel,
_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::incremental\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_incremental_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[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(&FilterListModel) + 'static>(
this: *mut ffi::GtkFilterListModel,
_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::<*const (), unsafe extern "C" fn()>(
notify_model_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "pending")]
pub fn connect_pending_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_pending_trampoline<F: Fn(&FilterListModel) + 'static>(
this: *mut ffi::GtkFilterListModel,
_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::pending\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_pending_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for FilterListModel {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`FilterListModel`] 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 FilterListModelBuilder {
builder: glib::object::ObjectBuilder<'static, FilterListModel>,
}
impl FilterListModelBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The filter for this model.
pub fn filter(self, filter: &impl IsA<Filter>) -> Self {
Self {
builder: self.builder.property("filter", filter.clone().upcast()),
}
}
/// If the model should filter items incrementally.
pub fn incremental(self, incremental: bool) -> Self {
Self {
builder: self.builder.property("incremental", incremental),
}
}
/// The model being filtered.
pub fn model(self, model: &impl IsA<gio::ListModel>) -> Self {
Self {
builder: self.builder.property("model", model.clone().upcast()),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`FilterListModel`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> FilterListModel {
self.builder.build()
}
}