Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.TreeSelection

Class Gtk.TreeSelection

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkTreeSelection
Class :	TreeSelection
Extends:	GObject.Object

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 GtkTreeSelection::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 GtkTreeSelection::changed signal
when nothing has happened (mostly as a result of programmers calling
select_row on an already selected row).

Properties
Properties		Defined By
	parent : GObject.Object read only	Gtk.TreeSelection
	priv : Gtk.TreeSelectionPrivate read only	Gtk.TreeSelection

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.TreeSelection (Object *properties) Create a new Gtk.TreeSelection Create a new Gtk.TreeSelection Parameters: Object properties*
	count_selected_rows () : gint32 Returns the number of rows that have been selected in tree. Returns the number of rows that have been selected in tree. Returns: gint32 The number of rows selected.	Gtk.TreeSelection
	get_mode () : Gtk.SelectionMode Gets the selection mode for selection. Gets the selection mode for selection. See gtk_tree_selection_set_mode(). Returns: Gtk.SelectionMode the current selection mode	Gtk.TreeSelection
	get_selected (Object *out_values) : gboolean Sets iter* to the currently selected node if selection is set to GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE. 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. Parameters: Object out_values Gtk.TreeModel model Gtk.TreeIter iter Returns: gboolean TRUE, if there is a selected node.	Gtk.TreeSelection
	get_selected_rows (Object *out_values) : Array Creates a list of path of all selected rows. 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, (GFunc) gtk_tree_path_free, NULL); g_list_free (list); ]\| Parameters: Object out_values* Gtk.TreeModel model Returns: Array A GList containing a GtkTreePath for each selected row.	Gtk.TreeSelection
	get_tree_view () : Gtk.TreeView Returns the tree view associated with selection. Returns the tree view associated with selection. Returns: Gtk.TreeView A GtkTreeView	Gtk.TreeSelection
	iter_is_selected (TreeIter *iter) : gboolean Returns TRUE* if the row at iter is currently selected. Returns TRUE if the row at iter is currently selected. Parameters: Gtk.TreeIter iter Required (not null) A valid GtkTreeIter Returns: gboolean TRUE, if iter is selected	Gtk.TreeSelection
	path_is_selected (TreePath *path) : gboolean Returns TRUE* if the row pointed to by path is currently 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 Parameters: Gtk.TreePath path Required (not null) A GtkTreePath to check selection on. Returns: gboolean TRUE if path is selected.	Gtk.TreeSelection
	select_all () : none Selects all the nodes. Selects all the nodes. selection must be set to GTK_SELECTION_MULTIPLE mode. Returns: none	Gtk.TreeSelection
	select_iter (TreeIter *iter) : none Selects the specified iterator. Selects the specified iterator. Parameters: Gtk.TreeIter iter* Required (not null) The GtkTreeIter to be selected. Returns: none	Gtk.TreeSelection
	select_path (TreePath *path) : none Select the row at path. Select the row at path. Parameters: Gtk.TreePath path* Required (not null) The GtkTreePath to be selected. Returns: none	Gtk.TreeSelection
	select_range (TreePath *start_path, TreePath end_path) : none Selects a range of nodes, determined by start_path* and end_path inclusive. Selects a range of nodes, determined by start_path and end_path inclusive. Parameters: Gtk.TreePath start_path Required (not null) The initial node of the range. Gtk.TreePath end_path Required (not null) The final node of the range. Returns: none	Gtk.TreeSelection
	selected_foreach (Function *func, void *data) : none Calls a function for each selected node. 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. Parameters: Function (TreeModel model, TreePath path, TreeIter iter, void *data) : none Required (not null) The function to call for each selected node. void data Required (not null) user data to pass to the function. Returns: none	Gtk.TreeSelection
	set_mode (SelectionMode *type) : none Sets the selection mode of the selection. 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. Parameters: Gtk.SelectionMode type* Required (not null) The selection mode Returns: none	Gtk.TreeSelection
	set_select_function (Function *func, void *data, Function destroy) : none Sets the selection 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. Parameters: Function (TreeSelection *selection, TreeModel model, TreePath path, gboolean path_currently_selected, void *data) : none Required (not null) The selection function. May be NULL* void* data Required (not null) The selection function's data. May be NULL Function (void* *data) : none Required (not null) The destroy function for user data. May be NULL* Returns: none	Gtk.TreeSelection
	unselect_all () : none Unselects all the nodes. Unselects all the nodes. Returns: none	Gtk.TreeSelection
	unselect_iter (TreeIter *iter) : none Unselects the specified iterator. Unselects the specified iterator. Parameters: Gtk.TreeIter iter* Required (not null) The GtkTreeIter to be unselected. Returns: none	Gtk.TreeSelection
	unselect_path (TreePath *path) : none Unselects the row at path. Unselects the row at path. Parameters: Gtk.TreePath path* Required (not null) The GtkTreePath to be unselected. Returns: none	Gtk.TreeSelection
	unselect_range (TreePath *start_path, TreePath end_path) : none Unselects a range of nodes, determined by start_path* and end_path inclusive. Unselects a range of nodes, determined by start_path and end_path inclusive. Parameters: Gtk.TreePath start_path Required (not null) The initial node of the range. Gtk.TreePath end_path Required (not null) The initial node of the range. Returns: none	Gtk.TreeSelection

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (TreeSelection *self) : none Emitted whenever the selection has (possibly) changed. 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. Parameters: Gtk.TreeSelection self* Returns: {none}	Gtk.TreeSelection

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.TreeView Method	get_selection () : Gtk.TreeSelection Gets the GtkTreeSelection associated with tree_view.