W Wrapl, The Programming Language

Libraries:Gtk:Gtk:ListStore

Types

T

Inherits from:

The T object is a list model for use with a Gtk.Gtk.TreeView.T widget. It implements the Gtk.Gtk.TreeModel.T interface, and consequentialy, can use all of the methods available there. It also implements the Gtk.Gtk.TreeSortable.T interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.

The T can accept most GObject types 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 T 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 gtk_tree_model_row_changed to emit the "row_changed" signal. This most commonly affects lists with Gtk.Gdk.Pixbuf.Ts stored.

Example 27. Creating a simple list store.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
enum {
  COLUMN_STRING,
  COLUMN_INT,
  COLUMN_BOOLEAN,
  N_COLUMNS
};
{
  GtkListStore *list_store;
  GtkTreePath *path;
  GtkTreeIter iter;
  gint i;
  list_store = gtk_list_store_new (N_COLUMNS,
                                   G_TYPE_STRING,
                                   G_TYPE_INT,
                                   G_TYPE_BOOLEAN);
  for (i = 0; i < 10; i++)
    {
      gchar *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 T was implemented with a linked list with a tail pointer prior to GTK+ 2.6. As a result, it was fast at data insertion and deletion, and not fast at random data access. The T sets the Gtk.Gtk.TreeModelFlags.ItersPersist flag, which means that Gtk.Gtk.TreeIter.Ts 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.

It is important to note that only the methods InsertWithValues and InsertWithValuesv 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 Gtk.Gtk.TreeModel.T signaling. In contrast, using e.g. Append and then gtk_list_store_set() will first create a row, which triggers the "row-inserted" signal on T. The row, however, is still empty, and any signal handler connecting to "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 T inside a Gtk.Gtk.TreeModelFilter.T and are using a Gtk.Gtk.TreeModelFilterVisibleFunc. Using any of the non-atomic operations to append rows to the T will cause the Gtk.Gtk.TreeModelFilterVisibleFunc to be visited with an empty row first; the function must be prepared for that.


GtkListStore as GtkBuildable

The GtkListStore implementation of the GtkBuildable 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.

Example 28. A UI Definition fragment for a list store

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<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>




Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



New(... @ Std.Object.T) : Gtk.Gtk.ListStore.T

Non-vararg creation function. Used primarily by language bindings.

n_columns number of columns in the list store
types an array of GType types for the columns, from first to last. [array length=n_columns]
Returns a new T. [transfer none]


Newv(types @ Agg.List.T) : Gtk.Gtk.ListStore.T

Non-vararg creation function. Used primarily by language bindings.

n_columns number of columns in the list store
types an array of GType types for the columns, from first to last. [array length=n_columns]
Returns a new T. [transfer none]


Methods

:Append(self @ T, iter @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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 SetValue.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the appended row. [out]


:Clear(self @ T) : Std.Object.T

Removes all rows from the list store.

list_store a T.


:Insert(self @ T, iter @ Gtk.Gtk.TreeIter.T, position @ Std.Integer.SmallT) : Std.Object.T

Creates a new row at position. iter will be changed to point to this new row. If position 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 SetValue.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the new row. [out]
position position to insert the new row


:InsertAfter(self @ T, iter @ Gtk.Gtk.TreeIter.T, sibling @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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 SetValue.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the new row. [out]
sibling A valid Gtk.Gtk.TreeIter.T, or NULL. [allow-none]


:InsertBefore(self @ T, iter @ Gtk.Gtk.TreeIter.T, sibling @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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 SetValue.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the new row. [out]
sibling A valid Gtk.Gtk.TreeIter.T, or NULL. [allow-none]


:InsertWithValues(self @ T, iter @ Gtk.Gtk.TreeIter.T, position @ Std.Integer.SmallT, ... @ Std.Object.T) : Std.Object.T

Creates a new row at position. iter will be changed to point to this new row. If position is larger than the number of rows on 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

1
2
gtk_list_store_insert (list_store, iter, position);
gtk_list_store_set (list_store, iter, ...);


:InsertWithValuesv(self @ T, iter @ Gtk.Gtk.TreeIter.T, position @ Std.Integer.SmallT, columns @ Std.Object.T, values @ Gtk.GObject.Value.T, n_values @ Std.Integer.SmallT) : Std.Object.T

A variant of InsertWithValues which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the new row, or NULL. [out][allow-none]
position position to insert the new row
columns an array of column numbers. [array length=n_values]
values an array of GValues. [array length=n_values]
n_values the length of the columns and values arrays


:IterIsValid(self @ T, iter @ Gtk.Gtk.TreeIter.T) : Std.Symbol.T

Warning

This function is slow. Only use it for debugging and/or testing purposes.


:MoveAfter(self @ T, iter @ Gtk.Gtk.TreeIter.T, position @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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.

store A T.
iter A Gtk.Gtk.TreeIter.T.
position A Gtk.Gtk.TreeIter.T or NULL. [allow-none]


:MoveBefore(self @ T, iter @ Gtk.Gtk.TreeIter.T, position @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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.

store A T.
iter A Gtk.Gtk.TreeIter.T.
position A Gtk.Gtk.TreeIter.T, or NULL. [allow-none]


:Prepend(self @ T, iter @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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 SetValue.

list_store A T
iter An unset Gtk.Gtk.TreeIter.T to set to the prepend row. [out]


:Remove(self @ T, iter @ Gtk.Gtk.TreeIter.T) : Std.Symbol.T

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.

list_store A T
iter A valid Gtk.Gtk.TreeIter.T
Returns TRUE if iter is valid, FALSE if not.


:Reorder(self @ T, new_order @ Std.Object.T) : Std.Object.T

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

store A T.
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. [array]


:Set(self @ T, iter @ Gtk.Gtk.TreeIter.T, ...) : Std.Object.T

See gtk_list_store_set(); this version takes a va_list for use by language bindings.

list_store A T
iter A valid Gtk.Gtk.TreeIter.T for the row being modified
var_args va_list of column/value pairs


:SetColumnTypes(self @ T, n_columns @ Std.Integer.SmallT, types @ Std.Object.T) : Std.Object.T

This function is meant primarily for GObjects that inherit from T, and should only be used when constructing a new T. It will not function after a row has been added, or a method on the Gtk.Gtk.TreeModel.T interface is called.

list_store A T
n_columns Number of columns for the list store
types An array length n of GTypes. [array length=n_columns]


:SetValist(self @ T, iter @ Gtk.Gtk.TreeIter.T, var_args @ Agg.List.T) : Std.Object.T

See gtk_list_store_set(); this version takes a va_list for use by language bindings.

list_store A T
iter A valid Gtk.Gtk.TreeIter.T for the row being modified
var_args va_list of column/value pairs


:SetValue(self @ T, iter @ Gtk.Gtk.TreeIter.T, column @ Std.Integer.SmallT, value @ Gtk.GObject.Value.T) : Std.Object.T

Sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column.

list_store A T
iter A valid Gtk.Gtk.TreeIter.T for the row being modified
column column number to modify
value new value for the cell


:SetValuesv(self @ T, iter @ Gtk.Gtk.TreeIter.T, columns @ Std.Object.T, values @ Gtk.GObject.Value.T, n_values @ Std.Integer.SmallT) : Std.Object.T

A variant of SetValist which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to change is not known until run-time.

list_store A T
iter A valid Gtk.Gtk.TreeIter.T for the row being modified
columns an array of column numbers. [array length=n_values]
values an array of GValues. [array length=n_values]
n_values the length of the columns and values arrays


:Swap(self @ T, a @ Gtk.Gtk.TreeIter.T, b @ Gtk.Gtk.TreeIter.T) : Std.Object.T

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

store A T.
a A Gtk.Gtk.TreeIter.T.
b Another Gtk.Gtk.TreeIter.T.