Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.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.VcsPlugins.vcsSubversion.subversion</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.VcsPlugins.vcsSubversion.subversion</h1>
24
25 <p>
26 Module implementing the version control systems interface to Subversion.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#Subversion">Subversion</a></td>
39 <td>Class implementing the version control systems interface to Subversion.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="Subversion" ID="Subversion"></a>
50 <h2>Subversion</h2>
51
52 <p>
53 Class implementing the version control systems interface to Subversion.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>committed()</dt>
59 <dd>
60 emitted after the commit action has completed
61 </dd>
62 </dl>
63 <h3>Derived from</h3>
64 VersionControl
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#Subversion.__init__">Subversion</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#Subversion.__svnGetFileForRevision">__svnGetFileForRevision</a></td>
85 <td>Private method to get a file for a specific revision from the repository.</td>
86 </tr>
87 <tr>
88 <td><a href="#Subversion.__svnURL">__svnURL</a></td>
89 <td>Private method to format a url for subversion.</td>
90 </tr>
91 <tr>
92 <td><a href="#Subversion.__vcsAllRegisteredStates_wc">__vcsAllRegisteredStates_wc</a></td>
93 <td>Private method used to get the registered states of a number of files in the VCS.</td>
94 </tr>
95 <tr>
96 <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td>
97 <td>Private method used to get the registered states of a number of files in the VCS.</td>
98 </tr>
99 <tr>
100 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
101 <td>Private slot performing the second step of the commit action.</td>
102 </tr>
103 <tr>
104 <td><a href="#Subversion.__vcsRegisteredState_wc">__vcsRegisteredState_wc</a></td>
105 <td>Private method used to get the registered state of a file in the VCS.</td>
106 </tr>
107 <tr>
108 <td><a href="#Subversion.__vcsRegisteredState_wcng">__vcsRegisteredState_wcng</a></td>
109 <td>Private method used to get the registered state of a file in the vcs.</td>
110 </tr>
111 <tr>
112 <td><a href="#Subversion._createStatusMonitorThread">_createStatusMonitorThread</a></td>
113 <td>Protected method to create an instance of the VCS status monitor thread.</td>
114 </tr>
115 <tr>
116 <td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td>
117 <td>Public method to clear the status cache.</td>
118 </tr>
119 <tr>
120 <td><a href="#Subversion.getPlugin">getPlugin</a></td>
121 <td>Public method to get a reference to the plugin object.</td>
122 </tr>
123 <tr>
124 <td><a href="#Subversion.svnAddToChangelist">svnAddToChangelist</a></td>
125 <td>Public method to add a file or directory to a changelist.</td>
126 </tr>
127 <tr>
128 <td><a href="#Subversion.svnBlame">svnBlame</a></td>
129 <td>Public method to show the output of the svn blame command.</td>
130 </tr>
131 <tr>
132 <td><a href="#Subversion.svnCopy">svnCopy</a></td>
133 <td>Public method used to copy a file/directory.</td>
134 </tr>
135 <tr>
136 <td><a href="#Subversion.svnDelProp">svnDelProp</a></td>
137 <td>Public method used to delete a property of a file/directory.</td>
138 </tr>
139 <tr>
140 <td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td>
141 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
142 </tr>
143 <tr>
144 <td><a href="#Subversion.svnGetChangelists">svnGetChangelists</a></td>
145 <td>Public method to get a list of all defined change lists.</td>
146 </tr>
147 <tr>
148 <td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td>
149 <td>Public method used to retrieve the URL of the subversion repository path.</td>
150 </tr>
151 <tr>
152 <td><a href="#Subversion.svnListProps">svnListProps</a></td>
153 <td>Public method used to list the properties of a file/directory.</td>
154 </tr>
155 <tr>
156 <td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td>
157 <td>Public method used to list the available tags or branches.</td>
158 </tr>
159 <tr>
160 <td><a href="#Subversion.svnLock">svnLock</a></td>
161 <td>Public method used to lock a file in the Subversion repository.</td>
162 </tr>
163 <tr>
164 <td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td>
165 <td>Public method to normalize a url for subversion.</td>
166 </tr>
167 <tr>
168 <td><a href="#Subversion.svnRelocate">svnRelocate</a></td>
169 <td>Public method to relocate the working copy to a new repository URL.</td>
170 </tr>
171 <tr>
172 <td><a href="#Subversion.svnRemoveFromChangelist">svnRemoveFromChangelist</a></td>
173 <td>Public method to remove a file or directory from its changelist.</td>
174 </tr>
175 <tr>
176 <td><a href="#Subversion.svnRepoBrowser">svnRepoBrowser</a></td>
177 <td>Public method to open the repository browser.</td>
178 </tr>
179 <tr>
180 <td><a href="#Subversion.svnResolve">svnResolve</a></td>
181 <td>Public method used to resolve conflicts of a file/directory.</td>
182 </tr>
183 <tr>
184 <td><a href="#Subversion.svnSbsDiff">svnSbsDiff</a></td>
185 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
186 </tr>
187 <tr>
188 <td><a href="#Subversion.svnSetProp">svnSetProp</a></td>
189 <td>Public method used to add a property to a file/directory.</td>
190 </tr>
191 <tr>
192 <td><a href="#Subversion.svnShowChangelists">svnShowChangelists</a></td>
193 <td>Public method used to inspect the change lists defined for the project.</td>
194 </tr>
195 <tr>
196 <td><a href="#Subversion.svnUnlock">svnUnlock</a></td>
197 <td>Public method used to unlock a file in the Subversion repository.</td>
198 </tr>
199 <tr>
200 <td><a href="#Subversion.svnUpgrade">svnUpgrade</a></td>
201 <td>Public method to upgrade the working copy format.</td>
202 </tr>
203 <tr>
204 <td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td>
205 <td>Public method used to view the difference of a file/directory of two repository URLs.</td>
206 </tr>
207 <tr>
208 <td><a href="#Subversion.vcsAdd">vcsAdd</a></td>
209 <td>Public method used to add a file/directory to the Subversion repository.</td>
210 </tr>
211 <tr>
212 <td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td>
213 <td>Public method used to add a file/directory in binary mode to the Subversion repository.</td>
214 </tr>
215 <tr>
216 <td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td>
217 <td>Public method to add a directory tree rooted at path to the Subversion repository.</td>
218 </tr>
219 <tr>
220 <td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
221 <td>Public method used to get the registered states of a number of files in the VCS.</td>
222 </tr>
223 <tr>
224 <td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td>
225 <td>Public method used to check the project out of the Subversion repository.</td>
226 </tr>
227 <tr>
228 <td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td>
229 <td>Public method used to cleanup the working copy.</td>
230 </tr>
231 <tr>
232 <td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td>
233 <td>Public method used to execute arbitrary subversion commands.</td>
234 </tr>
235 <tr>
236 <td><a href="#Subversion.vcsCommit">vcsCommit</a></td>
237 <td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td>
238 </tr>
239 <tr>
240 <td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td>
241 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
242 </tr>
243 <tr>
244 <td><a href="#Subversion.vcsDiff">vcsDiff</a></td>
245 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
246 </tr>
247 <tr>
248 <td><a href="#Subversion.vcsExists">vcsExists</a></td>
249 <td>Public method used to test for the presence of the svn executable.</td>
250 </tr>
251 <tr>
252 <td><a href="#Subversion.vcsExport">vcsExport</a></td>
253 <td>Public method used to export a directory from the Subversion repository.</td>
254 </tr>
255 <tr>
256 <td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
257 <td>Public method to instanciate a helper object for the different project browsers.</td>
258 </tr>
259 <tr>
260 <td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
261 <td>Public method to instanciate a helper object for the project.</td>
262 </tr>
263 <tr>
264 <td><a href="#Subversion.vcsImport">vcsImport</a></td>
265 <td>Public method used to import the project into the Subversion repository.</td>
266 </tr>
267 <tr>
268 <td><a href="#Subversion.vcsInit">vcsInit</a></td>
269 <td>Public method used to initialize the subversion repository.</td>
270 </tr>
271 <tr>
272 <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td>
273 <td>Public method to initialize the VCS configuration.</td>
274 </tr>
275 <tr>
276 <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td>
277 <td>Public method used to browse the log of a file/directory from the Subversion repository.</td>
278 </tr>
279 <tr>
280 <td><a href="#Subversion.vcsMerge">vcsMerge</a></td>
281 <td>Public method used to merge a URL/revision into the local project.</td>
282 </tr>
283 <tr>
284 <td><a href="#Subversion.vcsMove">vcsMove</a></td>
285 <td>Public method used to move a file/directory.</td>
286 </tr>
287 <tr>
288 <td><a href="#Subversion.vcsName">vcsName</a></td>
289 <td>Public method returning the name of the vcs.</td>
290 </tr>
291 <tr>
292 <td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
293 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
294 </tr>
295 <tr>
296 <td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td>
297 <td>Public method to get a dialog to enter repository info.</td>
298 </tr>
299 <tr>
300 <td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td>
301 <td>Public method used to get the registered state of a file in the vcs.</td>
302 </tr>
303 <tr>
304 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
305 <td>Public method used to remove a file/directory from the Subversion repository.</td>
306 </tr>
307 <tr>
308 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
309 <td>Public method to retrieve information about the repository.</td>
310 </tr>
311 <tr>
312 <td><a href="#Subversion.vcsRevert">vcsRevert</a></td>
313 <td>Public method used to revert changes made to a file/directory.</td>
314 </tr>
315 <tr>
316 <td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td>
317 <td>Public method used to shutdown the Subversion interface.</td>
318 </tr>
319 <tr>
320 <td><a href="#Subversion.vcsStatus">vcsStatus</a></td>
321 <td>Public method used to view the status of files/directories in the Subversion repository.</td>
322 </tr>
323 <tr>
324 <td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td>
325 <td>Public method used to switch a directory to a different tag/branch.</td>
326 </tr>
327 <tr>
328 <td><a href="#Subversion.vcsTag">vcsTag</a></td>
329 <td>Public method used to set the tag of a file/directory in the Subversion repository.</td>
330 </tr>
331 <tr>
332 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
333 <td>Public method used to update a file/directory with the Subversion repository.</td>
334 </tr>
335 </table>
336 <h3>Static Methods</h3>
337
338 <table>
339 <tr><td>None</td></tr>
340 </table>
341
342 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
343 <h4>Subversion (Constructor)</h4>
344 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>)
345
346 <p>
347 Constructor
348 </p>
349 <dl>
350
351 <dt><i>plugin</i></dt>
352 <dd>
353 reference to the plugin object
354 </dd>
355 <dt><i>parent</i></dt>
356 <dd>
357 parent widget (QWidget)
358 </dd>
359 <dt><i>name</i></dt>
360 <dd>
361 name of this object (string)
362 </dd>
363 </dl>
364 <a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
365 <h4>Subversion.__svnGetFileForRevision</h4>
366 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>)
367
368 <p>
369 Private method to get a file for a specific revision from the
370 repository.
371 </p>
372 <dl>
373
374 <dt><i>name</i></dt>
375 <dd>
376 file name to get from the repository (string)
377 </dd>
378 <dt><i>rev</i></dt>
379 <dd>
380 revision to retrieve (integer or string)
381 </dd>
382 </dl>
383 <dl>
384 <dt>Return:</dt>
385 <dd>
386 contents of the file (string) and an error message (string)
387 </dd>
388 </dl>
389 <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
390 <h4>Subversion.__svnURL</h4>
391 <b>__svnURL</b>(<i>url</i>)
392
393 <p>
394 Private method to format a url for subversion.
395 </p>
396 <dl>
397
398 <dt><i>url</i></dt>
399 <dd>
400 unformatted url string (string)
401 </dd>
402 </dl>
403 <dl>
404 <dt>Return:</dt>
405 <dd>
406 properly formated url for subversion (string)
407 </dd>
408 </dl>
409 <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a>
410 <h4>Subversion.__vcsAllRegisteredStates_wc</h4>
411 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>)
412
413 <p>
414 Private method used to get the registered states of a number of files
415 in the VCS.
416 </p>
417 <p>
418 This is the variant for subversion installations using the old working
419 copy meta-data format.
420 </p>
421 <p>
422 <b>Note:</b> If a shortcut is to be taken, the code will only check,
423 if the named directory has been scanned already. If so, it is assumed,
424 that the states for all files has been populated by the previous run.
425 </p>
426 <dl>
427
428 <dt><i>names</i></dt>
429 <dd>
430 dictionary with all filenames to be checked as keys
431 </dd>
432 <dt><i>dname</i></dt>
433 <dd>
434 directory to check in (string)
435 </dd>
436 <dt><i>shortcut</i></dt>
437 <dd>
438 flag indicating a shortcut should be taken (boolean)
439 </dd>
440 </dl>
441 <dl>
442 <dt>Return:</dt>
443 <dd>
444 the received dictionary completed with a combination of
445 canBeCommited and canBeAdded or None in order to signal an error
446 </dd>
447 </dl>
448 <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a>
449 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
450 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>)
451
452 <p>
453 Private method used to get the registered states of a number of files
454 in the VCS.
455 </p>
456 <p>
457 This is the variant for subversion installations using the new working
458 copy meta-data format.
459 </p>
460 <p>
461 <b>Note:</b> If a shortcut is to be taken, the code will only check,
462 if the named directory has been scanned already. If so, it is assumed,
463 that the states for all files has been populated by the previous run.
464 </p>
465 <dl>
466
467 <dt><i>names</i></dt>
468 <dd>
469 dictionary with all filenames to be checked as keys
470 </dd>
471 <dt><i>dname</i></dt>
472 <dd>
473 directory to check in (string)
474 </dd>
475 <dt><i>shortcut</i></dt>
476 <dd>
477 flag indicating a shortcut should be taken (boolean)
478 </dd>
479 </dl>
480 <dl>
481 <dt>Return:</dt>
482 <dd>
483 the received dictionary completed with a combination of
484 canBeCommited and canBeAdded or None in order to signal an error
485 </dd>
486 </dl>
487 <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
488 <h4>Subversion.__vcsCommit_Step2</h4>
489 <b>__vcsCommit_Step2</b>(<i></i>)
490
491 <p>
492 Private slot performing the second step of the commit action.
493 </p>
494 <a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a>
495 <h4>Subversion.__vcsRegisteredState_wc</h4>
496 <b>__vcsRegisteredState_wc</b>(<i>name</i>)
497
498 <p>
499 Private method used to get the registered state of a file in the VCS.
500 </p>
501 <p>
502 This is the variant for subversion installations using the old working
503 copy meta-data format.
504 </p>
505 <dl>
506
507 <dt><i>name</i></dt>
508 <dd>
509 filename to check (string)
510 </dd>
511 </dl>
512 <dl>
513 <dt>Return:</dt>
514 <dd>
515 a combination of canBeCommited and canBeAdded
516 </dd>
517 </dl>
518 <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a>
519 <h4>Subversion.__vcsRegisteredState_wcng</h4>
520 <b>__vcsRegisteredState_wcng</b>(<i>name</i>)
521
522 <p>
523 Private method used to get the registered state of a file in the vcs.
524 </p>
525 <p>
526 This is the variant for subversion installations using the new
527 working copy meta-data format.
528 </p>
529 <dl>
530
531 <dt><i>name</i></dt>
532 <dd>
533 filename to check (string)
534 </dd>
535 </dl>
536 <dl>
537 <dt>Return:</dt>
538 <dd>
539 a combination of canBeCommited and canBeAdded
540 </dd>
541 </dl>
542 <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
543 <h4>Subversion._createStatusMonitorThread</h4>
544 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
545
546 <p>
547 Protected method to create an instance of the VCS status monitor
548 thread.
549 </p>
550 <dl>
551
552 <dt><i>interval</i></dt>
553 <dd>
554 check interval for the monitor thread in seconds
555 (integer)
556 </dd>
557 <dt><i>project</i></dt>
558 <dd>
559 reference to the project object
560 </dd>
561 </dl>
562 <dl>
563 <dt>Return:</dt>
564 <dd>
565 reference to the monitor thread (QThread)
566 </dd>
567 </dl>
568 <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
569 <h4>Subversion.clearStatusCache</h4>
570 <b>clearStatusCache</b>(<i></i>)
571
572 <p>
573 Public method to clear the status cache.
574 </p>
575 <a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
576 <h4>Subversion.getPlugin</h4>
577 <b>getPlugin</b>(<i></i>)
578
579 <p>
580 Public method to get a reference to the plugin object.
581 </p>
582 <dl>
583 <dt>Return:</dt>
584 <dd>
585 reference to the plugin object (VcsSubversionPlugin)
586 </dd>
587 </dl>
588 <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
589 <h4>Subversion.svnAddToChangelist</h4>
590 <b>svnAddToChangelist</b>(<i>names</i>)
591
592 <p>
593 Public method to add a file or directory to a changelist.
594 </p>
595 <p>
596 Note: Directories will be added recursively.
597 </p>
598 <dl>
599
600 <dt><i>names</i></dt>
601 <dd>
602 name or list of names of file or directory to add
603 (string)
604 </dd>
605 </dl>
606 <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
607 <h4>Subversion.svnBlame</h4>
608 <b>svnBlame</b>(<i>name</i>)
609
610 <p>
611 Public method to show the output of the svn blame command.
612 </p>
613 <dl>
614
615 <dt><i>name</i></dt>
616 <dd>
617 file name to show the blame for (string)
618 </dd>
619 </dl>
620 <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
621 <h4>Subversion.svnCopy</h4>
622 <b>svnCopy</b>(<i>name, project</i>)
623
624 <p>
625 Public method used to copy a file/directory.
626 </p>
627 <dl>
628
629 <dt><i>name</i></dt>
630 <dd>
631 file/directory name to be copied (string)
632 </dd>
633 <dt><i>project</i></dt>
634 <dd>
635 reference to the project object
636 </dd>
637 </dl>
638 <dl>
639 <dt>Return:</dt>
640 <dd>
641 flag indicating successfull operation (boolean)
642 </dd>
643 </dl>
644 <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
645 <h4>Subversion.svnDelProp</h4>
646 <b>svnDelProp</b>(<i>name, recursive=False</i>)
647
648 <p>
649 Public method used to delete a property of a file/directory.
650 </p>
651 <dl>
652
653 <dt><i>name</i></dt>
654 <dd>
655 file/directory name (string or list of strings)
656 </dd>
657 <dt><i>recursive</i></dt>
658 <dd>
659 flag indicating a recursive list is requested
660 </dd>
661 </dl>
662 <a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
663 <h4>Subversion.svnExtendedDiff</h4>
664 <b>svnExtendedDiff</b>(<i>name</i>)
665
666 <p>
667 Public method used to view the difference of a file/directory to the
668 Subversion repository.
669 </p>
670 <p>
671 If name is a directory and is the project directory, all project files
672 are saved first. If name is a file (or list of files), which is/are
673 being edited and has unsaved modification, they can be saved or the
674 operation may be aborted.
675 </p>
676 <p>
677 This method gives the chance to enter the revisions to be compared.
678 </p>
679 <dl>
680
681 <dt><i>name</i></dt>
682 <dd>
683 file/directory name to be diffed (string)
684 </dd>
685 </dl>
686 <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a>
687 <h4>Subversion.svnGetChangelists</h4>
688 <b>svnGetChangelists</b>(<i></i>)
689
690 <p>
691 Public method to get a list of all defined change lists.
692 </p>
693 <dl>
694 <dt>Return:</dt>
695 <dd>
696 list of defined change list names (list of strings)
697 </dd>
698 </dl>
699 <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
700 <h4>Subversion.svnGetReposName</h4>
701 <b>svnGetReposName</b>(<i>path</i>)
702
703 <p>
704 Public method used to retrieve the URL of the subversion repository
705 path.
706 </p>
707 <dl>
708
709 <dt><i>path</i></dt>
710 <dd>
711 local path to get the svn repository path for (string)
712 </dd>
713 </dl>
714 <dl>
715 <dt>Return:</dt>
716 <dd>
717 string with the repository path URL
718 </dd>
719 </dl>
720 <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
721 <h4>Subversion.svnListProps</h4>
722 <b>svnListProps</b>(<i>name, recursive=False</i>)
723
724 <p>
725 Public method used to list the properties of a file/directory.
726 </p>
727 <dl>
728
729 <dt><i>name</i></dt>
730 <dd>
731 file/directory name (string or list of strings)
732 </dd>
733 <dt><i>recursive</i></dt>
734 <dd>
735 flag indicating a recursive list is requested
736 </dd>
737 </dl>
738 <a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
739 <h4>Subversion.svnListTagBranch</h4>
740 <b>svnListTagBranch</b>(<i>path, tags=True</i>)
741
742 <p>
743 Public method used to list the available tags or branches.
744 </p>
745 <dl>
746
747 <dt><i>path</i></dt>
748 <dd>
749 directory name of the project (string)
750 </dd>
751 <dt><i>tags</i></dt>
752 <dd>
753 flag indicating listing of branches or tags
754 (False = branches, True = tags)
755 </dd>
756 </dl>
757 <a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
758 <h4>Subversion.svnLock</h4>
759 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
760
761 <p>
762 Public method used to lock a file in the Subversion repository.
763 </p>
764 <dl>
765
766 <dt><i>name</i></dt>
767 <dd>
768 file/directory name to be locked (string or list of
769 strings)
770 </dd>
771 <dt><i>stealIt</i></dt>
772 <dd>
773 flag indicating a forced operation (boolean)
774 </dd>
775 <dt><i>parent</i></dt>
776 <dd>
777 reference to the parent object of the subversion dialog
778 (QWidget)
779 </dd>
780 </dl>
781 <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
782 <h4>Subversion.svnNormalizeURL</h4>
783 <b>svnNormalizeURL</b>(<i>url</i>)
784
785 <p>
786 Public method to normalize a url for subversion.
787 </p>
788 <dl>
789
790 <dt><i>url</i></dt>
791 <dd>
792 url string (string)
793 </dd>
794 </dl>
795 <dl>
796 <dt>Return:</dt>
797 <dd>
798 properly normalized url for subversion (string)
799 </dd>
800 </dl>
801 <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
802 <h4>Subversion.svnRelocate</h4>
803 <b>svnRelocate</b>(<i>projectPath</i>)
804
805 <p>
806 Public method to relocate the working copy to a new repository URL.
807 </p>
808 <dl>
809
810 <dt><i>projectPath</i></dt>
811 <dd>
812 path name of the project (string)
813 </dd>
814 </dl>
815 <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
816 <h4>Subversion.svnRemoveFromChangelist</h4>
817 <b>svnRemoveFromChangelist</b>(<i>names</i>)
818
819 <p>
820 Public method to remove a file or directory from its changelist.
821 </p>
822 <p>
823 Note: Directories will be removed recursively.
824 </p>
825 <dl>
826
827 <dt><i>names</i></dt>
828 <dd>
829 name or list of names of file or directory to remove
830 (string)
831 </dd>
832 </dl>
833 <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
834 <h4>Subversion.svnRepoBrowser</h4>
835 <b>svnRepoBrowser</b>(<i>projectPath=None</i>)
836
837 <p>
838 Public method to open the repository browser.
839 </p>
840 <dl>
841
842 <dt><i>projectPath</i></dt>
843 <dd>
844 path name of the project (string)
845 </dd>
846 </dl>
847 <a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a>
848 <h4>Subversion.svnResolve</h4>
849 <b>svnResolve</b>(<i>name</i>)
850
851 <p>
852 Public method used to resolve conflicts of a file/directory.
853 </p>
854 <dl>
855
856 <dt><i>name</i></dt>
857 <dd>
858 file/directory name to be resolved (string)
859 </dd>
860 </dl>
861 <a NAME="Subversion.svnSbsDiff" ID="Subversion.svnSbsDiff"></a>
862 <h4>Subversion.svnSbsDiff</h4>
863 <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
864
865 <p>
866 Public method used to view the difference of a file to the Mercurial
867 repository side-by-side.
868 </p>
869 <dl>
870
871 <dt><i>name</i></dt>
872 <dd>
873 file name to be diffed (string)
874 </dd>
875 <dt><i>extended</i></dt>
876 <dd>
877 flag indicating the extended variant (boolean)
878 </dd>
879 <dt><i>revisions</i></dt>
880 <dd>
881 tuple of two revisions (tuple of strings)
882 </dd>
883 </dl>
884 <dl>
885
886 <dt>Raises <b>ValueError</b>:</dt>
887 <dd>
888 raised to indicate an illegal name parameter type
889 </dd>
890 </dl>
891 <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
892 <h4>Subversion.svnSetProp</h4>
893 <b>svnSetProp</b>(<i>name, recursive=False</i>)
894
895 <p>
896 Public method used to add a property to a file/directory.
897 </p>
898 <dl>
899
900 <dt><i>name</i></dt>
901 <dd>
902 file/directory name (string or list of strings)
903 </dd>
904 <dt><i>recursive</i></dt>
905 <dd>
906 flag indicating a recursive list is requested
907 </dd>
908 </dl>
909 <a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a>
910 <h4>Subversion.svnShowChangelists</h4>
911 <b>svnShowChangelists</b>(<i>path</i>)
912
913 <p>
914 Public method used to inspect the change lists defined for the project.
915 </p>
916 <dl>
917
918 <dt><i>path</i></dt>
919 <dd>
920 directory name to show change lists for (string)
921 </dd>
922 </dl>
923 <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
924 <h4>Subversion.svnUnlock</h4>
925 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
926
927 <p>
928 Public method used to unlock a file in the Subversion repository.
929 </p>
930 <dl>
931
932 <dt><i>name</i></dt>
933 <dd>
934 file/directory name to be unlocked (string or list of
935 strings)
936 </dd>
937 <dt><i>breakIt</i></dt>
938 <dd>
939 flag indicating a forced operation (boolean)
940 </dd>
941 <dt><i>parent</i></dt>
942 <dd>
943 reference to the parent object of the subversion dialog
944 (QWidget)
945 </dd>
946 </dl>
947 <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a>
948 <h4>Subversion.svnUpgrade</h4>
949 <b>svnUpgrade</b>(<i>path</i>)
950
951 <p>
952 Public method to upgrade the working copy format.
953 </p>
954 <dl>
955
956 <dt><i>path</i></dt>
957 <dd>
958 directory name to show change lists for (string)
959 </dd>
960 </dl>
961 <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
962 <h4>Subversion.svnUrlDiff</h4>
963 <b>svnUrlDiff</b>(<i>name</i>)
964
965 <p>
966 Public method used to view the difference of a file/directory of two
967 repository URLs.
968 </p>
969 <p>
970 If name is a directory and is the project directory, all project files
971 are saved first. If name is a file (or list of files), which is/are
972 being edited and has unsaved modification, they can be saved or the
973 operation may be aborted.
974 </p>
975 <p>
976 This method gives the chance to enter the revisions to be compared.
977 </p>
978 <dl>
979
980 <dt><i>name</i></dt>
981 <dd>
982 file/directory name to be diffed (string)
983 </dd>
984 </dl>
985 <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
986 <h4>Subversion.vcsAdd</h4>
987 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
988
989 <p>
990 Public method used to add a file/directory to the Subversion
991 repository.
992 </p>
993 <dl>
994
995 <dt><i>name</i></dt>
996 <dd>
997 file/directory name to be added (string)
998 </dd>
999 <dt><i>isDir</i></dt>
1000 <dd>
1001 flag indicating name is a directory (boolean)
1002 </dd>
1003 <dt><i>noDialog</i></dt>
1004 <dd>
1005 flag indicating quiet operations
1006 </dd>
1007 </dl>
1008 <a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
1009 <h4>Subversion.vcsAddBinary</h4>
1010 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
1011
1012 <p>
1013 Public method used to add a file/directory in binary mode to the
1014 Subversion repository.
1015 </p>
1016 <dl>
1017
1018 <dt><i>name</i></dt>
1019 <dd>
1020 file/directory name to be added (string)
1021 </dd>
1022 <dt><i>isDir</i></dt>
1023 <dd>
1024 flag indicating name is a directory (boolean)
1025 </dd>
1026 </dl>
1027 <a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
1028 <h4>Subversion.vcsAddTree</h4>
1029 <b>vcsAddTree</b>(<i>path</i>)
1030
1031 <p>
1032 Public method to add a directory tree rooted at path to the Subversion
1033 repository.
1034 </p>
1035 <dl>
1036
1037 <dt><i>path</i></dt>
1038 <dd>
1039 root directory of the tree to be added (string or list of
1040 strings))
1041 </dd>
1042 </dl>
1043 <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
1044 <h4>Subversion.vcsAllRegisteredStates</h4>
1045 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
1046
1047 <p>
1048 Public method used to get the registered states of a number of files
1049 in the VCS.
1050 </p>
1051 <p>
1052 <b>Note:</b> If a shortcut is to be taken, the code will only check,
1053 if the named directory has been scanned already. If so, it is assumed,
1054 that the states for all files have been populated by the previous run.
1055 </p>
1056 <dl>
1057
1058 <dt><i>names</i></dt>
1059 <dd>
1060 dictionary with all filenames to be checked as keys
1061 </dd>
1062 <dt><i>dname</i></dt>
1063 <dd>
1064 directory to check in (string)
1065 </dd>
1066 <dt><i>shortcut</i></dt>
1067 <dd>
1068 flag indicating a shortcut should be taken (boolean)
1069 </dd>
1070 </dl>
1071 <dl>
1072 <dt>Return:</dt>
1073 <dd>
1074 the received dictionary completed with a combination of
1075 canBeCommited and canBeAdded or None in order to signal an error
1076 </dd>
1077 </dl>
1078 <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
1079 <h4>Subversion.vcsCheckout</h4>
1080 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1081
1082 <p>
1083 Public method used to check the project out of the Subversion
1084 repository.
1085 </p>
1086 <dl>
1087
1088 <dt><i>vcsDataDict</i></dt>
1089 <dd>
1090 dictionary of data required for the checkout
1091 </dd>
1092 <dt><i>projectDir</i></dt>
1093 <dd>
1094 project directory to create (string)
1095 </dd>
1096 <dt><i>noDialog</i></dt>
1097 <dd>
1098 flag indicating quiet operations
1099 </dd>
1100 </dl>
1101 <dl>
1102 <dt>Return:</dt>
1103 <dd>
1104 flag indicating an execution without errors (boolean)
1105 </dd>
1106 </dl>
1107 <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
1108 <h4>Subversion.vcsCleanup</h4>
1109 <b>vcsCleanup</b>(<i>name</i>)
1110
1111 <p>
1112 Public method used to cleanup the working copy.
1113 </p>
1114 <dl>
1115
1116 <dt><i>name</i></dt>
1117 <dd>
1118 directory name to be cleaned up (string)
1119 </dd>
1120 </dl>
1121 <a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
1122 <h4>Subversion.vcsCommandLine</h4>
1123 <b>vcsCommandLine</b>(<i>name</i>)
1124
1125 <p>
1126 Public method used to execute arbitrary subversion commands.
1127 </p>
1128 <dl>
1129
1130 <dt><i>name</i></dt>
1131 <dd>
1132 directory name of the working directory (string)
1133 </dd>
1134 </dl>
1135 <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
1136 <h4>Subversion.vcsCommit</h4>
1137 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
1138
1139 <p>
1140 Public method used to make the change of a file/directory permanent
1141 in the Subversion repository.
1142 </p>
1143 <dl>
1144
1145 <dt><i>name</i></dt>
1146 <dd>
1147 file/directory name to be committed (string or list of
1148 strings)
1149 </dd>
1150 <dt><i>message</i></dt>
1151 <dd>
1152 message for this operation (string)
1153 </dd>
1154 <dt><i>noDialog</i></dt>
1155 <dd>
1156 flag indicating quiet operations
1157 </dd>
1158 </dl>
1159 <a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
1160 <h4>Subversion.vcsConvertProject</h4>
1161 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>)
1162
1163 <p>
1164 Public method to convert an uncontrolled project to a version
1165 controlled project.
1166 </p>
1167 <dl>
1168
1169 <dt><i>vcsDataDict</i> (dict)</dt>
1170 <dd>
1171 dictionary of data required for the conversion
1172 </dd>
1173 <dt><i>project</i> (Project)</dt>
1174 <dd>
1175 reference to the project object
1176 </dd>
1177 <dt><i>addAll</i> (bool)</dt>
1178 <dd>
1179 flag indicating to add all files to the repository
1180 </dd>
1181 </dl>
1182 <a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
1183 <h4>Subversion.vcsDiff</h4>
1184 <b>vcsDiff</b>(<i>name</i>)
1185
1186 <p>
1187 Public method used to view the difference of a file/directory to the
1188 Subversion repository.
1189 </p>
1190 <p>
1191 If name is a directory and is the project directory, all project files
1192 are saved first. If name is a file (or list of files), which is/are
1193 being edited and has unsaved modification, they can be saved or the
1194 operation may be aborted.
1195 </p>
1196 <dl>
1197
1198 <dt><i>name</i></dt>
1199 <dd>
1200 file/directory name to be diffed (string)
1201 </dd>
1202 </dl>
1203 <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
1204 <h4>Subversion.vcsExists</h4>
1205 <b>vcsExists</b>(<i></i>)
1206
1207 <p>
1208 Public method used to test for the presence of the svn executable.
1209 </p>
1210 <dl>
1211 <dt>Return:</dt>
1212 <dd>
1213 flag indicating the existance (boolean) and an error message
1214 (string)
1215 </dd>
1216 </dl>
1217 <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
1218 <h4>Subversion.vcsExport</h4>
1219 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
1220
1221 <p>
1222 Public method used to export a directory from the Subversion
1223 repository.
1224 </p>
1225 <dl>
1226
1227 <dt><i>vcsDataDict</i></dt>
1228 <dd>
1229 dictionary of data required for the checkout
1230 </dd>
1231 <dt><i>projectDir</i></dt>
1232 <dd>
1233 project directory to create (string)
1234 </dd>
1235 </dl>
1236 <dl>
1237 <dt>Return:</dt>
1238 <dd>
1239 flag indicating an execution without errors (boolean)
1240 </dd>
1241 </dl>
1242 <a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
1243 <h4>Subversion.vcsGetProjectBrowserHelper</h4>
1244 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
1245
1246 <p>
1247 Public method to instanciate a helper object for the different
1248 project browsers.
1249 </p>
1250 <dl>
1251
1252 <dt><i>browser</i></dt>
1253 <dd>
1254 reference to the project browser object
1255 </dd>
1256 <dt><i>project</i></dt>
1257 <dd>
1258 reference to the project object
1259 </dd>
1260 <dt><i>isTranslationsBrowser</i></dt>
1261 <dd>
1262 flag indicating, the helper is requested
1263 for the translations browser (this needs some special treatment)
1264 </dd>
1265 </dl>
1266 <dl>
1267 <dt>Return:</dt>
1268 <dd>
1269 the project browser helper object
1270 </dd>
1271 </dl>
1272 <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
1273 <h4>Subversion.vcsGetProjectHelper</h4>
1274 <b>vcsGetProjectHelper</b>(<i>project</i>)
1275
1276 <p>
1277 Public method to instanciate a helper object for the project.
1278 </p>
1279 <dl>
1280
1281 <dt><i>project</i></dt>
1282 <dd>
1283 reference to the project object
1284 </dd>
1285 </dl>
1286 <dl>
1287 <dt>Return:</dt>
1288 <dd>
1289 the project helper object
1290 </dd>
1291 </dl>
1292 <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
1293 <h4>Subversion.vcsImport</h4>
1294 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
1295
1296 <p>
1297 Public method used to import the project into the Subversion
1298 repository.
1299 </p>
1300 <dl>
1301
1302 <dt><i>vcsDataDict</i> (dict)</dt>
1303 <dd>
1304 dictionary of data required for the import
1305 </dd>
1306 <dt><i>projectDir</i> (str)</dt>
1307 <dd>
1308 project directory (string)
1309 </dd>
1310 <dt><i>noDialog</i> (bool)</dt>
1311 <dd>
1312 flag indicating quiet operations
1313 </dd>
1314 <dt><i>addAll</i> (bool)</dt>
1315 <dd>
1316 flag indicating to add all files to the repository
1317 </dd>
1318 </dl>
1319 <dl>
1320 <dt>Return:</dt>
1321 <dd>
1322 tuple containing a flag indicating an execution without errors
1323 and a flag indicating the version controll status
1324 </dd>
1325 </dl>
1326 <dl>
1327 <dt>Return Type:</dt>
1328 <dd>
1329 tuple of (bool, bool)
1330 </dd>
1331 </dl>
1332 <a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
1333 <h4>Subversion.vcsInit</h4>
1334 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
1335
1336 <p>
1337 Public method used to initialize the subversion repository.
1338 </p>
1339 <p>
1340 The subversion repository has to be initialized from outside eric
1341 because the respective command always works locally. Therefore we
1342 always return TRUE without doing anything.
1343 </p>
1344 <dl>
1345
1346 <dt><i>vcsDir</i></dt>
1347 <dd>
1348 name of the VCS directory (string)
1349 </dd>
1350 <dt><i>noDialog</i></dt>
1351 <dd>
1352 flag indicating quiet operations (boolean)
1353 </dd>
1354 </dl>
1355 <dl>
1356 <dt>Return:</dt>
1357 <dd>
1358 always TRUE
1359 </dd>
1360 </dl>
1361 <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
1362 <h4>Subversion.vcsInitConfig</h4>
1363 <b>vcsInitConfig</b>(<i>project</i>)
1364
1365 <p>
1366 Public method to initialize the VCS configuration.
1367 </p>
1368 <p>
1369 This method ensures, that an ignore file exists.
1370 </p>
1371 <dl>
1372
1373 <dt><i>project</i></dt>
1374 <dd>
1375 reference to the project (Project)
1376 </dd>
1377 </dl>
1378 <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
1379 <h4>Subversion.vcsLogBrowser</h4>
1380 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
1381
1382 <p>
1383 Public method used to browse the log of a file/directory from the
1384 Subversion repository.
1385 </p>
1386 <dl>
1387
1388 <dt><i>name</i></dt>
1389 <dd>
1390 file/directory name to show the log of (string)
1391 </dd>
1392 <dt><i>isFile</i></dt>
1393 <dd>
1394 flag indicating log for a file is to be shown (boolean)
1395 </dd>
1396 </dl>
1397 <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
1398 <h4>Subversion.vcsMerge</h4>
1399 <b>vcsMerge</b>(<i>name</i>)
1400
1401 <p>
1402 Public method used to merge a URL/revision into the local project.
1403 </p>
1404 <dl>
1405
1406 <dt><i>name</i></dt>
1407 <dd>
1408 file/directory name to be merged (string)
1409 </dd>
1410 </dl>
1411 <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
1412 <h4>Subversion.vcsMove</h4>
1413 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
1414
1415 <p>
1416 Public method used to move a file/directory.
1417 </p>
1418 <dl>
1419
1420 <dt><i>name</i></dt>
1421 <dd>
1422 file/directory name to be moved (string)
1423 </dd>
1424 <dt><i>project</i></dt>
1425 <dd>
1426 reference to the project object
1427 </dd>
1428 <dt><i>target</i></dt>
1429 <dd>
1430 new name of the file/directory (string)
1431 </dd>
1432 <dt><i>noDialog</i></dt>
1433 <dd>
1434 flag indicating quiet operations
1435 </dd>
1436 </dl>
1437 <dl>
1438 <dt>Return:</dt>
1439 <dd>
1440 flag indicating successfull operation (boolean)
1441 </dd>
1442 </dl>
1443 <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
1444 <h4>Subversion.vcsName</h4>
1445 <b>vcsName</b>(<i></i>)
1446
1447 <p>
1448 Public method returning the name of the vcs.
1449 </p>
1450 <dl>
1451 <dt>Return:</dt>
1452 <dd>
1453 always 'Subversion' (string)
1454 </dd>
1455 </dl>
1456 <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
1457 <h4>Subversion.vcsNewProjectOptionsDialog</h4>
1458 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
1459
1460 <p>
1461 Public method to get a dialog to enter repository info for getting
1462 a new project.
1463 </p>
1464 <dl>
1465
1466 <dt><i>parent</i></dt>
1467 <dd>
1468 parent widget (QWidget)
1469 </dd>
1470 </dl>
1471 <dl>
1472 <dt>Return:</dt>
1473 <dd>
1474 reference to the instantiated options dialog
1475 (SvnNewProjectOptionsDialog)
1476 </dd>
1477 </dl>
1478 <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
1479 <h4>Subversion.vcsOptionsDialog</h4>
1480 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
1481
1482 <p>
1483 Public method to get a dialog to enter repository info.
1484 </p>
1485 <dl>
1486
1487 <dt><i>project</i></dt>
1488 <dd>
1489 reference to the project object
1490 </dd>
1491 <dt><i>archive</i></dt>
1492 <dd>
1493 name of the project in the repository (string)
1494 </dd>
1495 <dt><i>editable</i></dt>
1496 <dd>
1497 flag indicating that the project name is editable
1498 (boolean)
1499 </dd>
1500 <dt><i>parent</i></dt>
1501 <dd>
1502 parent widget (QWidget)
1503 </dd>
1504 </dl>
1505 <dl>
1506 <dt>Return:</dt>
1507 <dd>
1508 reference to the instantiated options dialog (SvnOptionsDialog)
1509 </dd>
1510 </dl>
1511 <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
1512 <h4>Subversion.vcsRegisteredState</h4>
1513 <b>vcsRegisteredState</b>(<i>name</i>)
1514
1515 <p>
1516 Public method used to get the registered state of a file in the vcs.
1517 </p>
1518 <dl>
1519
1520 <dt><i>name</i></dt>
1521 <dd>
1522 filename to check (string)
1523 </dd>
1524 </dl>
1525 <dl>
1526 <dt>Return:</dt>
1527 <dd>
1528 a combination of canBeCommited and canBeAdded
1529 </dd>
1530 </dl>
1531 <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
1532 <h4>Subversion.vcsRemove</h4>
1533 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
1534
1535 <p>
1536 Public method used to remove a file/directory from the Subversion
1537 repository.
1538 </p>
1539 <p>
1540 The default operation is to remove the local copy as well.
1541 </p>
1542 <dl>
1543
1544 <dt><i>name</i></dt>
1545 <dd>
1546 file/directory name to be removed (string or list of
1547 strings))
1548 </dd>
1549 <dt><i>project</i></dt>
1550 <dd>
1551 flag indicating deletion of a project tree (boolean)
1552 (not needed)
1553 </dd>
1554 <dt><i>noDialog</i></dt>
1555 <dd>
1556 flag indicating quiet operations
1557 </dd>
1558 </dl>
1559 <dl>
1560 <dt>Return:</dt>
1561 <dd>
1562 flag indicating successfull operation (boolean)
1563 </dd>
1564 </dl>
1565 <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
1566 <h4>Subversion.vcsRepositoryInfos</h4>
1567 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1568
1569 <p>
1570 Public method to retrieve information about the repository.
1571 </p>
1572 <dl>
1573
1574 <dt><i>ppath</i></dt>
1575 <dd>
1576 local path to get the repository infos (string)
1577 </dd>
1578 </dl>
1579 <dl>
1580 <dt>Return:</dt>
1581 <dd>
1582 string with ready formated info for display (string)
1583 </dd>
1584 </dl>
1585 <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
1586 <h4>Subversion.vcsRevert</h4>
1587 <b>vcsRevert</b>(<i>name</i>)
1588
1589 <p>
1590 Public method used to revert changes made to a file/directory.
1591 </p>
1592 <dl>
1593
1594 <dt><i>name</i></dt>
1595 <dd>
1596 file/directory name to be reverted (string)
1597 </dd>
1598 </dl>
1599 <a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
1600 <h4>Subversion.vcsShutdown</h4>
1601 <b>vcsShutdown</b>(<i></i>)
1602
1603 <p>
1604 Public method used to shutdown the Subversion interface.
1605 </p>
1606 <a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
1607 <h4>Subversion.vcsStatus</h4>
1608 <b>vcsStatus</b>(<i>name</i>)
1609
1610 <p>
1611 Public method used to view the status of files/directories in the
1612 Subversion repository.
1613 </p>
1614 <dl>
1615
1616 <dt><i>name</i></dt>
1617 <dd>
1618 file/directory name(s) to show the status of
1619 (string or list of strings)
1620 </dd>
1621 </dl>
1622 <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
1623 <h4>Subversion.vcsSwitch</h4>
1624 <b>vcsSwitch</b>(<i>name</i>)
1625
1626 <p>
1627 Public method used to switch a directory to a different tag/branch.
1628 </p>
1629 <dl>
1630
1631 <dt><i>name</i></dt>
1632 <dd>
1633 directory name to be switched (string)
1634 </dd>
1635 </dl>
1636 <dl>
1637 <dt>Return:</dt>
1638 <dd>
1639 flag indicating added or changed files (boolean)
1640 </dd>
1641 </dl>
1642 <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
1643 <h4>Subversion.vcsTag</h4>
1644 <b>vcsTag</b>(<i>name</i>)
1645
1646 <p>
1647 Public method used to set the tag of a file/directory in the
1648 Subversion repository.
1649 </p>
1650 <dl>
1651
1652 <dt><i>name</i></dt>
1653 <dd>
1654 file/directory name to be tagged (string)
1655 </dd>
1656 </dl>
1657 <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
1658 <h4>Subversion.vcsUpdate</h4>
1659 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1660
1661 <p>
1662 Public method used to update a file/directory with the Subversion
1663 repository.
1664 </p>
1665 <dl>
1666
1667 <dt><i>name</i></dt>
1668 <dd>
1669 file/directory name to be updated (string or list of
1670 strings)
1671 </dd>
1672 <dt><i>noDialog</i></dt>
1673 <dd>
1674 flag indicating quiet operations (boolean)
1675 </dd>
1676 </dl>
1677 <dl>
1678 <dt>Return:</dt>
1679 <dd>
1680 flag indicating, that the update contained an add
1681 or delete (boolean)
1682 </dd>
1683 </dl>
1684 <div align="right"><a href="#top">Up</a></div>
1685 <hr />
1686 </body></html>

Mercurial Repository: eric

eric ide

mercurial