Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html

eric6/Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html

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

Mercurial Repository: eric

eric ide

mercurial