Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html
- branch
- eric7
- changeset 9686
- 2eee7a645cba
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9685:b43e04854aba | 9686:2eee7a645cba |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget</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.QtHelpInterface.QtHelpDocumentationSettingsWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget to manage the QtHelp documentation settings. | |
| 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="#QtHelpDocumentationSettingsWidget">QtHelpDocumentationSettingsWidget</a></td> | |
| 25 <td>Class implementing a widget to manage the QtHelp documentation settings.</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="QtHelpDocumentationSettingsWidget" ID="QtHelpDocumentationSettingsWidget"></a> | |
| 36 <h2>QtHelpDocumentationSettingsWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a widget to manage the QtHelp documentation settings. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>documentationSettingsChanged(settings)</dt> | |
| 45 <dd> | |
| 46 emitted to signal a change | |
| 47 of the documentation configuration | |
| 48 </dd> | |
| 49 </dl> | |
| 50 <h3>Derived from</h3> | |
| 51 QWidget, Ui_QtHelpDocumentationSettingsWidget | |
| 52 <h3>Class Attributes</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 | |
| 66 <tr> | |
| 67 <td><a href="#QtHelpDocumentationSettingsWidget.__init__">QtHelpDocumentationSettingsWidget</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter">__applyDocumentsListFilter</a></td> | |
| 72 <td>Private slot to apply the current documents filter.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#QtHelpDocumentationSettingsWidget.__registerDocumentation">__registerDocumentation</a></td> | |
| 76 <td>Private method to register a given list of documentations.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#QtHelpDocumentationSettingsWidget.documentationSettings">documentationSettings</a></td> | |
| 80 <td>Public method to get the reference to the QtHelp documentation configuration object.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td> | |
| 84 <td>Private slot to add QtHelp documents to the help database.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td> | |
| 88 <td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 92 <td>Private slot handling a change of the documents selection.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged">on_filterEdit_textChanged</a></td> | |
| 96 <td>Private slot to react on changes of the document filter text.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td> | |
| 100 <td>Private slot to manage the QtHelp documents provided by plug-ins.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td> | |
| 104 <td>Private slot to remove a document from the help database.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#QtHelpDocumentationSettingsWidget.setDocumentationSettings">setDocumentationSettings</a></td> | |
| 108 <td>Public method to set the reference to the QtHelp documentation configuration object.</td> | |
| 109 </tr> | |
| 110 </table> | |
| 111 <h3>Static Methods</h3> | |
| 112 | |
| 113 <table> | |
| 114 <tr><td>None</td></tr> | |
| 115 </table> | |
| 116 | |
| 117 <a NAME="QtHelpDocumentationSettingsWidget.__init__" ID="QtHelpDocumentationSettingsWidget.__init__"></a> | |
| 118 <h4>QtHelpDocumentationSettingsWidget (Constructor)</h4> | |
| 119 <b>QtHelpDocumentationSettingsWidget</b>(<i>parent=None</i>) | |
| 120 | |
| 121 <p> | |
| 122 Constructor | |
| 123 </p> | |
| 124 <dl> | |
| 125 | |
| 126 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 127 <dd> | |
| 128 reference to the parent widget (defaults to None) | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter" ID="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter"></a> | |
| 132 <h4>QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter</h4> | |
| 133 <b>__applyDocumentsListFilter</b>(<i></i>) | |
| 134 | |
| 135 <p> | |
| 136 Private slot to apply the current documents filter. | |
| 137 </p> | |
| 138 <a NAME="QtHelpDocumentationSettingsWidget.__registerDocumentation" ID="QtHelpDocumentationSettingsWidget.__registerDocumentation"></a> | |
| 139 <h4>QtHelpDocumentationSettingsWidget.__registerDocumentation</h4> | |
| 140 <b>__registerDocumentation</b>(<i>filenames</i>) | |
| 141 | |
| 142 <p> | |
| 143 Private method to register a given list of documentations. | |
| 144 </p> | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>filenames</i> (list of str)</dt> | |
| 148 <dd> | |
| 149 list of documentation files to be registered | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="QtHelpDocumentationSettingsWidget.documentationSettings" ID="QtHelpDocumentationSettingsWidget.documentationSettings"></a> | |
| 153 <h4>QtHelpDocumentationSettingsWidget.documentationSettings</h4> | |
| 154 <b>documentationSettings</b>(<i></i>) | |
| 155 | |
| 156 <p> | |
| 157 Public method to get the reference to the QtHelp documentation | |
| 158 configuration object. | |
| 159 </p> | |
| 160 <dl> | |
| 161 <dt>Return:</dt> | |
| 162 <dd> | |
| 163 reference to the created QtHelpDocumentationSettings object | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <dl> | |
| 167 <dt>Return Type:</dt> | |
| 168 <dd> | |
| 169 QtHelpDocumentationSettings | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked"></a> | |
| 173 <h4>QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked</h4> | |
| 174 <b>on_addDocumentsButton_clicked</b>(<i></i>) | |
| 175 | |
| 176 <p> | |
| 177 Private slot to add QtHelp documents to the help database. | |
| 178 </p> | |
| 179 <a NAME="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked"></a> | |
| 180 <h4>QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked</h4> | |
| 181 <b>on_addPluginButton_clicked</b>(<i></i>) | |
| 182 | |
| 183 <p> | |
| 184 Private slot to add QtHelp documents provided by plug-ins to | |
| 185 the help database. | |
| 186 </p> | |
| 187 <a NAME="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged"></a> | |
| 188 <h4>QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged</h4> | |
| 189 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Private slot handling a change of the documents selection. | |
| 193 </p> | |
| 194 <a NAME="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged" ID="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged"></a> | |
| 195 <h4>QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged</h4> | |
| 196 <b>on_filterEdit_textChanged</b>(<i>txt</i>) | |
| 197 | |
| 198 <p> | |
| 199 Private slot to react on changes of the document filter text. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>txt</i> (str)</dt> | |
| 204 <dd> | |
| 205 current entry of the filter | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <a NAME="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked"></a> | |
| 209 <h4>QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked</h4> | |
| 210 <b>on_managePluginButton_clicked</b>(<i></i>) | |
| 211 | |
| 212 <p> | |
| 213 Private slot to manage the QtHelp documents provided by plug-ins. | |
| 214 </p> | |
| 215 <a NAME="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked"></a> | |
| 216 <h4>QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked</h4> | |
| 217 <b>on_removeDocumentsButton_clicked</b>(<i></i>) | |
| 218 | |
| 219 <p> | |
| 220 Private slot to remove a document from the help database. | |
| 221 </p> | |
| 222 <a NAME="QtHelpDocumentationSettingsWidget.setDocumentationSettings" ID="QtHelpDocumentationSettingsWidget.setDocumentationSettings"></a> | |
| 223 <h4>QtHelpDocumentationSettingsWidget.setDocumentationSettings</h4> | |
| 224 <b>setDocumentationSettings</b>(<i>settings</i>) | |
| 225 | |
| 226 <p> | |
| 227 Public method to set the reference to the QtHelp documentation | |
| 228 configuration object. | |
| 229 </p> | |
| 230 <dl> | |
| 231 | |
| 232 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt> | |
| 233 <dd> | |
| 234 reference to the created QtHelpDocumentationSettings | |
| 235 object | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <div align="right"><a href="#top">Up</a></div> | |
| 239 <hr /> | |
| 240 </body></html> |
