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 6942
- 2602857055c5
- parent 4602
- 48cc4820e2c2
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the parameters for eric6_api. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#EricapiConfigDialog">EricapiConfigDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter the parameters for eric6_api.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="EricapiConfigDialog" ID="EricapiConfigDialog"></a> | |
| 43 <h2>EricapiConfigDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter the parameters for eric6_api. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_EricapiConfigDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 64 <td>Private method to set the default values.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricapiConfigDialog.accept">accept</a></td> | |
| 67 <td>Public slot called by the Ok button.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td> | |
| 70 <td>Public method that generates the commandline parameters.</td> | |
| 71 </tr><tr> | |
| 72 <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> | |
| 74 </tr><tr> | |
| 75 <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> | |
| 77 </tr><tr> | |
| 78 <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> | |
| 80 </tr><tr> | |
| 81 <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> | |
| 83 </tr><tr> | |
| 84 <td><a href="#EricapiConfigDialog.on_outputFilePicker_pathSelected">on_outputFilePicker_pathSelected</a></td> | |
| 85 <td>Private slot handling the selection of an output file.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#EricapiConfigDialog.on_outputFilePicker_textChanged">on_outputFilePicker_textChanged</a></td> | |
| 88 <td>Private slot to enable/disable the "OK" button.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a> | |
| 96 <h4>EricapiConfigDialog (Constructor)</h4> | |
| 97 <b>EricapiConfigDialog</b>(<i>project, parms=None, parent=None</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>project</i></dt> | |
| 102 <dd> | |
| 103 reference to the project object (Project.Project) | |
| 104 </dd><dt><i>parms</i></dt> | |
| 105 <dd> | |
| 106 parameters to set in the dialog | |
| 107 </dd><dt><i>parent</i></dt> | |
| 108 <dd> | |
| 109 parent widget of this dialog | |
| 110 </dd> | |
| 111 </dl><a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a> | |
| 112 <h4>EricapiConfigDialog.__initializeDefaults</h4> | |
| 113 <b>__initializeDefaults</b>(<i></i>) | |
| 114 <p> | |
| 115 Private method to set the default values. | |
| 116 </p><p> | |
| 117 These are needed later on to generate the commandline | |
| 118 parameters. | |
| 119 </p><a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a> | |
| 120 <h4>EricapiConfigDialog.accept</h4> | |
| 121 <b>accept</b>(<i></i>) | |
| 122 <p> | |
| 123 Public slot called by the Ok button. | |
| 124 </p><p> | |
| 125 It saves the values in the parameters dictionary. | |
| 126 </p><a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a> | |
| 127 <h4>EricapiConfigDialog.generateParameters</h4> | |
| 128 <b>generateParameters</b>(<i></i>) | |
| 129 <p> | |
| 130 Public method that generates the commandline parameters. | |
| 131 </p><p> | |
| 132 It generates a list of strings to be used | |
| 133 to set the QProcess arguments for the ericapi call and | |
| 134 a dictionary containing the non default parameters. This | |
| 135 dictionary can be passed back upon object generation to overwrite | |
| 136 the default settings. | |
| 137 </p><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 a tuple of the commandline parameters and non default | |
| 141 parameters (list of strings, dictionary) | |
| 142 </dd> | |
| 143 </dl><a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a> | |
| 144 <h4>EricapiConfigDialog.on_addButton_clicked</h4> | |
| 145 <b>on_addButton_clicked</b>(<i></i>) | |
| 146 <p> | |
| 147 Private slot to add the directory displayed to the listview. | |
| 148 </p><p> | |
| 149 The directory in the ignore directories | |
| 150 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> | |
| 152 <h4>EricapiConfigDialog.on_deleteButton_clicked</h4> | |
| 153 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 154 <p> | |
| 155 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> | |
| 157 <h4>EricapiConfigDialog.on_ignoreDirPicker_pathSelected</h4> | |
| 158 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>) | |
| 159 <p> | |
| 160 Private slot handling the selection of a directory to be ignored. | |
| 161 </p><dl> | |
| 162 <dt><i>path</i> (str)</dt> | |
| 163 <dd> | |
| 164 path of the directory to be ignored | |
| 165 </dd> | |
| 166 </dl><a NAME="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog" ID="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog"></a> | |
| 167 <h4>EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog</h4> | |
| 168 <b>on_outputFilePicker_aboutToShowPathPickerDialog</b>(<i></i>) | |
| 169 <p> | |
| 170 Private slot called before the file selection dialog is shown. | |
| 171 </p><a NAME="EricapiConfigDialog.on_outputFilePicker_pathSelected" ID="EricapiConfigDialog.on_outputFilePicker_pathSelected"></a> | |
| 172 <h4>EricapiConfigDialog.on_outputFilePicker_pathSelected</h4> | |
| 173 <b>on_outputFilePicker_pathSelected</b>(<i>path</i>) | |
| 174 <p> | |
| 175 Private slot handling the selection of an output file. | |
| 176 </p><dl> | |
| 177 <dt><i>path</i> (str)</dt> | |
| 178 <dd> | |
| 179 path of the output file | |
| 180 </dd> | |
| 181 </dl><a NAME="EricapiConfigDialog.on_outputFilePicker_textChanged" ID="EricapiConfigDialog.on_outputFilePicker_textChanged"></a> | |
| 182 <h4>EricapiConfigDialog.on_outputFilePicker_textChanged</h4> | |
| 183 <b>on_outputFilePicker_textChanged</b>(<i>filename</i>) | |
| 184 <p> | |
| 185 Private slot to enable/disable the "OK" button. | |
| 186 </p><dl> | |
| 187 <dt><i>filename</i></dt> | |
| 188 <dd> | |
| 189 name of the file (string) | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <div align="right"><a href="#top">Up</a></div> | |
| 193 <hr /> | |
| 194 </body></html> |
