FL.objects.Dialog.Dialog

class FL.objects.Dialog.Dialog

Bases: object

Dialog - class to represent Dialog

Dialog.__doc__ reports only ‘Dialog’ … so use this information with care)

See ‘yourFontLabFolder/Macros/Effects/digital.py’ for an example

__init__() → None

Dialog(DialogClass) - generic constructor

Methods

AddControl(ControlType, dimension, ...)	Adds a control to the dialog, see FLdict for Type- and Style-constants
Center()	Center dialog on screen
Enable(identifier, value)	Enable (value=1) or disable (value=0) the specified control
End([returnvalue])	End the dialog
GetRect(identifier)	Get dimension of the specified control as a Rect object
GetValue(identifier)	Get value from the specified control
PutValue(identifier)	Put value to the specified control
Repaint(identifier)	Redraw the specified (custom)control
Run()	Run the dialog
SetLabel(identifier, value)	Set the label of the specified control
Show(identifier, value)	Show (value=1) or hide (value=0) the specified control
__init__()	Dialog(DialogClass) - generic constructor

Attributes

size
title

AddControl(ControlType: int, dimension: Rect, identifier: str, ControlStyle: int) → None

Adds a control to the dialog, see FLdict for Type- and Style-constants

Parameters:

• ControlType (int) – _description_

• dimension (Rect) – _description_

• identifier (str) – _description_

• ControlStyle (int) – _description_

Center() → None

Center dialog on screen

Enable(identifier: str, value: int) → None

Enable (value=1) or disable (value=0) the specified control

Parameters:

• identifier (str) – _description_

• value (int) – _description_

End(returnvalue: int | None = None)

End the dialog

Parameters:

returnvalue (int | None, optional) – _description_. Defaults to None.

GetRect(identifier: str) → Rect

Get dimension of the specified control as a Rect object

Parameters:

identifier (str) – _description_

GetValue(identifier: str) → Any

Get value from the specified control

Parameters:

identifier (str) – _description_

Returns:

_description_

Return type:

Any

PutValue(identifier: str) → None

Put value to the specified control

Parameters:

identifier (str) – _description_

Repaint(identifier: str) → None

Redraw the specified (custom)control

Parameters:

identifier (str) – _description_

Run() → int

Run the dialog

Returns:

_description_

Return type:

int

SetLabel(identifier: str, value: str) → None

Set the label of the specified control

Parameters:

• identifier (str) – _description_

• value (str) – _description_

Show(identifier: str, value: int) → None

Show (value=1) or hide (value=0) the specified control

Parameters:

• identifier (str) – _description_

• value (int) – _description_