Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html
src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DocumentationTools.QtHelpGenerator</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.DocumentationTools.QtHelpGenerator</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the QtHelp generator for the builtin documentation | |
| 13 generator. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | |
| 26 <td>Class implementing the QtHelp generator for the builtin documentation generator.</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="QtHelpGenerator" ID="QtHelpGenerator"></a> | |
| 37 <h2>QtHelpGenerator</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing the QtHelp generator for the builtin documentation | |
| 41 generator. | |
| 42 </p> | |
| 43 <h3>Derived from</h3> | |
| 44 None | |
| 45 <h3>Class Attributes</h3> | |
| 46 | |
| 47 <table> | |
| 48 <tr><td>None</td></tr> | |
| 49 </table> | |
| 50 <h3>Class Methods</h3> | |
| 51 | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 | |
| 57 <table> | |
| 58 | |
| 59 <tr> | |
| 60 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#QtHelpGenerator.__convertEol">__convertEol</a></td> | |
| 65 <td>Private method to convert the newline characters.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | |
| 69 <td>Private method to generate the sections part.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | |
| 73 <td>Public method to generate all index files.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#QtHelpGenerator.remember">remember</a></td> | |
| 77 <td>Public method to remember a documentation file.</td> | |
| 78 </tr> | |
| 79 </table> | |
| 80 <h3>Static Methods</h3> | |
| 81 | |
| 82 <table> | |
| 83 <tr><td>None</td></tr> | |
| 84 </table> | |
| 85 | |
| 86 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | |
| 87 <h4>QtHelpGenerator (Constructor)</h4> | |
| 88 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) | |
| 89 | |
| 90 <p> | |
| 91 Constructor | |
| 92 </p> | |
| 93 <dl> | |
| 94 | |
| 95 <dt><i>htmlDir</i></dt> | |
| 96 <dd> | |
| 97 directory containing the HTML files (string) | |
| 98 </dd> | |
| 99 <dt><i>outputDir</i></dt> | |
| 100 <dd> | |
| 101 output directory for the files (string) | |
| 102 </dd> | |
| 103 <dt><i>namespace</i></dt> | |
| 104 <dd> | |
| 105 namespace to be used (string) | |
| 106 </dd> | |
| 107 <dt><i>virtualFolder</i></dt> | |
| 108 <dd> | |
| 109 virtual folder to be used (string) | |
| 110 </dd> | |
| 111 <dt><i>filterName</i></dt> | |
| 112 <dd> | |
| 113 name of the custom filter (string) | |
| 114 </dd> | |
| 115 <dt><i>filterAttributes</i></dt> | |
| 116 <dd> | |
| 117 ':' separated list of filter attributes | |
| 118 (string) | |
| 119 </dd> | |
| 120 <dt><i>title</i></dt> | |
| 121 <dd> | |
| 122 title to be used for the generated help (string) | |
| 123 </dd> | |
| 124 <dt><i>createCollection</i></dt> | |
| 125 <dd> | |
| 126 flag indicating the generation of the | |
| 127 collection files (boolean) | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | |
| 131 <h4>QtHelpGenerator.__convertEol</h4> | |
| 132 <b>__convertEol</b>(<i>txt, newline</i>) | |
| 133 | |
| 134 <p> | |
| 135 Private method to convert the newline characters. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>txt</i></dt> | |
| 140 <dd> | |
| 141 text to be converted (string) | |
| 142 </dd> | |
| 143 <dt><i>newline</i></dt> | |
| 144 <dd> | |
| 145 newline character to be used (string) | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <dl> | |
| 149 <dt>Return:</dt> | |
| 150 <dd> | |
| 151 converted text (string) | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | |
| 155 <h4>QtHelpGenerator.__generateSections</h4> | |
| 156 <b>__generateSections</b>(<i>package, level</i>) | |
| 157 | |
| 158 <p> | |
| 159 Private method to generate the sections part. | |
| 160 </p> | |
| 161 <dl> | |
| 162 | |
| 163 <dt><i>package</i></dt> | |
| 164 <dd> | |
| 165 name of the package to process (string) | |
| 166 </dd> | |
| 167 <dt><i>level</i></dt> | |
| 168 <dd> | |
| 169 indentation level (integer) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <dl> | |
| 173 <dt>Return:</dt> | |
| 174 <dd> | |
| 175 sections part (string) | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | |
| 179 <h4>QtHelpGenerator.generateFiles</h4> | |
| 180 <b>generateFiles</b>(<i>basename="", newline=None</i>) | |
| 181 | |
| 182 <p> | |
| 183 Public method to generate all index files. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>basename</i></dt> | |
| 188 <dd> | |
| 189 The basename of the file hierarchy to be documented. | |
| 190 The basename is stripped off the filename if it starts with | |
| 191 the basename. | |
| 192 </dd> | |
| 193 <dt><i>newline</i></dt> | |
| 194 <dd> | |
| 195 newline character to be used (string) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | |
| 199 <h4>QtHelpGenerator.remember</h4> | |
| 200 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 201 | |
| 202 <p> | |
| 203 Public method to remember a documentation file. | |
| 204 </p> | |
| 205 <dl> | |
| 206 | |
| 207 <dt><i>file</i></dt> | |
| 208 <dd> | |
| 209 The filename to be remembered. (string) | |
| 210 </dd> | |
| 211 <dt><i>moduleDocument</i></dt> | |
| 212 <dd> | |
| 213 The ModuleDocument object containing the | |
| 214 information for the file. | |
| 215 </dd> | |
| 216 <dt><i>basename</i></dt> | |
| 217 <dd> | |
| 218 The basename of the file hierarchy to be documented. | |
| 219 The basename is stripped off the filename if it starts with | |
| 220 the basename. | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <div align="right"><a href="#top">Up</a></div> | |
| 224 <hr /> | |
| 225 </body></html> |
