ListStore

Deprecated since version 4.10: Use ListStore instead

class ListStore(*column_types)

Superclasses: Object

Implemented Interfaces: Buildable, TreeDragDest, TreeDragSource, TreeModel, TreeSortable

Constructors:

ListStore(**properties)
new(types:list) -> Gtk.ListStore

Constructors

class ListStore
classmethod new(types: Sequence[type]) → 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:

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 since version 4.10: Use ListStore instead

Parameters:

types

Methods

class ListStore
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 set() or set_value().

Deprecated since version 4.10: Use list models

Parameters:

row

clear() → None

Removes all rows from the list store.

Deprecated since version 4.10: Use list models

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 set() or set_value().

Deprecated since version 4.10: Use list models

Parameters:

  • position – position to insert the new row, or -1 for last

  • row

insert_after(sibling, row=None)

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 set() or set_value().

Deprecated since version 4.10: Use list models

Parameters:

  • sibling – A valid GtkTreeIter

  • row

insert_before(sibling, row=None)

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 set() or set_value().

Deprecated since version 4.10: Use list models

Parameters:

  • sibling – A valid GtkTreeIter

  • row

insert_with_values(position: int, columns: Sequence[int], values: Sequence[Any]) → 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:

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, insert_with_values() should generally be preferred when inserting rows in a sorted list store.

Deprecated since version 4.10: Use list models

Parameters:

  • position – position to insert the new row, or -1 to append after existing rows

  • columns

  • values

insert_with_valuesv(position: int, columns: Sequence[int], values: Sequence[Any]) → TreeIter

A variant of insert_with_values() which takes the columns and values as two arrays, instead of varargs.

This function is mainly intended for language-bindings.

Deprecated since version 4.10: Use list models

Parameters:

  • position – position to insert the new row, or -1 for last

  • columns – an array of column numbers

  • values – an array of GValues

iter_is_valid(iter: 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 since version 4.10: Use list models

Parameters:

iter – the iterator to check

move_after(iter: TreeIter, position: 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 None, iter will be moved to the start of the list.

Deprecated since version 4.10: Use list models

Parameters:

  • iter – A GtkTreeIter

  • position – A GtkTreeIter

move_before(iter: TreeIter, position: 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 None, iter will be moved to the end of the list.

Deprecated since version 4.10: Use list models

Parameters:

  • iter – A GtkTreeIter

  • position – A GtkTreeIter

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 set() or set_value().

Deprecated since version 4.10: Use list models

Parameters:

row

remove(iter: 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 since version 4.10: Use list models

Parameters:

iter – A valid GtkTreeIter

reorder(new_order: Sequence[int]) → None

Reorders store to follow the order indicated by new_order. Note that this function only works with unsorted stores.

Deprecated since version 4.10: Use list models

Parameters:

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.

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 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 object, and it will be copied if it is a str or Boxed.

Deprecated since version 4.10: Use list models

Parameters:

  • treeiter

  • args

set_column_types(types: 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 since version 4.10: Use list models

Parameters:

types – An array length n of GType’s

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 since version 4.10: Use list models

Parameters:

  • treeiter

  • column – column number to modify

  • value – new value for the cell

swap(a: TreeIter, b: TreeIter) → None

Swaps a and b in store. Note that this function only works with unsorted stores.

Deprecated since version 4.10: Use list models

Parameters:

  • a – A GtkTreeIter

  • b – Another GtkTreeIter

Fields

class ListStore
parent
priv