|  |  |  | libatspi Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Known Implementations | ||||
AtspiSelection; gint atspi_selection_get_n_selected_children (AtspiSelection *obj,GError **error); AtspiAccessible * atspi_selection_get_selected_child (AtspiSelection *obj,gint selected_child_index,GError **error); gboolean atspi_selection_select_child (AtspiSelection *obj,gint child_index,GError **error); gboolean atspi_selection_deselect_selected_child (AtspiSelection *obj,gint selected_child_index,GError **error); gboolean atspi_selection_deselect_child (AtspiSelection *obj,gint child_index,GError **error); gboolean atspi_selection_is_child_selected (AtspiSelection *obj,gint child_index,GError **error); gboolean atspi_selection_select_all (AtspiSelection *obj,GError **error); gboolean atspi_selection_clear_selection (AtspiSelection *obj,GError **error);
gint atspi_selection_get_n_selected_children (AtspiSelection *obj,GError **error);
Get the number of children of an AtspiSelection implementor which are currently selected.
| 
 | a pointer to the AtspiSelection implementor on which to operate. | 
| 
 | |
| Returns : | a gint indicating the number of Accessible children of the AtspiSelection implementor which are currently selected. | 
AtspiAccessible * atspi_selection_get_selected_child (AtspiSelection *obj,gint selected_child_index,GError **error);
Get the i-th selected AtspiAccessible child of an AtspiSelection.
     Note that child_index refers to the index in the list of 'selected'
     children and generally differs from that used in
     #atspi_accessible_get_child_at_index() or returned by
     #atspi_accessible_get_index_in_parent(). selected_child_index must lie between 0
     and #Atspi_selection_get_n_selected_children()-1, inclusive.
| 
 | a pointer to the AtspiSelection on which to operate. | 
| 
 | a gint indicating which of the selected children is specified. | 
| 
 | |
| Returns : | a pointer to a selected AtspiAccessible child
         object, specified by child_index.
. transfer full. | 
gboolean atspi_selection_select_child (AtspiSelection *obj,gint child_index,GError **error);
Add a child to the selected children list of an AtspiSelection. For AtspiSelection implementors that only allow single selections, this may replace the (single) current selection.
| 
 | a pointer to the AtspiSelection on which to operate. | 
| 
 | a gint indicating which child of the Accessible is to be selected. | 
| 
 | |
| Returns : | TRUE if the child was successfully selected, FALSE otherwise. | 
gboolean atspi_selection_deselect_selected_child (AtspiSelection *obj,gint selected_child_index,GError **error);
Remove a child to the selected children list of an AtspiSelection.
         Note that child_index is the index in the selected-children list,
         not the index in the parent container.  selectedChildIndex in this
         method, and child_index in atspi_selection_select_child
         are asymmettric.
| 
 | a pointer to the AtspiSelection on which to operate. | 
| 
 | a gint indicating which of the selected children of the Accessible is to be selected. | 
| 
 | |
| Returns : | TRUE if the child was successfully deselected, FALSE otherwise. | 
gboolean atspi_selection_deselect_child (AtspiSelection *obj,gint child_index,GError **error);
Deselect a specific child of an AtspiSelection.
         Note that child_index is the index of the child
         in the parent container.
See atspi_selection_deselect_selected_child
| 
 | a pointer to the AtspiSelection on which to operate. | 
| 
 | a gint indicating which of the children of the AtspiAccessible is to be de-selected. | 
| 
 | |
| Returns : | TRUE if the child was successfully deselected, FALSE otherwise. | 
gboolean atspi_selection_is_child_selected (AtspiSelection *obj,gint child_index,GError **error);
Determine whether a particular child of an AtspiSelection implementor
       is currently selected.  Note that child_index is the index into the
       standard Accessible container's list of children.
| 
 | a pointer to the AtspiSelection implementor on which to operate. | 
| 
 | an index into the AtspiSelection's list of children. | 
| 
 | |
| Returns : | TRUE if the specified child is currently selected, FALSE otherwise. | 
gboolean atspi_selection_select_all (AtspiSelection *obj,GError **error);
Attempt to select all of the children of an AtspiSelection implementor. Not all AtspiSelection implementors support this operation.
| 
 | a pointer to the AtspiSelection implementor on which to operate. | 
| 
 | |
| Returns : | TRUE if successful, FALSE otherwise. | 
gboolean atspi_selection_clear_selection (AtspiSelection *obj,GError **error);
Clear the current selection, removing all selected children from the specified AtspiSelection implementor's selection list.
| 
 | a pointer to the AtspiSelection implementor on which to operate. | 
| 
 | |
| Returns : | TRUE if successful, FALSE otherwise. |