gtk4/auto/

list_store.rs

// 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 `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),
            );
        }
    }
}