Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html

eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</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.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the parameters for eric7_doc.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td>
39 <td>Class implementing a dialog to enter the parameters for eric7_doc.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a>
50 <h2>EricdocConfigDialog</h2>
51
52 <p>
53 Class implementing a dialog to enter the parameters for eric7_doc.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_EricdocConfigDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#EricdocConfigDialog.__checkQtHelpOptions">__checkQtHelpOptions</a></td>
77 <td>Private slot to check the QtHelp options and set the ok button accordingly.</td>
78 </tr>
79 <tr>
80 <td><a href="#EricdocConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
81 <td>Private method to set the default values.</td>
82 </tr>
83 <tr>
84 <td><a href="#EricdocConfigDialog.__selectColor">__selectColor</a></td>
85 <td>Private method to select a color.</td>
86 </tr>
87 <tr>
88 <td><a href="#EricdocConfigDialog.accept">accept</a></td>
89 <td>Public slot called by the Ok button.</td>
90 </tr>
91 <tr>
92 <td><a href="#EricdocConfigDialog.generateParameters">generateParameters</a></td>
93 <td>Public method that generates the commandline parameters.</td>
94 </tr>
95 <tr>
96 <td><a href="#EricdocConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td>
97 <td>Private slot to add the directory displayed to the listview.</td>
98 </tr>
99 <tr>
100 <td><a href="#EricdocConfigDialog.on_bodyBgButton_clicked">on_bodyBgButton_clicked</a></td>
101 <td>Private slot to select the body background color.</td>
102 </tr>
103 <tr>
104 <td><a href="#EricdocConfigDialog.on_bodyFgButton_clicked">on_bodyFgButton_clicked</a></td>
105 <td>Private slot to select the body foreground color.</td>
106 </tr>
107 <tr>
108 <td><a href="#EricdocConfigDialog.on_cfBgButton_clicked">on_cfBgButton_clicked</a></td>
109 <td>Private slot to select the class/function header background color.</td>
110 </tr>
111 <tr>
112 <td><a href="#EricdocConfigDialog.on_cfFgButton_clicked">on_cfFgButton_clicked</a></td>
113 <td>Private slot to select the class/function header foreground color.</td>
114 </tr>
115 <tr>
116 <td><a href="#EricdocConfigDialog.on_cssPicker_pathSelected">on_cssPicker_pathSelected</a></td>
117 <td>Private slot handling the selection of a css style sheet.</td>
118 </tr>
119 <tr>
120 <td><a href="#EricdocConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
121 <td>Private slot to delete the currently selected directory of the listbox.</td>
122 </tr>
123 <tr>
124 <td><a href="#EricdocConfigDialog.on_ignoreDirPicker_pathSelected">on_ignoreDirPicker_pathSelected</a></td>
125 <td>Private slot handling the selection of a directory to be ignored.</td>
126 </tr>
127 <tr>
128 <td><a href="#EricdocConfigDialog.on_l1BgButton_clicked">on_l1BgButton_clicked</a></td>
129 <td>Private slot to select the level 1 header background color.</td>
130 </tr>
131 <tr>
132 <td><a href="#EricdocConfigDialog.on_l1FgButton_clicked">on_l1FgButton_clicked</a></td>
133 <td>Private slot to select the level 1 header foreground color.</td>
134 </tr>
135 <tr>
136 <td><a href="#EricdocConfigDialog.on_l2BgButton_clicked">on_l2BgButton_clicked</a></td>
137 <td>Private slot to select the level 2 header background color.</td>
138 </tr>
139 <tr>
140 <td><a href="#EricdocConfigDialog.on_l2FgButton_clicked">on_l2FgButton_clicked</a></td>
141 <td>Private slot to select the level 2 header foreground color.</td>
142 </tr>
143 <tr>
144 <td><a href="#EricdocConfigDialog.on_linkFgButton_clicked">on_linkFgButton_clicked</a></td>
145 <td>Private slot to select the foreground color of links.</td>
146 </tr>
147 <tr>
148 <td><a href="#EricdocConfigDialog.on_outputDirPicker_pathSelected">on_outputDirPicker_pathSelected</a></td>
149 <td>Private slot handling the selection of an output directory.</td>
150 </tr>
151 <tr>
152 <td><a href="#EricdocConfigDialog.on_qtHelpDirPicker_pathSelected">on_qtHelpDirPicker_pathSelected</a></td>
153 <td>Private slot handling the selection of the output directory for the QtHelp files.</td>
154 </tr>
155 <tr>
156 <td><a href="#EricdocConfigDialog.on_qtHelpFolderEdit_textChanged">on_qtHelpFolderEdit_textChanged</a></td>
157 <td>Private slot to check the virtual folder.</td>
158 </tr>
159 <tr>
160 <td><a href="#EricdocConfigDialog.on_qtHelpGroup_toggled">on_qtHelpGroup_toggled</a></td>
161 <td>Private slot to toggle the generation of QtHelp files.</td>
162 </tr>
163 <tr>
164 <td><a href="#EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged">on_qtHelpNamespaceEdit_textChanged</a></td>
165 <td>Private slot to check the namespace.</td>
166 </tr>
167 <tr>
168 <td><a href="#EricdocConfigDialog.on_qtHelpTitleEdit_textChanged">on_qtHelpTitleEdit_textChanged</a></td>
169 <td>Private slot to check the title.</td>
170 </tr>
171 </table>
172 <h3>Static Methods</h3>
173
174 <table>
175 <tr><td>None</td></tr>
176 </table>
177
178 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a>
179 <h4>EricdocConfigDialog (Constructor)</h4>
180 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>)
181
182 <p>
183 Constructor
184 </p>
185 <dl>
186
187 <dt><i>project</i></dt>
188 <dd>
189 reference to the project object (Project.Project)
190 </dd>
191 <dt><i>parms</i></dt>
192 <dd>
193 parameters to set in the dialog
194 </dd>
195 <dt><i>parent</i></dt>
196 <dd>
197 parent widget of this dialog
198 </dd>
199 </dl>
200 <a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a>
201 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4>
202 <b>__checkQtHelpOptions</b>(<i></i>)
203
204 <p>
205 Private slot to check the QtHelp options and set the ok button
206 accordingly.
207 </p>
208 <a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a>
209 <h4>EricdocConfigDialog.__initializeDefaults</h4>
210 <b>__initializeDefaults</b>(<i></i>)
211
212 <p>
213 Private method to set the default values.
214 </p>
215 <p>
216 These are needed later on to generate the commandline
217 parameters.
218 </p>
219 <a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a>
220 <h4>EricdocConfigDialog.__selectColor</h4>
221 <b>__selectColor</b>(<i>colorKey</i>)
222
223 <p>
224 Private method to select a color.
225 </p>
226 <dl>
227
228 <dt><i>colorKey</i></dt>
229 <dd>
230 key of the color to select (string)
231 </dd>
232 </dl>
233 <a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a>
234 <h4>EricdocConfigDialog.accept</h4>
235 <b>accept</b>(<i></i>)
236
237 <p>
238 Public slot called by the Ok button.
239 </p>
240 <p>
241 It saves the values in the parameters dictionary.
242 </p>
243 <a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a>
244 <h4>EricdocConfigDialog.generateParameters</h4>
245 <b>generateParameters</b>(<i></i>)
246
247 <p>
248 Public method that generates the commandline parameters.
249 </p>
250 <p>
251 It generates a list of strings to be used
252 to set the QProcess arguments for the ericdoc call and
253 a dictionary containing the non default parameters. This
254 dictionary can be passed back upon object generation to overwrite
255 the default settings.
256 </p>
257 <dl>
258 <dt>Return:</dt>
259 <dd>
260 a tuple of the commandline parameters and non default
261 parameters (list of strings, dictionary)
262 </dd>
263 </dl>
264 <a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a>
265 <h4>EricdocConfigDialog.on_addButton_clicked</h4>
266 <b>on_addButton_clicked</b>(<i></i>)
267
268 <p>
269 Private slot to add the directory displayed to the listview.
270 </p>
271 <p>
272 The directory in the ignore directories
273 line edit is moved to the listbox above and the edit is cleared.
274 </p>
275 <a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a>
276 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4>
277 <b>on_bodyBgButton_clicked</b>(<i></i>)
278
279 <p>
280 Private slot to select the body background color.
281 </p>
282 <a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a>
283 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4>
284 <b>on_bodyFgButton_clicked</b>(<i></i>)
285
286 <p>
287 Private slot to select the body foreground color.
288 </p>
289 <a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a>
290 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4>
291 <b>on_cfBgButton_clicked</b>(<i></i>)
292
293 <p>
294 Private slot to select the class/function header background color.
295 </p>
296 <a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a>
297 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4>
298 <b>on_cfFgButton_clicked</b>(<i></i>)
299
300 <p>
301 Private slot to select the class/function header foreground color.
302 </p>
303 <a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a>
304 <h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4>
305 <b>on_cssPicker_pathSelected</b>(<i>path</i>)
306
307 <p>
308 Private slot handling the selection of a css style sheet.
309 </p>
310 <dl>
311
312 <dt><i>path</i> (str)</dt>
313 <dd>
314 path of the css style sheet
315 </dd>
316 </dl>
317 <a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a>
318 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4>
319 <b>on_deleteButton_clicked</b>(<i></i>)
320
321 <p>
322 Private slot to delete the currently selected directory of the listbox.
323 </p>
324 <a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a>
325 <h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4>
326 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>)
327
328 <p>
329 Private slot handling the selection of a directory to be ignored.
330 </p>
331 <dl>
332
333 <dt><i>path</i> (str)</dt>
334 <dd>
335 path of the directory to be ignored
336 </dd>
337 </dl>
338 <a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a>
339 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4>
340 <b>on_l1BgButton_clicked</b>(<i></i>)
341
342 <p>
343 Private slot to select the level 1 header background color.
344 </p>
345 <a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a>
346 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4>
347 <b>on_l1FgButton_clicked</b>(<i></i>)
348
349 <p>
350 Private slot to select the level 1 header foreground color.
351 </p>
352 <a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a>
353 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4>
354 <b>on_l2BgButton_clicked</b>(<i></i>)
355
356 <p>
357 Private slot to select the level 2 header background color.
358 </p>
359 <a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a>
360 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4>
361 <b>on_l2FgButton_clicked</b>(<i></i>)
362
363 <p>
364 Private slot to select the level 2 header foreground color.
365 </p>
366 <a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a>
367 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4>
368 <b>on_linkFgButton_clicked</b>(<i></i>)
369
370 <p>
371 Private slot to select the foreground color of links.
372 </p>
373 <a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a>
374 <h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4>
375 <b>on_outputDirPicker_pathSelected</b>(<i>path</i>)
376
377 <p>
378 Private slot handling the selection of an output directory.
379 </p>
380 <dl>
381
382 <dt><i>path</i> (str)</dt>
383 <dd>
384 path of the output directory
385 </dd>
386 </dl>
387 <a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a>
388 <h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4>
389 <b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>)
390
391 <p>
392 Private slot handling the selection of the output directory for the
393 QtHelp files.
394 </p>
395 <dl>
396
397 <dt><i>path</i> (str)</dt>
398 <dd>
399 path of the the output directory for the QtHelp files
400 </dd>
401 </dl>
402 <a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a>
403 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4>
404 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>)
405
406 <p>
407 Private slot to check the virtual folder.
408 </p>
409 <dl>
410
411 <dt><i>txt</i></dt>
412 <dd>
413 text of the line edit (string)
414 </dd>
415 </dl>
416 <a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a>
417 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4>
418 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>)
419
420 <p>
421 Private slot to toggle the generation of QtHelp files.
422 </p>
423 <dl>
424
425 <dt><i>enabled</i></dt>
426 <dd>
427 flag indicating the state (boolean)
428 </dd>
429 </dl>
430 <a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a>
431 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4>
432 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>)
433
434 <p>
435 Private slot to check the namespace.
436 </p>
437 <dl>
438
439 <dt><i>txt</i></dt>
440 <dd>
441 text of the line edit (string)
442 </dd>
443 </dl>
444 <a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a>
445 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4>
446 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>)
447
448 <p>
449 Private slot to check the title.
450 </p>
451 <dl>
452
453 <dt><i>txt</i></dt>
454 <dd>
455 text of the line edit (string)
456 </dd>
457 </dl>
458 <div align="right"><a href="#top">Up</a></div>
459 <hr />
460 </body></html>

Mercurial Repository: eric

eric ide

mercurial