![]() |
![]() |
dialog.textinputShows a dialog that accepts user input as text |
||||||
Usage | ||||||
|
||||||
Description | ||||||
Shows a text input dialog box with the specified <caption> , <info_text> , <icon> and
buttons. <caption> is a text string that will appear in the caption of the dialog box. <info_text> is a fixed text string that will appear in the dialog box and can contain HTML formatting. <button0> is the text of the first button (on the left). <button1> is the text of the second button (if empty or not given at all, only one button will appear in the dialog). <button2> is the text of the third button (if empty or not given, only two buttons will appear in the dialog). If one of the text strings starts with a "default=" prefix then the button is assumed to be the default button of the dialog and will be also activated when the user presses enter. If the -m switch is used , the dialog will be a multi-line text input, otherwise the user will be able to input only a single line of text. If the -d switch is used , the initial text input value is set to <default text>. If the -i switch is used , the dialog displays also the icon <icon> , just on the left ot the <info_text> If the -b or -modal switch is specified the dialog will have non-blocking modal behaviour: it will appear above its parent widget and block its input until it's closed. In that case <icon> is an image identifier (can be a relative or absolute path to an image file or a signed number (in that case it defines an internal KVIrc image). <magic1>,<magic2>... are the magic parameters: evaluated at dialog.textinput call time and passed to the <callback_command> as positional parameters. Once the dialog has been shown , the user will click one of the buttons. At this point the dialog is hidden and the <callback_command> is executed passing the text input value in $1, the number of the button clicked as $0, and the magic parameters as positional parameters $2 , $3 , $4.... Please note that if the user closes the window with the window manager close button , the action is interpreted as a button2 click (that is usually sth as "Cancel"). |
||||||
Switches | ||||||
|
||||||
Syntax Specification | ||||||
|
||||||
Examples | ||||||
|