Skip to content

Commit

Permalink
Update documentation for the Mouse action object
Browse files Browse the repository at this point in the history
The action's behaviour when the primary and secondary mouse buttons
are swapped is now documented.
  • Loading branch information
drmfinlay committed Mar 5, 2023
1 parent 2202f06 commit 2681aa2
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions dragonfly/actions/action_mouse.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
This section describes the :class:`Mouse` action object. This type of
action is used for controlling the mouse cursor and clicking mouse
button.
buttons.
Below you'll find some simple examples of :class:`Mouse` usage, followed
by a detailed description of the available mouse events.
Expand Down Expand Up @@ -105,9 +105,9 @@
- *keyname* -- Specifies which mouse button to click:
- ``left`` -- left mouse button key
- ``left`` -- left (primary) mouse button key
- ``middle`` -- middle mouse button key
- ``right`` -- right mouse button key
- ``right`` -- right (secondary) mouse button key
- ``four`` -- fourth mouse button key
- ``five`` -- fifth mouse button key
- ``wheelup`` -- mouse wheel up
Expand Down Expand Up @@ -170,6 +170,13 @@
#Mouse("left, left").execute()
#Mouse("left, left, left").execute()
A further caveat to be aware of is that the :class:`Mouse` action object
will, when sending mouse events, always treat the *left* mouse button as
primary and the *right* mouse button as secondary. This means that any
system setting for switching the primary and secondary mouse buttons (meant
for left-handed users) will not affect which buttons are pressed when a
:class:`Mouse` action object is executed.
.. _RefNatlinkMouseInput:
Expand Down

0 comments on commit 2681aa2

Please sign in to comment.