Description
The GtkTreeSelection object is a helper object to manage the selection
for a GtkTreeView widget. The GtkTreeSelection object is
automatically created when a new GtkTreeView widget is created, and
cannot exist independently of this widget. The primary reason the
GtkTreeSelection 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 GtkTreeView widget instead of a separate function.
The GtkTreeSelection object is gotten from a GtkTreeView by calling
gtk_tree_view_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).
Functions
gtk_tree_selection_set_mode ()
void
gtk_tree_selection_set_mode (GtkTreeSelection *selection,
GtkSelectionMode type);
Sets the selection mode of the selection
. If the previous type was
GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was
previously selected.
gtk_tree_selection_set_select_function ()
void
gtk_tree_selection_set_select_function
(GtkTreeSelection *selection,
GtkTreeSelectionFunc func,
gpointer data,
GDestroyNotify destroy);
Sets the selection function.
If set, this function is called before any node is selected or unselected,
giving some control over which nodes are selected. The select function
should return TRUE if the state of the node may be toggled, and FALSE
if the state of the node should be left unchanged.
gtk_tree_selection_get_select_function ()
GtkTreeSelectionFunc
gtk_tree_selection_get_select_function
(GtkTreeSelection *selection);
Returns the current selection function.
[skip]
Since: 2.14
gtk_tree_selection_get_user_data ()
gpointer
gtk_tree_selection_get_user_data (GtkTreeSelection *selection);
Returns the user data for the selection function.
[skip]
gtk_tree_selection_get_tree_view ()
GtkTreeView *
gtk_tree_selection_get_tree_view (GtkTreeSelection *selection);
Returns the tree view associated with selection
.
gtk_tree_selection_get_selected_rows ()
GList *
gtk_tree_selection_get_selected_rows (GtkTreeSelection *selection,
GtkTreeModel **model);
Creates a list of path of all selected rows. Additionally, if you are
planning on modifying the model after calling this function, you may
want to convert the returned list into a list of GtkTreeRowReferences.
To do this, you can use gtk_tree_row_reference_new().
To free the return value, use:
Returns
A GList containing a GtkTreePath for each selected row.
[element-type GtkTreePath][transfer full]
Since: 2.2
gtk_tree_selection_count_selected_rows ()
gint
gtk_tree_selection_count_selected_rows
(GtkTreeSelection *selection);
Returns the number of rows that have been selected in tree
.
Returns
The number of rows selected.
Since: 2.2
gtk_tree_selection_select_path ()
void
gtk_tree_selection_select_path (GtkTreeSelection *selection,
GtkTreePath *path);
Select the row at path
.
gtk_tree_selection_unselect_path ()
void
gtk_tree_selection_unselect_path (GtkTreeSelection *selection,
GtkTreePath *path);
Unselects the row at path
.
gtk_tree_selection_path_is_selected ()
gboolean
gtk_tree_selection_path_is_selected (GtkTreeSelection *selection,
GtkTreePath *path);
Returns TRUE if the row pointed to by path
is currently selected. If path
does not point to a valid location, FALSE is returned
Returns
TRUE if path
is selected.
gtk_tree_selection_select_iter ()
void
gtk_tree_selection_select_iter (GtkTreeSelection *selection,
GtkTreeIter *iter);
Selects the specified iterator.
gtk_tree_selection_unselect_iter ()
void
gtk_tree_selection_unselect_iter (GtkTreeSelection *selection,
GtkTreeIter *iter);
Unselects the specified iterator.
gtk_tree_selection_iter_is_selected ()
gboolean
gtk_tree_selection_iter_is_selected (GtkTreeSelection *selection,
GtkTreeIter *iter);
Returns TRUE if the row at iter
is currently selected.
Returns
TRUE, if iter
is selected
gtk_tree_selection_unselect_all ()
void
gtk_tree_selection_unselect_all (GtkTreeSelection *selection);
Unselects all the nodes.
gtk_tree_selection_unselect_range ()
void
gtk_tree_selection_unselect_range (GtkTreeSelection *selection,
GtkTreePath *start_path,
GtkTreePath *end_path);
Unselects a range of nodes, determined by start_path
and end_path
inclusive.
Since: 2.2