'\" t
.\"     Title: dwb-js
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.0 <http://docbook.sf.net/>
.\"      Date: 04/04/2013
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DWB\-JS" "7" "04/04/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dwb-js \- dwb\*(Aqs javascript api documentation
.SH "DESCRIPTION"
.sp
dwb provides a javascript api that can be used to write userscripts or extensions for dwb\&.
.SH "GETTING STARTED"
.sp
Scripts that use the javascript api must be located in \fB$XDG_CONFIG_HOME/dwb/userscripts\fR like any other script\&. Scripts that use the javascript api must either start with
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript
.fi
.if n \{\
.RE
.\}
.sp
or with
.sp
.if n \{\
.RS 4
.\}
.nf
//!javascript
.fi
.if n \{\
.RE
.\}
.sp
All native javascript methods can be used in scripts, however there are limitations:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The execution context of userscripts is completely seperated from the web execution context\&. Due to security concerns it is not possible to communicate with the web execution context, it is only possible to inject scripts into the web context\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
In contrast to the global window object in the web execution context, the global object is a readonly object, i\&.e\&. it is not possible to set properties on the global object, see also
\fBGlobal data\fR
for details\&.
.RE
.SH "GLOBAL"
.SS "Properties"
.PP
\fIglobal (Object, read)\fR
.RS 4
Refers to the global object
.RE
.PP
\fIsession (SoupSession, read)\fR
.RS 4
The webkit session
.RE
.SS "Methods"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean bind(String shortcut, Function callback, [String name])\fR
.RS 4
.sp
Bind a javascript function to a shortcut\&. This is the preferred method of binding keys to shortcuts since the shortcut is evaluated using the native method, but also the keyPress\-signal can be used to bind shortcuts\&.
.PP
\fIshortcut\fR
.RS 4
A shortcut shortcut, will be parsed the same way as if set in dwb:keys
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that will be called when the shortcut is pressed
.RE
.PP
\fIname\fR
.RS 4
A name that identifies the function on command line, optional
.RE
.PP
\fIreturns\fR
.RS 4
true if the function was bound successfully
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean execute(String command)\fR
.RS 4
.sp
Executes a dwb command
.PP
\fIcommand\fR
.RS 4
a dwb command to execute, will be parsed the same way as if executed from commandline
.RE
.PP
\fIreturns\fR
.RS 4
true if execution was successful
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean exit()\fR
.RS 4
.sp
Exit dwb, must be called if the script is running from commandline\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBObject include(String path, [Boolean global])\fR
.RS 4
.sp
Includes a file\&. Note that there is only one context, all scripts are executed in this context\&. Included files are not visible in other scripts unless true is passed as second parameter\&.
.PP
\fIpath\fR
.RS 4
Path to a file to include
.RE
.PP
\fIglobal\fR
.RS 4
Whether to include the script into the global scope, optional
.RE
.PP
\fIreturns\fR
.RS 4
The return value of the included file
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Scripts included with include are either visible in the global scope or invisible, even in the including script\&. To use an included script it can return an object with its public objects:
.sp .5v
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
// included script

var private = 37;
return {
  getPrivate : function () {
    return private;
  }
};

// Scripts that includes the above
var i = include("/path/to/script");
var p = i\&.getPrivate();               // 37
.fi
.if n \{\
.RE
.\}
.sp
or define a module that can be shared:
.sp
.if n \{\
.RS 4
.\}
.nf
// included script

var private = 37;
provide("foo", {
    getPrivate : function() {
        return private;
    }
});

// Scripts that includes the above
var i = include("/path/to/script");
require(["foo"], function(foo) {
    var bar = foo\&.getPrivate();               // 37
})
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid provide(String name, Object module)\fR
.RS 4
.sp
Defines a module that can be used in other scripts, see MODULES for details\&.
.PP
\fIname\fR
.RS 4
Name of the module
.RE
.PP
\fImodule\fR
.RS 4
The module
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid replace(String name, Object module)\fR
.RS 4
.sp
Same as provide but replaces the module if it was already defined\&.
.PP
\fIname\fR
.RS 4
Name of the module
.RE
.PP
\fImodule\fR
.RS 4
The module, if omitted the module will be deleted, all references to that module will reference an empty object afterwards, optional\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid require(Array names, Function callback)\fR
.RS 4
.sp
Load modules defined with provide\&.
.PP
\fInames\fR
.RS 4
An array of module names or null to get all modules, a module name can also contain a path, the path must be seperated with a
\fB!\fR
from the module name, see also MODULES for details\&.
.RE
.PP
\fIcallback\fR
.RS 4
A callback function that is called after initialization of all scripts and modules\&. The parameters of the callback function correspond to the names array\&. If
\fBnames\fR
is null the function is called with one parameter that contains all modules, see also MODULES for examples\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber unbind(Function func|String name)\fR
.RS 4
.sp
Unbind a shortcut that was previously bound with bind
.PP
\fIfunc\fR or \fIname\fR
.RS 4
Either the function or the optional name passed to bind\&.
.RE
.PP
\fIreturns\fR
.RS 4
true if the function was unbound
.RE
.RE
.SH "GLOBAL OBJECTS"
.SS "data"
.sp
The data object can be used to determine internally used data securely\&. All properties are readonly Strings\&.
.PP
\fIdata\&.bookmarks\fR
.RS 4
Bookmark file
.RE
.PP
\fIdata\&.cacheDir\fR
.RS 4
Cache directory
.RE
.PP
\fIdata\&.configDir\fR
.RS 4
Config directory
.RE
.PP
\fIdata\&.cookies\fR
.RS 4
Cookie file
.RE
.PP
\fIdata\&.cookiesWhitelist\fR
.RS 4
Whitelist for persistent cookies
.RE
.PP
\fIdata\&.customKeys\fR
.RS 4
Custom keyboard shortcuts
.RE
.PP
\fIdata\&.history\fR
.RS 4
History file
.RE
.PP
\fIdata\&.keys\fR
.RS 4
Shortcuts configuration file
.RE
.PP
\fIdata\&.pluginsWhitelist\fR
.RS 4
Whitelist for the plugin blocker
.RE
.PP
\fIdata\&.profile\fR
.RS 4
Profile which will be
\fBdefault\fR
unless another profile is specified on command line
.RE
.PP
\fIdata\&.quickmarks\fR
.RS 4
Quickmark file
.RE
.PP
\fIdata\&.scriptWhitelist\fR
.RS 4
Whitelist for scripts
.RE
.PP
\fIdata\&.session\fR
.RS 4
File with stored sessions for this profile
.RE
.PP
\fIdata\&.sessionCookiesWhitelist\fR
.RS 4
Whitelist for session cookies
.RE
.PP
\fIdata\&.settings\fR
.RS 4
Settings configuration file
.RE
.PP
\fIdata\&.searchEngines\fR
.RS 4
Searchengines
.RE
.SS "io"
.sp
The io object implements methods for input and output\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid io.debug([Object detail])\fR
.RS 4
.sp
Prints a debug message and the call stack to stderr\&.
.PP
\fIdetail\fR
.RS 4
Message details, optional
.RE
.PP
\fIdetail\&.message\fR
.RS 4
The message to show, optional
.RE
.PP
\fIdetail\&.error\fR
.RS 4
An Error object, optional
.RE
.PP
\fIdetail\&.arguments\fR
.RS 4
Arguments, optional
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBArray io.dirNames(String path)\fR
.RS 4
.sp
Get directory entries\&.
.PP
\fIpath\fR
.RS 4
A path to a directory
.RE
.PP
\fIreturns\fR
.RS 4
An array with the directory names
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid io.error(String text)\fR
.RS 4
.sp
Shows an error message in the browser window\&.
.PP
\fItext\fR
.RS 4
The message to show
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid io.notify(String text)\fR
.RS 4
.sp
Shows a message in the browser window\&.
.PP
\fItext\fR
.RS 4
The message to show
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid io.print(String text, [String stream])\fR
.RS 4
.sp
Print text to stdout or stderr
.PP
\fItext\fR
.RS 4
the text to print
.RE
.PP
\fIstream\fR
.RS 4
pass "stderr" to print to stderr, optional
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString io.prompt(String text, [Boolean visible])\fR
.RS 4
.sp
Gets user input synchronously\&.
.PP
\fItext\fR
.RS 4
The message for the prompt
.RE
.PP
\fIvisible\fR
.RS 4
Whether the chars should be visible, pass false for a password prompt, default true, optional
.RE
.PP
\fIreturns\fR
.RS 4
The text that was entered or null
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString io.read(String path)\fR
.RS 4
.sp
Read from a file\&.
.PP
\fIpath\fR
.RS 4
Path to a file that should be read
.RE
.PP
\fIreturns\fR
.RS 4
A string with the file content
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean io.write(String path, String mode, String text)\fR
.RS 4
.sp
Write to a file
.PP
\fIpath\fR
.RS 4
Path to a file to write to
.RE
.PP
\fImode\fR
.RS 4
Either "a" to append to the file, or "w" to strip the file or create a new file\&.
.RE
.PP
\fItext\fR
.RS 4
The text that should be written to the file
.RE
.PP
\fIreturns\fR
.RS 4
true if writing was successful
.RE
.RE
.SS "system"
.sp
The system object implements system methods\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean system.fileTest(String path, FileTest flags)\fR
.RS 4
.sp
Checks for FileTest flags on a file\&.
.PP
\fIpath\fR
.RS 4
Path to a file to check
.RE
.PP
\fIflags\fR
.RS 4
The flags to test
.RE
.PP
\fIreturns\fR
.RS 4
true if any of the test on the flags is true
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString system.getEnv(String name)\fR
.RS 4
.sp
Get a system environment variable
.PP
\fIname\fR
.RS 4
Name of the variable
.RE
.PP
\fIreturns\fR
.RS 4
The variable or null if the variable wasn\(cqt found
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean system.mkdir(String path, Number mode)\fR
.RS 4
.sp
Creates a directory and all parent directories\&.
.PP
\fIpath\fR
.RS 4
Path to create
.RE
.PP
\fImode\fR
.RS 4
The permissions the directory will get
.RE
.PP
\fIreturns\fR
.RS 4
true if creation was successful or directory already existed
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDeferred system.spawn(String command, [Function stdout], [Function stderr], [Object environ])\fR
.RS 4
.sp
Executes a shell command using the default search path
.PP
\fIcommand\fR
.RS 4
The command to execute
.RE
.PP
\fIstdout(String)\fR
.RS 4
Callback function for stdin, any strings returned from the callback are passed to stdin of the spawned process, pass
null
if only stderr is needed, optional
.RE
.PP
\fIstderr(String)\fR
.RS 4
Callback function for stderr, any strings returned from the callback are passed to stdin of the process, pass
null
if stderr is not needed and environment variables should be set, optional
.RE
.PP
\fIenviron\fR
.RS 4
Object that can be used to add environment variables to the childs environment, optional\&.
.RE
.PP
\fIreturns\fR
.RS 4
A deferred, it will be resolved if the child exits normally, it will be rejected if the child process exits abnormally, the first parameter of the reject function will be the status code of the child process\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBObject system.spawnSync(String command, [Object environment])\fR
.RS 4
.sp
Executes a shell command synchronously using the default search path
.PP
\fIcommand\fR
.RS 4
The command to execute
.RE
.PP
\fIenvironment\fR
.RS 4
Object that can be used to add environment variables to the childs environment, optional\&.
.RE
.PP
\fIreturns\fR
.RS 4
An object that contains stdout, stderr and status\&.
.RE
.RE
.SS "tabs"
.sp
The tabs object implements methods and properties to get webview objects\&.
.PP
\fItabs\&.current (webview, read)\fR
.RS 4
The currently focused webview
.RE
.PP
\fItabs\&.length (Number, read)\fR
.RS 4
Total number of tabs
.RE
.PP
\fItabs\&.number (Number, read)\fR
.RS 4
Number of the currently focused tab
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBwebview tabs.nth(Number n)\fR
.RS 4
.sp
Gets the webview object of the nth tab
.PP
\fIn\fR
.RS 4
Number of the tab
.RE
.PP
\fIreturns\fR
.RS 4
The corresponding webview
.RE
.RE
.SS "net"
.sp
Network related functions
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString net.domainFromHost(String hostname)\fR
.RS 4
.sp
Gets the base domain name from a hostname where the base domain name is the effective second level domain name, e\&.g\&. for www\&.example\&.com it will be example\&.com, for www\&.example\&.co\&.uk it will be example\&.co\&.uk\&.
.PP
\fIhostname\fR
.RS 4
a hostname
.RE
.PP
\fIreturns\fR
.RS 4
the base domain
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid net.sendRequest(String uri, Function callback, [String method], [Object data])\fR
.RS 4
.sp
Sends a http\-request\&.
.PP
\fIuri\fR
.RS 4
The uri the request will be sent to\&.
.RE
.PP
\fIcallback\fR
.RS 4
A callback that will be called when the request is finished, the callback has 2 parameters, the first will be an object that contains body and headers, the second the associated SoupMessage\&.
.RE
.PP
\fImethod\fR
.RS 4
The http request method, default GET, optional\&.
.RE
.PP
\fIdata\fR
.RS 4
Data to sent if method is POST
.RE
.PP
\fIdata\&.contentType\fR
.RS 4
The content type
.RE
.PP
\fIdata\&.data\fR
.RS 4
The data to sent
.RE
.PP
\fIreturns\fR
.RS 4
True if the request was sent\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBObject net.sendRequestSync(String uri, [String method])\fR
.RS 4
.sp
Sends a http\-request synchronously\&.
.PP
\fIuri\fR
.RS 4
The uri the request will be sent to\&.
.RE
.PP
\fImethod\fR
.RS 4
The http request method, default GET, optional\&.
.RE
.PP
\fIreturns\fR
.RS 4
Object that contains the response body, the response headers and the http status code of the request\&.
.RE
.RE
.SS "timer"
.sp
Functions for timed execution
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber timer.start(Number interval, Function func)\fR
.RS 4
.sp
Executes a function repeatedly until the function returns false or timerStop is called on the id returned from this function
.PP
\fIinterval\fR
.RS 4
Interval in milliseconds
.RE
.PP
\fIfunc\fR
.RS 4
Function to execute
.RE
.PP
\fIreturns\fR
.RS 4
An id that can be passed to timerStop
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber timer.stop(Number id)\fR
.RS 4
.sp
Stops a timer started by timerStart
.PP
\fIid\fR
.RS 4
The id returned from timerStart
.RE
.PP
\fIreturns\fR
.RS 4
true if the timer was stopped
.RE
.RE
.SS "util"
.sp
The util object implements helper methods\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.camelize(String text)\fR
.RS 4
.sp
Converts a non\-camelcase string to a camelcase string\&.
.PP
\fItext\fR
.RS 4
A non\-camelcase string
.RE
.PP
\fIreturns\fR
.RS 4
The a camelcase string
.RE
.sp
Computes a checksum for given data\&.
.PP
\fIshortcut\fR
.RS 4
The to compute the checksum for\&.
.RE
.PP
\fItype\fR
.RS 4
The type of the checksum, optional, defaults to ChecksumType\&.sha256
.RE
.PP
\fIreturns\fR
.RS 4
The checksum
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.getBody(Function func)\fR
.RS 4
.sp
Gets the body of a function, useful for scripts that will be injected into sites\&.
.PP
\fIfunc\fR
.RS 4
A function
.RE
.PP
\fIreturns\fR
.RS 4
The body of the function as a string
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.dispatchEvent(Number event, Modifier modifier, Number keyval)\fR
.RS 4
.sp
Dispatches a keyboard event\&.
.PP
\fIevent\fR
.RS 4
A GdkEventType
.RE
.PP
\fImodifier\fR
.RS 4
A Modifier
.RE
.PP
\fIkeyval\fR
.RS 4
A keyval as listed in gdkkeysyms\&.h
.RE
.PP
\fIreturns\fR
.RS 4
True if the event was dispatched
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber util.getMode()\fR
.RS 4
.sp
Gets the the current mode\&.
.PP
\fIreturns\fR
.RS 4
The mode, see Modes for possible modes\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.getSelection()\fR
.RS 4
.sp
Get selected text from the focused webview\&.
.PP
\fIreturns\fR
.RS 4
The selection or null if no text was selected\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.markupEscape(String text)\fR
.RS 4
.sp
Escapes text for usage with pango markup\&.
.PP
\fItext\fR
.RS 4
A text to escape
.RE
.PP
\fIreturns\fR
.RS 4
The escaped text or
\fInull\fR;
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString util.mixin(Object self, Object \&...)\fR
.RS 4
.sp
Mixes properties of objects into an object\&. Properties are mixed in from left to right, so properties will not be overwritten in the leftmost object if they are already defined\&.
.PP
\fIself\fR
.RS 4
An object
.RE
.PP
\fIObject\&...\fR
.RS 4
Variable number of objects to mix in\&.
.RE
.PP
\fIreturns\fR
.RS 4
self or a new object if self is null or undefined
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid util.tabComplete(String label, Array items, Function callback, [Boolean readonly])\fR
.RS 4
.sp
Initiates tab completion\&.
.PP
\fIlabel\fR
.RS 4
The command line label
.RE
.PP
\fIitems\fR
.RS 4
An array of objects, each object can have 2 properties, left which will be the left completion label and right which will be the right completion label\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function, the first argument will be the returned string from the url bar\&.
.RE
.PP
\fIreadonly\fR
.RS 4
Whether the items are readonly, default false, optional\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid util.uncamelize(String text)\fR
.RS 4
.sp
Converts camel\-case string for usage with GObject properties to a non\-camel\-case String
.PP
\fItext\fR
.RS 4
The text to uncamlize
.RE
.PP
\fIreturns\fR
.RS 4
The uncamelized string
.RE
.sp
dwb also adds additional methods to builtin objects
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid Object.forEach(Function func(String key, Object value, Object this))\fR
.RS 4
.sp
Executes a function for each enumarable property of this similar to Array\&.forEach\&.
.PP
\fIfunc\fR
.RS 4
The function to execute
.RE
.PP
\fIkey\fR
.RS 4
The property name
.RE
.PP
\fIvalue\fR
.RS 4
The property value
.RE
.PP
\fIthis\fR
.RS 4
The object forEach is called on
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber Array.fastIndexOf(Object object)\fR
.RS 4
.sp
This method is basically the same as Array\&.indexOf but without type checking\&.
.PP
\fIobject\fR
.RS 4
The object to search for
.RE
.PP
\fIreturns\fR
.RS 4
The index in the array or \-1 if the Object wasn\(cqt found\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber Array.fastLastIndexOf(Object object)\fR
.RS 4
.sp
This method is basically the same as Array\&.lastIndexOf but without type checking\&.
.PP
\fIobject\fR
.RS 4
The object to search for
.RE
.PP
\fIreturns\fR
.RS 4
The index in the array or \-1 if the Object wasn\(cqt found\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid Function.debug([Object scope])\fR
.RS 4
.sp
A wrapper method for debugging callbacks, especially useful if it is combined with script\&.
.PP
\fIscope\fR
.RS 4

\fBscript\fR
or
\fBthis\fR, optional
.RE
.PP
\fIreturns\fR
.RS 4
A new function that calls script\&.debug on errors\&.
.RE
.RE
.SS "clipboard"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid clipboard.get(Selection selection, [Function callback])\fR
.RS 4
.sp
Gets the X11 clipboard\&.
.PP
\fIselection\fR
.RS 4
The Selection to get
.RE
.PP
\fIcallback\fR
.RS 4
If a callback function is used the clipboard will be fetched asynchronously, the first parameter will be the content of the clipboard, else it will be fetched synchronously
.RE
.PP
\fIreturns\fR
.RS 4
If no callback was provided it returns the text content of the clipboard\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid clipboard.set(Selection selection, String text)\fR
.RS 4
.sp
Sets the X11 clipboard\&.
.PP
\fIselection\fR
.RS 4
The Selection to set
.RE
.PP
\fItext\fR
.RS 4
Text that will be stored in the clipboard\&.
.RE
.RE
.SS "gui"
.sp
Most gtk\-widgets can be accessed from scripts, an overview of the layout can be found under https://portix\&.bitbucket\&.org/dwb/resources/layout\&.html\&.
.PP
\fIgui\&.window (GtkWindow, read)\fR
.RS 4
The main window\&.
.RE
.PP
\fIgui\&.mainBox (GtkBox, read)\fR
.RS 4
The the main container, child of
\fBgui\&.window\fR\&.
.RE
.PP
\fIgui\&.tabBox (GtkBox, read)\fR
.RS 4
The box used for tab labels, child of
\fBgui\&.mainBox\fR\&.
.RE
.PP
\fIgui\&.contentBox (GtkBox, read)\fR
.RS 4
The box used for the main content, it contains all webviews, child of
\fBgui\&.mainBox\fR\&.
.RE
.PP
\fIgui\&.statusWidget (GtkEventBox, read)\fR
.RS 4
The outmost statusbar widget, used for setting the statusbars colors, child of
\fBgui\&.mainBox\fR\&.
.RE
.PP
\fIgui\&.statusAlignment (GtkAlignment, read)\fR
.RS 4
Used for the statusbar alignment, child of
\fBgui\&.statusWidget\fR\&.
.RE
.PP
\fIgui\&.statusBox (GtkBox, read)\fR
.RS 4
The box that contains the statusbar widgets, grandchild of
\fBgui\&.statusAlignment\fR\&.
.RE
.PP
\fIgui\&.messageLabel (GtkLabel, read)\fR
.RS 4
Label used for notifications, first child of
\fBgui\&.statusBox\fR\&.
.RE
.PP
\fIgui\&.entry (GtkEntry, read)\fR
.RS 4
The entry, second child of
\fBgui\&.statusBox\fR\&.
.RE
.PP
\fIgui\&.uriLabel (GtkLabel, read)\fR
.RS 4
Label used for displaying uris, third child of
\fBgui\&.statusBox\fR\&.
.RE
.PP
\fIgui\&.statusLabel (GtkLabel, read)\fR
.RS 4
Label used for status information, fourth child of
\fBgui\&.statusBox\fR\&.
.RE
.SS "Deferred"
.sp
Deferred objects can be used to manage asynchronous operations\&. It can trigger a callback function when an asynchrounous operation has finished, and allows chaining of callbacks\&. Deferred basically has 2 callback chains, a \fIdone\fR\-chain and a \fIfail\fR\-chain\&. If a asynchronous operation is successful the deferred should be resolved and the done callback chain of the deferred is called\&. If a asynchronous operation fails the deferred should be rejected and the fail callback chain of the deferred is called\&.
.sp
Deferreds implement the following methods:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid Deferred.always(Function callback)\fR
.RS 4
.sp
Registers a function for then done and fail chain\&.
.PP
\fIcallback\fR
.RS 4
A callback function that will be called when the Deferred is resolved or rejected\&. If the function returns a deferred the original deferred will be replaced with the new deferred\&.
.RE
.PP
\fIreturns\fR
.RS 4
A new deferred that can be used to chain callbacks\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid Deferred.done(Function callback)\fR
.RS 4
.sp
Registers a function for the done\-chain\&.
.PP
\fIcallback\fR
.RS 4
A callback function that will be called when the Deferred is resolved\&. If the function returns a deferred the original deferred will be replaced with the new deferred\&.
.RE
.PP
\fIreturns\fR
.RS 4
A new deferred that can be used to chain callbacks\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDeferred Deferred.fail(Function callback)\fR
.RS 4
.sp
Registers a function for the fail\-chain\&.
.PP
\fIcallback\fR
.RS 4
A callback function that will be called when the deferred is rejected\&. If the function returns a deferred the original deferred will be replaced with the new deferred\&.
.RE
.PP
\fIreturns\fR
.RS 4
A new deferred that can be used to chain callbacks\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDeferred Deferred.reject(arguments)\fR
.RS 4
.sp
Rejects a deferred, the fail\-chain is called when a deferred is rejected\&.
.PP
\fIarguments\fR
.RS 4
Arguments passed to the
\fIfail\fR
callbacks\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid Deferred.resolve(arguments)\fR
.RS 4
.sp
Resolves a deferred, the done\-chain is called when a deferred is resolved\&.
.PP
\fIarguments\fR
.RS 4
Arguments passed to the
\fIdone\fR
callbacks\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDeferred Deferred.then(Function ondone, Function onfail)\fR
.RS 4
.sp
Registers a function for the done and fail chain\&.
.PP
\fIondone\fR
.RS 4
A callback function that will be called when the deferred is resolved\&. If the function returns a deferred the original deferred will be replaced with the new deferred\&.
.RE
.PP
\fIonfail\fR
.RS 4
A callback function that will be called when the deferred is rejected\&. If the function returns a deferred the original deferred will be replaced with the new deferred\&.
.RE
.PP
\fIreturns\fR
.RS 4
A new deferred that can be used to chain callbacks\&.
.RE
.sp
Deferred also implements a static method:
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBValue Deferred.when(Value value, Function ondone, Function onfail)\fR
.RS 4
.sp
Static method that can be used for synchronous and asynchronous operations\&. If if \fBvalue\fR is a Deferred \fBondone\fR is called when the Deferred is resolved and \fBonfail\fR is called if the Deferred is rejected, otherwise ondone is called and value is the first parameter of the callback\&.
.PP
\fIvalue\fR
.RS 4
A Deferred or a value\&.
.RE
.PP
\fIondone\fR
.RS 4
Callback function\&.
.RE
.PP
\fIonfail\fR
.RS 4
Callback function\&.
.RE
.PP
\fIreturns\fR
.RS 4
The value\&.
.RE
.sp
Simple usage of a deferred:
.sp
.if n \{\
.RS 4
.\}
.nf
function loadUri(uri) {
    var d = new Deferred();
    tabs\&.current\&.loadUri(uri, function(wv) {
        if (wv\&.loadStatus == LoadStatus\&.finished)
        {
            d\&.resolve("Finished");
            return true;
        }
        else if (wv\&.loadStatus == LoadStatus\&.failed)
        {
            d\&.reject("Failed");
            return true;
        }
    });
    return d;
}

loadUri("http://www\&.example\&.com")\&.then(
    function(response) {
        io\&.print(response); // Finished
    },
    function(response) {
        io\&.print(response); // Failed
    }
);
.fi
.if n \{\
.RE
.\}
.sp
Chaining of a deferred:
.sp
.if n \{\
.RS 4
.\}
.nf
function foo()
{
    var d = new Deferred();
    timer\&.start(2000, function() {
        d\&.reject("rejected");
    });
    return d;
}

function onResponse(response)
{
    io\&.print(response);
}

// Will print "rejected" twice to stdout after 2 seconds
foo()\&.fail(onResponse)\&.fail(onResponse);
.fi
.if n \{\
.RE
.\}
.sp
Note that if the deferred is rejected only the fail chain is called, when it is resolved only the done chain is called\&.
.sp
.if n \{\
.RS 4
.\}
.nf
function foo()
{
    var d = new Deferred();
    timer\&.start(2000, function() {
        d\&.reject("rejected");
        // Already rejected, will not execute the done chain
        d\&.resolve("rejected");
    });
    return d;
}

function onResponse(response)
{
    io\&.print(response);
}

// Only the fail will be executed

foo()\&.fail(onResponse)\&.done(onResponse);
foo()\&.done(onResponse)\&.fail(onResponse);
.fi
.if n \{\
.RE
.\}
.sp
Changing the deferred in a callback chain:
.sp
.if n \{\
.RS 4
.\}
.nf
function foo(message)
{
    var d = new Deferred();
    timer\&.start(2000, function() {
        d\&.resolve(message);
    });
    return d;
}
function callback1(response)
{
    io\&.print(response); // Prints "foo" after 2 seconds

    // Return a new Deferred, will replace the old one\&.
    return foo("bar");
}
function callback2(response)
{
    io\&.print(response); // Prints "bar" after 4 seconds
}

foo("foo")\&.done(callback1)\&.done(callback2);
.fi
.if n \{\
.RE
.\}
.sp
Using Deferred\&.when
.sp
.if n \{\
.RS 4
.\}
.nf
function asyncOperation() {
    var d = new Deferred();
    \&.\&.\&.\&.
    return d;
}
function syncOperation()
{
    var result = {};
    \&.\&.\&.\&.
    return result;
}
Deferred\&.when(asyncOperation(), function() {\&.\&.\&.});
Deferred\&.when(syncOperation(), function() {\&.\&.\&.});
.fi
.if n \{\
.RE
.\}
.RE
.SS "Glob"
.sp
Globs can be used for pattern matching, they are much simpler than regular expressions, there are only two special characters, the wildcard character \fI*\fR which matches any number of unknown characters and the joker character \fI?\fR which matches exactly one unknown character\&. The literal characters "*" and "?" must be escaped with "\e\e";
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBnew Glob(String pattern)\fR
.RS 4
.sp
Constructs a new Glob\&.
.PP
\fIpattern\fR
.RS 4
The pattern to match against\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean Glob.match(String string)\fR
.RS 4
.sp
Matches against a string
.PP
\fIstring\fR
.RS 4
The string to match against\&.
.RE
.PP
\fIreturns\fR
.RS 4
True if the string matches the Glob\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString Glob.toString()\fR
.RS 4
.sp
Converts a Glob to string\&.
.PP
\fIreturns\fR
.RS 4
A string represantation of the Glob\&.
.RE
.RE
.SS "settings"
.sp
Readonly object that can be used to query dwb\(cqs current settings, all settings can also be used in camelcase, to modify settings \fBexecute\fR can be used\&.
.sp
.if n \{\
.RS 4
.\}
.nf
if (settings\&.enablePrivateBrowsing == true)
    execute("set enable\-private\-browsing false");
.fi
.if n \{\
.RE
.\}
.SH "WEBKIT OBJECTS"
.sp
All webkit objects correspond to gobject objects, i\&.e\&. they have the same properties, but the javascript properties are all camelcase\&. For example, a WebKitWebView has the property \fBzoom\-level\fR, the corresponding javascript property is \fBzoomLevel\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
var webview = tabs\&.current
webview\&.zoomLevel = webview\&.zoomLevel * 2;
.fi
.if n \{\
.RE
.\}
.sp
To check if an object is derived from GObject the instanceof operator can be used:
.sp
.if n \{\
.RS 4
.\}
.nf
if (myObject instanceof GObject)
{
  \&.\&.\&.
}
.fi
.if n \{\
.RE
.\}
.SS "General methods"
.sp
The following methods are implemented by all Objects derived from GObject
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid object.blockSignal(Number signalid)\fR
.RS 4
.sp
Blocks emission of a gobect signal\&.
.PP
\fIsignalid\fR
.RS 4
The signalid returned from
\fBobject\&.connect\fR
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber object.connect(String name, Function callback, [Boolean after])\fR
.RS 4
.sp
Connect to a gobject\-signal, note that all signals are connected using the \fIsignal::\fR\- or with \fInotify::\fR\-prefix\&. If connecting to a signal the \fIsignal::\fR\-prefix must be omitted\&. The callback function will have the same parameters as the GObject signal callback, however some parameters may be undefined if they cannot be converted to javascript objects\&. All signal handlers are executed after dwb\(cqs default handler\&.
.PP
\fIname\fR
.RS 4
The signal name to connect to\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that will be called when the signal is emitted\&.
.RE
.PP
\fIafter\fR
.RS 4
Whether to install the handler after the default handler, default false\&.
.RE
.PP
\fIreturns\fR
.RS 4
The signal id of the signal\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber object.connectBlocked(String name, Function callback, [Boolean after])\fR
.RS 4
.sp
Connect to a gobject\-signal but block the emission of the own callback during execution of the callback, useful if the object is connected to a notify event and the the property is changed in the callback function\&.
.PP
\fIname\fR
.RS 4
The signal name to connect to\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that will be called when the signal is emitted\&.
.RE
.PP
\fIafter\fR
.RS 4
Whether to install the handler after the default handler, default false\&.
.RE
.PP
\fIreturns\fR
.RS 4
The signal id of the signal\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean object.disconnect(Number id)\fR
.RS 4
.sp
Disconnect from a gobject\-signal\&.
.PP
\fIid\fR
.RS 4
The signal id obtained from connect
.RE
.PP
\fIreturns\fR
.RS 4
true if the signal was disconnected
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber object.notify(String name, Function callback, [Boolean after])\fR
.RS 4
.sp
Wrapper function for property\-change notification, the same as \fIobject\&.connect("notify::" + name, callback, after);\fR\&.
.PP
\fIname\fR
.RS 4
The property name to connect to, the name can also be in camelcase\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that will be called when the property changes\&.
.RE
.PP
\fIafter\fR
.RS 4
Whether to install the handler after the default handler, default after\&.
.RE
.PP
\fIreturns\fR
.RS 4
The signal id of the signal\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber object.notifyBlocked(String name, Function callback, [Boolean after])\fR
.RS 4
.sp
Wrapper function for property\-change notification, the same as \fIobject\&.connectBlocked("notify::" + name, callback, after);\fR\&.
.PP
\fIname\fR
.RS 4
The property name to connect to, the name can also be in camelcase\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that will be called when the property changes\&.
.RE
.PP
\fIafter\fR
.RS 4
Whether to install the handler after the default handler, default after\&.
.RE
.PP
\fIreturns\fR
.RS 4
The signal id of the signal\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid object.unblockSignal(Number signalid)\fR
.RS 4
.sp
Unblocks a signal previously blocked with \fBobject\&.blockSignal\fR\&.
.PP
\fIsignalid\fR
.RS 4
The signalid returned from
\fBobject\&.connect\fR
.RE
.RE
.SS "webview"
.sp
The webview object represents the widget that actually displays the site content\&.
.PP
\fIwv\&.allFrames (Array of frames, read)\fR
.RS 4
All frames of a webview including the mainframe
.RE
.PP
\fIwv\&.focusedFrame (Frame, read)\fR
.RS 4
The focused frame of the webview
.RE
.PP
\fIwv\&.historyList (Historylist, read)\fR
.RS 4
The focused frame of the webview
.RE
.PP
\fIwv\&.mainFrame (Frame, read)\fR
.RS 4
The main frame of the webview
.RE
.PP
\fIwv\&.number (Number, read)\fR
.RS 4
The number of the webview, starting at 0
.RE
.PP
\fIwv\&.scrolledWindow (GtkScrollwindow, read)\fR
.RS 4
The parent widget of every webview, it is used for scrolling the webview\&.
.RE
.PP
\fIwv\&.tabWidget (GtkEventBox, read)\fR
.RS 4
The main widget for tab labels, used for coloring tabs, child of
\fBgui\&.tabBox\fR\&.
.RE
.PP
\fIwv\&.tabBox (GtkBox, read)\fR
.RS 4
Horizontal box, child of
\fBwv\&.tabWidget\fR\&.
.RE
.PP
\fIwv\&.tabIcon (GtkImage, read)\fR
.RS 4
Favicon widget, child of
\fBwv\&.tabBox\fR\&.
.RE
.PP
\fIwv\&.tabLabel (GtkLabel, read)\fR
.RS 4
Text label of a tab, child of
\fBwv\&.tabBox\fR\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString wv.inject([String code|Function code], [Object arg], [Boolean global])\fR
.RS 4
.sp
Injects a script into a webview
.PP
\fIcode\fR
.RS 4
The script to inject, either a string or a function\&. If it is a function the body will be wrapped inside a new function\&.
.RE
.PP
\fIarg\fR
.RS 4
If the script isn\(cqt injected into the global scope the script is wrapped inside a function\&.
\fIarg\fR
then is accesible via
\fIarguments\fR
in the injected script, optional
.RE
.PP
\fIline\fR
.RS 4
Starting line number, useful for debugging\&. If linenumber is greater than 0 error messages will be printed to stderr, optional\&.
.RE
.PP
\fIglobal\fR
.RS 4
true to inject it into the global scope, false to encapsulate it in a function, optional
.RE
.PP
\fIreturns\fR
.RS 4
The return value of the script\&. If the script is injected globally inject always returns null\&. The return value is always converted to a string\&. To return objects call JSON\&.parse on the return value\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
If a script is injected from a loadStatus\-callback the script must be injected after LoadStatus\&.committed has been emitted\&. On LoadStatus\&.committed the document hasn\(cqt been created, if the script modifies the DOM it should be injected when LoadStatus\&.finished or documentLoaded is emitted\&. If only LoadStatus\&.committed or loadFinished\&.committed are used it is better to use the corresponding signals instead to reduce overhead\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid wv.history(Number steps)\fR
.RS 4
.sp
Loads a history item steps away from the current history item
.PP
\fIsteps\fR
.RS 4
Number of steps, pass a negative value to go back in history
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean wv.loadUri(String uri, [Function callback])\fR
.RS 4
.sp
Loads an uri in a webview\&.
.PP
\fIuri\fR
.RS 4
The uri to load
.RE
.PP
\fIcallback\fR
.RS 4
A callback function that will be called when the load status changes, return true to stop the emission, optional
.RE
.PP
\fIreturns\fR
.RS 4
true if the uri is loaded
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid wv.reload(void)\fR
.RS 4
.sp
Reloads a webview
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid wv.stopLoading()\fR
.RS 4
.sp
Stops any ongoing loading\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber wv.toPng(String filename, [Number width, Number height], [Boolean keepAspect])\fR
.RS 4
.sp
Renders a webview to a png file\&.
.PP
\fIfilename\fR
.RS 4
The filename for the png\&.
.RE
.PP
\fIwidth\fR
.RS 4
The width of the png, if width is < 0 and height is > 0 the image will have the same aspect ratio as the original webview, optional\&.
.RE
.PP
\fIheight\fR
.RS 4
The height of the png, if height is < 0 and width is > 0 the image will have the same aspect ratio as the original webview, optional, mandatory if width is set\&.
.RE
.PP
\fIkeepAspect\fR
.RS 4
Whether to keep the aspect ratio, if set to true the new image will have the same aspect ratio as the original webview, width and height are taken as maximum sizes and must both be > 0, optional\&.
.RE
.PP
\fIreturns\fR
.RS 4
A cairo_status_t (0 on success) or \-1 if an error occured\&.
.RE
.RE
.SS "frame"
.sp
A frame represents a frame or iframe\&. Due to same origin policy it is not possible to inject scripts from a webview into iframes with a different domain\&. For this purpose the frame object can be used\&.
.PP
\fIframe\&.domain (String, read)\fR
.RS 4
The domain name of the frame which is the effective second level domain
.RE
.PP
\fIframe\&.host (String, read)\fR
.RS 4
The host name of the frame
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean frame.inject(String script, [Boolean global])\fR
.RS 4
.sp
Injects a script into a frame, see also webview\&.inject for details\&.
.RE
.SS "download"
.sp
Corresponds to a WebKitDownload\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBnew Download(String uri)\fR
.RS 4
.sp
Constructs a new download
.PP
\fIuri\fR
.RS 4
The uri of the download
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean download.start([Function callback])\fR
.RS 4
.sp
Starts a download
.PP
\fIcallback\fR
.RS 4
A callback function that will be executed whenever the DownloadStatus changes, return true to stop the emission, optional\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid download.cancel()\fR
.RS 4
.sp
Cancels a download
.RE
.SS "historylist"
.sp
Corresponds to a WebkitWebBackForwardList\&.
.PP
\fIhistorylist\&.backLength\fR
.RS 4
Number of items that precede the current item
.RE
.PP
\fIhistorylist\&.forwardLength\fR
.RS 4
Number of items that succeed the current item
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBWebKitWebHistoryItem historylist.getItem([Number position])\fR
.RS 4
.sp
Gets a WebKitWebHistoryItem\&.
.PP
\fIposition\fR
.RS 4
The position of the item where 0 corresponds to the current item\&.
.RE
.PP
\fIreturns\fR
.RS 4
A WebKitWebHistoryItem\&.
.RE
.RE
.SH "GTK WIDGETS"
.sp
It is possible to create new widgets but only widgets that are currently used by dwb can be created, the widgets used by dwb can be found under http://portix\&.bitbucket\&.org/dwb/resources/layout\&.html\&.
.SS "Constructor"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBnew GtkWindow(String type)\fR
.RS 4
.sp
Constructs a new widget
.PP
\fItype\fR
.RS 4
The type of the widget, e\&.g\&. "GtkLabel"
.RE
.RE
.SS "Methods"
.sp
All created widgets implement the following methods:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid GtkWidget.destroy()\fR
.RS 4
.sp
Destroys a widget\&. Note that only newly created widgets can be destroyed\&.
.sp
Widgets that implement the GtkBox interface implement the following methods:
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid GtkWidget.packEnd(GtkWidget child, boolean expand, boolean fill, int padding)\fR
.RS 4
.sp
Adds a widget to a GtkBox\&.
.PP
\fIchild\fR
.RS 4
The child widget
.RE
.PP
\fIexpand\fR
.RS 4
Whether to expand the widget
.RE
.PP
\fIfill\fR
.RS 4
Whether to fill the remaining space
.RE
.PP
\fIpadding\fR
.RS 4
Padding in the box
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid GtkWidget.packStart(GtkWidget child, boolean expand, boolean fill, int padding)\fR
.RS 4
.sp
Adds a widget to a GtkBox\&.
.PP
\fIchild\fR
.RS 4
The child widget
.RE
.PP
\fIexpand\fR
.RS 4
Whether to expand the widget
.RE
.PP
\fIfill\fR
.RS 4
Whether to fill the remaining space
.RE
.PP
\fIpadding\fR
.RS 4
Padding in the box
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid GtkWidget.reorderChild(GtkWidget child, int postion)\fR
.RS 4
.sp
Moves a widget to a new position\&.
.PP
\fIchild\fR
.RS 4
The child widget
.RE
.PP
\fIposition\fR
.RS 4
The new position
.RE
.sp
Widgets derived from GtkContainer implement the following methods:
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid GtkWidget.add(GtkWidget child)\fR
.RS 4
.sp
Adds a widget to a GtkContainer\&.
.PP
\fIchild\fR
.RS 4
The child widget
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExample\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
var label = new GtkWidget("GtkLabel");
gui\&.statusBox\&.packStart(label, false, false, 0);
label\&.label = "foobar";
label\&.visible = true;
.fi
.if n \{\
.RE
.\}
.RE
.SH "SIGNALS"
.sp
Execute code on certain events\&. dwb emits some signals, e\&.g\&. before a new site is loaded, the signals object can be used to handle these signals\&. All events are emitted on the signals object itself, for example "signals\&.keyPress = function() { \&... };" would connect to the keyPress signal but it is strongly discouraged to use this pattern since it will only allow to connect one callback to a certain signal\&. To handle signals Signal\-objects can be used, it manages signals, allows to connect to more than one signal and also allows to easily disconnect/reconnect to signals\&.
.sp
There is just one convenient pattern that allows setting callbacks directly on signals: if the signal name starts with "on" dwb will internally create a new Signal and connect to it with the given callback function, i\&.e\&. using signals\&.onResource = function () {\&...} allows to connect more than one callback to the "resource"\-event, however it doesn\(cqt give you as much control as creating a Signal\&. When connected with this pattern it is not possible to disconnect from the signal with signals\&.onResource = null;, instead Signal\&.disconnect must be used\&.
.SS "Emitted signals"
.sp
Custom signals can be created by simply calling
.sp
.if n \{\
.RS 4
.\}
.nf
var signal = new Signal("nameOfNewSignal", callbackFunction);
.fi
.if n \{\
.RE
.\}
.sp
Signals emitted by dwb are the following:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBbuttonPress\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("buttonPress", function(webview, hittestresult, event));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a button is pressed on the webview, return true to prevent the default action
.PP
\fIwebview\fR
.RS 4
The webview which received the signal
.RE
.PP
\fIhittestresult\fR
.RS 4
Hittestresult under the cursor
.RE
.PP
\fIevent\&.button\fR
.RS 4
The button that is pressed, usually a value between 1 and 5
.RE
.PP
\fIevent\&.state\fR
.RS 4
A bitmap of modifiers pressed, see Modifier
.RE
.PP
\fIevent\&.time\fR
.RS 4
The time in milliseconds when the button was pressed
.RE
.PP
\fIevent\&.type\fR
.RS 4
A ClickType
.RE
.PP
\fIevent\&.x\fR
.RS 4
x\-position relative to the window
.RE
.PP
\fIevent\&.xRoot\fR
.RS 4
x\-position relative to the screen
.RE
.PP
\fIevent\&.y\fR
.RS 4
y\-position relative to the window
.RE
.PP
\fIevent\&.yRoot\fR
.RS 4
y\-position relative to the screen
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBbuttonRelease\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("buttonRelease", function(webview, hittestresult, event));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a button is released, return true to prevent the default action
.PP
\fIwebview\fR
.RS 4
The webview which received the signal
.RE
.PP
\fIhittestresult\fR
.RS 4
Hittestresult under the cursor
.RE
.PP
\fIevent\fR
.RS 4
Same as buttonPress but without
\fIevent\&.type\fR
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBchangeMode\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("changeMode", function(webview, mode));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the mode changes, return true to prevent the change\&.
.PP
\fIwebview\fR
.RS 4
The focused webview
.RE
.PP
\fImode\fR
.RS 4
A mode, see also Modes for possible modes
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBclose\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("close", function());
.fi
.if n \{\
.RE
.\}
.sp
Emitted when dwb is closed
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBcloseTab\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("closeTab", function(webview));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a tab is closed
.PP
\fIwebview\fR
.RS 4
The webview that corresponds to the tab
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBcreateTab\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("createTab", function(webview));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a tab is created
.PP
\fIwebview\fR
.RS 4
The webview that corresponds to the created tab
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBdocumentLoaded\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("documentLoaded",  function(webview, frame));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a the DOM document of a frame has been loaded\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIframe\fR
.RS 4
The frame that contains the document
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBdownload\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("download", function(webview, download, json));
.fi
.if n \{\
.RE
.\}
.sp
Emitted before a download starts, before a file or action has been chosen, return true if the signal was handled\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIdownload\fR
.RS 4
The Download
.RE
.PP
\fIjson\&.referer\fR
.RS 4
The referer
.RE
.PP
\fIjson\&.mimeType\fR
.RS 4
The mimetype of the file
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBdownloadStart\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("downloadStart", function(download, json));
.fi
.if n \{\
.RE
.\}
.sp
Emitted before a download starts after a path or application has been chosen, return true if the signal was handled\&. Note that destinationUri has not been set on the download\&.
.PP
\fIdownload\fR
.RS 4
The Download
.RE
.PP
\fIjson\&.referer\fR
.RS 4
The referer
.RE
.PP
\fIjson\&.mimeType\fR
.RS 4
The mimetype of the file
.RE
.PP
\fIjson\&.destinationUri\fR
.RS 4
The chosen destination path or null if an application was chosen\&.
.RE
.PP
\fIjson\&.application\fR
.RS 4
The chosen application or null if a path was chosen\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBdownloadStatus\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("downloadStatus", function(download));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the DownloadStatus changes\&.
.PP
\fIdownload\fR
.RS 4
The Download
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBexecuteCommand\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("executeCommand", function(commandinfo));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a command is executed, return true to prevent execution\&.
.PP
\fIcommandinfo\&.command\fR
.RS 4
The command that is executed
.RE
.PP
\fIcommandinfo\&.argument\fR
.RS 4
An argument, if the command isn\(cqt executed from commandline this will always be null\&.
.RE
.PP
\fIcommandinfo\&.nummod\fR
.RS 4
The numerical modifier\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBframeCreated\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("frameCreated", function(webview, frame));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a frame is created
.PP
\fIwebview\fR
.RS 4
The webview the frame belongs to
.RE
.PP
\fIframe\fR
.RS 4
The frame
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBframeStatus\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("frameStatus", function(webview, frame));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the LoadStatus of a frame changes
.PP
\fIwebview\fR
.RS 4
The webview the frame belongs to
.RE
.PP
\fIframe\fR
.RS 4
The frame
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBkeyPress\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("keyPress", function(webview, json));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a key is pressed, return true to prevent the default action
.PP
\fIwebview\fR
.RS 4
The focused webview
.RE
.PP
\fIjson\&.isModifier\fR
.RS 4
Whether or not the key is a modifier
.RE
.PP
\fIjson\&.keyCode\fR
.RS 4
Hardware keycode
.RE
.PP
\fIjson\&.keyVal\fR
.RS 4
Keycode as listed in gdkkeysyms\&.h
.RE
.PP
\fIjson\&.name\fR
.RS 4
A string represantation of the key
.RE
.PP
\fIjson\&.state\fR
.RS 4
A bitmap of modifiers pressed, see Modifier
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBkeyRelease\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("keyRelease", function(webview, json));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a key is released, return true to prevent the default action
.PP
\fIwebview\fR
.RS 4
The focused webview
.RE
.PP
\fIjson\fR
.RS 4
Same as keyPress
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBloadCommitted\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("loadCommitted", function(webview));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the load has just commited, no data has been loaded when this signal is emitted\&. This is the preferred signal for injected scripts that do not manipulate the DOM\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBloadFinished\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("loadFinished", function(webview));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the site has completely loaded\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBloadStatus\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("loadStatus", function(webview));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the load status changes
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBmimeType\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("mimeType", function(webview, frame, request, json));
.fi
.if n \{\
.RE
.\}
.sp
Decide whether or not to show a given mimetype\&. Return true to stop the request\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIframe\fR
.RS 4
The frames requires the decision
.RE
.PP
\fIrequest\fR
.RS 4
The network request
.RE
.PP
\fIjson\&.mimeType\fR
.RS 4
The mimetype
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBmouseMove\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("mouseMove", function(webview, event));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when the pointer is moved\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIevent\fR
.RS 4
Same as buttonRelease
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBnavigation\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("navigation", function(webview, frame, request, action));
.fi
.if n \{\
.RE
.\}
.sp
Emitted before a new site is loaded, return true to stop the request\&.
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIframe\fR
.RS 4
The frame that requires the navigation
.RE
.PP
\fIrequest\fR
.RS 4
The network request
.RE
.PP
\fIaction\fR
.RS 4
The navigation action
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBresource\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("resource", function(webview, frame, request, response));
.fi
.if n \{\
.RE
.\}
.sp
Emitted before a new resource is going to be loaded
.PP
\fIwebview\fR
.RS 4
The webview that emitted the signal
.RE
.PP
\fIframe\fR
.RS 4
The frame that dispatched the request
.RE
.PP
\fIrequest\fR
.RS 4
The network request
.RE
.PP
\fIresponse\fR
.RS 4
The network response
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBstatusBarChange\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("statusBarChange", function(webview, data));
.fi
.if n \{\
.RE
.\}
.sp
Emitted before the status bar is updated, if the callback returns true dwb will not update the statusbar so it is possible to set the statusbar from the script\&.
.PP
\fIwebview\fR
.RS 4
The focused webview
.RE
.PP
\fIdata\&.canGoBack\fR
.RS 4
Whether it is possible to navigate back in the webview
.RE
.PP
\fIdata\&.canGoForward\fR
.RS 4
Whether it is possible to navigate forward in the webview
.RE
.PP
\fIdata\&.isBookmarked\fR
.RS 4
Whether the site is bookmarked
.RE
.PP
\fIdata\&.isQuickmarked\fR
.RS 4
Whether the site is quickmarked
.RE
.PP
\fIdata\&.pluginsBlocked\fR
.RS 4
Whether plugins are blocked
.RE
.PP
\fIdata\&.scriptsBlocked\fR
.RS 4
Whether scripts are blocked
.RE
.PP
\fIdata\&.ssl\fR
.RS 4
SSL\-State of the page, can either be
\fItrusted\fR,
\fIuntrusted\fR
or
\fInone\fR
.RE
.PP
\fIdata\&.type\fR
.RS 4
The type of the update, can be
\fBstatus\fR
and
\fBuri\fR, status means that statusLabel und uriLabel need to be updated, uri means that only the uriLabel needs to be updated\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBtabButtonPress\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("tabButtonPress", function(webview, tabwidget, event));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when a button is pressed on a tabwidget, return true to prevent the default action
.PP
\fIwebview\fR
.RS 4
The webview which received the signal
.RE
.PP
\fItabwidget\fR
.RS 4
The tabwidget
.RE
.PP
\fIevent\fR
.RS 4
Same as buttonPress
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBtabFocus\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
new Signal("tabFocus", function(webview, json));
.fi
.if n \{\
.RE
.\}
.sp
Emitted when another tab gets focus, return true to stop the event
.PP
\fIwebview\fR
.RS 4
The new tab
.RE
.PP
\fIjson\&.last\fR
.RS 4
The number of the previously focused tab
.RE
.RE
.SH "SIGNAL"
.sp
Object that can be used to connect to certain browser events\&.
.SS "Constructor"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBnew Signal(String name, [Function callback])\fR
.RS 4
.sp
Constructs a new signal
.PP
\fIname\fR
.RS 4
Name of the event
.RE
.PP
\fIcallback\fR
.RS 4
Callback function that is invoked when the signal is emitted\&.
.RE
.RE
.SS "Properties"
.PP
\fIcallback (Function, read|write)\fR
.RS 4
The callback that will be called when the signal is emitted, the context of the signal will be the signal itself (i\&.e\&. this refers to the connected Signal)\&.
.RE
.PP
\fIconnected (Boolean, read)\fR
.RS 4
Whether the signal is connected
.RE
.PP
\fIid (Number, read)\fR
.RS 4
Unique id of the signal
.RE
.PP
\fIname (Number, read)\fR
.RS 4
Name of the event
.RE
.SS "Methods"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBconnect([Function callback])\fR
.RS 4
.sp
Connects the signal to the event
.PP
\fIcallback\fR
.RS 4
Callback function that is invoked when the signal is emitted, optional but mandatory if no callback was given during signal construction\&.
.RE
.PP
\fIreturns\fR
.RS 4
self
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBdisconnect([Function callback])\fR
.RS 4
.sp
Disconnects the signal from the event
.PP
\fIreturns\fR
.RS 4
self
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBtoggle()\fR
.RS 4
.sp
Toggles a signal, if it is connected it will be disconnected an vice versa\&.
.PP
\fIreturns\fR
.RS 4
true if the signal was connected, false otherwise
.RE
.RE
.SS "Static methods"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.connect(String name, Function callback)\fR
.RS 4
.sp
Connects to an event
.PP
\fIsignals\fR
.RS 4
The event name
.RE
.PP
\fIcallback\fR
.RS 4
Callback function to connect to\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.connectAll(Array signals, [Function callback])\fR
.RS 4
.sp
Connects to more than one signal at once
.PP
\fIsignals\fR
.RS 4
Array of signals\&.
.RE
.PP
\fIcallback\fR
.RS 4
Callback function to connect to, optional\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.connectWebView(String name, Function callback)\fR
.RS 4
.sp
Connects all webviews to a GObject signal\&.
.PP
\fIname\fR
.RS 4
The event name
.RE
.PP
\fIcallback\fR
.RS 4
A callback function the will be called when the signal is emitted, the arguments of the callback correspond to the GObject callback with the first argument omitted, instead this refers to the object\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.disconnect(Signal|Function object)\fR
.RS 4
.sp
Either a Signal or the callback of a signal If a callback is passed to this function and the same callback is connected multiple times only the first matching callback will be disconnected, to disconnect all matching callbacks call use Signal\&.disconnectAll
.PP
\fIobject\fR
.RS 4
The event name
.RE
.PP
\fIreturns\fR
.RS 4
the disconnected signal
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.disconnectAll(Function callback)\fR
.RS 4
.sp
Disconnect from all signals with matching callback function
.PP
\fIcallback\fR
.RS 4
A callback function
.RE
.PP
\fIreturns\fR
.RS 4
An array of signal that were disconnected
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSignal.emit(String name, \&...)\fR
.RS 4
.sp
Emits a signal, can be used to implement custom signals\&.
.PP
\fIname\fR
.RS 4
The name of the event
.RE
.PP
\fI\&...\fR
.RS 4
Variable number of arguments passed to the callback function of Signal\&.connect\&.
.RE
.PP
\fIreturns\fR
.RS 4
The overall return value of all callback function, if one callback function returns true the overall return value will be true
.RE
.RE
.SH "ENUM OBJECTS"
.sp
Enum objects are objects that have only readonly properties, mapping gtk/webkit enums to javascript objects\&.
.SS "ButtonContext"
.sp
.if n \{\
.RS 4
.\}
.nf
const ButtonContext = {
  document   : 1 << 1,
  link       : 1 << 2,
  image      : 1 << 3,
  media      : 1 << 4,
  selection  : 1 << 5,
  editable   : 1 << 6
};
.fi
.if n \{\
.RE
.\}
.SS "ChecksumType"
.sp
.if n \{\
.RS 4
.\}
.nf
const ChecksumType = {
  md5     : 0,
  sha1    : 1,
  sha256  : 2
};
.fi
.if n \{\
.RE
.\}
.SS "ClickType"
.sp
.if n \{\
.RS 4
.\}
.nf
const ClickType = {
  click       : 4,
  doubleClick : 5,
  tripleClick : 6
};
.fi
.if n \{\
.RE
.\}
.SS "DownloadStatus"
.sp
.if n \{\
.RS 4
.\}
.nf
const DownloadStatus = {
  error       : \-1,
  created     : 0,
  started     : 1,
  cancelled   : 2,
  finished    : 3
};
.fi
.if n \{\
.RE
.\}
.SS "FileTest"
.sp
.if n \{\
.RS 4
.\}
.nf
const FileTest = {
  regular    : 1 << 0,
  symlink    : 1 << 1,
  dir        : 1 << 2,
  executable : 1 << 3,
  exists     : 1 << 4
};
.fi
.if n \{\
.RE
.\}
.SS "LoadStatus"
.sp
.if n \{\
.RS 4
.\}
.nf
const LoadStatus = {
  provisional       : 0,
  committed         : 1,
  finished          : 2,
  firstVisualLayout : 3,
  failed            : 4
};
.fi
.if n \{\
.RE
.\}
.SS "Modifier"
.sp
.if n \{\
.RS 4
.\}
.nf
const Modifier = {
  Shift     : 1 << 0,
  Lock      : 1 << 1,
  Control   : 1 << 2,
  Mod1      : 1 << 3,
  Mod2      : 1 << 4,
  Mod3      : 1 << 5,
  Mod4      : 1 << 6,
  Mod5      : 1 << 7,
  Button1   : 1 << 8,
  Button2   : 1 << 9,
  Button3   : 1 << 10,
  Button4   : 1 << 11,
  Button5   : 1 << 12,
  Super     : 1 << 26,
  Hyper     : 1 << 27,
  Meta      : 1 << 28,
  Release   : 1 << 30,
  Modifier  : 0x5c001fff
};
.fi
.if n \{\
.RE
.\}
.SS "NavigationReason"
.sp
.if n \{\
.RS 4
.\}
.nf
const NavigationReason = {
  linkClicked     : 0,
  formSubmitted   : 1,
  backForward     : 2,
  reload          : 3,
  formResubmitted : 4,
  other           : 5
};
.fi
.if n \{\
.RE
.\}
.SS "Modes"
.sp
.if n \{\
.RS 4
.\}
.nf
const Modes = {
  NormalMode  : 1<<0,
  InsertMode  : 1<<1,
  CommandMode : 1<<2
  HintMode : 1<<2
};
.fi
.if n \{\
.RE
.\}
.SS "Selection"
.sp
.if n \{\
.RS 4
.\}
.nf
const Selection = {
  primary   : 1,
  clipboard : 2
};
.fi
.if n \{\
.RE
.\}
.SH "GLOBAL DATA"
.sp
Since all scripts share the same execution context, they are encapsulated in a function\&. To avoid conflicts with other scripts it is not allowed to set properties on the global object, i\&.e\&.
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

// not allowed, the global object is readonly
number = 0;
io\&.print(number);     // undefined

var number2 = 0;
io\&.print(number2);    // 0

// not allowed
foo = function()
{
  io\&.print("foo");
}
foo();  // fails
.fi
.if n \{\
.RE
.\}
.sp
For sharing data between scripts either signals or modules can be created\&.
.SS "script and this"
.sp
In every script the variable \fBscript\fR refers to \fBthis\fR, the encapsulating function, it has the following properties and methods:
.PP
\fIscript\&.path (Object, read)\fR
.RS 4
The path of the script\&.
.RE
.PP
\fIscript\&._arguments (Object, read)\fR
.RS 4

\fBarguments\fR
object of the encapsulating function
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid script.debug(Object params)\fR
.RS 4
.sp
Same as io\&.debug but also prints additional information, e\&.g\&. if the object is an Error, this method will also print the corresponding source of the error\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBString script.generateId()\fR
.RS 4
.sp
Generates a unique id\&.
.PP
\fIreturns\fR
.RS 4
A unique id\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid script.getPrivate(Object object, String key)\fR
.RS 4
.sp
Gets a private property of an object previously set with \fBscript\&.setPrivate\fR
.PP
\fIobject\fR
.RS 4
The object on which the value was set\&.
.RE
.PP
\fIkey\fR
.RS 4
The property name
.RE
.PP
\fIreturns\fR
.RS 4
The private value
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid script.setPrivate(Object object, String key, String value)\fR
.RS 4
.sp
Convenience function to set a private property on an object that doesn\(cqt conflict with properties set in other scripts, it uses a random unique id to set the property, so the property can most likely be only retrieved with \fBscript\&.getPrivate\fR\&. This is mostly useful for objects derived from GObject since GObjects are shared between all scripts\&.
.PP
\fIobject\fR
.RS 4
The object on which the value should be set\&.
.RE
.PP
\fIkey\fR
.RS 4
The property name
.RE
.PP
\fIvalue\fR
.RS 4
The value to set\&.
.RE
.RE
.SH "MODULES"
.sp
With modules it is possible to share objects between scripts\&. Modules are defined with provide and loaded with require\&.
.PP
\fBDefining modules\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

provide("myModule", {
  foo : 37,
  doBar : function() {
    io\&.print("bar");
  }
});
provide("myOtherModule", {
  act : function (arg) {
    io\&.print(arg);
  }
});
.fi
.if n \{\
.RE
.\}
.PP
\fBGetting some modules\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

require(["myModule", "myOtherModule"], function(myModule, myOtherModule) {
  if (myModule\&.foo == 37)
    myModule\&.doBar();

  myOtherModule\&.act("foo");
});
.fi
.if n \{\
.RE
.\}
.PP
\fBGetting all modules\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

require(null, function(modules) {
  if (modules\&.myModule\&.foo == 37)
    modules\&.myModule\&.doBar();

  modules\&.myOtherModule\&.act("foo");
});
.fi
.if n \{\
.RE
.\}
.sp
It is also possible to specify a path in the name array\&. The name then follows the format \fBname!path\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

require(["foo!/path/to/foo"], function(foo) {
  io\&.print(foo\&.bar); // 37
});
.fi
.if n \{\
.RE
.\}
.PP
\fB/path/to/foo\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
provide("foo", { bar : 37 });
.fi
.if n \{\
.RE
.\}
.sp
The resolution chain is as follows, first all modules defined with \fBprovide\fR and module names requested by \fBrequire\fR are stored\&. If all scripts have been loaded the requirements are resolved\&. If a requirement contains a path and the module isn\(cqt defined yet the module will be loaded, if it is already defined the path is ignored and the stored module will be resolved:
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

require(["foo!/path/to/foo"], function(foo) {
  io\&.print(foo\&.bar); // 42
});
provide("foo", { bar : 42 });
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

require(["foo"], function(foo) {
  io\&.print(foo); // undefined
});
require(["foo!/path/to/foo"]);

require(["foo"], function(foo) {
  io\&.print(foo); // { bar : 37 }
});
.fi
.if n \{\
.RE
.\}
.SH "EXTENSIONS"
.sp
\fBdwb\fR provides the possibility to load extensions\&. It is recommended to implement javascript\-userscripts as an extension to have consistent configuration locations for scripts\&. One advantage of extension also is that they can be loaded/unloaded on the fly\&.
.SS "Prepackaged extensions"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBformfiller\fR
.RS 4
.sp
An extension that gets form data and fills forms with previously saved data\&.
.PP
\fBConfiguration options\fR
.RS 4
.PP
\fIformData\fR
.RS 4
A path to a file where formdata will be saved, the default path is
\fB$XDG_CONFIG_HOME/dwb/forms\fR
.RE
.PP
\fIscGetForm\fR
.RS 4
Shortcut that gets and saves form data, the default value is
\fBefg\fR
.RE
.PP
\fIscFillForm\fR
.RS 4
Shortcut that fills a form, the default value is
\fBeff\fR
.RE
.PP
\fIuseGPG\fR
.RS 4
Whether to use gpg2 to encrypt the formData file with a password\&.
.RE
.PP
\fIGPGOptEncrypt\fR
.RS 4
Additional options that will be passed to gpg2 for encryption, the default gpg2 options are: \-\-passphrase <password> \-\-batch \-\-no\-tty \-\-yes \-c \-\-output <formData> default value:
\fB""\fR
.RE
.PP
\fIGPGOptDecrypt\fR
.RS 4
Additional options that will be passed to gpg2 for decryption, the default gpg2 options are \-\-passphrase <password> \-\-batch \-\-no\-tty \-\-yes \-d <formData> default value:
\fB""\fR
.RE
.PP
\fIkeepPassword\fR
.RS 4
Whether to save the gpg password in memory, if set to false the user will be prompted for the password every time a form is filled or new data is saved, default value:
\fBtrue\fR
.RE
.PP
\fIkeepFormdata\fR
.RS 4
If useGPG is enabled and this value is set to true the complete formdata will be kept in memory, if set to false gpg2 will be called every time a form is filled, default value:
\fBfalse\fR
.RE
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBperdomainsettings\fR
.RS 4
.sp
An extension that can be used for per\-domain\-settings\&. Valid settings are the properties of WebKitWebSettings but in camelcase, see http://webkitgtk\&.org/reference/webkitgtk/unstable/WebKitWebSettings\&.html for details\&.
.PP
\fBConfiguration options\fR
.RS 4
.PP
\fIdomains\fR
.RS 4
Settings applied based on the effective second level domain
.RE
.PP
\fIhosts\fR
.RS 4
Settings applied based on host name, this option is an object of the format
.RE
.PP
\fIuris\fR
.RS 4
Settings applied based on the uri, this option is an object of the format
.RE
.PP
\fIdefaults\fR
.RS 4
Default settings, for each setting in domains, hosts and uris a default\-value should be specified
.RE
.RE
.PP
\fBExample configuration\fR
.RS 4
Example using extensions\&.load:
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
extensions\&.load("perdomainsettings", {
  domains : {
     "example\&.com" : {
          "enablePlugins"  : true
     },
     "example\&.uk\&.com" :  {
          "enablePlugins"  : true,
          "enableScripts"  : false
     }
  },
  hosts : {
     "www\&.example1\&.com" :  {
          "autoLoadImages" : true
     }
  },
  uris : {
     "http://www\&.example2\&.com/login\&.php" :  {
          "autoLoadImages" : false
     }
  },
  defaults : {
     "enablePlugins"   : false,
     "autoLoadImages"  : false,
     "enableScripts"   :  true
  }
});
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBrequestpolicy\fR
.RS 4
.sp
Extension that blocks requests from thirdparty domains with whitelisting support, either permanently or just for the session\&. It is also possible to block requests from certain domains on all sites, they have highest precedence and will also be blocked on sites where thirdparty requests are allowed in general\&.
.PP
\fBConfiguration options\fR
.RS 4
.PP
\fIshortcut\fR
.RS 4
Shortcut to block / allow requests, default
\fB"erp"\fR
.RE
.PP
\fIunblockCurrent\fR
.RS 4
Shortcut to unblock always blocked requests, shows only domains from the current site, default
\fB"erC"\fR
.RE
.PP
\fIunblockAll\fR
.RS 4
Shortcut to unblock always blocked requests, shows all blocked domains, default
\fB"erA"\fR
.RE
.PP
\fIwhiteList\fR
.RS 4
A path to the whitelisting file, default is
\fB$XDG_CONFIG_HOME/dwb/<profile>/requestpolicy\&.json\fR
.RE
.PP
\fIautoreload\fR
.RS 4
Whether to automatically reload the website after the persistentList has changed, default
\fBfalse\fR
.RE
.PP
\fInotify\fR
.RS 4
Whether to notify about blocked request, default
\fBfalse\fR
.RE
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBunique_tabs\fR
.RS 4
.sp
Extension that allows to remove duplicate tabs or avoids duplicate tabs automatically\&.
.PP
\fBConfiguration options\fR
.RS 4
.PP
\fIshortcutRemoveDuplicates\fR
.RS 4
Shortcut that removes duplicate tabs, default
\fBnull\fR
.RE
.PP
\fIcommandRemoveDuplicates\fR
.RS 4
Command that remove s duplicate tabs, default
\fBut_remove_duplicates\fR
.RE
.PP
\fIautoFocus\fR
.RS 4
Autofocus a tab if an url is already opened, if the url would be loaded in a new tab the new tab is closed\&. Setting this to true makes commandRemoveDuplicates and shortcutRemoveDuplicates obsolete because there will be no duplicate tabs\&. Default value:
\fBtrue\fR
.RE
.PP
\fIshortcutToggleAutoFocus\fR
.RS 4
Shortcut that enables/disables autofocus, default
\fBnull\fR
.RE
.PP
\fIcommandToggleAutoFocus\fR
.RS 4
Command that enables/disables autofocus, default
\fBut_toggle_autofocus\fR
.RE
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBuserscripts\fR
.RS 4
.sp
Extension that loads userscripts and injects them into websites, this extension is mostly greasemonkey compatible\&. Scripts can be loaded by either passing an array of paths to extensions\&.load or by putting scripts into $XDG_CONFIG_HOME/dwb/scripts/\&.
.PP
\fBConfiguration options\fR
.RS 4
The only configuration option is an array of paths to scripts
.RE
.PP
\fBExample configuration\fR
.RS 4
Example using extensions\&.load:
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
extensions\&.load("userscripts", [ "/path/to/script1", "/path/to/script2" ]);
.fi
.if n \{\
.RE
.\}
.RE
.SS "Using extensions"
.sp
Extensions can be loaded by an userscript
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

extensions\&.load("extension_1");
extensions\&.load("extension_2", {
  configProp_1 : 22,
  configProp_2 : "val2"
});
.fi
.if n \{\
.RE
.\}
.sp
To load/unload extensions on the fly \fBextensions\&.bind\fR can be used:
.sp
.if n \{\
.RS 4
.\}
.nf
#!javascript

var myConfig = {
  prop_1 : 37,
  prop_2 : true,
  prop_3 : "foo"
};


extensions\&.bind("myExtension", "Control m", {
  command : "toggleMyExtension",
  config : myConfig,
  load : false
});

extensions\&.bind("mySecondExtension", "Control M");
.fi
.if n \{\
.RE
.\}
.sp
The default searchpaths for extensions are $XDG_DATA_HOME/dwb/extensions/ and /usr/share/dwb/extensions/\&.
.SS "Methods"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.bind(String name, String shortcut, [Object options])\fR
.RS 4
.sp
Bind an extension to a shortcut, the shortcut enables/disables the extension\&.
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fIshortcut\fR
.RS 4
Name of the extension
.RE
.PP
\fIoptions\fR
.RS 4
An optional object with options where possible options are
.PP
options\&.load
.RS 4
Whether to load the extension on startup, default true
.RE
.PP
options\&.config
.RS 4
Config passed to extensions\&.load
.RE
.PP
options\&.command
.RS 4
Command that can be used on command line
.RE
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.disableAll()\fR
.RS 4
.sp
Disables all extensions\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.error(String name, String message)\fR
.RS 4
.sp
Print a consistent error message to stderr
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fImessage\fR
.RS 4
The message
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean extensions.load(String name, [Object config])\fR
.RS 4
.sp
Loads an extension
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fIconfig\fR
.RS 4
The config for the script, if omitted the config is read from $XDG_CONFIG_HOME/dwb/extensionrc, optional
.RE
.PP
\fIreturns\fR
.RS 4
True if the extension was loaded
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean extensions.toggle(String name, [Object config])\fR
.RS 4
.sp
Toggles an extension
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fIconfig\fR
.RS 4
The config for the extension\&. optional
.RE
.PP
\fIreturns\fR
.RS 4
True if the extension was loaded, false if it was unloaded\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBoolean extensions.unload(String name)\fR
.RS 4
.sp
Unloads an extension
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fIreturns\fR
.RS 4
True if the extension was unloaded
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.error(String name, String message|Error e, [String message])\fR
.RS 4
.sp
Print an error message and call stack to stderr\&.
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fImessage|e\fR
.RS 4
The error message or an Error
.RE
.PP
\fImessage\fR
.RS 4
If the second parameter is an Error, an optional message can be specified\&.
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.message(String name, String message)\fR
.RS 4
.sp
Print a consistent message to stdout
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fImessage\fR
.RS 4
The message
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBvoid extensions.warning(String name, String message)\fR
.RS 4
.sp
Print a consistent warning to stderr
.PP
\fIname\fR
.RS 4
Name of the extension
.RE
.PP
\fImessage\fR
.RS 4
The warning message
.RE
.RE
.SS "Writing extensions"
.sp
The default searchpath for extensions is \fB$XDG_DATA_HOME/dwb/extensions\fR and \fBSHARE_DIR/dwb/extensions\fR where SHARE_DIR being the share directory of the installation, most likely /usr/share\&.
.sp
The configuration for extensions is in \fB$XDG_CONFIG_HOME/dwb/extensionrc\fR and should return a javascript object\&.
.sp
Every extension must implement one function named init that takes one argument, the config for the extension\&. The function should return true if the extension was successfully loaded, false otherwise\&. Every extension also may implement a function end that will be called when an extension is unloaded\&. If an extension registers to signals and binds shortcuts the extension should unregister all signals and unbind all shortcuts in this function\&. init and end should be returned from the extension\&.
.sp
Additionally the returned object can also have a \fIdefaultConfig\fR\-property and an \fIexports\fR\-property\&. \fIdefaultConfig\fR will be mixed into the config before calling the init function and \fIexports\fR can be used to define a public api that can be loaded as a module with \fBrequire\fR\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExample\fR
.RS 4
.sp
A extension called \fBfoobar\fR in \fB$HOME/\&.local/share/dwb/extensions/foobar\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
function foo(val) {
  \&.\&.\&.\&.
}
function bar(val) {
  \&.\&.\&.\&.
}
function loadStatusCallback(w) {
  \&.\&.\&.
}
var myExtension = {
  defaultConfig : { foo : 37 },
  exports : {
    foo : foo,
    bar : bar
  },
  init : function (config) {
    if (config\&.foo > 36) {
      bar(config\&.foo);
      foo(config\&.bar);
      bind("XX", bar, "dobar");
      Signal\&.connect("loadStatus", loadStatusCallback);
      return true;
    }

    return false;
  },

  end : function () {
    unbind("dobar");
    Signal\&.disconnect(loadStatusCallback);
    return true;
  }
};
return myExtension;
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExample extensionrc\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
return {
  foobar : { bar : "X", foo : 37 }, // config for extension foobar
  barfoo : {  }                     // config for extension barfoo

};
.fi
.if n \{\
.RE
.\}
.RE
.SH "SEE ALSO"
.sp
\fBdwb\fR(1) \fBdwbem\fR(1)