Table Of Contents

• Kivy Base

Kivy Base

This module contains the Kivy core functionality and is not intended for end users. Feel free to look through it, but bare in mind that calling any of these methods directly may result in an unpredictable behavior as the calls access directly the event loop of an application.

kivy.base.EventLoop = <kivy.base.EventLoopBase object>

EventLoop instance

class kivy.base.EventLoopBase

Bases: kivy.event.EventDispatcher

Main event loop. This loop handles the updating of input and dispatching events.

add_event_listener(listener)

Add a new event listener for getting touch events.

add_input_provider(provider, auto_remove=False)

Add a new input provider to listen for touch events.

add_postproc_module(mod)

Add a postproc input module (DoubleTap, TripleTap, DeJitter RetainTouch are defaults).

async async_idle()

Identical to idle(), but instead used when running within an async event loop.

close()

Exit from the main loop and stop all configured input providers.

dispatch_input()

Called by EventLoopBase.idle() to read events from input providers, pass events to postproc, and dispatch final events.

ensure_window()

Ensure that we have a window.

exit()

Close the main loop and close the window.

idle()

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_pause()

Event handler for on_pause which will be fired when the event loop is paused.

on_start()

Event handler for on_start which will be fired right after all input providers have been started.

on_stop()

Event handler for on_stop events which will be fired right after all input providers have been stopped.

post_dispatch_input(etype, me)

This function is called by EventLoopBase.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.

remove_android_splash(*args)

Remove android presplash in SDL2 bootstrap.

remove_event_listener(listener)

Remove an event listener from the list.

remove_input_provider(provider)

Remove an input provider.

Changed in version 2.1.0: Provider will be also removed if it exist in auto-remove list.

remove_postproc_module(mod)

Remove a postproc module.

run()

Main loop

set_window(window)

Set the window used for the event loop.

start()

Must be called before EventLoopBase.run(). This starts all configured input providers.

Changed in version 2.1.0: Method can be called multiple times, but event loop will start only once.

stop()

Stop all input providers and call callbacks registered using EventLoop.add_stop_callback().

Changed in version 2.1.0: Method can be called multiple times, but event loop will stop only once.

property touches

Return the list of all touches currently in down or move states.

class kivy.base.ExceptionHandler

Bases: builtins.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 caught by ExceptionHandler')
        return ExceptionManager.PASS

ExceptionManager.add_handler(E())

Then, all exceptions will be set to PASS, and logged to the console!

handle_exception(exception)

Called by ExceptionManagerBase to handle a exception.

Defaults to returning ExceptionManager.RAISE that re-raises the exception. Return ExceptionManager.PASS to indicate that the exception was handled and should be ignored.

This may be called multiple times with the same exception, if ExceptionManager.RAISE is returned as the exception bubbles through multiple kivy exception handling levels.

kivy.base.ExceptionManager: kivy.base.ExceptionManagerBase = <kivy.base.ExceptionManagerBase object>

The ExceptionManagerBase instance that handles kivy exceptions.

class kivy.base.ExceptionManagerBase

Bases: builtins.object

ExceptionManager manages exceptions handlers.

PASS = 1

The exception should be ignored as it was handled by the handler.

RAISE = 0

The exception should be re-raised.

add_handler(cls)

Add a new exception handler to the stack.

handle_exception(inst)

Called when an exception occurred in the runTouchApp() main loop.

remove_handler(cls)

Remove the exception handler from the stack.

async kivy.base.async_runTouchApp(widget=None, embedded=False, async_lib=None)

Identical to runTouchApp() but instead it is a coroutine that can be run in an existing async event loop.

async_lib is the async library to use. See kivy.app for details and example usage.

New in version 2.0.0.

kivy.base.runTouchApp(widget=None, embedded=False)

Static main function that starts the application loop. You can access some magic via the following arguments:

See kivy.app for example usage.

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.

embedded

No event dispatching is done. This will be your job.

widget + embedded

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 useful for embedding Kivy in another toolkit. (like Qt, check kivy-designed)

kivy.base.stopTouchApp()

Stop the current application by leaving the main loop.

See kivy.app for example usage.

« Interactive launcher

Logger object »