Project

General

Profile

$input » History » Version 8

Per Amundsen, 01/23/2017 03:59 PM

1 1 Per Amundsen
_Added in 1.9.0_
2
3
*$input(prompt,[options],[window],[title],[text])*
4
5
Prompts the user for input and returns the result.
6
7 8 Per Amundsen
_See also [[$yes]], [[$no]], [[$ok]], [[$cancel]], [[$timeout]]._
8
9 7 Per Amundsen
_Can be prefixed with # to ensure the resulted text starts with a channel prefix._
10
11 1 Per Amundsen
*parameters*
12
13
prompt - Question text.
14
[options] - (optional)
15 4 Per Amundsen
16 2 Per Amundsen
e - Show input Editbox.
17
p - Show input password Editbox.
18
o - Show only a OK button.
19
y - Show Yes/No buttons.
20
n - Show Yes/No/Cancel buttons.
21
r - Show Retry/Cancel buttons.
22
v - Return [[$ok]], [[$yes]], [[$no]], [[$cancel]] for buttons.
23
g - Right-align buttons.
24
b - Disables buttons for a second when dialog is displayed.
25 1 Per Amundsen
f - TODO
26 2 Per Amundsen
i - Show the information icon.
27
q - Show the question icon.
28
w - Show the warning icon.
29
h - Show the error icon.
30
d - Play the system sound associated with the icon.
31
s - Indicates that [window] name has been specified.
32 5 Per Amundsen
a - Unminimize and focus the parent form.
33 1 Per Amundsen
u - use current active window as parent window
34 2 Per Amundsen
kN - Close/timeout the dialog after N seconds. On timing out, [[$timeout]] is returned if v is specified, otherwise [[$false]].
35 6 Per Amundsen
m - Indicates that multiple text parameters have been specified. They will be displayed in a combobox.
36 1 Per Amundsen
37 2 Per Amundsen
[window] - Window name to associate the dialog with.
38 1 Per Amundsen
[title] - The Titlebar text
39
[text] - The default text placed in the input Editbox.
40
41
*Example*
42
43
<pre>
44
; Ask for a name and print it.
45
//echo -ag $input(What is your name?, Question)
46
</pre>