Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.PluginPipInterface.html

Documentation/Source/eric6.Plugins.PluginPipInterface.html

changeset 6011
e6af0dcfbb35
child 6343
86cea8abd0f7
equal deleted inserted replaced
6010:7ef7d47a0ad5 6011:e6af0dcfbb35
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.PluginPipInterface</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.Plugins.PluginPipInterface</h1>
23 <p>
24 Module implementing the pip interface plug-in.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pipPluginObject</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PipInterfacePlugin">PipInterfacePlugin</a></td>
34 <td>Class implementing the pip interface plug-in.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
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>
44 <td>Module function to create the pip configuration page.</td>
45 </tr><tr>
46 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
47 <td>Module function to support the display of some executable info.</td>
48 </tr><tr>
49 <td><a href="#getConfigData">getConfigData</a></td>
50 <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>
55 <td><a href="#prepareUninstall">prepareUninstall</a></td>
56 <td>Module function to prepare for an un-installation.</td>
57 </tr>
58 </table>
59 <hr /><hr />
60 <a NAME="PipInterfacePlugin" ID="PipInterfacePlugin"></a>
61 <h2>PipInterfacePlugin</h2>
62 <p>
63 Class implementing the pip interface plug-in.
64 </p><h3>Signals</h3>
65 <dl>
66 <dt>currentPipChanged(exe)</dt>
67 <dd>
68 emitted to signal a change of the current
69 pip executable
70 </dd>
71 </dl>
72 <h3>Derived from</h3>
73 QObject
74 <h3>Class Attributes</h3>
75 <table>
76 <tr><td>PreferencesKey</td></tr>
77 </table>
78 <h3>Class Methods</h3>
79 <table>
80 <tr><td>None</td></tr>
81 </table>
82 <h3>Methods</h3>
83 <table>
84 <tr>
85 <td><a href="#PipInterfacePlugin.__init__">PipInterfacePlugin</a></td>
86 <td>Constructor</td>
87 </tr><tr>
88 <td><a href="#PipInterfacePlugin.__initialize">__initialize</a></td>
89 <td>Private slot to (re)initialize the plugin.</td>
90 </tr><tr>
91 <td><a href="#PipInterfacePlugin.activate">activate</a></td>
92 <td>Public method to activate this plugin.</td>
93 </tr><tr>
94 <td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td>
95 <td>Public method to deactivate this plugin.</td>
96 </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>
101 <td>Public method to get a reference to the requested menu.</td>
102 </tr><tr>
103 <td><a href="#PipInterfacePlugin.getMenuNames">getMenuNames</a></td>
104 <td>Public method to get the names of all menus.</td>
105 </tr><tr>
106 <td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td>
107 <td>Public method to retrieve the various refactoring settings.</td>
108 </tr><tr>
109 <td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td>
110 <td>Public method to store the various refactoring settings.</td>
111 </tr>
112 </table>
113 <h3>Static Methods</h3>
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117 <a NAME="PipInterfacePlugin.__init__" ID="PipInterfacePlugin.__init__"></a>
118 <h4>PipInterfacePlugin (Constructor)</h4>
119 <b>PipInterfacePlugin</b>(<i>ui</i>)
120 <p>
121 Constructor
122 </p><dl>
123 <dt><i>ui</i></dt>
124 <dd>
125 reference to the user interface object (UI.UserInterface)
126 </dd>
127 </dl><a NAME="PipInterfacePlugin.__initialize" ID="PipInterfacePlugin.__initialize"></a>
128 <h4>PipInterfacePlugin.__initialize</h4>
129 <b>__initialize</b>(<i></i>)
130 <p>
131 Private slot to (re)initialize the plugin.
132 </p><a NAME="PipInterfacePlugin.activate" ID="PipInterfacePlugin.activate"></a>
133 <h4>PipInterfacePlugin.activate</h4>
134 <b>activate</b>(<i></i>)
135 <p>
136 Public method to activate this plugin.
137 </p><dl>
138 <dt>Returns:</dt>
139 <dd>
140 tuple of None and activation status (boolean)
141 </dd>
142 </dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a>
143 <h4>PipInterfacePlugin.deactivate</h4>
144 <b>deactivate</b>(<i></i>)
145 <p>
146 Public method to deactivate this plugin.
147 </p><a NAME="PipInterfacePlugin.getDefaultPipExecutables" ID="PipInterfacePlugin.getDefaultPipExecutables"></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>
159 <b>getMenu</b>(<i>name</i>)
160 <p>
161 Public method to get a reference to the requested menu.
162 </p><dl>
163 <dt><i>name</i></dt>
164 <dd>
165 name of the menu (string)
166 </dd>
167 </dl><dl>
168 <dt>Returns:</dt>
169 <dd>
170 reference to the menu (QMenu) or None, if no
171 menu with the given name exists
172 </dd>
173 </dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a>
174 <h4>PipInterfacePlugin.getMenuNames</h4>
175 <b>getMenuNames</b>(<i></i>)
176 <p>
177 Public method to get the names of all menus.
178 </p><dl>
179 <dt>Returns:</dt>
180 <dd>
181 menu names (list of string)
182 </dd>
183 </dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a>
184 <h4>PipInterfacePlugin.getPreferences</h4>
185 <b>getPreferences</b>(<i>key</i>)
186 <p>
187 Public method to retrieve the various refactoring settings.
188 </p><dl>
189 <dt><i>key</i></dt>
190 <dd>
191 the key of the value to get
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 the requested refactoring setting
197 </dd>
198 </dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a>
199 <h4>PipInterfacePlugin.setPreferences</h4>
200 <b>setPreferences</b>(<i>key, value</i>)
201 <p>
202 Public method to store the various refactoring settings.
203 </p><dl>
204 <dt><i>key</i></dt>
205 <dd>
206 the key of the setting to be set (string)
207 </dd><dt><i>value</i></dt>
208 <dd>
209 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>
229 </dl>
230 <div align="right"><a href="#top">Up</a></div>
231 <hr /><hr />
232 <a NAME="createPipPage" ID="createPipPage"></a>
233 <h2>createPipPage</h2>
234 <b>createPipPage</b>(<i>configDlg</i>)
235 <p>
236 Module function to create the pip configuration page.
237 </p><dl>
238 <dt><i>configDlg</i></dt>
239 <dd>
240 reference to the configuration dialog
241 </dd>
242 </dl><dl>
243 <dt>Returns:</dt>
244 <dd>
245 reference to the configuration page
246 </dd>
247 </dl>
248 <div align="right"><a href="#top">Up</a></div>
249 <hr /><hr />
250 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a>
251 <h2>exeDisplayDataList</h2>
252 <b>exeDisplayDataList</b>(<i></i>)
253 <p>
254 Module function to support the display of some executable info.
255 </p><dl>
256 <dt>Returns:</dt>
257 <dd>
258 list of dictionaries containing the data to query the presence of
259 the executable
260 </dd>
261 </dl>
262 <div align="right"><a href="#top">Up</a></div>
263 <hr /><hr />
264 <a NAME="getConfigData" ID="getConfigData"></a>
265 <h2>getConfigData</h2>
266 <b>getConfigData</b>(<i></i>)
267 <p>
268 Module function returning data as required by the configuration dialog.
269 </p><dl>
270 <dt>Returns:</dt>
271 <dd>
272 dictionary containing the relevant data
273 </dd>
274 </dl>
275 <div align="right"><a href="#top">Up</a></div>
276 <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>
284 <h2>prepareUninstall</h2>
285 <b>prepareUninstall</b>(<i></i>)
286 <p>
287 Module function to prepare for an un-installation.
288 </p>
289 <div align="right"><a href="#top">Up</a></div>
290 <hr />
291 </body></html>

Mercurial Repository: eric

eric ide

mercurial