TreeStore

Description The GtkTreeStore 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 interfaces. GtkTreeStore as GtkBuildable The GtkTreeStore 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.

class TreeStore : ObjectG , TreeModelIF , TreeDragSourceIF , TreeDragDestIF , TreeSortableIF {}

Constructors

this
this(GtkTreeStore* gtkTreeStore)

Sets our main struct and passes it to the parent class

this
this(GType[] types)

Non vararg creation function. Used primarily by language bindings.

Members

Functions

append
TreeIter append(TreeIter parent)

Creates and appends a new row to tree_store. If parent is non-NULL, then it will append the new row after the last child of parent, otherwise it will append a row to the top level. 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_tree_store_set() or gtk_tree_store_set_value().

append
void append(TreeIter iter, TreeIter parent)

Appends a new row to tree_store. If parent is non-NULL, then it will append the new row after the last child of parent, otherwise it will append a row to the top level. 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_tree_store_set() or gtk_tree_store_set_value().

clear
void clear()

Removes all rows from tree_store

createIter
TreeIter createIter(TreeIter parent)

Creates a top level iteractor. I don't think lists have but the top level iteractor

getStruct
void* getStruct()

the main Gtk struct as a void*

getTreeStoreStruct
GtkTreeStore* getTreeStoreStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
insert
void insert(TreeIter iter, TreeIter parent, int position)

Creates a new row at position. If parent is non-NULL, then the row will be made a child of parent. Otherwise, the row will be created at the toplevel. If position is larger than the number of rows at that level, then the new row will be inserted 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_tree_store_set() or gtk_tree_store_set_value().

insertAfter
void insertAfter(TreeIter iter, TreeIter parent, TreeIter sibling)

Inserts a new row after sibling. If sibling is NULL, then the row will be prepended to parent 's children. If parent and sibling are NULL, then the row will be prepended to the toplevel. If both sibling and parent are set, then parent must be the parent of sibling. When sibling is set, parent is optional. 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_tree_store_set() or gtk_tree_store_set_value().

insertBefore
void insertBefore(TreeIter iter, TreeIter parent, TreeIter sibling)

Inserts a new row before sibling. If sibling is NULL, then the row will be appended to parent 's children. If parent and sibling are NULL, then the row will be appended to the toplevel. If both sibling and parent are set, then parent must be the parent of sibling. When sibling is set, parent is optional. 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_tree_store_set() or gtk_tree_store_set_value().

insertWithValuesv
void insertWithValuesv(TreeIter iter, TreeIter parent, int position, int[] columns, GValue[] values)

A variant of gtk_tree_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language bindings. Since 2.10

isAncestor
int isAncestor(TreeIter iter, TreeIter descendant)

Returns TRUE if iter is an ancestor of descendant. That is, iter is the parent (or grandparent or great-grandparent) of descendant.

iterDepth
int iterDepth(TreeIter iter)

Returns the depth of iter. This will be 0 for anything on the root level, 1 for anything down a level, etc.

iterIsValid
int iterIsValid(TreeIter iter)

WARNING: This function is slow. Only use it for debugging and/or testing purposes. Checks if the given iter is a valid iter for this GtkTreeStore. Since 2.2

moveAfter
void moveAfter(TreeIter iter, TreeIter position)

Moves iter in tree_store to the position after position. iter and position should be in the same level. Note that this function only works with unsorted stores. If position is NULL, iter will be moved to the start of the level. Since 2.2

moveBefore
void moveBefore(TreeIter iter, TreeIter position)

Moves iter in tree_store to the position before position. iter and position should be in the same level. Note that this function only works with unsorted stores. If position is NULL, iter will be moved to the end of the level. Since 2.2

prepend
TreeIter prepend(TreeIter parent)

Creates and prepends a new row to tree_store. If parent is non-NULL, then it will prepend the new row before the first child of parent, otherwise it will prepend a row to the top level. 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_tree_store_set() or gtk_tree_store_set_value().

prepend
void prepend(TreeIter iter, TreeIter parent)

Prepends a new row to tree_store. If parent is non-NULL, then it will prepend the new row before the first child of parent, otherwise it will prepend a row to the top level. 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_tree_store_set() or gtk_tree_store_set_value().

