gtk4/auto/tree_store.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
// 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
#![allow(deprecated)]
use crate::{ffi, Buildable, TreeDragDest, TreeDragSource, TreeIter, TreeModel, TreeSortable};
use glib::translate::*;
glib::wrapper! {
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// A tree-like data structure that can be used with the [`TreeView`][crate::TreeView].
///
/// The [`TreeStore`][crate::TreeStore] object is a list model for use with a [`TreeView`][crate::TreeView]
/// widget. It implements the [`TreeModel`][crate::TreeModel] interface, and consequently,
/// can use all of the methods available there. It also implements the
/// [`TreeSortable`][crate::TreeSortable] interface so it can be sorted by the view.
/// Finally, it also implements the tree [drag][`TreeDragSource`][crate::TreeDragSource]
/// and [drop][`TreeDragDest`][crate::TreeDragDest] interfaces.
///
/// [`TreeStore`][crate::TreeStore] is deprecated since GTK 4.10, and should not be used in newly
/// written code. You should use [`TreeListModel`][crate::TreeListModel] for a tree-like model
/// object.
///
/// ## GtkTreeStore as GtkBuildable
///
/// The GtkTreeStore implementation of the [`Buildable`][crate::Buildable] interface allows
/// to specify the model columns with a `<columns>` element that may contain
/// multiple `<column>` elements, each specifying one model column. The “type”
/// attribute specifies the data type for the column.
///
/// An example of a UI Definition fragment for a tree store:
///
/// ```xml
/// <object class="GtkTreeStore">
/// <columns>
/// <column type="gchararray"/>
/// <column type="gchararray"/>
/// <column type="gint"/>
/// </columns>
/// </object>
/// ```
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`TreeDragDestExt`][trait@crate::prelude::TreeDragDestExt], [`TreeDragSourceExt`][trait@crate::prelude::TreeDragSourceExt], [`TreeModelExt`][trait@crate::prelude::TreeModelExt], [`TreeSortableExt`][trait@crate::prelude::TreeSortableExt], [`TreeModelExtManual`][trait@crate::prelude::TreeModelExtManual], [`TreeSortableExtManual`][trait@crate::prelude::TreeSortableExtManual]
#[doc(alias = "GtkTreeStore")]
pub struct TreeStore(Object<ffi::GtkTreeStore, ffi::GtkTreeStoreClass>) @implements Buildable, TreeDragDest, TreeDragSource, TreeModel, TreeSortable;
match fn {
type_ => || ffi::gtk_tree_store_get_type(),
}
}
impl TreeStore {
/// Appends a new row to @self.
///
/// If @parent is non-[`None`], then it will append the new row after the last
/// child of @parent, otherwise it will append a row to the top level.
///
/// The @iter parameter will be changed to point to this new row. The row will
/// be empty after this function is called. To fill in values, you need to call
/// gtk_tree_store_set() or gtk_tree_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `parent`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the appended row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_append")]
pub fn append(&self, parent: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_tree_store_append(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(parent.to_glib_none().0),
);
iter
}
}
/// Removes all rows from @self
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_clear")]
pub fn clear(&self) {
unsafe {
ffi::gtk_tree_store_clear(self.to_glib_none().0);
}
}
/// Creates a new row at @position.
///
/// If parent is non-[`None`], then the row will be made a child of @parent.
/// Otherwise, the row will be created at the toplevel.
///
/// If @position is `-1` or is larger than the number of rows at that level,
/// then the new row will be inserted to the end of the list.
///
/// The @iter parameter will be changed to point to this new row. The row
/// will be empty after this function is called. To fill in values, you
/// need to call gtk_tree_store_set() or gtk_tree_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `parent`
/// A valid [`TreeIter`][crate::TreeIter]
/// ## `position`
/// position to insert the new row, or -1 for last
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the new row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_insert")]
pub fn insert(&self, parent: Option<&TreeIter>, position: i32) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_tree_store_insert(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(parent.to_glib_none().0),
position,
);
iter
}
}
/// Inserts a new row after @sibling.
///
/// If @sibling is [`None`], then the row will be prepended to @parent’s children.
///
/// If @parent and @sibling are [`None`], then the row will be prepended to the
/// toplevel.
///
/// If both @sibling and @parent are set, then @parent must be the parent
/// of @sibling. When @sibling is set, @parent is optional.
///
/// The @iter parameter will be changed to point to this new row. The row will
/// be empty after this function is called. To fill in values, you need to call
/// gtk_tree_store_set() or gtk_tree_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `parent`
/// A valid [`TreeIter`][crate::TreeIter]
/// ## `sibling`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the new row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_insert_after")]
pub fn insert_after(&self, parent: Option<&TreeIter>, sibling: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_tree_store_insert_after(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(parent.to_glib_none().0),
mut_override(sibling.to_glib_none().0),
);
iter
}
}
/// Inserts a new row before @sibling.
///
/// If @sibling is [`None`], then the row will be appended to @parent’s children.
///
/// If @parent and @sibling are [`None`], then the row will be appended to the
/// toplevel.
///
/// If both @sibling and @parent are set, then @parent must be the parent
/// of @sibling. When @sibling is set, @parent is optional.
///
/// The @iter parameter will be changed to point to this new row. The row will
/// be empty after this function is called. To fill in values, you need to call
/// gtk_tree_store_set() or gtk_tree_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `parent`
/// A valid [`TreeIter`][crate::TreeIter]
/// ## `sibling`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the new row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_insert_before")]
pub fn insert_before(&self, parent: Option<&TreeIter>, sibling: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_tree_store_insert_before(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(parent.to_glib_none().0),
mut_override(sibling.to_glib_none().0),
);
iter
}
}
/// Checks if @iter is an ancestor of @descendant.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// A valid [`TreeIter`][crate::TreeIter]
/// ## `descendant`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
/// true if @iter is an ancestor of @descendant, and false otherwise
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_is_ancestor")]
pub fn is_ancestor(&self, iter: &TreeIter, descendant: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_tree_store_is_ancestor(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
mut_override(descendant.to_glib_none().0),
))
}
}
/// Returns the depth of the position pointed by the iterator
///
/// The depth will be 0 for anything on the root level, 1 for anything down
/// a level, etc.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
/// The depth of the position pointed by the iterator
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_iter_depth")]
pub fn iter_depth(&self, iter: &TreeIter) -> i32 {
unsafe {
ffi::gtk_tree_store_iter_depth(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
)
}
}
/// Checks if the given iter is a valid iter for this [`TreeStore`][crate::TreeStore].
///
/// This function is slow. Only use it for debugging and/or testing
/// purposes.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// the iterator to check
///
/// # Returns
///
/// true if the iter is valid, and false otherwise
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_iter_is_valid")]
pub fn iter_is_valid(&self, iter: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_tree_store_iter_is_valid(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
))
}
}
/// Moves @iter in @self to the position after @position.
///
/// @iter and @position should be in the same level.
///
/// Note that this function only works with unsorted stores.
///
/// If @position is [`None`], @iter will be moved to the start of the level.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// A [`TreeIter`][crate::TreeIter].
/// ## `position`
/// A [`TreeIter`][crate::TreeIter].
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_move_after")]
pub fn move_after(&self, iter: &TreeIter, position: Option<&TreeIter>) {
unsafe {
ffi::gtk_tree_store_move_after(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
mut_override(position.to_glib_none().0),
);
}
}
/// Moves @iter in @self to the position before @position.
///
/// @iter and @position should be in the same level.
///
/// Note that this function only works with unsorted stores.
///
/// If @position is [`None`], @iter will be moved to the end of the level.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// A [`TreeIter`][crate::TreeIter]
/// ## `position`
/// A [`TreeIter`][crate::TreeIter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_move_before")]
pub fn move_before(&self, iter: &TreeIter, position: Option<&TreeIter>) {
unsafe {
ffi::gtk_tree_store_move_before(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
mut_override(position.to_glib_none().0),
);
}
}
/// Prepends a new row to @self.
///
/// If @parent is non-[`None`], then it will prepend the new row before the first
/// child of @parent, otherwise it will prepend a row to the top level. The
/// `iter` parameter will be changed to point to this new row. The row will
/// be empty after this function is called. To fill in values, you need to
/// call gtk_tree_store_set() or gtk_tree_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `parent`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the prepended row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_prepend")]
pub fn prepend(&self, parent: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_tree_store_prepend(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(parent.to_glib_none().0),
);
iter
}
}
/// Removes @iter from @self.
///
/// After being removed, @iter is set to the next valid row at that level, or
/// invalidated if it previously pointed to the last one.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `iter`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
/// true if @iter is still valid, and false otherwise
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_remove")]
pub fn remove(&self, iter: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_tree_store_remove(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
))
}
}
/// Swaps @a and @b in the same level of @self.
///
/// Note that this function only works with unsorted stores.
///
/// # Deprecated since 4.10
///
/// Use [`TreeListModel`][crate::TreeListModel] instead
/// ## `a`
/// A [`TreeIter`][crate::TreeIter].
/// ## `b`
/// Another [`TreeIter`][crate::TreeIter].
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_tree_store_swap")]
pub fn swap(&self, a: &TreeIter, b: &TreeIter) {
unsafe {
ffi::gtk_tree_store_swap(
self.to_glib_none().0,
mut_override(a.to_glib_none().0),
mut_override(b.to_glib_none().0),
);
}
}
}