utils.umsgbox
Lua function

utils.umsgbox

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 ...

Topics

DOC_lua_base Lua base functions
DOC_lua_bc Lua bc (big number) functions
DOC_lua_bit Lua bit manipulation functions
DOC_lua_coroutines Lua coroutine functions
DOC_lua_debug Lua debug functions
DOC_lua_io Lua io functions
DOC_lua_lpeg Lua LPEG library
DOC_lua_math Lua math functions
DOC_lua_os Lua os functions
DOC_lua_package Lua package functions
DOC_lua_rex Lua PCRE regular expression functions
DOC_lua Lua script extensions
DOC_lua_string Lua string functions
DOC_lua_tables Lua table functions
DOC_lua_utils Lua utilities
DOC_scripting Scripting

Lua functions

LUA_utils.base64decode utils.base64decode (Decode a string which was base-64 encoded)
LUA_utils.base64encode utils.base64encode (Encode a string with base-64 encoding)
LUA_utils.choose utils.choose (Display a combo box with choices in it)
LUA_utils.compress utils.compress (Compress a string)
LUA_utils.decompress utils.decompress (Decompress a string)
LUA_utils.directorypicker utils.directorypicker (Invokes the Windows standard "directory picker" dialog box)
LUA_utils.editbox utils.editbox (Display a large message box and get free-format reply)
LUA_utils.edit_distance utils.edit_distance (Returns the Levenshtein Edit Distance between two words)
LUA_utils.filepicker utils.filepicker (Invokes the Windows standard "file picker" dialog box)
LUA_utils.fontpicker utils.fontpicker (Invokes the Windows standard "font picker" dialog box)
LUA_utils.fromhex utils.fromhex (Convert a string from hex)
LUA_utils.functionlist utils.functionlist (Returns a table of MUSHclient world function names)
LUA_utils.getfontfamilies utils.getfontfamilies (Returns all fonts available to Windows)
LUA_utils.hash utils.hash (Hash a string, returning the hex codes)
LUA_utils.info utils.info (Information about directories, locale, etc.)
LUA_utils.inputbox utils.inputbox (Display a message box and get free-format reply)
LUA_utils.listbox utils.listbox (Display a dialog box with choices in it in a single selection list box)
LUA_utils.md5 utils.md5 (Hash a string using the 128-bit MD5 algorithm)
LUA_utils.metaphone utils.metaphone (Returns metaphones (sound-alike codes) for the supplied word)
LUA_utils.msgbox utils.msgbox (Display a message box and get a response)
LUA_utils.multilistbox utils.multilistbox (Display a dialog box with choices in it in a multiple selection list box)
LUA_utils.readdir utils.readdir (Read a disk directory into a table)
LUA_utils.sha256 utils.sha256 (Hash a string using a 256-bit hash)
LUA_utils.spellcheckdialog utils.spellcheckdialog (Spell-checker dialog)
LUA_utils.split utils.split (Split a delimited string into a table)
LUA_utils.tohex utils.tohex (Convert a string into hex)
LUA_utils.utf8decode utils.utf8decode (Encodes a series of Unicode codes into a UTF-8 string)
LUA_utils.utf8encode utils.utf8encode (Encodes a series of Unicode codes into a UTF-8 string)
LUA_utils.utf8sub utils.utf8sub (Returns a substring of a UTF-8 string)
LUA_utils.utf8valid utils.utf8valid (Checks if a UTF-8 string is valid)
LUA_utils.xmlread utils.xmlread (Parses an XML string into a nested table)

(Help topic: lua=utils.umsgbox)

DOC_contents Documentation contents page