gtkmm  4.8.0
Public Types | Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gtk::TreeSelection Class Reference

Typedefed as Gtk::TreeView::Selection. More...

#include <gtkmm/treeselection.h>

Inherits Glib::Object.

Public Types

using SlotSelect = sigc::slot< bool(const Glib::RefPtr< TreeModel > &, const TreeModel::Path &, bool)>
 For instance, bool on_select_function(const Glib::RefPtr<TreeModel>& model, const TreeModel::Path& path, bool path_currently_selected);. More...
 
using SlotForeachIter = sigc::slot< void(const TreeModel::const_iterator &)>
 For example, void on_foreach(const Gtk::TreeModel::const_iterator& iter);. More...
 
using SlotForeachPath = sigc::slot< void(const TreeModel::Path &)>
 For example, void on_foreach(const Gtk::TreeModel::Path& path);. More...
 
using SlotForeachPathAndIter = sigc::slot< void(const TreeModel::Path &, const TreeModel::const_iterator &)>
 For example, void on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::const_iterator& iter);. More...
 

Public Member Functions

 TreeSelection (TreeSelection && src) noexcept
 
TreeSelectionoperator= (TreeSelection && src) noexcept
 
 ~TreeSelection () noexcept override
 
GtkTreeSelection * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkTreeSelection * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkTreeSelection * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void set_mode (SelectionMode type)
 Sets the selection mode of the selection. More...
 
SelectionMode get_mode () const
 Gets the selection mode for selection. More...
 
void set_select_function (const SlotSelect & slot)
 Sets the selection callback slot. More...
 
TreeViewget_tree_view ()
 Returns the tree view associated with selection. More...
 
const TreeViewget_tree_view () const
 Returns the tree view associated with selection. More...
 
Glib::RefPtr< TreeModelget_model ()
 Shortcut for get_tree_view()->get_model(). More...
 
Glib::RefPtr< const TreeModelget_model () const
 
TreeModel::iterator get_selected ()
 Get the currently selected row. More...
 
TreeModel::const_iterator get_selected () const
 Get the currently selected row. More...
 
TreeModel::iterator get_selected (Glib::RefPtr< TreeModel > & model)
 Get the currently selected row. More...
 
TreeModel::const_iterator get_selected (Glib::RefPtr< const TreeModel > & model) const
 Get the currently selected row. More...
 
std::vector< TreeModel::Pathget_selected_rows () const
 Creates a vector of paths of all selected rows. More...
 
std::vector< TreeModel::Pathget_selected_rows (Glib::RefPtr< TreeModel > & model)
 Creates a list of paths of all selected rows. More...
 
int count_selected_rows () const
 Returns the number of rows that have been selected in tree. More...
 
void selected_foreach_iter (const SlotForeachIter & slot) const
 Calls a callback slot for each selected node. More...
 
void selected_foreach_path (const SlotForeachPath & slot) const
 Calls a callback slot for each selected node. More...
 
void selected_foreach (const SlotForeachPathAndIter & slot) const
 Calls a callback slot for each selected node. More...
 
void select (const TreeModel::Path & path)
 Select the row at path. More...
 
void select (const TreeModel::Path & start_path, const TreeModel::Path & end_path)
 Selects a range of nodes, determined by start_path and end_path inclusive. More...
 
void select (const TreeModel::const_iterator & iter)
 Selects the specified iterator. More...
 
void unselect (const TreeModel::Path & path)
 Unselects the row at path. More...
 
void unselect (const TreeModel::Path & start_path, const TreeModel::Path & end_path)
 Unselects a range of nodes, determined by start_path and end_path inclusive. More...
 
void unselect (const TreeModel::const_iterator & iter)
 Unselects the specified iterator. More...
 
bool is_selected (const TreeModel::Path & path) const
 Returns true if the row pointed to by path is currently selected. More...
 
bool is_selected (const TreeModel::const_iterator & iter) const
 Returns true if the row at iter is currently selected. More...
 
void select_all ()
 Selects all the nodes. More...
 
void unselect_all ()
 Unselects all the nodes. More...
 
Glib::PropertyProxy< SelectionModeproperty_mode ()
 Selection mode. More...
 
Glib::PropertyProxy_ReadOnly< SelectionModeproperty_mode () const
 Selection mode. More...
 
