Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html

eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.JavaScript.ExternalJsObject</h1> 23 <h1>eric6.WebBrowser.JavaScript.ExternalJsObject</h1>
24
23 <p> 25 <p>
24 Module implementing the JavaScript external object being the endpoint of 26 Module implementing the JavaScript external object being the endpoint of
25 a web channel. 27 a web channel.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
32 <table> 35
36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#ExternalJsObject">ExternalJsObject</a></td> 39 <td><a href="#ExternalJsObject">ExternalJsObject</a></td>
35 <td>Class implementing the endpoint of our web channel.</td> 40 <td>Class implementing the endpoint of our web channel.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
44
39 <table> 45 <table>
40 <tr><td>None</td></tr> 46 <tr><td>None</td></tr>
41 </table> 47 </table>
42 <hr /><hr /> 48 <hr />
49 <hr />
43 <a NAME="ExternalJsObject" ID="ExternalJsObject"></a> 50 <a NAME="ExternalJsObject" ID="ExternalJsObject"></a>
44 <h2>ExternalJsObject</h2> 51 <h2>ExternalJsObject</h2>
52
45 <p> 53 <p>
46 Class implementing the endpoint of our web channel. 54 Class implementing the endpoint of our web channel.
47 </p> 55 </p>
48 <h3>Derived from</h3> 56 <h3>Derived from</h3>
49 QObject 57 QObject
50 <h3>Class Attributes</h3> 58 <h3>Class Attributes</h3>
59
51 <table> 60 <table>
52 <tr><td>extraObjects</td></tr> 61 <tr><td>extraObjects</td></tr>
53 </table> 62 </table>
54 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
55 <table> 64
65 <table>
66
56 <tr> 67 <tr>
57 <td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td> 68 <td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td>
58 <td>Class method to register extra JavaScript objects.</td> 69 <td>Class method to register extra JavaScript objects.</td>
59 </tr><tr> 70 </tr>
71 <tr>
60 <td><a href="#ExternalJsObject.setupWebChannel">setupWebChannel</a></td> 72 <td><a href="#ExternalJsObject.setupWebChannel">setupWebChannel</a></td>
61 <td>Class method to setup the web channel.</td> 73 <td>Class method to setup the web channel.</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td> 76 <td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td>
64 <td>Class method to unregister extra JavaScript objects.</td> 77 <td>Class method to unregister extra JavaScript objects.</td>
65 </tr> 78 </tr>
66 </table> 79 </table>
67 <h3>Methods</h3> 80 <h3>Methods</h3>
68 <table> 81
82 <table>
83
69 <tr> 84 <tr>
70 <td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td> 85 <td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td>
71 <td>Constructor</td> 86 <td>Constructor</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#ExternalJsObject.page">page</a></td> 89 <td><a href="#ExternalJsObject.page">page</a></td>
74 <td>Public method returning a reference to the web page object.</td> 90 <td>Public method returning a reference to the web page object.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#ExternalJsObject.passwordManager">passwordManager</a></td> 93 <td><a href="#ExternalJsObject.passwordManager">passwordManager</a></td>
77 <td>Public method to get a reference to the password manager JavaScript object.</td> 94 <td>Public method to get a reference to the password manager JavaScript object.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#ExternalJsObject.speedDial">speedDial</a></td> 97 <td><a href="#ExternalJsObject.speedDial">speedDial</a></td>
80 <td>Public method returning a reference to a speed dial object.</td> 98 <td>Public method returning a reference to a speed dial object.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#ExternalJsObject.startPage">startPage</a></td> 101 <td><a href="#ExternalJsObject.startPage">startPage</a></td>
83 <td>Public method to get a reference to the start page JavaScript object.</td> 102 <td>Public method to get a reference to the start page JavaScript object.</td>
84 </tr> 103 </tr>
85 </table> 104 </table>
86 <h3>Static Methods</h3> 105 <h3>Static Methods</h3>
106
87 <table> 107 <table>
88 <tr><td>None</td></tr> 108 <tr><td>None</td></tr>
89 </table> 109 </table>
110
90 <a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a> 111 <a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a>
91 <h4>ExternalJsObject.registerExtraObject (class method)</h4> 112 <h4>ExternalJsObject.registerExtraObject (class method)</h4>
92 <b>registerExtraObject</b>(<i>name, jsObject</i>) 113 <b>registerExtraObject</b>(<i>name, jsObject</i>)
114
93 <p> 115 <p>
94 Class method to register extra JavaScript objects. 116 Class method to register extra JavaScript objects.
95 </p><dl> 117 </p>
118 <dl>
119
96 <dt><i>name</i> (str)</dt> 120 <dt><i>name</i> (str)</dt>
97 <dd> 121 <dd>
98 name for the object 122 name for the object
99 </dd><dt><i>jsObject</i> (QObject)</dt> 123 </dd>
124 <dt><i>jsObject</i> (QObject)</dt>
100 <dd> 125 <dd>
101 reference to the JavaScript object to be registered 126 reference to the JavaScript object to be registered
102 </dd> 127 </dd>
103 </dl><a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a> 128 </dl>
129 <a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a>
104 <h4>ExternalJsObject.setupWebChannel (class method)</h4> 130 <h4>ExternalJsObject.setupWebChannel (class method)</h4>
105 <b>setupWebChannel</b>(<i>channel, page</i>) 131 <b>setupWebChannel</b>(<i>channel, page</i>)
132
106 <p> 133 <p>
107 Class method to setup the web channel. 134 Class method to setup the web channel.
108 </p><dl> 135 </p>
136 <dl>
137
109 <dt><i>channel</i> (QWebChannel)</dt> 138 <dt><i>channel</i> (QWebChannel)</dt>
110 <dd> 139 <dd>
111 reference to the channel 140 reference to the channel
112 </dd><dt><i>page</i> (QWebEnginePage)</dt> 141 </dd>
142 <dt><i>page</i> (QWebEnginePage)</dt>
113 <dd> 143 <dd>
114 reference to the web page 144 reference to the web page
115 </dd> 145 </dd>
116 </dl><a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a> 146 </dl>
147 <a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a>
117 <h4>ExternalJsObject.unregisterExtraObject (class method)</h4> 148 <h4>ExternalJsObject.unregisterExtraObject (class method)</h4>
118 <b>unregisterExtraObject</b>(<i>name</i>) 149 <b>unregisterExtraObject</b>(<i>name</i>)
150
119 <p> 151 <p>
120 Class method to unregister extra JavaScript objects. 152 Class method to unregister extra JavaScript objects.
121 </p><dl> 153 </p>
154 <dl>
155
122 <dt><i>name</i> (str)</dt> 156 <dt><i>name</i> (str)</dt>
123 <dd> 157 <dd>
124 name of the object 158 name of the object
125 </dd> 159 </dd>
126 </dl><a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a> 160 </dl>
161 <a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a>
127 <h4>ExternalJsObject (Constructor)</h4> 162 <h4>ExternalJsObject (Constructor)</h4>
128 <b>ExternalJsObject</b>(<i>page</i>) 163 <b>ExternalJsObject</b>(<i>page</i>)
164
129 <p> 165 <p>
130 Constructor 166 Constructor
131 </p><dl> 167 </p>
168 <dl>
169
132 <dt><i>page</i> (WebBrowserPage)</dt> 170 <dt><i>page</i> (WebBrowserPage)</dt>
133 <dd> 171 <dd>
134 reference to the web page object 172 reference to the web page object
135 </dd> 173 </dd>
136 </dl><a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a> 174 </dl>
175 <a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a>
137 <h4>ExternalJsObject.page</h4> 176 <h4>ExternalJsObject.page</h4>
138 <b>page</b>(<i></i>) 177 <b>page</b>(<i></i>)
178
139 <p> 179 <p>
140 Public method returning a reference to the web page object. 180 Public method returning a reference to the web page object.
141 </p><dl> 181 </p>
182 <dl>
142 <dt>Returns:</dt> 183 <dt>Returns:</dt>
143 <dd> 184 <dd>
144 reference to the web page object 185 reference to the web page object
145 </dd> 186 </dd>
146 </dl><dl> 187 </dl>
188 <dl>
147 <dt>Return Type:</dt> 189 <dt>Return Type:</dt>
148 <dd> 190 <dd>
149 WebBrowserPage 191 WebBrowserPage
150 </dd> 192 </dd>
151 </dl><a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a> 193 </dl>
194 <a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a>
152 <h4>ExternalJsObject.passwordManager</h4> 195 <h4>ExternalJsObject.passwordManager</h4>
153 <b>passwordManager</b>(<i></i>) 196 <b>passwordManager</b>(<i></i>)
197
154 <p> 198 <p>
155 Public method to get a reference to the password manager JavaScript 199 Public method to get a reference to the password manager JavaScript
156 object. 200 object.
157 </p><dl> 201 </p>
202 <dl>
158 <dt>Returns:</dt> 203 <dt>Returns:</dt>
159 <dd> 204 <dd>
160 reference to the password manager JavaScript object 205 reference to the password manager JavaScript object
161 </dd> 206 </dd>
162 </dl><dl> 207 </dl>
208 <dl>
163 <dt>Return Type:</dt> 209 <dt>Return Type:</dt>
164 <dd> 210 <dd>
165 StartPageJsObject 211 StartPageJsObject
166 </dd> 212 </dd>
167 </dl><a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a> 213 </dl>
214 <a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a>
168 <h4>ExternalJsObject.speedDial</h4> 215 <h4>ExternalJsObject.speedDial</h4>
169 <b>speedDial</b>(<i></i>) 216 <b>speedDial</b>(<i></i>)
217
170 <p> 218 <p>
171 Public method returning a reference to a speed dial object. 219 Public method returning a reference to a speed dial object.
172 </p><dl> 220 </p>
221 <dl>
173 <dt>Returns:</dt> 222 <dt>Returns:</dt>
174 <dd> 223 <dd>
175 reference to a speed dial object 224 reference to a speed dial object
176 </dd> 225 </dd>
177 </dl><dl> 226 </dl>
227 <dl>
178 <dt>Return Type:</dt> 228 <dt>Return Type:</dt>
179 <dd> 229 <dd>
180 SpeedDial 230 SpeedDial
181 </dd> 231 </dd>
182 </dl><a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a> 232 </dl>
233 <a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a>
183 <h4>ExternalJsObject.startPage</h4> 234 <h4>ExternalJsObject.startPage</h4>
184 <b>startPage</b>(<i></i>) 235 <b>startPage</b>(<i></i>)
236
185 <p> 237 <p>
186 Public method to get a reference to the start page JavaScript object. 238 Public method to get a reference to the start page JavaScript object.
187 </p><dl> 239 </p>
240 <dl>
188 <dt>Returns:</dt> 241 <dt>Returns:</dt>
189 <dd> 242 <dd>
190 reference to the start page JavaScript object 243 reference to the start page JavaScript object
191 </dd> 244 </dd>
192 </dl><dl> 245 </dl>
246 <dl>
193 <dt>Return Type:</dt> 247 <dt>Return Type:</dt>
194 <dd> 248 <dd>
195 StartPageJsObject 249 StartPageJsObject
196 </dd> 250 </dd>
197 </dl> 251 </dl>

Mercurial Repository: eric

eric ide

mercurial