User Interface module - SPUIInterface
Functions to enable user interactions with the script.
Constants
Dialog result
Result of message box dialog
ID_OK = 1
ID_CANCEL = 2
ID_ABORT = 3
ID_RETRY = 4
ID_IGNORE = 5
ID_YES = 6
ID_NO = 7
Buttons
What buttons shall appear in message box
MB_OK = 0
MB_OKCANCEL = 1
MB_ABORTRETRYIGNORE = 2
MB_YESNOCANCEL = 3
MB_YESNO = 4
MB_RETRYCANCEL = 5
Message box type
DLG_MT_CUSTOM = 0
DLG_MT_INFORMATION = 1
DLG_MT_WARNING = 2
DLG_MT_ERROR = 3
DLG_MT_CONFIRMATION = 4
Module methods
msg_box(caption, type, buttons)
- Show a message box
- type: use Message box type constant
- buttons: use Buttons constants
- return: one of Dialog result constants
input_dlg(caption, label, default, wx, wy,
memo, read_only)
- Show a text input dialog
- caption: Title of the dialog
- label: Label in the dialog
- default: Default value that will be set
to the edit box
- wx: width (pixels)
- wy: height(pixels)
- memo:
- true: the edit box will be a memo
(multi-line)
- false: edit box will be single-line
- read_only: shall the edit box be
read-only?
- return: edited value (OK button) or
default value (Cancel button)
log(log_value)
- This function does not anything except putting a line in the
debug log.
get_translation(key)
- get a value of string constant from the language file
- key: The key to identify the constant
(see string constants in language file)