# dialog.message

Shows a message box

Usage

    dialog.message [-b] (<caption>,<message_text>,<icon>,<button0>[,<button1>[,<button2>[,<magic1>[,<magic2>[...]]]]])
    {
        <callback_command>
    }

Description

Shows a message dialog box with the specified <caption>, <message_text>, <icon> and buttons.
<caption> is a text string that will appear in the caption of the dialog box.
<message_text> is a text string that will appear in the dialog box and can contain HTML formatting.
<icon> is an image identifier that defines an icon to be placed in the dialog box. <icon> can be a relative or absolute path to an image file, a signed number (in that case it defines an internal KVIrc image) or one of the special strings "critical", "information" and "warning".
<button0> is the text of the first button (on the left).
<button1> is the text of the second button (if empty or specified, only one button will appear in the dialog).
<button2> is the text of the third button (if empty or specified, only two buttons will appear in the dialog).
The first button is the default button - it is activated when the user presses the enter key. The third (or the second if only two buttons are present) is treated as the escape button and is activated when the user presses the Esc key or closes the dialog with the window manager close button.
If one of the button text strings starts with a "default=" prefix then that button is assumed to be the default button of the dialog.
If one of the button text strings starts with a "escape=" prefix then that button is assumed to be the escape button of the dialog.
<magic1>,<magic2>... are the magic parameters - evaluated at dialog.message call time and passed to the <callback_command> as positional parameters.
If the -b or -modal switch is specified the dialog will have blocking modal behaviour - it will appear above its parent widget and block its input until the dialog is closed.
Once the dialog is displayed, the user will click one of the buttons. At this point the dialog is hidden and the <callback_command> is executed, passing the number of the button clicked as $0 and the magic parameters as positional parameters $1, $2, $3....

Syntax Specification

    dialog.message [-b] (<caption>,<message_text>,<icon>,<button0>[,<button1>[,<button2>[,<magic1>[,<magic2>[...]]]]])
    {
        <callback_command>
    }

Examples

    # Just a warning dialog
    dialog.message("Warning","You're being <b>warned</b>",warning,"Ok"){ echo The user clicked OK; }
    # A question
    dialog.message("And now ?","What do you want to do ?",information,"Go home","Watch TV","Scream")
    {
        if($0 == 0)echo "The user wants to go home"
        else if($0 == 1)echo "The user wants to watch TV"
        else echo "The user wants to scream!"
    }

Index, Commands

KVIrc 4.2.0.6190 Documentation
Generated by root at Mon Jul 22 18:18:08 2013