OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.ui_if.UiIf Class Reference

Lifecycle contract implemented by a complete frontend. More...

Inheritance diagram for ui.ui_if.UiIf:
apps.carUi.car_ui_frontend.CarUiFrontend apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi ui.ui_stub.UiStub

Public Member Functions

bool initialize (self)
 Create resources and leave the frontend ready to run.
 
None run (self)
 Run the frontend event loop until it is asked to exit.
 
None shutdown (self)
 Release frontend resources; repeated calls must be safe.
 

Detailed Description

Lifecycle contract implemented by a complete frontend.

A frontend owns its toolkit application, top-level windows, event loop, and composed screens. Domain-specific UI contracts intentionally do not inherit this lifecycle.

Member Function Documentation

◆ initialize()

bool ui.ui_if.UiIf.initialize (   self)

Create resources and leave the frontend ready to run.

Returns
True when initialization succeeds.

Reimplemented in apps.carUi.car_ui_frontend.CarUiFrontend, apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, and ui.ui_stub.UiStub.


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