TreeStore

A tree-like data structure that can be used with the gtk.tree_view.TreeView.

The gtk.tree_store.TreeStore object is a list model for use with a gtk.tree_view.TreeView widget. It implements the gtk.tree_model.TreeModel interface, and consequently, can use all of the methods available there. It also implements the gtk.tree_sortable.TreeSortable interface so it can be sorted by the view. Finally, it also implements the tree drag gtk.tree_drag_source.TreeDragSource and drop gtk.tree_drag_dest.TreeDragDest interfaces.

gtk.tree_store.TreeStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use gtk.tree_list_model.TreeListModel for a tree-like model object.

GtkTreeStore as GtkBuildable

The GtkTreeStore implementation of the gtk.buildable.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.

An example of a UI Definition fragment for a tree store:

<object class="GtkTreeStore">
  <columns>
    <column type="gchararray"/>
    <column type="gchararray"/>
    <column type="gint"/>
  </columns>
</object>

More...

class TreeStore : ObjectG , Buildable , TreeDragDest , TreeDragSource , TreeModel , TreeSortable {

static gtk.tree_store.TreeStore new_(gobject.types.GType[] types);

void append(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent);

void clear();

void insert(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int position);

void insertAfter(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, gtk.tree_iter.TreeIter sibling);

void insertBefore(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, gtk.tree_iter.TreeIter sibling);

void insertWithValues(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int position, int[] columns, gobject.value.Value[] values);

bool isAncestor(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter descendant);

int iterDepth(gtk.tree_iter.TreeIter iter);

bool iterIsValid(gtk.tree_iter.TreeIter iter);

void moveAfter(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter position);

void moveBefore(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter position);

void prepend(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent);

bool remove(gtk.tree_iter.TreeIter iter);

void setColumnTypes(gobject.types.GType[] types);

void setValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value);

void set(gtk.tree_iter.TreeIter iter, int[] columns, gobject.value.Value[] values);

void swap(gtk.tree_iter.TreeIter a, gtk.tree_iter.TreeIter b);

}

Members

Functions

append void append(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent): Appends a new row to tree_store.
clear void clear(): Removes all rows from tree_store
insert void insert(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int position): Creates a new row at position.
insertAfter void insertAfter(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, gtk.tree_iter.TreeIter sibling): Inserts a new row after sibling.
insertBefore void insertBefore(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, gtk.tree_iter.TreeIter sibling): Inserts a new row before sibling.
insertWithValues void insertWithValues(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int position, int[] columns, gobject.value.Value[] values): A variant of gtk.tree_store.TreeStore.insertWithValues which takes the columns and values as two arrays, instead of varargs.
isAncestor bool isAncestor(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter descendant): Checks if iter is an ancestor of descendant.
iterDepth int iterDepth(gtk.tree_iter.TreeIter iter): Returns the depth of the position pointed by the iterator
iterIsValid bool iterIsValid(gtk.tree_iter.TreeIter iter): Checks if the given iter is a valid iter for this gtk.tree_store.TreeStore.
moveAfter void moveAfter(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter position): Moves iter in tree_store to the position after position.
moveBefore void moveBefore(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter position): Moves iter in tree_store to the position before position.
prepend void prepend(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent): Prepends a new row to tree_store.
remove bool remove(gtk.tree_iter.TreeIter iter): Removes iter from tree_store.
set void set(gtk.tree_iter.TreeIter iter, int[] columns, gobject.value.Value[] values): A variant of gtk.tree_store.TreeStore.setValist which takes the columns and values as two arrays, instead of using variadic arguments.
setColumnTypes void setColumnTypes(gobject.types.GType[] types): Sets the type of the columns in a tree store.
setValue void setValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value): Sets the data in the cell specified by iter and column.
swap void swap(gtk.tree_iter.TreeIter a, gtk.tree_iter.TreeIter b): Swaps a and b in the same level of tree_store.

Static functions

new_ gtk.tree_store.TreeStore new_(gobject.types.GType[] types): Creates a new tree store.

Mixed In Members

From `mixin BuildableT!()`

getBuildableId string getBuildableId(): Gets the ID of the buildable object.

From `mixin TreeDragDestT!()`

