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 10479
- 856476537696
- parent 9209
- b99e7fd55fd3
- child 10690
- fab36645aa7d
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.HelpViewer.HelpBookmarksWidget</h1> | 9 <h1>eric7.HelpViewer.HelpBookmarksWidget</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a widget showing the list of bookmarks. | 11 Module implementing a widget showing the list of bookmarks. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HelpBookmarksWidget">HelpBookmarksWidget</a></td> | 22 <td><a href="#HelpBookmarksWidget">HelpBookmarksWidget</a></td> |
| 25 <td>Class implementing a widget showing the list of bookmarks.</td> | 23 <td>Class implementing a widget showing the list of bookmarks.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HelpBookmarksWidget" ID="HelpBookmarksWidget"></a> | 34 <a NAME="HelpBookmarksWidget" ID="HelpBookmarksWidget"></a> |
| 36 <h2>HelpBookmarksWidget</h2> | 35 <h2>HelpBookmarksWidget</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a widget showing the list of bookmarks. | 37 Class implementing a widget showing the list of bookmarks. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Signals</h3> | 40 <h3>Signals</h3> |
| 42 <dl> | 41 <dl> |
| 43 | 42 |
| 44 <dt>escapePressed()</dt> | 43 <dt>escapePressed()</dt> |
| 45 <dd> | 44 <dd> |
| 60 </dd> | 59 </dd> |
| 61 </dl> | 60 </dl> |
| 62 <h3>Derived from</h3> | 61 <h3>Derived from</h3> |
| 63 QListWidget | 62 QListWidget |
| 64 <h3>Class Attributes</h3> | 63 <h3>Class Attributes</h3> |
| 65 | |
| 66 <table> | 64 <table> |
| 67 <tr><td>UrlRole</td></tr> | 65 <tr><td>UrlRole</td></tr> |
| 68 </table> | 66 </table> |
| 67 | |
| 69 <h3>Class Methods</h3> | 68 <h3>Class Methods</h3> |
| 70 | |
| 71 <table> | 69 <table> |
| 72 <tr><td>None</td></tr> | 70 <tr><td>None</td></tr> |
| 73 </table> | 71 </table> |
| 72 | |
| 74 <h3>Methods</h3> | 73 <h3>Methods</h3> |
| 75 | 74 <table> |
| 76 <table> | |
| 77 | |
| 78 <tr> | 75 <tr> |
| 79 <td><a href="#HelpBookmarksWidget.__init__">HelpBookmarksWidget</a></td> | 76 <td><a href="#HelpBookmarksWidget.__init__">HelpBookmarksWidget</a></td> |
| 80 <td>Constructor</td> | 77 <td>Constructor</td> |
| 81 </tr> | 78 </tr> |
| 82 <tr> | 79 <tr> |
| 142 <tr> | 139 <tr> |
| 143 <td><a href="#HelpBookmarksWidget.addBookmark">addBookmark</a></td> | 140 <td><a href="#HelpBookmarksWidget.addBookmark">addBookmark</a></td> |
| 144 <td>Public slot to add a bookmark with given data.</td> | 141 <td>Public slot to add a bookmark with given data.</td> |
| 145 </tr> | 142 </tr> |
| 146 </table> | 143 </table> |
| 144 | |
| 147 <h3>Static Methods</h3> | 145 <h3>Static Methods</h3> |
| 148 | |
| 149 <table> | 146 <table> |
| 150 <tr><td>None</td></tr> | 147 <tr><td>None</td></tr> |
| 151 </table> | 148 </table> |
| 149 | |
| 152 | 150 |
| 153 <a NAME="HelpBookmarksWidget.__init__" ID="HelpBookmarksWidget.__init__"></a> | 151 <a NAME="HelpBookmarksWidget.__init__" ID="HelpBookmarksWidget.__init__"></a> |
| 154 <h4>HelpBookmarksWidget (Constructor)</h4> | 152 <h4>HelpBookmarksWidget (Constructor)</h4> |
| 155 <b>HelpBookmarksWidget</b>(<i>parent=None</i>) | 153 <b>HelpBookmarksWidget</b>(<i>parent=None</i>) |
| 156 | |
| 157 <p> | 154 <p> |
| 158 Constructor | 155 Constructor |
| 159 </p> | 156 </p> |
| 157 | |
| 160 <dl> | 158 <dl> |
| 161 | 159 |
| 162 <dt><i>parent</i> (QWidget (optional))</dt> | 160 <dt><i>parent</i> (QWidget (optional))</dt> |
| 163 <dd> | 161 <dd> |
| 164 reference to the parent widget (defaults to None) | 162 reference to the parent widget (defaults to None) |
| 165 </dd> | 163 </dd> |
| 166 </dl> | 164 </dl> |
| 167 <a NAME="HelpBookmarksWidget.__addBookmark" ID="HelpBookmarksWidget.__addBookmark"></a> | 165 <a NAME="HelpBookmarksWidget.__addBookmark" ID="HelpBookmarksWidget.__addBookmark"></a> |
| 168 <h4>HelpBookmarksWidget.__addBookmark</h4> | 166 <h4>HelpBookmarksWidget.__addBookmark</h4> |
| 169 <b>__addBookmark</b>(<i>title, url</i>) | 167 <b>__addBookmark</b>(<i>title, url</i>) |
| 170 | |
| 171 <p> | 168 <p> |
| 172 Private slot to add a bookmark entry. | 169 Private slot to add a bookmark entry. |
| 173 </p> | 170 </p> |
| 171 | |
| 174 <dl> | 172 <dl> |
| 175 | 173 |
| 176 <dt><i>title</i> (str)</dt> | 174 <dt><i>title</i> (str)</dt> |
| 177 <dd> | 175 <dd> |
| 178 title for the bookmark | 176 title for the bookmark |
| 183 </dd> | 181 </dd> |
| 184 </dl> | 182 </dl> |
| 185 <a NAME="HelpBookmarksWidget.__bookmarkActivated" ID="HelpBookmarksWidget.__bookmarkActivated"></a> | 183 <a NAME="HelpBookmarksWidget.__bookmarkActivated" ID="HelpBookmarksWidget.__bookmarkActivated"></a> |
| 186 <h4>HelpBookmarksWidget.__bookmarkActivated</h4> | 184 <h4>HelpBookmarksWidget.__bookmarkActivated</h4> |
| 187 <b>__bookmarkActivated</b>(<i>itm</i>) | 185 <b>__bookmarkActivated</b>(<i>itm</i>) |
| 188 | |
| 189 <p> | 186 <p> |
| 190 Private slot handling the activation of a bookmark. | 187 Private slot handling the activation of a bookmark. |
| 191 </p> | 188 </p> |
| 189 | |
| 192 <dl> | 190 <dl> |
| 193 | 191 |
| 194 <dt><i>itm</i> (QListWidgetItem)</dt> | 192 <dt><i>itm</i> (QListWidgetItem)</dt> |
| 195 <dd> | 193 <dd> |
| 196 reference to the activated item | 194 reference to the activated item |
| 197 </dd> | 195 </dd> |
| 198 </dl> | 196 </dl> |
| 199 <a NAME="HelpBookmarksWidget.__bookmarkCurrentPage" ID="HelpBookmarksWidget.__bookmarkCurrentPage"></a> | 197 <a NAME="HelpBookmarksWidget.__bookmarkCurrentPage" ID="HelpBookmarksWidget.__bookmarkCurrentPage"></a> |
| 200 <h4>HelpBookmarksWidget.__bookmarkCurrentPage</h4> | 198 <h4>HelpBookmarksWidget.__bookmarkCurrentPage</h4> |
| 201 <b>__bookmarkCurrentPage</b>(<i></i>) | 199 <b>__bookmarkCurrentPage</b>(<i></i>) |
| 202 | |
| 203 <p> | 200 <p> |
| 204 Private slot to bookmark the current page. | 201 Private slot to bookmark the current page. |
| 205 </p> | 202 </p> |
| 203 | |
| 206 <a NAME="HelpBookmarksWidget.__deleteBookmarks" ID="HelpBookmarksWidget.__deleteBookmarks"></a> | 204 <a NAME="HelpBookmarksWidget.__deleteBookmarks" ID="HelpBookmarksWidget.__deleteBookmarks"></a> |
| 207 <h4>HelpBookmarksWidget.__deleteBookmarks</h4> | 205 <h4>HelpBookmarksWidget.__deleteBookmarks</h4> |
| 208 <b>__deleteBookmarks</b>(<i>items</i>) | 206 <b>__deleteBookmarks</b>(<i>items</i>) |
| 209 | |
| 210 <p> | 207 <p> |
| 211 Private method to delete the given bookmark items. | 208 Private method to delete the given bookmark items. |
| 212 </p> | 209 </p> |
| 210 | |
| 213 <dl> | 211 <dl> |
| 214 | 212 |
| 215 <dt><i>items</i> (list of QListWidgetItem)</dt> | 213 <dt><i>items</i> (list of QListWidgetItem)</dt> |
| 216 <dd> | 214 <dd> |
| 217 list of bookmarks to be deleted | 215 list of bookmarks to be deleted |
| 218 </dd> | 216 </dd> |
| 219 </dl> | 217 </dl> |
| 220 <a NAME="HelpBookmarksWidget.__editBookmark" ID="HelpBookmarksWidget.__editBookmark"></a> | 218 <a NAME="HelpBookmarksWidget.__editBookmark" ID="HelpBookmarksWidget.__editBookmark"></a> |
| 221 <h4>HelpBookmarksWidget.__editBookmark</h4> | 219 <h4>HelpBookmarksWidget.__editBookmark</h4> |
| 222 <b>__editBookmark</b>(<i>itm</i>) | 220 <b>__editBookmark</b>(<i>itm</i>) |
| 223 | |
| 224 <p> | 221 <p> |
| 225 Private slot to edit a bookmark. | 222 Private slot to edit a bookmark. |
| 226 </p> | 223 </p> |
| 224 | |
| 227 <dl> | 225 <dl> |
| 228 | 226 |
| 229 <dt><i>itm</i> (QListWidgetItem)</dt> | 227 <dt><i>itm</i> (QListWidgetItem)</dt> |
| 230 <dd> | 228 <dd> |
| 231 reference to the bookmark item to be edited | 229 reference to the bookmark item to be edited |
| 232 </dd> | 230 </dd> |
| 233 </dl> | 231 </dl> |
| 234 <a NAME="HelpBookmarksWidget.__exportBookmarks" ID="HelpBookmarksWidget.__exportBookmarks"></a> | 232 <a NAME="HelpBookmarksWidget.__exportBookmarks" ID="HelpBookmarksWidget.__exportBookmarks"></a> |
| 235 <h4>HelpBookmarksWidget.__exportBookmarks</h4> | 233 <h4>HelpBookmarksWidget.__exportBookmarks</h4> |
| 236 <b>__exportBookmarks</b>(<i>selected=False</i>) | 234 <b>__exportBookmarks</b>(<i>selected=False</i>) |
| 237 | |
| 238 <p> | 235 <p> |
| 239 Private slot to export the bookmarks into a JSON file. | 236 Private slot to export the bookmarks into a JSON file. |
| 240 </p> | 237 </p> |
| 238 | |
| 241 <dl> | 239 <dl> |
| 242 | 240 |
| 243 <dt><i>selected</i> (bool (optional))</dt> | 241 <dt><i>selected</i> (bool (optional))</dt> |
| 244 <dd> | 242 <dd> |
| 245 flag indicating to export the selected bookmarks | 243 flag indicating to export the selected bookmarks |
| 247 </dd> | 245 </dd> |
| 248 </dl> | 246 </dl> |
| 249 <a NAME="HelpBookmarksWidget.__importBookmarks" ID="HelpBookmarksWidget.__importBookmarks"></a> | 247 <a NAME="HelpBookmarksWidget.__importBookmarks" ID="HelpBookmarksWidget.__importBookmarks"></a> |
| 250 <h4>HelpBookmarksWidget.__importBookmarks</h4> | 248 <h4>HelpBookmarksWidget.__importBookmarks</h4> |
| 251 <b>__importBookmarks</b>(<i></i>) | 249 <b>__importBookmarks</b>(<i></i>) |
| 252 | |
| 253 <p> | 250 <p> |
| 254 Private slot to import bookmarks from a JSON file. | 251 Private slot to import bookmarks from a JSON file. |
| 255 </p> | 252 </p> |
| 253 | |
| 256 <a NAME="HelpBookmarksWidget.__loadBookmarks" ID="HelpBookmarksWidget.__loadBookmarks"></a> | 254 <a NAME="HelpBookmarksWidget.__loadBookmarks" ID="HelpBookmarksWidget.__loadBookmarks"></a> |
| 257 <h4>HelpBookmarksWidget.__loadBookmarks</h4> | 255 <h4>HelpBookmarksWidget.__loadBookmarks</h4> |
| 258 <b>__loadBookmarks</b>(<i></i>) | 256 <b>__loadBookmarks</b>(<i></i>) |
| 259 | |
| 260 <p> | 257 <p> |
| 261 Private method to load the defined bookmarks. | 258 Private method to load the defined bookmarks. |
| 262 </p> | 259 </p> |
| 260 | |
| 263 <a NAME="HelpBookmarksWidget.__newBookmark" ID="HelpBookmarksWidget.__newBookmark"></a> | 261 <a NAME="HelpBookmarksWidget.__newBookmark" ID="HelpBookmarksWidget.__newBookmark"></a> |
| 264 <h4>HelpBookmarksWidget.__newBookmark</h4> | 262 <h4>HelpBookmarksWidget.__newBookmark</h4> |
| 265 <b>__newBookmark</b>(<i></i>) | 263 <b>__newBookmark</b>(<i></i>) |
| 266 | |
| 267 <p> | 264 <p> |
| 268 Private slot to create a new bookmark. | 265 Private slot to create a new bookmark. |
| 269 </p> | 266 </p> |
| 267 | |
| 270 <a NAME="HelpBookmarksWidget.__openBookmarks" ID="HelpBookmarksWidget.__openBookmarks"></a> | 268 <a NAME="HelpBookmarksWidget.__openBookmarks" ID="HelpBookmarksWidget.__openBookmarks"></a> |
| 271 <h4>HelpBookmarksWidget.__openBookmarks</h4> | 269 <h4>HelpBookmarksWidget.__openBookmarks</h4> |
| 272 <b>__openBookmarks</b>(<i>selected=False</i>) | 270 <b>__openBookmarks</b>(<i>selected=False</i>) |
| 273 | |
| 274 <p> | 271 <p> |
| 275 Private method to open all or selected bookmarks. | 272 Private method to open all or selected bookmarks. |
| 276 </p> | 273 </p> |
| 274 | |
| 277 <dl> | 275 <dl> |
| 278 | 276 |
| 279 <dt><i>selected</i> (bool (optional))</dt> | 277 <dt><i>selected</i> (bool (optional))</dt> |
| 280 <dd> | 278 <dd> |
| 281 flag indicating to open the selected bookmarks | 279 flag indicating to open the selected bookmarks |
| 283 </dd> | 281 </dd> |
| 284 </dl> | 282 </dl> |
| 285 <a NAME="HelpBookmarksWidget.__saveBookmarks" ID="HelpBookmarksWidget.__saveBookmarks"></a> | 283 <a NAME="HelpBookmarksWidget.__saveBookmarks" ID="HelpBookmarksWidget.__saveBookmarks"></a> |
| 286 <h4>HelpBookmarksWidget.__saveBookmarks</h4> | 284 <h4>HelpBookmarksWidget.__saveBookmarks</h4> |
| 287 <b>__saveBookmarks</b>(<i></i>) | 285 <b>__saveBookmarks</b>(<i></i>) |
| 288 | |
| 289 <p> | 286 <p> |
| 290 Private method to save the defined bookmarks. | 287 Private method to save the defined bookmarks. |
| 291 </p> | 288 </p> |
| 289 | |
| 292 <a NAME="HelpBookmarksWidget.__showBackgroundMenu" ID="HelpBookmarksWidget.__showBackgroundMenu"></a> | 290 <a NAME="HelpBookmarksWidget.__showBackgroundMenu" ID="HelpBookmarksWidget.__showBackgroundMenu"></a> |
| 293 <h4>HelpBookmarksWidget.__showBackgroundMenu</h4> | 291 <h4>HelpBookmarksWidget.__showBackgroundMenu</h4> |
| 294 <b>__showBackgroundMenu</b>(<i>point</i>) | 292 <b>__showBackgroundMenu</b>(<i>point</i>) |
| 295 | |
| 296 <p> | 293 <p> |
| 297 Private slot to show the background menu (i.e. no selection). | 294 Private slot to show the background menu (i.e. no selection). |
| 298 </p> | 295 </p> |
| 296 | |
| 299 <dl> | 297 <dl> |
| 300 | 298 |
| 301 <dt><i>point</i> (QPoint)</dt> | 299 <dt><i>point</i> (QPoint)</dt> |
| 302 <dd> | 300 <dd> |
| 303 position to open the menu at | 301 position to open the menu at |
| 304 </dd> | 302 </dd> |
| 305 </dl> | 303 </dl> |
| 306 <a NAME="HelpBookmarksWidget.__showBookmarkContextMenu" ID="HelpBookmarksWidget.__showBookmarkContextMenu"></a> | 304 <a NAME="HelpBookmarksWidget.__showBookmarkContextMenu" ID="HelpBookmarksWidget.__showBookmarkContextMenu"></a> |
| 307 <h4>HelpBookmarksWidget.__showBookmarkContextMenu</h4> | 305 <h4>HelpBookmarksWidget.__showBookmarkContextMenu</h4> |
| 308 <b>__showBookmarkContextMenu</b>(<i>point</i>) | 306 <b>__showBookmarkContextMenu</b>(<i>point</i>) |
| 309 | |
| 310 <p> | 307 <p> |
| 311 Private slot to show the context menu for a bookmark. | 308 Private slot to show the context menu for a bookmark. |
| 312 </p> | 309 </p> |
| 310 | |
| 313 <dl> | 311 <dl> |
| 314 | 312 |
| 315 <dt><i>point</i> (QPoint)</dt> | 313 <dt><i>point</i> (QPoint)</dt> |
| 316 <dd> | 314 <dd> |
| 317 position to open the menu at | 315 position to open the menu at |
| 318 </dd> | 316 </dd> |
| 319 </dl> | 317 </dl> |
| 320 <a NAME="HelpBookmarksWidget.__showBookmarksContextMenu" ID="HelpBookmarksWidget.__showBookmarksContextMenu"></a> | 318 <a NAME="HelpBookmarksWidget.__showBookmarksContextMenu" ID="HelpBookmarksWidget.__showBookmarksContextMenu"></a> |
| 321 <h4>HelpBookmarksWidget.__showBookmarksContextMenu</h4> | 319 <h4>HelpBookmarksWidget.__showBookmarksContextMenu</h4> |
| 322 <b>__showBookmarksContextMenu</b>(<i>point</i>) | 320 <b>__showBookmarksContextMenu</b>(<i>point</i>) |
| 323 | |
| 324 <p> | 321 <p> |
| 325 Private slot to show the context menu for multiple bookmark. | 322 Private slot to show the context menu for multiple bookmark. |
| 326 </p> | 323 </p> |
| 324 | |
| 327 <dl> | 325 <dl> |
| 328 | 326 |
| 329 <dt><i>point</i> (QPoint)</dt> | 327 <dt><i>point</i> (QPoint)</dt> |
| 330 <dd> | 328 <dd> |
| 331 position to open the menu at | 329 position to open the menu at |
| 332 </dd> | 330 </dd> |
| 333 </dl> | 331 </dl> |
| 334 <a NAME="HelpBookmarksWidget.__showContextMenu" ID="HelpBookmarksWidget.__showContextMenu"></a> | 332 <a NAME="HelpBookmarksWidget.__showContextMenu" ID="HelpBookmarksWidget.__showContextMenu"></a> |
| 335 <h4>HelpBookmarksWidget.__showContextMenu</h4> | 333 <h4>HelpBookmarksWidget.__showContextMenu</h4> |
| 336 <b>__showContextMenu</b>(<i>point</i>) | 334 <b>__showContextMenu</b>(<i>point</i>) |
| 337 | |
| 338 <p> | 335 <p> |
| 339 Private slot to handle the customContextMenuRequested signal of | 336 Private slot to handle the customContextMenuRequested signal of |
| 340 the viewlist. | 337 the viewlist. |
| 341 </p> | 338 </p> |
| 339 | |
| 342 <dl> | 340 <dl> |
| 343 | 341 |
| 344 <dt><i>point</i> (QPoint)</dt> | 342 <dt><i>point</i> (QPoint)</dt> |
| 345 <dd> | 343 <dd> |
| 346 position to open the menu at | 344 position to open the menu at |
| 347 </dd> | 345 </dd> |
| 348 </dl> | 346 </dl> |
| 349 <a NAME="HelpBookmarksWidget.addBookmark" ID="HelpBookmarksWidget.addBookmark"></a> | 347 <a NAME="HelpBookmarksWidget.addBookmark" ID="HelpBookmarksWidget.addBookmark"></a> |
| 350 <h4>HelpBookmarksWidget.addBookmark</h4> | 348 <h4>HelpBookmarksWidget.addBookmark</h4> |
| 351 <b>addBookmark</b>(<i>title, url</i>) | 349 <b>addBookmark</b>(<i>title, url</i>) |
| 352 | |
| 353 <p> | 350 <p> |
| 354 Public slot to add a bookmark with given data. | 351 Public slot to add a bookmark with given data. |
| 355 </p> | 352 </p> |
| 353 | |
| 356 <dl> | 354 <dl> |
| 357 | 355 |
| 358 <dt><i>title</i> (str)</dt> | 356 <dt><i>title</i> (str)</dt> |
| 359 <dd> | 357 <dd> |
| 360 title for the bookmark | 358 title for the bookmark |
