DialogBox

class ansys.scade.guitools.dialog.DialogBox(title: str, width: int, height: int, nc: bool = False, style: DS = DS.NONE, **kwargs)

Bases: scade.tool.suite.gui.dialogs.Dialog

Defines a dialog box with optional default button management.

Parameters

title: str

Title of the dialog box.

width: int

Width of the client area if nc is False, otherwise overall width of the dialog box.

height: int

Height of the client area if nc is False, otherwise overall width of the dialog box.

nc: bool

Whether the provided dimensions are for the overall dialog box or for its client area, default False.

kwargs: Any

Other parameters of scade.tool.suite.gui.dialog.Dialog.

Initialize the dialog box.

Overview

Abstract methods

on_build_ex

Build the controls.

Methods

on_build	Build the dialog with the specified dialog validation buttons.
on_click_cancel	Close the dialog when Cancel is pressed.
on_click_close	Close the dialog when Close is pressed.
on_click_no	Close the dialog when No is pressed.
on_click_ok	Close the dialog when OK is pressed.
on_click_retry	Close the dialog when Retry is pressed.
on_click_yes	Close the dialog when Yes is pressed.

Properties

bottom	Return the bottom-most position of the dialog box.
right	Return the right-most position of the dialog box.

Import detail

from ansys.scade.guitools.dialog import DialogBox

Property detail

property DialogBox.bottom: int

Return the bottom-most position of the dialog box.

This corresponds to the height of its client area if there are no buttons, otherwise the vertical position of the bottom buttons.

property DialogBox.right: int

Return the right-most position of the dialog box.

This corresponds to the width of its client area.

Method detail

DialogBox.on_build()

Build the dialog with the specified dialog validation buttons.

abstract DialogBox.on_build_ex()

Build the controls.

DialogBox.on_click_cancel(*args)

Close the dialog when Cancel is pressed.

DialogBox.on_click_close(*args)

Close the dialog when Close is pressed.

DialogBox.on_click_no(*args)

Close the dialog when No is pressed.

DialogBox.on_click_ok(*args)

Close the dialog when OK is pressed.

DialogBox.on_click_retry(*args)

Close the dialog when Retry is pressed.

DialogBox.on_click_yes(*args)

Close the dialog when Yes is pressed.