ui.ui_dispatcher_if.UiDispatcherIf Class Reference

Schedule callbacks without exposing a concrete frontend event loop. More...

Inheritance diagram for ui.ui_dispatcher_if.UiDispatcherIf:

Public Member Functions
None	dispatch_ui (self, Callable[[], None] callback)
	Arrange for work to run on the frontend thread.
object	schedule_ui_callback (self, int delay_ms, Callable[[], None] callback)
	Run work after a delay and return a cancellation token.
None	cancel_ui_callback (self, object callback_id)
	Cancel a previously scheduled callback when it is still pending.

Detailed Description

Schedule callbacks without exposing a concrete frontend event loop.

Member Function Documentation

cancel_ui_callback()

None ui.ui_dispatcher_if.UiDispatcherIf.cancel_ui_callback	(		self,
		object	callback_id
	)

Cancel a previously scheduled callback when it is still pending.

Parameters

callback_id

Token returned by schedule_ui_callback().

dispatch_ui()

None ui.ui_dispatcher_if.UiDispatcherIf.dispatch_ui	(		self,
		Callable[[], None]	callback
	)

Arrange for work to run on the frontend thread.

Parameters

callback

Work to invoke on the frontend thread.

schedule_ui_callback()

object ui.ui_dispatcher_if.UiDispatcherIf.schedule_ui_callback	(		self,
		int	delay_ms,
		Callable[[], None]	callback
	)

Run work after a delay and return a cancellation token.

Parameters

delay_ms	Non-negative scheduling delay in milliseconds.
callback	Work to invoke after the delay.

Returns

Opaque token identifying the pending callback.

---

The documentation for this class was generated from the following file:

• ui/ui_dispatcher_if.py