Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksWidget.html
src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8905
- 986278234c8a
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.HelpBookmarksWidget</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.HelpViewer.HelpBookmarksWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget showing the list of bookmarks. | |
| 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="#HelpBookmarksWidget">HelpBookmarksWidget</a></td> | |
| 25 <td>Class implementing a widget showing the list of bookmarks.</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="HelpBookmarksWidget" ID="HelpBookmarksWidget"></a> | |
| 36 <h2>HelpBookmarksWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a widget showing the list of bookmarks. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>escapePressed()</dt> | |
| 45 <dd> | |
| 46 emitted when the ESC key was pressed | |
| 47 </dd> | |
| 48 <dt>newBackgroundTab(QUrl, str)</dt> | |
| 49 <dd> | |
| 50 emitted to open an entry in a | |
| 51 new background tab | |
| 52 </dd> | |
| 53 <dt>newTab(QUrl, str)</dt> | |
| 54 <dd> | |
| 55 emitted to open an entry in a new tab | |
| 56 </dd> | |
| 57 <dt>openUrl(QUrl, str)</dt> | |
| 58 <dd> | |
| 59 emitted to open an entry in the current tab | |
| 60 </dd> | |
| 61 </dl> | |
| 62 <h3>Derived from</h3> | |
| 63 QListWidget | |
| 64 <h3>Class Attributes</h3> | |
| 65 | |
| 66 <table> | |
| 67 <tr><td>UrlRole</td></tr> | |
| 68 </table> | |
| 69 <h3>Class Methods</h3> | |
| 70 | |
| 71 <table> | |
| 72 <tr><td>None</td></tr> | |
| 73 </table> | |
| 74 <h3>Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 | |
| 78 <tr> | |
| 79 <td><a href="#HelpBookmarksWidget.__init__">HelpBookmarksWidget</a></td> | |
| 80 <td>Constructor</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#HelpBookmarksWidget.__addBookmark">__addBookmark</a></td> | |
| 84 <td>Private slot to add a bookmark entry.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#HelpBookmarksWidget.__bookmarkActivated">__bookmarkActivated</a></td> | |
| 88 <td>Private slot handling the activation of a bookmark.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HelpBookmarksWidget.__bookmarkCurrentPage">__bookmarkCurrentPage</a></td> | |
| 92 <td>Private slot to bookmark the current page.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HelpBookmarksWidget.__deleteBookmarks">__deleteBookmarks</a></td> | |
| 96 <td>Private method to delete the given bookmark items.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#HelpBookmarksWidget.__editBookmark">__editBookmark</a></td> | |
| 100 <td>Private slot to edit a bookmark.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#HelpBookmarksWidget.__exportBookmarks">__exportBookmarks</a></td> | |
| 104 <td>Private slot to export the bookmarks into a JSON file.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#HelpBookmarksWidget.__importBookmarks">__importBookmarks</a></td> | |
| 108 <td>Private slot to import bookmarks from a JSON file.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#HelpBookmarksWidget.__loadBookmarks">__loadBookmarks</a></td> | |
| 112 <td>Private method to load the defined bookmarks.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#HelpBookmarksWidget.__newBookmark">__newBookmark</a></td> | |
| 116 <td>Private slot to create a new bookmark.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#HelpBookmarksWidget.__openBookmarks">__openBookmarks</a></td> | |
| 120 <td>Private method to open all or selected bookmarks.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#HelpBookmarksWidget.__saveBookmarks">__saveBookmarks</a></td> | |
| 124 <td>Private method to save the defined bookmarks.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#HelpBookmarksWidget.__showBackgroundMenu">__showBackgroundMenu</a></td> | |
| 128 <td>Private slot to show the background menu (i.e.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#HelpBookmarksWidget.__showBookmarkContextMenu">__showBookmarkContextMenu</a></td> | |
| 132 <td>Private slot to show the context menu for a bookmark.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#HelpBookmarksWidget.__showBookmarksContextMenu">__showBookmarksContextMenu</a></td> | |
| 136 <td>Private slot to show the context menu for multiple bookmark.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#HelpBookmarksWidget.__showContextMenu">__showContextMenu</a></td> | |
| 140 <td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#HelpBookmarksWidget.addBookmark">addBookmark</a></td> | |
| 144 <td>Public slot to add a bookmark with given data.</td> | |
| 145 </tr> | |
| 146 </table> | |
| 147 <h3>Static Methods</h3> | |
| 148 | |
| 149 <table> | |
| 150 <tr><td>None</td></tr> | |
| 151 </table> | |
| 152 | |
| 153 <a NAME="HelpBookmarksWidget.__init__" ID="HelpBookmarksWidget.__init__"></a> | |
| 154 <h4>HelpBookmarksWidget (Constructor)</h4> | |
| 155 <b>HelpBookmarksWidget</b>(<i>parent=None</i>) | |
| 156 | |
| 157 <p> | |
| 158 Constructor | |
| 159 </p> | |
| 160 <dl> | |
| 161 | |
| 162 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 163 <dd> | |
| 164 reference to the parent widget (defaults to None) | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="HelpBookmarksWidget.__addBookmark" ID="HelpBookmarksWidget.__addBookmark"></a> | |
| 168 <h4>HelpBookmarksWidget.__addBookmark</h4> | |
| 169 <b>__addBookmark</b>(<i>title, url</i>) | |
| 170 | |
| 171 <p> | |
| 172 Private slot to add a bookmark entry. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>title</i> (str)</dt> | |
| 177 <dd> | |
| 178 title for the bookmark | |
| 179 </dd> | |
| 180 <dt><i>url</i> (str)</dt> | |
| 181 <dd> | |
| 182 URL for the bookmark | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="HelpBookmarksWidget.__bookmarkActivated" ID="HelpBookmarksWidget.__bookmarkActivated"></a> | |
| 186 <h4>HelpBookmarksWidget.__bookmarkActivated</h4> | |
| 187 <b>__bookmarkActivated</b>(<i>itm</i>) | |
| 188 | |
| 189 <p> | |
| 190 Private slot handling the activation of a bookmark. | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>itm</i> (QListWidgetItem)</dt> | |
| 195 <dd> | |
| 196 reference to the activated item | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="HelpBookmarksWidget.__bookmarkCurrentPage" ID="HelpBookmarksWidget.__bookmarkCurrentPage"></a> | |
| 200 <h4>HelpBookmarksWidget.__bookmarkCurrentPage</h4> | |
| 201 <b>__bookmarkCurrentPage</b>(<i></i>) | |
| 202 | |
| 203 <p> | |
| 204 Private slot to bookmark the current page. | |
| 205 </p> | |
| 206 <a NAME="HelpBookmarksWidget.__deleteBookmarks" ID="HelpBookmarksWidget.__deleteBookmarks"></a> | |
| 207 <h4>HelpBookmarksWidget.__deleteBookmarks</h4> | |
| 208 <b>__deleteBookmarks</b>(<i>items</i>) | |
| 209 | |
| 210 <p> | |
| 211 Private method to delete the given bookmark items. | |
| 212 </p> | |
| 213 <dl> | |
| 214 | |
| 215 <dt><i>items</i> (list of QListWidgetItem)</dt> | |
| 216 <dd> | |
| 217 list of bookmarks to be deleted | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <a NAME="HelpBookmarksWidget.__editBookmark" ID="HelpBookmarksWidget.__editBookmark"></a> | |
| 221 <h4>HelpBookmarksWidget.__editBookmark</h4> | |
| 222 <b>__editBookmark</b>(<i>itm</i>) | |
| 223 | |
| 224 <p> | |
| 225 Private slot to edit a bookmark. | |
| 226 </p> | |
| 227 <dl> | |
| 228 | |
| 229 <dt><i>itm</i> (QListWidgetItem)</dt> | |
| 230 <dd> | |
| 231 reference to the bookmark item to be edited | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <a NAME="HelpBookmarksWidget.__exportBookmarks" ID="HelpBookmarksWidget.__exportBookmarks"></a> | |
| 235 <h4>HelpBookmarksWidget.__exportBookmarks</h4> | |
| 236 <b>__exportBookmarks</b>(<i>selected=False</i>) | |
| 237 | |
| 238 <p> | |
| 239 Private slot to export the bookmarks into a JSON file. | |
| 240 </p> | |
| 241 <dl> | |
| 242 | |
| 243 <dt><i>selected</i> (bool (optional))</dt> | |
| 244 <dd> | |
| 245 flag indicating to export the selected bookmarks | |
| 246 (defaults to False) | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <a NAME="HelpBookmarksWidget.__importBookmarks" ID="HelpBookmarksWidget.__importBookmarks"></a> | |
| 250 <h4>HelpBookmarksWidget.__importBookmarks</h4> | |
| 251 <b>__importBookmarks</b>(<i></i>) | |
| 252 | |
| 253 <p> | |
| 254 Private slot to import bookmarks from a JSON file. | |
| 255 </p> | |
| 256 <a NAME="HelpBookmarksWidget.__loadBookmarks" ID="HelpBookmarksWidget.__loadBookmarks"></a> | |
| 257 <h4>HelpBookmarksWidget.__loadBookmarks</h4> | |
| 258 <b>__loadBookmarks</b>(<i></i>) | |
| 259 | |
| 260 <p> | |
| 261 Private method to load the defined bookmarks. | |
| 262 </p> | |
| 263 <a NAME="HelpBookmarksWidget.__newBookmark" ID="HelpBookmarksWidget.__newBookmark"></a> | |
| 264 <h4>HelpBookmarksWidget.__newBookmark</h4> | |
| 265 <b>__newBookmark</b>(<i></i>) | |
| 266 | |
| 267 <p> | |
| 268 Private slot to create a new bookmark. | |
| 269 </p> | |
| 270 <a NAME="HelpBookmarksWidget.__openBookmarks" ID="HelpBookmarksWidget.__openBookmarks"></a> | |
| 271 <h4>HelpBookmarksWidget.__openBookmarks</h4> | |
| 272 <b>__openBookmarks</b>(<i>selected=False</i>) | |
| 273 | |
| 274 <p> | |
| 275 Private method to open all or selected bookmarks. | |
| 276 </p> | |
| 277 <dl> | |
| 278 | |
| 279 <dt><i>selected</i> (bool (optional))</dt> | |
| 280 <dd> | |
| 281 flag indicating to open the selected bookmarks | |
| 282 (defaults to False) | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <a NAME="HelpBookmarksWidget.__saveBookmarks" ID="HelpBookmarksWidget.__saveBookmarks"></a> | |
| 286 <h4>HelpBookmarksWidget.__saveBookmarks</h4> | |
| 287 <b>__saveBookmarks</b>(<i></i>) | |
| 288 | |
| 289 <p> | |
| 290 Private method to save the defined bookmarks. | |
| 291 </p> | |
| 292 <a NAME="HelpBookmarksWidget.__showBackgroundMenu" ID="HelpBookmarksWidget.__showBackgroundMenu"></a> | |
| 293 <h4>HelpBookmarksWidget.__showBackgroundMenu</h4> | |
| 294 <b>__showBackgroundMenu</b>(<i>point</i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot to show the background menu (i.e. no selection). | |
| 298 </p> | |
| 299 <dl> | |
| 300 | |
| 301 <dt><i>point</i> (QPoint)</dt> | |
| 302 <dd> | |
| 303 position to open the menu at | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="HelpBookmarksWidget.__showBookmarkContextMenu" ID="HelpBookmarksWidget.__showBookmarkContextMenu"></a> | |
| 307 <h4>HelpBookmarksWidget.__showBookmarkContextMenu</h4> | |
| 308 <b>__showBookmarkContextMenu</b>(<i>point</i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to show the context menu for a bookmark. | |
| 312 </p> | |
| 313 <dl> | |
| 314 | |
| 315 <dt><i>point</i> (QPoint)</dt> | |
| 316 <dd> | |
| 317 position to open the menu at | |
| 318 </dd> | |
| 319 </dl> | |
| 320 <a NAME="HelpBookmarksWidget.__showBookmarksContextMenu" ID="HelpBookmarksWidget.__showBookmarksContextMenu"></a> | |
| 321 <h4>HelpBookmarksWidget.__showBookmarksContextMenu</h4> | |
| 322 <b>__showBookmarksContextMenu</b>(<i>point</i>) | |
| 323 | |
| 324 <p> | |
| 325 Private slot to show the context menu for multiple bookmark. | |
| 326 </p> | |
| 327 <dl> | |
| 328 | |
| 329 <dt><i>point</i> (QPoint)</dt> | |
| 330 <dd> | |
| 331 position to open the menu at | |
| 332 </dd> | |
| 333 </dl> | |
| 334 <a NAME="HelpBookmarksWidget.__showContextMenu" ID="HelpBookmarksWidget.__showContextMenu"></a> | |
| 335 <h4>HelpBookmarksWidget.__showContextMenu</h4> | |
| 336 <b>__showContextMenu</b>(<i>point</i>) | |
| 337 | |
| 338 <p> | |
| 339 Private slot to handle the customContextMenuRequested signal of | |
| 340 the viewlist. | |
| 341 </p> | |
| 342 <dl> | |
| 343 | |
| 344 <dt><i>point</i> (QPoint)</dt> | |
| 345 <dd> | |
| 346 position to open the menu at | |
| 347 </dd> | |
| 348 </dl> | |
| 349 <a NAME="HelpBookmarksWidget.addBookmark" ID="HelpBookmarksWidget.addBookmark"></a> | |
| 350 <h4>HelpBookmarksWidget.addBookmark</h4> | |
| 351 <b>addBookmark</b>(<i>title, url</i>) | |
| 352 | |
| 353 <p> | |
| 354 Public slot to add a bookmark with given data. | |
| 355 </p> | |
| 356 <dl> | |
| 357 | |
| 358 <dt><i>title</i> (str)</dt> | |
| 359 <dd> | |
| 360 title for the bookmark | |
| 361 </dd> | |
| 362 <dt><i>url</i> (QUrl)</dt> | |
| 363 <dd> | |
| 364 URL for the bookmark | |
| 365 </dd> | |
| 366 </dl> | |
| 367 <div align="right"><a href="#top">Up</a></div> | |
| 368 <hr /> | |
| 369 </body></html> |
