SettingsPageEx#

class ansys.scade.guitools.page.SettingsPageEx(label_width: int, *args, **kwargs)#

Bases: scade.tool.suite.gui.settings.Page, ContainerPage

Provides a base class for settings pages.

It introduces a new abstract method that must be implemented for building the controls.

Overview#

on_build_ex

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

on_build

Build the settings page.

on_display

Update the page with the properties read from the project.

on_layout

Specify how controls are moved or resized.

on_validate

Update the project with the properties read from the page.

ddx

Import detail#

from ansys.scade.guitools.page import SettingsPageEx

Attribute detail#

SettingsPageEx.ddx: ansys.scade.guitools.interfaces.ISettingsDataExchange | None = None#

Method detail#

SettingsPageEx.on_build()#

Build the settings page.

abstract SettingsPageEx.on_build_ex() → ansys.scade.guitools.interfaces.ISettingsDataExchange | None#

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

Returns#

Optional[ISettingsDataExchange]

Object for exchanging data between the project and the controls.

SettingsPageEx.on_display(project: scade.model.project.stdproject.Project, configuration: scade.model.project.stdproject.Configuration)#

Update the page with the properties read from the project.

SettingsPageEx.on_layout()#

Specify how controls are moved or resized.

SettingsPageEx.on_validate(project: scade.model.project.stdproject.Project, configuration: scade.model.project.stdproject.Configuration)#

Update the project with the properties read from the page.