dragDataReceived bool dragDataReceived(gtk.tree_path.TreePath dest, gobject.value.Value value): Asks the gtk.tree_drag_dest.TreeDragDest to insert a row before the path dest, deriving the contents of the row from value. 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!
rowDropPossible bool rowDropPossible(gtk.tree_path.TreePath destPath, gobject.value.Value value): 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 value 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.

From `mixin TreeDragSourceT!()`

dragDataDelete bool dragDataDelete(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource 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!
dragDataGet gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!
rowDraggable bool rowDraggable(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource 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.

From `mixin TreeModelT!()`

filterNew gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root): Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.
foreach_ void foreach_(gtk.types.TreeModelForeachFunc func): Calls func on each node in model in a depth-first fashion.
getColumnType gobject.types.GType getColumnType(int index): Returns the type of the column.
getFlags gtk.types.TreeModelFlags getFlags(): Returns a set of flags supported by this interface.
getIter bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path): Sets iter to a valid iterator pointing to path.
getIterFirst bool getIterFirst(gtk.tree_iter.TreeIter iter): Initializes iter with the first iterator in the tree (the one at the path "0").
getIterFromString bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString): Sets iter to a valid iterator pointing to path_string, if it exists.
getNColumns int getNColumns(): Returns the number of columns supported by tree_model.
getPath gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter): Returns a newly-created gtk.tree_path.TreePath referenced by iter.
getStringFromIter string getStringFromIter(gtk.tree_iter.TreeIter iter): Generates a string representation of the iter.
getValue void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value): Initializes and sets value to that at column.
iterChildren bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent): Sets iter to point to the first child of parent.
iterHasChild bool iterHasChild(gtk.tree_iter.TreeIter iter): Returns true if iter has children, false otherwise.
iterNChildren int iterNChildren(gtk.tree_iter.TreeIter iter): Returns the number of children that iter has.
iterNext bool iterNext(gtk.tree_iter.TreeIter iter): Sets iter to point to the node following it at the current level.
iterNthChild bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n): Sets iter to be the child of parent, using the given index.
iterParent bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child): Sets iter to be the parent of child.
iterPrevious bool iterPrevious(gtk.tree_iter.TreeIter iter): Sets iter to point to the previous node at the current level.
refNode void refNode(gtk.tree_iter.TreeIter iter): Lets the tree ref the node.
rowChanged void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-changed signal on tree_model.
rowDeleted void rowDeleted(gtk.tree_path.TreePath path): Emits the ::row-deleted signal on tree_model.
rowHasChildToggled void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-has-child-toggled signal on tree_model.
rowInserted void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-inserted signal on tree_model.
rowsReordered void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder): Emits the ::rows-reordered signal on tree_model.
unrefNode void unrefNode(gtk.tree_iter.TreeIter iter): Lets the tree unref the node.
connectRowChanged ulong connectRowChanged(T callback, Flag!"After" after): Connect to RowChanged signal.
connectRowDeleted ulong connectRowDeleted(T callback, Flag!"After" after): Connect to RowDeleted signal.
connectRowHasChildToggled ulong connectRowHasChildToggled(T callback, Flag!"After" after): Connect to RowHasChildToggled signal.
connectRowInserted ulong connectRowInserted(T callback, Flag!"After" after): Connect to RowInserted signal.

From `mixin TreeSortableT!()`

getSortColumnId bool getSortColumnId(int sortColumnId, gtk.types.SortType order): 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_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
hasDefaultSortFunc bool hasDefaultSortFunc(): 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.
setDefaultSortFunc void setDefaultSortFunc(gtk.types.TreeIterCompareFunc sortFunc): Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
setSortColumnId void setSortColumnId(int sortColumnId, gtk.types.SortType order): 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:
setSortFunc void setSortFunc(int sortColumnId, gtk.types.TreeIterCompareFunc sortFunc): 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.
sortColumnChanged void sortColumnChanged(): Emits a GtkTreeSortable::sort-column-changed signal on sortable.
connectSortColumnChanged ulong connectSortColumnChanged(T callback, Flag!"After" after): Connect to SortColumnChanged signal.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): 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.
forceFloating void forceFloating(): 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.ObjectG.refSink.
freezeNotify void freezeNotify(): 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.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): 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.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.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:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): 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.ObjectG.ref_ and gobject.object.ObjectG.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.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From Buildable

