Mercurial Repositories > eric / file comparison

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

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html

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

Mercurial Repository: eric

eric ide

mercurial