diff options
author | portix <none@none> | 2012-05-02 20:06:51 +0200 |
---|---|---|
committer | portix <none@none> | 2012-05-02 20:06:51 +0200 |
commit | f82e11efaa6f0177e8d31d878448ec8afd302330 (patch) | |
tree | 666869699a5892bc8d125e7611e4374713fd47b9 /api | |
parent | 4a83cf45d08284896b9dc96eb383226a6669552c (diff) | |
download | dwb-f82e11efaa6f0177e8d31d878448ec8afd302330.zip |
Make extension.config private
--HG--
branch : scripts
Diffstat (limited to 'api')
-rw-r--r-- | api/jsapi.txt | 88 |
1 files changed, 56 insertions, 32 deletions
diff --git a/api/jsapi.txt b/api/jsapi.txt index face19d6..60ca229c 100644 --- a/api/jsapi.txt +++ b/api/jsapi.txt @@ -704,7 +704,7 @@ Write to a file _path_;; Path to a file to write to _mode_;; Either +"a"+ to append to the file, or +"w"+ to strip the file or create a new file. -_mode_;; The text that should be written to the file +_text_;; The text that should be written to the file _returns_;; +true+ if writing was successful [[read]] @@ -875,7 +875,7 @@ Number of the currently focused tab webview tabs.nth(Number n) ---- -Gets the webview object the nth tab +Gets the webview object of the nth tab :: @@ -1362,44 +1362,68 @@ consistent configuration locations for scripts. The +extensions+ object has the following properties and functions -.Properties +=== Functions === + +[[extensionload,load]] +.load() + +[source,javascript] +---- +Boolean extensions.load(String name) +---- +Loads an extension + + :: + +_name_;; Name of the extension +_returns_;; True if the extension was loaded + +[[error]] +.error() + +[source,javascript] +---- +void extensions.error(String name, String message) +---- + +Print a consistent error to stderr -[options="header", cols="2s,2m,10"] -|============================================= -|name |type | description -|config|Object|Object that holds data for all extensions + :: + +_name_;; Name of the extension +_message_;; The error message + +[[message]] +.message() + +[source,javascript] +---- +void extensions.message(String name, String message) +---- -|============================================= +Print a consistent message to stderr -.Functions + :: -[options="header", cols="1s,1m,3,2,2"] -|============================================= -|function 2+| parameter | returns |description -|load -|String |name of the extension -| +true+ if the extension was successfully loaded -|Load an extension +_name_;; Name of the extension +_message_;; The message -.2+|error -|String |name of the extension -.2+| - -.2+|Print a consistent error message to stderr. -|String |The message to print -.2+|message -|String |name of the extension -.2+| - -.2+|Print a consistent message to stderr. -|String |The message to print +[[warning]] +.warning() + +[source,javascript] +---- +void extensions.warning(String name, String message) +---- + +Print a consistent warning to stderr + + :: -.2+|warning -|String |name of the extension -.2+| - -.2+|Print a consistent warning message to stderr. -|String |The message to print +_name_;; Name of the extension +_message_;; The warning message -|============================================= .Example |