![]() |
![]() |
It is 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 Gtk::TreeView 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 TreeModel::Column<> templates. 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 Gtk::TreeStore and the Gtk::ListStore. 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 Path and the iterator. Most of the interface consists of operations on an iterator.
A Gtk::TreeModel::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.
By contrast, an Gtk::TreeModel::iterator is a reference to a specific node on a specific model. One can convert a path to an iterator by calling Gtk::TreeModel::get_iter(). These iterators are the primary way of accessing a model and are similar to the iterators used by Gtk::TextBuffer. The model interface defines a set of operations using them for navigating the model.
The RowReference is also useful, because it remains valid as long as there is an existing row pointed to by it's path. You can convert between RowReferences and iterators and Path s.
Public Types | |
typedef TreeNodeChildren | Children |
typedef TreeModelColumnRecord | ColumnRecord |
typedef Children::const_iterator | const_iterator |
typedef Children::const_reverse_iterator | const_reverse_iterator |
typedef Children::iterator | iterator |
typedef TreePath | Path |
typedef Children::reverse_iterator | reverse_iterator |
typedef TreeRow | Row |
typedef TreeRowReference | RowReference |
typedef sigc::slot< bool, const TreeModel::iterator& > | SlotForeachIter |
For example, void on_foreach(const Gtk::TreeModel::iterator& iter);. | |
typedef sigc::slot< bool, const TreeModel::Path& > | SlotForeachPath |
For example, void on_foreach(const Gtk::TreeModel::Path& path);. | |
typedef sigc::slot< bool, const TreeModel::Path&, const TreeModel::iterator& > | SlotForeachPathAndIter |
For example, void on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter);. | |
Public Member Functions | |
Children | children () const |
This returns an STL-like container API, for iterating over the rows. | |
Children | children () |
This returns an STL-like container API, for iterating over the rows. | |
void | foreach (const SlotForeachPathAndIter& slot) |
Calls a callback slot on each node in the model in a depth-first fashion. | |
void | foreach_iter (const SlotForeachIter& slot) |
Calls a callback slot on each node in the model in a depth-first fashion. | |
void | foreach_path (const SlotForeachPath& slot) |
Calls a callback slot on each node in the model in a depth-first fashion. | |
GType | get_column_type (int index) const |
Returns the type of the column. | |
TreeModelFlags | get_flags () const |
Returns a set of flags supported by this interface. | |
iterator | get_iter (const Glib::ustring& path_string) |
Returns a valid iterator pointing to path_string. | |
iterator | get_iter (const Path& path) |
Returns a valid iterator pointing to path. | |
int | get_n_columns () const |
Returns the number of columns supported by tree_model . | |
TreeModel::Path | get_path (const iterator& iter) const |
Returns a Gtk::TreePath referenced by iter . | |
Glib::ustring | get_string (const iterator& iter) const |
Generates a string representation of the iter. | |
const GtkTreeModel* | gobj () const |
Provides access to the underlying C GObject. | |
GtkTreeModel* | gobj () |
Provides access to the underlying C GObject. | |
void | row_changed (const Path& path, const iterator& iter) |
Emits the "row_changed" signal on tree_model . | |
void | row_deleted (const Path& path) |
Emits the "row_deleted" signal on tree_model . | |
void | row_has_child_toggled (const Path& path, const iterator& iter) |
Emits the "row_has_child_toggled" signal on tree_model . | |
void | row_inserted (const Path& path, const iterator& iter) |
Emits the "row_inserted" signal on tree_model. | |
void | rows_reordered (const Path& path, const iterator& iter, int* new_order) |
Emits the "rows_reordered" signal on tree_model . | |
void | rows_reordered (const Path& path, const iterator& iter, const Glib::ArrayHandle<int>& new_order) |
Glib::SignalProxy2< void, const TreeModel::Path&, const TreeModel::iterator& > | signal_row_changed () |
Glib::SignalProxy1< void, const TreeModel::Path& > | signal_row_deleted () |
Glib::SignalProxy2< void, const TreeModel::Path&, const TreeModel::iterator& > | signal_row_has_child_toggled () |
Glib::SignalProxy2< void, const TreeModel::Path&, const TreeModel::iterator& > | signal_row_inserted () |
Glib::SignalProxy3< void, const TreeModel::Path&, const TreeModel::iterator&, int* > | signal_rows_reordered () |
virtual | ~TreeModel () |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
Protected Member Functions | |
virtual GType | get_column_type_vfunc (int index) const |
virtual TreeModelFlags | get_flags_vfunc () const |
virtual bool | get_iter_vfunc (const Path& path, iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual int | get_n_columns_vfunc () const |
virtual TreeModel::Path | get_path_vfunc (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual void | get_value_impl (const iterator& row, int column, Glib::ValueBase& value) const |
virtual void | get_value_vfunc (const iterator& iter, int column, Glib::ValueBase& value) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_children_vfunc (const iterator& parent, iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_has_child_vfunc (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_is_valid (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual int | iter_n_children_vfunc (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual int | iter_n_root_children_vfunc () const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_next_vfunc (const iterator& iter, iterator& iter_next) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_nth_child_vfunc (const iterator& parent, int n, iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_nth_root_child_vfunc (int n, iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual bool | iter_parent_vfunc (const iterator& child, iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual void | on_row_changed (const TreeModel::Path& path, const TreeModel::iterator& iter) |
virtual void | on_row_deleted (const TreeModel::Path& path) |
virtual void | on_row_has_child_toggled (const TreeModel::Path& path, const TreeModel::iterator& iter) |
virtual void | on_row_inserted (const TreeModel::Path& path, const TreeModel::iterator& iter) |
virtual void | on_rows_reordered (const TreeModel::Path& path, const TreeModel::iterator& iter, int* new_order) |
virtual void | ref_node_vfunc (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
virtual void | set_value_impl (const iterator& row, int column, const Glib::ValueBase& value) |
Override and implement this in a derived TreeModel class, so that Row::operator() and Row::set_value() work. | |
virtual void | unref_node_vfunc (const iterator& iter) const |
Override and implement this in a derived TreeModel class. | |
Friends | |
class | Gtk::TreeIter |
class | Gtk::TreeModelSort |
class | Gtk::TreeRow |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr<Gtk::TreeModel> | wrap (GtkTreeModel* object, bool take_copy=false) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For example, void on_foreach(const Gtk::TreeModel::iterator& iter);. If the callback function returns true, then the tree ceases to be walked, and foreach() returns. |
|
For example, void on_foreach(const Gtk::TreeModel::Path& path);. If the callback function returns true, then the tree ceases to be walked, and foreach() returns. |
|
For example, void on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter);. If the callback function returns true, then the tree ceases to be walked, and foreach() returns. |
|
|
|
|
|
This returns an STL-like container API, for iterating over the rows.
|
|
This returns an STL-like container API, for iterating over the rows.
|
|
Calls a callback slot on each node in the model in a depth-first fashion. If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
|
|
Calls a callback slot on each node in the model in a depth-first fashion. If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
|
|
Calls a callback slot on each node in the model in a depth-first fashion. If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
|
|
Returns the type of the column.
|
|
|
|
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 lifecycle of the tree_model.
|
|
|
|
Returns a valid iterator pointing to path_string.
|
|
Returns a valid iterator pointing to path.
|
|
Override and implement this in a derived TreeModel class. Sets iter to a valid iterator pointing to path
|
|
Returns the number of columns supported by tree_model .
|
|
|
|
Returns a Gtk::TreePath referenced by iter .
|
|
Override and implement this in a derived TreeModel class. Returns a Path referenced by 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. newin2p2
|
|
|
|
Override and implement this in a derived TreeModel class. Initializes and sets value to that at column.
|
|
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface. Reimplemented in Gtk::ListStore, Gtk::TreeModelFilter, Gtk::TreeModelSort, and Gtk::TreeStore. |
|
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface. Reimplemented in Gtk::ListStore, Gtk::TreeModelFilter, Gtk::TreeModelSort, and Gtk::TreeStore. |
|
Override and implement this in a derived TreeModel class. Sets iter to refer to the first child of parent. If parent has no children, false is returned and iter is set to be invalid.
|
|
Override and implement this in a derived TreeModel class. Returns true if iter has children, false otherwise.
|
|
Override and implement this in a derived TreeModel class.
|
|
Override and implement this in a derived TreeModel class. Returns the number of children that iter has. See also iter_n_root_children_vfunc().
|
|
Override and implement this in a derived TreeModel class. Returns the number of toplevel nodes. See also iter_n_children().
|
|
Override and implement this in a derived TreeModel class. Sets iter_next to refer to the node following iter it at the current level. If there is no next iter, false is returned and iter_next is set to be invalid.
|
|
Override and implement this in a derived TreeModel class. 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. See also iter_nth_root_child_vfunc()
|
|
Override and implement this in a derived TreeModel class. Sets iter to be the child of at the root level using the given index. The first index is 0. If n is too big, or if there are no children, iter is set to an invalid iterator and false is returned. See also iter_nth_child_vfunc().
|
|
Override and implement this in a derived TreeModel class. 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.
|
|
|
|
|
|
|
|
|
|
|
|
Override and implement this in a derived TreeModel class. 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.
|
|
Emits the "row_changed" signal on tree_model .
|
|
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.
|
|
Emits the "row_has_child_toggled" signal on tree_model . This should be called by models after the child state of a node changes.
|
|
Emits the "row_inserted" signal on tree_model.
|
|
Emits the "rows_reordered" signal on tree_model . This should be called by models when their rows have been reordered.
|
|
|
|
Override and implement this in a derived TreeModel class, so that Row::operator() and Row::set_value() work. You can probably just implement this by calling set_value_vfunc(). Your implementation of set_value_impl() should also call set_row_changed() after changing the value. |
|
|
|
|
|
|
|
|
|
|
|
Override and implement this in a derived TreeModel class. 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 unref_node_vfunc(). Please note that nodes that are deleted are not unreffed.
|
|
|
|
|
|
|
|
|