Package ch.bailu.gtk.gtk

Class ListStore

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.ListStore
All Implemented Interfaces:
PointerInterface
public class ListStore 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](iface.TreeDragSource.html) and [drop](iface.TreeDragDest.html)
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 [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);
}
```

# 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
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 `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 [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
<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>
```

https://docs.gtk.org/gtk4/class.ListStore.html

  • Constructor Details

    • ListStore

      public ListStore(PointerContainer pointer)

    • ListStore

      public ListStore(int n_columns, Object... _elipse)
      Creates a new list store as with @n_columns columns each of the types passed
      in. 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, string and `GdkTexture`, respectively.
      Parameters:
      n_columns - number of columns in the list store
      _elipse - all `GType` types for the columns, from first to last

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • newvListStore

      public static ListStore newvListStore(int n_columns, @Nonnull Int64 types)
      Non-vararg creation function. Used primarily by language bindings.
      Parameters:
      n_columns - number of columns in the list store
      types - an array of `GType` types for the columns, from first to last
      Returns:
      a new `GtkListStore`

    • append

      public void append(@Nonnull TreeIter iter)
      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 gtk_list_store_set() or gtk_list_store_set_value().
      Parameters:
      iter - An unset `GtkTreeIter` to set to the appended row

    • clear

      public void clear()
      Removes all rows from the list store.

    • insert

      public void insert(@Nonnull TreeIter iter, int position)
      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().
      Parameters:
      iter - An unset `GtkTreeIter` to set to the new row
      position - position to insert the new row, or -1 for last

    • insertAfter

      public void insertAfter(@Nonnull TreeIter iter, @Nullable TreeIter sibling)
      Inserts a new row after @sibling. If @sibling is %NULL, 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().
      Parameters:
      iter - An unset `GtkTreeIter` to set to the new row
      sibling - A valid `GtkTreeIter`

    • insertBefore

      public void insertBefore(@Nonnull TreeIter iter, @Nullable TreeIter sibling)
      Inserts a new row before @sibling. If @sibling is %NULL, 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().
      Parameters:
      iter - An unset `GtkTreeIter` to set to the new row
      sibling - A valid `GtkTreeIter`

    • insertWithValues

      public void insertWithValues(@Nullable TreeIter iter, int position, Object... _elipse)
      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: 
      <!-- language="C" -->
 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, gtk_list_store_insert_with_values()
      should generally be preferred when inserting rows in a sorted list store.
      Parameters:
      iter - An unset `GtkTreeIter` to set to the new row
      position - position to insert the new row, or -1 to append after existing rows
      _elipse - pairs of column number and value, terminated with -1

    • iterIsValid

      public boolean iterIsValid(@Nonnull TreeIter 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.
      Parameters:
      iter - the iterator to check
      Returns:
      %TRUE if the iter is valid, %FALSE if the iter is invalid.

    • moveAfter

      public void moveAfter(@Nonnull TreeIter iter, @Nullable TreeIter 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.
      Parameters:
      iter - A `GtkTreeIter`
      position - A `GtkTreeIter`

    • moveBefore

      public void moveBefore(@Nonnull TreeIter iter, @Nullable TreeIter 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.
      Parameters:
      iter - A `GtkTreeIter`
      position - A `GtkTreeIter`

    • prepend

      public void prepend(@Nonnull TreeIter iter)
      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 gtk_list_store_set() or gtk_list_store_set_value().
      Parameters:
      iter - An unset `GtkTreeIter` to set to the prepend row

    • remove

      public boolean remove(@Nonnull TreeIter 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.
      Parameters:
      iter - A valid `GtkTreeIter`
      Returns:
      %TRUE if @iter is valid, %FALSE if not.

    • reorder

      public void reorder(@Nonnull Int new_order)
      Reorders @store to follow the order indicated by @new_order. Note that
      this function only works with unsorted stores.
      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

      public void set(@Nonnull TreeIter iter, Object... _elipse)
      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
      %G_TYPE_STRING 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 %G_TYPE_OBJECT, and it
      will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
      Parameters:
      iter - row iterator
      _elipse - pairs of column number and value, terminated with -1

    • setColumnTypes

      public void setColumnTypes(int n_columns, @Nonnull Int64 types)
      This function is meant primarily for `GObject`s that inherit from `GtkListStore`,
      and should only be used when constructing a new `GtkListStore`. It will not
      function after a row has been added, or a method on the `GtkTreeModel`
      interface is called.
      Parameters:
      n_columns - Number of columns for the list store
      types - An array length n of `GType`s

    • setValue

      public void setValue(@Nonnull TreeIter iter, int column, @Nonnull Value 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.
      Parameters:
      iter - A valid `GtkTreeIter` for the row being modified
      column - column number to modify
      value - new value for the cell

    • swap

      public void swap(@Nonnull TreeIter a, @Nonnull TreeIter b)
      Swaps @a and @b in @store. Note that this function only works with
      unsorted stores.
      Parameters:
      a - A `GtkTreeIter`
      b - Another `GtkTreeIter`

    • asBuildable

      public Buildable asBuildable()
      Implements interface Buildable. Call this to get access to interface functions.
      Returns:
      Buildable

    • asTreeDragDest

      public TreeDragDest asTreeDragDest()
      Implements interface TreeDragDest. Call this to get access to interface functions.
      Returns:
      TreeDragDest

    • asTreeDragSource

      public TreeDragSource asTreeDragSource()
      Implements interface TreeDragSource. Call this to get access to interface functions.
      Returns:
      TreeDragSource

    • asTreeModel

      public TreeModel asTreeModel()
      Implements interface TreeModel. Call this to get access to interface functions.
      Returns:
      TreeModel

    • asTreeSortable

      public TreeSortable asTreeSortable()
      Implements interface TreeSortable. Call this to get access to interface functions.
      Returns:
      TreeSortable

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()