Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html
src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9016
- 6f079c524e99
- child 9212
- 1c5cf2022c7e
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the parameters for eric7_api. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#EricapiConfigDialog">EricapiConfigDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the parameters for eric7_api.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="EricapiConfigDialog" ID="EricapiConfigDialog"></a> | |
| 36 <h2>EricapiConfigDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the parameters for eric7_api. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_EricapiConfigDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 63 <td>Private method to set the default values.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EricapiConfigDialog.accept">accept</a></td> | |
| 67 <td>Public slot called by the Ok button.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td> | |
| 71 <td>Public method that generates the command line parameters.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EricapiConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 75 <td>Private slot to add the directory displayed to the listview.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EricapiConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 79 <td>Private slot to delete the currently selected directory of the listbox.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EricapiConfigDialog.on_ignoreDirPicker_pathSelected">on_ignoreDirPicker_pathSelected</a></td> | |
| 83 <td>Private slot handling the selection of a directory to be ignored.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog">on_outputFilePicker_aboutToShowPathPickerDialog</a></td> | |
| 87 <td>Private slot called before the file selection dialog is shown.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#EricapiConfigDialog.on_outputFilePicker_pathSelected">on_outputFilePicker_pathSelected</a></td> | |
| 91 <td>Private slot handling the selection of an output file.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#EricapiConfigDialog.on_outputFilePicker_textChanged">on_outputFilePicker_textChanged</a></td> | |
| 95 <td>Private slot to enable/disable the "OK" button.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a> | |
| 105 <h4>EricapiConfigDialog (Constructor)</h4> | |
| 106 <b>EricapiConfigDialog</b>(<i>project, parms=None, parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>project</i></dt> | |
| 114 <dd> | |
| 115 reference to the project object (Project.Project) | |
| 116 </dd> | |
| 117 <dt><i>parms</i></dt> | |
| 118 <dd> | |
| 119 parameters to set in the dialog | |
| 120 </dd> | |
| 121 <dt><i>parent</i></dt> | |
| 122 <dd> | |
| 123 parent widget of this dialog | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a> | |
| 127 <h4>EricapiConfigDialog.__initializeDefaults</h4> | |
| 128 <b>__initializeDefaults</b>(<i></i>) | |
| 129 | |
| 130 <p> | |
| 131 Private method to set the default values. | |
| 132 </p> | |
| 133 <p> | |
| 134 These are needed later on to generate the commandline | |
| 135 parameters. | |
| 136 </p> | |
| 137 <a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a> | |
| 138 <h4>EricapiConfigDialog.accept</h4> | |
| 139 <b>accept</b>(<i></i>) | |
| 140 | |
| 141 <p> | |
| 142 Public slot called by the Ok button. | |
| 143 </p> | |
| 144 <p> | |
| 145 It saves the values in the parameters dictionary. | |
| 146 </p> | |
| 147 <a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a> | |
| 148 <h4>EricapiConfigDialog.generateParameters</h4> | |
| 149 <b>generateParameters</b>(<i></i>) | |
| 150 | |
| 151 <p> | |
| 152 Public method that generates the command line parameters. | |
| 153 </p> | |
| 154 <p> | |
| 155 It generates a list of strings to be used | |
| 156 to set the QProcess arguments for the ericapi call and | |
| 157 a dictionary containing the non default parameters. This | |
| 158 dictionary can be passed back upon object generation to overwrite | |
| 159 the default settings. | |
| 160 </p> | |
| 161 <dl> | |
| 162 <dt>Return:</dt> | |
| 163 <dd> | |
| 164 a tuple of the commandline parameters and non default | |
| 165 parameters (list of strings, dictionary) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a> | |
| 169 <h4>EricapiConfigDialog.on_addButton_clicked</h4> | |
| 170 <b>on_addButton_clicked</b>(<i></i>) | |
| 171 | |
| 172 <p> | |
| 173 Private slot to add the directory displayed to the listview. | |
| 174 </p> | |
| 175 <p> | |
| 176 The directory in the ignore directories | |
| 177 line edit is moved to the listbox above and the edit is cleared. | |
| 178 </p> | |
| 179 <a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a> | |
| 180 <h4>EricapiConfigDialog.on_deleteButton_clicked</h4> | |
| 181 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 182 | |
| 183 <p> | |
| 184 Private slot to delete the currently selected directory of the listbox. | |
| 185 </p> | |
| 186 <a NAME="EricapiConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricapiConfigDialog.on_ignoreDirPicker_pathSelected"></a> | |
| 187 <h4>EricapiConfigDialog.on_ignoreDirPicker_pathSelected</h4> | |
| 188 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>) | |
| 189 | |
| 190 <p> | |
| 191 Private slot handling the selection of a directory to be ignored. | |
| 192 </p> | |
| 193 <dl> | |
| 194 | |
| 195 <dt><i>path</i> (str)</dt> | |
| 196 <dd> | |
| 197 path of the directory to be ignored | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog" ID="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog"></a> | |
| 201 <h4>EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog</h4> | |
| 202 <b>on_outputFilePicker_aboutToShowPathPickerDialog</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private slot called before the file selection dialog is shown. | |
| 206 </p> | |
| 207 <a NAME="EricapiConfigDialog.on_outputFilePicker_pathSelected" ID="EricapiConfigDialog.on_outputFilePicker_pathSelected"></a> | |
| 208 <h4>EricapiConfigDialog.on_outputFilePicker_pathSelected</h4> | |
| 209 <b>on_outputFilePicker_pathSelected</b>(<i>path</i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot handling the selection of an output file. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>path</i> (str)</dt> | |
| 217 <dd> | |
| 218 path of the output file | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <a NAME="EricapiConfigDialog.on_outputFilePicker_textChanged" ID="EricapiConfigDialog.on_outputFilePicker_textChanged"></a> | |
| 222 <h4>EricapiConfigDialog.on_outputFilePicker_textChanged</h4> | |
| 223 <b>on_outputFilePicker_textChanged</b>(<i>filename</i>) | |
| 224 | |
| 225 <p> | |
| 226 Private slot to enable/disable the "OK" button. | |
| 227 </p> | |
| 228 <dl> | |
| 229 | |
| 230 <dt><i>filename</i></dt> | |
| 231 <dd> | |
| 232 name of the file (string) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <div align="right"><a href="#top">Up</a></div> | |
| 236 <hr /> | |
| 237 </body></html> |
