Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
child 4602
48cc4820e2c2
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1>
23 <p>
24 Module implementing a dialog to enter the parameters for eric6_doc.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td>
34 <td>Class implementing a dialog to enter the parameters for eric6_doc.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a>
43 <h2>EricdocConfigDialog</h2>
44 <p>
45 Class implementing a dialog to enter the parameters for eric6_doc.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_EricdocConfigDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#EricdocConfigDialog.__checkQtHelpOptions">__checkQtHelpOptions</a></td>
64 <td>Private slot to check the QtHelp options and set the ok button accordingly.</td>
65 </tr><tr>
66 <td><a href="#EricdocConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
67 <td>Private method to set the default values.</td>
68 </tr><tr>
69 <td><a href="#EricdocConfigDialog.__selectColor">__selectColor</a></td>
70 <td>Private method to select a color.</td>
71 </tr><tr>
72 <td><a href="#EricdocConfigDialog.accept">accept</a></td>
73 <td>Public slot called by the Ok button.</td>
74 </tr><tr>
75 <td><a href="#EricdocConfigDialog.generateParameters">generateParameters</a></td>
76 <td>Public method that generates the commandline parameters.</td>
77 </tr><tr>
78 <td><a href="#EricdocConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td>
79 <td>Private slot to add the directory displayed to the listview.</td>
80 </tr><tr>
81 <td><a href="#EricdocConfigDialog.on_bodyBgButton_clicked">on_bodyBgButton_clicked</a></td>
82 <td>Private slot to select the body background color.</td>
83 </tr><tr>
84 <td><a href="#EricdocConfigDialog.on_bodyFgButton_clicked">on_bodyFgButton_clicked</a></td>
85 <td>Private slot to select the body foreground color.</td>
86 </tr><tr>
87 <td><a href="#EricdocConfigDialog.on_cfBgButton_clicked">on_cfBgButton_clicked</a></td>
88 <td>Private slot to select the class/function header background color.</td>
89 </tr><tr>
90 <td><a href="#EricdocConfigDialog.on_cfFgButton_clicked">on_cfFgButton_clicked</a></td>
91 <td>Private slot to select the class/function header foreground color.</td>
92 </tr><tr>
93 <td><a href="#EricdocConfigDialog.on_cssButton_clicked">on_cssButton_clicked</a></td>
94 <td>Private slot to select a css style sheet.</td>
95 </tr><tr>
96 <td><a href="#EricdocConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
97 <td>Private slot to delete the currently selected directory of the listbox.</td>
98 </tr><tr>
99 <td><a href="#EricdocConfigDialog.on_ignoreDirButton_clicked">on_ignoreDirButton_clicked</a></td>
100 <td>Private slot to select a directory to be ignored.</td>
101 </tr><tr>
102 <td><a href="#EricdocConfigDialog.on_l1BgButton_clicked">on_l1BgButton_clicked</a></td>
103 <td>Private slot to select the level 1 header background color.</td>
104 </tr><tr>
105 <td><a href="#EricdocConfigDialog.on_l1FgButton_clicked">on_l1FgButton_clicked</a></td>
106 <td>Private slot to select the level 1 header foreground color.</td>
107 </tr><tr>
108 <td><a href="#EricdocConfigDialog.on_l2BgButton_clicked">on_l2BgButton_clicked</a></td>
109 <td>Private slot to select the level 2 header background color.</td>
110 </tr><tr>
111 <td><a href="#EricdocConfigDialog.on_l2FgButton_clicked">on_l2FgButton_clicked</a></td>
112 <td>Private slot to select the level 2 header foreground color.</td>
113 </tr><tr>
114 <td><a href="#EricdocConfigDialog.on_linkFgButton_clicked">on_linkFgButton_clicked</a></td>
115 <td>Private slot to select the foreground color of links.</td>
116 </tr><tr>
117 <td><a href="#EricdocConfigDialog.on_outputDirButton_clicked">on_outputDirButton_clicked</a></td>
118 <td>Private slot to select the output directory.</td>
119 </tr><tr>
120 <td><a href="#EricdocConfigDialog.on_qtHelpDirButton_clicked">on_qtHelpDirButton_clicked</a></td>
121 <td>Private slot to select the output directory for the QtHelp files.</td>
122 </tr><tr>
123 <td><a href="#EricdocConfigDialog.on_qtHelpFolderEdit_textChanged">on_qtHelpFolderEdit_textChanged</a></td>
124 <td>Private slot to check the virtual folder.</td>
125 </tr><tr>
126 <td><a href="#EricdocConfigDialog.on_qtHelpGroup_toggled">on_qtHelpGroup_toggled</a></td>
127 <td>Private slot to toggle the generation of QtHelp files.</td>
128 </tr><tr>
129 <td><a href="#EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged">on_qtHelpNamespaceEdit_textChanged</a></td>
130 <td>Private slot to check the namespace.</td>
131 </tr><tr>
132 <td><a href="#EricdocConfigDialog.on_qtHelpTitleEdit_textChanged">on_qtHelpTitleEdit_textChanged</a></td>
133 <td>Private slot to check the title.</td>
134 </tr>
135 </table>
136 <h3>Static Methods</h3>
137 <table>
138 <tr><td>None</td></tr>
139 </table>
140 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a>
141 <h4>EricdocConfigDialog (Constructor)</h4>
142 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>)
143 <p>
144 Constructor
145 </p><dl>
146 <dt><i>project</i></dt>
147 <dd>
148 reference to the project object (Project.Project)
149 </dd><dt><i>parms</i></dt>
150 <dd>
151 parameters to set in the dialog
152 </dd><dt><i>parent</i></dt>
153 <dd>
154 parent widget of this dialog
155 </dd>
156 </dl><a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a>
157 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4>
158 <b>__checkQtHelpOptions</b>(<i></i>)
159 <p>
160 Private slot to check the QtHelp options and set the ok button
161 accordingly.
162 </p><a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a>
163 <h4>EricdocConfigDialog.__initializeDefaults</h4>
164 <b>__initializeDefaults</b>(<i></i>)
165 <p>
166 Private method to set the default values.
167 </p><p>
168 These are needed later on to generate the commandline
169 parameters.
170 </p><a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a>
171 <h4>EricdocConfigDialog.__selectColor</h4>
172 <b>__selectColor</b>(<i>colorKey</i>)
173 <p>
174 Private method to select a color.
175 </p><dl>
176 <dt><i>colorKey</i></dt>
177 <dd>
178 key of the color to select (string)
179 </dd>
180 </dl><a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a>
181 <h4>EricdocConfigDialog.accept</h4>
182 <b>accept</b>(<i></i>)
183 <p>
184 Public slot called by the Ok button.
185 </p><p>
186 It saves the values in the parameters dictionary.
187 </p><a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a>
188 <h4>EricdocConfigDialog.generateParameters</h4>
189 <b>generateParameters</b>(<i></i>)
190 <p>
191 Public method that generates the commandline parameters.
192 </p><p>
193 It generates a list of strings to be used
194 to set the QProcess arguments for the ericdoc call and
195 a dictionary containing the non default parameters. This
196 dictionary can be passed back upon object generation to overwrite
197 the default settings.
198 </p><dl>
199 <dt>Returns:</dt>
200 <dd>
201 a tuple of the commandline parameters and non default
202 parameters (list of strings, dictionary)
203 </dd>
204 </dl><a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a>
205 <h4>EricdocConfigDialog.on_addButton_clicked</h4>
206 <b>on_addButton_clicked</b>(<i></i>)
207 <p>
208 Private slot to add the directory displayed to the listview.
209 </p><p>
210 The directory in the ignore directories
211 line edit is moved to the listbox above and the edit is cleared.
212 </p><a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a>
213 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4>
214 <b>on_bodyBgButton_clicked</b>(<i></i>)
215 <p>
216 Private slot to select the body background color.
217 </p><a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a>
218 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4>
219 <b>on_bodyFgButton_clicked</b>(<i></i>)
220 <p>
221 Private slot to select the body foreground color.
222 </p><a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a>
223 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4>
224 <b>on_cfBgButton_clicked</b>(<i></i>)
225 <p>
226 Private slot to select the class/function header background color.
227 </p><a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a>
228 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4>
229 <b>on_cfFgButton_clicked</b>(<i></i>)
230 <p>
231 Private slot to select the class/function header foreground color.
232 </p><a NAME="EricdocConfigDialog.on_cssButton_clicked" ID="EricdocConfigDialog.on_cssButton_clicked"></a>
233 <h4>EricdocConfigDialog.on_cssButton_clicked</h4>
234 <b>on_cssButton_clicked</b>(<i></i>)
235 <p>
236 Private slot to select a css style sheet.
237 </p><a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a>
238 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4>
239 <b>on_deleteButton_clicked</b>(<i></i>)
240 <p>
241 Private slot to delete the currently selected directory of the listbox.
242 </p><a NAME="EricdocConfigDialog.on_ignoreDirButton_clicked" ID="EricdocConfigDialog.on_ignoreDirButton_clicked"></a>
243 <h4>EricdocConfigDialog.on_ignoreDirButton_clicked</h4>
244 <b>on_ignoreDirButton_clicked</b>(<i></i>)
245 <p>
246 Private slot to select a directory to be ignored.
247 </p><p>
248 It displays a directory selection dialog to
249 select a directory to be ignored.
250 </p><a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a>
251 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4>
252 <b>on_l1BgButton_clicked</b>(<i></i>)
253 <p>
254 Private slot to select the level 1 header background color.
255 </p><a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a>
256 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4>
257 <b>on_l1FgButton_clicked</b>(<i></i>)
258 <p>
259 Private slot to select the level 1 header foreground color.
260 </p><a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a>
261 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4>
262 <b>on_l2BgButton_clicked</b>(<i></i>)
263 <p>
264 Private slot to select the level 2 header background color.
265 </p><a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a>
266 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4>
267 <b>on_l2FgButton_clicked</b>(<i></i>)
268 <p>
269 Private slot to select the level 2 header foreground color.
270 </p><a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a>
271 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4>
272 <b>on_linkFgButton_clicked</b>(<i></i>)
273 <p>
274 Private slot to select the foreground color of links.
275 </p><a NAME="EricdocConfigDialog.on_outputDirButton_clicked" ID="EricdocConfigDialog.on_outputDirButton_clicked"></a>
276 <h4>EricdocConfigDialog.on_outputDirButton_clicked</h4>
277 <b>on_outputDirButton_clicked</b>(<i></i>)
278 <p>
279 Private slot to select the output directory.
280 </p><p>
281 It displays a directory selection dialog to
282 select the directory the documentations is written to.
283 </p><a NAME="EricdocConfigDialog.on_qtHelpDirButton_clicked" ID="EricdocConfigDialog.on_qtHelpDirButton_clicked"></a>
284 <h4>EricdocConfigDialog.on_qtHelpDirButton_clicked</h4>
285 <b>on_qtHelpDirButton_clicked</b>(<i></i>)
286 <p>
287 Private slot to select the output directory for the QtHelp files.
288 </p><p>
289 It displays a directory selection dialog to
290 select the directory the QtHelp files are written to.
291 </p><a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a>
292 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4>
293 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>)
294 <p>
295 Private slot to check the virtual folder.
296 </p><dl>
297 <dt><i>txt</i></dt>
298 <dd>
299 text of the line edit (string)
300 </dd>
301 </dl><a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a>
302 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4>
303 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>)
304 <p>
305 Private slot to toggle the generation of QtHelp files.
306 </p><dl>
307 <dt><i>enabled</i></dt>
308 <dd>
309 flag indicating the state (boolean)
310 </dd>
311 </dl><a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a>
312 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4>
313 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>)
314 <p>
315 Private slot to check the namespace.
316 </p><dl>
317 <dt><i>txt</i></dt>
318 <dd>
319 text of the line edit (string)
320 </dd>
321 </dl><a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a>
322 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4>
323 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>)
324 <p>
325 Private slot to check the title.
326 </p><dl>
327 <dt><i>txt</i></dt>
328 <dd>
329 text of the line edit (string)
330 </dd>
331 </dl>
332 <div align="right"><a href="#top">Up</a></div>
333 <hr />
334 </body></html>

Mercurial Repository: eric

eric ide

mercurial