guibot.inputmap module

Key mappings, modifiers, and mouse buttons.

SUMMARY

INTERFACE

class guibot.inputmap.Key[source]

Bases: object

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

to_string(key: str) → str[source]

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

Parameters:

key – selected key name according to the custom backend

Returns:

text representation of the selected key

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: str) → str[source]

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

Parameters:

key – selected modifier name according to the current backend

Returns:

text representation of the selected modifier

Raises:

ValueError if key is not found in the current modifier map

class guibot.inputmap.AutoPyKeyModifier[source]

Bases: KeyModifier

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

class guibot.inputmap.XDoToolKeyModifier[source]

Bases: KeyModifier

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

class guibot.inputmap.VNCDoToolKeyModifier[source]

Bases: KeyModifier

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

class guibot.inputmap.PyAutoGUIKeyModifier[source]

Bases: KeyModifier

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: str) → str[source]

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

Parameters:

key – selected mouse button according to the current backend

Returns:

text representation of the selected mouse button

Raises:

ValueError if key is not found in the current mouse map

class guibot.inputmap.AutoPyMouseButton[source]

Bases: MouseButton

Helper to contain all mouse button mappings for the AutoPy DC backend.

class guibot.inputmap.XDoToolMouseButton[source]

Bases: MouseButton

Helper to contain all mouse button mappings for the xdotool DC backend.

class guibot.inputmap.VNCDoToolMouseButton[source]

Bases: MouseButton

Helper to contain all mouse button mappings for the VNCDoTool DC backend.

class guibot.inputmap.PyAutoGUIMouseButton[source]

Bases: MouseButton

Helper to contain all mouse button mappings for the PyAutoGUI DC backend.