remove
int remove(TreeIter iter)

Removes iter from tree_store. After being removed, iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one.

reorder
void reorder(TreeIter parent, int[] newOrder)

Reorders the children of parent in tree_store to follow the order indicated by new_order. Note that this function only works with unsorted stores. Since 2.2

set
void set(TreeIter iter, int[] columns, char*[] values)

sets the values for one row

set
void set(TreeIter iter, int[] columns, string[] values)
set
void set(TreeIter iter, TreeNode treeNode)

Sets an iteractor values from a tree node. This is the way to add a new row to the tree, the iteractor is either a top level iteractor created from createIter() or a nested iteractor created from append()

setColumnTypes
void setColumnTypes(GType[] types)

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

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setValist
void setValist(TreeIter iter, void* varArgs)

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

setValue
void setValue(TreeIter iter, int column, string value)

Sets one value into one cells. \todo confirm we need to destroy the Value instance

setValue
void setValue(TreeIter iter, int column, int value)
setValue
void setValue(TreeIter iter, int column, Pixbuf pixbuf)

\todo confirm we need to destroy the Value instance

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

setValuesv
void setValuesv(TreeIter iter, int[] columns, GValue[] values)

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

swap
void swap(TreeIter a, TreeIter b)

Swaps a and b in the same level of tree_store. Note that this function only works with unsorted stores. Since 2.2

Mixins

__anonymous
mixin TreeModelT!(GtkTreeStore)
Undocumented in source.
__anonymous
mixin TreeDragSourceT!(GtkTreeStore)
Undocumented in source.
__anonymous
mixin TreeDragDestT!(GtkTreeStore)
Undocumented in source.
__anonymous
mixin TreeSortableT!(GtkTreeStore)
Undocumented in source.

Variables

gtkTreeStore
GtkTreeStore* gtkTreeStore;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

getObjectGStruct
GObject* getObjectGStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
Undocumented in source.
destroyNotify
void destroyNotify(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify
void toggleNotify(ObjectG obj, GObject* object, int isLastRef)
Undocumented in source. Be warned that the author may not have intended to support it.
~this
~this()
Undocumented in source.
getDObject
RT getDObject(U obj)

Gets a D Object from the objects table of associations.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, int value)
setProperty
void setProperty(string propertyName, string value)
setProperty
void setProperty(string propertyName, long value)
setProperty
void setProperty(string propertyName, ulong value)
unref
void unref()
Undocumented in source. Be warned that the author may not have intended to support it.
doref
ObjectG doref()
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
onNotifyListeners
void delegate(ParamSpec, ObjectG)[] onNotifyListeners;
Undocumented in source.
addOnNotify
void addOnNotify(void delegate(ParamSpec, ObjectG) dlg, ConnectFlags connectFlags)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value. This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the It is important to note that you must use canonical parameter names as detail strings for the notify signal. See Also GParamSpecObject, g_param_spec_object()

callBackNotify
void callBackNotify(GObject* gobjectStruct, GParamSpec* pspec, ObjectG _objectG)
Undocumented in source. Be warned that the author may not have intended to support it.
classInstallProperty
void classInstallProperty(GObjectClass* oclass, uint propertyId, ParamSpec pspec)

Installs a new property. This is usually done in the class initializer. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, e.g. to change the range of allowed values or the default value.

classInstallProperties
void classInstallProperties(GObjectClass* oclass, ParamSpec[] pspecs)

Installs new properties from an array of GParamSpecs. This is usually done in the class initializer. The property id of each property is the index of each GParamSpec in the pspecs array. The property id of 0 is treated specially by GObject and it should not be used to store a GParamSpec. This function should be used if you plan to use a static array of GParamSpecs and g_object_notify_by_pspec(). For instance, this Since 2.26

classFindProperty
ParamSpec classFindProperty(GObjectClass* oclass, string propertyName)

Looks up the GParamSpec for a property of a class.

classListProperties
ParamSpec[] classListProperties(GObjectClass* oclass)

Get an array of GParamSpec* for all properties of a class.

classOverrideProperty
void classOverrideProperty(GObjectClass* oclass, uint propertyId, string name)

