Mercurial Repositories > eric / file revision
Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html@b88a0e6268bd
Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html
Wed, 06 Jan 2010 18:14:15 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Wed, 06 Jan 2010 18:14:15 +0000
- changeset 21
- b88a0e6268bd
- parent 17
- edde1fe80b3e
- child 58
- 37f0444c3479
- permissions
- -rw-r--r--
Fixed a bug in eric5-doc.py and regenerated docu.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</title> <style> body { background:white; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #4FA4FF; } h2 { color: white; background: #4FA4FF; } h3 { color: white; background: #00557F; } h4 { color: white; background: #00557F; } a { color: #AA5500; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</h1> <p> Module implementing a dialog to enter the parameters for eric5-api. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#EricapiConfigDialog">EricapiConfigDialog</a></td> <td>Class implementing a dialog to enter the parameters for eric5-api.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="EricapiConfigDialog" ID="EricapiConfigDialog"></a> <h2>EricapiConfigDialog</h2> <p> Class implementing a dialog to enter the parameters for eric5-api. </p> <h3>Derived from</h3> QDialog, Ui_EricapiConfigDialog <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td> <td>Constructor</td> </tr><tr> <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td> <td>Private method to set the default values.</td> </tr><tr> <td><a href="#EricapiConfigDialog.accept">accept</a></td> <td>Protected slot called by the Ok button.</td> </tr><tr> <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td> <td>Public method that generates the commandline parameters.</td> </tr><tr> <td><a href="#EricapiConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td> <td>Private slot to add the directory displayed to the listview.</td> </tr><tr> <td><a href="#EricapiConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> <td>Private slot to delete the currently selected directory of the listbox.</td> </tr><tr> <td><a href="#EricapiConfigDialog.on_ignoreDirButton_clicked">on_ignoreDirButton_clicked</a></td> <td>Private slot to select a directory to be ignored.</td> </tr><tr> <td><a href="#EricapiConfigDialog.on_outputFileButton_clicked">on_outputFileButton_clicked</a></td> <td>Private slot to select the output file.</td> </tr><tr> <td><a href="#EricapiConfigDialog.on_outputFileEdit_textChanged">on_outputFileEdit_textChanged</a></td> <td>Private slot to enable/disable the "OK" button.</td> </tr> </table> <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a> <h4>EricapiConfigDialog (Constructor)</h4> <b>EricapiConfigDialog</b>(<i>project, parms = None, parent = None</i>) <p> Constructor </p><dl> <dt><i>project</i></dt> <dd> reference to the project object (Project.Project) </dd><dt><i>parms</i></dt> <dd> parameters to set in the dialog </dd><dt><i>parent</i></dt> <dd> parent widget of this dialog </dd> </dl><a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a> <h4>EricapiConfigDialog.__initializeDefaults</h4> <b>__initializeDefaults</b>(<i></i>) <p> Private method to set the default values. </p><p> These are needed later on to generate the commandline parameters. </p><a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a> <h4>EricapiConfigDialog.accept</h4> <b>accept</b>(<i></i>) <p> Protected slot called by the Ok button. </p><p> It saves the values in the parameters dictionary. </p><a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a> <h4>EricapiConfigDialog.generateParameters</h4> <b>generateParameters</b>(<i></i>) <p> Public method that generates the commandline parameters. </p><p> It generates a list of strings to be used to set the QProcess arguments for the ericapi call and a dictionary containing the non default parameters. This dictionary can be passed back upon object generation to overwrite the default settings. </p><dl> <dt>Returns:</dt> <dd> a tuple of the commandline parameters and non default parameters (list of strings, dictionary) </dd> </dl><a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a> <h4>EricapiConfigDialog.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) <p> Private slot to add the directory displayed to the listview. </p><p> The directory in the ignore directories line edit is moved to the listbox above and the edit is cleared. </p><a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a> <h4>EricapiConfigDialog.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) <p> Private slot to delete the currently selected directory of the listbox. </p><a NAME="EricapiConfigDialog.on_ignoreDirButton_clicked" ID="EricapiConfigDialog.on_ignoreDirButton_clicked"></a> <h4>EricapiConfigDialog.on_ignoreDirButton_clicked</h4> <b>on_ignoreDirButton_clicked</b>(<i></i>) <p> Private slot to select a directory to be ignored. </p><p> It displays a directory selection dialog to select a directory to be ignored. </p><a NAME="EricapiConfigDialog.on_outputFileButton_clicked" ID="EricapiConfigDialog.on_outputFileButton_clicked"></a> <h4>EricapiConfigDialog.on_outputFileButton_clicked</h4> <b>on_outputFileButton_clicked</b>(<i></i>) <p> Private slot to select the output file. </p><p> It displays a file selection dialog to select the file the api is written to. </p><a NAME="EricapiConfigDialog.on_outputFileEdit_textChanged" ID="EricapiConfigDialog.on_outputFileEdit_textChanged"></a> <h4>EricapiConfigDialog.on_outputFileEdit_textChanged</h4> <b>on_outputFileEdit_textChanged</b>(<i>filename</i>) <p> Private slot to enable/disable the "OK" button. </p><dl> <dt><i>filename</i></dt> <dd> name of the file (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
