Merge pull request #3712 from JReesW/expose_clicks

exposed the mouse button event "clicks" property

Author: Starbuck5

docs/reST/ref/event.rst

@@ -72,8 +72,8 @@ specific attributes.
     KEYDOWN           key, mod, unicode, scancode
     KEYUP             key, mod, unicode, scancode
     MOUSEMOTION       pos, rel, buttons, touch
-    MOUSEBUTTONUP     pos, button, touch
-    MOUSEBUTTONDOWN   pos, button, touch
+    MOUSEBUTTONUP     pos, button, touch, clicks
+    MOUSEBUTTONDOWN   pos, button, touch, clicks
     JOYAXISMOTION     joy (deprecated), instance_id, axis, value
     JOYBALLMOTION     joy (deprecated), instance_id, ball, rel
     JOYHATMOTION      joy (deprecated), instance_id, hat, value
@@ -87,6 +87,12 @@ specific attributes.
 
 .. versionchangedold:: 2.0.1 The ``unicode`` attribute was added to ``KEYUP`` event.
 
+.. versionchangedold:: 2.5.7 The ``clicks`` attribute was added to ``MOUSEBUTTONDOWN`` and ``MOUSEBUTTONUP`` events.
+
+The ``clicks`` attribute of the ``MOUSEBUTTONDOWN`` and ``MOUSEBUTTONUP`` events indicate the number of clicks occurring
+in rapid succession, e.g. ``1`` for single-click, ``2`` for double-click, etc. Note that double, triple, or more clicks
+will still fire mouse events for each individual click, with a progressively increasing ``clicks`` attribute.
+
 Note that ``ACTIVEEVENT``, ``VIDEORESIZE`` and ``VIDEOEXPOSE`` are considered
 as "legacy" events, the use of pygame2 ``WINDOWEVENT`` API is recommended over
 the use of this older API.

src_c/event.c

@@ -1211,6 +1211,7 @@ dict_from_event(SDL_Event *event)
                                                   (int)event->button.y);
             _pg_insobj(dict, "pos", obj);
             _pg_insobj(dict, "button", PyLong_FromLong(event->button.button));
+            _pg_insobj(dict, "clicks", PyLong_FromLong(event->button.clicks));
             _pg_insobj(
                 dict, "touch",
                 PyBool_FromLong((event->button.which == SDL_TOUCH_MOUSEID)));