TreeSelection

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_tree_selection_get_type ()" ) ]
public class TreeSelection : Object

The TreeSelection object is a helper object to manage the selection for a TreeView widget.

The TreeSelection object is automatically created when a new TreeView widget is created, and cannot exist independently of this widget. The primary reason the TreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the TreeView widget instead of a separate function.

The TreeSelection object is gotten from a TreeView by calling get_selection. It can be manipulated to check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely view side. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row on the model that is not currently displayed by the view without expanding its parents first.

One of the important things to remember when monitoring the selection of a view is that the changed signal is mostly a hint. That is, it may only emit one signal when a range of rows is selected. Additionally, it may on occasion emit a changed signal when nothing has happened (mostly as a result of programmers calling select_row on an already selected row).

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public SelectionMode mode { get; set; }
Selection mode.

Creation methods:

protected TreeSelection ()

Methods:

public int count_selected_rows ()
Returns the number of rows that have been selected in tree.
public SelectionMode get_mode ()
Gets the selection mode for this.
public bool get_selected (out unowned TreeModel model, out TreeIter iter)
Sets iter to the currently selected node, if this is set to gtk_selection_single or gtk_selection_browse.
public List<TreePath> get_selected_rows (out unowned TreeModel model)
Creates a list of path of all selected rows.
public unowned TreeView get_tree_view ()
Returns the tree view associated with this .
public bool iter_is_selected (TreeIter iter)
Returns true if the row at iter is currently selected.
public bool path_is_selected (TreePath path)
Returns true if the row pointed to by path is currently selected.
public void select_all ()
Selects all the nodes.
public void select_iter (TreeIter iter)
Selects the specified iterator.
public void select_path (TreePath path)
Select the row at path.
public void select_range (TreePath start_path, TreePath end_path)
Selects a range of nodes, determined by start_path and end_path inclusive.
public void selected_foreach (TreeSelectionForeachFunc func)
Calls a function for each selected node.
public void set_mode (SelectionMode type)
Sets the selection mode of the this.
public void set_select_function (owned TreeSelectionFunc? func)
Sets the selection function.
public void unselect_all ()
Unselects all the nodes.
public void unselect_iter (TreeIter iter)
Unselects the specified iterator.
public void unselect_path (TreePath path)
Unselects the row at path.
public void unselect_range (TreePath start_path, TreePath end_path)
Unselects a range of nodes, determined by start_path and end_path inclusive.

Signals:

public virtual signal void changed ()
Emitted whenever the selection has (possibly) changed.

Inherited Members:

All known members inherited from class GLib.Object