guibot.inputmap module

class guibot.inputmap.Key[source]

Bases: object

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

__init__()[source]

Build an instance containing an empty key map.

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: guibot.inputmap.Key

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

__init__()[source]

Build an instance containing the key map for the AutoPy backend.

class guibot.inputmap.XDoToolKey[source]

Bases: guibot.inputmap.Key

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

__init__()[source]

Build an instance containing the key map for the xdotool backend.

class guibot.inputmap.VNCDoToolKey[source]

Bases: guibot.inputmap.Key

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

__init__()[source]

Build an instance containing the key map for the VNCDoTool backend.

class guibot.inputmap.QemuKey[source]

Bases: guibot.inputmap.Key

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

__init__()[source]

Build an instance containing the key map for the Qemu backend.

class guibot.inputmap.KeyModifier[source]

Bases: object

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

__init__()[source]

Build an instance containing an empty modifier key map.

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]

Bases: guibot.inputmap.KeyModifier

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

__init__()[source]

Build an instance containing the modifier key map for the AutoPy backend.

class guibot.inputmap.XDoToolKeyModifier[source]

Bases: guibot.inputmap.KeyModifier

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

__init__()[source]

Build an instance containing the modifier key map for the xdotool backend.

class guibot.inputmap.VNCDoToolKeyModifier[source]

Bases: guibot.inputmap.KeyModifier

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

__init__()[source]

Build an instance containing the modifier key map for the VNCDoTool backend.

class guibot.inputmap.QemuKeyModifier[source]

Bases: guibot.inputmap.KeyModifier

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

__init__()[source]

Build an instance containing the modifier key map for the Qemu backend.

class guibot.inputmap.MouseButton[source]

Bases: object

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

__init__()[source]

Build an instance containing an empty mouse button map.

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
class guibot.inputmap.AutoPyMouseButton[source]

Bases: guibot.inputmap.MouseButton

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

__init__()[source]

Build an instance containing the mouse button map for the AutoPy backend.

class guibot.inputmap.XDoToolMouseButton[source]

Bases: guibot.inputmap.MouseButton

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

__init__()[source]

Build an instance containing the mouse button map for the xdotool backend.

class guibot.inputmap.VNCDoToolMouseButton[source]

Bases: guibot.inputmap.MouseButton

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

__init__()[source]

Build an instance containing the mouse button map for the VNCDoTool backend.

class guibot.inputmap.QemuMouseButton[source]

Bases: guibot.inputmap.MouseButton

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

__init__()[source]

Build an instance containing the mouse button map for the Qemu backend.