| atkmm 2.22.6 | 
The ATK interface implemented by container objects whose Atk::Object children can be selected. More...
#include <atkmm/selection.h>

| Public Member Functions | |
| AtkSelection* | gobj () | 
| Provides access to the underlying C GObject. | |
| const AtkSelection* | gobj () const | 
| Provides access to the underlying C GObject. | |
| bool | add_selection (int i) | 
| Adds the specified accessible child of the object to the object's selection. | |
| bool | clear_selection () | 
| Clears the selection in the object so that no children in the object are selected. | |
| Glib::RefPtr< Atk::Object > | get_selection (int i) | 
| Gets a reference to the accessible object representing the specified selected child of the object. | |
| int | get_selection_count () const | 
| Gets the number of accessible children currently selected. | |
| bool | is_child_selected (int i) const | 
| Determines if the current child of this object is selected. | |
| bool | remove_selection (int i) | 
| Removes the specified child of the object from the object's selection. | |
| bool | select_all_selection () | 
| Causes every child of the object to be selected if the object supports multiple selections. | |
| Glib::SignalProxy0< void > | signal_selection_changed () | 
| Related Functions | |
| (Note that these are not member functions.) | |
| Glib::RefPtr< Atk::Selection > | wrap (AtkSelection* object, bool take_copy=false) | 
| A Glib::wrap() method for this object. | |
The ATK interface implemented by container objects whose Atk::Object children can be selected.
This should be implemented by UI components with children which are exposed by Atk::Object::ref_child and Atk::Object::get_n_children, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those AtkObject children - for example, selectable lists.
Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - Atk::Selection is limited to the selection/deselection of children.
| bool Atk::Selection::add_selection | ( | int | i | ) | 
Adds the specified accessible child of the object to the object's selection.
| i | A intspecifying the child index. | 
true if success, false otherwise. | bool Atk::Selection::clear_selection | ( | ) | 
Clears the selection in the object so that no children in the object are selected.
true if success, false otherwise. | Glib::RefPtr<Atk::Object> Atk::Selection::get_selection | ( | int | i | ) | 
Gets a reference to the accessible object representing the specified selected child of the object.
0 or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. | i | A intspecifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). | 
0 if selection does not implement this interface. | int Atk::Selection::get_selection_count | ( | ) | const | 
Gets the number of accessible children currently selected.
0 or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. int representing the number of items selected, or 0 if selection does not implement this interface. | bool Atk::Selection::is_child_selected | ( | int | i | ) | const | 
Determines if the current child of this object is selected.
0 or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. | i | A intspecifying the child index. | 
bool representing the specified child is selected, or 0 if selection does not implement this interface. | bool Atk::Selection::remove_selection | ( | int | i | ) | 
Removes the specified child of the object from the object's selection.
| i | A intspecifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). | 
true if success, false otherwise. | bool Atk::Selection::select_all_selection | ( | ) | 
Causes every child of the object to be selected if the object supports multiple selections.
true if success, false otherwise. | Glib::SignalProxy0< void > Atk::Selection::signal_selection_changed | ( | ) | 
void on_my_selection_changed() | Glib::RefPtr< Atk::Selection > wrap | ( | AtkSelection * | object, | 
| bool | take_copy = false | ||
| ) |  [related] | 
A Glib::wrap() method for this object.
| object | The C instance. | 
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. | 
 1.7.4
 1.7.4