[700:7] extends: object
Generated low-level callback wrapper for GIR callback
row-has-child-toggled.
TreeModelRowhaschildtoggledCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, path, iter, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[557:7] extends: object
Generated low-level callback wrapper for GIR callback row-changed.
TreeModelRowchangedCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, path, iter, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[842:7] extends: object
Generated low-level callback wrapper for GIR callback rows-reordered.
TreeModelRowsreorderedCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, path, iter, new_order, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[117:7] extends: object
The tree interface used by GtkTreeView The GtkTreeModel interface defines a
generic tree interface for use by the GtkTreeView widget. It is an abstract
interface, and is designed to be usable with any appropriate data structure.
The programmer just has to implement this interface on their own data type
for it to be viewable by a GtkTreeView widget. The model is represented as
a hierarchical tree of strongly-typed, columned data. In other words, the
model can be seen as a tree where every node has different values depending
on which column is being queried. The type of data found in a column is
determined by using the GType system (ie. %G_TYPE_INT, %GTK_TYPE_BUTTON,
%G_TYPE_POINTER, etc). The types are homogeneous per column across all nodes.
It is important to note that this interface only provides a way of examining
a model and observing changes. The implementation of each individual model
decides how and if changes are made. In order to make life simpler for
programmers who do not need to write their own specialized model, two generic
models are provided — the GtkTreeStore and the GtkListStore. To use
these, the developer simply pushes data into these models as necessary. These
models provide the data structure as well as all appropriate tree interfaces.
As a result, implementing drag and drop, sorting, and storing data is
trivial. For the vast majority of trees and lists, these two models are
sufficient. Models are accessed on a node/column level of granularity. One
can query for the value of a model at a certain node and a certain column on
that node. There are two structures used to reference a particular node in a
model. They are the [struct@Gtk.TreePath] and the [struct@Gtk.TreeIter]
(“iter” is short for iterator). Most of the interface consists of operations
on a [struct@Gtk.TreeIter]. A path is essentially a potential node. It is a
location on a model that may or may not actually correspond to a node on a
specific model. A [struct@Gtk.TreePath] can be converted into either an array
of unsigned integers or a string. The string form is a list of numbers
separated by a colon. Each number refers to the offset at that level. Thus,
the path 0 refers to the root node and the path 2:4 refers to the fifth
child of the third node. By contrast, a [struct@Gtk.TreeIter] is a reference
to a specific node on a specific model. It is a generic struct with an
integer and three generic pointers. These are filled in by the model in a
model-specific way. One can convert a path to an iterator by calling
gtk_tree_model_get_iter(). These iterators are the primary way of accessing a
model and are similar to the iterators used by GtkTextBuffer. They are
generally statically allocated on the stack and only used for a short time.
The model interface defines a set of operations using them for navigating the
model. It is expected that models fill in the iterator with private data. For
example, the GtkListStore model, which is internally a simple linked list,
stores a list node in one of the pointers. The GtkTreeModelSort stores an
array and an offset in two of the pointers. Additionally, there is an integer
field. This field is generally filled with a unique stamp per model. This
stamp is for catching errors resulting from using invalid iterators with a
model. The lifecycle of an iterator can be a little confusing at first.
Iterators are expected to always be valid for as long as the model is
unchanged (and doesn’t emit a signal). The model is considered to own all
outstanding iterators and nothing needs to be done to free them from the
user’s point of view. Additionally, some models guarantee that an iterator is
valid for as long as the node it refers to is valid (most notably the
GtkTreeStore and GtkListStore). Although generally uninteresting, as one
always has to allow for the case where iterators do not persist beyond a
signal, some very important performance enhancements were made in the sort
model. As a result, the %GTK_TREE_MODEL_ITERS_PERSIST flag was added to
indicate this behavior. To help show some common operation of a model, some
examples are provided. The first example shows three ways of getting the iter
at the location 3:2:5. While the first method shown is easier, the second
is much more common, as you often get paths from callbacks. ## Acquiring a
GtkTreeIter c // Three ways of getting the iter pointing to the location GtkTreePath *path; GtkTreeIter iter; GtkTreeIter parent_iter; // get the iterator from a string gtk_tree_model_get_iter_from_string (model, &iter, "3:2:5"); // get the iterator from a path path = gtk_tree_path_new_from_string ("3:2:5"); gtk_tree_model_get_iter (model, &iter, path); gtk_tree_path_free (path); // walk the tree to find the iterator gtk_tree_model_iter_nth_child (model, &iter, NULL, 3); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 2); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 5); This second example shows a quick way of iterating
through a list and getting a string and an integer from each row. The
populate_model() function used below is not shown, as it is specific to the
GtkListStore. For information on how to write such a function, see the
GtkListStore documentation. ## Reading data from a GtkTreeModel c enum { STRING_COLUMN, INT_COLUMN, N_COLUMNS }; ... GtkTreeModel *list_store; GtkTreeIter iter; gboolean valid; int row_count = 0; // make a new list_store list_store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_INT); // Fill the list store with data populate_model (list_store); // Get the first iter in the list, check it is valid and walk // through the list, reading each row. valid = gtk_tree_model_get_iter_first (list_store, &iter); while (valid) { char *str_data; int int_data; // Make sure you terminate calls to gtk_tree_model_get() with a “-1” value gtk_tree_model_get (list_store, &iter, STRING_COLUMN, &str_data, INT_COLUMN, &int_data, -1); // Do something with the data g_print ("Row %d: (%s,%d)\n", row_count, str_data, int_data); g_free (str_data); valid = gtk_tree_model_iter_next (list_store, &iter); row_count++; } The GtkTreeModel interface contains two methods for
reference counting: gtk_tree_model_ref_node() and
gtk_tree_model_unref_node(). These two methods are optional to implement. The
reference counting is meant as a way for views to let models know when nodes
are being displayed. GtkTreeView will take a reference on a node when it is
visible, which means the node is either in the toplevel or expanded. Being
displayed does not mean that the node is currently directly visible to the
user in the viewport. Based on this reference counting scheme a caching
model, for example, can decide whether or not to cache a node based on the
reference count. A file-system based model would not want to keep the entire
file hierarchy in memory, but just the folders that are currently expanded in
every current view. When working with reference counting, the following rules
must be taken into account: - Never take a reference on a node without owning
a reference on its parent. This means that all parent nodes of a referenced
node must be referenced as well. - Outstanding references on a deleted node
are not released. This is not possible because the node has already been
deleted by the time the row-deleted signal is received. - Models are not
obligated to emit a signal on rows of which none of its siblings are
referenced. To phrase this differently, signals are only required for levels
in which nodes are referenced. For the root level however, signals must be
emitted at all times (however the root level is always referenced when any
view is attached).
TreeModel (Handle = null)
Creates a new
TreeModelby wrapping a native handle or another wrapper.
Handle is the native handle or another wrapper whose handle to adopt.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.connectSignal (string Name, CallbackObj)
Connects one generated callback wrapper to a named signal.
Name is the signal name.CallbackObj is the generated callback wrapper to connect.The connected handler id.disconnectSignalHandler (int HandlerId)
Disconnects one retained signal handler id.
HandlerId is the signal handler id to disconnect.None.setOnRowchanged (callback Fn, UserData = null)
This signal is emitted when a row in the model has changed.
Fn is the Aussom callback.Fn is called with (TreeModel Self, TreePath Path, object Iter).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnRowdeleted (callback Fn, UserData = null)
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.
Fn is the Aussom callback.Fn is called with (TreeModel Self, TreePath Path).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnRowhaschildtoggled (callback Fn, UserData = null)
This signal is emitted when a row has gotten the first child row or lost its last child row.
Fn is the Aussom callback.Fn is called with (TreeModel Self, TreePath Path, object Iter).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnRowinserted (callback Fn, UserData = null)
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.
Fn is the Aussom callback.Fn is called with (TreeModel Self, TreePath Path, object Iter).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnRowsreordered (callback Fn, UserData = null)
This signal is emitted when the children of a node in the
GtkTreeModelhave 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.
Fn is the Aussom callback.Fn is called with (TreeModel Self, TreePath Path, object Iter, object New_order).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.filter_new (object root)
Creates a new
GtkTreeModel, with @child_model as the child_model and
as the virtual root.root is A GtkTreePath.get_flags ()
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 lifetime of the @tree_model.
get_n_columns ()
Returns the number of columns supported by @tree_model.
get_path (iter)
Returns a newly-created
GtkTreePathreferenced by @iter. This path should be freed with gtk_tree_path_free().
iter is the GtkTreeIter.get_string_from_iter (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.
iter is a GtkTreeIter.iter_has_child (iter)
Returns %TRUE if @iter has children, %FALSE otherwise.
iter is the GtkTreeIter to test for children.iter_n_children (iter)
Returns the number of children that @iter has. As a special case, if
is %NULL, then the number of toplevel nodes is returned.iter is the GtkTreeIter.iter_next (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.
iter is the GtkTreeIter.iter_previous (iter)
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.
iter is the GtkTreeIter.ref_node (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 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.
iter is the GtkTreeIter.None.row_changed (object path, iter)
Emits the ::row-changed signal on @tree_model. See [signal@Gtk.TreeModel::row-changed].
path is a GtkTreePath pointing to the changed row.iter is a valid GtkTreeIter pointing to the changed row.None.row_deleted (object path)
Emits the ::row-deleted signal on @tree_model. See [signal@Gtk.TreeModel::row-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. Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.
path is a GtkTreePath pointing to the previous location of the deleted row.None.row_has_child_toggled (object path, iter)
Emits the ::row-has-child-toggled signal on @tree_model. See [signal@Gtk.TreeModel::row-has-child-toggled]. This should be called by models after the child state of a node changes.
path is a GtkTreePath pointing to the changed row.iter is a valid GtkTreeIter pointing to the changed row.None.row_inserted (object path, iter)
Emits the ::row-inserted signal on @tree_model. See [signal@Gtk.TreeModel::row-inserted].
path is a GtkTreePath pointing to the inserted row.iter is a valid GtkTreeIter pointing to the inserted row.None.rows_reordered (object path, iter, int new_order)
Emits the ::rows-reordered signal on @tree_model. See [signal@Gtk.TreeModel::rows-reordered]. This should be called by models when their rows have been reordered.
path is a GtkTreePath pointing to the tree node whose children have been reordered.iter is a valid GtkTreeIter pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0.new_order is an array of integers mapping the current position of each child to its old position before the re-ordering, i.e.[newpos]** = oldpos.None.rows_reordered_with_length (object path, iter, int length)
Emits the ::rows-reordered signal on @tree_model. See [signal@Gtk.TreeModel::rows-reordered]. This should be called by models when their rows have been reordered.
path is a GtkTreePath pointing to the tree node whose children have been reordered.iter is a valid GtkTreeIter pointing to the node whose children have been reordered, or %NULL if the depth of @path is 0.new_order is an array of integers mapping the current position of each child to its old position before the re-ordering, i.e.[newpos]** = oldpos.length is length of @new_order array.None.unref_node (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.
iter is the GtkTreeIter.None.[628:7] extends: object
Generated low-level callback wrapper for GIR callback row-deleted.
TreeModelRowdeletedCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, path, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[913:14] static extends: object
Generated metadata helpers for TreeModel interface surfaces.
signals ()
Returns signal metadata for
TreeModel.
A list.[771:7] extends: object
Generated low-level callback wrapper for GIR callback row-inserted.
TreeModelRowinsertedCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, path, iter, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
