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