ConsoleUser

Copyright (c) 2010-2023 Skaion Corporarion, www.skaion.com

This project was developed in part by numerous sponsorships from the U.S. Government. The U.S. Government is authorized to reproduce and distribute reprints of Governmental purposes notwithstanding any copyright notation thereon.

All content reflects those of the authors and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Government or Skaion Corporation.

class ATSPISystem.ATSPISystem(config)

This class provides a concrete implementation of <no title> that uses that AT-STI accessibility to interact with the system.

Parameters:

  • config: a :doc:UserConfig object

click_mouse(button)

Click the given mouse button once.

Parameters:

  • button: which mouse button should be clicked

click_region(region)

Locate the given region, then click a spot within it (the spot can be any spot in the region, so this may not be suitable for every caller!).

Parameters:

  • region: a <no title> to locate on the screen then click

Return: True if the region was found and clicked, False otherwise

click_within(bounds)

The bounds for this could be a region or coords, either way a click event will be generated within it.

find_region(region)

Find the component described by the given ATSPIRegion

get_screen()

Get a <no title> that represents the whole screen and can be searched for other portions.

insert_text(text, metas=())

Insert the given text into the current widget (or the desktop), adding the given set of meta modifiers.

Parameters:

  • text: the string message to pass to the widget

  • metas: a collection of meta keys that modify the text

key_down(key)

Hold down a given key. It will be released later by a call to key_up (or some type_str which will also release it).

Parameters:

  • key: the key to hold. This can be any printable character or a special string which indicates one of the meta keys (e.g. SHIFT). Except when the string is a meta key string this should be exactly 1 character long

key_up(key)

Release a given key. It will probably have been held down by a previous call to key_down.

Parameters:

  • key: the key to release. This can be any printable character or a special string which indicates one of the meta keys (e.g. SHIFT). Except when the string is a meta key string this should be exactly 1 character long

mouse_down(button)

Do a mouse down of whichever button is given in the location the mouse currently is found.

Parameters:

  • button: which button to press

mouse_up(button)

Release a mouse button which had been pressed (as from a call to mouse_down) earlier.

Parameters:

  • button: which button to release

move_mouse(x, y)

If we can identify the window component that contains this coordinates prepare to give that one focus.

set_text(text, metas=())

Set the text of the current widget (or the desktop), adding the given set of meta modifiers.

Parameters:

  • text: the string message to pass to the widget

  • metas: a collection of meta keys that modify the text