K-Meleon Macro Language

This section describes how you can directly interact with the user.

•  

  Simple Dialogs / Modal Windows

  •  

    alert()^0.8

    alert(<message>[,<title>[,<icon>]]);

    Shows a simple messagebox.

    Parameters:

    Parameter	Required	Type	Value	Meaning
    <message>	YES	STRING	A message(1)	The text to be displayed in the dialog's body.
    <title>	NO	STRING	A title(2)	The text to be displayed in the dialog's title bar.
    <icon>	NO(3)	PREDEFINED	EXCLAIM	The icon to be displayed in the dialog's body.
    			INFO
    			STOP
    			QUESTION

    ⁽¹⁾ The message can span several lines.

    ⁽²⁾ The title cannot span several lines.

    ⁽³⁾ When <icon> is specified, <title> must be specified too.

  •  

    confirm()^0.9

    $button=confirm(<message>[,<title>[,<buttons>[,<icon>]]]);

    Shows a confirmation box and returns the name of the pressed button: ABORT, IGNORE, NO, OK, RETRY, YES or 0 (for CANCEL).

    Parameters:

    Parameter	Required	Type	Value	Meaning
    <message>	YES	STRING	A message(1)	The text to be displayed in the dialog's body.
    <title>	NO	STRING	A title(2)	The text to be displayed in the dialog's title bar.
    <buttons>	NO(3)	PREDEFINED	ABORTRETRYIGNORE	The buttons to be displayed in the dialog's body.
    			OKCANCEL (default)
    			RETRYCANCEL
    			YESNO
    			YESNOCANCEL
    <icon>	NO(4)	PREDEFINED	EXCLAIM	The icon to be displayed in the dialog's body.
    			INFO
    			STOP
    			QUESTION

    ⁽¹⁾ The message can span several lines.

    ⁽²⁾ The title cannot span several lines.

    ⁽³⁾ When <buttons> is specified, <title> must be specified too.

    ⁽⁴⁾ When <icon> is specified, <buttons> must be specified too.

  •  

    prompt()^0.7

    $input=prompt(<message>[,<title>[,<preset>]]);

    Shows an input box and returns a string (which is empty when the user canceled).

    Parameters:

    Parameter	Required	Type	Value	Meaning
    <message>	YES	STRING	A message(1)	The text to be displayed in the dialog's body.
    <title>	NO	STRING	A title(2)	The text to be displayed in the dialog's title bar.
    <preset>	NO(3)	STRING	A preset	The text to be displayed in the dialog's input field.

    ⁽¹⁾ The message cannot span several lines here!

    ⁽²⁾ The title cannot span several lines.

    ⁽³⁾ When <preset> is specified, <title> must be specified too.

•  

  Operating System Dialogs

  •  

    promptforfile()^1.0

    $path=promptforfile(<folder>,<fileType>,<fileMask>);

    Shows the "Open File" Dialog and returns a path (which is empty when the user canceled).

    Parameters:

    Parameter	Required	Type	Value	Meaning
    <folder>	YES	STRING	A folder path(1)	The dialog's initial folder.
    <fileType>	YES	STRING	A file type	Describes the files of interest e.g. "HTML Documents".
    <fileMask>	YES	STRING	A match pattern	Specifies the files of interest e.g. "*.htm".

    ⁽¹⁾ When an empty string, the OS will choose a folder.

  •  

    promptforfolder()^1.0

    $path=promptforfolder([<message>[,<folder>]]);

    Shows the "Browse For Folder" Dialog and returns a path (which is empty when the user canceled).

    Parameters:

    Parameter	Required	Type	Value	Meaning
    <message>	NO(1)	STRING	A message	The text to be displayed in the dialog's body.
    <folder>	NO(2)	STRING	A folder path	The dialog's initial folder.

    ⁽¹⁾ Must be specified when <folder> is specified.

    ⁽²⁾ When omitted, the OS will choose a folder.