ui.system.top_bar_ui_if.TopBarUiIf Class Reference

Present screen navigation and compact vehicle status information. More...

Inheritance diagram for ui.system.top_bar_ui_if.TopBarUiIf:

Public Member Functions
None	set_title (self, str title)
	Set the current screen or menu title.
None	set_back_action (self, Callable[[], None] action)
	Set the action requested by the back control.
None	show_back_button (self, str|None text=None)
	Show the back control, optionally with custom text.
None	hide_back_button (self)
	Hide the back control.
None	invoke_back_action (self)
	Request the configured back action.
None	set_frequency_text (self, str text)
	Set the compact radio-frequency status text.
None	set_location_text (self, str text)
	Set the compact geographic-location status text.

Detailed Description

Present screen navigation and compact vehicle status information.

Member Function Documentation

set_back_action()

None ui.system.top_bar_ui_if.TopBarUiIf.set_back_action	(		self,
		Callable[[], None]	action
	)

Set the action requested by the back control.

Parameters

action

Callback invoked by the back control.

Reimplemented in frontends.tk.system.top_bar_panel.TopBarPanel, and ui.system.top_bar_ui_stub.TopBarUiStub.

set_frequency_text()

None ui.system.top_bar_ui_if.TopBarUiIf.set_frequency_text	(		self,
		str	text
	)

Set the compact radio-frequency status text.

Parameters

text	Formatted frequency text or unavailable placeholder.

Reimplemented in frontends.tk.system.top_bar_panel.TopBarPanel, and ui.system.top_bar_ui_stub.TopBarUiStub.

set_location_text()

None ui.system.top_bar_ui_if.TopBarUiIf.set_location_text	(		self,
		str	text
	)

Set the compact geographic-location status text.

Parameters

text	Formatted location text or unavailable placeholder.

Reimplemented in frontends.tk.system.top_bar_panel.TopBarPanel, and ui.system.top_bar_ui_stub.TopBarUiStub.

set_title()

None ui.system.top_bar_ui_if.TopBarUiIf.set_title	(		self,
		str	title
	)

Set the current screen or menu title.

Parameters

title

User-visible title text.

Reimplemented in frontends.tk.system.top_bar_panel.TopBarPanel, and ui.system.top_bar_ui_stub.TopBarUiStub.

show_back_button()

None ui.system.top_bar_ui_if.TopBarUiIf.show_back_button	(		self,
		str | None	text = None
	)

Show the back control, optionally with custom text.

Parameters

text	Optional custom back-control label.

Reimplemented in frontends.tk.system.top_bar_panel.TopBarPanel, and ui.system.top_bar_ui_stub.TopBarUiStub.

---

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

• ui/system/top_bar_ui_if.py