OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.screen_ui_stub.ScreenUiStub Class Reference

Provide inert lifecycle and action behavior for a named screen. More...

Inheritance diagram for ui.screen_ui_stub.ScreenUiStub:
ui.screen_ui_if.ScreenUiIf

Public Member Functions

ScreenId screen_id (self)
 Return the stable identifier used to navigate to this screen.
 
None show (self)
 Make the screen active and ready to receive UI actions.
 
None hide (self)
 Make the screen inactive and release transient activity.
 
bool handle_ui_action (self, UiAction action)
 Handle a semantic action offered to the active screen.
 

Detailed Description

Provide inert lifecycle and action behavior for a named screen.

Member Function Documentation

◆ handle_ui_action()

bool ui.screen_ui_stub.ScreenUiStub.handle_ui_action (   self,
UiAction  action 
)

Handle a semantic action offered to the active screen.

Parameters
actionSemantic UI action offered to the screen.
Returns
True when handled; False when the parent should handle it.

Reimplemented from ui.screen_ui_if.ScreenUiIf.

◆ screen_id()

ScreenId ui.screen_ui_stub.ScreenUiStub.screen_id (   self)

Return the stable identifier used to navigate to this screen.

Returns
Stable screen identifier.

Reimplemented from ui.screen_ui_if.ScreenUiIf.


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