Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.QtHelpDocumentationDialog.html
eric7/Documentation/Source/eric7.WebBrowser.QtHelp.QtHelpDocumentationDialog.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.QtHelp.QtHelpDocumentationDialog</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.QtHelp.QtHelpDocumentationDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a dialog to manage the QtHelp documentation database. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> | |
| 39 <td>Class implementing a dialog to manage the QtHelp documentation database.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> | |
| 50 <h2>QtHelpDocumentationDialog</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a dialog to manage the QtHelp documentation database. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QDialog, Ui_QtHelpDocumentationDialog | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#QtHelpDocumentationDialog.__hasChangedFilters">__hasChangedFilters</a></td> | |
| 77 <td>Private method to determine, if there are filter changes.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#QtHelpDocumentationDialog.__initDocumentsTab">__initDocumentsTab</a></td> | |
| 81 <td>Private method to initialize the documents tab.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#QtHelpDocumentationDialog.__initFiltersTab">__initFiltersTab</a></td> | |
| 85 <td>Private method to initialize the filters tab.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#QtHelpDocumentationDialog.__registerDocumentations">__registerDocumentations</a></td> | |
| 89 <td>Private method to register a given list of documentations.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#QtHelpDocumentationDialog.__removeAttributes">__removeAttributes</a></td> | |
| 93 <td>Private method to remove attributes from the Qt Help database.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> | |
| 97 <td>Public method to get the list of tabs to close.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#QtHelpDocumentationDialog.hasDocumentationChanges">hasDocumentationChanges</a></td> | |
| 101 <td>Public slot to test the dialog for changes of configured QtHelp documents.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#QtHelpDocumentationDialog.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td> | |
| 105 <td>Private slot to add QtHelp documents to the help database.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#QtHelpDocumentationDialog.on_addFilterButton_clicked">on_addFilterButton_clicked</a></td> | |
| 109 <td>Private slot to add a new filter.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td> | |
| 113 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked">on_applyFilterChangesButton_clicked</a></td> | |
| 117 <td>Private slot to apply the filter changes.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemChanged">on_attributesList_itemChanged</a></td> | |
| 121 <td>Private slot to handle a change of an attribute.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged">on_attributesList_itemSelectionChanged</a></td> | |
| 125 <td>Private slot handling the selection of attributes.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 129 <td>Private slot handling a change of the documents selection.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#QtHelpDocumentationDialog.on_filtersList_currentItemChanged">on_filtersList_currentItemChanged</a></td> | |
| 133 <td>Private slot to update the attributes depending on the current filter.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged">on_filtersList_itemSelectionChanged</a></td> | |
| 137 <td>Private slot handling a change of selected filters.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td> | |
| 141 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#QtHelpDocumentationDialog.on_removeAttributesButton_clicked">on_removeAttributesButton_clicked</a></td> | |
| 145 <td>Private slot to remove the selected filter attributes.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#QtHelpDocumentationDialog.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td> | |
| 149 <td>Private slot to remove a document from the help database.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#QtHelpDocumentationDialog.on_removeFiltersButton_clicked">on_removeFiltersButton_clicked</a></td> | |
| 153 <td>Private slot to remove the selected filters.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked">on_resetFilterChangesButton_clicked</a></td> | |
| 157 <td>Private slot to forget the filter changes and reset the tab.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#QtHelpDocumentationDialog.on_tabWidget_currentChanged">on_tabWidget_currentChanged</a></td> | |
| 161 <td>Private slot handling a change of the current tab.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#QtHelpDocumentationDialog.on_unusedAttributesButton_clicked">on_unusedAttributesButton_clicked</a></td> | |
| 165 <td>Private slot to select all unused attributes.</td> | |
| 166 </tr> | |
| 167 </table> | |
| 168 <h3>Static Methods</h3> | |
| 169 | |
| 170 <table> | |
| 171 <tr><td>None</td></tr> | |
| 172 </table> | |
| 173 | |
| 174 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> | |
| 175 <h4>QtHelpDocumentationDialog (Constructor)</h4> | |
| 176 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) | |
| 177 | |
| 178 <p> | |
| 179 Constructor | |
| 180 </p> | |
| 181 <dl> | |
| 182 | |
| 183 <dt><i>engine</i></dt> | |
| 184 <dd> | |
| 185 reference to the help engine (QHelpEngine) | |
| 186 </dd> | |
| 187 <dt><i>parent</i></dt> | |
| 188 <dd> | |
| 189 reference to the parent widget (QWidget) | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="QtHelpDocumentationDialog.__hasChangedFilters" ID="QtHelpDocumentationDialog.__hasChangedFilters"></a> | |
| 193 <h4>QtHelpDocumentationDialog.__hasChangedFilters</h4> | |
| 194 <b>__hasChangedFilters</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Private method to determine, if there are filter changes. | |
| 198 </p> | |
| 199 <dl> | |
| 200 <dt>Return:</dt> | |
| 201 <dd> | |
| 202 flag indicating the presence of filter changes | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return Type:</dt> | |
| 207 <dd> | |
| 208 bool | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <a NAME="QtHelpDocumentationDialog.__initDocumentsTab" ID="QtHelpDocumentationDialog.__initDocumentsTab"></a> | |
| 212 <h4>QtHelpDocumentationDialog.__initDocumentsTab</h4> | |
| 213 <b>__initDocumentsTab</b>(<i></i>) | |
| 214 | |
| 215 <p> | |
| 216 Private method to initialize the documents tab. | |
| 217 </p> | |
| 218 <a NAME="QtHelpDocumentationDialog.__initFiltersTab" ID="QtHelpDocumentationDialog.__initFiltersTab"></a> | |
| 219 <h4>QtHelpDocumentationDialog.__initFiltersTab</h4> | |
| 220 <b>__initFiltersTab</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Private method to initialize the filters tab. | |
| 224 </p> | |
| 225 <a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a> | |
| 226 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4> | |
| 227 <b>__registerDocumentations</b>(<i>fileNames</i>) | |
| 228 | |
| 229 <p> | |
| 230 Private method to register a given list of documentations. | |
| 231 </p> | |
| 232 <dl> | |
| 233 | |
| 234 <dt><i>fileNames</i> (list of str)</dt> | |
| 235 <dd> | |
| 236 list of documentation files to be registered | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="QtHelpDocumentationDialog.__removeAttributes" ID="QtHelpDocumentationDialog.__removeAttributes"></a> | |
| 240 <h4>QtHelpDocumentationDialog.__removeAttributes</h4> | |
| 241 <b>__removeAttributes</b>(<i></i>) | |
| 242 | |
| 243 <p> | |
| 244 Private method to remove attributes from the Qt Help database. | |
| 245 </p> | |
| 246 <a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> | |
| 247 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> | |
| 248 <b>getTabsToClose</b>(<i></i>) | |
| 249 | |
| 250 <p> | |
| 251 Public method to get the list of tabs to close. | |
| 252 </p> | |
| 253 <dl> | |
| 254 <dt>Return:</dt> | |
| 255 <dd> | |
| 256 list of tab ids to be closed | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <dl> | |
| 260 <dt>Return Type:</dt> | |
| 261 <dd> | |
| 262 list of int | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="QtHelpDocumentationDialog.hasDocumentationChanges" ID="QtHelpDocumentationDialog.hasDocumentationChanges"></a> | |
| 266 <h4>QtHelpDocumentationDialog.hasDocumentationChanges</h4> | |
| 267 <b>hasDocumentationChanges</b>(<i></i>) | |
| 268 | |
| 269 <p> | |
| 270 Public slot to test the dialog for changes of configured QtHelp | |
| 271 documents. | |
| 272 </p> | |
| 273 <dl> | |
| 274 <dt>Return:</dt> | |
| 275 <dd> | |
| 276 flag indicating presence of changes | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <dl> | |
| 280 <dt>Return Type:</dt> | |
| 281 <dd> | |
| 282 bool | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <a NAME="QtHelpDocumentationDialog.on_addDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_addDocumentsButton_clicked"></a> | |
| 286 <h4>QtHelpDocumentationDialog.on_addDocumentsButton_clicked</h4> | |
| 287 <b>on_addDocumentsButton_clicked</b>(<i></i>) | |
| 288 | |
| 289 <p> | |
| 290 Private slot to add QtHelp documents to the help database. | |
| 291 </p> | |
| 292 <a NAME="QtHelpDocumentationDialog.on_addFilterButton_clicked" ID="QtHelpDocumentationDialog.on_addFilterButton_clicked"></a> | |
| 293 <h4>QtHelpDocumentationDialog.on_addFilterButton_clicked</h4> | |
| 294 <b>on_addFilterButton_clicked</b>(<i></i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot to add a new filter. | |
| 298 </p> | |
| 299 <a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a> | |
| 300 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4> | |
| 301 <b>on_addPluginButton_clicked</b>(<i></i>) | |
| 302 | |
| 303 <p> | |
| 304 Private slot to add QtHelp documents provided by plug-ins to | |
| 305 the help database. | |
| 306 </p> | |
| 307 <a NAME="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked"></a> | |
| 308 <h4>QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked</h4> | |
| 309 <b>on_applyFilterChangesButton_clicked</b>(<i></i>) | |
| 310 | |
| 311 <p> | |
| 312 Private slot to apply the filter changes. | |
| 313 </p> | |
| 314 <a NAME="QtHelpDocumentationDialog.on_attributesList_itemChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemChanged"></a> | |
| 315 <h4>QtHelpDocumentationDialog.on_attributesList_itemChanged</h4> | |
| 316 <b>on_attributesList_itemChanged</b>(<i>item, column</i>) | |
| 317 | |
| 318 <p> | |
| 319 Private slot to handle a change of an attribute. | |
| 320 </p> | |
| 321 <dl> | |
| 322 | |
| 323 <dt><i>item</i></dt> | |
| 324 <dd> | |
| 325 reference to the changed item (QTreeWidgetItem) | |
| 326 </dd> | |
| 327 <dt><i>column</i></dt> | |
| 328 <dd> | |
| 329 column containing the change (integer) | |
| 330 </dd> | |
| 331 </dl> | |
| 332 <a NAME="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged"></a> | |
| 333 <h4>QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged</h4> | |
| 334 <b>on_attributesList_itemSelectionChanged</b>(<i></i>) | |
| 335 | |
| 336 <p> | |
| 337 Private slot handling the selection of attributes. | |
| 338 </p> | |
| 339 <a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> | |
| 340 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> | |
| 341 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 342 | |
| 343 <p> | |
| 344 Private slot handling a change of the documents selection. | |
| 345 </p> | |
| 346 <a NAME="QtHelpDocumentationDialog.on_filtersList_currentItemChanged" ID="QtHelpDocumentationDialog.on_filtersList_currentItemChanged"></a> | |
| 347 <h4>QtHelpDocumentationDialog.on_filtersList_currentItemChanged</h4> | |
| 348 <b>on_filtersList_currentItemChanged</b>(<i>current, previous</i>) | |
| 349 | |
| 350 <p> | |
| 351 Private slot to update the attributes depending on the current filter. | |
| 352 </p> | |
| 353 <dl> | |
| 354 | |
| 355 <dt><i>current</i></dt> | |
| 356 <dd> | |
| 357 reference to the current item (QListWidgetitem) | |
| 358 </dd> | |
| 359 <dt><i>previous</i></dt> | |
| 360 <dd> | |
| 361 reference to the previous current item | |
| 362 (QListWidgetItem) | |
| 363 </dd> | |
| 364 </dl> | |
| 365 <a NAME="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged"></a> | |
| 366 <h4>QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged</h4> | |
| 367 <b>on_filtersList_itemSelectionChanged</b>(<i></i>) | |
| 368 | |
| 369 <p> | |
| 370 Private slot handling a change of selected filters. | |
| 371 </p> | |
| 372 <a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a> | |
| 373 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4> | |
| 374 <b>on_managePluginButton_clicked</b>(<i></i>) | |
| 375 | |
| 376 <p> | |
| 377 Private slot to manage the QtHelp documents provided by plug-ins. | |
| 378 </p> | |
| 379 <a NAME="QtHelpDocumentationDialog.on_removeAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_removeAttributesButton_clicked"></a> | |
| 380 <h4>QtHelpDocumentationDialog.on_removeAttributesButton_clicked</h4> | |
| 381 <b>on_removeAttributesButton_clicked</b>(<i></i>) | |
| 382 | |
| 383 <p> | |
| 384 Private slot to remove the selected filter attributes. | |
| 385 </p> | |
| 386 <a NAME="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationDialog.on_removeDocumentsButton_clicked"></a> | |
| 387 <h4>QtHelpDocumentationDialog.on_removeDocumentsButton_clicked</h4> | |
| 388 <b>on_removeDocumentsButton_clicked</b>(<i></i>) | |
| 389 | |
| 390 <p> | |
| 391 Private slot to remove a document from the help database. | |
| 392 </p> | |
| 393 <a NAME="QtHelpDocumentationDialog.on_removeFiltersButton_clicked" ID="QtHelpDocumentationDialog.on_removeFiltersButton_clicked"></a> | |
| 394 <h4>QtHelpDocumentationDialog.on_removeFiltersButton_clicked</h4> | |
| 395 <b>on_removeFiltersButton_clicked</b>(<i></i>) | |
| 396 | |
| 397 <p> | |
| 398 Private slot to remove the selected filters. | |
| 399 </p> | |
| 400 <a NAME="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked" ID="QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked"></a> | |
| 401 <h4>QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked</h4> | |
| 402 <b>on_resetFilterChangesButton_clicked</b>(<i></i>) | |
| 403 | |
| 404 <p> | |
| 405 Private slot to forget the filter changes and reset the tab. | |
| 406 </p> | |
| 407 <a NAME="QtHelpDocumentationDialog.on_tabWidget_currentChanged" ID="QtHelpDocumentationDialog.on_tabWidget_currentChanged"></a> | |
| 408 <h4>QtHelpDocumentationDialog.on_tabWidget_currentChanged</h4> | |
| 409 <b>on_tabWidget_currentChanged</b>(<i>index</i>) | |
| 410 | |
| 411 <p> | |
| 412 Private slot handling a change of the current tab. | |
| 413 </p> | |
| 414 <dl> | |
| 415 | |
| 416 <dt><i>index</i> (int)</dt> | |
| 417 <dd> | |
| 418 index of the current tab | |
| 419 </dd> | |
| 420 </dl> | |
| 421 <a NAME="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked" ID="QtHelpDocumentationDialog.on_unusedAttributesButton_clicked"></a> | |
| 422 <h4>QtHelpDocumentationDialog.on_unusedAttributesButton_clicked</h4> | |
| 423 <b>on_unusedAttributesButton_clicked</b>(<i></i>) | |
| 424 | |
| 425 <p> | |
| 426 Private slot to select all unused attributes. | |
| 427 </p> | |
| 428 <div align="right"><a href="#top">Up</a></div> | |
| 429 <hr /> | |
| 430 </body></html> |
