Table Of Contents
Kivy Base¶
This module contains core Kivy functionality and is not intended for end users. Feel free to look though it, but calling any of these methods directly may well result in unpredicatable behavior.
Event loop management¶
- kivy.base.EventLoop = <kivy.base.EventLoopBase object at 0x807b4cc18>¶
EventLoop instance
- class kivy.base.EventLoopBase[source]¶
Bases: kivy.event.EventDispatcher
Main event loop. This loop handles the updating of input and dispatching events.
- add_input_provider(provider, auto_remove=False)[source]¶
Add a new input provider to listen for touch events.
- add_postproc_module(mod)[source]¶
Add a postproc input module (DoubleTap, TripleTap, DeJitter RetainTouch are defaults).
- dispatch_input()[source]¶
Called by idle() to read events from input providers, pass events to postproc, and dispatch final events.
- idle()[source]¶
This function is called after every frame. By default:
- it “ticks” the clock to the next frame.
- it reads all input and dispatches events.
- it dispatches on_update, on_draw and on_flip events to the window.
- on_start()[source]¶
Event handler for on_start which will be fired right after all input providers have been started.
- on_stop()[source]¶
Event handler for on_stop events which will be fired right after all input providers have been stopped.
- post_dispatch_input(etype, me)[source]¶
This function is called by dispatch_input() when we want to dispatch an input event. The event is dispatched to all listeners and if grabbed, it’s dispatched to grabbed widgets.
- class kivy.base.ExceptionHandler[source]¶
Bases: object
Base handler that catches exceptions in runTouchApp(). You can subclass and extend it as follows:
class E(ExceptionHandler): def handle_exception(self, inst): Logger.exception('Exception catched by ExceptionHandler') return ExceptionManager.PASS ExceptionManager.add_handler(E())
All exceptions will be set to PASS, and logged to the console!
- kivy.base.ExceptionManager = <kivy.base.ExceptionManagerBase instance at 0x8083a67a0>¶
Instance of a ExceptionManagerBase implementation.
- kivy.base.runTouchApp(widget=None, slave=False)[source]¶
Static main function that starts the application loop. You can access some magic via the following arguments:
Parameters: - <empty>
To make dispatching work, you need at least one input listener. If not, application will leave. (MTWindow act as an input listener)
- widget
If you pass only a widget, a MTWindow will be created and your widget will be added to the window as the root widget.
- slave
No event dispatching is done. This will be your job.
- widget + slave
No event dispatching is done. This will be your job but we try to get the window (must be created by you beforehand) and add the widget to it. Very usefull for embedding Kivy in another toolkit. (like Qt, check kivy-designed)