K-Meleon Macro Language: More Interfaces

The Preferences System

This section describes how you can interact with K-Meleon's preferences system.

delpref()^0.9
```
delpref(<prefName>);
```
Deletes any user set value of the specified preference. This restores the preference's default value if one is set, otherwise the preference is expunged.

getpref()^0.7

$prefValue=getpref(<prefType>,<prefName>);

Returns the value of the specified preference (which is false, 0 or an empty string when the pref is not found).

Parameters:

Parameter	Required	Type	Value	Meaning
<prefType>	YES	PREDEFINED	BOOL	The type of the addressed preference.
			INT
			STRING
<prefName>	YES	STRING	A pref name	The name of the addressed preference.

setpref()^0.6

setpref(<prefType>,<prefName>,<prefValue>);

Sets the value of the specified preference.

Parameters:

Parameter	Required	Type	Value	Meaning
<prefType>	YES	PREDEFINED	BOOL	The type of the addressed preference.
			INT
			STRING
<prefName>	YES	STRING	A pref name	The name of the addressed preference.
<prefValue>	YES	Same as <prefType>	A value	The value to be set.

togglepref()^0.6

togglepref(<prefType>,<prefName>[,<prefValue1>,<prefValue2>[,<prefValue3>[,...]]]);

Toggles the value of the specified preference between a series of values.

Parameters:

Parameter	Required	Type	Value	Meaning
<prefType>	YES	PREDEFINED	BOOL	The type of the addressed preference.
			INT
			STRING
<prefName>	YES	STRING	A pref name	The name of the addressed preference.
<prefValueN>	NO⁽¹⁾	Same as <prefType>	A value	The Nth value to be set.

⁽¹⁾ Boolean preferences are always toggled between true and false.

K-Meleon Plugins

This section describes how you can interact with K-Meleon Plugins.

plugin()^0.7

plugin(<pluginName>,<pluginCommand>);

Executes a simple plugin command.

Parameters:

Parameter	Required	Type	Value	Meaning
<pluginName>⁽¹⁾	YES	STRING	A plugin name	The name of the addressed plugin.
<pluginCommand>⁽²⁾	YES⁽³⁾	STRING	A command name	The name of the command to execute.

⁽¹⁾ The plugin DLL's file name.

⁽²⁾ The supported command names depend on the particular plugin. See the plugin documentation.

⁽³⁾ Depends on the plugin.

pluginmsg()^0.7

pluginmsg(<pluginName>,<pluginCommand>,<parameters>);

Executes an advanced plugin command.

Parameters:

Parameter	Required	Type	Value	Meaning
<pluginName>⁽¹⁾	YES	STRING	A plugin name	The name of the addressed plugin.
<pluginCommand>⁽²⁾	YES	STRING	A command name	The name of the command to execute.
<parameters>⁽³⁾	YES	STRING	A parameter list	A comma separated list of parameters.

⁽¹⁾ The plugin DLL's file name.

⁽²⁾ The supported command names depend on the particular plugin. See the plugin documentation.

⁽³⁾ The supported/required parameters depend on the particular command. See the plugin documentation.

pluginmsgex()^0.7

$returnValue=pluginmsgex(<pluginName>,<pluginCommand>,<parameters>,<returnType>);

Executes an advanced plugin command and returns the operation's result.

Parameters:

Parameter	Required	Type	Value	Meaning
<pluginName>⁽¹⁾	YES	STRING	A plugin name	The name of the addressed plugin.
<pluginCommand>⁽²⁾	YES	STRING	A command name	The name of the command to execute.
<parameters>⁽³⁾	YES	STRING	A parameter list	A comma separated list of parameters.
<returnType>	YES	PREDEFINED	BOOL	The return value's data type.
			INT
			STRING

⁽¹⁾ The plugin DLL's file name.

⁽²⁾ The supported command names depend on the particular plugin. See the plugin documentation.

⁽³⁾ The supported/required parameters depend on the particular command. See the plugin documentation.

K-Meleon Macro Language

More Interfaces

The Preferences System

delpref()0.9

getpref()0.7

setpref()0.6

togglepref()0.6

K-Meleon Plugins

plugin()0.7

pluginmsg()0.7

pluginmsgex()0.7

delpref()^0.9

getpref()^0.7

setpref()^0.6

togglepref()^0.6

plugin()^0.7

pluginmsg()^0.7

pluginmsgex()^0.7