summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorportix <portix@gmx.net>2012-11-03 15:07:16 +0100
committerportix <portix@gmx.net>2012-11-03 15:07:16 +0100
commit835ab2029dc3aef9de29a0346fa83d7966d82ad2 (patch)
tree617feb30fdb9d05529b541e3150005435c858224 /api
parent99bd0954de2c7ba1d0598ac62a6d537a84e28461 (diff)
parentd4f59982568390a2993d47f4361552bbc57c196b (diff)
downloaddwb-835ab2029dc3aef9de29a0346fa83d7966d82ad2.zip
Merging http://bitbucket.ort/portix/dwb into default
Diffstat (limited to 'api')
-rw-r--r--api/dwb-js.764
-rw-r--r--api/jsapi.7.txt42
-rw-r--r--api/jsapi.txt72
3 files changed, 99 insertions, 79 deletions
diff --git a/api/dwb-js.7 b/api/dwb-js.7
index b02f651f..c208d932 100644
--- a/api/dwb-js.7
+++ b/api/dwb-js.7
@@ -980,24 +980,19 @@ The object forEach is called on
.nr an-break-flag 1
.br
.ps +1
-\fBvoid Object.setPrivate(String key, String value, Object identifier)\fR
+\fBNumber Array.fastIndexOf(Object object)\fR
.RS 4
.sp
-Associates a private value with that object that can only be retrieved in the calling script, this function is only useful for objects derived from GObjects, e\&.g\&. to associate a value with a webview and keep it invisible in other scripts\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
+This method is basically the same as Array\&.indexOf but without type checking\&.
.PP
-\fIvalue\fR
+\fIobject\fR
.RS 4
-The property value
+The object to search for
.RE
.PP
-\fIidentifier\fR
+\fIreturns\fR
.RS 4
-A local object to identify the calling script, the identifier must either be of type Object or of type Function\&.
+The index in the array or \-1 if the Object wasn\(cqt found\&.
.RE
.RE
.sp
@@ -1006,24 +1001,19 @@ A local object to identify the calling script, the identifier must either be of
.nr an-break-flag 1
.br
.ps +1
-\fBObject Object.getPrivate(String key, Object identifier)\fR
+\fBNumber Array.fastLastIndexOf(Object object)\fR
.RS 4
.sp
-Gets a value previously set with Object\&.setPrivate\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
+This method is basically the same as Array\&.lastIndexOf but without type checking\&.
.PP
-\fIidentifier\fR
+\fIobject\fR
.RS 4
-The identifier passed to setPrivate
+The object to search for
.RE
.PP
\fIreturns\fR
.RS 4
-The object set with setPrivate or null\&.
+The index in the array or \-1 if the Object wasn\(cqt found\&.
.RE
.RE
.sp
@@ -1032,19 +1022,24 @@ The object set with setPrivate or null\&.
.nr an-break-flag 1
.br
.ps +1
-\fBNumber Array.fastIndexOf(Object object)\fR
+\fBObject Object.getPrivate(String key, Object identifier)\fR
.RS 4
.sp
-This method is basically the same as Array\&.indexOf but without type checking\&.
+Gets a value previously set with Object\&.setPrivate\&.
.PP
-\fIobject\fR
+\fIkey\fR
.RS 4
-The object to search for
+The property name
+.RE
+.PP
+\fIidentifier\fR
+.RS 4
+The identifier passed to setPrivate
.RE
.PP
\fIreturns\fR
.RS 4
-The index in the array or \-1 if the Object wasn\(cqt found\&.
+The object set with setPrivate or null\&.
.RE
.RE
.sp
@@ -1053,19 +1048,24 @@ The index in the array or \-1 if the Object wasn\(cqt found\&.
.nr an-break-flag 1
.br
.ps +1
-\fBNumber Array.fastLastIndexOf(Object object)\fR
+\fBvoid Object.setPrivate(String key, String value, Object identifier)\fR
.RS 4
.sp
-This method is basically the same as Array\&.lastIndexOf but without type checking\&.
+Associates a private value with that object that can only be retrieved in the calling script, this function is only useful for objects derived from GObjects, e\&.g\&. to associate a value with a webview and keep it invisible in other scripts\&.
.PP
-\fIobject\fR
+\fIkey\fR
.RS 4
-The object to search for
+The property name
.RE
.PP
-\fIreturns\fR
+\fIvalue\fR
.RS 4
-The index in the array or \-1 if the Object wasn\(cqt found\&.
+The property value
+.RE
+.PP
+\fIidentifier\fR
+.RS 4
+A local object to identify the calling script, the identifier must either be of type Object or of type Function\&.
.RE
.RE
.SH "WEBKIT OBJECTS"
diff --git a/api/jsapi.7.txt b/api/jsapi.7.txt
index 63390a90..1f6eff2d 100644
--- a/api/jsapi.7.txt
+++ b/api/jsapi.7.txt
@@ -443,17 +443,22 @@ _value_;; The property value
_this_;; The object forEach is called on
****
-==== void Object.setPrivate(String key, String value, Object identifier)
+==== Number Array.fastIndexOf(Object object)
****
-Associates a private value with that object that can only be retrieved in the
-calling script, this function is only useful for objects derived from GObjects,
-e.g. to associate a value with a webview and keep it invisible in other scripts.
+This method is basically the same as Array.indexOf but without type checking.
-_key_;; The property name
-_value_;; The property value
-_identifier_;; A local object to identify the calling script, the identifier
-must either be of type Object or of type Function.
+_object_;; The object to search for
+_returns_;; The index in the array or -1 if the Object wasn't found.
+****
+
+==== Number Array.fastLastIndexOf(Object object)
+****
+
+This method is basically the same as Array.lastIndexOf but without type checking.
+
+_object_;; The object to search for
+_returns_;; The index in the array or -1 if the Object wasn't found.
****
==== Object Object.getPrivate(String key, Object identifier)
@@ -466,26 +471,23 @@ _identifier_;; The identifier passed to setPrivate
_returns_;; The object set with setPrivate or null.
****
-==== Number Array.fastIndexOf(Object object)
-****
-
-This method is basically the same as Array.indexOf but without type checking.
-_object_;; The object to search for
-_returns_;; The index in the array or -1 if the Object wasn't found.
-****
-
-==== Number Array.fastLastIndexOf(Object object)
+==== void Object.setPrivate(String key, String value, Object identifier)
****
-This method is basically the same as Array.lastIndexOf but without type checking.
+Associates a private value with that object that can only be retrieved in the
+calling script, this function is only useful for objects derived from GObjects,
+e.g. to associate a value with a webview and keep it invisible in other scripts.
-_object_;; The object to search for
-_returns_;; The index in the array or -1 if the Object wasn't found.
+_key_;; The property name
+_value_;; The property value
+_identifier_;; A local object to identify the calling script, the identifier
+must either be of type Object or of type Function.
****
+
== WEBKIT OBJECTS ==
All webkit objects correspond to gobject objects, i.e. they have the same
diff --git a/api/jsapi.txt b/api/jsapi.txt
index cc16f43e..d411c0d3 100644
--- a/api/jsapi.txt
+++ b/api/jsapi.txt
@@ -825,24 +825,37 @@ _this_;; The object forEach is called on
****
****
-[[setPrivate]]
+[[fastIndexOf]]
[float]
-==== *Object.setPrivate()* ====
+==== *Array.fastIndexOf()* ====
[source,javascript]
----
-void Object.setPrivate(key, value, identifier)
+Number Array.fastIndexOf(Object object)
----
-Associates a private value with that object that can only be retrieved in the
-calling script, this function is only useful for objects derived from GObjects,
-e.g. to associate a value with a webview and keep it invisible in other scripts.
+This method is basically the same as +Array.indexOf+ but without type checking.
::
-_key_;; The property name
-_value_;; The property value
-_identifier_;; A local object to identify the calling script, the identifier
-must either be of type object or of type function.
+_object_;; The object to search for
+_returns_;; The index in the array or +-1+ if the Object wasn't found.
+****
+
+****
+[[fastLastIndexOf]]
+[float]
+==== *Array.fastLastIndexOf()* ====
+[source,javascript]
+----
+Number Array.fastLastIndexOf(Object object)
+----
+
+This method is basically the same as +Array.lastIndexOf+ but without type checking.
+
+ ::
+
+_object_;; The object to search for
+_returns_;; The index in the array or +-1+ if the Object wasn't found.
****
****
@@ -864,38 +877,43 @@ _returns_;; The object set with <<setPrivate>> or +null+.
****
****
-[[fastIndexOf]]
+[[setPrivate]]
[float]
-==== *Array.fastIndexOf()* ====
+==== *Object.setPrivate()* ====
[source,javascript]
----
-Number Array.fastIndexOf(Object object)
+void Object.setPrivate(key, value, identifier)
----
-This method is basically the same as +Array.indexOf+ but without type checking.
+Associates a private value with that object that can only be retrieved in the
+calling script, this function is only useful for objects derived from GObjects,
+e.g. to associate a value with a webview and keep it invisible in other scripts.
::
-_object_;; The object to search for
-_returns_;; The index in the array or +-1+ if the Object wasn't found.
+_key_;; The property name
+_value_;; The property value
+_identifier_;; A local object to identify the calling script, the identifier
+must either be of type object or of type function.
****
-****
-[[fastLastIndexOf]]
+====
[float]
-==== *Array.fastLastIndexOf()* ====
+==== *Example* ====
[source,javascript]
-----
-Number Array.fastLastIndexOf(Object object)
-----
+------------
+var self = this;
+signals.connect("loadCommitted", function(wv) {
+ wv.setPrivate("foo", "bar", self);
+});
+signals.connect("loadFinished", function(wv) {
+ io.print(wv.getPrivate("foo", self));
+});
+------------
+====
-This method is basically the same as +Array.lastIndexOf+ but without type checking.
- ::
-_object_;; The object to search for
-_returns_;; The index in the array or +-1+ if the Object wasn't found.
-****
[[Webkitobjects]]
== Webkit objects ==