arjuna.tpi.guiauto.base.single_widget module

class arjuna.tpi.guiauto.base.single_widget.SingleGuiWidget(gui, wmd)

Bases: arjuna.interact.gui.auto.base.dispatchable._Dispatchable

Abstract claas for a single GuiWidget in the Gui.

Parameters

• gui – Gui containing this GuiWidget.

• wmd – GuiWidgetMetaData of this GuiWidget.

check()

Check this GuiWidget.

Waits for clickability. Click happens only if it is currently unchecked.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

clear_text()

Clear text of this GuiWidget.

Waits for clickability.

click()

Click on this GuiWidget.

Waits for clickability. Waits for click to succeed.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

property config

Configuration object associated with this GuiWidget.

deselect()

De-select this GuiWidget.

Waits for clickability. Click happens only if it is currently selected.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

double_click()

Mouse double click.

Waits for clickability.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

drag(*, offset)

drop(target, *, source_offset=None, target_offset=None)

enter_text(text)

Send text to this GuiWidget.

Waits for clickability. Click on GuiWidget is executed before send keys operation.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

get_attr(name)

Get value of an attribute for this GuiWidget.

get_property(name)

Get value of a property for this GuiWidget.

hover()

Mouse hover on this GuiWidget.

Waits for clickability.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

hover_and_click()

Mouse hover and click on this GuiWidget.

Waits for clickability.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

is_checked()

Check whether GuiWidget is checked. No dynamic waiting.

is_clickable()

Check whether GuiWidget is clickable. No dynamic waiting.

is_selected()

Check whether GuiWidget is selected. No dynamic waiting.

is_visible()

Check whether GuiWidget is visible. No dynamic waiting.

scroll_full_height() → None

Scroll full height of a GuiWidget. Applicable when it represents scrollable widgets in a Gui.

select()

Select this GuiWidget.

Waits for clickability. Click happens only if it is currently deselected.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

send_keys(key_chord, wait_clickable=True)

Send KeyChord to this GuiWidget.

Waits for clickability. Click on GuiWidget is NOT executed before send keys operation.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

send_text(text)

Send text to this GuiWidget.

Waits for clickability. Click on GuiWidget is NOT executed before send keys operation.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

property source: arjuna.tpi.guiauto.source.element.GuiElementSource

GuiSource object for this GuiWidget.

property text

Text contained in this GuiWidget. It is a settable property.

Note

You can set text of this GuiWidget (Clears and enters text.) using following Python code:

element.text = "<some_text>"

Waits for clickability. Waits for text to be set as expected.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

toggle()

Toggle the selected/checked stage of a GuiWidget.

Waits for clickability. Waits for click to succeed.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

uncheck()

Uncheck this GuiWidget.

Waits for clickability. Click happens only if it is currently checked.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

wait_until_clickable()

Wait for clickability of this Gui Widget.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

wait_until_selected()

Wait for selected state of this Gui Widget.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.

wait_until_visible()

Wait until visibility of this Gui Widget.

ArjunaOption.GUIAUTO_MAX_WAIT in associated configuration is used as the default. Can be overriden using max_wait argument in GuiWidgetDefinition or GNS file.