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