Click

Module path

kivydk.uix.behavior.click

---

Overview

Provides a pointer‑based click detection behavior for widgets. ClickBehavior listens to pointer release events routed through the KiviDK PointerManager and implements a consistent model for single‑click and double‑click recognition.

---

Example

Sample demonstrating how ClickBehavior can be used to detect and handle click events.

#// IMPORT
from kivy.uix.label import Label

from kivydk.uix.behavior import ClickBehavior


#// LOGIC
class TestClick(ClickBehavior, Label):
    """ Each event updates the label text to reflect the current click state. """
    def __init__(self, **kwargs):
        super().__init__(**kwargs)

        # Local variables
        self.count_click = 0
        self.count_double_click = 0
        self.last_button_click = "-"
        self.last_button_double_click = "-"

        # Initialize the label text with default information
        self.update_text()

    def on_click(self, button, modifiers):
        self.count_click += 1
        self.last_button_click = button
        self.update_text()

    def on_double_click(self, button, modifiers):
        self.count_double_click += 1
        self.last_button_double_click = button
        self.update_text()

    def update_text(self):
        """ Update the label text to display the current click information. """
        single_click = f"Click's amount: %.2d" % self.count_click
        double_click = f"Double click's amount: %.2d" % self.count_double_click
        last_single_click = f"Last clicked button: %s" % self.last_button_click
        last_double_click = f"Last double clicked button: %s" % self.last_button_double_click

        self.text = f"{single_click}\n{double_click}\n\n{last_single_click}\n{last_double_click}"


#// RUN FILE
if __name__ == "__main__":
    from kivydk.app import App

    class Example(App):
        def build(self):
            return TestClick(size_hint_y=None, height=256)

    Example().run()

---

Reference

class ClickBehavior(**kwargs)

Bases: object

A mixin that adds click and double‑click detection to any widget.

A click is recognized when a pointer is pressed and released inside the widget without leaving its bounds. Two valid clicks of the same pointer within click_interval form a double‑click.

Note

This behavior does not provide on_press or on_release callbacks. If you require those events, inherit from Kivy’s ButtonBehavior or KivyDK’s PressBehavior.

Events

Todo

The current event implementation relies on __events__ being defined as a class attribute. This works for now, but it overrides inherited Kivy events.

When revisiting the event system, consider migrating to register_event_type() and updating the DocLang command to support dynamically registered events.

on_click

Called when the widget receives a valid pointer click.

on_double_click

Called when two consecutive valid clicks occur within click_interval.

click_interval: NumericProperty

Maximum time (in seconds) in which a second click is considered part of a double‑click.

The sweet spot is between 0.2 and 0.3.

Default value

0.25

on_click(button: str | None, modifiers: list[str]) → None

Called when the widget receives a valid pointer click.

Parameters

Name	Description
button	The name of the pointer button that triggered the event, or None.
modifiers	A list of active modifier keys (e.g. alt, ctrl, shift, numlock).

on_double_click(button: str | None, modifiers: list[str]) → None

Called when two consecutive valid clicks occur within click_interval.

Parameters

Name	Description
button	The name of the pointer button that triggered the event, or None.
modifiers	A list of active modifier keys (e.g. alt, ctrl, shift, numlock).