Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html
src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10437
- 2f70ca07f0af
- child 10690
- fab36645aa7d
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1> | 9 <h1>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to enter the parameters for eric7_doc. | 11 Module implementing a dialog to enter the parameters for eric7_doc. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td> | 22 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td> |
| 25 <td>Class implementing a dialog to enter the parameters for eric7_doc.</td> | 23 <td>Class implementing a dialog to enter the parameters for eric7_doc.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a> | 34 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a> |
| 36 <h2>EricdocConfigDialog</h2> | 35 <h2>EricdocConfigDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to enter the parameters for eric7_doc. | 37 Class implementing a dialog to enter the parameters for eric7_doc. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_EricdocConfigDialog | 41 QDialog, Ui_EricdocConfigDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>None</td></tr> | 44 <tr><td>None</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td> | 55 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 157 <tr> | 154 <tr> |
| 158 <td><a href="#EricdocConfigDialog.on_startDirPicker_pathSelected">on_startDirPicker_pathSelected</a></td> | 155 <td><a href="#EricdocConfigDialog.on_startDirPicker_pathSelected">on_startDirPicker_pathSelected</a></td> |
| 159 <td>Private slot handling the selection of a start directory.</td> | 156 <td>Private slot handling the selection of a start directory.</td> |
| 160 </tr> | 157 </tr> |
| 161 </table> | 158 </table> |
| 159 | |
| 162 <h3>Static Methods</h3> | 160 <h3>Static Methods</h3> |
| 163 | |
| 164 <table> | 161 <table> |
| 165 <tr><td>None</td></tr> | 162 <tr><td>None</td></tr> |
| 166 </table> | 163 </table> |
| 164 | |
| 167 | 165 |
| 168 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a> | 166 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a> |
| 169 <h4>EricdocConfigDialog (Constructor)</h4> | 167 <h4>EricdocConfigDialog (Constructor)</h4> |
| 170 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>) | 168 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>) |
| 171 | |
| 172 <p> | 169 <p> |
| 173 Constructor | 170 Constructor |
| 174 </p> | 171 </p> |
| 172 | |
| 175 <dl> | 173 <dl> |
| 176 | 174 |
| 177 <dt><i>project</i> (Project)</dt> | 175 <dt><i>project</i> (Project)</dt> |
| 178 <dd> | 176 <dd> |
| 179 reference to the project object | 177 reference to the project object |
| 188 </dd> | 186 </dd> |
| 189 </dl> | 187 </dl> |
| 190 <a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a> | 188 <a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a> |
| 191 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4> | 189 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4> |
| 192 <b>__checkQtHelpOptions</b>(<i></i>) | 190 <b>__checkQtHelpOptions</b>(<i></i>) |
| 193 | |
| 194 <p> | 191 <p> |
| 195 Private slot to check the QtHelp options and set the ok button | 192 Private slot to check the QtHelp options and set the ok button |
| 196 accordingly. | 193 accordingly. |
| 197 </p> | 194 </p> |
| 195 | |
| 198 <a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a> | 196 <a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a> |
| 199 <h4>EricdocConfigDialog.__initializeDefaults</h4> | 197 <h4>EricdocConfigDialog.__initializeDefaults</h4> |
| 200 <b>__initializeDefaults</b>(<i></i>) | 198 <b>__initializeDefaults</b>(<i></i>) |
| 201 | |
| 202 <p> | 199 <p> |
| 203 Private method to set the default values. | 200 Private method to set the default values. |
| 204 </p> | 201 </p> |
| 205 <p> | 202 <p> |
| 206 These are needed later on to generate the commandline | 203 These are needed later on to generate the commandline |
| 207 parameters. | 204 parameters. |
| 208 </p> | 205 </p> |
| 206 | |
| 209 <a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a> | 207 <a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a> |
| 210 <h4>EricdocConfigDialog.__selectColor</h4> | 208 <h4>EricdocConfigDialog.__selectColor</h4> |
| 211 <b>__selectColor</b>(<i>colorKey</i>) | 209 <b>__selectColor</b>(<i>colorKey</i>) |
| 212 | |
| 213 <p> | 210 <p> |
| 214 Private method to select a color. | 211 Private method to select a color. |
| 215 </p> | 212 </p> |
| 213 | |
| 216 <dl> | 214 <dl> |
| 217 | 215 |
| 218 <dt><i>colorKey</i> (str)</dt> | 216 <dt><i>colorKey</i> (str)</dt> |
| 219 <dd> | 217 <dd> |
| 220 key of the color to select | 218 key of the color to select |
| 221 </dd> | 219 </dd> |
| 222 </dl> | 220 </dl> |
| 223 <a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a> | 221 <a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a> |
| 224 <h4>EricdocConfigDialog.accept</h4> | 222 <h4>EricdocConfigDialog.accept</h4> |
| 225 <b>accept</b>(<i></i>) | 223 <b>accept</b>(<i></i>) |
| 226 | |
| 227 <p> | 224 <p> |
| 228 Public slot called by the Ok button. | 225 Public slot called by the Ok button. |
| 229 </p> | 226 </p> |
| 230 <p> | 227 <p> |
| 231 It saves the values in the parameters dictionary. | 228 It saves the values in the parameters dictionary. |
| 232 </p> | 229 </p> |
| 230 | |
| 233 <a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a> | 231 <a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a> |
| 234 <h4>EricdocConfigDialog.generateParameters</h4> | 232 <h4>EricdocConfigDialog.generateParameters</h4> |
| 235 <b>generateParameters</b>(<i></i>) | 233 <b>generateParameters</b>(<i></i>) |
| 236 | |
| 237 <p> | 234 <p> |
| 238 Public method that generates the commandline parameters. | 235 Public method that generates the commandline parameters. |
| 239 </p> | 236 </p> |
| 240 <p> | 237 <p> |
| 241 It generates a list of strings to be used | 238 It generates a list of strings to be used |
| 242 to set the QProcess arguments for the ericdoc call and | 239 to set the QProcess arguments for the ericdoc call and |
| 243 a dictionary containing the non default parameters. This | 240 a dictionary containing the non default parameters. This |
| 244 dictionary can be passed back upon object generation to overwrite | 241 dictionary can be passed back upon object generation to overwrite |
| 245 the default settings. | 242 the default settings. |
| 246 </p> | 243 </p> |
| 244 | |
| 247 <dl> | 245 <dl> |
| 248 <dt>Return:</dt> | 246 <dt>Return:</dt> |
| 249 <dd> | 247 <dd> |
| 250 a tuple containing the commandline parameters, non default | 248 a tuple containing the commandline parameters, non default |
| 251 parameters and the start directory | 249 parameters and the start directory |
| 258 </dd> | 256 </dd> |
| 259 </dl> | 257 </dl> |
| 260 <a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a> | 258 <a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a> |
| 261 <h4>EricdocConfigDialog.on_addButton_clicked</h4> | 259 <h4>EricdocConfigDialog.on_addButton_clicked</h4> |
| 262 <b>on_addButton_clicked</b>(<i></i>) | 260 <b>on_addButton_clicked</b>(<i></i>) |
| 263 | |
| 264 <p> | 261 <p> |
| 265 Private slot to add the directory displayed to the listview. | 262 Private slot to add the directory displayed to the listview. |
| 266 </p> | 263 </p> |
| 267 <p> | 264 <p> |
| 268 The directory in the ignore directories | 265 The directory in the ignore directories |
| 269 line edit is moved to the listbox above and the edit is cleared. | 266 line edit is moved to the listbox above and the edit is cleared. |
| 270 </p> | 267 </p> |
| 268 | |
| 271 <a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a> | 269 <a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a> |
| 272 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4> | 270 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4> |
| 273 <b>on_bodyBgButton_clicked</b>(<i></i>) | 271 <b>on_bodyBgButton_clicked</b>(<i></i>) |
| 274 | |
| 275 <p> | 272 <p> |
| 276 Private slot to select the body background color. | 273 Private slot to select the body background color. |
| 277 </p> | 274 </p> |
| 275 | |
| 278 <a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a> | 276 <a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a> |
| 279 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4> | 277 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4> |
| 280 <b>on_bodyFgButton_clicked</b>(<i></i>) | 278 <b>on_bodyFgButton_clicked</b>(<i></i>) |
| 281 | |
| 282 <p> | 279 <p> |
| 283 Private slot to select the body foreground color. | 280 Private slot to select the body foreground color. |
| 284 </p> | 281 </p> |
| 282 | |
| 285 <a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a> | 283 <a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a> |
| 286 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4> | 284 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4> |
| 287 <b>on_cfBgButton_clicked</b>(<i></i>) | 285 <b>on_cfBgButton_clicked</b>(<i></i>) |
| 288 | |
| 289 <p> | 286 <p> |
| 290 Private slot to select the class/function header background color. | 287 Private slot to select the class/function header background color. |
| 291 </p> | 288 </p> |
| 289 | |
| 292 <a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a> | 290 <a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a> |
| 293 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4> | 291 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4> |
| 294 <b>on_cfFgButton_clicked</b>(<i></i>) | 292 <b>on_cfFgButton_clicked</b>(<i></i>) |
| 295 | |
| 296 <p> | 293 <p> |
| 297 Private slot to select the class/function header foreground color. | 294 Private slot to select the class/function header foreground color. |
| 298 </p> | 295 </p> |
| 296 | |
| 299 <a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a> | 297 <a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a> |
| 300 <h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4> | 298 <h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4> |
| 301 <b>on_cssPicker_pathSelected</b>(<i>path</i>) | 299 <b>on_cssPicker_pathSelected</b>(<i>path</i>) |
| 302 | |
| 303 <p> | 300 <p> |
| 304 Private slot handling the selection of a css style sheet. | 301 Private slot handling the selection of a css style sheet. |
| 305 </p> | 302 </p> |
| 303 | |
| 306 <dl> | 304 <dl> |
| 307 | 305 |
| 308 <dt><i>path</i> (str)</dt> | 306 <dt><i>path</i> (str)</dt> |
| 309 <dd> | 307 <dd> |
| 310 path of the css style sheet | 308 path of the css style sheet |
| 311 </dd> | 309 </dd> |
| 312 </dl> | 310 </dl> |
| 313 <a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a> | 311 <a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a> |
| 314 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4> | 312 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4> |
| 315 <b>on_deleteButton_clicked</b>(<i></i>) | 313 <b>on_deleteButton_clicked</b>(<i></i>) |
| 316 | |
| 317 <p> | 314 <p> |
| 318 Private slot to delete the currently selected directory of the listbox. | 315 Private slot to delete the currently selected directory of the listbox. |
| 319 </p> | 316 </p> |
| 317 | |
| 320 <a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a> | 318 <a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a> |
| 321 <h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4> | 319 <h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4> |
| 322 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>) | 320 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>) |
| 323 | |
| 324 <p> | 321 <p> |
| 325 Private slot handling the selection of a directory to be ignored. | 322 Private slot handling the selection of a directory to be ignored. |
| 326 </p> | 323 </p> |
| 324 | |
| 327 <dl> | 325 <dl> |
| 328 | 326 |
| 329 <dt><i>path</i> (str)</dt> | 327 <dt><i>path</i> (str)</dt> |
| 330 <dd> | 328 <dd> |
| 331 path of the directory to be ignored | 329 path of the directory to be ignored |
| 332 </dd> | 330 </dd> |
| 333 </dl> | 331 </dl> |
| 334 <a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a> | 332 <a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a> |
| 335 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4> | 333 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4> |
| 336 <b>on_l1BgButton_clicked</b>(<i></i>) | 334 <b>on_l1BgButton_clicked</b>(<i></i>) |
| 337 | |
| 338 <p> | 335 <p> |
| 339 Private slot to select the level 1 header background color. | 336 Private slot to select the level 1 header background color. |
| 340 </p> | 337 </p> |
| 338 | |
| 341 <a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a> | 339 <a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a> |
| 342 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4> | 340 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4> |
| 343 <b>on_l1FgButton_clicked</b>(<i></i>) | 341 <b>on_l1FgButton_clicked</b>(<i></i>) |
| 344 | |
| 345 <p> | 342 <p> |
| 346 Private slot to select the level 1 header foreground color. | 343 Private slot to select the level 1 header foreground color. |
| 347 </p> | 344 </p> |
| 345 | |
| 348 <a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a> | 346 <a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a> |
| 349 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4> | 347 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4> |
| 350 <b>on_l2BgButton_clicked</b>(<i></i>) | 348 <b>on_l2BgButton_clicked</b>(<i></i>) |
| 351 | |
| 352 <p> | 349 <p> |
| 353 Private slot to select the level 2 header background color. | 350 Private slot to select the level 2 header background color. |
| 354 </p> | 351 </p> |
| 352 | |
| 355 <a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a> | 353 <a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a> |
| 356 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4> | 354 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4> |
| 357 <b>on_l2FgButton_clicked</b>(<i></i>) | 355 <b>on_l2FgButton_clicked</b>(<i></i>) |
| 358 | |
| 359 <p> | 356 <p> |
| 360 Private slot to select the level 2 header foreground color. | 357 Private slot to select the level 2 header foreground color. |
| 361 </p> | 358 </p> |
| 359 | |
| 362 <a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a> | 360 <a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a> |
| 363 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4> | 361 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4> |
| 364 <b>on_linkFgButton_clicked</b>(<i></i>) | 362 <b>on_linkFgButton_clicked</b>(<i></i>) |
| 365 | |
| 366 <p> | 363 <p> |
| 367 Private slot to select the foreground color of links. | 364 Private slot to select the foreground color of links. |
| 368 </p> | 365 </p> |
| 366 | |
| 369 <a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a> | 367 <a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a> |
| 370 <h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4> | 368 <h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4> |
| 371 <b>on_outputDirPicker_pathSelected</b>(<i>path</i>) | 369 <b>on_outputDirPicker_pathSelected</b>(<i>path</i>) |
| 372 | |
| 373 <p> | 370 <p> |
| 374 Private slot handling the selection of an output directory. | 371 Private slot handling the selection of an output directory. |
| 375 </p> | 372 </p> |
| 373 | |
| 376 <dl> | 374 <dl> |
| 377 | 375 |
| 378 <dt><i>path</i> (str)</dt> | 376 <dt><i>path</i> (str)</dt> |
| 379 <dd> | 377 <dd> |
| 380 path of the output directory | 378 path of the output directory |
| 381 </dd> | 379 </dd> |
| 382 </dl> | 380 </dl> |
| 383 <a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a> | 381 <a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a> |
| 384 <h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4> | 382 <h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4> |
| 385 <b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>) | 383 <b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>) |
| 386 | |
| 387 <p> | 384 <p> |
| 388 Private slot handling the selection of the output directory for the | 385 Private slot handling the selection of the output directory for the |
| 389 QtHelp files. | 386 QtHelp files. |
| 390 </p> | 387 </p> |
| 388 | |
| 391 <dl> | 389 <dl> |
| 392 | 390 |
| 393 <dt><i>path</i> (str)</dt> | 391 <dt><i>path</i> (str)</dt> |
| 394 <dd> | 392 <dd> |
| 395 path of the the output directory for the QtHelp files | 393 path of the the output directory for the QtHelp files |
| 396 </dd> | 394 </dd> |
| 397 </dl> | 395 </dl> |
| 398 <a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a> | 396 <a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a> |
| 399 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4> | 397 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4> |
| 400 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>) | 398 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>) |
| 401 | |
| 402 <p> | 399 <p> |
| 403 Private slot to check the virtual folder. | 400 Private slot to check the virtual folder. |
| 404 </p> | 401 </p> |
| 402 | |
| 405 <dl> | 403 <dl> |
| 406 | 404 |
| 407 <dt><i>txt</i> (str)</dt> | 405 <dt><i>txt</i> (str)</dt> |
| 408 <dd> | 406 <dd> |
| 409 text of the line edit | 407 text of the line edit |
| 410 </dd> | 408 </dd> |
| 411 </dl> | 409 </dl> |
| 412 <a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a> | 410 <a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a> |
| 413 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4> | 411 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4> |
| 414 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>) | 412 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>) |
| 415 | |
| 416 <p> | 413 <p> |
| 417 Private slot to toggle the generation of QtHelp files. | 414 Private slot to toggle the generation of QtHelp files. |
| 418 </p> | 415 </p> |
| 416 | |
| 419 <dl> | 417 <dl> |
| 420 | 418 |
| 421 <dt><i>enabled</i> (bool)</dt> | 419 <dt><i>enabled</i> (bool)</dt> |
| 422 <dd> | 420 <dd> |
| 423 flag indicating the state | 421 flag indicating the state |
| 424 </dd> | 422 </dd> |
| 425 </dl> | 423 </dl> |
| 426 <a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a> | 424 <a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a> |
| 427 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4> | 425 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4> |
| 428 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>) | 426 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>) |
| 429 | |
| 430 <p> | 427 <p> |
| 431 Private slot to check the namespace. | 428 Private slot to check the namespace. |
| 432 </p> | 429 </p> |
| 430 | |
| 433 <dl> | 431 <dl> |
| 434 | 432 |
| 435 <dt><i>txt</i> (str)</dt> | 433 <dt><i>txt</i> (str)</dt> |
| 436 <dd> | 434 <dd> |
| 437 text of the line edit | 435 text of the line edit |
| 438 </dd> | 436 </dd> |
| 439 </dl> | 437 </dl> |
| 440 <a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a> | 438 <a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a> |
| 441 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4> | 439 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4> |
| 442 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>) | 440 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>) |
| 443 | |
| 444 <p> | 441 <p> |
| 445 Private slot to check the title. | 442 Private slot to check the title. |
| 446 </p> | 443 </p> |
| 444 | |
| 447 <dl> | 445 <dl> |
| 448 | 446 |
| 449 <dt><i>txt</i> (str)</dt> | 447 <dt><i>txt</i> (str)</dt> |
| 450 <dd> | 448 <dd> |
| 451 text of the line edit | 449 text of the line edit |
| 452 </dd> | 450 </dd> |
| 453 </dl> | 451 </dl> |
| 454 <a NAME="EricdocConfigDialog.on_startDirPicker_pathSelected" ID="EricdocConfigDialog.on_startDirPicker_pathSelected"></a> | 452 <a NAME="EricdocConfigDialog.on_startDirPicker_pathSelected" ID="EricdocConfigDialog.on_startDirPicker_pathSelected"></a> |
| 455 <h4>EricdocConfigDialog.on_startDirPicker_pathSelected</h4> | 453 <h4>EricdocConfigDialog.on_startDirPicker_pathSelected</h4> |
| 456 <b>on_startDirPicker_pathSelected</b>(<i>path</i>) | 454 <b>on_startDirPicker_pathSelected</b>(<i>path</i>) |
| 457 | |
| 458 <p> | 455 <p> |
| 459 Private slot handling the selection of a start directory. | 456 Private slot handling the selection of a start directory. |
| 460 </p> | 457 </p> |
| 458 | |
| 461 <dl> | 459 <dl> |
| 462 | 460 |
| 463 <dt><i>path</i> (str)</dt> | 461 <dt><i>path</i> (str)</dt> |
| 464 <dd> | 462 <dd> |
| 465 path of the start directory | 463 path of the start directory |
