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
// 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::TreeListRow;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// [`TreeListModel`][crate::TreeListModel] is a list model that can create child models on demand.
///
/// ## Properties
///
///
/// #### `autoexpand`
/// If all rows should be expanded by default.
///
/// Readable | Writeable
///
///
/// #### `item-type`
/// The type of items. See [`ListModelExtManual::item_type()`][crate::gio::prelude::ListModelExtManual::item_type()].
///
/// Readable
///
///
/// #### `model`
/// The root model displayed.
///
/// Readable
///
///
/// #### `n-items`
/// The number of items. See [`ListModelExtManual::n_items()`][crate::gio::prelude::ListModelExtManual::n_items()].
///
/// Readable
///
///
/// #### `passthrough`
/// Gets whether the model is in passthrough mode.
///
/// If [`false`], the `GListModel` functions for this object return custom
/// [`TreeListRow`][crate::TreeListRow] objects. If [`true`], the values of the child
/// models are pass through unmodified.
///
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`]
#[doc(alias = "GtkTreeListModel")]
pub struct TreeListModel(Object<ffi::GtkTreeListModel, ffi::GtkTreeListModelClass>) @implements gio::ListModel;
match fn {
type_ => || ffi::gtk_tree_list_model_get_type(),
}
}
impl TreeListModel {
/// Creates a new empty [`TreeListModel`][crate::TreeListModel] displaying @root
/// with all rows collapsed.
/// ## `root`
/// The `GListModel` to use as root
/// ## `passthrough`
/// [`true`] to pass through items from the models
/// ## `autoexpand`
/// [`true`] to set the autoexpand property and expand the @root model
/// ## `create_func`
/// Function to call to create the `GListModel` for the children
/// of an item
///
/// # Returns
///
/// a newly created [`TreeListModel`][crate::TreeListModel].
#[doc(alias = "gtk_tree_list_model_new")]
pub fn new<P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static>(
root: impl IsA<gio::ListModel>,
passthrough: bool,
autoexpand: bool,
create_func: P,
) -> TreeListModel {
assert_initialized_main_thread!();
let create_func_data: Box_<P> = Box_::new(create_func);
unsafe extern "C" fn create_func_func<
P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static,
>(
item: *mut glib::gobject_ffi::GObject,
user_data: glib::ffi::gpointer,
) -> *mut gio::ffi::GListModel {
let item = from_glib_borrow(item);
let callback = &*(user_data as *mut P);
(*callback)(&item).to_glib_full()
}
let create_func = Some(create_func_func::<P> as _);
unsafe extern "C" fn user_destroy_func<
P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static,
>(
data: glib::ffi::gpointer,
) {
let _callback = Box_::from_raw(data as *mut P);
}
let destroy_call5 = Some(user_destroy_func::<P> as _);
let super_callback0: Box_<P> = create_func_data;
unsafe {
from_glib_full(ffi::gtk_tree_list_model_new(
root.upcast().into_glib_ptr(),
passthrough.into_glib(),
autoexpand.into_glib(),
create_func,
Box_::into_raw(super_callback0) as *mut _,
destroy_call5,
))
}
}
/// Gets whether the model is set to automatically expand new rows
/// that get added.
///
/// This can be either rows added by changes to the underlying
/// models or via [`TreeListRow::set_expanded()`][crate::TreeListRow::set_expanded()].
///
/// # Returns
///
/// [`true`] if the model is set to autoexpand
#[doc(alias = "gtk_tree_list_model_get_autoexpand")]
#[doc(alias = "get_autoexpand")]
pub fn is_autoexpand(&self) -> bool {
unsafe {
from_glib(ffi::gtk_tree_list_model_get_autoexpand(
self.to_glib_none().0,
))
}
}
/// Gets the row item corresponding to the child at index @position for
/// @self's root model.
///
/// If @position is greater than the number of children in the root model,
/// [`None`] is returned.
///
/// Do not confuse this function with [`row()`][Self::row()].
/// ## `position`
/// position of the child to get
///
/// # Returns
///
/// the child in @position
#[doc(alias = "gtk_tree_list_model_get_child_row")]
#[doc(alias = "get_child_row")]
pub fn child_row(&self, position: u32) -> Option<TreeListRow> {
unsafe {
from_glib_full(ffi::gtk_tree_list_model_get_child_row(
self.to_glib_none().0,
position,
))
}
}
/// Gets the root model that @self was created with.
///
/// # Returns
///
/// the root model
#[doc(alias = "gtk_tree_list_model_get_model")]
#[doc(alias = "get_model")]
pub fn model(&self) -> gio::ListModel {
unsafe { from_glib_none(ffi::gtk_tree_list_model_get_model(self.to_glib_none().0)) }
}
/// Gets whether the model is passing through original row items.
///
/// If this function returns [`false`], the `GListModel` functions for @self
/// return custom [`TreeListRow`][crate::TreeListRow] objects. You need to call
/// [`TreeListRow::item()`][crate::TreeListRow::item()] on these objects to get the original
/// item.
///
/// If [`true`], the values of the child models are passed through in their
/// original state. You then need to call [`row()`][Self::row()]
/// to get the custom [`TreeListRow`][crate::TreeListRow]s.
///
/// # Returns
///
/// [`true`] if the model is passing through original row items
#[doc(alias = "gtk_tree_list_model_get_passthrough")]
#[doc(alias = "get_passthrough")]
pub fn is_passthrough(&self) -> bool {
unsafe {
from_glib(ffi::gtk_tree_list_model_get_passthrough(
self.to_glib_none().0,
))
}
}
/// Gets the row object for the given row.
///
/// If @position is greater than the number of items in @self,
/// [`None`] is returned.
///
/// The row object can be used to expand and collapse rows as
/// well as to inspect its position in the tree. See its
/// documentation for details.
///
/// This row object is persistent and will refer to the current
/// item as long as the row is present in @self, independent of
/// other rows being added or removed.
///
/// If @self is set to not be passthrough, this function is
/// equivalent to calling g_list_model_get_item().
///
/// Do not confuse this function with [`child_row()`][Self::child_row()].
/// ## `position`
/// the position of the row to fetch
///
/// # Returns
///
/// The row item
#[doc(alias = "gtk_tree_list_model_get_row")]
#[doc(alias = "get_row")]
pub fn row(&self, position: u32) -> Option<TreeListRow> {
unsafe {
from_glib_full(ffi::gtk_tree_list_model_get_row(
self.to_glib_none().0,
position,
))
}
}
/// Sets whether the model should autoexpand.
///
/// If set to [`true`], the model will recursively expand all rows that
/// get added to the model. This can be either rows added by changes
/// to the underlying models or via [`TreeListRow::set_expanded()`][crate::TreeListRow::set_expanded()].
/// ## `autoexpand`
/// [`true`] to make the model autoexpand its rows
#[doc(alias = "gtk_tree_list_model_set_autoexpand")]
pub fn set_autoexpand(&self, autoexpand: bool) {
unsafe {
ffi::gtk_tree_list_model_set_autoexpand(self.to_glib_none().0, autoexpand.into_glib());
}
}
#[doc(alias = "autoexpand")]
pub fn connect_autoexpand_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_autoexpand_trampoline<F: Fn(&TreeListModel) + 'static>(
this: *mut ffi::GtkTreeListModel,
_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::autoexpand\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_autoexpand_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(&TreeListModel) + 'static>(
this: *mut ffi::GtkTreeListModel,
_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),
)
}
}
}