Glib::SignalProxy< void()> signal_changed ()
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::TreeSelectionwrap (GtkTreeSelection * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Typedefed as Gtk::TreeView::Selection.

This is a helper object to manage the selection for a Gtk::TreeView widget.

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

The Gtk::TreeSelection object can be obtained from a Gtk::TreeView by calling Gtk::TreeView::get_selection(). It can be manipulated to check the selection status of the tree, as well as to 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.

When monitoring the selection of a view, it's important to remember 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.

Deprecated:
4.10: Use Gtk::SelectionModel instead.

Member Typedef Documentation

◆ SlotForeachIter

For example, void on_foreach(const Gtk::TreeModel::const_iterator& iter);.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

◆ SlotForeachPath

using Gtk::TreeSelection::SlotForeachPath = sigc::slot<void(const TreeModel::Path&)>

For example, void on_foreach(const Gtk::TreeModel::Path& path);.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

◆ SlotForeachPathAndIter

For example, void on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::const_iterator& iter);.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

◆ SlotSelect

using Gtk::TreeSelection::SlotSelect = sigc::slot<bool(const Glib::RefPtr<TreeModel>&, const TreeModel::Path&, bool)>

For instance, bool on_select_function(const Glib::RefPtr<TreeModel>& model, const TreeModel::Path& path, bool path_currently_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.

Constructor & Destructor Documentation

◆ TreeSelection()

Gtk::TreeSelection::TreeSelection ( TreeSelection &&  src)
noexcept

◆ ~TreeSelection()

Gtk::TreeSelection::~TreeSelection ( )
overridenoexcept

Member Function Documentation

◆ count_selected_rows()

int Gtk::TreeSelection::count_selected_rows ( ) const

Returns the number of rows that have been selected in tree.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Returns
The number of rows selected.

◆ get_mode()

SelectionMode Gtk::TreeSelection::get_mode ( ) const

Gets the selection mode for selection.

See set_mode().

Deprecated: 4.10: Use GtkListView or GtkColumnView

Returns
The current selection mode.

◆ get_model() [1/2]

Glib::RefPtr<TreeModel> Gtk::TreeSelection::get_model ( )

Shortcut for get_tree_view()->get_model().

Returns
The TreeModel associated with this TreeSelection.

◆ get_model() [2/2]

Glib::RefPtr<const TreeModel> Gtk::TreeSelection::get_model ( ) const

◆ get_selected() [1/4]

TreeModel::iterator Gtk::TreeSelection::get_selected ( )

Get the currently selected row.

Returns
The currently selected row. Or an invalid iterator, if no row is selected.
Note
This method won't work if the selection mode is Gtk::SelectionMode::MULTIPLE. Use get_selected_rows() for multiple selections.

◆ get_selected() [2/4]

TreeModel::const_iterator Gtk::TreeSelection::get_selected ( ) const

Get the currently selected row.

Returns
The currently selected row. Or an invalid iterator, if no row is selected.
Note
This method won't work if the selection mode is Gtk::SelectionMode::MULTIPLE. Use get_selected_rows() for multiple selections.
Since gtkmm 3.90:

◆ get_selected() [3/4]

TreeModel::const_iterator Gtk::TreeSelection::get_selected ( Glib::RefPtr< const TreeModel > &  model) const

Get the currently selected row.

Parameters
[out]modelThe current TreeModel.
Returns
The currently selected row. Or an invalid iterator, if no row is selected.
Note
This method won't work if the selection mode is Gtk::SelectionMode::MULTIPLE. Use get_selected_rows() for multiple selections.
Since gtkmm 3.90:

◆ get_selected() [4/4]

TreeModel::iterator Gtk::TreeSelection::get_selected ( Glib::RefPtr< TreeModel > &  model)

Get the currently selected row.

Parameters
[out]modelThe current TreeModel.
Returns
The currently selected row. Or an invalid iterator, if no row is selected.
Note
This method won't work if the selection mode is Gtk::SelectionMode::MULTIPLE. Use get_selected_rows() for multiple selections.

◆ get_selected_rows() [1/2]

std::vector<TreeModel::Path> Gtk::TreeSelection::get_selected_rows ( ) const

Creates a vector of paths 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.

Returns
A vector containing a Gtk::TreeModel::Path for each selected row.

◆ get_selected_rows() [2/2]

std::vector<TreeModel::Path> Gtk::TreeSelection::get_selected_rows ( Glib::RefPtr< TreeModel > &  model)

Creates a list of paths 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.

Parameters
[out]modelThe current TreeModel.
Returns
A vector containing a Gtk::TreeModel::Path for each selected row.

◆ get_tree_view() [1/2]

TreeView* Gtk::TreeSelection::get_tree_view ( )

Returns the tree view associated with selection.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Returns
A Gtk::TreeView.

◆ get_tree_view() [2/2]

const TreeView* Gtk::TreeSelection::get_tree_view ( ) const

Returns the tree view associated with selection.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Returns
A Gtk::TreeView.

◆ get_type()

static GType Gtk::TreeSelection::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkTreeSelection* Gtk::TreeSelection::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkTreeSelection* Gtk::TreeSelection::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkTreeSelection* Gtk::TreeSelection::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ is_selected() [1/2]

bool Gtk::TreeSelection::is_selected ( const TreeModel::const_iterator iter) const

Returns true if the row at iter is currently selected.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
iterA valid Gtk::TreeIter.
Returns
true, if iter is selected.

◆ is_selected() [2/2]

bool Gtk::TreeSelection::is_selected ( const TreeModel::Path path) const

Returns true if the row pointed to by path is currently selected.

If path does not point to a valid location, false is returned

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
pathA Gtk::TreePath to check selection on.
Returns
true if path is selected.

◆ operator=()

TreeSelection& Gtk::TreeSelection::operator= ( TreeSelection &&  src)
noexcept

◆ property_mode() [1/2]

Glib::PropertyProxy< SelectionMode > Gtk::TreeSelection::property_mode ( )

Selection mode.

See Gtk::TreeSelection::set_mode() for more information on this property.

Default value: Gtk::SelectionMode::SINGLE

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_mode() [2/2]

Glib::PropertyProxy_ReadOnly< SelectionMode > Gtk::TreeSelection::property_mode ( ) const

Selection mode.

See Gtk::TreeSelection::set_mode() for more information on this property.

Default value: Gtk::SelectionMode::SINGLE

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ select() [1/3]

void Gtk::TreeSelection::select ( const TreeModel::const_iterator iter)

Selects the specified iterator.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
iterThe Gtk::TreeIter to be selected.

◆ select() [2/3]

void Gtk::TreeSelection::select ( const TreeModel::Path path)

Select the row at path.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
pathThe Gtk::TreePath to be selected.

◆ select() [3/3]

void Gtk::TreeSelection::select ( const TreeModel::Path start_path,
const TreeModel::Path end_path 
)

Selects a range of nodes, determined by start_path and end_path inclusive.

selection must be set to Gtk::SelectionMode::MULTIPLE mode.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
start_pathThe initial node of the range.
end_pathThe final node of the range.

◆ select_all()

void Gtk::TreeSelection::select_all ( )

Selects all the nodes.

selection must be set to Gtk::SelectionMode::MULTIPLE mode.

Deprecated: 4.10: Use GtkListView or GtkColumnView

◆ selected_foreach()

void Gtk::TreeSelection::selected_foreach ( const SlotForeachPathAndIter slot) const

Calls a callback slot for each selected node.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

Parameters
slotThe function to call for each selected node.

◆ selected_foreach_iter()

void Gtk::TreeSelection::selected_foreach_iter ( const SlotForeachIter slot) const

Calls a callback slot for each selected node.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

Parameters
slotThe function to call for each selected node.

◆ selected_foreach_path()

void Gtk::TreeSelection::selected_foreach_path ( const SlotForeachPath slot) const

Calls a callback slot for each selected node.

Note that you cannot modify the tree or selection from within the callback function. As a result, get_selected_rows() might be more useful.

Parameters
slotThe function to call for each selected node.

◆ set_mode()

void Gtk::TreeSelection::set_mode ( SelectionMode  type)

Sets the selection mode of the selection.

If the previous type was Gtk::SelectionMode::MULTIPLE, then the anchor is kept selected, if it was previously selected.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
typeThe selection mode.

◆ set_select_function()

void Gtk::TreeSelection::set_select_function ( const SlotSelect slot)

Sets the selection callback slot.

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.

Parameters
slotThe selection function.

◆ signal_changed()

Glib::SignalProxy<void()> Gtk::TreeSelection::signal_changed ( )
Slot Prototype:
void on_my_changed()

Flags: Run First

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.

◆ unselect() [1/3]

void Gtk::TreeSelection::unselect ( const TreeModel::const_iterator iter)

Unselects the specified iterator.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
iterThe Gtk::TreeIter to be unselected.

◆ unselect() [2/3]

void Gtk::TreeSelection::unselect ( const TreeModel::Path path)

Unselects the row at path.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
pathThe Gtk::TreePath to be unselected.

◆ unselect() [3/3]

void Gtk::TreeSelection::unselect ( const TreeModel::Path start_path,
const TreeModel::Path end_path 
)

Unselects a range of nodes, determined by start_path and end_path inclusive.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Parameters
start_pathThe initial node of the range.
end_pathThe initial node of the range.

◆ unselect_all()

void Gtk::TreeSelection::unselect_all ( )

Unselects all the nodes.

Deprecated: 4.10: Use GtkListView or GtkColumnView

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::TreeSelection > wrap ( GtkTreeSelection *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.