GtkTreeSelection
Name
GtkTreeSelection -- The selection object for
GtkTreeViewSynopsis
#include <gtk/gtk.h>
struct GtkTreeSelection;
gboolean (*GtkTreeSelectionFunc) (GtkTreeSelection *selection,
GtkTreeModel *model,
GtkTreePath *path,
gboolean path_currently_selected,
gpointer data);
void (*GtkTreeSelectionForeachFunc) (GtkTreeModel *model,
GtkTreePath *path,
GtkTreeIter *iter,
gpointer data);
void gtk_tree_selection_set_mode (GtkTreeSelection *selection,
GtkSelectionMode type);
GtkSelectionMode gtk_tree_selection_get_mode
(GtkTreeSelection *selection);
void gtk_tree_selection_set_select_function
(GtkTreeSelection *selection,
GtkTreeSelectionFunc func,
gpointer data,
GtkDestroyNotify destroy);
gpointer gtk_tree_selection_get_user_data
(GtkTreeSelection *selection);
GtkTreeView* gtk_tree_selection_get_tree_view
(GtkTreeSelection *selection);
gboolean gtk_tree_selection_get_selected (GtkTreeSelection *selection,
GtkTreeModel **model,
GtkTreeIter *iter);
void gtk_tree_selection_selected_foreach
(GtkTreeSelection *selection,
GtkTreeSelectionForeachFunc func,
gpointer data);
void gtk_tree_selection_select_path (GtkTreeSelection *selection,
GtkTreePath *path);
void gtk_tree_selection_unselect_path
(GtkTreeSelection *selection,
GtkTreePath *path);
gboolean gtk_tree_selection_path_is_selected
(GtkTreeSelection *selection,
GtkTreePath *path);
void gtk_tree_selection_select_iter (GtkTreeSelection *selection,
GtkTreeIter *iter);
void gtk_tree_selection_unselect_iter
(GtkTreeSelection *selection,
GtkTreeIter *iter);
gboolean gtk_tree_selection_iter_is_selected
(GtkTreeSelection *selection,
GtkTreeIter *iter);
void gtk_tree_selection_select_all (GtkTreeSelection *selection);
void gtk_tree_selection_unselect_all (GtkTreeSelection *selection);
void gtk_tree_selection_select_range (GtkTreeSelection *selection,
GtkTreePath *start_path,
GtkTreePath *end_path);
|
Object Hierarchy
GObject
+----GtkTreeSelection |
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 independentally 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).
Details
GtkTreeSelectionFunc ()
A function used by gtk_tree_selection_set_select_function() to filter
whether or not a row may be selected. It is called whenever a row's
state might change. A return value of TRUE indicates to selection
that it is okay to change the selection.
gtk_tree_selection_set_mode ()
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 ()
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_user_data ()
Returns the user data for the selection function.
gtk_tree_selection_get_tree_view ()
Returns the tree view associated with selection.
gtk_tree_selection_get_selected ()
Sets iter to the currently selected node if selection is set to
GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE. iter may be NULL if you
just want to test if selection has any selected nodes. model is filled
with the current model as a convenience. This function will not work if you
use selection is GTK_SELECTION_MULTIPLE.
gtk_tree_selection_selected_foreach ()
Calls a function for each selected node.
gtk_tree_selection_select_path ()
Select the row at path.
gtk_tree_selection_unselect_path ()
Unselects the row at path.
gtk_tree_selection_path_is_selected ()
Returns TRUE if the row pointed to by path is currently selected. If path
does not point to a valid location, FALSE is returned
gtk_tree_selection_select_iter ()
Selects the specified iterator.
gtk_tree_selection_unselect_iter ()
Unselects the specified iterator.
gtk_tree_selection_iter_is_selected ()
Returns TRUE if the row pointed to by path is currently selected.
gtk_tree_selection_select_all ()
Selects all the nodes. selection is must be set to GTK_SELECTION_MULTIPLE
mode.
gtk_tree_selection_unselect_all ()
Unselects all the nodes.
gtk_tree_selection_select_range ()
Selects a range of nodes, determined by start_path and end_path inclusive.
Signals
The "changed" signal
Emitted whenever the selection has (possibly) changed. Please note that
this signal is
See Also
GtkTreeView, GtkTreeViewColumn, GtkTreeDnd, GtkTreeMode, GtkTreeSortable, GtkTreeModelSort, GtkListStore, GtkTreeStore, GtkCellRenderer, GtkCellEditable, GtkCellRendererPixbuf, GtkCellRendererText, GtkCellRendererToggle