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