Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial