Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html

eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.PluginVcsGit</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>eric7.Plugins.PluginVcsGit</h1>
24
25 <p>
26 Module implementing the Git version control plugin.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <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>gitCfgPluginObject</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#VcsGitPlugin">VcsGitPlugin</a></td>
39 <td>Class implementing the Git version control plugin.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#clearPrivateData">clearPrivateData</a></td>
48 <td>Module function to clear the private data of the plug-in.</td>
49 </tr>
50 <tr>
51 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
52 <td>Module function to create the configuration page.</td>
53 </tr>
54 <tr>
55 <td><a href="#displayString">displayString</a></td>
56 <td>Public function to get the display string.</td>
57 </tr>
58 <tr>
59 <td><a href="#exeDisplayData">exeDisplayData</a></td>
60 <td>Public method to support the display of some executable info.</td>
61 </tr>
62 <tr>
63 <td><a href="#getConfigData">getConfigData</a></td>
64 <td>Module function returning data as required by the configuration dialog.</td>
65 </tr>
66 <tr>
67 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td>
68 <td>Public function to get the indicators for this version control system.</td>
69 </tr>
70 <tr>
71 <td><a href="#prepareUninstall">prepareUninstall</a></td>
72 <td>Module function to prepare for an uninstallation.</td>
73 </tr>
74 </table>
75 <hr />
76 <hr />
77 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a>
78 <h2>VcsGitPlugin</h2>
79
80 <p>
81 Class implementing the Git version control plugin.
82 </p>
83 <h3>Derived from</h3>
84 QObject
85 <h3>Class Attributes</h3>
86
87 <table>
88 <tr><td>GitDefaults</td></tr>
89 </table>
90 <h3>Class Methods</h3>
91
92 <table>
93
94 <tr>
95 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td>
96 <td>Class method to retrieve the various settings.</td>
97 </tr>
98 <tr>
99 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td>
100 <td>Class method to store the various settings.</td>
101 </tr>
102 </table>
103 <h3>Methods</h3>
104
105 <table>
106
107 <tr>
108 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td>
109 <td>Constructor</td>
110 </tr>
111 <tr>
112 <td><a href="#VcsGitPlugin.activate">activate</a></td>
113 <td>Public method to activate this plugin.</td>
114 </tr>
115 <tr>
116 <td><a href="#VcsGitPlugin.deactivate">deactivate</a></td>
117 <td>Public method to deactivate this plugin.</td>
118 </tr>
119 <tr>
120 <td><a href="#VcsGitPlugin.getConfigPath">getConfigPath</a></td>
121 <td>Public method to get the filename of the config file.</td>
122 </tr>
123 <tr>
124 <td><a href="#VcsGitPlugin.getProjectHelper">getProjectHelper</a></td>
125 <td>Public method to get a reference to the project helper object.</td>
126 </tr>
127 <tr>
128 <td><a href="#VcsGitPlugin.initToolbar">initToolbar</a></td>
129 <td>Public slot to initialize the VCS toolbar.</td>
130 </tr>
131 <tr>
132 <td><a href="#VcsGitPlugin.prepareUninstall">prepareUninstall</a></td>
133 <td>Public method to prepare for an uninstallation.</td>
134 </tr>
135 <tr>
136 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td>
137 <td>Public method to prepare for an unload.</td>
138 </tr>
139 </table>
140 <h3>Static Methods</h3>
141
142 <table>
143 <tr><td>None</td></tr>
144 </table>
145
146 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a>
147 <h4>VcsGitPlugin.getPreferences (class method)</h4>
148 <b>getPreferences</b>(<i>key</i>)
149
150 <p>
151 Class method to retrieve the various settings.
152 </p>
153 <dl>
154
155 <dt><i>key</i></dt>
156 <dd>
157 the key of the value to get
158 </dd>
159 </dl>
160 <dl>
161 <dt>Return:</dt>
162 <dd>
163 the requested setting
164 </dd>
165 </dl>
166 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a>
167 <h4>VcsGitPlugin.setPreferences (class method)</h4>
168 <b>setPreferences</b>(<i>key, value</i>)
169
170 <p>
171 Class method to store the various settings.
172 </p>
173 <dl>
174
175 <dt><i>key</i></dt>
176 <dd>
177 the key of the setting to be set
178 </dd>
179 <dt><i>value</i></dt>
180 <dd>
181 the value to be set
182 </dd>
183 </dl>
184 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a>
185 <h4>VcsGitPlugin (Constructor)</h4>
186 <b>VcsGitPlugin</b>(<i>ui</i>)
187
188 <p>
189 Constructor
190 </p>
191 <dl>
192
193 <dt><i>ui</i></dt>
194 <dd>
195 reference to the user interface object (UI.UserInterface)
196 </dd>
197 </dl>
198 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a>
199 <h4>VcsGitPlugin.activate</h4>
200 <b>activate</b>(<i></i>)
201
202 <p>
203 Public method to activate this plugin.
204 </p>
205 <dl>
206 <dt>Return:</dt>
207 <dd>
208 tuple of reference to instantiated viewmanager and
209 activation status (boolean)
210 </dd>
211 </dl>
212 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a>
213 <h4>VcsGitPlugin.deactivate</h4>
214 <b>deactivate</b>(<i></i>)
215
216 <p>
217 Public method to deactivate this plugin.
218 </p>
219 <a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a>
220 <h4>VcsGitPlugin.getConfigPath</h4>
221 <b>getConfigPath</b>(<i></i>)
222
223 <p>
224 Public method to get the filename of the config file.
225 </p>
226 <dl>
227 <dt>Return:</dt>
228 <dd>
229 filename of the config file (string)
230 </dd>
231 </dl>
232 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a>
233 <h4>VcsGitPlugin.getProjectHelper</h4>
234 <b>getProjectHelper</b>(<i></i>)
235
236 <p>
237 Public method to get a reference to the project helper object.
238 </p>
239 <dl>
240 <dt>Return:</dt>
241 <dd>
242 reference to the project helper object
243 </dd>
244 </dl>
245 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a>
246 <h4>VcsGitPlugin.initToolbar</h4>
247 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
248
249 <p>
250 Public slot to initialize the VCS toolbar.
251 </p>
252 <dl>
253
254 <dt><i>ui</i></dt>
255 <dd>
256 reference to the main window (UserInterface)
257 </dd>
258 <dt><i>toolbarManager</i></dt>
259 <dd>
260 reference to a toolbar manager object
261 (EricToolBarManager)
262 </dd>
263 </dl>
264 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a>
265 <h4>VcsGitPlugin.prepareUninstall</h4>
266 <b>prepareUninstall</b>(<i></i>)
267
268 <p>
269 Public method to prepare for an uninstallation.
270 </p>
271 <a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a>
272 <h4>VcsGitPlugin.prepareUnload</h4>
273 <b>prepareUnload</b>(<i></i>)
274
275 <p>
276 Public method to prepare for an unload.
277 </p>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 <hr />
281 <a NAME="clearPrivateData" ID="clearPrivateData"></a>
282 <h2>clearPrivateData</h2>
283 <b>clearPrivateData</b>(<i></i>)
284
285 <p>
286 Module function to clear the private data of the plug-in.
287 </p>
288 <div align="right"><a href="#top">Up</a></div>
289 <hr />
290 <hr />
291 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a>
292 <h2>createConfigurationPage</h2>
293 <b>createConfigurationPage</b>(<i>configDlg</i>)
294
295 <p>
296 Module function to create the configuration page.
297 </p>
298 <dl>
299
300 <dt><i>configDlg</i></dt>
301 <dd>
302 reference to the configuration dialog (QDialog)
303 </dd>
304 </dl>
305 <dl>
306 <dt>Return:</dt>
307 <dd>
308 reference to the configuration page
309 </dd>
310 </dl>
311 <div align="right"><a href="#top">Up</a></div>
312 <hr />
313 <hr />
314 <a NAME="displayString" ID="displayString"></a>
315 <h2>displayString</h2>
316 <b>displayString</b>(<i></i>)
317
318 <p>
319 Public function to get the display string.
320 </p>
321 <dl>
322 <dt>Return:</dt>
323 <dd>
324 display string (string)
325 </dd>
326 </dl>
327 <div align="right"><a href="#top">Up</a></div>
328 <hr />
329 <hr />
330 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
331 <h2>exeDisplayData</h2>
332 <b>exeDisplayData</b>(<i></i>)
333
334 <p>
335 Public method to support the display of some executable info.
336 </p>
337 <dl>
338 <dt>Return:</dt>
339 <dd>
340 dictionary containing the data to query the presence of
341 the executable
342 </dd>
343 </dl>
344 <div align="right"><a href="#top">Up</a></div>
345 <hr />
346 <hr />
347 <a NAME="getConfigData" ID="getConfigData"></a>
348 <h2>getConfigData</h2>
349 <b>getConfigData</b>(<i></i>)
350
351 <p>
352 Module function returning data as required by the configuration dialog.
353 </p>
354 <dl>
355 <dt>Return:</dt>
356 <dd>
357 dictionary with key "zzz_gitPage" containing the relevant
358 data
359 </dd>
360 </dl>
361 <div align="right"><a href="#top">Up</a></div>
362 <hr />
363 <hr />
364 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a>
365 <h2>getVcsSystemIndicator</h2>
366 <b>getVcsSystemIndicator</b>(<i></i>)
367
368 <p>
369 Public function to get the indicators for this version control system.
370 </p>
371 <dl>
372 <dt>Return:</dt>
373 <dd>
374 dictionary with indicator as key and a tuple with the vcs name
375 (string) and vcs display string (string)
376 </dd>
377 </dl>
378 <div align="right"><a href="#top">Up</a></div>
379 <hr />
380 <hr />
381 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
382 <h2>prepareUninstall</h2>
383 <b>prepareUninstall</b>(<i></i>)
384
385 <p>
386 Module function to prepare for an uninstallation.
387 </p>
388 <div align="right"><a href="#top">Up</a></div>
389 <hr />
390 </body></html>

Mercurial Repository: eric

eric ide

mercurial