:right-sidebar: True ListStore =================================================================== .. currentmodule:: gi.repository.Gtk .. deprecated:: 4.10 Use :obj:`~gi.repository.Gio.ListStore` instead .. class:: ListStore(*column_types) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.TreeDragDest`, :class:`~gi.repository.Gtk.TreeDragSource`, :class:`~gi.repository.Gtk.TreeModel`, :class:`~gi.repository.Gtk.TreeSortable` A list-like data structure that can be used with the :obj:`~gi.repository.Gtk.TreeView`. The ``GtkListStore`` object is a list model for use with a ``GtkTreeView`` widget. It implements the ``GtkTreeModel`` interface, and consequentialy, can use all of the methods available there. It also implements the ``GtkTreeSortable`` interface so it can be sorted by the view. Finally, it also implements the tree `drag `_ and `drop `_ interfaces. The ``GtkListStore`` 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 ``GtkListStore`` 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 :obj:`~gi.repository.Gtk.TreeModel.row_changed` to emit the :obj:`~gi.repository.Gtk.TreeModel.signals.row_changed` signal. This most commonly affects lists with :obj:`~gi.repository.Gdk.Texture`'s stored. An example for creating a simple list store: .. code-block:: :dedent: 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); } ``GtkListStore`` is deprecated since GTK 4.10, and should not be used in newly written code. You should use :obj:`~gi.repository.Gio.ListStore` instead, and the various list models provided by GTK. Performance Considerations -------------------------- Internally, the ``GtkListStore`` 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 ``GtkListStore`` sets the ``GTK_TREE_MODEL_ITERS_PERSIST`` flag, which means that ``GtkTreeIter``'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 :func:`~gi.repository.Gtk.ListStore.insert_with_values` and :func:`~gi.repository.Gtk.ListStore.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 ``GtkTreeModel`` signaling. In contrast, using e.g. :func:`~gi.repository.Gtk.ListStore.append` and then :func:`~gi.repository.Gtk.ListStore.set` will first create a row, which triggers the ``GtkTreeModel::row-inserted`` signal on ``GtkListStore``. 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 ``GtkListStore`` inside a ``GtkTreeModel``Filter and are using a ``GtkTreeModel``FilterVisibleFunc. Using any of the non-atomic operations to append rows to the ``GtkListStore`` will cause the ``GtkTreeModel``FilterVisibleFunc to be visited with an empty row first; the function must be prepared for that. GtkListStore as GtkBuildable ---------------------------- The GtkListStore implementation of the :obj:`~gi.repository.Gtk.Buildable` interface allows to specify the model columns with a ```` element that may contain multiple ```` 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 ```` element. It can contain multiple ```` elements, each specifying to content for one row of the list model. Inside a ````, the ```` 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: .. code-block:: :dedent: John Doe 25 Johan Dahlin 50 Constructors ------------ .. rst-class:: interim-class .. class:: ListStore :no-index: .. classmethod:: new(types: ~typing.Sequence[type]) -> ~gi.repository.Gtk.ListStore Creates a new list store. The list store will have ``n_columns`` columns, with each column using the given type passed to this function. Note that only types derived from standard GObject fundamental types are supported. As an example: .. code-block:: :dedent: gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE); will create a new ``GtkListStore`` with three columns, of type ``int``, ``gchararray`` and ``GdkTexture``, respectively. .. deprecated:: 4.10 Use :obj:`~gi.repository.Gio.ListStore` instead :param types: Methods ------- .. rst-class:: interim-class .. class:: ListStore :no-index: .. method:: append(row=None) Appends a new row to ``list_store``. ``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 :func:`~gi.repository.Gtk.ListStore.set` or :func:`~gi.repository.Gtk.ListStore.set_value`. .. deprecated:: 4.10 Use list models :param row: .. method:: clear() -> None Removes all rows from the list store. .. deprecated:: 4.10 Use list models .. method:: insert(position, row=None) 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 :func:`~gi.repository.Gtk.ListStore.set` or :func:`~gi.repository.Gtk.ListStore.set_value`. .. deprecated:: 4.10 Use list models :param position: position to insert the new row, or -1 for last :param row: .. method:: insert_after(sibling, row=None) Inserts a new row after ``sibling``. If ``sibling`` is :const:`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 :func:`~gi.repository.Gtk.ListStore.set` or :func:`~gi.repository.Gtk.ListStore.set_value`. .. deprecated:: 4.10 Use list models :param sibling: A valid ``GtkTreeIter`` :param row: .. method:: insert_before(sibling, row=None) Inserts a new row before ``sibling``. If ``sibling`` is :const:`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 :func:`~gi.repository.Gtk.ListStore.set` or :func:`~gi.repository.Gtk.ListStore.set_value`. .. deprecated:: 4.10 Use list models :param sibling: A valid ``GtkTreeIter`` :param row: .. method:: insert_with_values(position: int, columns: ~typing.Sequence[int], values: ~typing.Sequence[~typing.Any]) -> ~gi.repository.Gtk.TreeIter Creates a new row at ``position``. ``iter`` will be changed to point to this new row. If ``position`` is -1, or larger than the number of rows in the list, then the new row will be appended to the list. The row will be filled with the values given to this function. Calling `gtk_list_store_insert_with_values (list_store, iter, position...)` has the same effect as calling: .. code-block:: C :dedent: static void insert_value (GtkListStore *list_store, GtkTreeIter *iter, int position) { gtk_list_store_insert (list_store, iter, position); gtk_list_store_set (list_store, iter // ... ); } with the difference that the former will only emit ``GtkTreeModel``::row-inserted once, while the latter will emit ``GtkTreeModel``::row-inserted, ``GtkTreeModel``::row-changed and, if the list store is sorted, ``GtkTreeModel``::rows-reordered for every inserted value. Since emitting the ``GtkTreeModel::rows-reordered`` signal repeatedly can affect the performance of the program, :func:`~gi.repository.Gtk.ListStore.insert_with_values` should generally be preferred when inserting rows in a sorted list store. .. deprecated:: 4.10 Use list models :param position: position to insert the new row, or -1 to append after existing rows :param columns: :param values: .. method:: insert_with_valuesv(position: int, columns: ~typing.Sequence[int], values: ~typing.Sequence[~typing.Any]) -> ~gi.repository.Gtk.TreeIter A variant of :func:`~gi.repository.Gtk.ListStore.insert_with_values` which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings. .. deprecated:: 4.10 Use list models :param position: position to insert the new row, or -1 for last :param columns: an array of column numbers :param values: an array of GValues .. method:: iter_is_valid(iter: ~gi.repository.Gtk.TreeIter) -> bool Checks if the given iter is a valid iter for this ``GtkListStore``. This function is slow. Only use it for debugging and/or testing purposes. .. deprecated:: 4.10 Use list models :param iter: the iterator to check .. method:: move_after(iter: ~gi.repository.Gtk.TreeIter, position: ~gi.repository.Gtk.TreeIter | None = None) -> None Moves ``iter`` in ``store`` to the position after ``position``. Note that this function only works with unsorted stores. If ``position`` is :const:`None`, ``iter`` will be moved to the start of the list. .. deprecated:: 4.10 Use list models :param iter: A ``GtkTreeIter`` :param position: A ``GtkTreeIter`` .. method:: move_before(iter: ~gi.repository.Gtk.TreeIter, position: ~gi.repository.Gtk.TreeIter | None = None) -> None Moves ``iter`` in ``store`` to the position before ``position``. Note that this function only works with unsorted stores. If ``position`` is :const:`None`, ``iter`` will be moved to the end of the list. .. deprecated:: 4.10 Use list models :param iter: A ``GtkTreeIter`` :param position: A ``GtkTreeIter`` .. method:: prepend(row=None) Prepends a new row to ``list_store``. ``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 :func:`~gi.repository.Gtk.ListStore.set` or :func:`~gi.repository.Gtk.ListStore.set_value`. .. deprecated:: 4.10 Use list models :param row: .. method:: remove(iter: ~gi.repository.Gtk.TreeIter) -> bool 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 ``list_store``. .. deprecated:: 4.10 Use list models :param iter: A valid ``GtkTreeIter`` .. method:: reorder(new_order: ~typing.Sequence[int]) -> None Reorders ``store`` to follow the order indicated by ``new_order``. Note that this function only works with unsorted stores. .. deprecated:: 4.10 Use list models :param new_order: an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. ``new_order```[newpos] = oldpos`. It must have exactly as many items as the list store’s length. .. method:: set(treeiter, *args) Sets the value of one or more cells in the row referenced by ``iter``. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type :obj:`str` to “Foo”, you would write `gtk_list_store_set (store, iter, 0, "Foo", -1)`. The value will be referenced by the store if it is a :obj:`object`, and it will be copied if it is a :obj:`str` or ``Boxed``. .. deprecated:: 4.10 Use list models :param treeiter: :param args: .. method:: set_column_types(types: ~typing.Sequence[type]) -> None Sets the types of the columns of a list store. This function is meant primarily for objects that inherit from ``GtkListStore``, and should only be used when constructing a new instance. This function cannot be called after a row has been added, or a method on the ``GtkTreeModel`` interface is called. .. deprecated:: 4.10 Use list models :param types: An array length n of ``GType``'s .. method:: set_value(treeiter, column, value) Sets the data in the cell specified by ``iter`` and ``column``. The type of ``value`` must be convertible to the type of the column. .. deprecated:: 4.10 Use list models :param treeiter: :param column: column number to modify :param value: new value for the cell .. method:: swap(a: ~gi.repository.Gtk.TreeIter, b: ~gi.repository.Gtk.TreeIter) -> None Swaps ``a`` and ``b`` in ``store``. Note that this function only works with unsorted stores. .. deprecated:: 4.10 Use list models :param a: A ``GtkTreeIter`` :param b: Another ``GtkTreeIter`` Fields ------ .. rst-class:: interim-class .. class:: ListStore :no-index: .. attribute:: parent .. attribute:: priv