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