guibot.inputmap module¶

SUMMARY¶

Key mappings, modifiers, and mouse buttons.

class guibot.inputmap.Key[source]¶

Bases: object

Helper to contain all key mappings for a custom display control backend.

to_string(key)[source]¶

Provide with a text representation of a desired key according to the custom BC backend.

Parameters:: key (str) – selected key name according to the custom backend
Returns:: text representation of the selected key
Return type:: str
Raises:: ValueError if key is not found in the current key map

class guibot.inputmap.AutoPyKey[source]¶

Bases: Key

Helper to contain all key mappings for the AutoPy DC backend.

class guibot.inputmap.XDoToolKey[source]¶

Bases: Key

Helper to contain all key mappings for the xdotool DC backend.

class guibot.inputmap.VNCDoToolKey[source]¶

Bases: Key

Helper to contain all key mappings for the VNCDoTool DC backend.

class guibot.inputmap.PyAutoGUIKey[source]¶

Bases: Key

Helper to contain all key mappings for the PyAutoGUI DC backend.

class guibot.inputmap.KeyModifier[source]¶

Bases: object

Helper to contain all modifier key mappings for a custom display control backend.

to_string(key)[source]¶

Provide with a text representation of a desired modifier key according to the custom BC backend.

Parameters:: key (str) – selected modifier name according to the current backend
Returns:: text representation of the selected modifier
Return type:: str
Raises:: ValueError if key is not found in the current modifier map

class guibot.inputmap.AutoPyKeyModifier[source]¶

Helper to contain all modifier key mappings for the AutoPy DC backend.

class guibot.inputmap.XDoToolKeyModifier[source]¶

Helper to contain all modifier key mappings for the xdotool DC backend.

class guibot.inputmap.VNCDoToolKeyModifier[source]¶

Helper to contain all modifier key mappings for the VNCDoTool DC backend.

class guibot.inputmap.PyAutoGUIKeyModifier[source]¶

Helper to contain all modifier key mappings for the PyAutoGUI DC backend.

class guibot.inputmap.MouseButton[source]¶

Bases: object

Helper to contain all mouse button mappings for a custom display control backend.

to_string(key)[source]¶

Provide with a text representation of a desired mouse button according to the custom BC backend.

Parameters:: key (str) – selected mouse button according to the current backend
Returns:: text representation of the selected mouse button
Return type:: str
Raises:: ValueError if key is not found in the current mouse map