org.gnu.gtk
public class TreeSelection extends GObject
The TreeSelection object is gotten from a TreeView by calling {@link TreeView#getSelection()}. 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 {@link org.gnu.gtk.event.TreeSelectionEvent.Type#CHANGED CHANGED} event 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" event when nothing has happened (mostly as a result of programmers calling selectRow on an already selected row).
See Also: TreeView
Method Summary | |
---|---|
void | addListener(TreeSelectionListener listener)
Register an object to handle Selection change events which are emitted
whenever the selection has (possibly) changed
|
int | countRows()
Returns the number of rows that have been selected.
|
void | forEachSelected(TreeSelectionForEach implementor)
Calls the forEach method of the specified class for every selected value. |
Class | getEventListenerClass(String signal) |
EventType | getEventType(String signal) |
SelectionMode | getMode() |
boolean | getSelected(TreePath path)
Returns TRUE if the row pointed to by path is currently selected. |
boolean | getSelected(TreeIter iter)
Returns TRUE if the row pointed to by iter is currently selected.
|
TreePath[] | getSelectedRows()
Returns an array of rows which are currently selected
|
TreeView | getTreeView()
Returns the {@link TreeView} associated with the selection.
|
static Type | getType()
Retrieve the runtime type used by the GLib library. |
void | removeListener(TreeSelectionListener listener)
Removes a listener
|
void | select(TreePath path)
Select the row at path.
|
void | select(TreeIter iter)
Selects the specified iterator.
|
void | select(TreePath startPath, TreePath endPath)
Selects a range of nodes, determined by startPath and endPath inclusive.
|
void | selectAll()
Selects all the nodes. |
void | setMode(SelectionMode mode)
Sets the selection mode of the selection. |
void | unselect(TreePath path)
Unselects the row at path.
|
void | unselect(TreeIter iter)
Unselects the specified iterator.
|
void | unselect(TreePath startPath, TreePath endPath) |
void | unselectAll()
Unselects all the nodes. |
See Also: TreeSelectionListener
Since: 2.2
Parameters: path A patch to check the selection on
Returns: True if the path is selected.
Parameters: iter The iter to test the selection of
Returns: true if the iter is selected.
Returns: an empty array if there aren't any rows selected; or an array filled with TreePath objects, representing the selections.
Since: 2.2
Returns: Associated widget
See Also: addListener
Parameters: path The path to be selected.
Parameters: iter The {@link TreeIter} to be selected.
Parameters: startPath The initial node of the range. endPath The final node of the range.
Parameters: mode The selection mode to use.
Parameters: path The path to be deselected
Parameters: iter The {@link TreeIter} to be unselected.