Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial