Optionalproperties: Partial<Gtk.TreeStore.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeAppends 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().
Optionalparent: Gtk.TreeIterA valid Gtk.TreeIter, or null
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
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.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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 the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Removes all rows from tree_store
SignalconnectSignalconnect_Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
the constructed child
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
true if a object has a custom implementation, false if it doesn't.
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
Asks the Gtk.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!
true if the row was successfully deleted
Asks the Gtk.TreeDragSource 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!
row that was dragged
a Gtk.SelectionData to fill with data from the dragged row
true if data of the required type was provided
Asks the Gtk.TreeDragDest 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!
row to drop in front of
data to drop
whether a new row was created before position dest
SignalemitCreates a new Gtk.TreeModel, with child_model as the child_model
and root as the virtual root.
Optionalroot: Gtk.TreePathA Gtk.TreePath or null.
A new Gtk.TreeModel.
This function is intended for GObject.Object implementations to re-enforce
a floating object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
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.
a function to be called on each row
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.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Returns the type of the column.
the column index
the type of the column
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Returns a set of flags supported by this interface.
The flags are a bitwise combination of Gtk.TreeModelFlags.
The flags supported should not change during the lifetime
of the tree_model.
the 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.
the Gtk.TreePath-struct
true, if iter was set
Sets iter to a valid iterator pointing to path_string, if it
exists. Otherwise, iter is left invalid and false is returned.
a string representation of a Gtk.TreePath-struct
true, if iter was set
Returns the number of columns supported by tree_model.
the number of columns
Gets the name of the buildable object.
Gtk.Builder sets the name based on the
[GtkBuilder UI definition][BUILDER-UI]
used to construct the buildable.
the name set with gtk_buildable_set_name()
Returns a newly-created Gtk.TreePath-struct referenced by iter.
This path should be freed with gtk_tree_path_free().
the Gtk.TreeIter-struct
a newly-created Gtk.TreePath-struct
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
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.
true if the sort column is not one of the special sort column ids.
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.
a Gtk.TreeIter-struct
a newly-allocated string. Must be freed with g_free().
Initializes and sets value to that at column.
When done with value, g_value_unset() needs to be called
to free any allocated memory.
the Gtk.TreeIter-struct
the column to lookup the value at
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.
the names of each property to get
the values of each property to get
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.
true, if the model has a default sort function
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 -1 or 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().
A valid Gtk.TreeIter, or null
position to insert the new row, or -1 for last
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().
Optionalparent: Gtk.TreeIterA valid Gtk.TreeIter, or null
Optionalsibling: Gtk.TreeIterA valid Gtk.TreeIter, or null
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().
Optionalparent: Gtk.TreeIterA valid Gtk.TreeIter, or null
Optionalsibling: Gtk.TreeIterA valid Gtk.TreeIter, or null
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.
A valid Gtk.TreeIter, or null
position to insert the new row, or -1 for last
an array of column numbers
an array of GValues
Returns true if iter is an ancestor of descendant. That is, iter is the
parent (or grandparent or great-grandparent) of descendant.
A valid Gtk.TreeIter
A valid Gtk.TreeIter
true, if iter is an ancestor of descendant
Checks whether object has a floating reference.
true if object has a floating reference
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);
Optionalparent: Gtk.TreeIterthe Gtk.TreeIter-struct, or null
true, if iter has been set to the first child
Returns the depth of iter. This will be 0 for anything on the root level, 1
for anything down a level, etc.
A valid Gtk.TreeIter
The depth of iter
Returns true if iter has children, false otherwise.
the Gtk.TreeIter-struct to test for children
true if iter has children
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 Gtk.TreeStore.
A Gtk.TreeIter.
true if the iter is valid, false if the iter is invalid.
Returns the number of children that iter has.
As a special case, if iter is null, then the number
of toplevel nodes is returned.
Optionaliter: Gtk.TreeIterthe Gtk.TreeIter-struct, or null
the number of children of 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.
the Gtk.TreeIter-struct
true if iter has been changed to the next node
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 n-th root node
is set.
the Gtk.TreeIter-struct to get the child from, or null.
the index of the desired child
true, if parent has an n-th 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.
iter will be initialized before the lookup is performed, so child
and iter cannot point to the same memory location.
the Gtk.TreeIter-struct
true, if iter is set to the parent of child
Sets iter to point to the previous node at the current level.
If there is no previous iter, false is returned and iter is
set to be invalid.
the Gtk.TreeIter-struct
true if iter has been changed to the previous node
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.
A Gtk.TreeIter.
Optionalposition: Gtk.TreeIterA Gtk.TreeIter.
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.
A Gtk.TreeIter.
Optionalposition: Gtk.TreeIterA Gtk.TreeIter or null.
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.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
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
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
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().
Optionalparent: Gtk.TreeIterA valid Gtk.TreeIter, or null
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
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 models know when nodes are being displayed (and hence, whether or not to cache that node). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. 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.
the Gtk.TreeIter-struct
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 GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
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.
A valid Gtk.TreeIter
true if iter is still valid, false if not.
Emits the Gtk.TreeModel.SignalSignatures.row_changed | Gtk.TreeModel::row-changed signal on tree_model.
a Gtk.TreePath-struct pointing to the changed row
a valid Gtk.TreeIter-struct pointing to the changed row
Emits the Gtk.TreeModel.SignalSignatures.row_deleted | Gtk.TreeModel::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.
Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.
a Gtk.TreePath-struct pointing to the previous location of the deleted row
Asks the Gtk.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.
true if the row can be dragged
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.
destination row
the data being dragged
true if a drop is possible before dest_path
Emits the Gtk.TreeModel.SignalSignatures.row_has_child_toggled | Gtk.TreeModel::row-has-child-toggled signal on
tree_model. This should be called by models after the child
state of a node changes.
a Gtk.TreePath-struct pointing to the changed row
a valid Gtk.TreeIter-struct pointing to the changed row
Emits the Gtk.TreeModel.SignalSignatures.row_inserted | Gtk.TreeModel::row-inserted signal on tree_model.
a Gtk.TreePath-struct pointing to the inserted row
a valid Gtk.TreeIter-struct pointing to the inserted row
Emits the Gtk.TreeModel.SignalSignatures.rows_reordered | Gtk.TreeModel::rows-reordered signal on tree_model.
This should be called by models when their rows have been reordered.
a Gtk.TreePath-struct pointing to the tree node whose children have been reordered
a valid Gtk.TreeIter-struct pointing to the node whose children have been reordered, or null if the depth of path is 0
an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. new_order``[newpos] = oldpos
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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.
A valid Gtk.TreeIter for the row being modified
an array of column numbers
an array of GValues
This function is meant primarily for GObjects that inherit from
Gtk.TreeStore, and should only be used when constructing a new
Gtk.TreeStore. It will not function after a row has been added,
or a method on the Gtk.TreeModel interface is called.
An array of GObject.GType types, one for each column
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.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
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.
The comparison function
Optionaldestroy: DestroyNotifyDestroy notifier of user_data, or null
Sets the name of the buildable object.
name to set
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets the current sort column to be sort_column_id. The sortable will
resort itself to reflect this change, after emitting a
Gtk.TreeSortable.SignalSignatures.sort_column_changed | Gtk.TreeSortable::sort-column-changed signal. sort_column_id may either be
a regular column id, or one of the following special values:
GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function
will be used, if it is set
GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur
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.
the sort column id to set the function for
The comparison function
Optionaldestroy: DestroyNotifyDestroy notifier of user_data, or null
Sets the data in the cell specified by iter and column.
The type of value must be convertible to the type of the
column.
A valid Gtk.TreeIter for the row being modified
column number to modify
new value for the cell
Emits a Gtk.TreeSortable.SignalSignatures.sort_column_changed | Gtk.TreeSortable::sort-column-changed signal on sortable.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
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
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Swaps a and b in the same level of tree_store. Note that this function
only works with unsorted stores.
A Gtk.TreeIter.
Another Gtk.TreeIter.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
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.
the Gtk.TreeIter-struct
Virtualvfunc_Virtualvfunc_Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
Virtualvfunc_This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_Asks the Gtk.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!
Virtualvfunc_Asks the Gtk.TreeDragSource 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!
row that was dragged
a Gtk.SelectionData to fill with data from the dragged row
Virtualvfunc_Asks the Gtk.TreeDragDest 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!
row to drop in front of
data to drop
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Returns a set of flags supported by this interface.
The flags are a bitwise combination of Gtk.TreeModelFlags.
The flags supported should not change during the lifetime
of the tree_model.
Virtualvfunc_Virtualvfunc_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.
the Gtk.TreePath-struct
Virtualvfunc_Returns the number of columns supported by tree_model.
Virtualvfunc_Gets the name of the buildable object.
Gtk.Builder sets the name based on the
[GtkBuilder UI definition][BUILDER-UI]
used to construct the buildable.
Virtualvfunc_Returns a newly-created Gtk.TreePath-struct referenced by iter.
This path should be freed with gtk_tree_path_free().
the Gtk.TreeIter-struct
Virtualvfunc_Virtualvfunc_Virtualvfunc_Initializes and sets value to that at column.
When done with value, g_value_unset() needs to be called
to free any allocated memory.
the Gtk.TreeIter-struct
the column to lookup the value at
Virtualvfunc_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.
Virtualvfunc_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);
Optionalparent: Gtk.TreeIterthe Gtk.TreeIter-struct, or null
Virtualvfunc_Returns true if iter has children, false otherwise.
the Gtk.TreeIter-struct to test for children
Virtualvfunc_Returns the number of children that iter has.
As a special case, if iter is null, then the number
of toplevel nodes is returned.
Optionaliter: Gtk.TreeIterthe Gtk.TreeIter-struct, or null
Virtualvfunc_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.
the Gtk.TreeIter-struct
Virtualvfunc_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 n-th root node
is set.
the Gtk.TreeIter-struct to get the child from, or null.
the index of the desired child
Virtualvfunc_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.
iter will be initialized before the lookup is performed, so child
and iter cannot point to the same memory location.
the Gtk.TreeIter-struct
Virtualvfunc_Sets iter to point to the previous node at the current level.
If there is no previous iter, false is returned and iter is
set to be invalid.
the Gtk.TreeIter-struct
Virtualvfunc_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.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Virtualvfunc_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 models know when nodes are being displayed (and hence, whether or not to cache that node). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. 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.
the Gtk.TreeIter-struct
Virtualvfunc_Emits the Gtk.TreeModel.SignalSignatures.row_changed | Gtk.TreeModel::row-changed signal on tree_model.
a Gtk.TreePath-struct pointing to the changed row
a valid Gtk.TreeIter-struct pointing to the changed row
Virtualvfunc_Emits the Gtk.TreeModel.SignalSignatures.row_deleted | Gtk.TreeModel::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.
Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.
a Gtk.TreePath-struct pointing to the previous location of the deleted row
Virtualvfunc_Asks the Gtk.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.
Virtualvfunc_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.
destination row
the data being dragged
Virtualvfunc_Emits the Gtk.TreeModel.SignalSignatures.row_has_child_toggled | Gtk.TreeModel::row-has-child-toggled signal on
tree_model. This should be called by models after the child
state of a node changes.
a Gtk.TreePath-struct pointing to the changed row
a valid Gtk.TreeIter-struct pointing to the changed row
Virtualvfunc_Emits the Gtk.TreeModel.SignalSignatures.row_inserted | Gtk.TreeModel::row-inserted signal on tree_model.
a Gtk.TreePath-struct pointing to the inserted row
a valid Gtk.TreeIter-struct pointing to the inserted row
Virtualvfunc_Virtualvfunc_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.
The comparison function
Optionaldestroy: DestroyNotifyDestroy notifier of user_data, or null
Virtualvfunc_Sets the name of the buildable object.
name to set
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_Sets the current sort column to be sort_column_id. The sortable will
resort itself to reflect this change, after emitting a
Gtk.TreeSortable.SignalSignatures.sort_column_changed | Gtk.TreeSortable::sort-column-changed signal. sort_column_id may either be
a regular column id, or one of the following special values:
GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function
will be used, if it is set
GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur
Virtualvfunc_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.
the sort column id to set the function for
The comparison function
Optionaldestroy: DestroyNotifyDestroy notifier of user_data, or null
Virtualvfunc_Emits a Gtk.TreeSortable.SignalSignatures.sort_column_changed | Gtk.TreeSortable::sort-column-changed signal on sortable.
Virtualvfunc_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.
the Gtk.TreeIter-struct
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.
GObject.Closure to watch
StaticnewStatic_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec 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().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_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 GObject.ParamSpec, 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
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_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().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
The Gtk.TreeStore object is a list model for use with a Gtk.TreeView widget. It implements the Gtk.TreeModel interface, and consequentially, can use all of the methods available there. It also implements the Gtk.TreeSortable interface so it can be sorted by the view. Finally, it also implements the tree [drag and drop][gtk3-GtkTreeView-drag-and-drop] interfaces.
GtkTreeStore as GtkBuildable
The GtkTreeStore implementation of the Gtk.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: