Module: Atk::Selection
- Defined in:
- (unknown)
Overview
Atk::Selection 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 Atk::Object 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.
Instance Method Summary collapse
-
#add_selection(selection, i) ⇒ TrueClass
TRUE if success, FALSE otherwise.
-
#clear_selection(selection) ⇒ TrueClass
TRUE if success, FALSE otherwise.
-
#get_selection_count(selection) ⇒ Integer
if selection does not implement this interface.
-
#is_child_selected(selection, i) ⇒ TrueClass
if selection does not implement this interface.
-
#ref_selection(selection, i) ⇒ Atk::Object
ith selection as opposed to the ith child).
-
#remove_selection(selection, i) ⇒ TrueClass
ith selection as opposed to the ith child).
-
#select_all_selection(selection) ⇒ TrueClass
TRUE if success, FALSE otherwise.
- #selection_changed(selection) ⇒ nil
-
#selection_count ⇒ Integer
Gets the number of accessible children currently selected.
Instance Method Details
#add_selection(selection, i) ⇒ TrueClass
Returns TRUE if success, FALSE otherwise.
#clear_selection(selection) ⇒ TrueClass
Returns TRUE if success, FALSE otherwise.
#get_selection_count(selection) ⇒ Integer
if selection does not implement this interface.
#is_child_selected(selection, i) ⇒ TrueClass
if selection does not implement this interface.
#ref_selection(selection, i) ⇒ Atk::Object
ith selection as opposed to the ith child). selected accessible, or nil if selection does not implement this interface.
#remove_selection(selection, i) ⇒ TrueClass
ith selection as opposed to the ith child).
#select_all_selection(selection) ⇒ TrueClass
Returns TRUE if success, FALSE otherwise.
#selection_changed(selection) ⇒ nil
#selection_count ⇒ Integer
Gets the number of accessible children currently selected. Note: callers should not rely on nil 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. if selection does not implement this interface.