OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
apps.carUi.car_ui_frontend.CarUiFrontend Class Reference

Render the Car UI shell and delegate application wiring. More...

Inheritance diagram for apps.carUi.car_ui_frontend.CarUiFrontend:
ui.ui_if.UiIf ui.ui_event_handler_if.UiEventHandlerIf ui.screen_navigator_if.ScreenNavigatorIf

Public Member Functions

bool initialize (self)
 Start composed services and make the frontend ready to run.
 
None run (self)
 Run the Tk event loop until shutdown.
 
None shutdown (self)
 Perform idempotent frontend shutdown.
 
None close (self)
 Stop composed services and destroy the Tk application.
 
None handle_ui_action (self, UiAction action)
 Route a semantic action through the application composition.
 
str empty_value (self)
 Return the theme placeholder for unavailable compact values.
 
None dispatch_ui (self, Callable[[], None] callback)
 Queue work for execution by the Tk event-loop thread.
 
tk.Misc screen_parent (self)
 Return the container for navigable screen content.
 
None activate_screen (self, ScreenUiIf screen)
 Make a screen the active semantic action target.
 
None clear_screen_content (self)
 Destroy widgets belonging to the previous destination.
 
ScreenId|None active_screen_id (self)
 Return the current route identifier, or None on the main menu.
 
None show_screen (self, ScreenId screen_id)
 Navigate to a registered screen while recording history.
 
bool go_back (self)
 Navigate to the previous route.
 
None go_home (self)
 Clear navigation history and display the main menu.
 

Protected Member Functions

None _apply_app_icon (self)
 Apply the OpenRoadCode logo to the Tk window and desktop shell.
 
None _drain_ui_queue (self)
 Execute queued worker callbacks exclusively on the Tk main thread.
 

Detailed Description

Render the Car UI shell and delegate application wiring.

Member Function Documentation

◆ activate_screen()

None apps.carUi.car_ui_frontend.CarUiFrontend.activate_screen (   self,
ScreenUiIf  screen 
)

Make a screen the active semantic action target.

Parameters
screenScreen to activate.

◆ dispatch_ui()

None apps.carUi.car_ui_frontend.CarUiFrontend.dispatch_ui (   self,
Callable[[], None]  callback 
)

Queue work for execution by the Tk event-loop thread.

This method may be called from worker threads. It intentionally performs no Tk/Tcl calls; the main thread drains the Python queue on a short timer.

Parameters
callbackWork to invoke on the Tk thread.

◆ empty_value()

str apps.carUi.car_ui_frontend.CarUiFrontend.empty_value (   self)

Return the theme placeholder for unavailable compact values.

Returns
Configured placeholder text.

◆ handle_ui_action()

None apps.carUi.car_ui_frontend.CarUiFrontend.handle_ui_action (   self,
UiAction  action 
)

Route a semantic action through the application composition.

Parameters
actionToolkit-independent UI action to route.

Reimplemented from ui.ui_event_handler_if.UiEventHandlerIf.

◆ initialize()

bool apps.carUi.car_ui_frontend.CarUiFrontend.initialize (   self)

Start composed services and make the frontend ready to run.

Returns
True unless the frontend has already been closed.

Reimplemented from ui.ui_if.UiIf.

◆ screen_parent()

tk.Misc apps.carUi.car_ui_frontend.CarUiFrontend.screen_parent (   self)

Return the container for navigable screen content.

Returns
Tk content frame owned by the application shell.

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