TreePath

Object Hierarchy:

Description:

[ CCode ( copy_function = "g_boxed_copy" , free_function = "g_boxed_free" , type_id = "gtk_tree_path_get_type ()" ) ]
[ Compact ]
public class TreePath

Example: TreePath:

public static int main (string[] args) {
	// Create a TreeStore [string, string]:
	Gtk.TreeStore store = new Gtk.TreeStore (2, typeof (string), typeof (string));

	// Add data:
	Gtk.TreeIter root;
	Gtk.TreeIter category_iter;
	Gtk.TreeIter product_iter;

	store.append (out root, null);
	store.set (root, 0, "All Products", -1);

	store.append (out category_iter, root);
	store.set (category_iter, 0, "Books", -1);

	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Moby Dick", 1, "$10.36", -1);
	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Heart of Darkness", 1, "$4.99", -1);
	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Ulysses", 1, "$26.09", -1);
	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Effective Vala", 1, "$38.99", -1);

	store.append (out category_iter, root);
	store.set (category_iter, 0, "Films", -1);

	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Amores Perros", 1, "$7.99", -1);
	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Twin Peaks", 1, "$14.99", -1);
	store.append (out product_iter, category_iter);
	store.set (product_iter, 0, "Vertigo", 1, "$20.49", -1);

	// Query:
	// + All Products
	//   + Books
	//     + Moby Dick				$10.36
	//     + Heart of Darkness		$4.99
	//     + Ulysses				$26.09
	//     + Effective Vala			$38.99
	//   + Films
	//     + Amores Perros			$7.99
	//     + Twin Peaks				$14.99
	// 	   + Vertigo				$20.49

	// Output: ``0:0:0: Moby Dick``
	Gtk.TreePath path = new Gtk.TreePath ();
	path.append_index (0);
	path.append_index (0);
	path.append_index (0);

	Gtk.TreeIter iter;
	Value val;

	store.get_iter (out iter, path);
	store.get_value (iter, 0, out val); 
	print ("%s: %s\n", path.to_string (), (string) val);

	// Output: ``0:0:1: Heart of Darkness``
	path = new Gtk.TreePath.from_indices (0, 0, 1);
	store.get_iter (out iter, path);
	store.get_value (iter, 0, out val); 
	print ("%s: %s\n", path.to_string (), (string) val);

	// Output: ``0:1:2: Vertigo``
	path = new Gtk.TreePath.from_string ("0:1:2");
	store.get_iter (out iter, path);
	store.get_value (iter, 0, out val); 
	print ("%s: %s\n", path.to_string (), (string) val);

	return 0;
}

valac --pkg gtk+-3.0 Gtk.TreePath.vala

Namespace: Gtk

Package: gtk+-3.0

Content:

Creation methods:

public TreePath ()
Creates a new TreePath-struct.
public TreePath.first ()
Creates a new TreePath-struct.
public TreePath.from_indices (...)
Creates a new path with first_index and varargs as indices.
public TreePath.from_indicesv (int[] indices)
Creates a new path with the given indices array of indices.length.
public TreePath.from_string (string path)
Creates a new TreePath-struct initialized to path.

Methods:

public void append_index (int index_)
Appends a new index to a path.
public int compare (TreePath b)
Compares two paths.
public TreePath copy ()
Creates a new TreePath-struct as a copy of this.
public void down ()
Moves this to point to the first child of the current path.
public void free ()
Frees this.
public int get_depth ()
Returns the current depth of this.
public unowned int[] get_indices ()
Returns the current indices of this.
public bool is_ancestor (TreePath descendant)
Returns true if descendant is a descendant of this.
public bool is_descendant (TreePath ancestor)
Returns true if this is a descendant of ancestor.
public void next ()
Moves the this to point to the next node at the current depth.
public void prepend_index (int index_)
Prepends a new index to a path.
public bool prev ()
Moves the this to point to the previous node at the current depth, if it exists.
public string to_string ()
Generates a string representation of the path.
public bool up ()
Moves the this to point to its parent node, if it has a parent.