ui.screen_ui_if.ScreenUiIf Class Reference

Lifecycle and action contract for one navigable screen. More...

Inheritance diagram for ui.screen_ui_if.ScreenUiIf:

Public Member Functions
ScreenId	screen_id (self)
	Return the stable identifier used to navigate to this screen.
None	show (self)
	Make the screen active and ready to receive UI actions.
None	hide (self)
	Make the screen inactive and release transient activity.
bool	handle_ui_action (self, UiAction action)
	Handle a semantic action offered to the active screen.

Detailed Description

Lifecycle and action contract for one navigable screen.

Implementations may use any UI toolkit. A screen is a navigation destination and may compose any number of toolkit-specific panels and widgets.

Member Function Documentation

handle_ui_action()

bool ui.screen_ui_if.ScreenUiIf.handle_ui_action	(		self,
		UiAction	action
	)

Handle a semantic action offered to the active screen.

Parameters

action

Semantic UI action offered to the screen.

Returns

True when handled; False when the parent should handle it.

Reimplemented in frontends.tk.tk_screen.TkScreen, and ui.screen_ui_stub.ScreenUiStub.

screen_id()

ScreenId ui.screen_ui_if.ScreenUiIf.screen_id

(

self

)

Return the stable identifier used to navigate to this screen.

Returns

Stable screen identifier.

Reimplemented in frontends.tk.tk_screen.TkScreen, and ui.screen_ui_stub.ScreenUiStub.

---

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

• ui/screen_ui_if.py