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.ListStore.set or gtk.list_store.ListStore.setValue.
Removes all rows from the list store.
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.ListStore.set or gtk.list_store.ListStore.setValue.
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.ListStore.set or gtk.list_store.ListStore.setValue.
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.ListStore.set or gtk.list_store.ListStore.setValue.
A variant of gtk.list_store.ListStore.insertWithValues which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings.
> This function is slow. Only use it for debugging and/or testing > purposes.
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.
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.
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.ListStore.set or gtk.list_store.ListStore.setValue.
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.
Returns this, for use in with statements.
A variant of gtk.list_store.ListStore.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.
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.
Sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column.
Swaps a and b in store. Note that this function only works with unsorted stores.
Get builder for gtk.list_store.ListStore
Non-vararg creation function. Used primarily by language bindings.
Adds a child to buildable. type is an optional string describing how the child should be added.
Constructs a child of buildable with the name name.
This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
This is called for each unknown element under <child>.
Get the internal child called childname of the buildable object.
Gets the name of the buildable object.
Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
Sets the property name name to value on the buildable object.
Sets the name of the buildable object.
Asks the #GtkTreeDragDest to insert a row before the path dest, deriving the contents of the row from selection_data. If dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason. Should robustly handle a dest no longer found in the model!
Determines whether a drop is possible before the given dest_path, at the same depth as dest_path. i.e., can we drop the data in selection_data at that location. dest_path does not have to exist; the return value will almost certainly be false if the parent of dest_path doesn’t exist, though.
Asks the #GtkTreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns false if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model!
Asks the #GtkTreeDragSource to fill in selection_data with a representation of the row at path. selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model!
Asks the #GtkTreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable.
Creates a new #GtkTreeModel, with child_model as the child_model and root as the virtual root.
Calls func on each node in model in a depth-first fashion.
Returns the type of the column.
Returns a set of flags supported by this interface.
Sets iter to a valid iterator pointing to path. If path does not exist, iter is set to an invalid iterator and false is returned.
Initializes iter with the first iterator in the tree (the one at the path "0") and returns true. Returns false if the tree is empty.
Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and false is returned.
Returns the number of columns supported by tree_model.
Returns a newly-created #GtkTreePath-struct referenced by iter.
Generates a string representation of the iter.
Initializes and sets value to that at column.
Sets iter to point to the first child of parent.
Returns true if iter has children, false otherwise.
Returns the number of children that iter has.
Sets iter to point to the node following it at the current level.
Sets iter to be the child of parent, using the given index.
Sets iter to be the parent of child.
Sets iter to point to the previous node at the current level.
Lets the tree ref the node.
Emits the #GtkTreeModel::row-changed signal on tree_model.
Emits the #GtkTreeModel::row-deleted signal on tree_model.
Emits the #GtkTreeModel::row-has-child-toggled signal on tree_model. This should be called by models after the child state of a node changes.
Emits the #GtkTreeModel::row-inserted signal on tree_model.
Emits the #GtkTreeModel::rows-reordered signal on tree_model.
Lets the tree unref the node.
Connect to RowChanged signal.
Connect to RowDeleted signal.
Connect to RowHasChildToggled signal.
Connect to RowInserted signal.
Fills in sort_column_id and order with the current sort column and the order. It returns true unless the sort_column_id is gtk.types.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or gtk.types.TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
Returns true if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not.
Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable is gtk.types.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a #GtkTreeSortable::sort-column-changed signal. sort_column_id may either be a regular column id, or one of the following special values:
Sets the comparison function used when sorting to be sort_func. If the current sort column id of sortable is the same as sort_column_id, then the model will sort using this function.
Emits a #GtkTreeSortable::sort-column-changed signal on sortable.
Connect to SortColumnChanged signal.
Set the GObject of a D ObjectWrap wrapper.
Get a pointer to the underlying C object.
Calls g_object_ref() on a GObject.
Calls g_object_unref() on a GObject.
Get the GType of an object.
GObject GType property.
Convenience method to return this cast to a type. For use in D with statements.
Template to get the D object from a C GObject and cast it to the given D object type.
Connect a D closure to an object signal.
Template for setting a GObject property.
Template for getting a GObject property.
Creates a binding between source_property on source and target_property on target.
Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.
Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
Gets a property of an object.
This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
Sets a property on an object.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
Connect to Notify signal.
Adds a child to buildable. type is an optional string describing how the child should be added.
Constructs a child of buildable with the name name.
This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
This is called for each unknown element under <child>.
Get the internal child called childname of the buildable object.
Gets the name of the buildable object.
Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
Sets the property name name to value on the buildable object.
Sets the name of the buildable object.
Asks the #GtkTreeDragDest to insert a row before the path dest, deriving the contents of the row from selection_data. If dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason. Should robustly handle a dest no longer found in the model!
Determines whether a drop is possible before the given dest_path, at the same depth as dest_path. i.e., can we drop the data in selection_data at that location. dest_path does not have to exist; the return value will almost certainly be false if the parent of dest_path doesn’t exist, though.
Asks the #GtkTreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns false if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model!
Asks the #GtkTreeDragSource to fill in selection_data with a representation of the row at path. selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model!
Asks the #GtkTreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable.
Creates a new #GtkTreeModel, with child_model as the child_model and root as the virtual root.
Calls func on each node in model in a depth-first fashion.
Returns the type of the column.
Returns a set of flags supported by this interface.
Sets iter to a valid iterator pointing to path. If path does not exist, iter is set to an invalid iterator and false is returned.
Initializes iter with the first iterator in the tree (the one at the path "0") and returns true. Returns false if the tree is empty.
Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and false is returned.
Returns the number of columns supported by tree_model.
Returns a newly-created #GtkTreePath-struct referenced by iter.
Generates a string representation of the iter.
Initializes and sets value to that at column.
Sets iter to point to the first child of parent.
Returns true if iter has children, false otherwise.
Returns the number of children that iter has.
Sets iter to point to the node following it at the current level.
Sets iter to be the child of parent, using the given index.
Sets iter to be the parent of child.
Sets iter to point to the previous node at the current level.
Lets the tree ref the node.
Emits the #GtkTreeModel::row-changed signal on tree_model.
Emits the #GtkTreeModel::row-deleted signal on tree_model.
Emits the #GtkTreeModel::row-has-child-toggled signal on tree_model. This should be called by models after the child state of a node changes.
Emits the #GtkTreeModel::row-inserted signal on tree_model.
Emits the #GtkTreeModel::rows-reordered signal on tree_model.
Lets the tree unref the node.
Connect to RowChanged signal.
Connect to RowDeleted signal.
Connect to RowHasChildToggled signal.
Connect to RowInserted signal.
Fills in sort_column_id and order with the current sort column and the order. It returns true unless the sort_column_id is gtk.types.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or gtk.types.TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
Returns true if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not.
Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable is gtk.types.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a #GtkTreeSortable::sort-column-changed signal. sort_column_id may either be a regular column id, or one of the following special values:
Sets the comparison function used when sorting to be sort_func. If the current sort column id of sortable is the same as sort_column_id, then the model will sort using this function.
Emits a #GtkTreeSortable::sort-column-changed signal on sortable.
Connect to SortColumnChanged signal.
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.TreeModel.rowChanged to emit the #GtkTreeModel::row_changed signal. This most commonly affects lists with #GdkPixbufs stored.
An example for creating a simple list store:
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.ListStore.insertWithValues and gtk.list_store.ListStore.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 #GtkTreeModel signaling. In contrast, using e.g. gtk.list_store.ListStore.append and then gtk.list_store.ListStore.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 <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: