Back to Seed Clases

Gtk


Classes

Interfaces

Structs

Unions

Enums

Interface Gtk.TreeModel

Import line: Gtk = imports.gi.Gtk;
GIR File: Gtk-3.0.gir
C documentation: GtkTreeModel
Interface : TreeModel
Implementations: Gtk.ListStore, Gtk.TreeModelFilter, Gtk.TreeModelSort, Gtk.TreeStore
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 GtkTreePath and the
GtkTreeIterHere, iter is short
for iterator
. Most of the interface
consists of operations on a GtkTreeIter.
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. The GtkTreePath struct 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 GtkTreeIter 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 <structname>GtkTreeIter</structname>

/* 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 <structname>GtkTreeModel</structname>

enum
{
STRING_COLUMN,
INT_COLUMN,
N_COLUMNS
};
...
GtkTreeModel *list_store;
GtkTreeIter iter;
gboolean valid;
gint 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 */
valid = gtk_tree_model_get_iter_first (list_store, &iter);
while (valid)
{
/* Walk through the list, reading each row */
gchar *str_data;
gint 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_free (str_data);
row_count++;
valid = gtk_tree_model_iter_next (list_store, &iter);
}

Properties
None
Methods / Constructors
Method / Constructor Defined By
Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event Defined By
Used by These Methods / Signals / Properties
Class / Namespace Method / Signal / Properties
EvinceDocument.DocumentFonts
Method
fill_model (TreeModel model) : none
GnomeBluetooth.Client
Method
get_adapter_model () : Gtk.TreeModel
GnomeBluetooth.Client
Method
get_device_filter_model (Proxy adapter, Function func, void* data, Function destroy) : Gtk.TreeModel
GnomeBluetooth.Client
Method
get_device_model (Proxy adapter) : Gtk.TreeModel
GnomeBluetooth.Client
Method
get_filter_model (Function func, void* data, Function destroy) : Gtk.TreeModel
GnomeBluetooth.Client
Method
get_model () : Gtk.TreeModel
Gtk
Method
Gtk.tree_set_row_drag_data (SelectionData selection_data, TreeModel tree_model, TreePath path) : gboolean
Sets selection data of target type GTK_TREE_MODEL_ROW.
Gtk.CellArea
Signal
apply_attributes (CellArea self, TreeModel model, TreeIter iter, gboolean is_expander, gboolean is_expanded) : none
This signal is emitted whenever applying attributes to area from model
Gtk.CellArea
Method
apply_attributes (TreeModel tree_model, TreeIter iter, gboolean is_expander, gboolean is_expanded) : none
Applies any connected attributes to the renderers in
Gtk.CellRendererCombo
Property
model : Gtk.TreeModel
Holds a tree model containing the possible values for the combo box.
Gtk.CellView
Property
model : Gtk.TreeModel
The model for cell view
since 2.10
Gtk.CellView
Method
get_model () : Gtk.TreeModel
Returns the model for cell_view.
Gtk.CellView
Method
set_model (TreeModel model) : none
Sets the model for cell_view.
Gtk.ComboBox
Property
model : Gtk.TreeModel
The model from which the combo box takes the values shown
in the list.
Gtk.ComboBox
Method
new Gtk.ComboBox.with_model (TreeModel model) : Gtk.Widget
Create a new Gtk.ComboBox
Gtk.ComboBox
Method
new Gtk.ComboBox.with_model_and_entry (TreeModel model) : Gtk.Widget
Create a new Gtk.ComboBox
Gtk.ComboBox
Method
get_model () : Gtk.TreeModel
Returns the GtkTreeModel which is acting as data source for combo_box.
Gtk.ComboBox
Method
set_model (TreeModel model) : none
Sets the model used by combo_box to be model.
Gtk.EntryCompletion
Property
model : Gtk.TreeModel
Gtk.EntryCompletion
Signal
cursor_on_match (EntryCompletion self, TreeModel model, TreeIter iter) : gboolean
Gets emitted when a match from the cursor is on a match
of the list.
Gtk.EntryCompletion
Signal
match_selected (EntryCompletion self, TreeModel model, TreeIter iter) : gboolean
Gets emitted when a match from the list is selected.
Gtk.EntryCompletion
Method
get_model () : Gtk.TreeModel
Returns the model the GtkEntryCompletion is using as data source.
Gtk.EntryCompletion
Method
set_model (TreeModel model) : none
Sets the model for a GtkEntryCompletion.
Gtk.IconView
Property
model : Gtk.TreeModel
Gtk.IconView
Method
new Gtk.IconView.with_model (TreeModel model) : Gtk.Widget
Create a new Gtk.IconView
Gtk.IconView
Method
get_model () : Gtk.TreeModel
Returns the model the GtkIconView is based on.
Gtk.IconView
Method
set_model (TreeModel model) : none
Sets the model for a GtkIconView.
Gtk.TreeModelFilter
Property
child_model : Gtk.TreeModel
Gtk.TreeModelFilter
Method
get_model () : Gtk.TreeModel
Returns a pointer to the child model of filter.
Gtk.TreeModelSort
Property
model : Gtk.TreeModel
Gtk.TreeModelSort
Method
get_model () : Gtk.TreeModel
Returns the model the GtkTreeModelSort is sorting.
Gtk.TreeRowReference
Method
new Gtk.TreeRowReference.c_new (TreeModel model, TreePath path) : Gtk.TreeRowReference
Create a new Gtk.TreeRowReference
Gtk.TreeRowReference
Method
new Gtk.TreeRowReference.proxy (Object proxy, TreeModel model, TreePath path) : Gtk.TreeRowReference
Create a new Gtk.TreeRowReference
Gtk.TreeRowReference
Method
get_model () : Gtk.TreeModel
Returns the model that the row reference is monitoring.
Gtk.TreeView
Property
model : Gtk.TreeModel
Gtk.TreeView
Method
new Gtk.TreeView.with_model (TreeModel model) : Gtk.Widget
Create a new Gtk.TreeView
Gtk.TreeView
Method
get_model () : Gtk.TreeModel
Returns the model the GtkTreeView is based on.
Gtk.TreeView
Method
set_model (TreeModel model) : none
Sets the model for a GtkTreeView.
Gtk.TreeViewColumn
Method
cell_set_cell_data (TreeModel tree_model, TreeIter iter, gboolean is_expander, gboolean is_expanded) : none
Sets the cell renderer based on the tree_model and iter.
Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:14:45 GMT+0800 (HKT)