Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog.html
eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog.html
- changeset 6942
- 2602857055c5
- parent 5393
- 9db3fd0b1c72
- child 7232
- 0b840f7ed593
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.QtHelp.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.__registerDocumentations">__registerDocumentations</a></td> | |
| 64 <td>Private method to register a given list of documentations.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> | |
| 67 <td>Public method to get the list of tabs to close.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> | |
| 70 <td>Public slot to test the dialog for changes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 73 <td>Private slot to add QtHelp documents to the help database.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#QtHelpDocumentationDialog.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td> | |
| 76 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 79 <td>Private slot handling a change of the documents selection.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#QtHelpDocumentationDialog.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td> | |
| 82 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 85 <td>Private slot to remove a document from the help database.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> | |
| 93 <h4>QtHelpDocumentationDialog (Constructor)</h4> | |
| 94 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>engine</i></dt> | |
| 99 <dd> | |
| 100 reference to the help engine (QHelpEngine) | |
| 101 </dd><dt><i>parent</i></dt> | |
| 102 <dd> | |
| 103 reference to the parent widget (QWidget) | |
| 104 </dd> | |
| 105 </dl><a NAME="QtHelpDocumentationDialog.__registerDocumentations" ID="QtHelpDocumentationDialog.__registerDocumentations"></a> | |
| 106 <h4>QtHelpDocumentationDialog.__registerDocumentations</h4> | |
| 107 <b>__registerDocumentations</b>(<i>fileNames</i>) | |
| 108 <p> | |
| 109 Private method to register a given list of documentations. | |
| 110 </p><dl> | |
| 111 <dt><i>fileNames</i> (list of str)</dt> | |
| 112 <dd> | |
| 113 list of documentation files to be registered | |
| 114 </dd> | |
| 115 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> | |
| 116 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> | |
| 117 <b>getTabsToClose</b>(<i></i>) | |
| 118 <p> | |
| 119 Public method to get the list of tabs to close. | |
| 120 </p><dl> | |
| 121 <dt>Returns:</dt> | |
| 122 <dd> | |
| 123 list of tab ids to be closed (list of integers) | |
| 124 </dd> | |
| 125 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> | |
| 126 <h4>QtHelpDocumentationDialog.hasChanges</h4> | |
| 127 <b>hasChanges</b>(<i></i>) | |
| 128 <p> | |
| 129 Public slot to test the dialog for changes. | |
| 130 </p><dl> | |
| 131 <dt>Returns:</dt> | |
| 132 <dd> | |
| 133 flag indicating presence of changes | |
| 134 </dd> | |
| 135 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> | |
| 136 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> | |
| 137 <b>on_addButton_clicked</b>(<i></i>) | |
| 138 <p> | |
| 139 Private slot to add QtHelp documents to the help database. | |
| 140 </p><a NAME="QtHelpDocumentationDialog.on_addPluginButton_clicked" ID="QtHelpDocumentationDialog.on_addPluginButton_clicked"></a> | |
| 141 <h4>QtHelpDocumentationDialog.on_addPluginButton_clicked</h4> | |
| 142 <b>on_addPluginButton_clicked</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to add QtHelp documents provided by plug-ins to | |
| 145 the help database. | |
| 146 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> | |
| 147 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> | |
| 148 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot handling a change of the documents selection. | |
| 151 </p><a NAME="QtHelpDocumentationDialog.on_managePluginButton_clicked" ID="QtHelpDocumentationDialog.on_managePluginButton_clicked"></a> | |
| 152 <h4>QtHelpDocumentationDialog.on_managePluginButton_clicked</h4> | |
| 153 <b>on_managePluginButton_clicked</b>(<i></i>) | |
| 154 <p> | |
| 155 Private slot to manage the QtHelp documents provided by plug-ins. | |
| 156 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> | |
| 157 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> | |
| 158 <b>on_removeButton_clicked</b>(<i></i>) | |
| 159 <p> | |
| 160 Private slot to remove a document from the help database. | |
| 161 </p> | |
| 162 <div align="right"><a href="#top">Up</a></div> | |
| 163 <hr /> | |
| 164 </body></html> |
