Project

General

Profile

$input » History » Version 7

Per Amundsen, 01/04/2017 11:59 AM

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