ui.screen_navigator_if.ScreenNavigatorIf Class Reference

Navigate between registered screens and expose navigation state. More...

Inheritance diagram for ui.screen_navigator_if.ScreenNavigatorIf:

Public Member Functions
ScreenId|None	active_screen_id (self)
	Return the active screen identifier, if a screen is active.
None	show_screen (self, ScreenId screen_id)
	Navigate to a screen and add the previous screen to history.
bool	go_back (self)
	Return to the previous screen.
None	go_home (self)
	Navigate to the frontend's configured home screen.

Detailed Description

Navigate between registered screens and expose navigation state.

Member Function Documentation

active_screen_id()

ScreenId | None ui.screen_navigator_if.ScreenNavigatorIf.active_screen_id

(

self

)

Return the active screen identifier, if a screen is active.

Returns

Active screen identifier, or None before navigation begins.

Reimplemented in apps.carUi.car_ui_frontend.CarUiFrontend.

go_back()

bool ui.screen_navigator_if.ScreenNavigatorIf.go_back

(

self

)

Return to the previous screen.

Returns

True when navigation occurred; False when history was empty.

Reimplemented in apps.carUi.car_ui_frontend.CarUiFrontend.

show_screen()

None ui.screen_navigator_if.ScreenNavigatorIf.show_screen	(		self,
		ScreenId	screen_id
	)

Navigate to a screen and add the previous screen to history.

Parameters

screen_id

Identifier of the registered destination screen.

Reimplemented in apps.carUi.car_ui_frontend.CarUiFrontend.

---

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

• ui/screen_navigator_if.py