Registers property_id as referring to a property with the name name in a parent class or in an interface implemented by oclass. This allows this class to override a property implementation in a parent class or to provide the implementation of a property from an interface. Note Internally, overriding is implemented by creating a property of type GParamSpecOverride; generally operations that query the properties of the object class, such as g_object_class_find_property() or g_object_class_list_properties() will return the overridden property. However, in one case, the construct_properties argument of the constructor virtual function, the GParamSpecOverride is passed instead, so that the param_id field of the GParamSpec will be correct. For virtually all uses, this makes no difference. If you need to get the overridden property, you can call g_param_spec_get_redirect_target(). Since 2.4

interfaceInstallProperty
void interfaceInstallProperty(void* iface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property. This function is meant to be called from the interface's default vtable initialization function (the class_init member of GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface. Since 2.4

interfaceFindProperty
ParamSpec interfaceFindProperty(void* iface, string propertyName)

Find the GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). Since 2.4

interfaceListProperties
ParamSpec[] interfaceListProperties(void* iface)

Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). Since 2.4

doref
void* doref(void* object)

Increases the reference count of object.

unref
void unref(void* object)

Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

refSink
void* refSink(void* object)

Increase the reference count of object, and possibly remove the floating reference, if object has a floating reference. In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one. Since 2.10

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a GObject. object_ptr must not be NULL. If the reference is NULL then this function does nothing. Otherwise, the reference count of the object is decreased and the pointer is set to NULL. This function is threadsafe and modifies the pointer atomically, using memory barriers where needed. A macro is also included that allows this function to be used without pointer casts. Since 2.28

isFloating
int isFloating(void* object)

Checks whether object has a floating reference. Since 2.10

forceFloating
void forceFloating()

This function is intended for GObject implementations to re-enforce a floating object reference. Doing this is seldomly required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). Since 2.10

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

addWeakPointer
void addWeakPointer(void** weakPointerLocation)

Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.

removeWeakPointer
void removeWeakPointer(void** weakPointerLocation)

Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established. This functionality is intended for binding object to a proxy object managed by another memory manager. This is done with two paired references: the strong reference added by g_object_add_toggle_ref() and a reverse reference to the proxy object which is either a strong reference or weak reference. The setup is that when there are no other references to object, only a weak reference is held in the reverse direction from object to the proxy object, but when there are other references held to object, a strong reference is held. The notify callback is called when the reference from object to the proxy object should be toggled from strong to weak (is_last_ref true) or weak to strong (is_last_ref false). Since a (normal) reference must be held to the object before calling g_object_toggle_ref(), the initial state of the reverse link is always strong. Multiple toggle references may be added to the same gobject, however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there is important state in the proxy object. Since 2.8

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one. Since 2.8

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object. This function omits the property name lookup, hence it is faster than g_object_notify(). One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with Since 2.26

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. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

thawNotify
void thawNotify()

Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, all queued "notify" signals are emitted. It is an error to call this function when the freeze count is zero.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

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. If the object already had an association with that name, the old association will be destroyed.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed. Note that the destroy callback is not called if data is NULL.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.

stealQdata
void* stealQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using g_value_init(). In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset(). Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get().

