phoenix_title wx.UIActionSimulator

wx.UIActionSimulator is a class used to simulate user interface actions such as a mouse click or a key press.

Common usage for this class would be to provide playback and record (aka macro recording) functionality for users, or to drive unit tests by simulating user sessions.

See the UIActionSimulator Sample for an example of using this class.

New in version 2.9.2.


class_hierarchy Class Hierarchy

Inheritance diagram for class UIActionSimulator:

method_summary Methods Summary

__init__

Default constructor.

Char

Press and release a key.

KeyDown

Press a key.

KeyUp

Release a key.

MouseClick

Click a mouse button.

MouseDblClick

Double-click a mouse button.

MouseDown

Press a mouse button.

MouseDragDrop

Perform a drag and drop operation.

MouseMove

Move the mouse to the specified coordinates.

MouseUp

Release a mouse button.

Select

Simulate selection of an item with the given text.

Text

Emulate typing in the keys representing the given string.


api Class API

class wx.UIActionSimulator(object)

Possible constructors:

UIActionSimulator()

UIActionSimulator is a class used to simulate user interface actions such as a mouse click or a key press.


Methods

__init__(self)

Default constructor.



Char(self, keycode, modifiers=MOD_NONE)

Press and release a key.

Parameters
  • keycode (int) – Key to operate on, as an integer. It is interpreted as a KeyCode.

  • modifiers (int) – A combination of wx.KeyModifier flags to be pressed with the given keycode.

Return type

bool



KeyDown(self, keycode, modifiers=MOD_NONE)

Press a key.

If you are using modifiers then it needs to be paired with an identical KeyUp or the modifiers will not be released (MSW and OS X).

Parameters
  • keycode (int) – Key to operate on, as an integer. It is interpreted as a KeyCode.

  • modifiers (int) – A combination of wx.KeyModifier flags to be pressed with the given keycode.

Return type

bool



KeyUp(self, keycode, modifiers=MOD_NONE)

Release a key.

Parameters
  • keycode (int) – Key to operate on, as an integer. It is interpreted as a KeyCode.

  • modifiers (int) – A combination of wx.KeyModifier flags to be pressed with the given keycode.

Return type

bool



MouseClick(self, button=MOUSE_BTN_LEFT)

Click a mouse button.

Parameters

button (int) – Button to press. See wx.UIActionSimulator.MouseDown for a list of valid constants.

Return type

bool



MouseDblClick(self, button=MOUSE_BTN_LEFT)

Double-click a mouse button.

Parameters

button (int) – Button to press. See wx.UIActionSimulator.MouseDown for a list of valid constants.

Return type

bool



MouseDown(self, button=MOUSE_BTN_LEFT)

Press a mouse button.

Parameters

button (int) – Button to press. Valid constants are MOUSE_BTN_LEFT , MOUSE_BTN_MIDDLE , and MOUSE_BTN_RIGHT .

Return type

bool



MouseDragDrop(self, x1, y1, x2, y2, button=MOUSE_BTN_LEFT)

Perform a drag and drop operation.

Parameters
  • x1 (long) – x start coordinate, in screen coordinates.

  • y1 (long) – y start coordinate, in screen coordinates.

  • x2 (long) – x destination coordinate, in screen coordinates.

  • y2 (long) – y destination coordinate, in screen coordinates.

  • button (int) – Button to press. See wx.UIActionSimulator.MouseDown for a list of valid constants.

Return type

bool



MouseMove(self, *args, **kw)

overload Overloaded Implementations:



MouseMove (self, x, y)

Move the mouse to the specified coordinates.

Parameters
  • x (long) – x coordinate to move to, in screen coordinates.

  • y (long) – y coordinate to move to, in screen coordinates.

Return type

bool



MouseMove (self, point)

Move the mouse to the specified coordinates.

Parameters

point (wx.Point) – Point to move to, in screen coordinates.

Return type

bool





MouseUp(self, button=MOUSE_BTN_LEFT)

Release a mouse button.

Parameters

button (int) – Button to press. See wx.UIActionSimulator.MouseDown for a list of valid constants.

Return type

bool



Select(self, text)

Simulate selection of an item with the given text.

This method selects an item in the currently focused wx.Choice, wx.ComboBox, wx.ListBox and similar controls. It does it by simulating keyboard events, so the behaviour should be the same as if the item was really selected by the user.

Notice that the implementation of this method uses wx.Yield and so events can be dispatched from it.

Parameters

text (string) – The text of the item to select.

Return type

bool

Returns

True if the item text was successfully selected or False if the currently focused window is not one of the controls allowing item selection or if the item with the given text was not found in it.

New in version 4.1/wxWidgets-3.1.0.



Text(self, text)

Emulate typing in the keys representing the given string.

Currently only the ASCII letters are universally supported. Digits and punctuation characters can be used with the standard QWERTY (US) keyboard layout but may not work with other layouts.

Parameters

text (string) – The string to type.

Return type

bool