Rooba
/
kivy
mirror of https://github.com/kivy/kivy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3194 from kived/scrollview-event-docs 

document scrollview generic events
This commit is contained in:
Ryan Pessa 2015-03-27 16:11:38 -05:00
parent d57ec5bc7c d48c94faca
commit 6cd5aefec9
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
kivy/uix/scrollview.py
View File

@ -135,6 +135,18 @@ if Config:
class ScrollView(StencilView): class ScrollView(StencilView):
'''ScrollView class. See module documentation for more information. '''ScrollView class. See module documentation for more information.
:Events:
`on_scroll_start`
Generic event fired when scrolling starts from touch.
`on_scroll_move`
Generic event fired when scrolling move from touch.
`on_scroll_stop`
Generic event fired when scrolling stops from touch.
.. versionchanged:: 1.9.0
`on_scroll_start`, `on_scroll_move` and `on_scroll_stop` events are
now dispatched when scrolling to handle nested ScrollViews.
.. versionchanged:: 1.7.0 .. versionchanged:: 1.7.0
`auto_scroll`, `scroll_friction`, `scroll_moves`, `scroll_stoptime' has `auto_scroll`, `scroll_friction`, `scroll_moves`, `scroll_stoptime' has
been deprecated, use :attr:`effect_cls` instead. been deprecated, use :attr:`effect_cls` instead.
@ -416,6 +428,8 @@ class ScrollView(StencilView):
value.bind(size=self._set_viewport_size) value.bind(size=self._set_viewport_size)
self.viewport_size = value.size self.viewport_size = value.size
__events__ = ('on_scroll_start', 'on_scroll_move', 'on_scroll_stop')
def __init__(self, **kwargs): def __init__(self, **kwargs):
self._touch = None self._touch = None
self._trigger_update_from_scroll = Clock.create_trigger( self._trigger_update_from_scroll = Clock.create_trigger(