Atspi.Selection¶

Implementations:: Atspi.Accessible

Methods¶

	`clear_selection` ()
	`deselect_child` (child_index)
	`deselect_selected_child` (selected_child_index)
	`get_n_selected_children` ()
	`get_selected_child` (selected_child_index)
	`is_child_selected` (child_index)
	`select_all` ()
	`select_child` (child_index)

Virtual Methods¶

None

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Atspi.Selection¶

Bases:: GObject.GInterface

An interface which indicates that an object exposes a ‘selection’ model, allowing the selection of one or more of its children.

An interface which indicates that an object exposes a ‘selection’ model, allowing the selection of one or more of its children. Read-only Selection instances are possible, in which case the interface is used to programmatically determine the selected-ness of its children.

clear_selection()¶

Raises:: GLib.Error
Returns:: True if successful, False otherwise.
Return type:: bool

Clears the current selection, removing all selected children from the specified Atspi.Selection implementor’s selection list.

deselect_child(child_index)¶

Parameters:: child_index (int) – a int indicating which of the children of the Atspi.Accessible is to be de-selected.
Raises:: GLib.Error
Returns:: True if the child was successfully deselected, False otherwise.
Return type:: bool

Deselects a specific child of an Atspi.Selection. Note that child_index is the index of the child in the parent container.

See Atspi.Selection.deselect_selected_child

deselect_selected_child(selected_child_index)¶

Parameters:: selected_child_index (int) – a int indicating which of the selected children of the #Accessible is to be selected.
Raises:: GLib.Error
Returns:: True if the child was successfully deselected, False otherwise.
Return type:: bool

Removes a child from the selected children list of an Atspi.Selection. 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 asymmetric.

get_n_selected_children()¶

Raises:: GLib.Error
Returns:: a int indicating the number of #Accessible children of the Atspi.Selection implementor which are currently selected.
Return type:: int

Gets the number of children of an Atspi.Selection implementor which are currently selected.

get_selected_child(selected_child_index)¶

Parameters:: selected_child_index (int) – a int indicating which of the selected children is specified.
Raises:: GLib.Error
Returns:: a pointer to a selected Atspi.Accessible child object, specified by selected_child_index.
Return type:: Atspi.Accessible

Gets the i-th selected Atspi.Accessible child of an Atspi.Selection. Note that selected_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.

is_child_selected(child_index)¶

Parameters:: child_index (int) – an index into the Atspi.Selection's list of children.
Raises:: GLib.Error
Returns:: True if the specified child is currently selected, False otherwise.
Return type:: bool

Determines whether a particular child of an Atspi.Selection implementor is currently selected. Note that child_index is the index into the standard Atspi.Accessible container’s list of children.

select_all()¶

Raises:: GLib.Error
Returns:: True if successful, False otherwise.
Return type:: bool

Attempts to select all of the children of an Atspi.Selection implementor. Not all Atspi.Selection implementors support this operation.

select_child(child_index)¶

Parameters:: child_index (int) – a int indicating which child of the #Accessible is to be selected.
Raises:: GLib.Error
Returns:: True if the child was successfully selected, False otherwise.
Return type:: bool

Adds a child to the selected children list of an Atspi.Selection. For Atspi.Selection implementors that only allow single selections, this may replace the (single) current selection.