user.plugin.mouse.mouse.py
Modules
Actions
- user.copy_mouse_position()
Copy the current mouse position coordinates
- user.mouse_drag(button: int)
Press and hold/release a specific mouse button for dragging
- user.mouse_drag_end()
Releases any held mouse buttons
- user.mouse_gaze_scroll()
Starts gaze scroll
- user.mouse_hide_cursor()
Hides the cursor
- user.mouse_move_center_active_window()
move the mouse cursor to the center of the currently active window
- user.mouse_scroll_down(amount: float = <class 'float'>)
Scrolls down
- user.mouse_scroll_down_continuous()
Scrolls down continuously
- user.mouse_scroll_left(amount: float = <class 'float'>)
Scrolls left
- user.mouse_scroll_right(amount: float = <class 'float'>)
Scrolls right
- user.mouse_scroll_stop()
Stops scrolling
- user.mouse_scroll_up(amount: float = <class 'float'>)
Scrolls up
- user.mouse_scroll_up_continuous()
Scrolls up continuously
- user.mouse_show_cursor()
Shows the cursor
- user.mouse_sleep()
Disables control mouse, zoom mouse, and re-enables cursor
- user.mouse_wake()
Enable control mouse, zoom mouse, and disables cursor
Lists
- user.mouse_button
List of mouse button words to mouse_click index parameter
Settings
- user.mouse_enable_pop_click: int = TalonInteger(text='1', type_name='integer', start_position=Point(line=24, column=34), end_position=Point(line=24, column=35))
Pop noise clicks left mouse button. 0 = off, 1 = on with eyetracker but not with zoom mouse mode, 2 = on but not with zoom mouse mode
- user.mouse_enable_pop_stops_scroll: int = TalonInteger(text='1', type_name='integer', start_position=Point(line=18, column=41), end_position=Point(line=18, column=42))
When enabled, pop stops continuous scroll modes (wheel upper/downer/gaze)
- user.mouse_wake_hides_cursor: int = TalonInteger(text='0', type_name='integer', start_position=Point(line=30, column=35), end_position=Point(line=30, column=36))
When enabled, mouse wake will hide the cursor. mouse_wake enables zoom mouse.
- user.mouse_hide_mouse_gui: int = TalonInteger(text='0', type_name='integer', start_position=Point(line=27, column=32), end_position=Point(line=27, column=33))
When enabled, the 'Scroll Mouse' GUI will not be shown.
- user.mouse_continuous_scroll_amount: int = 80
The default amount used when scrolling continuously
- user.mouse_wheel_down_amount: int = 120
The amount to scroll up/down (equivalent to mouse wheel on Windows by default)
- user.mouse_wheel_horizontal_amount: int = 40
The amount to scroll left/right