Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog.html
- branch
- eric7
- changeset 9756
- 9854647c8c5c
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9755:1a09700229e7 | 9756:9854647c8c5c |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</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.MicroPython.Devices.CircuitPythonUpdater.RequirementsDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to generate a requirements file. | |
| 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="#RequirementsDialog">RequirementsDialog</a></td> | |
| 25 <td>Class implementing a dialog to generate a requirements file.</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="RequirementsDialog" ID="RequirementsDialog"></a> | |
| 36 <h2>RequirementsDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to generate a requirements file. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_RequirementsDialog | |
| 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="#RequirementsDialog.__init__">RequirementsDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#RequirementsDialog.__generateRequirements">__generateRequirements</a></td> | |
| 63 <td>Private slot to generate the requirements specifiers list.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#RequirementsDialog.__updateButtons">__updateButtons</a></td> | |
| 67 <td>Private method to set the state of the various buttons.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#RequirementsDialog.__writeToFile">__writeToFile</a></td> | |
| 71 <td>Private method to write the requirements text to a file.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#RequirementsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 75 <td>Private slot called by a button of the button box clicked.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#RequirementsDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> | |
| 79 <td>Private slot to copy the requirements text to the clipboard.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#RequirementsDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> | |
| 83 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#RequirementsDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> | |
| 87 <td>Private slot to replace the text of the current editor with the requirements text.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#RequirementsDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> | |
| 91 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#RequirementsDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> | |
| 95 <td>Private slot handling changes of the requirements text.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#RequirementsDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> | |
| 99 <td>Private slot handling a change of the requirements file name.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#RequirementsDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 103 <td>Private slot to save the requirements text to the requirements file.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#RequirementsDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> | |
| 107 <td>Private slot to write the requirements text to a new file.</td> | |
| 108 </tr> | |
| 109 </table> | |
| 110 <h3>Static Methods</h3> | |
| 111 | |
| 112 <table> | |
| 113 <tr><td>None</td></tr> | |
| 114 </table> | |
| 115 | |
| 116 <a NAME="RequirementsDialog.__init__" ID="RequirementsDialog.__init__"></a> | |
| 117 <h4>RequirementsDialog (Constructor)</h4> | |
| 118 <b>RequirementsDialog</b>(<i>devicePath, parent=None</i>) | |
| 119 | |
| 120 <p> | |
| 121 Constructor | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>devicePath</i> (str)</dt> | |
| 126 <dd> | |
| 127 path to the connected board | |
| 128 </dd> | |
| 129 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 130 <dd> | |
| 131 reference to the parent widget (defaults to None) | |
| 132 </dd> | |
| 133 </dl> | |
| 134 <a NAME="RequirementsDialog.__generateRequirements" ID="RequirementsDialog.__generateRequirements"></a> | |
| 135 <h4>RequirementsDialog.__generateRequirements</h4> | |
| 136 <b>__generateRequirements</b>(<i></i>) | |
| 137 | |
| 138 <p> | |
| 139 Private slot to generate the requirements specifiers list. | |
| 140 </p> | |
| 141 <a NAME="RequirementsDialog.__updateButtons" ID="RequirementsDialog.__updateButtons"></a> | |
| 142 <h4>RequirementsDialog.__updateButtons</h4> | |
| 143 <b>__updateButtons</b>(<i></i>) | |
| 144 | |
| 145 <p> | |
| 146 Private method to set the state of the various buttons. | |
| 147 </p> | |
| 148 <a NAME="RequirementsDialog.__writeToFile" ID="RequirementsDialog.__writeToFile"></a> | |
| 149 <h4>RequirementsDialog.__writeToFile</h4> | |
| 150 <b>__writeToFile</b>(<i>fileName</i>) | |
| 151 | |
| 152 <p> | |
| 153 Private method to write the requirements text to a file. | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>fileName</i> (str)</dt> | |
| 158 <dd> | |
| 159 name of the file to write to | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="RequirementsDialog.on_buttonBox_clicked" ID="RequirementsDialog.on_buttonBox_clicked"></a> | |
| 163 <h4>RequirementsDialog.on_buttonBox_clicked</h4> | |
| 164 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private slot called by a button of the button box clicked. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>button</i> (QAbstractButton)</dt> | |
| 172 <dd> | |
| 173 button that was clicked | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <a NAME="RequirementsDialog.on_copyButton_clicked" ID="RequirementsDialog.on_copyButton_clicked"></a> | |
| 177 <h4>RequirementsDialog.on_copyButton_clicked</h4> | |
| 178 <b>on_copyButton_clicked</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Private slot to copy the requirements text to the clipboard. | |
| 182 </p> | |
| 183 <a NAME="RequirementsDialog.on_insertButton_clicked" ID="RequirementsDialog.on_insertButton_clicked"></a> | |
| 184 <h4>RequirementsDialog.on_insertButton_clicked</h4> | |
| 185 <b>on_insertButton_clicked</b>(<i></i>) | |
| 186 | |
| 187 <p> | |
| 188 Private slot to insert the requirements text at the cursor position | |
| 189 of the current editor. | |
| 190 </p> | |
| 191 <a NAME="RequirementsDialog.on_replaceAllButton_clicked" ID="RequirementsDialog.on_replaceAllButton_clicked"></a> | |
| 192 <h4>RequirementsDialog.on_replaceAllButton_clicked</h4> | |
| 193 <b>on_replaceAllButton_clicked</b>(<i></i>) | |
| 194 | |
| 195 <p> | |
| 196 Private slot to replace the text of the current editor with the | |
| 197 requirements text. | |
| 198 </p> | |
| 199 <a NAME="RequirementsDialog.on_replaceSelectionButton_clicked" ID="RequirementsDialog.on_replaceSelectionButton_clicked"></a> | |
| 200 <h4>RequirementsDialog.on_replaceSelectionButton_clicked</h4> | |
| 201 <b>on_replaceSelectionButton_clicked</b>(<i></i>) | |
| 202 | |
| 203 <p> | |
| 204 Private slot to replace the selected text of the current editor | |
| 205 with the requirements text. | |
| 206 </p> | |
| 207 <a NAME="RequirementsDialog.on_requirementsEdit_textChanged" ID="RequirementsDialog.on_requirementsEdit_textChanged"></a> | |
| 208 <h4>RequirementsDialog.on_requirementsEdit_textChanged</h4> | |
| 209 <b>on_requirementsEdit_textChanged</b>(<i></i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot handling changes of the requirements text. | |
| 213 </p> | |
| 214 <a NAME="RequirementsDialog.on_requirementsFilePicker_textChanged" ID="RequirementsDialog.on_requirementsFilePicker_textChanged"></a> | |
| 215 <h4>RequirementsDialog.on_requirementsFilePicker_textChanged</h4> | |
| 216 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) | |
| 217 | |
| 218 <p> | |
| 219 Private slot handling a change of the requirements file name. | |
| 220 </p> | |
| 221 <dl> | |
| 222 | |
| 223 <dt><i>txt</i> (str)</dt> | |
| 224 <dd> | |
| 225 name of the requirements file | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="RequirementsDialog.on_saveButton_clicked" ID="RequirementsDialog.on_saveButton_clicked"></a> | |
| 229 <h4>RequirementsDialog.on_saveButton_clicked</h4> | |
| 230 <b>on_saveButton_clicked</b>(<i></i>) | |
| 231 | |
| 232 <p> | |
| 233 Private slot to save the requirements text to the requirements file. | |
| 234 </p> | |
| 235 <a NAME="RequirementsDialog.on_saveToButton_clicked" ID="RequirementsDialog.on_saveToButton_clicked"></a> | |
| 236 <h4>RequirementsDialog.on_saveToButton_clicked</h4> | |
| 237 <b>on_saveToButton_clicked</b>(<i></i>) | |
| 238 | |
| 239 <p> | |
| 240 Private slot to write the requirements text to a new file. | |
| 241 </p> | |
| 242 <div align="right"><a href="#top">Up</a></div> | |
| 243 <hr /> | |
| 244 </body></html> |
