pywinauto.controls.atspi_controls¶

Wrap various Linux ATSPI windows controls. To be used with ‘atspi’ backend

class pywinauto.controls.atspi_controls.ButtonWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap a Atspi-compatible Button, CheckBox or RadioButton control

click()¶

Click the Button control

get_toggle_state()¶

Get a toggle state of a check box control

is_dialog()¶

Buttons are never dialogs so return False

toggle()¶

Method to change toggle button state

Currently, just a wrapper around the click() method

class pywinauto.controls.atspi_controls.ComboBoxWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap a AT-SPI ComboBox control

collapse()¶

Hide list of items of the control

expand()¶

Drop down list of items of the control

is_expanded()¶

Test if the control is expanded

item_count()¶

Number of items in the control

select(item)¶

Select the control item.

Item can be specified as string or as index

selected_index()¶

Return the selected index

selected_text()¶

Return the selected text

texts()¶

Get texts of all items in the control as list

class pywinauto.controls.atspi_controls.DocumentWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap document control

attribute_value(attrib)¶

Return the document’s attribute value

attributes()¶

Return the document’s constant attributes

locale()¶

Return the document’s content locale

class pywinauto.controls.atspi_controls.EditWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap single-line and multiline text edit controls

get_line(line_index)¶

Return the line specified

is_editable()¶

Return the edit possibility of the element

line_count()¶

Return how many lines there are in the Edit

line_length(line_index)¶

Return how many characters there are in the line

select(start=0, end=None)¶

Set the edit selection of the edit control

selection_indices()¶

The start and end indices of the current selection

set_edit_text(text, pos_start=None, pos_end=None)¶

Set the text of the edit control

set_text(text, pos_start=None, pos_end=None)¶

Set the text of the edit control

text_block()¶

Get the text of the edit control

Currently, only a wrapper around window_text()

texts()¶

Get the texts of the edit control as a lines array

window_text()¶

Window text of the element

class pywinauto.controls.atspi_controls.ImageWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap image controls

bounding_box()¶

Get image bounding box

description()¶

Get image description

locale()¶

Get image locale

position()¶

Get image position coordinates

size()¶

Get image size. Return a tuple with width and height

class pywinauto.controls.atspi_controls.MenuWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap an Atspi-compatible MenuBar, Menu or MenuItem control

click()¶

Click the Button control

item_by_index(idx)¶

Find a menu item specified by the index

item_by_path(path, exact=False)¶

Find a menu item specified by the path

item_count()¶

Number of items in the control

items()¶

Find all menu and menu items

selected_index()¶

Return the selected index

selected_menu_name()¶

Return the selected text

class pywinauto.controls.atspi_controls.ScrollBarWrapper(elem)¶

Bases: pywinauto.controls.atspiwrapper.AtspiWrapper

Wrap an Atspi-compatible Slider control

get_value()¶

Get a current position of slider’s thumb

has_title = False¶

max_value()¶

Get the maximum value of the ScrollBar

min_step()¶

Get the minimum step of the ScrollBar

min_value()¶

Get the minimum value of the ScrollBar

set_value(value)¶

Set position of slider’s thumb