Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PipInterface.PipFreezeDialog.html
src/eric7/Documentation/Source/eric7.PipInterface.PipFreezeDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8976
- ca442cd49b9e
- child 9244
- 3bf1a02df07a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PipInterface.PipFreezeDialog</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.PipInterface.PipFreezeDialog</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="#PipFreezeDialog">PipFreezeDialog</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="PipFreezeDialog" ID="PipFreezeDialog"></a> | |
| 36 <h2>PipFreezeDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to generate a requirements file. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_PipFreezeDialog | |
| 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="#PipFreezeDialog.__init__">PipFreezeDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#PipFreezeDialog.__refresh">__refresh</a></td> | |
| 63 <td>Private slot to refresh the displayed list.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PipFreezeDialog.__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="#PipFreezeDialog.__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="#PipFreezeDialog.closeEvent">closeEvent</a></td> | |
| 75 <td>Protected slot implementing a close event handler.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PipFreezeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 79 <td>Private slot called by a button of the button box clicked.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> | |
| 83 <td>Private slot to copy the requirements text to the clipboard.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> | |
| 87 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> | |
| 91 <td>Private slot handling the switching of the local mode.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> | |
| 95 <td>Private slot to replace the text of the current editor with the requirements text.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PipFreezeDialog.on_replaceSelectionButton_clicked">on_replaceSelectionButton_clicked</a></td> | |
| 99 <td>Private slot to replace the selected text of the current editor with the requirements text.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> | |
| 103 <td>Private slot handling changes of the requirements text.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> | |
| 107 <td>Private slot handling a change of the requirements file name.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 111 <td>Private slot to save the requirements text to the requirements file.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> | |
| 115 <td>Private slot to write the requirements text to a new file.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PipFreezeDialog.on_userCheckBox_clicked">on_userCheckBox_clicked</a></td> | |
| 119 <td>Private slot handling the switching of the user-site mode.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#PipFreezeDialog.start">start</a></td> | |
| 123 <td>Public method to start the command.</td> | |
| 124 </tr> | |
| 125 </table> | |
| 126 <h3>Static Methods</h3> | |
| 127 | |
| 128 <table> | |
| 129 <tr><td>None</td></tr> | |
| 130 </table> | |
| 131 | |
| 132 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> | |
| 133 <h4>PipFreezeDialog (Constructor)</h4> | |
| 134 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>) | |
| 135 | |
| 136 <p> | |
| 137 Constructor | |
| 138 </p> | |
| 139 <dl> | |
| 140 | |
| 141 <dt><i>pip</i> (Pip)</dt> | |
| 142 <dd> | |
| 143 reference to the master object | |
| 144 </dd> | |
| 145 <dt><i>parent</i> (QWidget)</dt> | |
| 146 <dd> | |
| 147 reference to the parent widget | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> | |
| 151 <h4>PipFreezeDialog.__refresh</h4> | |
| 152 <b>__refresh</b>(<i></i>) | |
| 153 | |
| 154 <p> | |
| 155 Private slot to refresh the displayed list. | |
| 156 </p> | |
| 157 <a NAME="PipFreezeDialog.__updateButtons" ID="PipFreezeDialog.__updateButtons"></a> | |
| 158 <h4>PipFreezeDialog.__updateButtons</h4> | |
| 159 <b>__updateButtons</b>(<i></i>) | |
| 160 | |
| 161 <p> | |
| 162 Private method to set the state of the various buttons. | |
| 163 </p> | |
| 164 <a NAME="PipFreezeDialog.__writeToFile" ID="PipFreezeDialog.__writeToFile"></a> | |
| 165 <h4>PipFreezeDialog.__writeToFile</h4> | |
| 166 <b>__writeToFile</b>(<i>fileName</i>) | |
| 167 | |
| 168 <p> | |
| 169 Private method to write the requirements text to a file. | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>fileName</i> (str)</dt> | |
| 174 <dd> | |
| 175 name of the file to write to | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> | |
| 179 <h4>PipFreezeDialog.closeEvent</h4> | |
| 180 <b>closeEvent</b>(<i>e</i>) | |
| 181 | |
| 182 <p> | |
| 183 Protected slot implementing a close event handler. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>e</i> (QCloseEvent)</dt> | |
| 188 <dd> | |
| 189 close event | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> | |
| 193 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> | |
| 194 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 195 | |
| 196 <p> | |
| 197 Private slot called by a button of the button box clicked. | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>button</i> (QAbstractButton)</dt> | |
| 202 <dd> | |
| 203 button that was clicked | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> | |
| 207 <h4>PipFreezeDialog.on_copyButton_clicked</h4> | |
| 208 <b>on_copyButton_clicked</b>(<i></i>) | |
| 209 | |
| 210 <p> | |
| 211 Private slot to copy the requirements text to the clipboard. | |
| 212 </p> | |
| 213 <a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> | |
| 214 <h4>PipFreezeDialog.on_insertButton_clicked</h4> | |
| 215 <b>on_insertButton_clicked</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Private slot to insert the requirements text at the cursor position | |
| 219 of the current editor. | |
| 220 </p> | |
| 221 <a NAME="PipFreezeDialog.on_localCheckBox_clicked" ID="PipFreezeDialog.on_localCheckBox_clicked"></a> | |
| 222 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> | |
| 223 <b>on_localCheckBox_clicked</b>(<i></i>) | |
| 224 | |
| 225 <p> | |
| 226 Private slot handling the switching of the local mode. | |
| 227 </p> | |
| 228 <a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> | |
| 229 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> | |
| 230 <b>on_replaceAllButton_clicked</b>(<i></i>) | |
| 231 | |
| 232 <p> | |
| 233 Private slot to replace the text of the current editor with the | |
| 234 requirements text. | |
| 235 </p> | |
| 236 <a NAME="PipFreezeDialog.on_replaceSelectionButton_clicked" ID="PipFreezeDialog.on_replaceSelectionButton_clicked"></a> | |
| 237 <h4>PipFreezeDialog.on_replaceSelectionButton_clicked</h4> | |
| 238 <b>on_replaceSelectionButton_clicked</b>(<i></i>) | |
| 239 | |
| 240 <p> | |
| 241 Private slot to replace the selected text of the current editor | |
| 242 with the requirements text. | |
| 243 </p> | |
| 244 <a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> | |
| 245 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> | |
| 246 <b>on_requirementsEdit_textChanged</b>(<i></i>) | |
| 247 | |
| 248 <p> | |
| 249 Private slot handling changes of the requirements text. | |
| 250 </p> | |
| 251 <a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> | |
| 252 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> | |
| 253 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) | |
| 254 | |
| 255 <p> | |
| 256 Private slot handling a change of the requirements file name. | |
| 257 </p> | |
| 258 <dl> | |
| 259 | |
| 260 <dt><i>txt</i> (str)</dt> | |
| 261 <dd> | |
| 262 name of the requirements file | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> | |
| 266 <h4>PipFreezeDialog.on_saveButton_clicked</h4> | |
| 267 <b>on_saveButton_clicked</b>(<i></i>) | |
| 268 | |
| 269 <p> | |
| 270 Private slot to save the requirements text to the requirements file. | |
| 271 </p> | |
| 272 <a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> | |
| 273 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> | |
| 274 <b>on_saveToButton_clicked</b>(<i></i>) | |
| 275 | |
| 276 <p> | |
| 277 Private slot to write the requirements text to a new file. | |
| 278 </p> | |
| 279 <a NAME="PipFreezeDialog.on_userCheckBox_clicked" ID="PipFreezeDialog.on_userCheckBox_clicked"></a> | |
| 280 <h4>PipFreezeDialog.on_userCheckBox_clicked</h4> | |
| 281 <b>on_userCheckBox_clicked</b>(<i></i>) | |
| 282 | |
| 283 <p> | |
| 284 Private slot handling the switching of the user-site mode. | |
| 285 </p> | |
| 286 <a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> | |
| 287 <h4>PipFreezeDialog.start</h4> | |
| 288 <b>start</b>(<i>venvName</i>) | |
| 289 | |
| 290 <p> | |
| 291 Public method to start the command. | |
| 292 </p> | |
| 293 <dl> | |
| 294 | |
| 295 <dt><i>venvName</i> (str)</dt> | |
| 296 <dd> | |
| 297 name of the environment to act upon | |
| 298 </dd> | |
| 299 </dl> | |
| 300 <div align="right"><a href="#top">Up</a></div> | |
| 301 <hr /> | |
| 302 </body></html> |
