utils.inputbox

result = utils.inputbox ( msg, title, default, font, fontsize, extras )

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