getBuildableId string getBuildableId(): Gets the ID of the buildable object.

From TreeDragDest

dragDataReceived bool dragDataReceived(gtk.tree_path.TreePath dest, gobject.value.Value value): Asks the gtk.tree_drag_dest.TreeDragDest to insert a row before the path dest, deriving the contents of the row from value. 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!
rowDropPossible bool rowDropPossible(gtk.tree_path.TreePath destPath, gobject.value.Value value): 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 value 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.

From TreeDragSource

dragDataDelete bool dragDataDelete(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource 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!
dragDataGet gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!
rowDraggable bool rowDraggable(gtk.tree_path.TreePath path): Asks the gtk.tree_drag_source.TreeDragSource 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.

From TreeModel

filterNew gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root): Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.
foreach_ void foreach_(gtk.types.TreeModelForeachFunc func): Calls func on each node in model in a depth-first fashion.
getColumnType gobject.types.GType getColumnType(int index): Returns the type of the column.
getFlags gtk.types.TreeModelFlags getFlags(): Returns a set of flags supported by this interface.
getIter bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path): Sets iter to a valid iterator pointing to path.
getIterFirst bool getIterFirst(gtk.tree_iter.TreeIter iter): Initializes iter with the first iterator in the tree (the one at the path "0").
getIterFromString bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString): Sets iter to a valid iterator pointing to path_string, if it exists.
getNColumns int getNColumns(): Returns the number of columns supported by tree_model.
getPath gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter): Returns a newly-created gtk.tree_path.TreePath referenced by iter.
getStringFromIter string getStringFromIter(gtk.tree_iter.TreeIter iter): Generates a string representation of the iter.
getValue void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value): Initializes and sets value to that at column.
iterChildren bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent): Sets iter to point to the first child of parent.
iterHasChild bool iterHasChild(gtk.tree_iter.TreeIter iter): Returns true if iter has children, false otherwise.
iterNChildren int iterNChildren(gtk.tree_iter.TreeIter iter): Returns the number of children that iter has.
iterNext bool iterNext(gtk.tree_iter.TreeIter iter): Sets iter to point to the node following it at the current level.
iterNthChild bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n): Sets iter to be the child of parent, using the given index.
iterParent bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child): Sets iter to be the parent of child.
iterPrevious bool iterPrevious(gtk.tree_iter.TreeIter iter): Sets iter to point to the previous node at the current level.
refNode void refNode(gtk.tree_iter.TreeIter iter): Lets the tree ref the node.
rowChanged void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-changed signal on tree_model.
rowDeleted void rowDeleted(gtk.tree_path.TreePath path): Emits the ::row-deleted signal on tree_model.
rowHasChildToggled void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-has-child-toggled signal on tree_model.
rowInserted void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter): Emits the ::row-inserted signal on tree_model.
rowsReordered void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder): Emits the ::rows-reordered signal on tree_model.
unrefNode void unrefNode(gtk.tree_iter.TreeIter iter): Lets the tree unref the node.
connectRowChanged ulong connectRowChanged(T callback, Flag!"After" after): Connect to RowChanged signal.
connectRowDeleted ulong connectRowDeleted(T callback, Flag!"After" after): Connect to RowDeleted signal.
connectRowHasChildToggled ulong connectRowHasChildToggled(T callback, Flag!"After" after): Connect to RowHasChildToggled signal.
connectRowInserted ulong connectRowInserted(T callback, Flag!"After" after): Connect to RowInserted signal.

From TreeSortable

getSortColumnId bool getSortColumnId(int sortColumnId, gtk.types.SortType order): 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_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
hasDefaultSortFunc bool hasDefaultSortFunc(): 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.
setDefaultSortFunc void setDefaultSortFunc(gtk.types.TreeIterCompareFunc sortFunc): Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
setSortColumnId void setSortColumnId(int sortColumnId, gtk.types.SortType order): 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:
setSortFunc void setSortFunc(int sortColumnId, gtk.types.TreeIterCompareFunc sortFunc): 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.
sortColumnChanged void sortColumnChanged(): Emits a GtkTreeSortable::sort-column-changed signal on sortable.
connectSortColumnChanged ulong connectSortColumnChanged(T callback, Flag!"After" after): Connect to SortColumnChanged signal.