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: |[ <object class="GtkListStore"> JohnDoe25 JohanDahlin50 </object> ]|

protected GtkListStore* gtkListStore ;
the main Gtk struct

GtkListStore* getListStoreStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkListStore* gtkListStore, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

TreeIter createIter ();
Creates a top level iteractor. I don't think lists have but the top level iteractor

void set (TreeIter iter, int[] columns, char*[] values);
void set (TreeIter iter, int[] columns, string[] values);
sets the values for one row

Params:

gtk.ListStore

class ListStore : gobject.ObjectG.ObjectG, gtk.BuildableIF.BuildableIF, gtk.TreeDragDestIF.TreeDragDestIF, gtk.TreeDragSourceIF.TreeDragSourceIF, gtk.TreeModelIF.TreeModelIF, gtk.TreeSortableIF.TreeSortableIF;
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][gtk3-GtkTreeView-drag-and-drop] interfaces.

The #GtkListStore 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 #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 gtk_tree_model_row_changed() to emit the #GtkTreeModel::row_changed signal. This most commonly affects lists with #GdkPixbufs stored.

An example for creating a simple list store: |[ 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 #GtkListStore 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 #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 GtkBuildable 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
TreeIter iter the row iteractor
int[] columns an arrays with the columns to set
char*[] values an arrays with the values

void setValue (TreeIter iter, int column, string value);
void setValue (TreeIter iter, int column, int value);
static GType getType ();
this(GType[] types);
Non-vararg creation function. Used primarily by language bindings.

Params:
nColumns number of columns in the list store
GType[] types an array of #GType types for the columns, from first to last

Returns:
a new #GtkListStore

Throws:
ConstructionException GTK+ fails to create the object.

void append (out 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().

Params:
TreeIter iter An unset #GtkTreeIter to set to the appended row

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

void insert (out 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().

Params:
TreeIter iter An unset #GtkTreeIter to set to the new row
int position position to insert the new row, or -1 for last

void insertAfter (out TreeIter iter, 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().

Params:
TreeIter iter An unset #GtkTreeIter to set to the new row
TreeIter sibling A valid #GtkTreeIter, or %NULL

void insertBefore (out TreeIter iter, 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().

Params:
TreeIter iter An unset #GtkTreeIter to set to the new row
TreeIter sibling A valid #GtkTreeIter, or %NULL

void insertWithValuesv (out TreeIter iter, int position, int[] columns, Value[] values);
A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings.

Params:
TreeIter iter An unset #GtkTreeIter to set to the new row, or %NULL.
int position position to insert the new row, or -1 for last
int[] columns an array of column numbers
Value[] values an array of GValues
nValues the length of the @columns and @values arrays

Since:
2.6

bool iterIsValid (TreeIter iter);
> This function is slow. Only use it for debugging and/or testing > purposes.

Checks if the given iter is a valid iter for this #GtkListStore.

Params:
TreeIter iter A #GtkTreeIter.

Returns:
%TRUE if the iter is valid, %FALSE if the iter is invalid.

Since:
2.2

void moveAfter (TreeIter iter, 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.

Params:
TreeIter iter A #GtkTreeIter.
TreeIter position A #GtkTreeIter or %NULL.

Since:
2.2

void moveBefore (TreeIter iter, 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.

Params:
TreeIter iter A #GtkTreeIter.
TreeIter position A #GtkTreeIter, or %NULL.

Since:
2.2

void prepend (out 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().

Params:
TreeIter iter An unset #GtkTreeIter to set to the prepend row

bool remove (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.

Params:
TreeIter iter A valid #GtkTreeIter

Returns:
%TRUE if @iter is valid, %FALSE if not.

void reorder (int[] newOrder);
Reorders @store to follow the order indicated by @new_order. Note that this function only works with unsorted stores.

Params:
int[] newOrder 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.

Since:
2.2

void setColumnTypes (GType[] types);
This function is meant primarily for #GObjects 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.

Params:
nColumns Number of columns for the list store
GType[] types An array length n of #GTypes

void setValist (TreeIter iter, void* varArgs);
See gtk_list_store_set(); this version takes a va_list for use by language bindings.

Params:
TreeIter iter A valid #GtkTreeIter for the row being modified
void* varArgs va_list of column/value pairs

void setValue (TreeIter iter, int column, 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.

Params:
TreeIter iter A valid #GtkTreeIter for the row being modified
int column column number to modify
Value value new value for the cell

void setValuesv (TreeIter iter, int[] columns, Value[] values);
A variant of gtk_list_store_set_valist() 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.

Params:
TreeIter iter A valid #GtkTreeIter for the row being modified
int[] columns an array of column numbers
Value[] values an array of GValues
nValues the length of the @columns and @values arrays

Since:
2.12

void swap (TreeIter a, TreeIter b);
Swaps @a and @b in @store. Note that this function only works with unsorted stores.

Params:
TreeIter a A #GtkTreeIter.
TreeIter b Another #GtkTreeIter.

Since:
2.2

Page was generated with on Sun Apr 23 22:52:56 2017