Press

Module path

kivydk.uix.behavior.press

---

Overview

Provides pointer‑based press and release detection for widgets. PressBehavior listens to pointer events routed through the KiviDK PointerManager and dispatches on_press and on_release whenever a pointer button is pressed or released.

A press event is fired immediately when a pointer button is pressed. A release event is fired when the button released, and includes an inside flag indicating whether the release occurred within the widget’s bounds.

---

Example

Sample demonstrating how PressBehavior can be used to detect press and release actions on a widget.

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

from kivydk.uix.behavior import PressBehavior


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

        # Provide the default label context
        self.text = "Press Example"
        self.font_size = "18 dp"

    def on_press(self, button, modifiers):
        self.text = f"The {button!r} button was pressed."

    def on_release(self, button, modifiers, inside):
        self.text = f"The {button!r} button was released {'inside' if inside else 'outside'}."


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

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

    Example().run()

---

Reference

class PressBehavior(**kwargs)

Bases: object

A mixin that adds basic press and release detection to any widget.

Note

This behavior is intentionally lightweight and does not implement click logic. For click detection, use ClickBehavior.

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_press

Fired when a pointer button is pressed.

on_release

Fired when a pointer button is released.

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

Fired when a pointer button is pressed.

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_release(button: str | None, modifiers: list[str], inside: bool) → None

Fired when a pointer button is released.

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).
inside	True if the release occurred inside the widget, False otherwise.