Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettings.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettings.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.QtHelpDocumentationSettings</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.QtHelpDocumentationSettings</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class to store the QtHelp documentation settings before | |
| 13 being applied to the help engine. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#QtHelpDocumentationSettings">QtHelpDocumentationSettings</a></td> | |
| 26 <td>Class implementing a temporary store for QtHelp documentation settings.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="QtHelpDocumentationSettings" ID="QtHelpDocumentationSettings"></a> | |
| 37 <h2>QtHelpDocumentationSettings</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing a temporary store for QtHelp documentation settings. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 None | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>None</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#QtHelpDocumentationSettings.__init__">QtHelpDocumentationSettings</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#QtHelpDocumentationSettings.addDocumentation">addDocumentation</a></td> | |
| 64 <td>Public method to a add a documentation file to the list.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#QtHelpDocumentationSettings.components">components</a></td> | |
| 68 <td>Public method to get the list of components.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#QtHelpDocumentationSettings.namespace">namespace</a></td> | |
| 72 <td>Public method to get the namespace defined by a QtHelp file.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#QtHelpDocumentationSettings.namespaceToFilename">namespaceToFilename</a></td> | |
| 76 <td>Public method to get the namespace to filename mapping.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#QtHelpDocumentationSettings.namespaces">namespaces</a></td> | |
| 80 <td>Public method to get the list of namespaces.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#QtHelpDocumentationSettings.removeDocumentation">removeDocumentation</a></td> | |
| 84 <td>Public method to remove the documentation of a given namespace.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#QtHelpDocumentationSettings.versions">versions</a></td> | |
| 88 <td>Public method to get the list of versions.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 | |
| 93 <table> | |
| 94 | |
| 95 <tr> | |
| 96 <td><a href="#QtHelpDocumentationSettings.applySettings">applySettings</a></td> | |
| 97 <td>Static method to apply the changed QtHelp documentation configuration.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#QtHelpDocumentationSettings.readSettings">readSettings</a></td> | |
| 101 <td>Static method to read the QtHelp documentation configuration.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 | |
| 105 <a NAME="QtHelpDocumentationSettings.__init__" ID="QtHelpDocumentationSettings.__init__"></a> | |
| 106 <h4>QtHelpDocumentationSettings (Constructor)</h4> | |
| 107 <b>QtHelpDocumentationSettings</b>(<i></i>) | |
| 108 | |
| 109 <p> | |
| 110 Constructor | |
| 111 </p> | |
| 112 <a NAME="QtHelpDocumentationSettings.addDocumentation" ID="QtHelpDocumentationSettings.addDocumentation"></a> | |
| 113 <h4>QtHelpDocumentationSettings.addDocumentation</h4> | |
| 114 <b>addDocumentation</b>(<i>filename</i>) | |
| 115 | |
| 116 <p> | |
| 117 Public method to a add a documentation file to the list. | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>filename</i> (str)</dt> | |
| 122 <dd> | |
| 123 name of the documentation file to add | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <dl> | |
| 127 <dt>Return:</dt> | |
| 128 <dd> | |
| 129 flag indicating success | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <dl> | |
| 133 <dt>Return Type:</dt> | |
| 134 <dd> | |
| 135 bool | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="QtHelpDocumentationSettings.components" ID="QtHelpDocumentationSettings.components"></a> | |
| 139 <h4>QtHelpDocumentationSettings.components</h4> | |
| 140 <b>components</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Public method to get the list of components. | |
| 144 </p> | |
| 145 <dl> | |
| 146 <dt>Return:</dt> | |
| 147 <dd> | |
| 148 list of components | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <dl> | |
| 152 <dt>Return Type:</dt> | |
| 153 <dd> | |
| 154 list of str | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="QtHelpDocumentationSettings.namespace" ID="QtHelpDocumentationSettings.namespace"></a> | |
| 158 <h4>QtHelpDocumentationSettings.namespace</h4> | |
| 159 <b>namespace</b>(<i>filename</i>) | |
| 160 | |
| 161 <p> | |
| 162 Public method to get the namespace defined by a QtHelp file. | |
| 163 </p> | |
| 164 <dl> | |
| 165 | |
| 166 <dt><i>filename</i> (str)</dt> | |
| 167 <dd> | |
| 168 name of the QtHelp file | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <dl> | |
| 172 <dt>Return:</dt> | |
| 173 <dd> | |
| 174 name of the namespace | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return Type:</dt> | |
| 179 <dd> | |
| 180 str | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <a NAME="QtHelpDocumentationSettings.namespaceToFilename" ID="QtHelpDocumentationSettings.namespaceToFilename"></a> | |
| 184 <h4>QtHelpDocumentationSettings.namespaceToFilename</h4> | |
| 185 <b>namespaceToFilename</b>(<i></i>) | |
| 186 | |
| 187 <p> | |
| 188 Public method to get the namespace to filename mapping. | |
| 189 </p> | |
| 190 <dl> | |
| 191 <dt>Return:</dt> | |
| 192 <dd> | |
| 193 dictionary containing the namespace to filename mapping | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <dl> | |
| 197 <dt>Return Type:</dt> | |
| 198 <dd> | |
| 199 dict | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="QtHelpDocumentationSettings.namespaces" ID="QtHelpDocumentationSettings.namespaces"></a> | |
| 203 <h4>QtHelpDocumentationSettings.namespaces</h4> | |
| 204 <b>namespaces</b>(<i></i>) | |
| 205 | |
| 206 <p> | |
| 207 Public method to get the list of namespaces. | |
| 208 </p> | |
| 209 <dl> | |
| 210 <dt>Return:</dt> | |
| 211 <dd> | |
| 212 list of namespaces | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <dl> | |
| 216 <dt>Return Type:</dt> | |
| 217 <dd> | |
| 218 list of str | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <a NAME="QtHelpDocumentationSettings.removeDocumentation" ID="QtHelpDocumentationSettings.removeDocumentation"></a> | |
| 222 <h4>QtHelpDocumentationSettings.removeDocumentation</h4> | |
| 223 <b>removeDocumentation</b>(<i>namespace</i>) | |
| 224 | |
| 225 <p> | |
| 226 Public method to remove the documentation of a given namespace. | |
| 227 </p> | |
| 228 <dl> | |
| 229 | |
| 230 <dt><i>namespace</i> (str)</dt> | |
| 231 <dd> | |
| 232 name of the namespace | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <dl> | |
| 236 <dt>Return:</dt> | |
| 237 <dd> | |
| 238 flag indicating success | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <dl> | |
| 242 <dt>Return Type:</dt> | |
| 243 <dd> | |
| 244 bool | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="QtHelpDocumentationSettings.versions" ID="QtHelpDocumentationSettings.versions"></a> | |
| 248 <h4>QtHelpDocumentationSettings.versions</h4> | |
| 249 <b>versions</b>(<i></i>) | |
| 250 | |
| 251 <p> | |
| 252 Public method to get the list of versions. | |
| 253 </p> | |
| 254 <dl> | |
| 255 <dt>Return:</dt> | |
| 256 <dd> | |
| 257 list of versions | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <dl> | |
| 261 <dt>Return Type:</dt> | |
| 262 <dd> | |
| 263 list of QVersionNumber | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <a NAME="QtHelpDocumentationSettings.applySettings" ID="QtHelpDocumentationSettings.applySettings"></a> | |
| 267 <h4>QtHelpDocumentationSettings.applySettings (static)</h4> | |
| 268 <b>applySettings</b>(<i>settings</i>) | |
| 269 | |
| 270 <p> | |
| 271 Static method to apply the changed QtHelp documentation configuration. | |
| 272 </p> | |
| 273 <dl> | |
| 274 | |
| 275 <dt><i>helpEngine</i> (QHelpEngineCore)</dt> | |
| 276 <dd> | |
| 277 reference to the QtHelp engine | |
| 278 </dd> | |
| 279 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt> | |
| 280 <dd> | |
| 281 reference to the created QtHelpDocumentationSettings | |
| 282 object | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <dl> | |
| 286 <dt>Return:</dt> | |
| 287 <dd> | |
| 288 flag indicating success | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <dl> | |
| 292 <dt>Return Type:</dt> | |
| 293 <dd> | |
| 294 bool | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <a NAME="QtHelpDocumentationSettings.readSettings" ID="QtHelpDocumentationSettings.readSettings"></a> | |
| 298 <h4>QtHelpDocumentationSettings.readSettings (static)</h4> | |
| 299 <b>readSettings</b>(<i></i>) | |
| 300 | |
| 301 <p> | |
| 302 Static method to read the QtHelp documentation configuration. | |
| 303 </p> | |
| 304 <dl> | |
| 305 | |
| 306 <dt><i>helpEngine</i> (QHelpEngineCore)</dt> | |
| 307 <dd> | |
| 308 reference to the QtHelp engine | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <dl> | |
| 312 <dt>Return:</dt> | |
| 313 <dd> | |
| 314 reference to the created QtHelpDocumentationSettings object | |
| 315 </dd> | |
| 316 </dl> | |
| 317 <dl> | |
| 318 <dt>Return Type:</dt> | |
| 319 <dd> | |
| 320 QtHelpDocumentationSettings | |
| 321 </dd> | |
| 322 </dl> | |
| 323 <div align="right"><a href="#top">Up</a></div> | |
| 324 <hr /> | |
| 325 </body></html> |
