Atk::Selection Class Reference
The ATK interface implemented by container objects whose Atk::Object children can be selected. More...
Inherits Glib::Interface.
Inherited by Atk::NoOpObject.
List of all members.
Detailed Description
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. 
Constructor & Destructor Documentation
      
        
          | virtual Atk::Selection::~Selection | ( |  | ) |  [virtual] | 
      
 
 
Member Function Documentation
      
        
          | static void Atk::Selection::add_interface | ( | GType | gtype_implementer | ) |  [static] | 
      
 
 
      
        
          | bool Atk::Selection::add_selection | ( | int | i | ) |  | 
      
 
Adds the specified accessible child of the object to the object's selection. 
- Parameters:
- 
  
    |  | i | A intspecifying the child index. |  
 
- Returns:
- trueif success,- falseotherwise.
 
 
      
        
          | virtual bool Atk::Selection::add_selection_vfunc | ( | int | i | ) |  [protected, virtual] | 
      
 
 
      
        
          | bool Atk::Selection::clear_selection | ( |  | ) |  | 
      
 
Clears the selection in the object so that no children in the object are selected. 
- Returns:
- trueif success,- falseotherwise.
 
 
      
        
          | virtual bool Atk::Selection::clear_selection_vfunc | ( |  | ) |  [protected, virtual] | 
      
 
 
Gets a reference to the accessible object representing the specified selected child of the object. 
- Note:
- callers should not rely on 0or 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.
- Parameters:
- 
  
    |  | i | A intspecifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). |  
 
- Returns:
- An Atk::Object representing the selected accessible , or 0if selection does not implement this interface.
 
 
      
        
          | int Atk::Selection::get_selection_count | ( |  | ) | const | 
      
 
Gets the number of accessible children currently selected. 
- Note:
- callers should not rely on 0or 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.
- Returns:
- A intrepresenting the number of items selected, or 0 if selection does not implement this interface.
 
 
      
        
          | virtual int Atk::Selection::get_selection_count_vfunc | ( |  | ) | const  [protected, virtual] | 
      
 
 
      
        
          | const AtkSelection* Atk::Selection::gobj | ( |  | ) | const  [inline] | 
      
 
 
      
        
          | AtkSelection* Atk::Selection::gobj | ( |  | ) |  [inline] | 
      
 
 
      
        
          | bool Atk::Selection::is_child_selected | ( | int | i | ) | const | 
      
 
Determines if the current child of this object is selected. 
- Note:
- callers should not rely on 0or 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.
- Parameters:
- 
  
    |  | i | A intspecifying the child index. |  
 
- Returns:
- A boolrepresenting the specified child is selected, or 0 if selection does not implement this interface.
 
 
      
        
          | virtual bool Atk::Selection::is_child_selected_vfunc | ( | int | i | ) | const  [protected, virtual] | 
      
 
 
      
        
          | virtual void Atk::Selection::on_selection_changed | ( |  | ) |  [protected, virtual] | 
      
 
 
      
        
          | bool Atk::Selection::remove_selection | ( | int | i | ) |  | 
      
 
Removes the specified child of the object from the object's selection. 
- Parameters:
- 
  
    |  | i | A intspecifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). |  
 
- Returns:
- trueif success,- falseotherwise.
 
 
      
        
          | virtual bool Atk::Selection::remove_selection_vfunc | ( | int | i | ) |  [protected, virtual] | 
      
 
 
      
        
          | bool Atk::Selection::select_all_selection | ( |  | ) |  | 
      
 
Causes every child of the object to be selected if the object supports multiple selections. 
- Returns:
- trueif success,- falseotherwise.
 
 
      
        
          | virtual bool Atk::Selection::select_all_selection_vfunc | ( |  | ) |  [protected, virtual] | 
      
 
 
- Prototype:
- void on_my_selection_changed()
 
 
Friends And Related Function Documentation
A Glib::wrap() method for this object. 
- Parameters:
- 
  
    |  | 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. |  
 
- Returns:
- A C++ instance that wraps this C instance. 
 
 
The documentation for this class was generated from the following file: