`IGuiHostClient`#

class ansys.scade.guitools.interfaces.IGuiHostClient#

Defines the interface for hosted pages.

Overview#

Abstract methods

`is_available`	Return whether the page is available for the current selection.
`on_build`	Build the controls.
`on_close`	Perform any cleaning before the page is closed.
`on_display`	Update the page with the properties read from the models.
`on_layout`	Declare the contained control’s constraints.
`on_validate`	Update the models with the properties read from the page.
`set_models`	Declare the models the page should consider.
`show`	Show or hide the page.

from ansys.scade.guitools.interfaces import IGuiHostClient

abstract IGuiHostClient.is_available(models: List[Any]) → bool#

Return whether the page is available for the current selection.

abstract IGuiHostClient.on_build(page: scade.tool.suite.gui.properties.Page, y: int) → int#

Build the controls.

abstract IGuiHostClient.on_close()#: Perform any cleaning before the page is closed.

abstract IGuiHostClient.on_display()#: Update the page with the properties read from the models.

abstract IGuiHostClient.on_layout()#: Declare the contained control’s constraints.

abstract IGuiHostClient.on_validate()#: Update the models with the properties read from the page.

abstract IGuiHostClient.set_models(models: List[Any])#

Declare the models the page should consider.

abstract IGuiHostClient.show(show: bool)#

Show or hide the page.

This consists in showing or hiding the contained controls.