Skip to content

README.md

Latest commit

 

History

History
42 lines (36 loc) · 1.41 KB

README.md

File metadata and controls

42 lines (36 loc) · 1.41 KB

Event manager and behavior for hover events

Install

Requires Kivy>=2.1.0 as support for event managers is introduced in that version.

pip install git+https://github.com/pythonic64/hover.git

Import

from kivy_garden.hover import (
    HoverManager,
    HoverBehavior,
    HoverCollideBehavior
)

Package content

  • HoverManager - an event manager which once registered will dispatch hover events throughout the widget tree.
  • HoverBehavior - a mixin class to be used with widgets. Class supports multi-hover and it also provides:
    • hovered boolean property which is True when a hover indicator (e.g. mouse) is hovering over a widget.
    • on_hover_enter, on_hover_update, on_hover_leave events which will dispatch when a hover indicator has entered, hovered over, or left a widget.
  • HoverCollideBehavior - a mixin class to be used with a StencilView or its subclasses to filter hover events which are currently grabbed by the widget itself or events which collide with the widget.

Examples

See simple_app.py for a basic example on how to register a HoverManager and use a HoverBehavior with a Label widget.

See large_app.py for an example covering more different use cases.

License

This software is released under the terms of the MIT License. Please see the LICENSE.txt file.