Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.PipInterface.PipFreezeDialog.html
Documentation/Source/eric6.PipInterface.PipFreezeDialog.html
- changeset 6807
- 7e5eba19d86d
equal
deleted
inserted
replaced
| 6806:d306647cb82d | 6807:7e5eba19d86d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.PipInterface.PipFreezeDialog</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.PipInterface.PipFreezeDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to generate a requirements file. | |
| 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="#PipFreezeDialog">PipFreezeDialog</a></td> | |
| 34 <td>Class implementing a dialog to generate a requirements file.</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="PipFreezeDialog" ID="PipFreezeDialog"></a> | |
| 43 <h2>PipFreezeDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to generate a requirements file. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_PipFreezeDialog | |
| 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="#PipFreezeDialog.__init__">PipFreezeDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PipFreezeDialog.__refresh">__refresh</a></td> | |
| 64 <td>Private slot to refresh the displayed list.</td> | |
| 65 </tr><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><tr> | |
| 69 <td><a href="#PipFreezeDialog.__writeToFile">__writeToFile</a></td> | |
| 70 <td>Private method to write the requirements text to a file.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PipFreezeDialog.closeEvent">closeEvent</a></td> | |
| 73 <td>Protected slot implementing a close event handler.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PipFreezeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 76 <td>Private slot called by a button of the button box clicked.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> | |
| 79 <td>Private slot to copy the requirements text to the clipboard.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> | |
| 82 <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> | |
| 85 <td>Private slot handling the switching of the local mode.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> | |
| 88 <td>Private slot to replace the text of the current editor with the requirements text.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#PipFreezeDialog.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><tr> | |
| 93 <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> | |
| 94 <td>Private slot handling changes of the requirements text.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> | |
| 97 <td>Private slot handling a change of the requirements file name.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 100 <td>Private slot to save the requirements text to the requirements file.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> | |
| 103 <td>Private slot to write the requirements text to a new file.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#PipFreezeDialog.start">start</a></td> | |
| 106 <td>Public method to start the command.</td> | |
| 107 </tr> | |
| 108 </table> | |
| 109 <h3>Static Methods</h3> | |
| 110 <table> | |
| 111 <tr><td>None</td></tr> | |
| 112 </table> | |
| 113 <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> | |
| 114 <h4>PipFreezeDialog (Constructor)</h4> | |
| 115 <b>PipFreezeDialog</b>(<i>pip, parent=None</i>) | |
| 116 <p> | |
| 117 Constructor | |
| 118 </p><dl> | |
| 119 <dt><i>pip</i> (Pip)</dt> | |
| 120 <dd> | |
| 121 reference to the master object | |
| 122 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 123 <dd> | |
| 124 reference to the parent widget | |
| 125 </dd> | |
| 126 </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> | |
| 127 <h4>PipFreezeDialog.__refresh</h4> | |
| 128 <b>__refresh</b>(<i></i>) | |
| 129 <p> | |
| 130 Private slot to refresh the displayed list. | |
| 131 </p><a NAME="PipFreezeDialog.__updateButtons" ID="PipFreezeDialog.__updateButtons"></a> | |
| 132 <h4>PipFreezeDialog.__updateButtons</h4> | |
| 133 <b>__updateButtons</b>(<i></i>) | |
| 134 <p> | |
| 135 Private method to set the state of the various buttons. | |
| 136 </p><a NAME="PipFreezeDialog.__writeToFile" ID="PipFreezeDialog.__writeToFile"></a> | |
| 137 <h4>PipFreezeDialog.__writeToFile</h4> | |
| 138 <b>__writeToFile</b>(<i>fileName</i>) | |
| 139 <p> | |
| 140 Private method to write the requirements text to a file. | |
| 141 </p><dl> | |
| 142 <dt><i>fileName</i> (str)</dt> | |
| 143 <dd> | |
| 144 name of the file to write to | |
| 145 </dd> | |
| 146 </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> | |
| 147 <h4>PipFreezeDialog.closeEvent</h4> | |
| 148 <b>closeEvent</b>(<i>e</i>) | |
| 149 <p> | |
| 150 Protected slot implementing a close event handler. | |
| 151 </p><dl> | |
| 152 <dt><i>e</i> (QCloseEvent)</dt> | |
| 153 <dd> | |
| 154 close event | |
| 155 </dd> | |
| 156 </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> | |
| 157 <h4>PipFreezeDialog.on_buttonBox_clicked</h4> | |
| 158 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 159 <p> | |
| 160 Private slot called by a button of the button box clicked. | |
| 161 </p><dl> | |
| 162 <dt><i>button</i> (QAbstractButton)</dt> | |
| 163 <dd> | |
| 164 button that was clicked | |
| 165 </dd> | |
| 166 </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> | |
| 167 <h4>PipFreezeDialog.on_copyButton_clicked</h4> | |
| 168 <b>on_copyButton_clicked</b>(<i></i>) | |
| 169 <p> | |
| 170 Private slot to copy the requirements text to the clipboard. | |
| 171 </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> | |
| 172 <h4>PipFreezeDialog.on_insertButton_clicked</h4> | |
| 173 <b>on_insertButton_clicked</b>(<i></i>) | |
| 174 <p> | |
| 175 Private slot to insert the requirements text at the cursor position | |
| 176 of the current editor. | |
| 177 </p><a NAME="PipFreezeDialog.on_localCheckBox_clicked" ID="PipFreezeDialog.on_localCheckBox_clicked"></a> | |
| 178 <h4>PipFreezeDialog.on_localCheckBox_clicked</h4> | |
| 179 <b>on_localCheckBox_clicked</b>(<i>checked</i>) | |
| 180 <p> | |
| 181 Private slot handling the switching of the local mode. | |
| 182 </p><dl> | |
| 183 <dt><i>checked</i> (bool)</dt> | |
| 184 <dd> | |
| 185 state of the local check box | |
| 186 </dd> | |
| 187 </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> | |
| 188 <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> | |
| 189 <b>on_replaceAllButton_clicked</b>(<i></i>) | |
| 190 <p> | |
| 191 Private slot to replace the text of the current editor with the | |
| 192 requirements text. | |
| 193 </p><a NAME="PipFreezeDialog.on_replaceSelectionButton_clicked" ID="PipFreezeDialog.on_replaceSelectionButton_clicked"></a> | |
| 194 <h4>PipFreezeDialog.on_replaceSelectionButton_clicked</h4> | |
| 195 <b>on_replaceSelectionButton_clicked</b>(<i></i>) | |
| 196 <p> | |
| 197 Private slot to replace the selected text of the current editor | |
| 198 with the requirements text. | |
| 199 </p><a NAME="PipFreezeDialog.on_requirementsEdit_textChanged" ID="PipFreezeDialog.on_requirementsEdit_textChanged"></a> | |
| 200 <h4>PipFreezeDialog.on_requirementsEdit_textChanged</h4> | |
| 201 <b>on_requirementsEdit_textChanged</b>(<i></i>) | |
| 202 <p> | |
| 203 Private slot handling changes of the requirements text. | |
| 204 </p><a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> | |
| 205 <h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> | |
| 206 <b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) | |
| 207 <p> | |
| 208 Private slot handling a change of the requirements file name. | |
| 209 </p><dl> | |
| 210 <dt><i>txt</i> (str)</dt> | |
| 211 <dd> | |
| 212 name of the requirements file | |
| 213 </dd> | |
| 214 </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> | |
| 215 <h4>PipFreezeDialog.on_saveButton_clicked</h4> | |
| 216 <b>on_saveButton_clicked</b>(<i></i>) | |
| 217 <p> | |
| 218 Private slot to save the requirements text to the requirements file. | |
| 219 </p><a NAME="PipFreezeDialog.on_saveToButton_clicked" ID="PipFreezeDialog.on_saveToButton_clicked"></a> | |
| 220 <h4>PipFreezeDialog.on_saveToButton_clicked</h4> | |
| 221 <b>on_saveToButton_clicked</b>(<i></i>) | |
| 222 <p> | |
| 223 Private slot to write the requirements text to a new file. | |
| 224 </p><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> | |
| 225 <h4>PipFreezeDialog.start</h4> | |
| 226 <b>start</b>(<i>venvName</i>) | |
| 227 <p> | |
| 228 Public method to start the command. | |
| 229 </p><dl> | |
| 230 <dt><i>venvName</i> (str)</dt> | |
| 231 <dd> | |
| 232 name of the environment to act upon | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <div align="right"><a href="#top">Up</a></div> | |
| 236 <hr /> | |
| 237 </body></html> |
