## GtkTreeSelection

GtkTreeSelection — The selection object for GtkTreeView

## Synopsis

    #include <gtk/gtk.h>

                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);
    GList*      gtk_tree_selection_get_selected_rows
                                                (GtkTreeSelection *selection,
                                                 GtkTreeModel **model);
    gint        gtk_tree_selection_count_selected_rows
                                                (GtkTreeSelection *selection);
    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);
    void        gtk_tree_selection_unselect_range
                                                (GtkTreeSelection *selection,
                                                 GtkTreePath *start_path,
                                                 GtkTreePath *end_path);

## Object Hierarchy

      GObject
       +----GtkTreeSelection

## Signals

    "changed"   void        user_function      (GtkTreeSelection *treeselection,
                                                gpointer user_data);

## 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

### GtkTreeSelection

    typedef struct _GtkTreeSelection GtkTreeSelection;

### GtkTreeSelectionFunc ()

    gboolean    (*GtkTreeSelectionFunc)         (GtkTreeSelection *selection,
                                                 GtkTreeModel *model,
                                                 GtkTreePath *path,
                                                 gboolean path_currently_selected,
                                                 gpointer data);

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.

`selection` : | A GtkTreeSelection
`model` : | A GtkTreeModel being viewed
`path` : | The GtkTreePath of the row in question
`path_currently_selected` : | `TRUE`, if the path is currently selected
`data` : | user data
Returns : | `TRUE`, if the selection state of the row can be toggled

### GtkTreeSelectionForeachFunc ()

    void        (*GtkTreeSelectionForeachFunc)  (GtkTreeModel *model,
                                                 GtkTreePath *path,
                                                 GtkTreeIter *iter,
                                                 gpointer data);

A function used by `gtk_tree_selection_selected_foreach()` to map all selected rows. It will be called on every selected row in the view.

`model` : | The GtkTreeModel being viewed
`path` : | The GtkTreePath of a selected row
`iter` : | A GtkTreeIter pointing to a selected row
`data` : | user data

### 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.

`selection` : | A GtkTreeSelection.
`type` : | The selection mode

### gtk_tree_selection_get_mode ()

    GtkSelectionMode gtk_tree_selection_get_mode
                                                (GtkTreeSelection *selection);

Gets the selection mode for `selection`. See `gtk_tree_selection_set_mode()`.

`selection` : | a GtkTreeSelection
Returns : | the current selection mode

### gtk_tree_selection_set_select_function ()

    void        gtk_tree_selection_set_select_function
                                                (GtkTreeSelection *selection,
                                                 GtkTreeSelectionFunc func,
                                                 gpointer data,
                                                 GtkDestroyNotify 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.

`selection` : | A GtkTreeSelection.
`func` : | The selection function.
`data` : | The selection function's data.
`destroy` : | The destroy function for user data. May be NULL.

### gtk_tree_selection_get_user_data ()

    gpointer    gtk_tree_selection_get_user_data
                                                (GtkTreeSelection *selection);

Returns the user data for the selection function.

`selection` : | A GtkTreeSelection.
Returns : | The user data.

### gtk_tree_selection_get_tree_view ()

    GtkTreeView* gtk_tree_selection_get_tree_view
                                                (GtkTreeSelection *selection);

Returns the tree view associated with `selection`.

`selection` : | A GtkTreeSelection
Returns : | A GtkTreeView

### gtk_tree_selection_get_selected ()

    gboolean    gtk_tree_selection_get_selected (GtkTreeSelection *selection,
                                                 GtkTreeModel **model,
                                                 GtkTreeIter *iter);

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.

`selection` : | A GtkTreeSelection.
`model` : | A pointer to set to the GtkTreeModel, or NULL.
`iter` : | The GtkTreeIter, or NULL.
Returns : | TRUE, if there is a selected node.

### gtk_tree_selection_selected_foreach ()

    void        gtk_tree_selection_selected_foreach
                                                (GtkTreeSelection *selection,
                                                 GtkTreeSelectionForeachFunc func,
                                                 gpointer data);

Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, `gtk_tree_selection_get_selected_rows()` might be more useful.

`selection` : | A GtkTreeSelection.
`func` : | The function to call for each selected node.
`data` : | user data to pass to the function.

### 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:

    g_list_foreach (list, gtk_tree_path_free, NULL);
    g_list_free (list);

`selection` : | A GtkTreeSelection.
`model` : | A pointer to set to the GtkTreeModel, or NULL.
Returns : | A GList containing a GtkTreePath for each selected row.

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`.

`selection` : | A GtkTreeSelection.
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`.

`selection` : | A GtkTreeSelection.
`path` : | The GtkTreePath to be selected.

### gtk_tree_selection_unselect_path ()

    void        gtk_tree_selection_unselect_path
                                                (GtkTreeSelection *selection,
                                                 GtkTreePath *path);

Unselects the row at `path`.

`selection` : | A GtkTreeSelection.
`path` : | The GtkTreePath to be unselected.

### 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

`selection` : | A GtkTreeSelection.
`path` : | A GtkTreePath to check selection on.
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.

`selection` : | A GtkTreeSelection.
`iter` : | The GtkTreeIter to be selected.

### gtk_tree_selection_unselect_iter ()

    void        gtk_tree_selection_unselect_iter
                                                (GtkTreeSelection *selection,
                                                 GtkTreeIter *iter);

Unselects the specified iterator.

`selection` : | A GtkTreeSelection.
`iter` : | The GtkTreeIter to be unselected.

### 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.

`selection` : | A GtkTreeSelection
`iter` : | A valid GtkTreeIter
Returns : | `TRUE`, if `iter` is selected

### gtk_tree_selection_select_all ()

    void        gtk_tree_selection_select_all   (GtkTreeSelection *selection);

Selects all the nodes. `selection` must be set to GTK_SELECTION_MULTIPLE mode.

`selection` : | A GtkTreeSelection.

### gtk_tree_selection_unselect_all ()

    void        gtk_tree_selection_unselect_all (GtkTreeSelection *selection);

Unselects all the nodes.

`selection` : | A GtkTreeSelection.

### gtk_tree_selection_select_range ()

    void        gtk_tree_selection_select_range (GtkTreeSelection *selection,
                                                 GtkTreePath *start_path,
                                                 GtkTreePath *end_path);

Selects a range of nodes, determined by `start_path` and `end_path` inclusive. `selection` must be set to GTK_SELECTION_MULTIPLE mode.

`selection` : | A GtkTreeSelection.
`start_path` : | The initial node of the range.
`end_path` : | The final node of the range.

### 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.

`selection` : | A GtkTreeSelection.
`start_path` : | The initial node of the range.
`end_path` : | The initial node of the range.

Since 2.2

## Signal Details

### The "changed" signal

    void        user_function                  (GtkTreeSelection *treeselection,
                                                gpointer user_data);

Emitted whenever the selection has (possibly) changed. Please note that this signal is mostly a hint. It may only be emitted once when a range of rows are selected, and it may occasionally be emitted when nothing has happened.

`treeselection` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

## See Also

GtkTreeView, GtkTreeViewColumn, GtkTreeDnd, GtkTreeMode, GtkTreeSortable, GtkTreeModelSort, GtkListStore, GtkTreeStore, GtkCellRenderer, GtkCellEditable, GtkCellRendererPixbuf, GtkCellRendererText, GtkCellRendererToggle