Mouse API
Functions for controlling the mouse cursor.
get_mouse_table
- get_mouse_table()
Returns the mouse key table for the current platform.
- Returns:
Dictionary mapping mouse button names to platform-specific key codes.
- Return type:
dict
mouse_preprocess
- mouse_preprocess(mouse_keycode, x, y)
Validates the mouse key code and resolves the cursor position. If
xoryisNone, the current mouse position is used.- Parameters:
mouse_keycode (int or str) – Mouse button name or key code.
x (int) – X coordinate. If
None, uses current position.y (int) – Y coordinate. If
None, uses current position.
- Returns:
Tuple of
(keycode, x, y).- Return type:
tuple
get_mouse_position
- get_mouse_position()
Returns the current mouse cursor position.
- Returns:
Tuple of
(x, y).- Return type:
tuple[int, int]
set_mouse_position
- set_mouse_position(x, y)
Moves the mouse cursor to the specified coordinates.
- Parameters:
x (int) – Target X position.
y (int) – Target Y position.
- Returns:
Tuple of
(x, y).- Return type:
tuple[int, int]
press_mouse
- press_mouse(mouse_keycode, x=None, y=None)
Presses and holds a mouse button at the specified position.
- Parameters:
mouse_keycode (int or str) – Mouse button name (e.g.,
"mouse_left").x (int) – X position (default: current position).
y (int) – Y position (default: current position).
- Returns:
Tuple of
(keycode, x, y).- Return type:
tuple
release_mouse
- release_mouse(mouse_keycode, x=None, y=None)
Releases a previously pressed mouse button.
- Parameters:
mouse_keycode (int or str) – Mouse button name (e.g.,
"mouse_left").x (int) – X position (default: current position).
y (int) – Y position (default: current position).
- Returns:
Tuple of
(keycode, x, y).- Return type:
tuple
click_mouse
- click_mouse(mouse_keycode, x=None, y=None)
Presses and releases a mouse button at the specified position.
- Parameters:
mouse_keycode (int or str) – Mouse button name (e.g.,
"mouse_left").x (int) – X position (default: current position).
y (int) – Y position (default: current position).
- Returns:
Tuple of
(keycode, x, y).- Return type:
tuple
mouse_scroll
- mouse_scroll(scroll_value, x=None, y=None, scroll_direction='scroll_down')
Scrolls the mouse wheel.
- Parameters:
scroll_value (int) – Number of scroll units.
x (int) – X position (default: current position).
y (int) – Y position (default: current position).
scroll_direction (str) – Scroll direction (Linux only). One of:
"scroll_up","scroll_down","scroll_left","scroll_right".
- Returns:
Tuple of
(scroll_value, direction).- Return type:
tuple