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
// 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::TreeDragSource;
use crate::TreeIter;
use crate::TreeModel;
use crate::TreePath;
use crate::TreeSortable;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;
glib::wrapper! {
/// The [`TreeModelSort`][crate::TreeModelSort] is a model which implements the [`TreeSortable`][crate::TreeSortable]
/// interface. It does not hold any data itself, but rather is created with
/// a child model and proxies its data. It has identical column types to
/// this child model, and the changes in the child are propagated. The
/// primary purpose of this model is to provide a way to sort a different
/// model without modifying it. Note that the sort function used by
/// [`TreeModelSort`][crate::TreeModelSort] is not guaranteed to be stable.
///
/// The use of this is best demonstrated through an example. In the
/// following sample code we create two [`TreeView`][crate::TreeView] widgets each with a
/// view of the same data. As the model is wrapped here by a
/// [`TreeModelSort`][crate::TreeModelSort], the two `GtkTreeViews` can each sort their
/// view of the data without affecting the other. By contrast, if we
/// simply put the same model in each widget, then sorting the first would
/// sort the second.
///
/// ## Using a [`TreeModelSort`][crate::TreeModelSort]
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// {
/// GtkTreeView *tree_view1;
/// GtkTreeView *tree_view2;
/// GtkTreeModel *sort_model1;
/// GtkTreeModel *sort_model2;
/// GtkTreeModel *child_model;
///
/// // get the child model
/// child_model = get_my_model ();
///
/// // Create the first tree
/// sort_model1 = gtk_tree_model_sort_new_with_model (child_model);
/// tree_view1 = gtk_tree_view_new_with_model (sort_model1);
///
/// // Create the second tree
/// sort_model2 = gtk_tree_model_sort_new_with_model (child_model);
/// tree_view2 = gtk_tree_view_new_with_model (sort_model2);
///
/// // Now we can sort the two models independently
/// gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1),
/// COLUMN_1, GTK_SORT_ASCENDING);
/// gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2),
/// COLUMN_1, GTK_SORT_DESCENDING);
/// }
/// ```
///
/// To demonstrate how to access the underlying child model from the sort
/// model, the next example will be a callback for the [`TreeSelection`][crate::TreeSelection]
/// `signal::TreeSelection::changed` signal. In this callback, we get a string
/// from COLUMN_1 of the model. We then modify the string, find the same
/// selected row on the child model, and change the row there.
///
/// ## Accessing the child model of in a selection changed callback
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// void
/// selection_changed (GtkTreeSelection *selection, gpointer data)
/// {
/// GtkTreeModel *sort_model = NULL;
/// GtkTreeModel *child_model;
/// GtkTreeIter sort_iter;
/// GtkTreeIter child_iter;
/// char *some_data = NULL;
/// char *modified_data;
///
/// // Get the current selected row and the model.
/// if (! gtk_tree_selection_get_selected (selection,
/// &sort_model,
/// &sort_iter))
/// return;
///
/// // Look up the current value on the selected row and get
/// // a new value to change it to.
/// gtk_tree_model_get (GTK_TREE_MODEL (sort_model), &sort_iter,
/// COLUMN_1, &some_data,
/// -1);
///
/// modified_data = change_the_data (some_data);
/// g_free (some_data);
///
/// // Get an iterator on the child model, instead of the sort model.
/// gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model),
/// &child_iter,
/// &sort_iter);
///
/// // Get the child model and change the value of the row. In this
/// // example, the child model is a GtkListStore. It could be any other
/// // type of model, though.
/// child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model));
/// gtk_list_store_set (GTK_LIST_STORE (child_model), &child_iter,
/// COLUMN_1, &modified_data,
/// -1);
/// g_free (modified_data);
/// }
/// ```
///
/// # Implements
///
/// [`TreeModelSortExt`][trait@crate::prelude::TreeModelSortExt], [`trait@glib::ObjectExt`], [`TreeDragSourceExt`][trait@crate::prelude::TreeDragSourceExt], [`TreeModelExt`][trait@crate::prelude::TreeModelExt], [`TreeSortableExt`][trait@crate::prelude::TreeSortableExt], [`TreeSortableExtManual`][trait@crate::prelude::TreeSortableExtManual]
#[doc(alias = "GtkTreeModelSort")]
pub struct TreeModelSort(Object<ffi::GtkTreeModelSort, ffi::GtkTreeModelSortClass>) @implements TreeDragSource, TreeModel, TreeSortable;
match fn {
type_ => || ffi::gtk_tree_model_sort_get_type(),
}
}
impl TreeModelSort {
pub const NONE: Option<&'static TreeModelSort> = None;
/// Creates a new [`TreeModelSort`][crate::TreeModelSort], with `child_model` as the child model.
/// ## `child_model`
/// A [`TreeModel`][crate::TreeModel]
///
/// # Returns
///
/// A new [`TreeModelSort`][crate::TreeModelSort].
#[doc(alias = "gtk_tree_model_sort_new_with_model")]
#[doc(alias = "new_with_model")]
pub fn new(child_model: &impl IsA<TreeModel>) -> TreeModelSort {
skip_assert_initialized!();
unsafe {
from_glib_full(ffi::gtk_tree_model_sort_new_with_model(
child_model.as_ref().to_glib_none().0,
))
}
}
}
/// Trait containing all [`struct@TreeModelSort`] methods.
///
/// # Implementors
///
/// [`TreeModelSort`][struct@crate::TreeModelSort]
pub trait TreeModelSortExt: 'static {
/// This function should almost never be called. It clears the `self`
/// of any cached iterators that haven’t been reffed with
/// `gtk_tree_model_ref_node()`. This might be useful if the child model being
/// sorted is static (and doesn’t change often) and there has been a lot of
/// unreffed access to nodes. As a side effect of this function, all unreffed
/// iters will be invalid.
#[doc(alias = "gtk_tree_model_sort_clear_cache")]
fn clear_cache(&self);
/// Sets `sort_iter` to point to the row in `self` that corresponds to
/// the row pointed at by `child_iter`. If `sort_iter` was not set, [`false`]
/// is returned. Note: a boolean is only returned since 2.14.
/// ## `child_iter`
/// A valid [`TreeIter`][crate::TreeIter] pointing to a row on the child model
///
/// # Returns
///
/// [`true`], if `sort_iter` was set, i.e. if `sort_iter` is a
/// valid iterator pointer to a visible row in the child model.
///
/// ## `sort_iter`
/// An uninitialized [`TreeIter`][crate::TreeIter].
#[doc(alias = "gtk_tree_model_sort_convert_child_iter_to_iter")]
fn convert_child_iter_to_iter(&self, child_iter: &TreeIter) -> Option<TreeIter>;
/// Converts `child_path` to a path relative to `self`. That is,
/// `child_path` points to a path in the child model. The returned path will
/// point to the same row in the sorted model. If `child_path` isn’t a valid
/// path on the child model, then [`None`] is returned.
/// ## `child_path`
/// A [`TreePath`][crate::TreePath] to convert
///
/// # Returns
///
/// A newly allocated [`TreePath`][crate::TreePath], or [`None`]
#[doc(alias = "gtk_tree_model_sort_convert_child_path_to_path")]
fn convert_child_path_to_path(&self, child_path: &TreePath) -> Option<TreePath>;
/// Sets `child_iter` to point to the row pointed to by `sorted_iter`.
/// ## `sorted_iter`
/// A valid [`TreeIter`][crate::TreeIter] pointing to a row on `self`.
///
/// # Returns
///
///
/// ## `child_iter`
/// An uninitialized [`TreeIter`][crate::TreeIter]
#[doc(alias = "gtk_tree_model_sort_convert_iter_to_child_iter")]
fn convert_iter_to_child_iter(&self, sorted_iter: &TreeIter) -> TreeIter;
/// Converts `sorted_path` to a path on the child model of `self`.
/// That is, `sorted_path` points to a location in `self`. The
/// returned path will point to the same location in the model not being
/// sorted. If `sorted_path` does not point to a location in the child model,
/// [`None`] is returned.
/// ## `sorted_path`
/// A [`TreePath`][crate::TreePath] to convert
///
/// # Returns
///
/// A newly allocated [`TreePath`][crate::TreePath], or [`None`]
#[doc(alias = "gtk_tree_model_sort_convert_path_to_child_path")]
fn convert_path_to_child_path(&self, sorted_path: &TreePath) -> Option<TreePath>;
/// Returns the model the [`TreeModelSort`][crate::TreeModelSort] is sorting.
///
/// # Returns
///
/// the "child model" being sorted
#[doc(alias = "gtk_tree_model_sort_get_model")]
#[doc(alias = "get_model")]
fn model(&self) -> TreeModel;
/// > This function is slow. Only use it for debugging and/or testing
/// > purposes.
///
/// Checks if the given iter is a valid iter for this [`TreeModelSort`][crate::TreeModelSort].
/// ## `iter`
/// A [`TreeIter`][crate::TreeIter].
///
/// # Returns
///
/// [`true`] if the iter is valid, [`false`] if the iter is invalid.
#[doc(alias = "gtk_tree_model_sort_iter_is_valid")]
fn iter_is_valid(&self, iter: &TreeIter) -> bool;
/// This resets the default sort function to be in the “unsorted” state. That
/// is, it is in the same order as the child model. It will re-sort the model
/// to be in the same order as the child model only if the [`TreeModelSort`][crate::TreeModelSort]
/// is in “unsorted” state.
#[doc(alias = "gtk_tree_model_sort_reset_default_sort_func")]
fn reset_default_sort_func(&self);
}
impl<O: IsA<TreeModelSort>> TreeModelSortExt for O {
fn clear_cache(&self) {
unsafe {
ffi::gtk_tree_model_sort_clear_cache(self.as_ref().to_glib_none().0);
}
}
fn convert_child_iter_to_iter(&self, child_iter: &TreeIter) -> Option<TreeIter> {
unsafe {
let mut sort_iter = TreeIter::uninitialized();
let ret = from_glib(ffi::gtk_tree_model_sort_convert_child_iter_to_iter(
self.as_ref().to_glib_none().0,
sort_iter.to_glib_none_mut().0,
mut_override(child_iter.to_glib_none().0),
));
if ret {
Some(sort_iter)
} else {
None
}
}
}
fn convert_child_path_to_path(&self, child_path: &TreePath) -> Option<TreePath> {
unsafe {
from_glib_full(ffi::gtk_tree_model_sort_convert_child_path_to_path(
self.as_ref().to_glib_none().0,
mut_override(child_path.to_glib_none().0),
))
}
}
fn convert_iter_to_child_iter(&self, sorted_iter: &TreeIter) -> TreeIter {
unsafe {
let mut child_iter = TreeIter::uninitialized();
ffi::gtk_tree_model_sort_convert_iter_to_child_iter(
self.as_ref().to_glib_none().0,
child_iter.to_glib_none_mut().0,
mut_override(sorted_iter.to_glib_none().0),
);
child_iter
}
}
fn convert_path_to_child_path(&self, sorted_path: &TreePath) -> Option<TreePath> {
unsafe {
from_glib_full(ffi::gtk_tree_model_sort_convert_path_to_child_path(
self.as_ref().to_glib_none().0,
mut_override(sorted_path.to_glib_none().0),
))
}
}
fn model(&self) -> TreeModel {
unsafe {
from_glib_none(ffi::gtk_tree_model_sort_get_model(
self.as_ref().to_glib_none().0,
))
}
}
fn iter_is_valid(&self, iter: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_tree_model_sort_iter_is_valid(
self.as_ref().to_glib_none().0,
mut_override(iter.to_glib_none().0),
))
}
}
fn reset_default_sort_func(&self) {
unsafe {
ffi::gtk_tree_model_sort_reset_default_sort_func(self.as_ref().to_glib_none().0);
}
}
}
impl fmt::Display for TreeModelSort {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("TreeModelSort")
}
}