Atk.Selection

g Atk.Selection Atk.Selection GObject.GInterface GObject.GInterface GObject.GInterface->Atk.Selection

Implementations:

Atk.NoOpObject

Methods

add_selection (i)

clear_selection ()

get_selection_count ()

is_child_selected (i)

ref_selection (i)

remove_selection (i)

select_all_selection ()

Virtual Methods

do_add_selection (i)

do_clear_selection ()

do_get_selection_count ()

do_is_child_selected (i)

do_ref_selection (i)

do_remove_selection (i)

do_select_all_selection ()

do_selection_changed ()

Properties

None

Signals

Name

Short Description

selection-changed

The “selection-changed” signal is emitted by an object which implements Atk.Selection interface when the selection changes.

Fields

None

Class Details

class Atk.Selection
Bases:

GObject.GInterface

Structure:

Atk.SelectionIface

The ATK interface implemented by container objects whose Atk.Object children can be selected.

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.

add_selection(i)[source]
Parameters:

i (int) – a int specifying the child index.

Returns:

True if success, False otherwise.

Return type:

bool

Adds the specified accessible child of the object to the object’s selection.

clear_selection()[source]
Returns:

True if success, False otherwise.

Return type:

bool

Clears the selection in the object so that no children in the object are selected.

get_selection_count()[source]
Returns:

a int representing the number of items selected, or 0 if self does not implement this interface.

Return type:

int

Gets the number of accessible children currently selected. Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

is_child_selected(i)[source]
Parameters:

i (int) – a int specifying the child index.

Returns:

a bool representing the specified child is selected, or 0 if self does not implement this interface.

Return type:

bool

Determines if the current child of this object is selected Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

ref_selection(i)[source]
Parameters:

i (int) – a int specifying 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 None if self does not implement this interface.

Return type:

Atk.Object or None

Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

remove_selection(i)[source]
Parameters:

i (int) – a int specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Returns:

True if success, False otherwise.

Return type:

bool

Removes the specified child of the object from the object’s selection.

select_all_selection()[source]
Returns:

True if success, False otherwise.

Return type:

bool

Causes every child of the object to be selected if the object supports multiple selections.

do_add_selection(i) virtual
Parameters:

i (int) – a int specifying the child index.

Returns:

True if success, False otherwise.

Return type:

bool

Adds the specified accessible child of the object to the object’s selection.

do_clear_selection() virtual
Returns:

True if success, False otherwise.

Return type:

bool

Clears the selection in the object so that no children in the object are selected.

do_get_selection_count() virtual
Returns:

a int representing the number of items selected, or 0 if selection does not implement this interface.

Return type:

int

Gets the number of accessible children currently selected. Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

do_is_child_selected(i) virtual
Parameters:

i (int) – a int specifying the child index.

Returns:

a bool representing the specified child is selected, or 0 if selection does not implement this interface.

Return type:

bool

Determines if the current child of this object is selected Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

do_ref_selection(i) virtual
Parameters:

i (int) – a int specifying 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 None if selection does not implement this interface.

Return type:

Atk.Object or None

Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on None or on a zero value for indication of whether Atk.SelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

do_remove_selection(i) virtual
Parameters:

i (int) – a int specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Returns:

True if success, False otherwise.

Return type:

bool

Removes the specified child of the object from the object’s selection.

do_select_all_selection() virtual
Returns:

True if success, False otherwise.

Return type:

bool

Causes every child of the object to be selected if the object supports multiple selections.

do_selection_changed() virtual

Signal Details

Atk.Selection.signals.selection_changed(selection)
Signal Name:

selection-changed

Flags:

RUN_LAST

Parameters:

selection (Atk.Selection) – The object which received the signal

The “selection-changed” signal is emitted by an object which implements Atk.Selection interface when the selection changes.