Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 6343
86cea8abd0f7
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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="#createPipPage">createPipPage</a></td>
41 <td>Module function to create the pip configuration page.</td>
42 </tr><tr>
43 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
44 <td>Module function to support the display of some executable info.</td>
45 </tr><tr>
46 <td><a href="#getConfigData">getConfigData</a></td>
47 <td>Module function returning data as required by the configuration dialog.</td>
48 </tr><tr>
49 <td><a href="#prepareUninstall">prepareUninstall</a></td>
50 <td>Module function to prepare for an un-installation.</td>
51 </tr>
52 </table>
53 <hr /><hr />
54 <a NAME="PipInterfacePlugin" ID="PipInterfacePlugin"></a>
55 <h2>PipInterfacePlugin</h2>
56 <p>
57 Class implementing the pip interface plug-in.
58 </p><h3>Signals</h3>
59 <dl>
60 <dt>currentEnvironmentChanged(str)</dt>
61 <dd>
62 emitted to signal a change of the
63 currently selected virtual environment
64 </dd>
65 </dl>
66 <h3>Derived from</h3>
67 QObject
68 <h3>Class Attributes</h3>
69 <table>
70 <tr><td>PreferencesKey</td></tr>
71 </table>
72 <h3>Class Methods</h3>
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77 <table>
78 <tr>
79 <td><a href="#PipInterfacePlugin.__init__">PipInterfacePlugin</a></td>
80 <td>Constructor</td>
81 </tr><tr>
82 <td><a href="#PipInterfacePlugin.__initialize">__initialize</a></td>
83 <td>Private slot to (re)initialize the plugin.</td>
84 </tr><tr>
85 <td><a href="#PipInterfacePlugin.activate">activate</a></td>
86 <td>Public method to activate this plugin.</td>
87 </tr><tr>
88 <td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td>
89 <td>Public method to deactivate this plugin.</td>
90 </tr><tr>
91 <td><a href="#PipInterfacePlugin.getMenu">getMenu</a></td>
92 <td>Public method to get a reference to the requested menu.</td>
93 </tr><tr>
94 <td><a href="#PipInterfacePlugin.getMenuNames">getMenuNames</a></td>
95 <td>Public method to get the names of all menus.</td>
96 </tr><tr>
97 <td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td>
98 <td>Public method to retrieve the various pip related settings.</td>
99 </tr><tr>
100 <td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td>
101 <td>Public method to store the various pip related settings.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108 <a NAME="PipInterfacePlugin.__init__" ID="PipInterfacePlugin.__init__"></a>
109 <h4>PipInterfacePlugin (Constructor)</h4>
110 <b>PipInterfacePlugin</b>(<i>ui</i>)
111 <p>
112 Constructor
113 </p><dl>
114 <dt><i>ui</i></dt>
115 <dd>
116 reference to the user interface object (UI.UserInterface)
117 </dd>
118 </dl><a NAME="PipInterfacePlugin.__initialize" ID="PipInterfacePlugin.__initialize"></a>
119 <h4>PipInterfacePlugin.__initialize</h4>
120 <b>__initialize</b>(<i></i>)
121 <p>
122 Private slot to (re)initialize the plugin.
123 </p><a NAME="PipInterfacePlugin.activate" ID="PipInterfacePlugin.activate"></a>
124 <h4>PipInterfacePlugin.activate</h4>
125 <b>activate</b>(<i></i>)
126 <p>
127 Public method to activate this plugin.
128 </p><dl>
129 <dt>Returns:</dt>
130 <dd>
131 tuple of None and activation status
132 </dd>
133 </dl><dl>
134 <dt>Return Type:</dt>
135 <dd>
136 tuple of (None, bool)
137 </dd>
138 </dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a>
139 <h4>PipInterfacePlugin.deactivate</h4>
140 <b>deactivate</b>(<i></i>)
141 <p>
142 Public method to deactivate this plugin.
143 </p><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a>
144 <h4>PipInterfacePlugin.getMenu</h4>
145 <b>getMenu</b>(<i>name</i>)
146 <p>
147 Public method to get a reference to the requested menu.
148 </p><dl>
149 <dt><i>name</i> (str)</dt>
150 <dd>
151 name of the menu
152 </dd>
153 </dl><dl>
154 <dt>Returns:</dt>
155 <dd>
156 reference to the menu or None, if no
157 menu with the given name exists
158 </dd>
159 </dl><dl>
160 <dt>Return Type:</dt>
161 <dd>
162 QMenu or None
163 </dd>
164 </dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a>
165 <h4>PipInterfacePlugin.getMenuNames</h4>
166 <b>getMenuNames</b>(<i></i>)
167 <p>
168 Public method to get the names of all menus.
169 </p><dl>
170 <dt>Returns:</dt>
171 <dd>
172 menu names
173 </dd>
174 </dl><dl>
175 <dt>Return Type:</dt>
176 <dd>
177 list of str
178 </dd>
179 </dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a>
180 <h4>PipInterfacePlugin.getPreferences</h4>
181 <b>getPreferences</b>(<i>key</i>)
182 <p>
183 Public method to retrieve the various pip related settings.
184 </p><dl>
185 <dt><i>key</i> (str)</dt>
186 <dd>
187 the key of the value to get
188 </dd>
189 </dl><dl>
190 <dt>Returns:</dt>
191 <dd>
192 the requested setting
193 </dd>
194 </dl><dl>
195 <dt>Return Type:</dt>
196 <dd>
197 any
198 </dd>
199 </dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a>
200 <h4>PipInterfacePlugin.setPreferences</h4>
201 <b>setPreferences</b>(<i>key, value</i>)
202 <p>
203 Public method to store the various pip related settings.
204 </p><dl>
205 <dt><i>key</i> (str)</dt>
206 <dd>
207 the key of the setting to be set
208 </dd><dt><i>value</i> (any)</dt>
209 <dd>
210 the value to be set
211 </dd>
212 </dl>
213 <div align="right"><a href="#top">Up</a></div>
214 <hr /><hr />
215 <a NAME="createPipPage" ID="createPipPage"></a>
216 <h2>createPipPage</h2>
217 <b>createPipPage</b>(<i>configDlg</i>)
218 <p>
219 Module function to create the pip configuration page.
220 </p><dl>
221 <dt><i>configDlg</i></dt>
222 <dd>
223 reference to the configuration dialog
224 </dd>
225 </dl><dl>
226 <dt>Returns:</dt>
227 <dd>
228 reference to the configuration page
229 </dd>
230 </dl>
231 <div align="right"><a href="#top">Up</a></div>
232 <hr /><hr />
233 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a>
234 <h2>exeDisplayDataList</h2>
235 <b>exeDisplayDataList</b>(<i></i>)
236 <p>
237 Module function to support the display of some executable info.
238 </p><dl>
239 <dt>Returns:</dt>
240 <dd>
241 list of dictionaries containing the data to query the presence of
242 the executable
243 </dd>
244 </dl>
245 <div align="right"><a href="#top">Up</a></div>
246 <hr /><hr />
247 <a NAME="getConfigData" ID="getConfigData"></a>
248 <h2>getConfigData</h2>
249 <b>getConfigData</b>(<i></i>)
250 <p>
251 Module function returning data as required by the configuration dialog.
252 </p><dl>
253 <dt>Returns:</dt>
254 <dd>
255 dictionary containing the relevant data
256 </dd>
257 </dl>
258 <div align="right"><a href="#top">Up</a></div>
259 <hr /><hr />
260 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
261 <h2>prepareUninstall</h2>
262 <b>prepareUninstall</b>(<i></i>)
263 <p>
264 Module function to prepare for an un-installation.
265 </p>
266 <div align="right"><a href="#top">Up</a></div>
267 <hr />
268 </body></html>

Mercurial Repository: eric

eric ide

mercurial