$input » History » Revision 8
Revision 7 (Per Amundsen, 01/04/2017 11:59 AM) → Revision 8/11 (Per Amundsen, 01/23/2017 03:59 PM)
_Added in 1.9.0_
*$input(prompt,[options],[window],[title],[text])*
Prompts the user for input and returns the result.
_See also [[$yes]], [[$no]], [[$ok]], [[$cancel]], [[$timeout]]._
_Can be prefixed with # to ensure the resulted text starts with a channel prefix._
*parameters*
prompt - Question text.
[options] - (optional)
e - Show input Editbox.
p - Show input password Editbox.
o - Show only a OK button.
y - Show Yes/No buttons.
n - Show Yes/No/Cancel buttons.
r - Show Retry/Cancel buttons.
v - Return [[$ok]], [[$yes]], [[$no]], [[$cancel]] for buttons.
g - Right-align buttons.
b - Disables buttons for a second when dialog is displayed.
f - TODO
i - Show the information icon.
q - Show the question icon.
w - Show the warning icon.
h - Show the error icon.
d - Play the system sound associated with the icon.
s - Indicates that [window] name has been specified.
a - Unminimize and focus the parent form.
u - use current active window as parent window
kN - Close/timeout the dialog after N seconds. On timing out, [[$timeout]] is returned if v is specified, otherwise [[$false]].
m - Indicates that multiple text parameters have been specified. They will be displayed in a combobox.
[window] - Window name to associate the dialog with.
[title] - The Titlebar text
[text] - The default text placed in the input Editbox.
*Example*
<pre>
; Ask for a name and print it.
//echo -ag $input(What is your name?, Question)
</pre>