Summary
Display a message box and get a response (Unicode)
Prototype
response = utils.umsgbox ( msg, title, type, icon, default )
Description
This lets you display a Windows message box (very similar to MsgBox in VBscript). The intention is to allow you to display (in a small dialog box), information of an urgent nature, or ask a yes/no type question.
The calling sequence is:
result = utils.msgbox ( msg, title, type, icon, default )
The only required argument is the message text itself, the others default to their first possible value. The first 4 arguments are string arguments, the last is a number.
msg = message to display (max 1000 characters) - in UTF-8 characters (Unicode)
title = title of box - if nil, defaults to "MUSHclient" (max 100 characters) - in UTF-8 characters (Unicode)
type = type of box (must be in lower case and exactly as shown here):
"ok" - The message box contains one push button: OK. This is the default.
"abortretryignore" - The message box contains three push buttons: Abort, Retry, and Ignore.
"okcancel" - The message box contains two push buttons: OK and Cancel.
"retrycancel" - The message box contains two push buttons: Retry and Cancel.
"yesno" - The message box contains two push buttons: Yes and No.
"yesnocancel" - The message box contains three push buttons: Yes, No, and Cancel.
icon = type of icon:
"!" - An exclamation-point icon appears in the message box. This is the default.
"?" - A question-mark icon appears in the message box.
"i" - An icon consisting of a lowercase letter i in a circle appears in the message box.
"." - A stop-sign icon appears in the message box.
default = default button (1 - 3)
This sets the default button (the one with the focus) to be either button 1, 2 or 3. The default is the first button.
Return value = (string) yes, no, ok, retry, ignore, cancel, abort
Example:
print (utils.umsgbox ("You are being paged", "Warning!", "ok", "!", 1)) --> ok
print (utils.umsgbox ("You are being paged")) --> ok
print (utils.umsgbox ("Go ahead?", "Question", "yesno", "?")) --> yes / no
See also utils.msgbox if you want to display a message in straight ASCII (not Unicode).
See Also ...
Lua functions
utils.activatenotepad - Actvitates the specified notepad window
utils.appendtonotepad - Appends text to the specified notepad window
utils.base64decode - Decode a string which was base-64 encoded
utils.base64encode - Encode a string with base-64 encoding
utils.callbackslist - Returns a table of plugin callback function names
utils.choose - Display a combo box with choices in it
utils.colourcube - Changes the colour cube used by 256-colour ANSI codes
utils.compress - Compress a string
utils.decompress - Decompress a string
utils.directorypicker - Invokes the Windows standard "directory picker" dialog box
utils.editbox - Display a large message box and get free-format reply
utils.edit_distance - Returns the Levenshtein Edit Distance between two words
utils.filepicker - Invokes the Windows standard "file picker" dialog box
utils.filterpicker - Display a dialog box which filters its contents as you type
utils.fontpicker - Invokes the Windows standard "font picker" dialog box
utils.fromhex - Convert a string from hex
utils.functionlist - Returns a table of MUSHclient world function names
utils.getfontfamilies - Returns all fonts available to Windows
utils.glyph_available - Returns the glyph index of a glyph (character) in a font
utils.hash - Hash a string, returning the hex codes
utils.info - Information about directories, locale, etc.
utils.infotypes - Returns a table of all GetInfo type selectors
utils.inputbox - Display a message box and get free-format reply
utils.listbox - Display a dialog box with choices in it in a single selection list box
utils.md5 - Hash a string using the 128-bit MD5 algorithm
utils.menufontsize - Alters the size of the font used in menus
utils.metaphone - Returns metaphones (sound-alike codes) for the supplied word
utils.msgbox - Display a message box and get a response
utils.multilistbox - Display a dialog box with choices in it in a multiple selection list box
utils.readdir - Read a disk directory into a table
utils.reload_global_prefs - Forces global preferences file to be reloaded
utils.sendtofront - Bring a window to the front
utils.sha256 - Hash a string using a 256-bit hash
utils.shellexecute - Executes a Windows "shell" command
utils.spellcheckdialog - Spell-checker dialog
utils.split - Split a delimited string into a table
utils.timer - Returns the high-resolution timer output
utils.tohex - Convert a string into hex
utils.utf8convert - Encodes a string into a UTF-8 string
utils.utf8decode - Encodes a series of Unicode codes into a UTF-8 string
utils.utf8encode - Encodes a series of Unicode codes into a UTF-8 string
utils.utf8sub - Returns a substring of a UTF-8 string
utils.utf8valid - Checks if a UTF-8 string is valid
utils.xmlread - Parses an XML string into a nested table
Topics
Lua base functions
Lua bc (big number) functions
Lua bit manipulation functions
Lua coroutine functions
Lua debug functions
Lua io functions
Lua LPEG library
Lua math functions
Lua os functions
Lua package functions
Lua PCRE regular expression functions
Lua script extensions
Lua string functions
Lua syntax
Lua table functions
Lua utilities
Scripting
Scripting callbacks - plugins
(Help topic: lua=utils.umsgbox)