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

• #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.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

• i (Integer) —

  a #gint specifying the child index.

Returns:

• (TrueClass) —

  TRUE if success, FALSE otherwise.

#clear_selection(selection) ⇒ TrueClass

Returns TRUE if success, FALSE otherwise.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

Returns:

• (TrueClass) —

  TRUE if success, FALSE otherwise.

#get_selection_count(selection) ⇒ Integer

if selection does not implement this interface.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

Returns:

• (Integer) —

  a gint representing the number of items selected, or 0

#is_child_selected(selection, i) ⇒ TrueClass

if selection does not implement this interface.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

• i (Integer) —

  a #gint specifying the child index.

Returns:

• (TrueClass) —

  a gboolean representing the specified child is selected, or 0

#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.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

• i (Integer) —

  a #gint specifying the index in the selection set. (e.g. the

Returns:

• (Atk::Object) —

  an Atk::Object representing the

#remove_selection(selection, i) ⇒ TrueClass

ith selection as opposed to the ith child).

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

• i (Integer) —

  a #gint specifying the index in the selection set. (e.g. the

Returns:

• (TrueClass) —

  TRUE if success, FALSE otherwise.

#select_all_selection(selection) ⇒ TrueClass

Returns TRUE if success, FALSE otherwise.

Parameters:

• selection (Atk::Selection) —

  a #GObject instance that implements AtkSelectionIface

Returns:

• (TrueClass) —

  TRUE if success, FALSE otherwise.

#selection_changed(selection) ⇒ nil

Parameters:

• selection (Atk::Selection)

Returns:

• (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.

Returns:

• (Integer) —

  a gint representing the number of items selected, or 0