Summary
Display a message box and get free-format reply
Prototype
result = utils.inputbox ( msg, title, default, font, fontsize, extras )
Description
This lets you display a Windows message box and accept a free-format reply (very similar to InputBox in VBscript). The intention is to allow you to display (in a small dialog box) a question and accept a typed response.
The calling sequence is:
result = utils.inputbox ( msg, title, default, font, fontsize, extras )
The only required argument is the message text itself.
msg = message to display (max 1000 characters)
title = title of box - if nil, defaults to "MUSHclient" (max 100 characters)
default = default text - defaults to no text
font = font to use in response field - defaults to standard Windows font
fontsize = size of font to use (ignored if no font supplied)
extras = table of extra parameters
The extra parameters (if supplied) is a table which can consist of one or more of:
box_width --> width of message box in pixels (min 180)
box_height --> height of message box in pixels (min 125)
prompt_width --> width of prompt text in pixels (min 10)
prompt_height --> height of prompt text in pixels (min 12)
reply_width --> width of reply in pixels (min 10)
reply_height --> height of reply in pixels (min 10)
max_length --> max characters they can type (min 1)
validate --> validation function
ok_button --> what text to put on the OK button (default: OK)
cancel_button --> what text to put on the Cancel button (default: Cancel)
ok_button_width --> the width of the OK button in pixels (default: 75)
cancel_button_width--> the width of the Cancel button in pixels (default: 75)
read_only --> if true, input area is read-only
no_default --> if true, pressing <enter> does not dismiss the dialog
Examples of the extra parameters can be found here:
http://gammon.com.au/forum/?id=10644
The validate function (if used) should be a Lua function that takes a single argument (which is what was typed into the input box) and returns true if this reply was acceptable, and false if not. For example, you might return true if the reply was numeric, if a number was required. This function is called when they click the OK button.
Return value = what they typed, or nil if cancelled
Example:
print (utils.inputbox ("What is your name?", "Query", "Nick", "Courier", 9)) --> Peter
There is also similar function which will handle a larger response: utils.editbox
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.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.umsgbox - Display a message box and get a response (Unicode)
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.inputbox)