Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.PluginPipInterface.html
Documentation/Source/eric6.Plugins.PluginPipInterface.html
- changeset 6343
- 86cea8abd0f7
- parent 6011
- e6af0dcfbb35
equal
deleted
inserted
replaced
| 6342:c79ecba9cde7 | 6343:86cea8abd0f7 |
|---|---|
| 35 </tr> | 35 </tr> |
| 36 </table> | 36 </table> |
| 37 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 38 <table> | 38 <table> |
| 39 <tr> | 39 <tr> |
| 40 <td><a href="#_findDefaultExecutables">_findDefaultExecutables</a></td> | |
| 41 <td>Restricted function to determine the name and path of the executables.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#createPipPage">createPipPage</a></td> | 40 <td><a href="#createPipPage">createPipPage</a></td> |
| 44 <td>Module function to create the pip configuration page.</td> | 41 <td>Module function to create the pip configuration page.</td> |
| 45 </tr><tr> | 42 </tr><tr> |
| 46 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> | 43 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> |
| 47 <td>Module function to support the display of some executable info.</td> | 44 <td>Module function to support the display of some executable info.</td> |
| 48 </tr><tr> | 45 </tr><tr> |
| 49 <td><a href="#getConfigData">getConfigData</a></td> | 46 <td><a href="#getConfigData">getConfigData</a></td> |
| 50 <td>Module function returning data as required by the configuration dialog.</td> | 47 <td>Module function returning data as required by the configuration dialog.</td> |
| 51 </tr><tr> | |
| 52 <td><a href="#getExePath">getExePath</a></td> | |
| 53 <td></td> | |
| 54 </tr><tr> | 48 </tr><tr> |
| 55 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 49 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 56 <td>Module function to prepare for an un-installation.</td> | 50 <td>Module function to prepare for an un-installation.</td> |
| 57 </tr> | 51 </tr> |
| 58 </table> | 52 </table> |
| 61 <h2>PipInterfacePlugin</h2> | 55 <h2>PipInterfacePlugin</h2> |
| 62 <p> | 56 <p> |
| 63 Class implementing the pip interface plug-in. | 57 Class implementing the pip interface plug-in. |
| 64 </p><h3>Signals</h3> | 58 </p><h3>Signals</h3> |
| 65 <dl> | 59 <dl> |
| 66 <dt>currentPipChanged(exe)</dt> | 60 <dt>currentEnvironmentChanged(str)</dt> |
| 67 <dd> | 61 <dd> |
| 68 emitted to signal a change of the current | 62 emitted to signal a change of the |
| 69 pip executable | 63 currently selected virtual environment |
| 70 </dd> | 64 </dd> |
| 71 </dl> | 65 </dl> |
| 72 <h3>Derived from</h3> | 66 <h3>Derived from</h3> |
| 73 QObject | 67 QObject |
| 74 <h3>Class Attributes</h3> | 68 <h3>Class Attributes</h3> |
| 92 <td>Public method to activate this plugin.</td> | 86 <td>Public method to activate this plugin.</td> |
| 93 </tr><tr> | 87 </tr><tr> |
| 94 <td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td> | 88 <td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td> |
| 95 <td>Public method to deactivate this plugin.</td> | 89 <td>Public method to deactivate this plugin.</td> |
| 96 </tr><tr> | 90 </tr><tr> |
| 97 <td><a href="#PipInterfacePlugin.getDefaultPipExecutables">getDefaultPipExecutables</a></td> | |
| 98 <td>Public method to get the default list of pip executables.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#PipInterfacePlugin.getMenu">getMenu</a></td> | 91 <td><a href="#PipInterfacePlugin.getMenu">getMenu</a></td> |
| 101 <td>Public method to get a reference to the requested menu.</td> | 92 <td>Public method to get a reference to the requested menu.</td> |
| 102 </tr><tr> | 93 </tr><tr> |
| 103 <td><a href="#PipInterfacePlugin.getMenuNames">getMenuNames</a></td> | 94 <td><a href="#PipInterfacePlugin.getMenuNames">getMenuNames</a></td> |
| 104 <td>Public method to get the names of all menus.</td> | 95 <td>Public method to get the names of all menus.</td> |
| 105 </tr><tr> | 96 </tr><tr> |
| 106 <td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td> | 97 <td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td> |
| 107 <td>Public method to retrieve the various refactoring settings.</td> | 98 <td>Public method to retrieve the various pip related settings.</td> |
| 108 </tr><tr> | 99 </tr><tr> |
| 109 <td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td> | 100 <td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td> |
| 110 <td>Public method to store the various refactoring settings.</td> | 101 <td>Public method to store the various pip related settings.</td> |
| 111 </tr> | 102 </tr> |
| 112 </table> | 103 </table> |
| 113 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 114 <table> | 105 <table> |
| 115 <tr><td>None</td></tr> | 106 <tr><td>None</td></tr> |
| 135 <p> | 126 <p> |
| 136 Public method to activate this plugin. | 127 Public method to activate this plugin. |
| 137 </p><dl> | 128 </p><dl> |
| 138 <dt>Returns:</dt> | 129 <dt>Returns:</dt> |
| 139 <dd> | 130 <dd> |
| 140 tuple of None and activation status (boolean) | 131 tuple of None and activation status |
| 132 </dd> | |
| 133 </dl><dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 tuple of (None, bool) | |
| 141 </dd> | 137 </dd> |
| 142 </dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a> | 138 </dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a> |
| 143 <h4>PipInterfacePlugin.deactivate</h4> | 139 <h4>PipInterfacePlugin.deactivate</h4> |
| 144 <b>deactivate</b>(<i></i>) | 140 <b>deactivate</b>(<i></i>) |
| 145 <p> | 141 <p> |
| 146 Public method to deactivate this plugin. | 142 Public method to deactivate this plugin. |
| 147 </p><a NAME="PipInterfacePlugin.getDefaultPipExecutables" ID="PipInterfacePlugin.getDefaultPipExecutables"></a> | 143 </p><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a> |
| 148 <h4>PipInterfacePlugin.getDefaultPipExecutables</h4> | |
| 149 <b>getDefaultPipExecutables</b>(<i></i>) | |
| 150 <p> | |
| 151 Public method to get the default list of pip executables. | |
| 152 </p><dl> | |
| 153 <dt>Returns:</dt> | |
| 154 <dd> | |
| 155 list of pip executables (list of string) | |
| 156 </dd> | |
| 157 </dl><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a> | |
| 158 <h4>PipInterfacePlugin.getMenu</h4> | 144 <h4>PipInterfacePlugin.getMenu</h4> |
| 159 <b>getMenu</b>(<i>name</i>) | 145 <b>getMenu</b>(<i>name</i>) |
| 160 <p> | 146 <p> |
| 161 Public method to get a reference to the requested menu. | 147 Public method to get a reference to the requested menu. |
| 162 </p><dl> | 148 </p><dl> |
| 163 <dt><i>name</i></dt> | 149 <dt><i>name</i> (str)</dt> |
| 164 <dd> | 150 <dd> |
| 165 name of the menu (string) | 151 name of the menu |
| 166 </dd> | 152 </dd> |
| 167 </dl><dl> | 153 </dl><dl> |
| 168 <dt>Returns:</dt> | 154 <dt>Returns:</dt> |
| 169 <dd> | 155 <dd> |
| 170 reference to the menu (QMenu) or None, if no | 156 reference to the menu or None, if no |
| 171 menu with the given name exists | 157 menu with the given name exists |
| 158 </dd> | |
| 159 </dl><dl> | |
| 160 <dt>Return Type:</dt> | |
| 161 <dd> | |
| 162 QMenu or None | |
| 172 </dd> | 163 </dd> |
| 173 </dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a> | 164 </dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a> |
| 174 <h4>PipInterfacePlugin.getMenuNames</h4> | 165 <h4>PipInterfacePlugin.getMenuNames</h4> |
| 175 <b>getMenuNames</b>(<i></i>) | 166 <b>getMenuNames</b>(<i></i>) |
| 176 <p> | 167 <p> |
| 177 Public method to get the names of all menus. | 168 Public method to get the names of all menus. |
| 178 </p><dl> | 169 </p><dl> |
| 179 <dt>Returns:</dt> | 170 <dt>Returns:</dt> |
| 180 <dd> | 171 <dd> |
| 181 menu names (list of string) | 172 menu names |
| 173 </dd> | |
| 174 </dl><dl> | |
| 175 <dt>Return Type:</dt> | |
| 176 <dd> | |
| 177 list of str | |
| 182 </dd> | 178 </dd> |
| 183 </dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a> | 179 </dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a> |
| 184 <h4>PipInterfacePlugin.getPreferences</h4> | 180 <h4>PipInterfacePlugin.getPreferences</h4> |
| 185 <b>getPreferences</b>(<i>key</i>) | 181 <b>getPreferences</b>(<i>key</i>) |
| 186 <p> | 182 <p> |
| 187 Public method to retrieve the various refactoring settings. | 183 Public method to retrieve the various pip related settings. |
| 188 </p><dl> | 184 </p><dl> |
| 189 <dt><i>key</i></dt> | 185 <dt><i>key</i> (str)</dt> |
| 190 <dd> | 186 <dd> |
| 191 the key of the value to get | 187 the key of the value to get |
| 192 </dd> | 188 </dd> |
| 193 </dl><dl> | 189 </dl><dl> |
| 194 <dt>Returns:</dt> | 190 <dt>Returns:</dt> |
| 195 <dd> | 191 <dd> |
| 196 the requested refactoring setting | 192 the requested setting |
| 193 </dd> | |
| 194 </dl><dl> | |
| 195 <dt>Return Type:</dt> | |
| 196 <dd> | |
| 197 any | |
| 197 </dd> | 198 </dd> |
| 198 </dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a> | 199 </dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a> |
| 199 <h4>PipInterfacePlugin.setPreferences</h4> | 200 <h4>PipInterfacePlugin.setPreferences</h4> |
| 200 <b>setPreferences</b>(<i>key, value</i>) | 201 <b>setPreferences</b>(<i>key, value</i>) |
| 201 <p> | 202 <p> |
| 202 Public method to store the various refactoring settings. | 203 Public method to store the various pip related settings. |
| 203 </p><dl> | 204 </p><dl> |
| 204 <dt><i>key</i></dt> | 205 <dt><i>key</i> (str)</dt> |
| 205 <dd> | 206 <dd> |
| 206 the key of the setting to be set (string) | 207 the key of the setting to be set |
| 207 </dd><dt><i>value</i></dt> | 208 </dd><dt><i>value</i> (any)</dt> |
| 208 <dd> | 209 <dd> |
| 209 the value to be set | 210 the value to be set |
| 210 </dd> | |
| 211 </dl> | |
| 212 <div align="right"><a href="#top">Up</a></div> | |
| 213 <hr /><hr /> | |
| 214 <a NAME="_findDefaultExecutables" ID="_findDefaultExecutables"></a> | |
| 215 <h2>_findDefaultExecutables</h2> | |
| 216 <b>_findDefaultExecutables</b>(<i>majorVersion</i>) | |
| 217 <p> | |
| 218 Restricted function to determine the name and path of the executables. | |
| 219 </p><dl> | |
| 220 <dt><i>majorVersion</i></dt> | |
| 221 <dd> | |
| 222 major python version of the executables (int) | |
| 223 </dd> | |
| 224 </dl><dl> | |
| 225 <dt>Returns:</dt> | |
| 226 <dd> | |
| 227 path names of the executables (list of string) | |
| 228 </dd> | 211 </dd> |
| 229 </dl> | 212 </dl> |
| 230 <div align="right"><a href="#top">Up</a></div> | 213 <div align="right"><a href="#top">Up</a></div> |
| 231 <hr /><hr /> | 214 <hr /><hr /> |
| 232 <a NAME="createPipPage" ID="createPipPage"></a> | 215 <a NAME="createPipPage" ID="createPipPage"></a> |
| 272 dictionary containing the relevant data | 255 dictionary containing the relevant data |
| 273 </dd> | 256 </dd> |
| 274 </dl> | 257 </dl> |
| 275 <div align="right"><a href="#top">Up</a></div> | 258 <div align="right"><a href="#top">Up</a></div> |
| 276 <hr /><hr /> | 259 <hr /><hr /> |
| 277 <a NAME="getExePath" ID="getExePath"></a> | |
| 278 <h2>getExePath</h2> | |
| 279 <b>getExePath</b>(<i>branch, access, versionStr</i>) | |
| 280 | |
| 281 <div align="right"><a href="#top">Up</a></div> | |
| 282 <hr /><hr /> | |
| 283 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 260 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 284 <h2>prepareUninstall</h2> | 261 <h2>prepareUninstall</h2> |
| 285 <b>prepareUninstall</b>(<i></i>) | 262 <b>prepareUninstall</b>(<i></i>) |
| 286 <p> | 263 <p> |
| 287 Module function to prepare for an un-installation. | 264 Module function to prepare for an un-installation. |
