Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.QtHelpDocumentationDialog.html
Documentation/Source/eric6.Helpviewer.QtHelpDocumentationDialog.html
- changeset 3673
- e26d7d0c1088
- child 5227
- 5bffd1a6741f
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.QtHelpDocumentationDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to manage the QtHelp documentation database. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> | |
| 34 <td>Class implementing a dialog to manage the QtHelp documentation database.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> | |
| 43 <h2>QtHelpDocumentationDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to manage the QtHelp documentation database. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_QtHelpDocumentationDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> | |
| 64 <td>Public method to get the list of tabs to close.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> | |
| 67 <td>Public slot to test the dialog for changes.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 70 <td>Private slot to add documents to the help database.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 73 <td>Private slot handling a change of the documents selection.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 76 <td>Private slot to remove a document from the help database.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> | |
| 84 <h4>QtHelpDocumentationDialog (Constructor)</h4> | |
| 85 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><dl> | |
| 89 <dt><i>engine</i></dt> | |
| 90 <dd> | |
| 91 reference to the help engine (QHelpEngine) | |
| 92 </dd><dt><i>parent</i></dt> | |
| 93 <dd> | |
| 94 reference to the parent widget (QWidget) | |
| 95 </dd> | |
| 96 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> | |
| 97 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> | |
| 98 <b>getTabsToClose</b>(<i></i>) | |
| 99 <p> | |
| 100 Public method to get the list of tabs to close. | |
| 101 </p><dl> | |
| 102 <dt>Returns:</dt> | |
| 103 <dd> | |
| 104 list of tab ids to be closed (list of integers) | |
| 105 </dd> | |
| 106 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> | |
| 107 <h4>QtHelpDocumentationDialog.hasChanges</h4> | |
| 108 <b>hasChanges</b>(<i></i>) | |
| 109 <p> | |
| 110 Public slot to test the dialog for changes. | |
| 111 </p><dl> | |
| 112 <dt>Returns:</dt> | |
| 113 <dd> | |
| 114 flag indicating presence of changes | |
| 115 </dd> | |
| 116 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> | |
| 117 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> | |
| 118 <b>on_addButton_clicked</b>(<i></i>) | |
| 119 <p> | |
| 120 Private slot to add documents to the help database. | |
| 121 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> | |
| 122 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> | |
| 123 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 124 <p> | |
| 125 Private slot handling a change of the documents selection. | |
| 126 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> | |
| 127 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> | |
| 128 <b>on_removeButton_clicked</b>(<i></i>) | |
| 129 <p> | |
| 130 Private slot to remove a document from the help database. | |
| 131 </p> | |
| 132 <div align="right"><a href="#top">Up</a></div> | |
| 133 <hr /> | |
| 134 </body></html> |
