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