Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksMenu.html
src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksMenu.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.Bookmarks.BookmarksMenu</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.Bookmarks.BookmarksMenu</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the bookmarks menu. | |
| 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="#BookmarksMenu">BookmarksMenu</a></td> | |
| 25 <td>Class implementing the bookmarks menu base class.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td> | |
| 29 <td>Class implementing a dynamically populated menu for bookmarks.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="BookmarksMenu" ID="BookmarksMenu"></a> | |
| 40 <h2>BookmarksMenu</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the bookmarks menu base class. | |
| 44 </p> | |
| 45 <h3>Signals</h3> | |
| 46 <dl> | |
| 47 | |
| 48 <dt>newTab(QUrl, str)</dt> | |
| 49 <dd> | |
| 50 emitted to open a URL with the given title in a | |
| 51 new tab | |
| 52 </dd> | |
| 53 <dt>newWindow(QUrl, str)</dt> | |
| 54 <dd> | |
| 55 emitted to open a URL with the given title in | |
| 56 a new window | |
| 57 </dd> | |
| 58 <dt>openUrl(QUrl, str)</dt> | |
| 59 <dd> | |
| 60 emitted to open a URL with the given title in | |
| 61 the current tab | |
| 62 </dd> | |
| 63 </dl> | |
| 64 <h3>Derived from</h3> | |
| 65 EricModelMenu | |
| 66 <h3>Class Attributes</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Class Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 <tr><td>None</td></tr> | |
| 75 </table> | |
| 76 <h3>Methods</h3> | |
| 77 | |
| 78 <table> | |
| 79 | |
| 80 <tr> | |
| 81 <td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td> | |
| 82 <td>Constructor</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#BookmarksMenu.__activated">__activated</a></td> | |
| 86 <td>Private slot handling the activated signal.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td> | |
| 90 <td>Private slot to handle the context menu request.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#BookmarksMenu.__edit">__edit</a></td> | |
| 94 <td>Private slot to edit a bookmarks properties.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td> | |
| 98 <td>Private slot to open a bookmark in the current browser tab.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> | |
| 102 <td>Private slot to open a bookmark in a new browser tab.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#BookmarksMenu.__openBookmarkInNewWindow">__openBookmarkInNewWindow</a></td> | |
| 106 <td>Private slot to open a bookmark in a new window.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#BookmarksMenu.__openBookmarkInPrivateWindow">__openBookmarkInPrivateWindow</a></td> | |
| 110 <td>Private slot to open a bookmark in a new private window.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td> | |
| 114 <td>Private slot to remove a bookmark.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#BookmarksMenu.__updateVisitCount">__updateVisitCount</a></td> | |
| 118 <td>Private method to update the visit count of a bookmark.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td> | |
| 122 <td>Public method to get the menu that is used to populate sub menu's.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#BookmarksMenu.openAll">openAll</a></td> | |
| 126 <td>Public slot to open all the menu's items.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td> | |
| 130 <td>Public method to add any actions after the tree.</td> | |
| 131 </tr> | |
| 132 </table> | |
| 133 <h3>Static Methods</h3> | |
| 134 | |
| 135 <table> | |
| 136 <tr><td>None</td></tr> | |
| 137 </table> | |
| 138 | |
| 139 <a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a> | |
| 140 <h4>BookmarksMenu (Constructor)</h4> | |
| 141 <b>BookmarksMenu</b>(<i>parent=None</i>) | |
| 142 | |
| 143 <p> | |
| 144 Constructor | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>parent</i></dt> | |
| 149 <dd> | |
| 150 reference to the parent widget (QWidget) | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <a NAME="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a> | |
| 154 <h4>BookmarksMenu.__activated</h4> | |
| 155 <b>__activated</b>(<i>idx</i>) | |
| 156 | |
| 157 <p> | |
| 158 Private slot handling the activated signal. | |
| 159 </p> | |
| 160 <dl> | |
| 161 | |
| 162 <dt><i>idx</i></dt> | |
| 163 <dd> | |
| 164 index of the activated item (QModelIndex) | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a> | |
| 168 <h4>BookmarksMenu.__contextMenuRequested</h4> | |
| 169 <b>__contextMenuRequested</b>(<i>pos</i>) | |
| 170 | |
| 171 <p> | |
| 172 Private slot to handle the context menu request. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>pos</i></dt> | |
| 177 <dd> | |
| 178 position the context menu shall be shown (QPoint) | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <a NAME="BookmarksMenu.__edit" ID="BookmarksMenu.__edit"></a> | |
| 182 <h4>BookmarksMenu.__edit</h4> | |
| 183 <b>__edit</b>(<i>act</i>) | |
| 184 | |
| 185 <p> | |
| 186 Private slot to edit a bookmarks properties. | |
| 187 </p> | |
| 188 <dl> | |
| 189 | |
| 190 <dt><i>act</i> (QAction)</dt> | |
| 191 <dd> | |
| 192 reference to the triggering action | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a> | |
| 196 <h4>BookmarksMenu.__openBookmark</h4> | |
| 197 <b>__openBookmark</b>(<i>act</i>) | |
| 198 | |
| 199 <p> | |
| 200 Private slot to open a bookmark in the current browser tab. | |
| 201 </p> | |
| 202 <dl> | |
| 203 | |
| 204 <dt><i>act</i> (QAction)</dt> | |
| 205 <dd> | |
| 206 reference to the triggering action | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a> | |
| 210 <h4>BookmarksMenu.__openBookmarkInNewTab</h4> | |
| 211 <b>__openBookmarkInNewTab</b>(<i>act</i>) | |
| 212 | |
| 213 <p> | |
| 214 Private slot to open a bookmark in a new browser tab. | |
| 215 </p> | |
| 216 <dl> | |
| 217 | |
| 218 <dt><i>act</i> (QAction)</dt> | |
| 219 <dd> | |
| 220 reference to the triggering action | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <a NAME="BookmarksMenu.__openBookmarkInNewWindow" ID="BookmarksMenu.__openBookmarkInNewWindow"></a> | |
| 224 <h4>BookmarksMenu.__openBookmarkInNewWindow</h4> | |
| 225 <b>__openBookmarkInNewWindow</b>(<i>act</i>) | |
| 226 | |
| 227 <p> | |
| 228 Private slot to open a bookmark in a new window. | |
| 229 </p> | |
| 230 <dl> | |
| 231 | |
| 232 <dt><i>act</i> (QAction)</dt> | |
| 233 <dd> | |
| 234 reference to the triggering action | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <a NAME="BookmarksMenu.__openBookmarkInPrivateWindow" ID="BookmarksMenu.__openBookmarkInPrivateWindow"></a> | |
| 238 <h4>BookmarksMenu.__openBookmarkInPrivateWindow</h4> | |
| 239 <b>__openBookmarkInPrivateWindow</b>(<i>act</i>) | |
| 240 | |
| 241 <p> | |
| 242 Private slot to open a bookmark in a new private window. | |
| 243 </p> | |
| 244 <dl> | |
| 245 | |
| 246 <dt><i>act</i> (QAction)</dt> | |
| 247 <dd> | |
| 248 reference to the triggering action | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a> | |
| 252 <h4>BookmarksMenu.__removeBookmark</h4> | |
| 253 <b>__removeBookmark</b>(<i>act</i>) | |
| 254 | |
| 255 <p> | |
| 256 Private slot to remove a bookmark. | |
| 257 </p> | |
| 258 <dl> | |
| 259 | |
| 260 <dt><i>act</i> (QAction)</dt> | |
| 261 <dd> | |
| 262 reference to the triggering action | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="BookmarksMenu.__updateVisitCount" ID="BookmarksMenu.__updateVisitCount"></a> | |
| 266 <h4>BookmarksMenu.__updateVisitCount</h4> | |
| 267 <b>__updateVisitCount</b>(<i>idx</i>) | |
| 268 | |
| 269 <p> | |
| 270 Private method to update the visit count of a bookmark. | |
| 271 </p> | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>idx</i></dt> | |
| 275 <dd> | |
| 276 index of the bookmark item (QModelIndex) | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a> | |
| 280 <h4>BookmarksMenu.createBaseMenu</h4> | |
| 281 <b>createBaseMenu</b>(<i></i>) | |
| 282 | |
| 283 <p> | |
| 284 Public method to get the menu that is used to populate sub menu's. | |
| 285 </p> | |
| 286 <dl> | |
| 287 <dt>Return:</dt> | |
| 288 <dd> | |
| 289 reference to the menu (BookmarksMenu) | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="BookmarksMenu.openAll" ID="BookmarksMenu.openAll"></a> | |
| 293 <h4>BookmarksMenu.openAll</h4> | |
| 294 <b>openAll</b>(<i>act</i>) | |
| 295 | |
| 296 <p> | |
| 297 Public slot to open all the menu's items. | |
| 298 </p> | |
| 299 <dl> | |
| 300 | |
| 301 <dt><i>act</i> (QAction)</dt> | |
| 302 <dd> | |
| 303 reference to the action object | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a> | |
| 307 <h4>BookmarksMenu.postPopulated</h4> | |
| 308 <b>postPopulated</b>(<i></i>) | |
| 309 | |
| 310 <p> | |
| 311 Public method to add any actions after the tree. | |
| 312 </p> | |
| 313 <div align="right"><a href="#top">Up</a></div> | |
| 314 <hr /> | |
| 315 <hr /> | |
| 316 <a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a> | |
| 317 <h2>BookmarksMenuBarMenu</h2> | |
| 318 | |
| 319 <p> | |
| 320 Class implementing a dynamically populated menu for bookmarks. | |
| 321 </p> | |
| 322 <h3>Signals</h3> | |
| 323 <dl> | |
| 324 | |
| 325 <dt>openUrl(QUrl, str)</dt> | |
| 326 <dd> | |
| 327 emitted to open a URL with the given title in | |
| 328 the current tab | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <h3>Derived from</h3> | |
| 332 BookmarksMenu | |
| 333 <h3>Class Attributes</h3> | |
| 334 | |
| 335 <table> | |
| 336 <tr><td>None</td></tr> | |
| 337 </table> | |
| 338 <h3>Class Methods</h3> | |
| 339 | |
| 340 <table> | |
| 341 <tr><td>None</td></tr> | |
| 342 </table> | |
| 343 <h3>Methods</h3> | |
| 344 | |
| 345 <table> | |
| 346 | |
| 347 <tr> | |
| 348 <td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td> | |
| 349 <td>Constructor</td> | |
| 350 </tr> | |
| 351 <tr> | |
| 352 <td><a href="#BookmarksMenuBarMenu.__defaultBookmarkTriggered">__defaultBookmarkTriggered</a></td> | |
| 353 <td>Private slot handling the default bookmark menu entries.</td> | |
| 354 </tr> | |
| 355 <tr> | |
| 356 <td><a href="#BookmarksMenuBarMenu.postPopulated">postPopulated</a></td> | |
| 357 <td>Public method to add any actions after the tree.</td> | |
| 358 </tr> | |
| 359 <tr> | |
| 360 <td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td> | |
| 361 <td>Public method to add any actions before the tree.</td> | |
| 362 </tr> | |
| 363 <tr> | |
| 364 <td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td> | |
| 365 <td>Public method to set the list of actions that should appear first in the menu.</td> | |
| 366 </tr> | |
| 367 </table> | |
| 368 <h3>Static Methods</h3> | |
| 369 | |
| 370 <table> | |
| 371 <tr><td>None</td></tr> | |
| 372 </table> | |
| 373 | |
| 374 <a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a> | |
| 375 <h4>BookmarksMenuBarMenu (Constructor)</h4> | |
| 376 <b>BookmarksMenuBarMenu</b>(<i>parent=None</i>) | |
| 377 | |
| 378 <p> | |
| 379 Constructor | |
| 380 </p> | |
| 381 <dl> | |
| 382 | |
| 383 <dt><i>parent</i></dt> | |
| 384 <dd> | |
| 385 reference to the parent widget (QWidget) | |
| 386 </dd> | |
| 387 </dl> | |
| 388 <a NAME="BookmarksMenuBarMenu.__defaultBookmarkTriggered" ID="BookmarksMenuBarMenu.__defaultBookmarkTriggered"></a> | |
| 389 <h4>BookmarksMenuBarMenu.__defaultBookmarkTriggered</h4> | |
| 390 <b>__defaultBookmarkTriggered</b>(<i>act</i>) | |
| 391 | |
| 392 <p> | |
| 393 Private slot handling the default bookmark menu entries. | |
| 394 </p> | |
| 395 <dl> | |
| 396 | |
| 397 <dt><i>act</i> (QAction)</dt> | |
| 398 <dd> | |
| 399 reference to the action object | |
| 400 </dd> | |
| 401 </dl> | |
| 402 <a NAME="BookmarksMenuBarMenu.postPopulated" ID="BookmarksMenuBarMenu.postPopulated"></a> | |
| 403 <h4>BookmarksMenuBarMenu.postPopulated</h4> | |
| 404 <b>postPopulated</b>(<i></i>) | |
| 405 | |
| 406 <p> | |
| 407 Public method to add any actions after the tree. | |
| 408 </p> | |
| 409 <a NAME="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a> | |
| 410 <h4>BookmarksMenuBarMenu.prePopulated</h4> | |
| 411 <b>prePopulated</b>(<i></i>) | |
| 412 | |
| 413 <p> | |
| 414 Public method to add any actions before the tree. | |
| 415 </p> | |
| 416 <dl> | |
| 417 <dt>Return:</dt> | |
| 418 <dd> | |
| 419 flag indicating if any actions were added (boolean) | |
| 420 </dd> | |
| 421 </dl> | |
| 422 <a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a> | |
| 423 <h4>BookmarksMenuBarMenu.setInitialActions</h4> | |
| 424 <b>setInitialActions</b>(<i>actions</i>) | |
| 425 | |
| 426 <p> | |
| 427 Public method to set the list of actions that should appear first in | |
| 428 the menu. | |
| 429 </p> | |
| 430 <dl> | |
| 431 | |
| 432 <dt><i>actions</i></dt> | |
| 433 <dd> | |
| 434 list of initial actions (list of QAction) | |
| 435 </dd> | |
| 436 </dl> | |
| 437 <div align="right"><a href="#top">Up</a></div> | |
| 438 <hr /> | |
| 439 </body></html> |
