gtk4/
tree_model.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use glib::{translate::*, value::FromValue};
4
5use crate::{TreeIter, TreeModel, ffi, prelude::*};
6
7// rustdoc-stripper-ignore-next
8/// Trait containing manually implemented methods of
9/// [`TreeModel`](crate::TreeModel).
10#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
11#[allow(deprecated)]
12pub trait TreeModelExtManual: IsA<TreeModel> + 'static {
13    #[doc(alias = "gtk_tree_model_get")]
14    #[doc(alias = "gtk_tree_model_get_value")]
15    #[doc(alias = "gtk_tree_model_get_valist")]
16    fn get_value(&self, iter: &TreeIter, column: i32) -> glib::Value {
17        let total_columns = self.as_ref().n_columns();
18        assert!(
19            column < total_columns,
20            "TreeModel has {total_columns} columns but TreeModelExt::get got {column} passed as a column number",
21        );
22        unsafe {
23            let mut value = glib::Value::uninitialized();
24            ffi::gtk_tree_model_get_value(
25                self.as_ref().to_glib_none().0,
26                mut_override(iter.to_glib_none().0),
27                column,
28                value.to_glib_none_mut().0,
29            );
30            value
31        }
32    }
33
34    #[doc(alias = "gtk_tree_model_get")]
35    #[doc(alias = "gtk_tree_model_get_value")]
36    #[doc(alias = "gtk_tree_model_get_valist")]
37    // rustdoc-stripper-ignore-next
38    /// Similar to [`Self::get_value`] but panics if the value is of a different
39    /// type.
40    // rustdoc-stripper-ignore-next-stop
41    /// place_string_here, -1)`,
42    /// where `place_string_here` is a #gchararray
43    /// to be filled with the string.
44    ///
45    /// Returned values with type `G_TYPE_OBJECT` have to be unreferenced,
46    /// values with type `G_TYPE_STRING` or `G_TYPE_BOXED` have to be freed.
47    /// Other values are passed by value.
48    ///
49    /// # Deprecated since 4.10
50    ///
51    /// ## `iter`
52    /// a row in @self
53    fn get<V: for<'b> FromValue<'b> + 'static>(&self, iter: &TreeIter, column: i32) -> V {
54        let value = self.get_value(iter, column);
55        value
56            .get_owned::<V>()
57            .expect("Failed to get TreeModel value")
58    }
59
60    // rustdoc-stripper-ignore-next
61    /// Manual implementation of iter_next that takes a mutable TreeIter.
62    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
63    #[allow(deprecated)]
64    #[doc(alias = "gtk_tree_model_iter_next")]
65    fn iter_next(&self, iter: &mut TreeIter) -> bool {
66        unsafe {
67            from_glib(ffi::gtk_tree_model_iter_next(
68                self.as_ref().to_glib_none().0,
69                iter.to_glib_none_mut().0,
70            ))
71        }
72    }
73
74    // rustdoc-stripper-ignore-next
75    /// Manual implementation of iter_previous that takes a mutable TreeIter.
76    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
77    #[allow(deprecated)]
78    #[doc(alias = "gtk_tree_model_iter_previous")]
79    fn iter_previous(&self, iter: &mut TreeIter) -> bool {
80        unsafe {
81            from_glib(ffi::gtk_tree_model_iter_previous(
82                self.as_ref().to_glib_none().0,
83                mut_override(iter.to_glib_none().0),
84            ))
85        }
86    }
87}
88
89impl<O: IsA<TreeModel>> TreeModelExtManual for O {}
gtk4/tree_model.rs

gtk4/
tree_model.rs
