class: ListStore

[79:7] extends: object

A list-like data structure that can be used with the [class@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 GTypes 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 GObjects 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 [method@Gtk.TreeModel.row_changed] to emit the [signal@Gtk.TreeModel::row_changed] signal. This most commonly affects lists with [class@Gdk.Texture]s stored. An example for creating a simple list store: 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); } GtkListStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use [class@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 GtkTreeIters 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 GtkTreeModel 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 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 GtkTreeModelFilter and are using a GtkTreeModelFilterVisibleFunc. Using any of the non-atomic operations to append rows to the GtkListStore will cause the GtkTreeModelFilterVisibleFunc to be visited with an empty row first; the function must be prepared for that. ## GtkListStore as GtkBuildable The GtkListStore implementation of the [iface@Gtk.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 ```

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• ListStore (Handle = null)

  Creates a new ListStore by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asTreeDragDest ()

  Wraps this handle as TreeDragDest.

  • @r A TreeDragDest object.

• asTreeDragSource ()

  Wraps this handle as TreeDragSource.

  • @r A TreeDragSource object.

• asTreeModel ()

  Wraps this handle as TreeModel.

  • @r A TreeModel object.

• asTreeSortable ()

  Wraps this handle as TreeSortable.

  • @r A TreeSortable object.

• clear ()

  Removes all rows from the list store.

  • @r None.

• iter_is_valid (iter)

  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.

  • @p iter is the iterator to check.

• move_after (iter, position)

  Moves @iter in @store to the position after @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the list.

  • @p iter is A GtkTreeIter.
  • @p position is A GtkTreeIter.
  • @r None.

• move_before (iter, position)

  Moves @iter in @store to the position before @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the list.

  • @p iter is A GtkTreeIter.
  • @p position is A GtkTreeIter.
  • @r None.

• remove (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 @list_store.

  • @p iter is A valid GtkTreeIter.

• reorder (list new_order)

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

  • @p new_order is 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..
  • @r None.

• set_value (iter, int column, object 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.
  • @p iter is A valid GtkTreeIter for the row being modified.
  • @p column is column number to modify.
  • @p value is new value for the cell.
  • @r None.

• swap (a, b)

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

  • @p a is A GtkTreeIter.
  • @p b is Another GtkTreeIter.
  • @r None.