Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.subversion.html

Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.subversion.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.VcsPlugins.vcsPySvn.subversion</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.VcsPlugins.vcsPySvn.subversion</h1>
24 <p>
25 Module implementing the version control systems interface to Subversion.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Subversion">Subversion</a></td>
35 <td>Class implementing the version control systems interface to Subversion.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="Subversion" ID="Subversion"></a>
44 <h2>Subversion</h2>
45 <p>
46 Class implementing the version control systems interface to Subversion.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>committed()</dt>
50 <dd>
51 emitted after the commit action has completed
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 VersionControl
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#Subversion.__init__">Subversion</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#Subversion.__svnURL">__svnURL</a></td>
67 <td>Private method to format a url for subversion.</td>
68 </tr><tr>
69 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
70 <td>Private slot performing the second step of the commit action.</td>
71 </tr><tr>
72 <td><a href="#Subversion._createStatusMonitorThread">_createStatusMonitorThread</a></td>
73 <td>Protected method to create an instance of the VCS status monitor thread.</td>
74 </tr><tr>
75 <td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td>
76 <td>Public method to clear the status cache.</td>
77 </tr><tr>
78 <td><a href="#Subversion.getClient">getClient</a></td>
79 <td>Public method to create and initialize the pysvn client object.</td>
80 </tr><tr>
81 <td><a href="#Subversion.getPlugin">getPlugin</a></td>
82 <td>Public method to get a reference to the plugin object.</td>
83 </tr><tr>
84 <td><a href="#Subversion.svnAddToChangelist">svnAddToChangelist</a></td>
85 <td>Public method to add a file or directory to a changelist.</td>
86 </tr><tr>
87 <td><a href="#Subversion.svnBlame">svnBlame</a></td>
88 <td>Public method to show the output of the svn blame command.</td>
89 </tr><tr>
90 <td><a href="#Subversion.svnCopy">svnCopy</a></td>
91 <td>Public method used to copy a file/directory.</td>
92 </tr><tr>
93 <td><a href="#Subversion.svnDelProp">svnDelProp</a></td>
94 <td>Public method used to delete a property of a file/directory.</td>
95 </tr><tr>
96 <td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td>
97 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
98 </tr><tr>
99 <td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td>
100 <td>Public method used to retrieve the URL of the subversion repository path.</td>
101 </tr><tr>
102 <td><a href="#Subversion.svnInfo">svnInfo</a></td>
103 <td>Public method to show repository information about a file or directory.</td>
104 </tr><tr>
105 <td><a href="#Subversion.svnListProps">svnListProps</a></td>
106 <td>Public method used to list the properties of a file/directory.</td>
107 </tr><tr>
108 <td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td>
109 <td>Public method used to list the available tags or branches.</td>
110 </tr><tr>
111 <td><a href="#Subversion.svnLock">svnLock</a></td>
112 <td>Public method used to lock a file in the Subversion repository.</td>
113 </tr><tr>
114 <td><a href="#Subversion.svnLogBrowser">svnLogBrowser</a></td>
115 <td>Public method used to browse the log of a file/directory from the Subversion repository.</td>
116 </tr><tr>
117 <td><a href="#Subversion.svnLogLimited">svnLogLimited</a></td>
118 <td>Public method used to view the (limited) log of a file/directory from the Subversion repository.</td>
119 </tr><tr>
120 <td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td>
121 <td>Public method to normalize a url for subversion.</td>
122 </tr><tr>
123 <td><a href="#Subversion.svnRelocate">svnRelocate</a></td>
124 <td>Public method to relocate the working copy to a new repository URL.</td>
125 </tr><tr>
126 <td><a href="#Subversion.svnRemoveFromChangelist">svnRemoveFromChangelist</a></td>
127 <td>Public method to remove a file or directory from it's changelist.</td>
128 </tr><tr>
129 <td><a href="#Subversion.svnRepoBrowser">svnRepoBrowser</a></td>
130 <td>Public method to open the repository browser.</td>
131 </tr><tr>
132 <td><a href="#Subversion.svnResolve">svnResolve</a></td>
133 <td>Public method used to resolve conflicts of a file/directory.</td>
134 </tr><tr>
135 <td><a href="#Subversion.svnSetProp">svnSetProp</a></td>
136 <td>Public method used to add a property to a file/directory.</td>
137 </tr><tr>
138 <td><a href="#Subversion.svnUnlock">svnUnlock</a></td>
139 <td>Public method used to unlock a file in the Subversion repository.</td>
140 </tr><tr>
141 <td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td>
142 <td>Public method used to view the difference of a file/directory of two repository URLs.</td>
143 </tr><tr>
144 <td><a href="#Subversion.vcsAdd">vcsAdd</a></td>
145 <td>Public method used to add a file/directory to the Subversion repository.</td>
146 </tr><tr>
147 <td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td>
148 <td>Public method used to add a file/directory in binary mode to the Subversion repository.</td>
149 </tr><tr>
150 <td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td>
151 <td>Public method to add a directory tree rooted at path to the Subversion repository.</td>
152 </tr><tr>
153 <td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
154 <td>Public method used to get the registered states of a number of files in the vcs.</td>
155 </tr><tr>
156 <td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td>
157 <td>Public method used to check the project out of the Subversion repository.</td>
158 </tr><tr>
159 <td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td>
160 <td>Public method used to cleanup the working copy.</td>
161 </tr><tr>
162 <td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td>
163 <td>Public method used to execute arbitrary subversion commands.</td>
164 </tr><tr>
165 <td><a href="#Subversion.vcsCommit">vcsCommit</a></td>
166 <td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td>
167 </tr><tr>
168 <td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td>
169 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
170 </tr><tr>
171 <td><a href="#Subversion.vcsDiff">vcsDiff</a></td>
172 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
173 </tr><tr>
174 <td><a href="#Subversion.vcsExists">vcsExists</a></td>
175 <td>Public method used to test for the presence of the svn executable.</td>
176 </tr><tr>
177 <td><a href="#Subversion.vcsExport">vcsExport</a></td>
178 <td>Public method used to export a directory from the Subversion repository.</td>
179 </tr><tr>
180 <td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
181 <td>Public method to instanciate a helper object for the different project browsers.</td>
182 </tr><tr>
183 <td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
184 <td>Public method to instanciate a helper object for the project.</td>
185 </tr><tr>
186 <td><a href="#Subversion.vcsImport">vcsImport</a></td>
187 <td>Public method used to import the project into the Subversion repository.</td>
188 </tr><tr>
189 <td><a href="#Subversion.vcsInit">vcsInit</a></td>
190 <td>Public method used to initialize the subversion repository.</td>
191 </tr><tr>
192 <td><a href="#Subversion.vcsLog">vcsLog</a></td>
193 <td>Public method used to view the log of a file/directory from the Subversion repository.</td>
194 </tr><tr>
195 <td><a href="#Subversion.vcsMerge">vcsMerge</a></td>
196 <td>Public method used to merge a URL/revision into the local project.</td>
197 </tr><tr>
198 <td><a href="#Subversion.vcsMove">vcsMove</a></td>
199 <td>Public method used to move a file/directory.</td>
200 </tr><tr>
201 <td><a href="#Subversion.vcsName">vcsName</a></td>
202 <td>Public method returning the name of the vcs.</td>
203 </tr><tr>
204 <td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
205 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
206 </tr><tr>
207 <td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td>
208 <td>Public method to get a dialog to enter repository info.</td>
209 </tr><tr>
210 <td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td>
211 <td>Public method used to get the registered state of a file in the vcs.</td>
212 </tr><tr>
213 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
214 <td>Public method used to remove a file/directory from the Subversion repository.</td>
215 </tr><tr>
216 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
217 <td>Public method to retrieve information about the repository.</td>
218 </tr><tr>
219 <td><a href="#Subversion.vcsRevert">vcsRevert</a></td>
220 <td>Public method used to revert changes made to a file/directory.</td>
221 </tr><tr>
222 <td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td>
223 <td>Public method used to shutdown the Subversion interface.</td>
224 </tr><tr>
225 <td><a href="#Subversion.vcsStatus">vcsStatus</a></td>
226 <td>Public method used to view the status of files/directories in the Subversion repository.</td>
227 </tr><tr>
228 <td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td>
229 <td>Public method used to switch a directory to a different tag/branch.</td>
230 </tr><tr>
231 <td><a href="#Subversion.vcsTag">vcsTag</a></td>
232 <td>Public method used to set the tag of a file/directory in the Subversion repository.</td>
233 </tr><tr>
234 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
235 <td>Public method used to update a file/directory with the Subversion repository.</td>
236 </tr>
237 </table>
238 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
239 <h4>Subversion (Constructor)</h4>
240 <b>Subversion</b>(<i>plugin, parent = None, name = None</i>)
241 <p>
242 Constructor
243 </p><dl>
244 <dt><i>plugin</i></dt>
245 <dd>
246 reference to the plugin object
247 </dd><dt><i>parent</i></dt>
248 <dd>
249 parent widget (QWidget)
250 </dd><dt><i>name</i></dt>
251 <dd>
252 name of this object (string)
253 </dd>
254 </dl><a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
255 <h4>Subversion.__svnURL</h4>
256 <b>__svnURL</b>(<i>url</i>)
257 <p>
258 Private method to format a url for subversion.
259 </p><dl>
260 <dt><i>url</i></dt>
261 <dd>
262 unformatted url string (string)
263 </dd>
264 </dl><dl>
265 <dt>Returns:</dt>
266 <dd>
267 properly formated url for subversion (string)
268 </dd>
269 </dl><a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
270 <h4>Subversion.__vcsCommit_Step2</h4>
271 <b>__vcsCommit_Step2</b>(<i></i>)
272 <p>
273 Private slot performing the second step of the commit action.
274 </p><a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
275 <h4>Subversion._createStatusMonitorThread</h4>
276 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
277 <p>
278 Protected method to create an instance of the VCS status monitor thread.
279 </p><dl>
280 <dt><i>project</i></dt>
281 <dd>
282 reference to the project object
283 </dd><dt><i>interval</i></dt>
284 <dd>
285 check interval for the monitor thread in seconds (integer)
286 </dd>
287 </dl><dl>
288 <dt>Returns:</dt>
289 <dd>
290 reference to the monitor thread (QThread)
291 </dd>
292 </dl><a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
293 <h4>Subversion.clearStatusCache</h4>
294 <b>clearStatusCache</b>(<i></i>)
295 <p>
296 Public method to clear the status cache.
297 </p><a NAME="Subversion.getClient" ID="Subversion.getClient"></a>
298 <h4>Subversion.getClient</h4>
299 <b>getClient</b>(<i></i>)
300 <p>
301 Public method to create and initialize the pysvn client object.
302 </p><dl>
303 <dt>Returns:</dt>
304 <dd>
305 the pysvn client object (pysvn.Client)
306 </dd>
307 </dl><a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
308 <h4>Subversion.getPlugin</h4>
309 <b>getPlugin</b>(<i></i>)
310 <p>
311 Public method to get a reference to the plugin object.
312 </p><dl>
313 <dt>Returns:</dt>
314 <dd>
315 reference to the plugin object (VcsPySvnPlugin)
316 </dd>
317 </dl><a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
318 <h4>Subversion.svnAddToChangelist</h4>
319 <b>svnAddToChangelist</b>(<i>names</i>)
320 <p>
321 Public method to add a file or directory to a changelist.
322 </p><p>
323 Note: Directories will be added recursively.
324 </p><dl>
325 <dt><i>names</i></dt>
326 <dd>
327 name or list of names of file or directory to add
328 (string)
329 </dd>
330 </dl><a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
331 <h4>Subversion.svnBlame</h4>
332 <b>svnBlame</b>(<i>name</i>)
333 <p>
334 Public method to show the output of the svn blame command.
335 </p><dl>
336 <dt><i>name</i></dt>
337 <dd>
338 file name to show the blame for (string)
339 </dd>
340 </dl><a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
341 <h4>Subversion.svnCopy</h4>
342 <b>svnCopy</b>(<i>name, project</i>)
343 <p>
344 Public method used to copy a file/directory.
345 </p><dl>
346 <dt><i>name</i></dt>
347 <dd>
348 file/directory name to be copied (string)
349 </dd><dt><i>project</i></dt>
350 <dd>
351 reference to the project object
352 </dd>
353 </dl><dl>
354 <dt>Returns:</dt>
355 <dd>
356 flag indicating successfull operation (boolean)
357 </dd>
358 </dl><a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
359 <h4>Subversion.svnDelProp</h4>
360 <b>svnDelProp</b>(<i>name, recursive = False</i>)
361 <p>
362 Public method used to delete a property of a file/directory.
363 </p><dl>
364 <dt><i>name</i></dt>
365 <dd>
366 file/directory name (string or list of strings)
367 </dd><dt><i>recursive</i></dt>
368 <dd>
369 flag indicating a recursive list is requested
370 </dd>
371 </dl><a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
372 <h4>Subversion.svnExtendedDiff</h4>
373 <b>svnExtendedDiff</b>(<i>name</i>)
374 <p>
375 Public method used to view the difference of a file/directory to the
376 Subversion repository.
377 </p><p>
378 If name is a directory and is the project directory, all project files
379 are saved first. If name is a file (or list of files), which is/are being edited
380 and has unsaved modification, they can be saved or the operation may be aborted.
381 </p><p>
382 This method gives the chance to enter the revisions to be compared.
383 </p><dl>
384 <dt><i>name</i></dt>
385 <dd>
386 file/directory name to be diffed (string)
387 </dd>
388 </dl><a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
389 <h4>Subversion.svnGetReposName</h4>
390 <b>svnGetReposName</b>(<i>path</i>)
391 <p>
392 Public method used to retrieve the URL of the subversion repository path.
393 </p><dl>
394 <dt><i>path</i></dt>
395 <dd>
396 local path to get the svn repository path for (string)
397 </dd>
398 </dl><dl>
399 <dt>Returns:</dt>
400 <dd>
401 string with the repository path URL
402 </dd>
403 </dl><a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a>
404 <h4>Subversion.svnInfo</h4>
405 <b>svnInfo</b>(<i>projectPath, name</i>)
406 <p>
407 Public method to show repository information about a file or directory.
408 </p><dl>
409 <dt><i>projectPath</i></dt>
410 <dd>
411 path name of the project (string)
412 </dd><dt><i>name</i></dt>
413 <dd>
414 file/directory name relative to the project (string)
415 </dd>
416 </dl><a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
417 <h4>Subversion.svnListProps</h4>
418 <b>svnListProps</b>(<i>name, recursive = False</i>)
419 <p>
420 Public method used to list the properties of a file/directory.
421 </p><dl>
422 <dt><i>name</i></dt>
423 <dd>
424 file/directory name (string or list of strings)
425 </dd><dt><i>recursive</i></dt>
426 <dd>
427 flag indicating a recursive list is requested
428 </dd>
429 </dl><a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
430 <h4>Subversion.svnListTagBranch</h4>
431 <b>svnListTagBranch</b>(<i>path, tags = True</i>)
432 <p>
433 Public method used to list the available tags or branches.
434 </p><dl>
435 <dt><i>path</i></dt>
436 <dd>
437 directory name of the project (string)
438 </dd><dt><i>tags</i></dt>
439 <dd>
440 flag indicating listing of branches or tags
441 (False = branches, True = tags)
442 </dd>
443 </dl><a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
444 <h4>Subversion.svnLock</h4>
445 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
446 <p>
447 Public method used to lock a file in the Subversion repository.
448 </p><dl>
449 <dt><i>name</i></dt>
450 <dd>
451 file/directory name to be locked (string or list of strings)
452 </dd><dt><i>stealIt</i></dt>
453 <dd>
454 flag indicating a forced operation (boolean)
455 </dd><dt><i>parent</i></dt>
456 <dd>
457 reference to the parent object of the subversion dialog (QWidget)
458 </dd>
459 </dl><a NAME="Subversion.svnLogBrowser" ID="Subversion.svnLogBrowser"></a>
460 <h4>Subversion.svnLogBrowser</h4>
461 <b>svnLogBrowser</b>(<i>path</i>)
462 <p>
463 Public method used to browse the log of a file/directory from the
464 Subversion repository.
465 </p><dl>
466 <dt><i>path</i></dt>
467 <dd>
468 file/directory name to show the log of (string)
469 </dd>
470 </dl><a NAME="Subversion.svnLogLimited" ID="Subversion.svnLogLimited"></a>
471 <h4>Subversion.svnLogLimited</h4>
472 <b>svnLogLimited</b>(<i>name</i>)
473 <p>
474 Public method used to view the (limited) log of a file/directory from the
475 Subversion repository.
476 </p><dl>
477 <dt><i>name</i></dt>
478 <dd>
479 file/directory name to show the log of (string)
480 </dd>
481 </dl><a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
482 <h4>Subversion.svnNormalizeURL</h4>
483 <b>svnNormalizeURL</b>(<i>url</i>)
484 <p>
485 Public method to normalize a url for subversion.
486 </p><dl>
487 <dt><i>url</i></dt>
488 <dd>
489 url string (string)
490 </dd>
491 </dl><dl>
492 <dt>Returns:</dt>
493 <dd>
494 properly normalized url for subversion (string)
495 </dd>
496 </dl><a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
497 <h4>Subversion.svnRelocate</h4>
498 <b>svnRelocate</b>(<i>projectPath</i>)
499 <p>
500 Public method to relocate the working copy to a new repository URL.
501 </p><dl>
502 <dt><i>projectPath</i></dt>
503 <dd>
504 path name of the project (string)
505 </dd>
506 </dl><a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
507 <h4>Subversion.svnRemoveFromChangelist</h4>
508 <b>svnRemoveFromChangelist</b>(<i>names</i>)
509 <p>
510 Public method to remove a file or directory from it's changelist.
511 </p><p>
512 Note: Directories will be removed recursively.
513 </p><dl>
514 <dt><i>names</i></dt>
515 <dd>
516 name or list of names of file or directory to remove
517 (string)
518 </dd>
519 </dl><a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
520 <h4>Subversion.svnRepoBrowser</h4>
521 <b>svnRepoBrowser</b>(<i>projectPath = None</i>)
522 <p>
523 Public method to open the repository browser.
524 </p><dl>
525 <dt><i>projectPath</i></dt>
526 <dd>
527 path name of the project (string)
528 </dd>
529 </dl><a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a>
530 <h4>Subversion.svnResolve</h4>
531 <b>svnResolve</b>(<i>name</i>)
532 <p>
533 Public method used to resolve conflicts of a file/directory.
534 </p><dl>
535 <dt><i>name</i></dt>
536 <dd>
537 file/directory name to be resolved (string)
538 </dd>
539 </dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
540 <h4>Subversion.svnSetProp</h4>
541 <b>svnSetProp</b>(<i>name, recursive = False</i>)
542 <p>
543 Public method used to add a property to a file/directory.
544 </p><dl>
545 <dt><i>name</i></dt>
546 <dd>
547 file/directory name (string or list of strings)
548 </dd><dt><i>recursive</i></dt>
549 <dd>
550 flag indicating a recursive set is requested
551 </dd>
552 </dl><a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
553 <h4>Subversion.svnUnlock</h4>
554 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
555 <p>
556 Public method used to unlock a file in the Subversion repository.
557 </p><dl>
558 <dt><i>name</i></dt>
559 <dd>
560 file/directory name to be unlocked (string or list of strings)
561 </dd><dt><i>breakIt</i></dt>
562 <dd>
563 flag indicating a forced operation (boolean)
564 </dd><dt><i>parent</i></dt>
565 <dd>
566 reference to the parent object of the subversion dialog (QWidget)
567 </dd>
568 </dl><a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
569 <h4>Subversion.svnUrlDiff</h4>
570 <b>svnUrlDiff</b>(<i>name</i>)
571 <p>
572 Public method used to view the difference of a file/directory of two
573 repository URLs.
574 </p><p>
575 If name is a directory and is the project directory, all project files
576 are saved first. If name is a file (or list of files), which is/are being edited
577 and has unsaved modification, they can be saved or the operation may be aborted.
578 </p><p>
579 This method gives the chance to enter the revisions to be compared.
580 </p><dl>
581 <dt><i>name</i></dt>
582 <dd>
583 file/directory name to be diffed (string)
584 </dd>
585 </dl><a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
586 <h4>Subversion.vcsAdd</h4>
587 <b>vcsAdd</b>(<i>name, isDir = False, noDialog = False</i>)
588 <p>
589 Public method used to add a file/directory to the Subversion repository.
590 </p><dl>
591 <dt><i>name</i></dt>
592 <dd>
593 file/directory name to be added (string)
594 </dd><dt><i>isDir</i></dt>
595 <dd>
596 flag indicating name is a directory (boolean)
597 </dd><dt><i>noDialog</i></dt>
598 <dd>
599 flag indicating quiet operations (boolean)
600 </dd>
601 </dl><a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
602 <h4>Subversion.vcsAddBinary</h4>
603 <b>vcsAddBinary</b>(<i>name, isDir = False</i>)
604 <p>
605 Public method used to add a file/directory in binary mode to the
606 Subversion repository.
607 </p><dl>
608 <dt><i>name</i></dt>
609 <dd>
610 file/directory name to be added (string)
611 </dd><dt><i>isDir</i></dt>
612 <dd>
613 flag indicating name is a directory (boolean)
614 </dd>
615 </dl><a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
616 <h4>Subversion.vcsAddTree</h4>
617 <b>vcsAddTree</b>(<i>path</i>)
618 <p>
619 Public method to add a directory tree rooted at path to the Subversion repository.
620 </p><dl>
621 <dt><i>path</i></dt>
622 <dd>
623 root directory of the tree to be added (string or list of strings))
624 </dd>
625 </dl><a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
626 <h4>Subversion.vcsAllRegisteredStates</h4>
627 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut = True</i>)
628 <p>
629 Public method used to get the registered states of a number of files in the vcs.
630 </p><p>
631 <b>Note:</b> If a shortcut is to be taken, the code will only check, if the named
632 directory has been scanned already. If so, it is assumed, that the states for
633 all files has been populated by the previous run.
634 </p><dl>
635 <dt><i>names</i></dt>
636 <dd>
637 dictionary with all filenames to be checked as keys
638 </dd><dt><i>dname</i></dt>
639 <dd>
640 directory to check in (string)
641 </dd><dt><i>shortcut</i></dt>
642 <dd>
643 flag indicating a shortcut should be taken (boolean)
644 </dd>
645 </dl><dl>
646 <dt>Returns:</dt>
647 <dd>
648 the received dictionary completed with a combination of
649 canBeCommited and canBeAdded or None in order to signal an error
650 </dd>
651 </dl><a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
652 <h4>Subversion.vcsCheckout</h4>
653 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog = False</i>)
654 <p>
655 Public method used to check the project out of the Subversion repository.
656 </p><dl>
657 <dt><i>vcsDataDict</i></dt>
658 <dd>
659 dictionary of data required for the checkout
660 </dd><dt><i>projectDir</i></dt>
661 <dd>
662 project directory to create (string)
663 </dd><dt><i>noDialog</i></dt>
664 <dd>
665 flag indicating quiet operations
666 </dd>
667 </dl><dl>
668 <dt>Returns:</dt>
669 <dd>
670 flag indicating an execution without errors (boolean)
671 </dd>
672 </dl><a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
673 <h4>Subversion.vcsCleanup</h4>
674 <b>vcsCleanup</b>(<i>name</i>)
675 <p>
676 Public method used to cleanup the working copy.
677 </p><dl>
678 <dt><i>name</i></dt>
679 <dd>
680 directory name to be cleaned up (string)
681 </dd>
682 </dl><a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
683 <h4>Subversion.vcsCommandLine</h4>
684 <b>vcsCommandLine</b>(<i>name</i>)
685 <p>
686 Public method used to execute arbitrary subversion commands.
687 </p><dl>
688 <dt><i>name</i></dt>
689 <dd>
690 directory name of the working directory (string)
691 </dd>
692 </dl><a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
693 <h4>Subversion.vcsCommit</h4>
694 <b>vcsCommit</b>(<i>name, message, noDialog = False</i>)
695 <p>
696 Public method used to make the change of a file/directory permanent in the
697 Subversion repository.
698 </p><dl>
699 <dt><i>name</i></dt>
700 <dd>
701 file/directory name to be committed (string or list of strings)
702 </dd><dt><i>message</i></dt>
703 <dd>
704 message for this operation (string)
705 </dd><dt><i>noDialog</i></dt>
706 <dd>
707 flag indicating quiet operations
708 </dd>
709 </dl><a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
710 <h4>Subversion.vcsConvertProject</h4>
711 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
712 <p>
713 Public method to convert an uncontrolled project to a version controlled project.
714 </p><dl>
715 <dt><i>vcsDataDict</i></dt>
716 <dd>
717 dictionary of data required for the conversion
718 </dd><dt><i>project</i></dt>
719 <dd>
720 reference to the project object
721 </dd>
722 </dl><a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
723 <h4>Subversion.vcsDiff</h4>
724 <b>vcsDiff</b>(<i>name</i>)
725 <p>
726 Public method used to view the difference of a file/directory to the
727 Subversion repository.
728 </p><p>
729 If name is a directory and is the project directory, all project files
730 are saved first. If name is a file (or list of files), which is/are being edited
731 and has unsaved modification, they can be saved or the operation may be aborted.
732 </p><dl>
733 <dt><i>name</i></dt>
734 <dd>
735 file/directory name to be diffed (string)
736 </dd>
737 </dl><a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
738 <h4>Subversion.vcsExists</h4>
739 <b>vcsExists</b>(<i></i>)
740 <p>
741 Public method used to test for the presence of the svn executable.
742 </p><dl>
743 <dt>Returns:</dt>
744 <dd>
745 flag indicating the existance (boolean) and an error message (string)
746 </dd>
747 </dl><a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
748 <h4>Subversion.vcsExport</h4>
749 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
750 <p>
751 Public method used to export a directory from the Subversion repository.
752 </p><dl>
753 <dt><i>vcsDataDict</i></dt>
754 <dd>
755 dictionary of data required for the checkout
756 </dd><dt><i>projectDir</i></dt>
757 <dd>
758 project directory to create (string)
759 </dd>
760 </dl><dl>
761 <dt>Returns:</dt>
762 <dd>
763 flag indicating an execution without errors (boolean)
764 </dd>
765 </dl><a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
766 <h4>Subversion.vcsGetProjectBrowserHelper</h4>
767 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser = False</i>)
768 <p>
769 Public method to instanciate a helper object for the different project browsers.
770 </p><dl>
771 <dt><i>browser</i></dt>
772 <dd>
773 reference to the project browser object
774 </dd><dt><i>project</i></dt>
775 <dd>
776 reference to the project object
777 </dd><dt><i>isTranslationsBrowser</i></dt>
778 <dd>
779 flag indicating, the helper is requested for the
780 translations browser (this needs some special treatment)
781 </dd>
782 </dl><dl>
783 <dt>Returns:</dt>
784 <dd>
785 the project browser helper object
786 </dd>
787 </dl><a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
788 <h4>Subversion.vcsGetProjectHelper</h4>
789 <b>vcsGetProjectHelper</b>(<i>project</i>)
790 <p>
791 Public method to instanciate a helper object for the project.
792 </p><dl>
793 <dt><i>project</i></dt>
794 <dd>
795 reference to the project object
796 </dd>
797 </dl><dl>
798 <dt>Returns:</dt>
799 <dd>
800 the project helper object
801 </dd>
802 </dl><a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
803 <h4>Subversion.vcsImport</h4>
804 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog = False</i>)
805 <p>
806 Public method used to import the project into the Subversion repository.
807 </p><dl>
808 <dt><i>vcsDataDict</i></dt>
809 <dd>
810 dictionary of data required for the import
811 </dd><dt><i>projectDir</i></dt>
812 <dd>
813 project directory (string)
814 </dd><dt><i>noDialog</i></dt>
815 <dd>
816 flag indicating quiet operations
817 </dd>
818 </dl><dl>
819 <dt>Returns:</dt>
820 <dd>
821 flag indicating an execution without errors (boolean)
822 and a flag indicating the version controll status (boolean)
823 </dd>
824 </dl><a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
825 <h4>Subversion.vcsInit</h4>
826 <b>vcsInit</b>(<i>vcsDir, noDialog = False</i>)
827 <p>
828 Public method used to initialize the subversion repository.
829 </p><p>
830 The subversion repository has to be initialized from outside eric4
831 because the respective command always works locally. Therefore we
832 always return TRUE without doing anything.
833 </p><dl>
834 <dt><i>vcsDir</i></dt>
835 <dd>
836 name of the VCS directory (string)
837 </dd><dt><i>noDialog</i></dt>
838 <dd>
839 flag indicating quiet operations (boolean)
840 </dd>
841 </dl><dl>
842 <dt>Returns:</dt>
843 <dd>
844 always TRUE
845 </dd>
846 </dl><a NAME="Subversion.vcsLog" ID="Subversion.vcsLog"></a>
847 <h4>Subversion.vcsLog</h4>
848 <b>vcsLog</b>(<i>name</i>)
849 <p>
850 Public method used to view the log of a file/directory from the
851 Subversion repository.
852 </p><dl>
853 <dt><i>name</i></dt>
854 <dd>
855 file/directory name to show the log of (string)
856 </dd>
857 </dl><a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
858 <h4>Subversion.vcsMerge</h4>
859 <b>vcsMerge</b>(<i>name</i>)
860 <p>
861 Public method used to merge a URL/revision into the local project.
862 </p><dl>
863 <dt><i>name</i></dt>
864 <dd>
865 file/directory name to be merged (string)
866 </dd>
867 </dl><a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
868 <h4>Subversion.vcsMove</h4>
869 <b>vcsMove</b>(<i>name, project, target = None, noDialog = False</i>)
870 <p>
871 Public method used to move a file/directory.
872 </p><dl>
873 <dt><i>name</i></dt>
874 <dd>
875 file/directory name to be moved (string)
876 </dd><dt><i>project</i></dt>
877 <dd>
878 reference to the project object
879 </dd><dt><i>target</i></dt>
880 <dd>
881 new name of the file/directory (string)
882 </dd><dt><i>noDialog</i></dt>
883 <dd>
884 flag indicating quiet operations
885 </dd>
886 </dl><dl>
887 <dt>Returns:</dt>
888 <dd>
889 flag indicating successfull operation (boolean)
890 </dd>
891 </dl><a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
892 <h4>Subversion.vcsName</h4>
893 <b>vcsName</b>(<i></i>)
894 <p>
895 Public method returning the name of the vcs.
896 </p><dl>
897 <dt>Returns:</dt>
898 <dd>
899 always 'Subversion' (string)
900 </dd>
901 </dl><a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
902 <h4>Subversion.vcsNewProjectOptionsDialog</h4>
903 <b>vcsNewProjectOptionsDialog</b>(<i>parent = None</i>)
904 <p>
905 Public method to get a dialog to enter repository info for getting a new project.
906 </p><dl>
907 <dt><i>parent</i></dt>
908 <dd>
909 parent widget (QWidget)
910 </dd>
911 </dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
912 <h4>Subversion.vcsOptionsDialog</h4>
913 <b>vcsOptionsDialog</b>(<i>project, archive, editable = False, parent = None</i>)
914 <p>
915 Public method to get a dialog to enter repository info.
916 </p><dl>
917 <dt><i>project</i></dt>
918 <dd>
919 reference to the project object
920 </dd><dt><i>archive</i></dt>
921 <dd>
922 name of the project in the repository (string)
923 </dd><dt><i>editable</i></dt>
924 <dd>
925 flag indicating that the project name is editable (boolean)
926 </dd><dt><i>parent</i></dt>
927 <dd>
928 parent widget (QWidget)
929 </dd>
930 </dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
931 <h4>Subversion.vcsRegisteredState</h4>
932 <b>vcsRegisteredState</b>(<i>name</i>)
933 <p>
934 Public method used to get the registered state of a file in the vcs.
935 </p><dl>
936 <dt><i>name</i></dt>
937 <dd>
938 filename to check (string)
939 </dd>
940 </dl><dl>
941 <dt>Returns:</dt>
942 <dd>
943 a combination of canBeCommited and canBeAdded
944 </dd>
945 </dl><a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
946 <h4>Subversion.vcsRemove</h4>
947 <b>vcsRemove</b>(<i>name, project = False, noDialog = False</i>)
948 <p>
949 Public method used to remove a file/directory from the Subversion repository.
950 </p><p>
951 The default operation is to remove the local copy as well.
952 </p><dl>
953 <dt><i>name</i></dt>
954 <dd>
955 file/directory name to be removed (string or list of strings))
956 </dd><dt><i>project</i></dt>
957 <dd>
958 flag indicating deletion of a project tree (boolean) (not needed)
959 </dd><dt><i>noDialog</i></dt>
960 <dd>
961 flag indicating quiet operations
962 </dd>
963 </dl><dl>
964 <dt>Returns:</dt>
965 <dd>
966 flag indicating successfull operation (boolean)
967 </dd>
968 </dl><a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
969 <h4>Subversion.vcsRepositoryInfos</h4>
970 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
971 <p>
972 Public method to retrieve information about the repository.
973 </p><dl>
974 <dt><i>ppath</i></dt>
975 <dd>
976 local path to get the repository infos (string)
977 </dd>
978 </dl><dl>
979 <dt>Returns:</dt>
980 <dd>
981 string with ready formated info for display (string)
982 </dd>
983 </dl><a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
984 <h4>Subversion.vcsRevert</h4>
985 <b>vcsRevert</b>(<i>name</i>)
986 <p>
987 Public method used to revert changes made to a file/directory.
988 </p><dl>
989 <dt><i>name</i></dt>
990 <dd>
991 file/directory name to be reverted (string)
992 </dd>
993 </dl><a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
994 <h4>Subversion.vcsShutdown</h4>
995 <b>vcsShutdown</b>(<i></i>)
996 <p>
997 Public method used to shutdown the Subversion interface.
998 </p><a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
999 <h4>Subversion.vcsStatus</h4>
1000 <b>vcsStatus</b>(<i>name</i>)
1001 <p>
1002 Public method used to view the status of files/directories in the
1003 Subversion repository.
1004 </p><dl>
1005 <dt><i>name</i></dt>
1006 <dd>
1007 file/directory name(s) to show the status of
1008 (string or list of strings)
1009 </dd>
1010 </dl><a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
1011 <h4>Subversion.vcsSwitch</h4>
1012 <b>vcsSwitch</b>(<i>name</i>)
1013 <p>
1014 Public method used to switch a directory to a different tag/branch.
1015 </p><dl>
1016 <dt><i>name</i></dt>
1017 <dd>
1018 directory name to be switched (string)
1019 </dd>
1020 </dl><a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
1021 <h4>Subversion.vcsTag</h4>
1022 <b>vcsTag</b>(<i>name</i>)
1023 <p>
1024 Public method used to set the tag of a file/directory in the
1025 Subversion repository.
1026 </p><dl>
1027 <dt><i>name</i></dt>
1028 <dd>
1029 file/directory name to be tagged (string)
1030 </dd>
1031 </dl><a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
1032 <h4>Subversion.vcsUpdate</h4>
1033 <b>vcsUpdate</b>(<i>name, noDialog = False</i>)
1034 <p>
1035 Public method used to update a file/directory with the Subversion repository.
1036 </p><dl>
1037 <dt><i>name</i></dt>
1038 <dd>
1039 file/directory name to be updated (string or list of strings)
1040 </dd><dt><i>noDialog</i></dt>
1041 <dd>
1042 flag indicating quiet operations (boolean)
1043 </dd>
1044 </dl><dl>
1045 <dt>Returns:</dt>
1046 <dd>
1047 flag indicating, that the update contained an add
1048 or delete (boolean)
1049 </dd>
1050 </dl>
1051 <div align="right"><a href="#top">Up</a></div>
1052 <hr />
1053 </body></html>

Mercurial Repository: eric

eric ide

mercurial