OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
frontends.tk.radio.radio_panel.RadioPanel Class Reference

Present radio state and forward semantic user requests to injected handlers. More...

Inheritance diagram for frontends.tk.radio.radio_panel.RadioPanel:
ui.radio.radio_ui_if.RadioUiIf

Public Member Functions

None start (self)
 Start periodic semantic refresh requests.
 
None stop_radio_status_polling (self)
 Stop periodic refresh requests.
 
None set_signal (self, TunedSignal|None signal)
 Set the tuned-signal display state.
 
None add_preset (self, RadioPreset preset)
 Add one preset to the radio UI.
 
None clear_presets (self)
 Remove all presets from the radio UI.
 
None set_receiver_active (self, bool active)
 Set whether the receiver is currently active.
 
None set_active_preset (self, int|None preset_index)
 Select the active zero-based preset, if any.
 
None set_preset_request_handler (self, PresetRequestHandlerIf|None handler)
 Set or clear the preset request handler.
 
None set_playback_request_handler (self, PlaybackRequestHandlerIf|None handler)
 Set or clear the playback request handler.
 
None set_station_request_handler (self, StationRequestHandlerIf|None handler)
 Set or clear the station-navigation request handler.
 
None set_tuning_request_handler (self, TuningRequestHandlerIf|None handler)
 Set or clear the frequency-tuning request handler.
 
None set_application_request_handler (self, RadioApplicationRequestHandlerIf|None handler)
 Set or clear companion-application requests.
 
None set_refresh_request_handler (self, RadioRefreshRequestHandlerIf|None handler)
 Set or clear periodic refresh requests.
 

Detailed Description

Present radio state and forward semantic user requests to injected handlers.

Member Function Documentation

◆ add_preset()

None frontends.tk.radio.radio_panel.RadioPanel.add_preset (   self,
RadioPreset  preset 
)

Add one preset to the radio UI.

Parameters
presetPreset to add.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_active_preset()

None frontends.tk.radio.radio_panel.RadioPanel.set_active_preset (   self,
int | None  preset_index 
)

Select the active zero-based preset, if any.

Parameters
preset_indexZero-based preset index, or None for no selection.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_application_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_application_request_handler (   self,
RadioApplicationRequestHandlerIf | None  handler 
)

Set or clear companion-application requests.

Parameters
handlerApplication request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_playback_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_playback_request_handler (   self,
PlaybackRequestHandlerIf | None  handler 
)

Set or clear the playback request handler.

Parameters
handlerPlayback request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_preset_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_preset_request_handler (   self,
PresetRequestHandlerIf | None  handler 
)

Set or clear the preset request handler.

Parameters
handlerPreset request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_receiver_active()

None frontends.tk.radio.radio_panel.RadioPanel.set_receiver_active (   self,
bool  active 
)

Set whether the receiver is currently active.

Parameters
activeTrue while the receiver is active.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_refresh_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_refresh_request_handler (   self,
RadioRefreshRequestHandlerIf | None  handler 
)

Set or clear periodic refresh requests.

Parameters
handlerRefresh request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_signal()

None frontends.tk.radio.radio_panel.RadioPanel.set_signal (   self,
TunedSignal | None  signal 
)

Set the tuned-signal display state.

Parameters
signalCurrent tuned signal, or None when unavailable.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_station_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_station_request_handler (   self,
StationRequestHandlerIf | None  handler 
)

Set or clear the station-navigation request handler.

Parameters
handlerStation request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.

◆ set_tuning_request_handler()

None frontends.tk.radio.radio_panel.RadioPanel.set_tuning_request_handler (   self,
TuningRequestHandlerIf | None  handler 
)

Set or clear the frequency-tuning request handler.

Parameters
handlerTuning request handler, or None to disconnect it.

Reimplemented from ui.radio.radio_ui_if.RadioUiIf.


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