Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html
Documentation/Source/eric4.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.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.Ericapi.EricapiConfigDialog</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.Ericapi.EricapiConfigDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to enter the parameters for eric4-api. | |
| 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="#EricapiConfigDialog">EricapiConfigDialog</a></td> | |
| 35 <td>Class implementing a dialog to enter the parameters for eric4-api.</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="EricapiConfigDialog" ID="EricapiConfigDialog"></a> | |
| 44 <h2>EricapiConfigDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to enter the parameters for eric4-api. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_EricapiConfigDialog | |
| 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="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 61 <td>Private method to set the default values.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EricapiConfigDialog.accept">accept</a></td> | |
| 64 <td>Protected slot called by the Ok button.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td> | |
| 67 <td>Public method that generates the commandline parameters.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricapiConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 70 <td>Private slot to add the directory displayed to the listview.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EricapiConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 73 <td>Private slot to delete the currently selected directory of the listbox.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EricapiConfigDialog.on_ignoreDirButton_clicked">on_ignoreDirButton_clicked</a></td> | |
| 76 <td>Private slot to select a directory to be ignored.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#EricapiConfigDialog.on_outputFileButton_clicked">on_outputFileButton_clicked</a></td> | |
| 79 <td>Private slot to select the output file.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#EricapiConfigDialog.on_outputFileEdit_textChanged">on_outputFileEdit_textChanged</a></td> | |
| 82 <td>Private slot to enable/disable the "OK" button.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a> | |
| 86 <h4>EricapiConfigDialog (Constructor)</h4> | |
| 87 <b>EricapiConfigDialog</b>(<i>project, parms = None, parent = None</i>) | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p><dl> | |
| 91 <dt><i>project</i></dt> | |
| 92 <dd> | |
| 93 reference to the project object (Project.Project) | |
| 94 </dd><dt><i>parms</i></dt> | |
| 95 <dd> | |
| 96 parameters to set in the dialog | |
| 97 </dd><dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 parent widget of this dialog | |
| 100 </dd> | |
| 101 </dl><a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a> | |
| 102 <h4>EricapiConfigDialog.__initializeDefaults</h4> | |
| 103 <b>__initializeDefaults</b>(<i></i>) | |
| 104 <p> | |
| 105 Private method to set the default values. | |
| 106 </p><p> | |
| 107 These are needed later on to generate the commandline | |
| 108 parameters. | |
| 109 </p><a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a> | |
| 110 <h4>EricapiConfigDialog.accept</h4> | |
| 111 <b>accept</b>(<i></i>) | |
| 112 <p> | |
| 113 Protected slot called by the Ok button. | |
| 114 </p><p> | |
| 115 It saves the values in the parameters dictionary. | |
| 116 </p><a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a> | |
| 117 <h4>EricapiConfigDialog.generateParameters</h4> | |
| 118 <b>generateParameters</b>(<i></i>) | |
| 119 <p> | |
| 120 Public method that generates the commandline parameters. | |
| 121 </p><p> | |
| 122 It generates a list of strings to be used | |
| 123 to set the QProcess arguments for the ericapi call and | |
| 124 a dictionary containing the non default parameters. This | |
| 125 dictionary can be passed back upon object generation to overwrite | |
| 126 the default settings. | |
| 127 </p><dl> | |
| 128 <dt>Returns:</dt> | |
| 129 <dd> | |
| 130 a tuple of the commandline parameters and non default parameters | |
| 131 (list of strings, dictionary) | |
| 132 </dd> | |
| 133 </dl><a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a> | |
| 134 <h4>EricapiConfigDialog.on_addButton_clicked</h4> | |
| 135 <b>on_addButton_clicked</b>(<i></i>) | |
| 136 <p> | |
| 137 Private slot to add the directory displayed to the listview. | |
| 138 </p><p> | |
| 139 The directory in the ignore directories | |
| 140 line edit is moved to the listbox above and the edit is cleared. | |
| 141 </p><a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a> | |
| 142 <h4>EricapiConfigDialog.on_deleteButton_clicked</h4> | |
| 143 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 144 <p> | |
| 145 Private slot to delete the currently selected directory of the listbox. | |
| 146 </p><a NAME="EricapiConfigDialog.on_ignoreDirButton_clicked" ID="EricapiConfigDialog.on_ignoreDirButton_clicked"></a> | |
| 147 <h4>EricapiConfigDialog.on_ignoreDirButton_clicked</h4> | |
| 148 <b>on_ignoreDirButton_clicked</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot to select a directory to be ignored. | |
| 151 </p><p> | |
| 152 It displays a directory selection dialog to | |
| 153 select a directory to be ignored. | |
| 154 </p><a NAME="EricapiConfigDialog.on_outputFileButton_clicked" ID="EricapiConfigDialog.on_outputFileButton_clicked"></a> | |
| 155 <h4>EricapiConfigDialog.on_outputFileButton_clicked</h4> | |
| 156 <b>on_outputFileButton_clicked</b>(<i></i>) | |
| 157 <p> | |
| 158 Private slot to select the output file. | |
| 159 </p><p> | |
| 160 It displays a file selection dialog to | |
| 161 select the file the api is written to. | |
| 162 </p><a NAME="EricapiConfigDialog.on_outputFileEdit_textChanged" ID="EricapiConfigDialog.on_outputFileEdit_textChanged"></a> | |
| 163 <h4>EricapiConfigDialog.on_outputFileEdit_textChanged</h4> | |
| 164 <b>on_outputFileEdit_textChanged</b>(<i>filename</i>) | |
| 165 <p> | |
| 166 Private slot to enable/disable the "OK" button. | |
| 167 </p><dl> | |
| 168 <dt><i>filename</i></dt> | |
| 169 <dd> | |
| 170 name of the file (string) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <div align="right"><a href="#top">Up</a></div> | |
| 174 <hr /> | |
| 175 </body></html> |
