GuiHostClientPage

class ansys.scade.guitools.page.GuiHostClientPage(*args, **kwargs)

Bases: ansys.scade.guitools.interfaces.IGuiHostClient, ContainerPage

Default implementation for GuiHost pages.

Overview

Abstract methods

on_build_ex

Build the controls and return an optional object for managing the persistence.

Methods

get_selected_models	Return a new list of models from the selection.
is_available	Return whether the page is available for the current selection.
on_build	Build the property page.
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.

Attributes

ddx

Import detail

from ansys.scade.guitools.page import GuiHostClientPage

Attribute detail

GuiHostClientPage.ddx: ansys.scade.guitools.interfaces.IPropertiesDataExchange | None = None

Method detail

GuiHostClientPage.get_selected_models(models: List[Any]) → List[Any]

Return a new list of models from the selection.

For example, replaces selected graphical elements by their associated semantic ones.

Parameters

modelsList[Any]

List of selected objects in the IDE.

Returns

List[Any]

List of objects to consider.

GuiHostClientPage.is_available(models: List[Any]) → bool

Return whether the page is available for the current selection.

Parameters

modelsList[Any]

List of selected objects in the IDE.

GuiHostClientPage.on_build(page: scade.tool.suite.gui.properties.Page, y: int)

Build the property page.

abstract GuiHostClientPage.on_build_ex(y: int) → ansys.scade.guitools.interfaces.IPropertiesDataExchange | None

Build the controls and return an optional object for managing the persistence.

Parameters

yint

Start vertical position.

Returns

Optional[IPropertiesDataExchange]

Object for exchanging data between the models and the controls.

GuiHostClientPage.on_close()

Perform any cleaning before the page is closed.

GuiHostClientPage.on_display()

Update the page with the properties read from the models.

GuiHostClientPage.on_layout()

Declare the contained control’s constraints.

GuiHostClientPage.on_validate()

Update the models with the properties read from the page.

GuiHostClientPage.set_models(models: List[Any])

Declare the models the page should consider.

Parameters

modelsList[Any]

List of selected objects in the IDE.

GuiHostClientPage.show(show: bool)

Show or hide the page.

This consists in showing or hiding the contained controls.

Parameters

showbool

Whether the page should be shown or hidden.