Ardour
9.0-pre0-582-g084a23a80d
|
#include <treemodel.h>
Public Types | |
typedef TreeModelColumnRecord | ColumnRecord |
typedef TreeNodeChildren | Children |
typedef Children::iterator | iterator |
typedef Children::reverse_iterator | reverse_iterator |
typedef Children::const_iterator | const_iterator |
typedef Children::const_reverse_iterator | const_reverse_iterator |
typedef TreeRow | Row |
typedef TreePath | Path |
typedef TreeRowReference | RowReference |
typedef sigc::slot< bool, const TreeModel::iterator & > | SlotForeachIter |
typedef sigc::slot< bool, const TreeModel::Path & > | SlotForeachPath |
typedef sigc::slot< bool, const TreeModel::Path &, const TreeModel::iterator & > | SlotForeachPathAndIter |
Public Member Functions | |
virtual | ~TreeModel () |
GtkTreeModel * | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkTreeModel * | gobj () const |
Provides access to the underlying C GObject. More... | |
iterator | get_iter (const Path &path) |
iterator | get_iter (const Glib::ustring &path_string) |
Children | children () |
This returns an STL-like container API, for iterating over the rows. More... | |
Children | children () const |
This returns an STL-like container API, for iterating over the rows. More... | |
void | foreach_iter (const SlotForeachIter &slot) |
void | foreach_path (const SlotForeachPath &slot) |
void | foreach (const SlotForeachPathAndIter &slot) |
TreeModelFlags | get_flags () const |
int | get_n_columns () const |
GType | get_column_type (int index) const |
TreeModel::Path | get_path (const iterator &iter) const |
void | row_changed (const Path &path, const iterator &iter) |
void | row_inserted (const Path &path, const iterator &iter) |
void | row_has_child_toggled (const Path &path, const iterator &iter) |
void | row_deleted (const Path &path) |
void | rows_reordered (const Path &path, const iterator &iter, const Glib::ArrayHandle< int > &new_order) |
void | rows_reordered (const Path &path, const Glib::ArrayHandle< int > &new_order) |
void | rows_reordered (const Path &path, const iterator &iter, int *new_order) |
Glib::ustring | get_string (const iterator &iter) const |
Glib::SignalProxy2< void, const TreeModel::Path &, const TreeModel::iterator & > | signal_row_changed () |
Glib::SignalProxy2< void, const TreeModel::Path &, const TreeModel::iterator & > | signal_row_inserted () |
Glib::SignalProxy2< void, const TreeModel::Path &, const TreeModel::iterator & > | signal_row_has_child_toggled () |
Glib::SignalProxy1< void, const TreeModel::Path & > | signal_row_deleted () |
Glib::SignalProxy3< void, const TreeModel::Path &, const TreeModel::iterator &, int * > | signal_rows_reordered () |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () G_GNUC_CONST |
Protected Member Functions | |
TreeModel () | |
virtual TreeModelFlags | get_flags_vfunc () const |
virtual int | get_n_columns_vfunc () const |
virtual GType | get_column_type_vfunc (int index) const |
virtual bool | iter_next_vfunc (const iterator &iter, iterator &iter_next) const |
virtual bool | get_iter_vfunc (const Path &path, iterator &iter) const |
virtual bool | iter_children_vfunc (const iterator &parent, iterator &iter) const |
virtual bool | iter_parent_vfunc (const iterator &child, iterator &iter) const |
virtual bool | iter_nth_child_vfunc (const iterator &parent, int n, iterator &iter) const |
virtual bool | iter_nth_root_child_vfunc (int n, iterator &iter) const |
virtual bool | iter_has_child_vfunc (const iterator &iter) const |
virtual int | iter_n_children_vfunc (const iterator &iter) const |
virtual int | iter_n_root_children_vfunc () const |
virtual void | ref_node_vfunc (const iterator &iter) const |
virtual void | unref_node_vfunc (const iterator &iter) const |
virtual TreeModel::Path | get_path_vfunc (const iterator &iter) const |
virtual void | get_value_vfunc (const iterator &iter, int column, Glib::ValueBase &value) const |
virtual bool | iter_is_valid (const iterator &iter) const |
virtual void | set_value_impl (const iterator &row, int column, const Glib::ValueBase &value) |
virtual void | get_value_impl (const iterator &row, int column, Glib::ValueBase &value) const |
virtual void | on_row_changed (const TreeModel::Path &path, const TreeModel::iterator &iter) |
This is a default handler for the signal signal_row_changed(). More... | |
virtual void | on_row_inserted (const TreeModel::Path &path, const TreeModel::iterator &iter) |
This is a default handler for the signal signal_row_inserted(). More... | |
virtual void | on_row_has_child_toggled (const TreeModel::Path &path, const TreeModel::iterator &iter) |
This is a default handler for the signal signal_row_has_child_toggled(). More... | |
virtual void | on_row_deleted (const TreeModel::Path &path) |
This is a default handler for the signal signal_row_deleted(). More... | |
virtual void | on_rows_reordered (const TreeModel::Path &path, const TreeModel::iterator &iter, int *new_order) |
This is a default handler for the signal signal_rows_reordered(). More... | |
Friends | |
class | Gtk::TreeModelSort |
class | Gtk::TreeRow |
class | Gtk::TreeIter |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::TreeModel > | wrap (GtkTreeModel *object, bool take_copy=false) |
This class defines a generic tree interface for use by the Gtk::TreeView widget.
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.
Definition at line 167 of file treemodel.h.
Definition at line 236 of file treemodel.h.
Definition at line 234 of file treemodel.h.
Definition at line 239 of file treemodel.h.
Definition at line 240 of file treemodel.h.
Definition at line 237 of file treemodel.h.
typedef TreePath Gtk::TreeModel::Path |
Definition at line 243 of file treemodel.h.
Definition at line 238 of file treemodel.h.
typedef TreeRow Gtk::TreeModel::Row |
Definition at line 242 of file treemodel.h.
Definition at line 244 of file treemodel.h.
typedef sigc::slot<bool, const TreeModel::iterator&> Gtk::TreeModel::SlotForeachIter |
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.
Definition at line 280 of file treemodel.h.
typedef sigc::slot<bool, const TreeModel::Path&> Gtk::TreeModel::SlotForeachPath |
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.
Definition at line 294 of file treemodel.h.
typedef sigc::slot<bool, const TreeModel::Path&, const TreeModel::iterator&> Gtk::TreeModel::SlotForeachPathAndIter |
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.
Definition at line 308 of file treemodel.h.
|
protected |
You should derive from this class to use it.
|
virtual |
|
static |
Children Gtk::TreeModel::children | ( | ) |
This returns an STL-like container API, for iterating over the rows.
Children Gtk::TreeModel::children | ( | ) | const |
This returns an STL-like container API, for iterating over the rows.
void Gtk::TreeModel::foreach | ( | const SlotForeachPathAndIter & | slot | ) |
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.
slot | The function to call for each selected node. |
void Gtk::TreeModel::foreach_iter | ( | const SlotForeachIter & | slot | ) |
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.
slot | The function to call for each selected node. |
void Gtk::TreeModel::foreach_path | ( | const SlotForeachPath & | slot | ) |
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.
slot | The function to call for each selected node. |
GType Gtk::TreeModel::get_column_type | ( | int | index | ) | const |
Returns the type of the column.
index | The column index. |
|
protectedvirtual |
Reimplemented in StripableTreeModel.
TreeModelFlags Gtk::TreeModel::get_flags | ( | ) | const |
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.
|
protectedvirtual |
Reimplemented in StripableTreeModel.
iterator Gtk::TreeModel::get_iter | ( | const Glib::ustring & | path_string | ) |
Returns a valid iterator pointing to path_string.
path_string | The path, as a string representation. |
Returns a valid iterator pointing to path.
path | The Gtk::TreeModel::Path. |
|
protectedvirtual |
Override and implement this in a derived TreeModel class. Sets iter to a valid iterator pointing to path
path | An path to a node. |
iter | An iterator that will be set to refer to a node to the path, or will be set as invalid. |
Reimplemented in StripableTreeModel.
int Gtk::TreeModel::get_n_columns | ( | ) | const |
Returns the number of columns supported by tree_model.
|
protectedvirtual |
Reimplemented in StripableTreeModel.
TreeModel::Path Gtk::TreeModel::get_path | ( | const iterator & | iter | ) | const |
Returns a Gtk::TreePath referenced by iter.
iter | The Gtk::TreeIter. |
|
protectedvirtual |
Override and implement this in a derived TreeModel class. Returns a Path referenced by iter.
iter | The iterator. |
Reimplemented in StripableTreeModel.
Glib::ustring Gtk::TreeModel::get_string | ( | const iterator & | iter | ) | const |
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 | An Gtk::TreeIter. |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
protectedvirtual |
|
protectedvirtual |
|
inline |
Provides access to the underlying C GObject.
Definition at line 225 of file treemodel.h.
|
inline |
Provides access to the underlying C GObject.
Definition at line 228 of file treemodel.h.
|
protectedvirtual |
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.
parent | An iterator. |
iter | An iterator that will be set to refer to the firt child node, or will be set as invalid. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
Override and implement this in a derived TreeModel class. Returns true if iter has children, false otherwise.
iter | The iterator to test for children. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
Override and implement this in a derived TreeModel class.
Reimplemented in Gtk::TreeStore, Gtk::TreeModelSort, Gtk::ListStore, and StripableTreeModel.
|
protectedvirtual |
Override and implement this in a derived TreeModel class. Returns the number of children that iter has. See also iter_n_root_children_vfunc().
iter | The iterator to test for children. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
Override and implement this in a derived TreeModel class. Returns the number of toplevel nodes. See also iter_n_children().
Reimplemented in StripableTreeModel.
|
protectedvirtual |
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.
iter | An iterator. |
iter_next | An iterator that will be set to refer to the next node, or will be set as invalid. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
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()
parent | An iterator. |
n | The index of the child node to which iter should be set. |
iter | An iterator that will be set to refer to the nth node, or will be set as invalid. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
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().
n | The index of the child node to which iter should be set. |
iter | An iterator that will be set to refer to the nth node, or will be set as invalid. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
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.
child | An iterator. |
iter | An iterator that will be set to refer to the parent node, or will be set as invalid. |
Reimplemented in StripableTreeModel.
|
protectedvirtual |
This is a default handler for the signal signal_row_changed().
|
protectedvirtual |
This is a default handler for the signal signal_row_deleted().
|
protectedvirtual |
This is a default handler for the signal signal_row_has_child_toggled().
|
protectedvirtual |
This is a default handler for the signal signal_row_inserted().
|
protectedvirtual |
This is a default handler for the signal signal_rows_reordered().
|
protectedvirtual |
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.
iter | the iterator. |
Emits the "row-changed" signal on tree_model.
path | A Gtk::TreePath pointing to the changed row. |
iter | A valid Gtk::TreeIter pointing to the changed row. |
void Gtk::TreeModel::row_deleted | ( | const Path & | 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.
path | A Gtk::TreePath pointing to the previous location of the deleted row. |
Emits the "row-has-child-toggled" signal on tree_model. This should be called by models after the child state of a node changes.
path | A Gtk::TreePath pointing to the changed row. |
iter | A valid Gtk::TreeIter pointing to the changed row. |
Emits the "row-inserted" signal on tree_model
path | A Gtk::TreePath pointing to the inserted row. |
iter | A valid Gtk::TreeIter pointing to the inserted row. |
void Gtk::TreeModel::rows_reordered | ( | const Path & | path, |
const Glib::ArrayHandle< int > & | new_order | ||
) |
Emits the "rows_reordered" signal on the tree model. This should be called by custom models when their rows have been reordered. This method overload is for nodes whose path has a depth of 0.
path | A tree path pointing to the tree node whose children have been reordered. |
new_order | An array of integers mapping the current position of each child to its old position before the re-ordering, i.e. new_order<literal>[newpos] = oldpos. |
void Gtk::TreeModel::rows_reordered | ( | const Path & | path, |
const iterator & | iter, | ||
const Glib::ArrayHandle< int > & | new_order | ||
) |
Emits the "rows_reordered" signal on the tree model. This should be called by custom models when their rows have been reordered.
path | A tree path pointing to the tree node whose children have been reordered. |
iter | A valid iterator pointing to the node whose children have been reordered. See also, rows_reordered(const Path& path, const Glib::ArrayHandle<int>& new_order), if the path has a depth of 0. |
new_order | An array of integers mapping the current position of each child to its old position before the re-ordering, i.e. new_order<literal>[newpos] = oldpos. |
Emits the "rows-reordered" signal on tree_model. This should be called by models when their rows have been reordered.
path | A Gtk::TreePath pointing to the tree node whose children have been reordered. |
iter | A valid Gtk::TreeIter pointing to the node whose children have been reordered, or 0 if the depth of path is 0. |
new_order | 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. |
|
protectedvirtual |
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 row_changed() after changing the value.
Reimplemented in Gtk::TreeStore, Gtk::TreeModelSort, Gtk::TreeModelFilter, and Gtk::ListStore.
Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > Gtk::TreeModel::signal_row_changed | ( | ) |
void on_my_row_changed(const TreeModel::Path& path, const TreeModel::iterator& iter)
Glib::SignalProxy1< void,const TreeModel::Path& > Gtk::TreeModel::signal_row_deleted | ( | ) |
void on_my_row_deleted(const TreeModel::Path& path)
Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > Gtk::TreeModel::signal_row_has_child_toggled | ( | ) |
void on_my_row_has_child_toggled(const TreeModel::Path& path, const TreeModel::iterator& iter)
Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > Gtk::TreeModel::signal_row_inserted | ( | ) |
void on_my_row_inserted(const TreeModel::Path& path, const TreeModel::iterator& iter)
Glib::SignalProxy3< void,const TreeModel::Path&,const TreeModel::iterator&,int* > Gtk::TreeModel::signal_rows_reordered | ( | ) |
void on_my_rows_reordered(const TreeModel::Path& path, const TreeModel::iterator& iter, int* new_order)
|
protectedvirtual |
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.
iter | the iterator. |
|
friend |
Definition at line 654 of file treemodel.h.
|
friend |
Definition at line 652 of file treemodel.h.
|
friend |
Definition at line 653 of file treemodel.h.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |