UserIO: Difference between revisions
(Created page with "Category:Modules Category:Add-On Modules") |
No edit summary |
||
Line 1: | Line 1: | ||
version: 1.5.5 | |||
The module 'UserIO' is is used to interact with the user, e.g. to ask for a value (Input) or to display some information (Output). | |||
For all types, you can enter a message. The message field can be used in combination with the [[Parameter system]] to change messages during the run. | |||
== Input == | |||
All input types are blocking, i.e. the user needs to enter a value and accept the dialog before the program run continues. | |||
=== String === | |||
Ask the user to enter a string. | |||
=== Integer === | |||
Ask the user to enter an integer. | |||
=== Float === | |||
Ask the user to enter a float. | |||
=== Selection === | |||
Ask the user to select from different options. Possible values can be entered in the field choices, separated by a | character. | |||
== Output == | |||
Some output types can be made 'blocking'. Then, the program will stop and wait for the user to accept the message. | |||
=== MessageBox (Warning) === | |||
Display a message box with warning symbol. | |||
=== MessageBox (Information) === | |||
Display a message box with information symbol. | |||
=== MessageBox (Critical) === | |||
Display a message box with critical symbol. | |||
=== MessageInfo === | |||
Display a message in the info field of the General tab. | |||
=== MessageBalloon === | |||
Display a message in a message balloon. | |||
=== Debug === | |||
Add a message to the debug output. | |||
=== WriteLog === | |||
Add a message to the Logbook file. | |||
[[Category:Modules]] | [[Category:Modules]] | ||
[[Category:Add-On Modules]] | [[Category:Add-On Modules]] |
Latest revision as of 22:26, 10 October 2020
version: 1.5.5
The module 'UserIO' is is used to interact with the user, e.g. to ask for a value (Input) or to display some information (Output).
For all types, you can enter a message. The message field can be used in combination with the Parameter system to change messages during the run.
Input
All input types are blocking, i.e. the user needs to enter a value and accept the dialog before the program run continues.
String
Ask the user to enter a string.
Integer
Ask the user to enter an integer.
Float
Ask the user to enter a float.
Selection
Ask the user to select from different options. Possible values can be entered in the field choices, separated by a | character.
Output
Some output types can be made 'blocking'. Then, the program will stop and wait for the user to accept the message.
MessageBox (Warning)
Display a message box with warning symbol.
MessageBox (Information)
Display a message box with information symbol.
MessageBox (Critical)
Display a message box with critical symbol.
MessageInfo
Display a message in the info field of the General tab.
MessageBalloon
Display a message in a message balloon.
Debug
Add a message to the debug output.
WriteLog
Add a message to the Logbook file.