summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
Diffstat (limited to 'api')
-rw-r--r--api/dwb-js.747
-rw-r--r--api/jsapi.7.txt17
-rw-r--r--api/jsapi.txt35
3 files changed, 92 insertions, 7 deletions
diff --git a/api/dwb-js.7 b/api/dwb-js.7
index 8964b910..5e0e6959 100644
--- a/api/dwb-js.7
+++ b/api/dwb-js.7
@@ -2,12 +2,12 @@
.\" Title: dwb-js
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
-.\" Date: 01/17/2013
+.\" Date: 01/28/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DWB\-JS" "7" "01/17/2013" "\ \&" "\ \&"
+.TH "DWB\-JS" "7" "01/28/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -90,6 +90,11 @@ for details\&.
.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
@@ -457,7 +462,7 @@ Either the function or the optional name passed to bind\&.
.PP
\fIreturns\fR
.RS 4
-true if the function is unbinded
+true if the function was unbound
.RE
.RE
.SH "GLOBAL OBJECTS"
@@ -2456,6 +2461,42 @@ The Download
.nr an-break-flag 1
.br
.ps +1
+\fBexecuteCommand\fR
+.RS 4
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+signals\&.connect("executeCommand", function(detail));
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Emitted before a command is executed, return true to prevent the execution\&.
+.PP
+\fIdetail\&.command\fR
+.RS 4
+The command that is executed\&.
+.RE
+.PP
+\fIdetail\&.argument\fR
+.RS 4
+The command that is executed\&.
+.RE
+.PP
+\fIdetail\&.nummod\fR
+.RS 4
+The numerical modifier, will be \-1 if no numerical modifier was used\&.
+.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
diff --git a/api/jsapi.7.txt b/api/jsapi.7.txt
index ec361e4d..8a0dce57 100644
--- a/api/jsapi.7.txt
+++ b/api/jsapi.7.txt
@@ -45,6 +45,7 @@ properties on the global object, see also *Global data* for details.
=== Properties
_global (Object, read)_;; Refers to the global object
+_session (SoupSession, read)_;; The webkit session
=== Methods ===
@@ -228,7 +229,7 @@ _returns_;; true if the timer was stopped
Unbind a shortcut that was previously binded with bind
_func_ or _name_;; Either the function or the optional name passed to bind.
-_returns_;; true if the function is unbinded
+_returns_;; true if the function was unbound
****
@@ -413,7 +414,6 @@ _n_;; Number of the tab
_returns_;; The corresponding webview
****
-
=== util ===
The util object implements helper methods.
@@ -1223,6 +1223,19 @@ Emitted when the DownloadStatus changes.
_download_;; The Download
****
+==== executeCommand
+****
+----
+signals.connect("executeCommand", function(detail));
+----
+
+Emitted before a command is executed, return true to prevent the execution.
+
+_detail.command_;; The command that is executed.
+_detail.argument_;; The command that is executed.
+_detail.nummod_;; The numerical modifier, will be -1 if no numerical modifier
+was used.
+****
==== frameCreated
****
diff --git a/api/jsapi.txt b/api/jsapi.txt
index efe43ff3..cefefed5 100644
--- a/api/jsapi.txt
+++ b/api/jsapi.txt
@@ -52,6 +52,18 @@ global object read
Refers to the global object.
****
+****
+[float]
+==== *session* ====
+
+[source,javascript]
+----
+session SoupSession read
+----
+
+The webkit session.
+****
+
=== Methods ===
@@ -312,7 +324,7 @@ Unbind a shortcut that was previously binded with <<bind>>
::
_func_ or _name_;; Either the function or the optional name passed to <<bind>>.
-_returns_;; +true+ if the function is unbinded
+_returns_;; +true+ if the function was unbound
****
======
@@ -758,7 +770,6 @@ _n_;; Number of the tab
_returns_;; The corresponding <<webview>>
****
-
====
.Example
[source,javascript]
@@ -2329,6 +2340,26 @@ Emitted when the <<DownloadStatus>> changes.
_download_;; The <<Download>>
****
+****
+[[executeCommand]]
+[float]
+==== *executeCommand* ====
+
+[source,javascript]
+----
+Boolean callback(detail)
+----
+
+Emitted before a command is executed, return true to prevent the execution.
+
+ ::
+
+_detail.command_;; The command that is executed.
+_detail.argument_;; The command that is executed.
+_detail.nummod_;; The numerical modifier, will be -1 if no numerical modifier
+was used.
+****
+
****
[[frameCreated]]