frontends.tk.tk_screen_host_if.TkScreenHostIf Class Reference

Operations a Tk application shell provides to hosted screens. More...

Inherits Protocol.

Public Member Functions
tk.Misc	screen_parent (self)
	Return the Tk container in which screen content is created.
None	activate_screen (self, ScreenUiIf screen)
	Make a screen the target for semantic UI actions.
None	clear_screen_content (self)
	Destroy content belonging to the previously displayed screen.
None	set_screen_title (self, str title)
	Set the application-shell title for the active screen.
None	set_screen_back_action (self, Callable[[], None] action)
	Configure and show the active screen's back action.
None	set_screen_status (self, str message)
	Set application status associated with the active screen.
object	schedule_ui_callback (self, int delay_ms, Callable[[], None] callback)
	Schedule work on the Tk event-loop thread.
None	cancel_ui_callback (self, object callback_id)
	Cancel scheduled UI work when it has not yet run.

Detailed Description

Operations a Tk application shell provides to hosted screens.

Member Function Documentation

activate_screen()

None frontends.tk.tk_screen_host_if.TkScreenHostIf.activate_screen	(		self,
		ScreenUiIf	screen
	)

Make a screen the target for semantic UI actions.

Parameters

screen

Screen that becomes the active action target.

cancel_ui_callback()

None frontends.tk.tk_screen_host_if.TkScreenHostIf.cancel_ui_callback	(		self,
		object	callback_id
	)

Cancel scheduled UI work when it has not yet run.

Parameters

callback_id

Token returned by schedule_ui_callback().

schedule_ui_callback()

object frontends.tk.tk_screen_host_if.TkScreenHostIf.schedule_ui_callback	(		self,
		int	delay_ms,
		Callable[[], None]	callback
	)

Schedule work on the Tk event-loop thread.

Parameters

delay_ms	Non-negative delay in milliseconds.
callback	Work to invoke after the delay.

Returns

Opaque token that can cancel the pending callback.

screen_parent()

tk.Misc frontends.tk.tk_screen_host_if.TkScreenHostIf.screen_parent

(

self

)

Return the Tk container in which screen content is created.

Returns

Parent Tk widget for hosted screen content.

set_screen_back_action()

None frontends.tk.tk_screen_host_if.TkScreenHostIf.set_screen_back_action	(		self,
		Callable[[], None]	action
	)

Configure and show the active screen's back action.

Parameters

action

Callback invoked by the shell back control.

set_screen_status()

None frontends.tk.tk_screen_host_if.TkScreenHostIf.set_screen_status	(		self,
		str	message
	)

Set application status associated with the active screen.

Parameters

message

User-visible status message.

set_screen_title()

None frontends.tk.tk_screen_host_if.TkScreenHostIf.set_screen_title	(		self,
		str	title
	)

Set the application-shell title for the active screen.

Parameters

title

User-visible title to display in the shell.

---

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

• frontends/tk/tk_screen_host_if.py