summaryrefslogtreecommitdiff
path: root/doc/dwb-js.7
diff options
context:
space:
mode:
authorportix <none@none>2013-03-04 12:37:52 +0100
committerportix <none@none>2013-03-04 12:37:52 +0100
commitad996d9cf4e143b17feeee9e4d43542169a7091b (patch)
tree6941305d4da9463a4e39ddddb586f86645d776c6 /doc/dwb-js.7
parent69cc2ce8bff1f3d8bdac9977230d18e6c31bfc57 (diff)
downloaddwb-ad996d9cf4e143b17feeee9e4d43542169a7091b.zip
Use _initNewContext to initialize scripts, change setPrivate/getPrivate api
Diffstat (limited to 'doc/dwb-js.7')
-rw-r--r--doc/dwb-js.7108
1 files changed, 54 insertions, 54 deletions
diff --git a/doc/dwb-js.7 b/doc/dwb-js.7
index c110c786..f61b36be 100644
--- a/doc/dwb-js.7
+++ b/doc/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.78.0 <http://docbook.sf.net/>
-.\" Date: 03/02/2013
+.\" Date: 03/04/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DWB\-JS" "7" "03/02/2013" "\ \&" "\ \&"
+.TH "DWB\-JS" "7" "03/04/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -1745,58 +1745,6 @@ The signal id of the signal\&.
.nr an-break-flag 1
.br
.ps +1
-\fBObject GObject.getPrivate(String key, Object identifier)\fR
-.RS 4
-.sp
-Gets a value previously set with GObject\&.setPrivate\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
-.PP
-\fIidentifier\fR
-.RS 4
-The identifier passed to setPrivate
-.RE
-.PP
-\fIreturns\fR
-.RS 4
-The object set with setPrivate or null\&.
-.RE
-.RE
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBvoid GObject.setPrivate(String key, String value, Object identifier)\fR
-.RS 4
-.sp
-Associates a private value with an object that can only be retrieved in the calling script\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
-.PP
-\fIvalue\fR
-.RS 4
-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
-.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
@@ -3552,6 +3500,58 @@ The path of the script\&.
.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
+\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
+Sets a private property on an object, 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\&.