OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
frontends.tk.lighting.lighting_screen.LightingScreen Class Reference

Present lighting state and connect lighting request handling. More...

Inheritance diagram for frontends.tk.lighting.lighting_screen.LightingScreen:
frontends.tk.tk_screen.TkScreen ui.lighting.lighting_ui_if.LightingUiIf ui.screen_ui_if.ScreenUiIf

Public Member Functions

None set_lighting_state (self, LightingState|None state)
 Set the displayed lighting snapshot, or clear unavailable state.
 
None set_lighting_request_handler (self, LightingRequestHandlerIf|None handler)
 Connect or clear the handler for user lighting requests.
 
None show (self)
 Build and display this screen's Tk panels.
 
- Public Member Functions inherited from frontends.tk.tk_screen.TkScreen
ScreenId screen_id (self)
 Return the stable identifier used to navigate to this screen.
 
None hide (self)
 Release transient screen activity before navigating away.
 
bool handle_ui_action (self, UiAction action)
 Return False until a screen provides semantic action handling.
 

Detailed Description

Present lighting state and connect lighting request handling.

Member Function Documentation

◆ set_lighting_request_handler()

None frontends.tk.lighting.lighting_screen.LightingScreen.set_lighting_request_handler (   self,
LightingRequestHandlerIf | None  handler 
)

Connect or clear the handler for user lighting requests.

Parameters
handlerRequest consumer, or None to disconnect it.

Reimplemented from ui.lighting.lighting_ui_if.LightingUiIf.

◆ set_lighting_state()

None frontends.tk.lighting.lighting_screen.LightingScreen.set_lighting_state (   self,
LightingState | None  state 
)

Set the displayed lighting snapshot, or clear unavailable state.

Parameters
stateComplete state snapshot, or None when unavailable.

Reimplemented from ui.lighting.lighting_ui_if.LightingUiIf.


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