OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.system.status_ui_if.StatusUiIf Class Reference

Present semantic application status information. More...

Inheritance diagram for ui.system.status_ui_if.StatusUiIf:
frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel frontends.tk.system.status_bar_panel.StatusBarPanel ui.system.status_ui_stub.StatusUiStub

Public Member Functions

None set_status (self, StatusValue status)
 Set or clear the current application status.
 

Detailed Description

Present semantic application status information.

Implementations may use a bar, notification area, log, overlay, speech, or another suitable presentation. The contract does not prescribe color, placement, duration, queuing, or dismissal behavior.

Member Function Documentation

◆ set_status()

None ui.system.status_ui_if.StatusUiIf.set_status (   self,
StatusValue  status 
)

Set or clear the current application status.

A string represents a concise informational status. Use StatusMessage when severity, detail, or source metadata matters.

Parameters
statusStructured status, concise text, or None to clear it.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, frontends.tk.system.status_bar_panel.StatusBarPanel, and ui.system.status_ui_stub.StatusUiStub.


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