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 449
// 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::{Buildable, TreeDragDest, TreeDragSource, TreeIter, TreeModel, TreeSortable};
use glib::translate::*;
use std::fmt;
glib::wrapper! {
/// Use `Gio::ListStore` instead
/// A list-like data structure that can be used with the [`TreeView`][crate::TreeView].
///
/// The [`ListStore`][crate::ListStore] object is a list model for use with a [`TreeView`][crate::TreeView]
/// widget. It implements the [`TreeModel`][crate::TreeModel] interface, and consequentialy,
/// 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](iface.TreeDragSource.html) and [drop](iface.TreeDragDest.html)
/// interfaces.
///
/// The [`ListStore`][crate::ListStore] can accept most `GType`s as a column type, though
/// it can’t accept all custom types. Internally, it will keep a copy of
/// data passed in (such as a string or a boxed pointer). Columns that
/// accept `GObject`s are handled a little differently. The
/// [`ListStore`][crate::ListStore] will keep a reference to the object instead of copying the
/// value. As a result, if the object is modified, it is up to the
/// application writer to call [`TreeModelExt::row_changed()`][crate::prelude::TreeModelExt::row_changed()] to emit the
/// [`row_changed`][struct@crate::TreeModel#row_changed] signal. This most commonly affects lists
/// with [`gdk::Texture`][crate::gdk::Texture]s stored.
///
/// An example for creating a simple list store:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// enum {
/// COLUMN_STRING,
/// COLUMN_INT,
/// COLUMN_BOOLEAN,
/// N_COLUMNS
/// };
///
/// {
/// GtkListStore *list_store;
/// GtkTreePath *path;
/// GtkTreeIter iter;
/// int i;
///
/// list_store = gtk_list_store_new (N_COLUMNS,
/// G_TYPE_STRING,
/// G_TYPE_INT,
/// G_TYPE_BOOLEAN);
///
/// for (i = 0; i < 10; i++)
/// {
/// char *some_data;
///
/// some_data = get_some_data (i);
///
/// // Add a new row to the model
/// gtk_list_store_append (list_store, &iter);
/// gtk_list_store_set (list_store, &iter,
/// COLUMN_STRING, some_data,
/// COLUMN_INT, i,
/// COLUMN_BOOLEAN, FALSE,
/// -1);
///
/// // As the store will keep a copy of the string internally,
/// // we free some_data.
/// g_free (some_data);
/// }
///
/// // Modify a particular row
/// path = gtk_tree_path_new_from_string ("4");
/// gtk_tree_model_get_iter (GTK_TREE_MODEL (list_store),
/// &iter,
/// path);
/// gtk_tree_path_free (path);
/// gtk_list_store_set (list_store, &iter,
/// COLUMN_BOOLEAN, TRUE,
/// -1);
/// }
/// ```
///
/// [`ListStore`][crate::ListStore] is deprecated since GTK 4.10, and should not be used in newly
/// written code. You should use `Gio::ListStore` instead, and the various
/// list models provided by GTK.
///
/// ## Performance Considerations
///
/// Internally, the [`ListStore`][crate::ListStore] was originally implemented with a linked list
/// with a tail pointer. As a result, it was fast at data insertion and deletion,
/// and not fast at random data access. The [`ListStore`][crate::ListStore] sets the
/// `GTK_TREE_MODEL_ITERS_PERSIST` flag, which means that [`TreeIter`][crate::TreeIter]s can be
/// cached while the row exists. Thus, if access to a particular row is needed
/// often and your code is expected to run on older versions of GTK, it is worth
/// keeping the iter around.
///
/// ## Atomic Operations
///
/// It is important to note that only the methods
/// gtk_list_store_insert_with_values() and gtk_list_store_insert_with_valuesv()
/// are atomic, in the sense that the row is being appended to the store and the
/// values filled in in a single operation with regard to [`TreeModel`][crate::TreeModel] signaling.
/// In contrast, using e.g. gtk_list_store_append() and then gtk_list_store_set()
/// will first create a row, which triggers the `GtkTreeModel::row-inserted` signal
/// on [`ListStore`][crate::ListStore]. The row, however, is still empty, and any signal handler
/// connecting to `GtkTreeModel::row-inserted` on this particular store should be prepared
/// for the situation that the row might be empty. This is especially important
/// if you are wrapping the [`ListStore`][crate::ListStore] inside a [`TreeModel`][crate::TreeModel]Filter and are
/// using a [`TreeModel`][crate::TreeModel]FilterVisibleFunc. Using any of the non-atomic operations
/// to append rows to the [`ListStore`][crate::ListStore] will cause the
/// [`TreeModel`][crate::TreeModel]FilterVisibleFunc to be visited with an empty row first; the
/// function must be prepared for that.
///
/// ## GtkListStore as GtkBuildable
///
/// The GtkListStore 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.
///
/// Additionally, it is possible to specify content for the list store
/// in the UI definition, with the `<data>` element. It can contain multiple
/// `<row>` elements, each specifying to content for one row of the list model.
/// Inside a `<row>`, the `<col>` elements specify the content for individual cells.
///
/// Note that it is probably more common to define your models in the code,
/// and one might consider it a layering violation to specify the content of
/// a list store in a UI definition, data, not presentation, and common wisdom
/// is to separate the two, as far as possible.
///
/// An example of a UI Definition fragment for a list store:
///
/// ```xml
/// <object class="GtkListStore">
/// <columns>
/// <column type="gchararray"/>
/// <column type="gchararray"/>
/// <column type="gint"/>
/// </columns>
/// <data>
/// <row>
/// <col id="0">John</col>
/// <col id="1">Doe</col>
/// <col id="2">25</col>
/// </row>
/// <row>
/// <col id="0">Johan</col>
/// <col id="1">Dahlin</col>
/// <col id="2">50</col>
/// </row>
/// </data>
/// </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 = "GtkListStore")]
pub struct ListStore(Object<ffi::GtkListStore, ffi::GtkListStoreClass>) @implements Buildable, TreeDragDest, TreeDragSource, TreeModel, TreeSortable;
match fn {
type_ => || ffi::gtk_list_store_get_type(),
}
}
impl ListStore {
/// Appends a new row to @self. @iter 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_list_store_set() or gtk_list_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use list models
///
/// # 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_list_store_append")]
pub fn append(&self) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_list_store_append(self.to_glib_none().0, iter.to_glib_none_mut().0);
iter
}
}
/// Removes all rows from the list store.
///
/// # Deprecated since 4.10
///
/// Use list models
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_clear")]
pub fn clear(&self) {
unsafe {
ffi::gtk_list_store_clear(self.to_glib_none().0);
}
}
/// Creates a new row at @position. @iter will be changed to point to this new
/// row. If @position is -1 or is larger than the number of rows on the list,
/// then the new row will be appended to the list. The row will be empty after
/// this function is called. To fill in values, you need to call
/// gtk_list_store_set() or gtk_list_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `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_list_store_insert")]
pub fn insert(&self, position: i32) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_list_store_insert(self.to_glib_none().0, iter.to_glib_none_mut().0, position);
iter
}
}
/// Inserts a new row after @sibling. If @sibling is [`None`], then the row will be
/// prepended to the beginning of the list. @iter 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_list_store_set() or gtk_list_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `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_list_store_insert_after")]
pub fn insert_after(&self, sibling: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_list_store_insert_after(
self.to_glib_none().0,
iter.to_glib_none_mut().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 the end of the list. @iter 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_list_store_set() or gtk_list_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `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_list_store_insert_before")]
pub fn insert_before(&self, sibling: Option<&TreeIter>) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_list_store_insert_before(
self.to_glib_none().0,
iter.to_glib_none_mut().0,
mut_override(sibling.to_glib_none().0),
);
iter
}
}
/// Checks if the given iter is a valid iter for this [`ListStore`][crate::ListStore].
///
/// This function is slow. Only use it for debugging and/or testing
/// purposes.
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `iter`
/// the iterator to check
///
/// # Returns
///
/// [`true`] if the iter is valid, [`false`] if the iter is invalid.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_iter_is_valid")]
pub fn iter_is_valid(&self, iter: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_list_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. Note that this
/// function only works with unsorted stores. If @position is [`None`], @iter
/// will be moved to the start of the list.
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `iter`
/// A [`TreeIter`][crate::TreeIter]
/// ## `position`
/// A [`TreeIter`][crate::TreeIter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_move_after")]
pub fn move_after(&self, iter: &TreeIter, position: Option<&TreeIter>) {
unsafe {
ffi::gtk_list_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. Note that this
/// function only works with unsorted stores. If @position is [`None`], @iter
/// will be moved to the end of the list.
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `iter`
/// A [`TreeIter`][crate::TreeIter]
/// ## `position`
/// A [`TreeIter`][crate::TreeIter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_move_before")]
pub fn move_before(&self, iter: &TreeIter, position: Option<&TreeIter>) {
unsafe {
ffi::gtk_list_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. @iter 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_list_store_set() or gtk_list_store_set_value().
///
/// # Deprecated since 4.10
///
/// Use list models
///
/// # Returns
///
///
/// ## `iter`
/// An unset [`TreeIter`][crate::TreeIter] to set to the prepend row
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_prepend")]
pub fn prepend(&self) -> TreeIter {
unsafe {
let mut iter = TreeIter::uninitialized();
ffi::gtk_list_store_prepend(self.to_glib_none().0, iter.to_glib_none_mut().0);
iter
}
}
/// Removes the given row from the list store. After being removed,
/// @iter is set to be the next valid row, or invalidated if it pointed
/// to the last row in @self.
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `iter`
/// A valid [`TreeIter`][crate::TreeIter]
///
/// # Returns
///
/// [`true`] if @iter is valid, [`false`] if not.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_remove")]
pub fn remove(&self, iter: &TreeIter) -> bool {
unsafe {
from_glib(ffi::gtk_list_store_remove(
self.to_glib_none().0,
mut_override(iter.to_glib_none().0),
))
}
}
/// Swaps @a and @b in @self. Note that this function only works with
/// unsorted stores.
///
/// # Deprecated since 4.10
///
/// Use list models
/// ## `a`
/// A [`TreeIter`][crate::TreeIter]
/// ## `b`
/// Another [`TreeIter`][crate::TreeIter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_list_store_swap")]
pub fn swap(&self, a: &TreeIter, b: &TreeIter) {
unsafe {
ffi::gtk_list_store_swap(
self.to_glib_none().0,
mut_override(a.to_glib_none().0),
mut_override(b.to_glib_none().0),
);
}
}
}
impl fmt::Display for ListStore {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("ListStore")
}
}