Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html
eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html
- changeset 6942
- 2602857055c5
- parent 6153
- 0b18c86c03a1
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.JavaScript.ExternalJsObject</h1> | |
| 23 <p> | |
| 24 Module implementing the JavaScript external object being the endpoint of | |
| 25 a web channel. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#ExternalJsObject">ExternalJsObject</a></td> | |
| 35 <td>Class implementing the endpoint of our web channel.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="ExternalJsObject" ID="ExternalJsObject"></a> | |
| 44 <h2>ExternalJsObject</h2> | |
| 45 <p> | |
| 46 Class implementing the endpoint of our web channel. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>extraObjects</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td> | |
| 58 <td>Class method to register extra JavaScript objects.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ExternalJsObject.setupWebChannel">setupWebChannel</a></td> | |
| 61 <td>Class method to setup the web channel.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td> | |
| 64 <td>Class method to unregister extra JavaScript objects.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 <table> | |
| 69 <tr> | |
| 70 <td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#ExternalJsObject.page">page</a></td> | |
| 74 <td>Public method returning a reference to the web page object.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#ExternalJsObject.passwordManager">passwordManager</a></td> | |
| 77 <td>Public method to get a reference to the password manager JavaScript object.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#ExternalJsObject.speedDial">speedDial</a></td> | |
| 80 <td>Public method returning a reference to a speed dial object.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#ExternalJsObject.startPage">startPage</a></td> | |
| 83 <td>Public method to get a reference to the start page JavaScript object.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 <table> | |
| 88 <tr><td>None</td></tr> | |
| 89 </table> | |
| 90 <a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a> | |
| 91 <h4>ExternalJsObject.registerExtraObject (class method)</h4> | |
| 92 <b>registerExtraObject</b>(<i>name, jsObject</i>) | |
| 93 <p> | |
| 94 Class method to register extra JavaScript objects. | |
| 95 </p><dl> | |
| 96 <dt><i>name</i> (str)</dt> | |
| 97 <dd> | |
| 98 name for the object | |
| 99 </dd><dt><i>jsObject</i> (QObject)</dt> | |
| 100 <dd> | |
| 101 reference to the JavaScript object to be registered | |
| 102 </dd> | |
| 103 </dl><a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a> | |
| 104 <h4>ExternalJsObject.setupWebChannel (class method)</h4> | |
| 105 <b>setupWebChannel</b>(<i>channel, page</i>) | |
| 106 <p> | |
| 107 Class method to setup the web channel. | |
| 108 </p><dl> | |
| 109 <dt><i>channel</i> (QWebChannel)</dt> | |
| 110 <dd> | |
| 111 reference to the channel | |
| 112 </dd><dt><i>page</i> (QWebEnginePage)</dt> | |
| 113 <dd> | |
| 114 reference to the web page | |
| 115 </dd> | |
| 116 </dl><a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a> | |
| 117 <h4>ExternalJsObject.unregisterExtraObject (class method)</h4> | |
| 118 <b>unregisterExtraObject</b>(<i>name</i>) | |
| 119 <p> | |
| 120 Class method to unregister extra JavaScript objects. | |
| 121 </p><dl> | |
| 122 <dt><i>name</i> (str)</dt> | |
| 123 <dd> | |
| 124 name of the object | |
| 125 </dd> | |
| 126 </dl><a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a> | |
| 127 <h4>ExternalJsObject (Constructor)</h4> | |
| 128 <b>ExternalJsObject</b>(<i>page</i>) | |
| 129 <p> | |
| 130 Constructor | |
| 131 </p><dl> | |
| 132 <dt><i>page</i> (WebBrowserPage)</dt> | |
| 133 <dd> | |
| 134 reference to the web page object | |
| 135 </dd> | |
| 136 </dl><a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a> | |
| 137 <h4>ExternalJsObject.page</h4> | |
| 138 <b>page</b>(<i></i>) | |
| 139 <p> | |
| 140 Public method returning a reference to the web page object. | |
| 141 </p><dl> | |
| 142 <dt>Returns:</dt> | |
| 143 <dd> | |
| 144 reference to the web page object | |
| 145 </dd> | |
| 146 </dl><dl> | |
| 147 <dt>Return Type:</dt> | |
| 148 <dd> | |
| 149 WebBrowserPage | |
| 150 </dd> | |
| 151 </dl><a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a> | |
| 152 <h4>ExternalJsObject.passwordManager</h4> | |
| 153 <b>passwordManager</b>(<i></i>) | |
| 154 <p> | |
| 155 Public method to get a reference to the password manager JavaScript | |
| 156 object. | |
| 157 </p><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 reference to the password manager JavaScript object | |
| 161 </dd> | |
| 162 </dl><dl> | |
| 163 <dt>Return Type:</dt> | |
| 164 <dd> | |
| 165 StartPageJsObject | |
| 166 </dd> | |
| 167 </dl><a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a> | |
| 168 <h4>ExternalJsObject.speedDial</h4> | |
| 169 <b>speedDial</b>(<i></i>) | |
| 170 <p> | |
| 171 Public method returning a reference to a speed dial object. | |
| 172 </p><dl> | |
| 173 <dt>Returns:</dt> | |
| 174 <dd> | |
| 175 reference to a speed dial object | |
| 176 </dd> | |
| 177 </dl><dl> | |
| 178 <dt>Return Type:</dt> | |
| 179 <dd> | |
| 180 SpeedDial | |
| 181 </dd> | |
| 182 </dl><a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a> | |
| 183 <h4>ExternalJsObject.startPage</h4> | |
| 184 <b>startPage</b>(<i></i>) | |
| 185 <p> | |
| 186 Public method to get a reference to the start page JavaScript object. | |
| 187 </p><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 reference to the start page JavaScript object | |
| 191 </dd> | |
| 192 </dl><dl> | |
| 193 <dt>Return Type:</dt> | |
| 194 <dd> | |
| 195 StartPageJsObject | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <div align="right"><a href="#top">Up</a></div> | |
| 199 <hr /> | |
| 200 </body></html> |