watchClosure
void watchClosure(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 g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles. This functions should only be called from object system implementations.

From TreeModelIF

getTreeModelTStruct
GtkTreeModel* getTreeModelTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

getValueString
string getValueString(TreeIter iter, int column)

Get the value of a column as a char array. this is the same calling getValue and get the string from the value object

getValueInt
int getValueInt(TreeIter iter, int column)

Get the value of a column as a char array. this is the same calling getValue and get the int from the value object

getIter
int getIter(TreeIter iter, TreePath path)

Sets iter to a valid iterator pointing to path.

getValue
Value getValue(TreeIter iter, int column, Value value)

Initializes and sets value to that at column. When done with value, g_value_unset() needs to be called to free any allocated memory.

onRowChangedListeners
void delegate(TreePath, TreeIter, TreeModelIF)[] onRowChangedListeners()
addOnRowChanged
void addOnRowChanged(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags)

This signal is emitted when a row in the model has changed.

onRowDeletedListeners
void delegate(TreePath, TreeModelIF)[] onRowDeletedListeners()
Undocumented in source.
addOnRowDeleted
void addOnRowDeleted(void delegate(TreePath, TreeModelIF) dlg, ConnectFlags connectFlags)

This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. This should be called by models after a row has been removed. The location pointed to by path should be the location that the row previously was at. It may not be a valid location anymore.

onRowHasChildToggledListeners
void delegate(TreePath, TreeIter, TreeModelIF)[] onRowHasChildToggledListeners()
Undocumented in source.
addOnRowHasChildToggled
void addOnRowHasChildToggled(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags)

This signal is emitted when a row has gotten the first child row or lost its last child row.

onRowInsertedListeners
void delegate(TreePath, TreeIter, TreeModelIF)[] onRowInsertedListeners()
Undocumented in source.
addOnRowInserted
void addOnRowInserted(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags)

This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values.

onRowsReorderedListeners
void delegate(TreePath, TreeIter, void*, TreeModelIF)[] onRowsReorderedListeners()
Undocumented in source.
addOnRowsReordered
void addOnRowsReordered(void delegate(TreePath, TreeIter, void*, TreeModelIF) dlg, ConnectFlags connectFlags)

This signal is emitted when the children of a node in the GtkTreeModel have been reordered. Note that this signal is not emitted when rows are reordered by DND, since this is implemented by removing and then reinserting the row. See Also GtkTreeView, GtkTreeStore, GtkListStore, GtkTreeDnd, GtkTreeSortable [4] Here, iter is short for “iterator”

getFlags
GtkTreeModelFlags getFlags()

Returns a set of flags supported by this interface. The flags are a bitwise combination of GtkTreeModelFlags. The flags supported should not change during the lifecycle of the tree_model.

getNColumns
int getNColumns()

Returns the number of columns supported by tree_model.

getColumnType
GType getColumnType(int index)

Returns the type of the column.

getIterFromString
int getIterFromString(TreeIter iter, string pathString)

Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned.

getIterFirst
int getIterFirst(TreeIter iter)

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.

getPath
TreePath getPath(TreeIter iter)

Returns a newly-created GtkTreePath referenced by iter. This path should be freed with gtk_tree_path_free().

iterNext
int iterNext(TreeIter iter)

Sets iter to point to the node following it at the current level. If there is no next iter, FALSE is returned and iter is set to be invalid.

iterChildren
int iterChildren(TreeIter iter, TreeIter parent)

Sets iter to point to the first child of parent. If parent has no children, FALSE is returned and iter is set to be invalid. parent will remain a valid node after this function has been called. If parent is NULL returns the first node, equivalent to gtk_tree_model_get_iter_first (tree_model, iter);

iterHasChild
int iterHasChild(TreeIter iter)

Returns TRUE if iter has children, FALSE otherwise.

iterNChildren
int iterNChildren(TreeIter iter)

Returns the number of children that iter has. As a special case, if iter is NULL, then the number of toplevel nodes is returned.

iterNthChild
int iterNthChild(TreeIter iter, TreeIter parent, int n)

Sets iter to be the child of parent, using the given index. The first index is 0. If n is too big, or parent has no children, iter is set to an invalid iterator and FALSE is returned. parent will remain a valid node after this function has been called. As a special case, if parent is NULL, then the nth root node is set.

iterParent
int iterParent(TreeIter iter, TreeIter child)

Sets iter to be the parent of child. If child is at the toplevel, and doesn't have a parent, then iter is set to an invalid iterator and FALSE is returned. child will remain a valid node after this function has been called.

getStringFromIter
string getStringFromIter(TreeIter iter)

Generates a string representation of the iter. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string. Since 2.2

refNode
void refNode(TreeIter iter)

Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let caching model know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get an iter independent of its reffed state.

unrefNode
void unrefNode(TreeIter iter)

Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see gtk_tree_model_ref_node(). Please note that nodes that are deleted are not unreffed.

getValist
void getValist(TreeIter iter, void* varArgs)

See gtk_tree_model_get(), this version takes a va_list for language bindings to use.

foreac
void foreac(GtkTreeModelForeachFunc func, void* userData)

Calls func on each node in model in a depth-first fashion. If func returns TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns.

rowChanged
void rowChanged(TreePath path, TreeIter iter)

Emits the "row-changed" signal on tree_model.

rowInserted
void rowInserted(TreePath path, TreeIter iter)

Emits the "row-inserted" signal on tree_model

rowHasChildToggled
void rowHasChildToggled(TreePath path, TreeIter iter)

Emits the "row-has-child-toggled" signal on tree_model. This should be called by models after the child state of a node changes.

rowDeleted
void rowDeleted(TreePath path)

Emits the "row-deleted" signal on tree_model. This should be called by models after a row has been removed. The location pointed to by path should be the location that the row previously was at. It may not be a valid location anymore.

rowsReordered
void rowsReordered(TreePath path, TreeIter iter, int[] newOrder)

Emits the "rows-reordered" signal on tree_model. This should be called by models when their rows have been reordered.

From TreeDragSourceIF

getTreeDragSourceTStruct
GtkTreeDragSource* getTreeDragSourceTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

dragDataDelete
int dragDataDelete(TreePath path)

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!

dragDataGet
int dragDataGet(TreePath path, GtkSelectionData* selectionData)

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!

rowDraggable
int rowDraggable(TreePath path)

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.

setRowDragData
int setRowDragData(GtkSelectionData* selectionData, TreeModelIF treeModel, TreePath path)

Sets selection data of target type GTK_TREE_MODEL_ROW. Normally used in a drag_data_get handler.

getRowDragData
int getRowDragData(GtkSelectionData* selectionData, TreeModelIF treeModel, TreePath path)

Obtains a tree_model and path from selection data of target type GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler. This function can only be used if selection_data originates from the same process that's calling this function, because a pointer to the tree model is being passed around. If you aren't in the same process, then you'll get memory corruption. In the GtkTreeDragDest drag_data_received handler, you can assume that selection data of type GTK_TREE_MODEL_ROW is in from the current process. The returned path must be freed with gtk_tree_path_free().

From TreeDragDestIF

getTreeDragDestTStruct
GtkTreeDragDest* getTreeDragDestTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

setRowDragData
int setRowDragData(GtkSelectionData* selectionData, TreeModelIF treeModel, TreePath path)

Sets selection data of target type GTK_TREE_MODEL_ROW. Normally used in a drag_data_get handler.

getRowDragData
int getRowDragData(GtkSelectionData* selectionData, GtkTreeModel** treeModel, GtkTreePath** path)

Obtains a tree_model and path from selection data of target type GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler. This function can only be used if selection_data originates from the same process that's calling this function, because a pointer to the tree model is being passed around. If you aren't in the same process, then you'll get memory corruption. In the GtkTreeDragDest drag_data_received handler, you can assume that selection data of type GTK_TREE_MODEL_ROW is in from the current process. The returned path must be freed with gtk_tree_path_free().

dragDataReceived
int dragDataReceived(TreePath dest, GtkSelectionData* selectionData)

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!

rowDropPossible
int rowDropPossible(TreePath destPath, GtkSelectionData* selectionData)

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.

From TreeSortableIF

getTreeSortableTStruct
GtkTreeSortable* getTreeSortableTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

onSortColumnChangedListeners
void delegate(TreeSortableIF)[] onSortColumnChangedListeners()
addOnSortColumnChanged
void addOnSortColumnChanged(void delegate(TreeSortableIF) dlg, ConnectFlags connectFlags)

The ::sort-column-changed signal is emitted when the sort column or sort order of sortable is changed. The signal is emitted before the contents of sortable are resorted. See Also GtkTreeModel, GtkTreeView

sortColumnChanged
void sortColumnChanged()

Emits a "sort-column-changed" signal on sortable.

getSortColumnId
int getSortColumnId(int sortColumnId, GtkSortType 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.

setSortColumnId
void setSortColumnId(int sortColumnId, GtkSortType order)

Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a "sort-column-changed" signal. sort_column_id may either be

setSortFunc
void setSortFunc(int sortColumnId, GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy)

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.

setDefaultSortFunc
void setDefaultSortFunc(GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy)

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. If sort_func is NULL, then there will be no default comparison function. This means that once the model has been sorted, it can't go back to the default state. In this case, when the current sort column id of sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.

hasDefaultSortFunc
int 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.

Meta