Skip to content

Keyboard

flaui.core.input.Keyboard

Simulates Key input, wrapper over Keyboard class in FlaUI.Core.Input namespace

press(virtual_key) staticmethod

Presses the given key.

Parameters:

Name Type Description Default
virtual_key VirtualKeyShort

Virtual key

required
Source code in flaui/core/input.py
@staticmethod
def press(virtual_key: VirtualKeyShort) -> None:
    """Presses the given key.

    :param virtual_key: Virtual key
    """
    CSKeyboard.Press(virtual_key.value)

press_scan_code(scan_code, is_extended_key) staticmethod

Presses the given scan-code.

Parameters:

Name Type Description Default
scan_code int

Scan code

required
is_extended_key bool

Is Extended Key

required
Source code in flaui/core/input.py
@staticmethod
def press_scan_code(scan_code: int, is_extended_key: bool) -> None:
    """Presses the given scan-code.

    :param scan_code: Scan code
    :param is_extended_key: Is Extended Key
    """
    CSKeyboard.PressScanCode(scan_code, is_extended_key)

press_virtual_key_code(virtual_keycode) staticmethod

Presses the given virtual key-code.

Parameters:

Name Type Description Default
virtual_keycode int

Virtual key-code

required
Source code in flaui/core/input.py
@staticmethod
def press_virtual_key_code(virtual_keycode: int) -> None:
    """Presses the given virtual key-code.

    :param virtual_keycode: Virtual key-code
    """
    CSKeyboard.PressVirtualKeyCode(virtual_keycode)

pressing(virtual_keys) staticmethod

Presses the given keys and releases them when the returned object is disposed.

Parameters:

Name Type Description Default
virtual_keys List[VirtualKeyShort]

Virtual keys to enter

required
Source code in flaui/core/input.py
@staticmethod
def pressing(virtual_keys: List[VirtualKeyShort]) -> None:
    """Presses the given keys and releases them when the returned object is disposed.

    :param virtual_keys: Virtual keys to enter
    """
    CSKeyboard.Pressing([_.value for _ in virtual_keys])

release(virtual_key) staticmethod

Releases the given key

Parameters:

Name Type Description Default
virtual_key VirtualKeyShort

Virtual Key

required
Source code in flaui/core/input.py
@staticmethod
def release(virtual_key: VirtualKeyShort) -> None:
    """Releases the given key

    :param virtual_key: Virtual Key
    """
    CSKeyboard.Release(virtual_key.value)

release_scan_code(scan_code, is_extended_key) staticmethod

Releases the given scan-code.

Parameters:

Name Type Description Default
scan_code int

Scan code

required
is_extended_key bool

Is Extended Key

required
Source code in flaui/core/input.py
@staticmethod
def release_scan_code(scan_code: int, is_extended_key: bool) -> None:
    """Releases the given scan-code.

    :param scan_code: Scan code
    :param is_extended_key: Is Extended Key
    """
    CSKeyboard.ReleaseScanCode(scan_code, is_extended_key)

release_virtual_key_code(virtual_keycode) staticmethod

Releases the given virtual key-code.

Parameters:

Name Type Description Default
virtual_keycode int

Virtual key-code

required
Source code in flaui/core/input.py
@staticmethod
def release_virtual_key_code(virtual_keycode: int) -> None:
    """Releases the given virtual key-code.

    :param virtual_keycode: Virtual key-code
    """
    CSKeyboard.ReleaseVirtualKeyCode(virtual_keycode)

type(text) staticmethod

Types the given character.

Parameters:

Name Type Description Default
text Union[str, List[VirtualKeyShort]]

Text/Charecters/VirtualKeyShort key to enter

required
Source code in flaui/core/input.py
@staticmethod
def type(text: Union[str, List[VirtualKeyShort]]) -> None:
    """Types the given character.

    :param text: Text/Charecters/VirtualKeyShort key to enter
    """
    CSKeyboard.Type(text if isinstance(text, str) else [_.value for _ in text])

type_key(virtual_key) staticmethod

Types a single virtual key (press and release).

Parameters:

Name Type Description Default
virtual_key VirtualKeyShort

VirtualKeyShort key to type

required
Source code in flaui/core/input.py
@staticmethod
def type_key(virtual_key: VirtualKeyShort) -> None:
    """Types a single virtual key (press and release).

    :param virtual_key: VirtualKeyShort key to type
    """
    CSKeyboard.Type(virtual_key.value)

type_scan_code(scan_code, is_extended_key) staticmethod

Types the given scan-code.

Parameters:

Name Type Description Default
scan_code int

Scan code

required
is_extended_key bool

Is Extended Key

required
Source code in flaui/core/input.py
@staticmethod
def type_scan_code(scan_code: int, is_extended_key: bool) -> None:
    """Types the given scan-code.

    :param scan_code: Scan code
    :param is_extended_key: Is Extended Key
    """
    CSKeyboard.TypeScanCode(scan_code, is_extended_key)

type_simultaneously(text) staticmethod

Types the given keys simultaneously (starting with the first).

Parameters:

Name Type Description Default
text List[VirtualKeyShort]

VirtualKeyShort key to enter

required
Source code in flaui/core/input.py
@staticmethod
def type_simultaneously(text: List[VirtualKeyShort]) -> None:
    """Types the given keys simultaneously (starting with the first).

    :param text: VirtualKeyShort key to enter
    """
    CSKeyboard.TypeSimultaneously([_.value for _ in text])

type_virtual_key_code(virtual_keycode) staticmethod

Types the given virtual key-code.

Parameters:

Name Type Description Default
virtual_keycode int

Virtual key-code

required
Source code in flaui/core/input.py
@staticmethod
def type_virtual_key_code(virtual_keycode: int) -> None:
    """Types the given virtual key-code.

    :param virtual_keycode: Virtual key-code
    """
    CSKeyboard.TypeVirtualKeyCode(virtual_keycode)