src/eric7/Documentation/Source/eric7.WebBrowser.JavaScript.ExternalJsObject.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.JavaScript.ExternalJsObject</h1> 9 <h1>eric7.WebBrowser.JavaScript.ExternalJsObject</h1>
10
11 <p> 10 <p>
12 Module implementing the JavaScript external object being the endpoint of 11 Module implementing the JavaScript external object being the endpoint of
13 a web channel. 12 a web channel.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#ExternalJsObject">ExternalJsObject</a></td> 23 <td><a href="#ExternalJsObject">ExternalJsObject</a></td>
26 <td>Class implementing the endpoint of our web channel.</td> 24 <td>Class implementing the endpoint of our web channel.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="ExternalJsObject" ID="ExternalJsObject"></a> 35 <a NAME="ExternalJsObject" ID="ExternalJsObject"></a>
37 <h2>ExternalJsObject</h2> 36 <h2>ExternalJsObject</h2>
38
39 <p> 37 <p>
40 Class implementing the endpoint of our web channel. 38 Class implementing the endpoint of our web channel.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QObject 42 QObject
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45
46 <table> 44 <table>
47 <tr><td>extraObjects</td></tr> 45 <tr><td>extraObjects</td></tr>
48 </table> 46 </table>
47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table>
52
53 <tr> 50 <tr>
54 <td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td> 51 <td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td>
55 <td>Class method to register extra JavaScript objects.</td> 52 <td>Class method to register extra JavaScript objects.</td>
56 </tr> 53 </tr>
57 <tr> 54 <tr>
61 <tr> 58 <tr>
62 <td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td> 59 <td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td>
63 <td>Class method to unregister extra JavaScript objects.</td> 60 <td>Class method to unregister extra JavaScript objects.</td>
64 </tr> 61 </tr>
65 </table> 62 </table>
63
66 <h3>Methods</h3> 64 <h3>Methods</h3>
67 65 <table>
68 <table>
69
70 <tr> 66 <tr>
71 <td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td> 67 <td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td>
72 <td>Constructor</td> 68 <td>Constructor</td>
73 </tr> 69 </tr>
74 <tr> 70 <tr>
86 <tr> 82 <tr>
87 <td><a href="#ExternalJsObject.startPage">startPage</a></td> 83 <td><a href="#ExternalJsObject.startPage">startPage</a></td>
88 <td>Public method to get a reference to the start page JavaScript object.</td> 84 <td>Public method to get a reference to the start page JavaScript object.</td>
89 </tr> 85 </tr>
90 </table> 86 </table>
87
91 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
92
93 <table> 89 <table>
94 <tr><td>None</td></tr> 90 <tr><td>None</td></tr>
95 </table> 91 </table>
92
96 93
97 <a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a> 94 <a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a>
98 <h4>ExternalJsObject.registerExtraObject (class method)</h4> 95 <h4>ExternalJsObject.registerExtraObject (class method)</h4>
99 <b>registerExtraObject</b>(<i>name, jsObject</i>) 96 <b>registerExtraObject</b>(<i>name, jsObject</i>)
100
101 <p> 97 <p>
102 Class method to register extra JavaScript objects. 98 Class method to register extra JavaScript objects.
103 </p> 99 </p>
100
104 <dl> 101 <dl>
105 102
106 <dt><i>name</i> (str)</dt> 103 <dt><i>name</i> (str)</dt>
107 <dd> 104 <dd>
108 name for the object 105 name for the object
113 </dd> 110 </dd>
114 </dl> 111 </dl>
115 <a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a> 112 <a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a>
116 <h4>ExternalJsObject.setupWebChannel (class method)</h4> 113 <h4>ExternalJsObject.setupWebChannel (class method)</h4>
117 <b>setupWebChannel</b>(<i>channel, page</i>) 114 <b>setupWebChannel</b>(<i>channel, page</i>)
118
119 <p> 115 <p>
120 Class method to setup the web channel. 116 Class method to setup the web channel.
121 </p> 117 </p>
118
122 <dl> 119 <dl>
123 120
124 <dt><i>channel</i> (QWebChannel)</dt> 121 <dt><i>channel</i> (QWebChannel)</dt>
125 <dd> 122 <dd>
126 reference to the channel 123 reference to the channel
131 </dd> 128 </dd>
132 </dl> 129 </dl>
133 <a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a> 130 <a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a>
134 <h4>ExternalJsObject.unregisterExtraObject (class method)</h4> 131 <h4>ExternalJsObject.unregisterExtraObject (class method)</h4>
135 <b>unregisterExtraObject</b>(<i>name</i>) 132 <b>unregisterExtraObject</b>(<i>name</i>)
136
137 <p> 133 <p>
138 Class method to unregister extra JavaScript objects. 134 Class method to unregister extra JavaScript objects.
139 </p> 135 </p>
136
140 <dl> 137 <dl>
141 138
142 <dt><i>name</i> (str)</dt> 139 <dt><i>name</i> (str)</dt>
143 <dd> 140 <dd>
144 name of the object 141 name of the object
145 </dd> 142 </dd>
146 </dl> 143 </dl>
147 <a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a> 144 <a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a>
148 <h4>ExternalJsObject (Constructor)</h4> 145 <h4>ExternalJsObject (Constructor)</h4>
149 <b>ExternalJsObject</b>(<i>page</i>) 146 <b>ExternalJsObject</b>(<i>page</i>)
150
151 <p> 147 <p>
152 Constructor 148 Constructor
153 </p> 149 </p>
150
154 <dl> 151 <dl>
155 152
156 <dt><i>page</i> (WebBrowserPage)</dt> 153 <dt><i>page</i> (WebBrowserPage)</dt>
157 <dd> 154 <dd>
158 reference to the web page object 155 reference to the web page object
159 </dd> 156 </dd>
160 </dl> 157 </dl>
161 <a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a> 158 <a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a>
162 <h4>ExternalJsObject.page</h4> 159 <h4>ExternalJsObject.page</h4>
163 <b>page</b>(<i></i>) 160 <b>page</b>(<i></i>)
164
165 <p> 161 <p>
166 Public method returning a reference to the web page object. 162 Public method returning a reference to the web page object.
167 </p> 163 </p>
164
168 <dl> 165 <dl>
169 <dt>Return:</dt> 166 <dt>Return:</dt>
170 <dd> 167 <dd>
171 reference to the web page object 168 reference to the web page object
172 </dd> 169 </dd>
178 </dd> 175 </dd>
179 </dl> 176 </dl>
180 <a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a> 177 <a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a>
181 <h4>ExternalJsObject.passwordManager</h4> 178 <h4>ExternalJsObject.passwordManager</h4>
182 <b>passwordManager</b>(<i></i>) 179 <b>passwordManager</b>(<i></i>)
183
184 <p> 180 <p>
185 Public method to get a reference to the password manager JavaScript 181 Public method to get a reference to the password manager JavaScript
186 object. 182 object.
187 </p> 183 </p>
184
188 <dl> 185 <dl>
189 <dt>Return:</dt> 186 <dt>Return:</dt>
190 <dd> 187 <dd>
191 reference to the password manager JavaScript object 188 reference to the password manager JavaScript object
192 </dd> 189 </dd>
198 </dd> 195 </dd>
199 </dl> 196 </dl>
200 <a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a> 197 <a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a>
201 <h4>ExternalJsObject.speedDial</h4> 198 <h4>ExternalJsObject.speedDial</h4>
202 <b>speedDial</b>(<i></i>) 199 <b>speedDial</b>(<i></i>)
203
204 <p> 200 <p>
205 Public method returning a reference to a speed dial object. 201 Public method returning a reference to a speed dial object.
206 </p> 202 </p>
203
207 <dl> 204 <dl>
208 <dt>Return:</dt> 205 <dt>Return:</dt>
209 <dd> 206 <dd>
210 reference to a speed dial object 207 reference to a speed dial object
211 </dd> 208 </dd>
217 </dd> 214 </dd>
218 </dl> 215 </dl>
219 <a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a> 216 <a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a>
220 <h4>ExternalJsObject.startPage</h4> 217 <h4>ExternalJsObject.startPage</h4>
221 <b>startPage</b>(<i></i>) 218 <b>startPage</b>(<i></i>)
222
223 <p> 219 <p>
224 Public method to get a reference to the start page JavaScript object. 220 Public method to get a reference to the start page JavaScript object.
225 </p> 221 </p>
222
226 <dl> 223 <dl>
227 <dt>Return:</dt> 224 <dt>Return:</dt>
228 <dd> 225 <dd>
229 reference to the start page JavaScript object 226 reference to the start page JavaScript object
230 </dd> 227 </dd>

eric ide

mercurial