This section describes how you can interact with K-Meleon's preferences system.
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.
$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(<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(<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(1) | Same as <prefType> | A value | The Nth value to be set. |
(1) Boolean preferences are always toggled between true and false.
This section describes how you can interact with K-Meleon Plugins.
plugin(<pluginName>,<pluginCommand>);
Executes a simple plugin command.
Parameters:
| Parameter | Required | Type | Value | Meaning |
|---|---|---|---|---|
| <pluginName>(1) | YES | STRING | A plugin name | The name of the addressed plugin. |
| <pluginCommand>(2) | YES(3) | STRING | A command name | The name of the command to execute. |
(1) The plugin DLL's file name.
(2) The supported command names depend on the particular plugin. See the plugin documentation.
(3) Depends on the plugin.
pluginmsg(<pluginName>,<pluginCommand>,<parameters>);
Executes an advanced plugin command.
Parameters:
| Parameter | Required | Type | Value | Meaning |
|---|---|---|---|---|
| <pluginName>(1) | YES | STRING | A plugin name | The name of the addressed plugin. |
| <pluginCommand>(2) | YES | STRING | A command name | The name of the command to execute. |
| <parameters>(3) | YES | STRING | A parameter list | A comma separated list of parameters. |
(1) The plugin DLL's file name.
(2) The supported command names depend on the particular plugin. See the plugin documentation.
(3) The supported/required parameters depend on the particular command. See the plugin documentation.
$returnValue=pluginmsgex(<pluginName>,<pluginCommand>,<parameters>,<returnType>);
Executes an advanced plugin command and returns the operation's result.
Parameters:
| Parameter | Required | Type | Value | Meaning |
|---|---|---|---|---|
| <pluginName>(1) | YES | STRING | A plugin name | The name of the addressed plugin. |
| <pluginCommand>(2) | YES | STRING | A command name | The name of the command to execute. |
| <parameters>(3) | YES | STRING | A parameter list | A comma separated list of parameters. |
| <returnType> | YES | PREDEFINED | BOOL | The return value's data type. |
| INT | ||||
| STRING |
(1) The plugin DLL's file name.
(2) The supported command names depend on the particular plugin. See the plugin documentation.
(3) The supported/required parameters depend on the particular command. See the plugin documentation.