OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.lighting.lighting_ui_if.LightingUiIf Class Reference

Display complete lighting state and emit semantic lighting requests. More...

Inheritance diagram for ui.lighting.lighting_ui_if.LightingUiIf:
frontends.tk.lighting.lighting_screen.LightingScreen ui.lighting.lighting_ui_stub.LightingUiStub

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.
 

Detailed Description

Display complete lighting state and emit semantic lighting requests.

Member Function Documentation

◆ set_lighting_request_handler()

None ui.lighting.lighting_ui_if.LightingUiIf.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 in frontends.tk.lighting.lighting_screen.LightingScreen, and ui.lighting.lighting_ui_stub.LightingUiStub.

◆ set_lighting_state()

None ui.lighting.lighting_ui_if.LightingUiIf.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 in frontends.tk.lighting.lighting_screen.LightingScreen, and ui.lighting.lighting_ui_stub.LightingUiStub.


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