Mercurial Repositories > Flask Project / file comparison
comparison: ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskVirtualenvConfigurationDialog.html
ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskVirtualenvConfigurationDialog.html
- changeset 52
- caddf9f36f9f
- child 61
- fe1e8783a95f
equal
deleted
inserted
replaced
| 51:428c2bec2e8f | 52:caddf9f36f9f |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Project_Flask.ProjectFlask.FlaskVirtualenvConfigurationDialog</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Project_Flask.ProjectFlask.FlaskVirtualenvConfigurationDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a dialog to configure a project specific virtual | |
| 27 environment. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#FlaskVirtualenvConfigurationDialog">FlaskVirtualenvConfigurationDialog</a></td> | |
| 40 <td>Class implementing a dialog to configure a project specific virtual environment.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="FlaskVirtualenvConfigurationDialog" ID="FlaskVirtualenvConfigurationDialog"></a> | |
| 51 <h2>FlaskVirtualenvConfigurationDialog</h2> | |
| 52 | |
| 53 <p> | |
| 54 Class implementing a dialog to configure a project specific virtual | |
| 55 environment. | |
| 56 </p> | |
| 57 <p> | |
| 58 Note: This dialog is a simplified variant of the one found in the eric | |
| 59 package. | |
| 60 </p> | |
| 61 <h3>Derived from</h3> | |
| 62 QDialog, Ui_FlaskVirtualenvConfigurationDialog | |
| 63 <h3>Class Attributes</h3> | |
| 64 | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Methods</h3> | |
| 74 | |
| 75 <table> | |
| 76 | |
| 77 <tr> | |
| 78 <td><a href="#FlaskVirtualenvConfigurationDialog.__init__">FlaskVirtualenvConfigurationDialog</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#FlaskVirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td> | |
| 83 <td>Private method to generate a valid target directory path.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#FlaskVirtualenvConfigurationDialog.__updateOK">__updateOK</a></td> | |
| 87 <td>Private method to update the enabled status of the OK button.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#FlaskVirtualenvConfigurationDialog.getData">getData</a></td> | |
| 91 <td>Public method to retrieve the dialog data.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> | |
| 95 <td>Private slot handling a change of the virtual environment name.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td> | |
| 99 <td>Private slot handling a change of the target directory.</td> | |
| 100 </tr> | |
| 101 </table> | |
| 102 <h3>Static Methods</h3> | |
| 103 | |
| 104 <table> | |
| 105 <tr><td>None</td></tr> | |
| 106 </table> | |
| 107 | |
| 108 <a NAME="FlaskVirtualenvConfigurationDialog.__init__" ID="FlaskVirtualenvConfigurationDialog.__init__"></a> | |
| 109 <h4>FlaskVirtualenvConfigurationDialog (Constructor)</h4> | |
| 110 <b>FlaskVirtualenvConfigurationDialog</b>(<i>projectPath, projectName, parent=None</i>) | |
| 111 | |
| 112 <p> | |
| 113 Constructor | |
| 114 </p> | |
| 115 <dl> | |
| 116 | |
| 117 <dt><i>projectPath</i> (str)</dt> | |
| 118 <dd> | |
| 119 directory path of the project | |
| 120 </dd> | |
| 121 <dt><i>projectName</i> (str)</dt> | |
| 122 <dd> | |
| 123 name of the project | |
| 124 </dd> | |
| 125 <dt><i>parent</i> (QWidget)</dt> | |
| 126 <dd> | |
| 127 reference to the parent widget | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="FlaskVirtualenvConfigurationDialog.__generateTargetDir" ID="FlaskVirtualenvConfigurationDialog.__generateTargetDir"></a> | |
| 131 <h4>FlaskVirtualenvConfigurationDialog.__generateTargetDir</h4> | |
| 132 <b>__generateTargetDir</b>(<i></i>) | |
| 133 | |
| 134 <p> | |
| 135 Private method to generate a valid target directory path. | |
| 136 </p> | |
| 137 <dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 target directory path | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 str | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="FlaskVirtualenvConfigurationDialog.__updateOK" ID="FlaskVirtualenvConfigurationDialog.__updateOK"></a> | |
| 150 <h4>FlaskVirtualenvConfigurationDialog.__updateOK</h4> | |
| 151 <b>__updateOK</b>(<i></i>) | |
| 152 | |
| 153 <p> | |
| 154 Private method to update the enabled status of the OK button. | |
| 155 </p> | |
| 156 <a NAME="FlaskVirtualenvConfigurationDialog.getData" ID="FlaskVirtualenvConfigurationDialog.getData"></a> | |
| 157 <h4>FlaskVirtualenvConfigurationDialog.getData</h4> | |
| 158 <b>getData</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Public method to retrieve the dialog data. | |
| 162 </p> | |
| 163 <p> | |
| 164 Note: This method returns a data structure compatible with the one | |
| 165 returned by the eric virtual environment configuration dialog. | |
| 166 </p> | |
| 167 <dl> | |
| 168 <dt>Returns:</dt> | |
| 169 <dd> | |
| 170 dictionary containing the data for the environment to be | |
| 171 created. The keys for both variants are 'arguments' containing the | |
| 172 command line arguments, 'logicalName' containing the environment | |
| 173 name to be used with the virtual environment manager and 'envType' | |
| 174 containing the environment type (always pyvenv). The pyvenv | |
| 175 specific keys are 'openTarget' containg a flag to open the target | |
| 176 directory after creation (always False), 'createLog' containing a | |
| 177 flag to write a log file (always False), 'createScript' containing | |
| 178 a flag to write a script (always False), 'targetDirectory' | |
| 179 containing the target directory and 'pythonExe' containing the | |
| 180 Python interpreter to be used. | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 <dt>Return Type:</dt> | |
| 185 <dd> | |
| 186 dict | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged" ID="FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged"></a> | |
| 190 <h4>FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged</h4> | |
| 191 <b>on_nameEdit_textChanged</b>(<i>txt</i>) | |
| 192 | |
| 193 <p> | |
| 194 Private slot handling a change of the virtual environment name. | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>txt</i> (str)</dt> | |
| 199 <dd> | |
| 200 name of the virtual environment | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged" ID="FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged"></a> | |
| 204 <h4>FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged</h4> | |
| 205 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) | |
| 206 | |
| 207 <p> | |
| 208 Private slot handling a change of the target directory. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>txt</i> (str)</dt> | |
| 213 <dd> | |
| 214 target directory | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <div align="right"><a href="#top">Up</a></div> | |
| 218 <hr /> | |
| 219 </body></html> |
