test-kivy-app/kivy_venv/lib/python3.11/site-packages/kivy/modules/cursor.py

76 lines
2.0 KiB
Python
Raw Normal View History

2024-09-15 12:12:16 +00:00
'''
Cursor
======
Shows a cursor following mouse motion events, useful on systems with no
visible native mouse cursor.
Configuration
-------------
:Parameters:
`texture`: str, defaults to
'data/images/cursor.png' Image used to represent the cursor if
displayed
`size`: tuple, defaults to (40, 40)
Apparent size of the mouse cursor, if displayed, (None,None) value
will keep its real size.
`offset`: tuple, defaults to (None, None)
Offset of the texture image. The default value will align the
top-left corner of the image to the mouse pos.
Example
-------
In your configuration (`~/.kivy/config.ini`), you can add something like
this::
[modules]
cursor = texture=mypointer.png,size=20x20,offset=20x20
.. versionadded:: 1.10.0
'''
__all__ = ('start', 'stop')
from kivy.core.image import Image
from kivy.graphics import Color, Rectangle
from kivy import kivy_data_dir
from kivy.compat import string_types
from os.path import join
from functools import partial
def _mouse_move(texture, size, offset, win, pos, *args):
if hasattr(win, '_cursor'):
c = win._cursor
else:
with win.canvas.after:
Color(1, 1, 1, 1, mode='rgba')
win._cursor = c = Rectangle(texture=texture, size=size)
c.pos = pos[0] + offset[0], pos[1] - size[1] + offset[1]
def start(win, ctx):
cursor_texture = Image(
ctx.config.get('texture', join(kivy_data_dir, 'images', 'cursor.png'))
).texture
cursor_size = ctx.config.get('size')
if isinstance(cursor_size, string_types):
cursor_size = [int(x) for x in cursor_size.split('x')]
elif not cursor_size:
cursor_size = cursor_texture.size
cursor_offset = ctx.config.get('offset', (0, 0))
if isinstance(cursor_offset, string_types):
cursor_offset = [int(x) for x in cursor_offset.split('x')]
win.bind(
mouse_pos=partial(
_mouse_move, cursor_texture, cursor_size, cursor_offset))
def stop(win, ctx):
win.unbind(mouse_pos=_mouse_move)