Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Navigation.NavigationBar.html
src/eric7/Documentation/Source/eric7.WebBrowser.Navigation.NavigationBar.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Navigation.NavigationBar</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.Navigation.NavigationBar</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the navigation bar widget. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#NavigationBar">NavigationBar</a></td> | |
| 25 <td>Class implementing the navigation bar.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="NavigationBar" ID="NavigationBar"></a> | |
| 36 <h2>NavigationBar</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the navigation bar. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QWidget | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#NavigationBar.__init__">NavigationBar</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#NavigationBar.__clearHistory">__clearHistory</a></td> | |
| 63 <td>Private slot to clear the history of the current web browser tab.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#NavigationBar.__contextMenuRequested">__contextMenuRequested</a></td> | |
| 67 <td>Private method to handle a context menu request.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#NavigationBar.__goBack">__goBack</a></td> | |
| 71 <td>Private slot called to handle the backward button.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#NavigationBar.__goBackInNewTab">__goBackInNewTab</a></td> | |
| 75 <td>Private slot handling a middle click or Ctrl left click of the backward button.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#NavigationBar.__goForward">__goForward</a></td> | |
| 79 <td>Private slot called to handle the forward button.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#NavigationBar.__goForwardInNewTab">__goForwardInNewTab</a></td> | |
| 83 <td>Private slot handling a middle click or Ctrl left click of the forward button.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#NavigationBar.__goHome">__goHome</a></td> | |
| 87 <td>Private slot called to handle the home button.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#NavigationBar.__goHomeInNewTab">__goHomeInNewTab</a></td> | |
| 91 <td>Private slot handling a middle click or Ctrl left click of the home button.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#NavigationBar.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td> | |
| 95 <td>Private slot to go to the selected page.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#NavigationBar.__reload">__reload</a></td> | |
| 99 <td>Private slot called to handle the reload button.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#NavigationBar.__showBackMenu">__showBackMenu</a></td> | |
| 103 <td>Private slot showing the backwards navigation menu.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#NavigationBar.__showForwardMenu">__showForwardMenu</a></td> | |
| 107 <td>Private slot showing the forwards navigation menu.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#NavigationBar.__stopLoad">__stopLoad</a></td> | |
| 111 <td>Private slot called to handle loading of the current page.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#NavigationBar.backButton">backButton</a></td> | |
| 115 <td>Public method to get a reference to the back button.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#NavigationBar.exitFullScreenButton">exitFullScreenButton</a></td> | |
| 119 <td>Public method to get a reference to the exit full screen button.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#NavigationBar.forwardButton">forwardButton</a></td> | |
| 123 <td>Public method to get a reference to the forward button.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#NavigationBar.reloadStopButton">reloadStopButton</a></td> | |
| 127 <td>Public method to get a reference to the reload/stop button.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#NavigationBar.searchEdit">searchEdit</a></td> | |
| 131 <td>Public method to get a reference to the web search edit.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td> | |
| 135 <td>Public method to get a reference to the super menu button.</td> | |
| 136 </tr> | |
| 137 </table> | |
| 138 <h3>Static Methods</h3> | |
| 139 | |
| 140 <table> | |
| 141 <tr><td>None</td></tr> | |
| 142 </table> | |
| 143 | |
| 144 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a> | |
| 145 <h4>NavigationBar (Constructor)</h4> | |
| 146 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>) | |
| 147 | |
| 148 <p> | |
| 149 Constructor | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>mainWindow</i> (WebBrowserWindow)</dt> | |
| 154 <dd> | |
| 155 reference to the browser main window | |
| 156 </dd> | |
| 157 <dt><i>parent</i> (QWidget)</dt> | |
| 158 <dd> | |
| 159 reference to the parent widget | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a> | |
| 163 <h4>NavigationBar.__clearHistory</h4> | |
| 164 <b>__clearHistory</b>(<i></i>) | |
| 165 | |
| 166 <p> | |
| 167 Private slot to clear the history of the current web browser tab. | |
| 168 </p> | |
| 169 <a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a> | |
| 170 <h4>NavigationBar.__contextMenuRequested</h4> | |
| 171 <b>__contextMenuRequested</b>(<i>pos</i>) | |
| 172 | |
| 173 <p> | |
| 174 Private method to handle a context menu request. | |
| 175 </p> | |
| 176 <dl> | |
| 177 | |
| 178 <dt><i>pos</i> (QPoint)</dt> | |
| 179 <dd> | |
| 180 position of the request | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a> | |
| 184 <h4>NavigationBar.__goBack</h4> | |
| 185 <b>__goBack</b>(<i></i>) | |
| 186 | |
| 187 <p> | |
| 188 Private slot called to handle the backward button. | |
| 189 </p> | |
| 190 <a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a> | |
| 191 <h4>NavigationBar.__goBackInNewTab</h4> | |
| 192 <b>__goBackInNewTab</b>(<i></i>) | |
| 193 | |
| 194 <p> | |
| 195 Private slot handling a middle click or Ctrl left click of the | |
| 196 backward button. | |
| 197 </p> | |
| 198 <a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a> | |
| 199 <h4>NavigationBar.__goForward</h4> | |
| 200 <b>__goForward</b>(<i></i>) | |
| 201 | |
| 202 <p> | |
| 203 Private slot called to handle the forward button. | |
| 204 </p> | |
| 205 <a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a> | |
| 206 <h4>NavigationBar.__goForwardInNewTab</h4> | |
| 207 <b>__goForwardInNewTab</b>(<i></i>) | |
| 208 | |
| 209 <p> | |
| 210 Private slot handling a middle click or Ctrl left click of the | |
| 211 forward button. | |
| 212 </p> | |
| 213 <a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a> | |
| 214 <h4>NavigationBar.__goHome</h4> | |
| 215 <b>__goHome</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Private slot called to handle the home button. | |
| 219 </p> | |
| 220 <a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a> | |
| 221 <h4>NavigationBar.__goHomeInNewTab</h4> | |
| 222 <b>__goHomeInNewTab</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Private slot handling a middle click or Ctrl left click of the | |
| 226 home button. | |
| 227 </p> | |
| 228 <a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a> | |
| 229 <h4>NavigationBar.__navigationMenuActionTriggered</h4> | |
| 230 <b>__navigationMenuActionTriggered</b>(<i>act</i>) | |
| 231 | |
| 232 <p> | |
| 233 Private slot to go to the selected page. | |
| 234 </p> | |
| 235 <dl> | |
| 236 | |
| 237 <dt><i>act</i></dt> | |
| 238 <dd> | |
| 239 reference to the action selected in the navigation menu | |
| 240 (QAction) | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a> | |
| 244 <h4>NavigationBar.__reload</h4> | |
| 245 <b>__reload</b>(<i></i>) | |
| 246 | |
| 247 <p> | |
| 248 Private slot called to handle the reload button. | |
| 249 </p> | |
| 250 <a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a> | |
| 251 <h4>NavigationBar.__showBackMenu</h4> | |
| 252 <b>__showBackMenu</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Private slot showing the backwards navigation menu. | |
| 256 </p> | |
| 257 <a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a> | |
| 258 <h4>NavigationBar.__showForwardMenu</h4> | |
| 259 <b>__showForwardMenu</b>(<i></i>) | |
| 260 | |
| 261 <p> | |
| 262 Private slot showing the forwards navigation menu. | |
| 263 </p> | |
| 264 <a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a> | |
| 265 <h4>NavigationBar.__stopLoad</h4> | |
| 266 <b>__stopLoad</b>(<i></i>) | |
| 267 | |
| 268 <p> | |
| 269 Private slot called to handle loading of the current page. | |
| 270 </p> | |
| 271 <a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a> | |
| 272 <h4>NavigationBar.backButton</h4> | |
| 273 <b>backButton</b>(<i></i>) | |
| 274 | |
| 275 <p> | |
| 276 Public method to get a reference to the back button. | |
| 277 </p> | |
| 278 <dl> | |
| 279 <dt>Return:</dt> | |
| 280 <dd> | |
| 281 reference to the back button | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <dl> | |
| 285 <dt>Return Type:</dt> | |
| 286 <dd> | |
| 287 QToolButton | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a> | |
| 291 <h4>NavigationBar.exitFullScreenButton</h4> | |
| 292 <b>exitFullScreenButton</b>(<i></i>) | |
| 293 | |
| 294 <p> | |
| 295 Public method to get a reference to the exit full screen button. | |
| 296 </p> | |
| 297 <dl> | |
| 298 <dt>Return:</dt> | |
| 299 <dd> | |
| 300 reference to the exit full screen button | |
| 301 </dd> | |
| 302 </dl> | |
| 303 <dl> | |
| 304 <dt>Return Type:</dt> | |
| 305 <dd> | |
| 306 QToolButton | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a> | |
| 310 <h4>NavigationBar.forwardButton</h4> | |
| 311 <b>forwardButton</b>(<i></i>) | |
| 312 | |
| 313 <p> | |
| 314 Public method to get a reference to the forward button. | |
| 315 </p> | |
| 316 <dl> | |
| 317 <dt>Return:</dt> | |
| 318 <dd> | |
| 319 reference to the forward button | |
| 320 </dd> | |
| 321 </dl> | |
| 322 <dl> | |
| 323 <dt>Return Type:</dt> | |
| 324 <dd> | |
| 325 QToolButton | |
| 326 </dd> | |
| 327 </dl> | |
| 328 <a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a> | |
| 329 <h4>NavigationBar.reloadStopButton</h4> | |
| 330 <b>reloadStopButton</b>(<i></i>) | |
| 331 | |
| 332 <p> | |
| 333 Public method to get a reference to the reload/stop button. | |
| 334 </p> | |
| 335 <dl> | |
| 336 <dt>Return:</dt> | |
| 337 <dd> | |
| 338 reference to the reload/stop button | |
| 339 </dd> | |
| 340 </dl> | |
| 341 <dl> | |
| 342 <dt>Return Type:</dt> | |
| 343 <dd> | |
| 344 QToolButton | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a> | |
| 348 <h4>NavigationBar.searchEdit</h4> | |
| 349 <b>searchEdit</b>(<i></i>) | |
| 350 | |
| 351 <p> | |
| 352 Public method to get a reference to the web search edit. | |
| 353 </p> | |
| 354 <dl> | |
| 355 <dt>Return:</dt> | |
| 356 <dd> | |
| 357 reference to the web search edit | |
| 358 </dd> | |
| 359 </dl> | |
| 360 <dl> | |
| 361 <dt>Return Type:</dt> | |
| 362 <dd> | |
| 363 WebBrowserWebSearchWidget | |
| 364 </dd> | |
| 365 </dl> | |
| 366 <a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a> | |
| 367 <h4>NavigationBar.superMenuButton</h4> | |
| 368 <b>superMenuButton</b>(<i></i>) | |
| 369 | |
| 370 <p> | |
| 371 Public method to get a reference to the super menu button. | |
| 372 </p> | |
| 373 <dl> | |
| 374 <dt>Return:</dt> | |
| 375 <dd> | |
| 376 reference to the super menu button | |
| 377 </dd> | |
| 378 </dl> | |
| 379 <dl> | |
| 380 <dt>Return Type:</dt> | |
| 381 <dd> | |
| 382 QToolButton | |
| 383 </dd> | |
| 384 </dl> | |
| 385 <div align="right"><a href="#top">Up</a></div> | |
| 386 <hr /> | |
| 387 </body></html> |
