Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 5452
9f89364d9ffd
child 7168
c1f97706c905
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsPySvn.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsPySvn.subversion</h1>
23 <p>
24 Module implementing the version control systems interface to Subversion.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Subversion">Subversion</a></td>
34 <td>Class implementing the version control systems interface to Subversion.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Subversion" ID="Subversion"></a>
43 <h2>Subversion</h2>
44 <p>
45 Class implementing the version control systems interface to Subversion.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>committed()</dt>
49 <dd>
50 emitted after the commit action has completed
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 VersionControl
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#Subversion.__init__">Subversion</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#Subversion.__isVersioned">__isVersioned</a></td>
70 <td>Private method to check, if the given status indicates a versioned state.</td>
71 </tr><tr>
72 <td><a href="#Subversion.__svnGetFileForRevision">__svnGetFileForRevision</a></td>
73 <td>Private method to get a file for a specific revision from the repository.</td>
74 </tr><tr>
75 <td><a href="#Subversion.__svnURL">__svnURL</a></td>
76 <td>Private method to format a url for subversion.</td>
77 </tr><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><tr>
81 <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td>
82 <td>Private method used to get the registered states of a number of files in the vcs.</td>
83 </tr><tr>
84 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
85 <td>Private slot performing the second step of the commit action.</td>
86 </tr><tr>
87 <td><a href="#Subversion.__vcsRegisteredState_wc">__vcsRegisteredState_wc</a></td>
88 <td>Private method used to get the registered state of a file in the vcs.</td>
89 </tr><tr>
90 <td><a href="#Subversion.__vcsRegisteredState_wcng">__vcsRegisteredState_wcng</a></td>
91 <td>Private method used to get the registered state of a file in the vcs.</td>
92 </tr><tr>
93 <td><a href="#Subversion._createStatusMonitorThread">_createStatusMonitorThread</a></td>
94 <td>Protected method to create an instance of the VCS status monitor thread.</td>
95 </tr><tr>
96 <td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td>
97 <td>Public method to clear the status cache.</td>
98 </tr><tr>
99 <td><a href="#Subversion.getClient">getClient</a></td>
100 <td>Public method to create and initialize the pysvn client object.</td>
101 </tr><tr>
102 <td><a href="#Subversion.getPlugin">getPlugin</a></td>
103 <td>Public method to get a reference to the plugin object.</td>
104 </tr><tr>
105 <td><a href="#Subversion.svnAddToChangelist">svnAddToChangelist</a></td>
106 <td>Public method to add a file or directory to a changelist.</td>
107 </tr><tr>
108 <td><a href="#Subversion.svnBlame">svnBlame</a></td>
109 <td>Public method to show the output of the svn blame command.</td>
110 </tr><tr>
111 <td><a href="#Subversion.svnCopy">svnCopy</a></td>
112 <td>Public method used to copy a file/directory.</td>
113 </tr><tr>
114 <td><a href="#Subversion.svnDelProp">svnDelProp</a></td>
115 <td>Public method used to delete a property of a file/directory.</td>
116 </tr><tr>
117 <td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td>
118 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
119 </tr><tr>
120 <td><a href="#Subversion.svnGetChangelists">svnGetChangelists</a></td>
121 <td>Public method to get a list of all defined change lists.</td>
122 </tr><tr>
123 <td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td>
124 <td>Public method used to retrieve the URL of the subversion repository path.</td>
125 </tr><tr>
126 <td><a href="#Subversion.svnInfo">svnInfo</a></td>
127 <td>Public method to show repository information about a file or directory.</td>
128 </tr><tr>
129 <td><a href="#Subversion.svnListProps">svnListProps</a></td>
130 <td>Public method used to list the properties of a file/directory.</td>
131 </tr><tr>
132 <td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td>
133 <td>Public method used to list the available tags or branches.</td>
134 </tr><tr>
135 <td><a href="#Subversion.svnLock">svnLock</a></td>
136 <td>Public method used to lock a file in the Subversion repository.</td>
137 </tr><tr>
138 <td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td>
139 <td>Public method to normalize a url for subversion.</td>
140 </tr><tr>
141 <td><a href="#Subversion.svnRelocate">svnRelocate</a></td>
142 <td>Public method to relocate the working copy to a new repository URL.</td>
143 </tr><tr>
144 <td><a href="#Subversion.svnRemoveFromChangelist">svnRemoveFromChangelist</a></td>
145 <td>Public method to remove a file or directory from its changelist.</td>
146 </tr><tr>
147 <td><a href="#Subversion.svnRepoBrowser">svnRepoBrowser</a></td>
148 <td>Public method to open the repository browser.</td>
149 </tr><tr>
150 <td><a href="#Subversion.svnResolve">svnResolve</a></td>
151 <td>Public method used to resolve conflicts of a file/directory.</td>
152 </tr><tr>
153 <td><a href="#Subversion.svnSbsDiff">svnSbsDiff</a></td>
154 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
155 </tr><tr>
156 <td><a href="#Subversion.svnSetProp">svnSetProp</a></td>
157 <td>Public method used to add a property to a file/directory.</td>
158 </tr><tr>
159 <td><a href="#Subversion.svnShowChangelists">svnShowChangelists</a></td>
160 <td>Public method used to inspect the change lists defined for the project.</td>
161 </tr><tr>
162 <td><a href="#Subversion.svnUnlock">svnUnlock</a></td>
163 <td>Public method used to unlock a file in the Subversion repository.</td>
164 </tr><tr>
165 <td><a href="#Subversion.svnUpgrade">svnUpgrade</a></td>
166 <td>Public method to upgrade the working copy format.</td>
167 </tr><tr>
168 <td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td>
169 <td>Public method used to view the difference of a file/directory of two repository URLs.</td>
170 </tr><tr>
171 <td><a href="#Subversion.vcsAdd">vcsAdd</a></td>
172 <td>Public method used to add a file/directory to the Subversion repository.</td>
173 </tr><tr>
174 <td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td>
175 <td>Public method used to add a file/directory in binary mode to the Subversion repository.</td>
176 </tr><tr>
177 <td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td>
178 <td>Public method to add a directory tree rooted at path to the Subversion repository.</td>
179 </tr><tr>
180 <td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
181 <td>Public method used to get the registered states of a number of files in the vcs.</td>
182 </tr><tr>
183 <td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td>
184 <td>Public method used to check the project out of the Subversion repository.</td>
185 </tr><tr>
186 <td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td>
187 <td>Public method used to cleanup the working copy.</td>
188 </tr><tr>
189 <td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td>
190 <td>Public method used to execute arbitrary subversion commands.</td>
191 </tr><tr>
192 <td><a href="#Subversion.vcsCommit">vcsCommit</a></td>
193 <td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td>
194 </tr><tr>
195 <td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td>
196 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
197 </tr><tr>
198 <td><a href="#Subversion.vcsDiff">vcsDiff</a></td>
199 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
200 </tr><tr>
201 <td><a href="#Subversion.vcsExists">vcsExists</a></td>
202 <td>Public method used to test for the presence of the svn executable.</td>
203 </tr><tr>
204 <td><a href="#Subversion.vcsExport">vcsExport</a></td>
205 <td>Public method used to export a directory from the Subversion repository.</td>
206 </tr><tr>
207 <td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
208 <td>Public method to instanciate a helper object for the different project browsers.</td>
209 </tr><tr>
210 <td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
211 <td>Public method to instanciate a helper object for the project.</td>
212 </tr><tr>
213 <td><a href="#Subversion.vcsImport">vcsImport</a></td>
214 <td>Public method used to import the project into the Subversion repository.</td>
215 </tr><tr>
216 <td><a href="#Subversion.vcsInit">vcsInit</a></td>
217 <td>Public method used to initialize the subversion repository.</td>
218 </tr><tr>
219 <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td>
220 <td>Public method to initialize the VCS configuration.</td>
221 </tr><tr>
222 <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td>
223 <td>Public method used to browse the log of a file/directory from the Subversion repository.</td>
224 </tr><tr>
225 <td><a href="#Subversion.vcsMerge">vcsMerge</a></td>
226 <td>Public method used to merge a URL/revision into the local project.</td>
227 </tr><tr>
228 <td><a href="#Subversion.vcsMove">vcsMove</a></td>
229 <td>Public method used to move a file/directory.</td>
230 </tr><tr>
231 <td><a href="#Subversion.vcsName">vcsName</a></td>
232 <td>Public method returning the name of the vcs.</td>
233 </tr><tr>
234 <td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
235 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
236 </tr><tr>
237 <td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td>
238 <td>Public method to get a dialog to enter repository info.</td>
239 </tr><tr>
240 <td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td>
241 <td>Public method used to get the registered state of a file in the vcs.</td>
242 </tr><tr>
243 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
244 <td>Public method used to remove a file/directory from the Subversion repository.</td>
245 </tr><tr>
246 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
247 <td>Public method to retrieve information about the repository.</td>
248 </tr><tr>
249 <td><a href="#Subversion.vcsRevert">vcsRevert</a></td>
250 <td>Public method used to revert changes made to a file/directory.</td>
251 </tr><tr>
252 <td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td>
253 <td>Public method used to shutdown the Subversion interface.</td>
254 </tr><tr>
255 <td><a href="#Subversion.vcsStatus">vcsStatus</a></td>
256 <td>Public method used to view the status of files/directories in the Subversion repository.</td>
257 </tr><tr>
258 <td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td>
259 <td>Public method used to switch a directory to a different tag/branch.</td>
260 </tr><tr>
261 <td><a href="#Subversion.vcsTag">vcsTag</a></td>
262 <td>Public method used to set the tag of a file/directory in the Subversion repository.</td>
263 </tr><tr>
264 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
265 <td>Public method used to update a file/directory with the Subversion repository.</td>
266 </tr>
267 </table>
268 <h3>Static Methods</h3>
269 <table>
270 <tr><td>None</td></tr>
271 </table>
272 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
273 <h4>Subversion (Constructor)</h4>
274 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>)
275 <p>
276 Constructor
277 </p><dl>
278 <dt><i>plugin</i></dt>
279 <dd>
280 reference to the plugin object
281 </dd><dt><i>parent</i></dt>
282 <dd>
283 parent widget (QWidget)
284 </dd><dt><i>name</i></dt>
285 <dd>
286 name of this object (string)
287 </dd>
288 </dl><a NAME="Subversion.__isVersioned" ID="Subversion.__isVersioned"></a>
289 <h4>Subversion.__isVersioned</h4>
290 <b>__isVersioned</b>(<i>status</i>)
291 <p>
292 Private method to check, if the given status indicates a
293 versioned state.
294 </p><dl>
295 <dt><i>status</i></dt>
296 <dd>
297 status object to check (pysvn.PysvnStatus)
298 </dd>
299 </dl><dl>
300 <dt>Returns:</dt>
301 <dd>
302 flag indicating a versioned state (boolean)
303 </dd>
304 </dl><a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
305 <h4>Subversion.__svnGetFileForRevision</h4>
306 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>)
307 <p>
308 Private method to get a file for a specific revision from the
309 repository.
310 </p><dl>
311 <dt><i>name</i></dt>
312 <dd>
313 file name to get from the repository (string)
314 </dd><dt><i>rev=</i></dt>
315 <dd>
316 revision to retrieve (integer or string)
317 </dd>
318 </dl><dl>
319 <dt>Returns:</dt>
320 <dd>
321 contents of the file (string) and an error message (string)
322 </dd>
323 </dl><a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
324 <h4>Subversion.__svnURL</h4>
325 <b>__svnURL</b>(<i>url</i>)
326 <p>
327 Private method to format a url for subversion.
328 </p><dl>
329 <dt><i>url</i></dt>
330 <dd>
331 unformatted url string (string)
332 </dd>
333 </dl><dl>
334 <dt>Returns:</dt>
335 <dd>
336 properly formated url for subversion (string)
337 </dd>
338 </dl><a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a>
339 <h4>Subversion.__vcsAllRegisteredStates_wc</h4>
340 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>)
341 <p>
342 Private method used to get the registered states of a number of files
343 in the VCS.
344 </p><p>
345 This is the variant for subversion installations using the old working
346 copy meta-data format.
347 </p><p>
348 <b>Note:</b> If a shortcut is to be taken, the code will only check,
349 if the named directory has been scanned already. If so, it is assumed,
350 that the states for all files has been populated by the previous run.
351 </p><dl>
352 <dt><i>names</i></dt>
353 <dd>
354 dictionary with all filenames to be checked as keys
355 </dd><dt><i>dname</i></dt>
356 <dd>
357 directory to check in (string)
358 </dd><dt><i>shortcut</i></dt>
359 <dd>
360 flag indicating a shortcut should be taken (boolean)
361 </dd>
362 </dl><dl>
363 <dt>Returns:</dt>
364 <dd>
365 the received dictionary completed with a combination of
366 canBeCommited and canBeAdded or None in order to signal an error
367 </dd>
368 </dl><a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a>
369 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
370 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>)
371 <p>
372 Private method used to get the registered states of a number of files
373 in the vcs.
374 </p><p>
375 This is the variant for subversion installations using the new working
376 copy meta-data format.
377 </p><p>
378 <b>Note:</b> If a shortcut is to be taken, the code will only check,
379 if the named directory has been scanned already. If so, it is assumed,
380 that the states for all files has been populated by the previous run.
381 </p><dl>
382 <dt><i>names</i></dt>
383 <dd>
384 dictionary with all filenames to be checked as keys
385 </dd><dt><i>dname</i></dt>
386 <dd>
387 directory to check in (string)
388 </dd><dt><i>shortcut</i></dt>
389 <dd>
390 flag indicating a shortcut should be taken (boolean)
391 </dd>
392 </dl><dl>
393 <dt>Returns:</dt>
394 <dd>
395 the received dictionary completed with a combination of
396 canBeCommited and canBeAdded or None in order to signal an error
397 </dd>
398 </dl><a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
399 <h4>Subversion.__vcsCommit_Step2</h4>
400 <b>__vcsCommit_Step2</b>(<i></i>)
401 <p>
402 Private slot performing the second step of the commit action.
403 </p><a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a>
404 <h4>Subversion.__vcsRegisteredState_wc</h4>
405 <b>__vcsRegisteredState_wc</b>(<i>name</i>)
406 <p>
407 Private method used to get the registered state of a file in the vcs.
408 </p><p>
409 This is the variant for subversion installations using the old working
410 copy meta-data format.
411 </p><dl>
412 <dt><i>name</i></dt>
413 <dd>
414 filename to check (string)
415 </dd>
416 </dl><dl>
417 <dt>Returns:</dt>
418 <dd>
419 a combination of canBeCommited and canBeAdded
420 </dd>
421 </dl><a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a>
422 <h4>Subversion.__vcsRegisteredState_wcng</h4>
423 <b>__vcsRegisteredState_wcng</b>(<i>name</i>)
424 <p>
425 Private method used to get the registered state of a file in the vcs.
426 </p><p>
427 This is the variant for subversion installations using the new
428 working copy meta-data format.
429 </p><dl>
430 <dt><i>name</i></dt>
431 <dd>
432 filename to check (string)
433 </dd>
434 </dl><dl>
435 <dt>Returns:</dt>
436 <dd>
437 a combination of canBeCommited and canBeAdded
438 </dd>
439 </dl><a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
440 <h4>Subversion._createStatusMonitorThread</h4>
441 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
442 <p>
443 Protected method to create an instance of the VCS status monitor
444 thread.
445 </p><dl>
446 <dt><i>interval</i></dt>
447 <dd>
448 check interval for the monitor thread in seconds
449 (integer)
450 </dd><dt><i>project</i></dt>
451 <dd>
452 reference to the project object
453 </dd>
454 </dl><dl>
455 <dt>Returns:</dt>
456 <dd>
457 reference to the monitor thread (QThread)
458 </dd>
459 </dl><a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
460 <h4>Subversion.clearStatusCache</h4>
461 <b>clearStatusCache</b>(<i></i>)
462 <p>
463 Public method to clear the status cache.
464 </p><a NAME="Subversion.getClient" ID="Subversion.getClient"></a>
465 <h4>Subversion.getClient</h4>
466 <b>getClient</b>(<i></i>)
467 <p>
468 Public method to create and initialize the pysvn client object.
469 </p><dl>
470 <dt>Returns:</dt>
471 <dd>
472 the pysvn client object (pysvn.Client)
473 </dd>
474 </dl><a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
475 <h4>Subversion.getPlugin</h4>
476 <b>getPlugin</b>(<i></i>)
477 <p>
478 Public method to get a reference to the plugin object.
479 </p><dl>
480 <dt>Returns:</dt>
481 <dd>
482 reference to the plugin object (VcsPySvnPlugin)
483 </dd>
484 </dl><a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
485 <h4>Subversion.svnAddToChangelist</h4>
486 <b>svnAddToChangelist</b>(<i>names</i>)
487 <p>
488 Public method to add a file or directory to a changelist.
489 </p><p>
490 Note: Directories will be added recursively.
491 </p><dl>
492 <dt><i>names</i></dt>
493 <dd>
494 name or list of names of file or directory to add
495 (string)
496 </dd>
497 </dl><a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
498 <h4>Subversion.svnBlame</h4>
499 <b>svnBlame</b>(<i>name</i>)
500 <p>
501 Public method to show the output of the svn blame command.
502 </p><dl>
503 <dt><i>name</i></dt>
504 <dd>
505 file name to show the blame for (string)
506 </dd>
507 </dl><a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
508 <h4>Subversion.svnCopy</h4>
509 <b>svnCopy</b>(<i>name, project</i>)
510 <p>
511 Public method used to copy a file/directory.
512 </p><dl>
513 <dt><i>name</i></dt>
514 <dd>
515 file/directory name to be copied (string)
516 </dd><dt><i>project</i></dt>
517 <dd>
518 reference to the project object
519 </dd>
520 </dl><dl>
521 <dt>Returns:</dt>
522 <dd>
523 flag indicating successfull operation (boolean)
524 </dd>
525 </dl><a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
526 <h4>Subversion.svnDelProp</h4>
527 <b>svnDelProp</b>(<i>name, recursive=False</i>)
528 <p>
529 Public method used to delete a property of a file/directory.
530 </p><dl>
531 <dt><i>name</i></dt>
532 <dd>
533 file/directory name (string or list of strings)
534 </dd><dt><i>recursive</i></dt>
535 <dd>
536 flag indicating a recursive list is requested
537 </dd>
538 </dl><a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
539 <h4>Subversion.svnExtendedDiff</h4>
540 <b>svnExtendedDiff</b>(<i>name</i>)
541 <p>
542 Public method used to view the difference of a file/directory to the
543 Subversion repository.
544 </p><p>
545 If name is a directory and is the project directory, all project files
546 are saved first. If name is a file (or list of files), which is/are
547 being edited and has unsaved modification, they can be saved or the
548 operation may be aborted.
549 </p><p>
550 This method gives the chance to enter the revisions to be compared.
551 </p><dl>
552 <dt><i>name</i></dt>
553 <dd>
554 file/directory name to be diffed (string)
555 </dd>
556 </dl><a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a>
557 <h4>Subversion.svnGetChangelists</h4>
558 <b>svnGetChangelists</b>(<i></i>)
559 <p>
560 Public method to get a list of all defined change lists.
561 </p><dl>
562 <dt>Returns:</dt>
563 <dd>
564 list of defined change list names (list of strings)
565 </dd>
566 </dl><a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
567 <h4>Subversion.svnGetReposName</h4>
568 <b>svnGetReposName</b>(<i>path</i>)
569 <p>
570 Public method used to retrieve the URL of the subversion repository
571 path.
572 </p><dl>
573 <dt><i>path</i></dt>
574 <dd>
575 local path to get the svn repository path for (string)
576 </dd>
577 </dl><dl>
578 <dt>Returns:</dt>
579 <dd>
580 string with the repository path URL
581 </dd>
582 </dl><a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a>
583 <h4>Subversion.svnInfo</h4>
584 <b>svnInfo</b>(<i>projectPath, name</i>)
585 <p>
586 Public method to show repository information about a file or directory.
587 </p><dl>
588 <dt><i>projectPath</i></dt>
589 <dd>
590 path name of the project (string)
591 </dd><dt><i>name</i></dt>
592 <dd>
593 file/directory name relative to the project (string)
594 </dd>
595 </dl><a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
596 <h4>Subversion.svnListProps</h4>
597 <b>svnListProps</b>(<i>name, recursive=False</i>)
598 <p>
599 Public method used to list the properties of a file/directory.
600 </p><dl>
601 <dt><i>name</i></dt>
602 <dd>
603 file/directory name (string or list of strings)
604 </dd><dt><i>recursive</i></dt>
605 <dd>
606 flag indicating a recursive list is requested
607 </dd>
608 </dl><a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
609 <h4>Subversion.svnListTagBranch</h4>
610 <b>svnListTagBranch</b>(<i>path, tags=True</i>)
611 <p>
612 Public method used to list the available tags or branches.
613 </p><dl>
614 <dt><i>path</i></dt>
615 <dd>
616 directory name of the project (string)
617 </dd><dt><i>tags</i></dt>
618 <dd>
619 flag indicating listing of branches or tags
620 (False = branches, True = tags)
621 </dd>
622 </dl><a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
623 <h4>Subversion.svnLock</h4>
624 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
625 <p>
626 Public method used to lock a file in the Subversion repository.
627 </p><dl>
628 <dt><i>name</i></dt>
629 <dd>
630 file/directory name to be locked (string or list of
631 strings)
632 </dd><dt><i>stealIt</i></dt>
633 <dd>
634 flag indicating a forced operation (boolean)
635 </dd><dt><i>parent</i></dt>
636 <dd>
637 reference to the parent object of the subversion dialog
638 (QWidget)
639 </dd>
640 </dl><a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
641 <h4>Subversion.svnNormalizeURL</h4>
642 <b>svnNormalizeURL</b>(<i>url</i>)
643 <p>
644 Public method to normalize a url for subversion.
645 </p><dl>
646 <dt><i>url</i></dt>
647 <dd>
648 url string (string)
649 </dd>
650 </dl><dl>
651 <dt>Returns:</dt>
652 <dd>
653 properly normalized url for subversion (string)
654 </dd>
655 </dl><a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
656 <h4>Subversion.svnRelocate</h4>
657 <b>svnRelocate</b>(<i>projectPath</i>)
658 <p>
659 Public method to relocate the working copy to a new repository URL.
660 </p><dl>
661 <dt><i>projectPath</i></dt>
662 <dd>
663 path name of the project (string)
664 </dd>
665 </dl><a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
666 <h4>Subversion.svnRemoveFromChangelist</h4>
667 <b>svnRemoveFromChangelist</b>(<i>names</i>)
668 <p>
669 Public method to remove a file or directory from its changelist.
670 </p><p>
671 Note: Directories will be removed recursively.
672 </p><dl>
673 <dt><i>names</i></dt>
674 <dd>
675 name or list of names of file or directory to remove
676 (string)
677 </dd>
678 </dl><a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
679 <h4>Subversion.svnRepoBrowser</h4>
680 <b>svnRepoBrowser</b>(<i>projectPath=None</i>)
681 <p>
682 Public method to open the repository browser.
683 </p><dl>
684 <dt><i>projectPath</i></dt>
685 <dd>
686 path name of the project (string)
687 </dd>
688 </dl><a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a>
689 <h4>Subversion.svnResolve</h4>
690 <b>svnResolve</b>(<i>name</i>)
691 <p>
692 Public method used to resolve conflicts of a file/directory.
693 </p><dl>
694 <dt><i>name</i></dt>
695 <dd>
696 file/directory name to be resolved (string)
697 </dd>
698 </dl><a NAME="Subversion.svnSbsDiff" ID="Subversion.svnSbsDiff"></a>
699 <h4>Subversion.svnSbsDiff</h4>
700 <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
701 <p>
702 Public method used to view the difference of a file to the Mercurial
703 repository side-by-side.
704 </p><dl>
705 <dt><i>name</i></dt>
706 <dd>
707 file name to be diffed (string)
708 </dd><dt><i>extended=</i></dt>
709 <dd>
710 flag indicating the extended variant (boolean)
711 </dd><dt><i>revisions=</i></dt>
712 <dd>
713 tuple of two revisions (tuple of strings)
714 </dd>
715 </dl><dl>
716 <dt>Raises <b>ValueError</b>:</dt>
717 <dd>
718 raised to indicate an invalid name parameter type
719 </dd>
720 </dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
721 <h4>Subversion.svnSetProp</h4>
722 <b>svnSetProp</b>(<i>name, recursive=False</i>)
723 <p>
724 Public method used to add a property to a file/directory.
725 </p><dl>
726 <dt><i>name</i></dt>
727 <dd>
728 file/directory name (string or list of strings)
729 </dd><dt><i>recursive</i></dt>
730 <dd>
731 flag indicating a recursive set is requested
732 </dd>
733 </dl><a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a>
734 <h4>Subversion.svnShowChangelists</h4>
735 <b>svnShowChangelists</b>(<i>path</i>)
736 <p>
737 Public method used to inspect the change lists defined for the project.
738 </p><dl>
739 <dt><i>path</i></dt>
740 <dd>
741 directory name to show change lists for (string)
742 </dd>
743 </dl><a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
744 <h4>Subversion.svnUnlock</h4>
745 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
746 <p>
747 Public method used to unlock a file in the Subversion repository.
748 </p><dl>
749 <dt><i>name</i></dt>
750 <dd>
751 file/directory name to be unlocked (string or list of
752 strings)
753 </dd><dt><i>breakIt</i></dt>
754 <dd>
755 flag indicating a forced operation (boolean)
756 </dd><dt><i>parent</i></dt>
757 <dd>
758 reference to the parent object of the subversion dialog
759 (QWidget)
760 </dd>
761 </dl><a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a>
762 <h4>Subversion.svnUpgrade</h4>
763 <b>svnUpgrade</b>(<i>path</i>)
764 <p>
765 Public method to upgrade the working copy format.
766 </p><dl>
767 <dt><i>path</i></dt>
768 <dd>
769 directory name to show change lists for (string)
770 </dd>
771 </dl><a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
772 <h4>Subversion.svnUrlDiff</h4>
773 <b>svnUrlDiff</b>(<i>name</i>)
774 <p>
775 Public method used to view the difference of a file/directory of two
776 repository URLs.
777 </p><p>
778 If name is a directory and is the project directory, all project files
779 are saved first. If name is a file (or list of files), which is/are
780 being edited and has unsaved modification, they can be saved or the
781 operation may be aborted.
782 </p><p>
783 This method gives the chance to enter the revisions to be compared.
784 </p><dl>
785 <dt><i>name</i></dt>
786 <dd>
787 file/directory name to be diffed (string)
788 </dd>
789 </dl><a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
790 <h4>Subversion.vcsAdd</h4>
791 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
792 <p>
793 Public method used to add a file/directory to the Subversion
794 repository.
795 </p><dl>
796 <dt><i>name</i></dt>
797 <dd>
798 file/directory name to be added (string)
799 </dd><dt><i>isDir</i></dt>
800 <dd>
801 flag indicating name is a directory (boolean)
802 </dd><dt><i>noDialog</i></dt>
803 <dd>
804 flag indicating quiet operations (boolean)
805 </dd>
806 </dl><a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
807 <h4>Subversion.vcsAddBinary</h4>
808 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
809 <p>
810 Public method used to add a file/directory in binary mode to the
811 Subversion repository.
812 </p><dl>
813 <dt><i>name</i></dt>
814 <dd>
815 file/directory name to be added (string)
816 </dd><dt><i>isDir</i></dt>
817 <dd>
818 flag indicating name is a directory (boolean)
819 </dd>
820 </dl><a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
821 <h4>Subversion.vcsAddTree</h4>
822 <b>vcsAddTree</b>(<i>path</i>)
823 <p>
824 Public method to add a directory tree rooted at path to the Subversion
825 repository.
826 </p><dl>
827 <dt><i>path</i></dt>
828 <dd>
829 root directory of the tree to be added (string or list of
830 strings))
831 </dd>
832 </dl><a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
833 <h4>Subversion.vcsAllRegisteredStates</h4>
834 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
835 <p>
836 Public method used to get the registered states of a number of files
837 in the vcs.
838 </p><p>
839 <b>Note:</b> If a shortcut is to be taken, the code will only check,
840 if the named directory has been scanned already. If so, it is assumed,
841 that the states for all files has been populated by the previous run.
842 </p><dl>
843 <dt><i>names</i></dt>
844 <dd>
845 dictionary with all filenames to be checked as keys
846 </dd><dt><i>dname</i></dt>
847 <dd>
848 directory to check in (string)
849 </dd><dt><i>shortcut</i></dt>
850 <dd>
851 flag indicating a shortcut should be taken (boolean)
852 </dd>
853 </dl><dl>
854 <dt>Returns:</dt>
855 <dd>
856 the received dictionary completed with a combination of
857 canBeCommited and canBeAdded or None in order to signal an error
858 </dd>
859 </dl><a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
860 <h4>Subversion.vcsCheckout</h4>
861 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
862 <p>
863 Public method used to check the project out of the Subversion
864 repository.
865 </p><dl>
866 <dt><i>vcsDataDict</i></dt>
867 <dd>
868 dictionary of data required for the checkout
869 </dd><dt><i>projectDir</i></dt>
870 <dd>
871 project directory to create (string)
872 </dd><dt><i>noDialog</i></dt>
873 <dd>
874 flag indicating quiet operations
875 </dd>
876 </dl><dl>
877 <dt>Returns:</dt>
878 <dd>
879 flag indicating an execution without errors (boolean)
880 </dd>
881 </dl><a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
882 <h4>Subversion.vcsCleanup</h4>
883 <b>vcsCleanup</b>(<i>name</i>)
884 <p>
885 Public method used to cleanup the working copy.
886 </p><dl>
887 <dt><i>name</i></dt>
888 <dd>
889 directory name to be cleaned up (string)
890 </dd>
891 </dl><a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
892 <h4>Subversion.vcsCommandLine</h4>
893 <b>vcsCommandLine</b>(<i>name</i>)
894 <p>
895 Public method used to execute arbitrary subversion commands.
896 </p><dl>
897 <dt><i>name</i></dt>
898 <dd>
899 directory name of the working directory (string)
900 </dd>
901 </dl><a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
902 <h4>Subversion.vcsCommit</h4>
903 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
904 <p>
905 Public method used to make the change of a file/directory permanent
906 in the Subversion repository.
907 </p><dl>
908 <dt><i>name</i></dt>
909 <dd>
910 file/directory name to be committed (string or
911 list of strings)
912 </dd><dt><i>message</i></dt>
913 <dd>
914 message for this operation (string)
915 </dd><dt><i>noDialog</i></dt>
916 <dd>
917 flag indicating quiet operations
918 </dd>
919 </dl><a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
920 <h4>Subversion.vcsConvertProject</h4>
921 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
922 <p>
923 Public method to convert an uncontrolled project to a version
924 controlled project.
925 </p><dl>
926 <dt><i>vcsDataDict</i></dt>
927 <dd>
928 dictionary of data required for the conversion
929 </dd><dt><i>project</i></dt>
930 <dd>
931 reference to the project object
932 </dd>
933 </dl><a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
934 <h4>Subversion.vcsDiff</h4>
935 <b>vcsDiff</b>(<i>name</i>)
936 <p>
937 Public method used to view the difference of a file/directory to the
938 Subversion repository.
939 </p><p>
940 If name is a directory and is the project directory, all project files
941 are saved first. If name is a file (or list of files), which is/are
942 being edited and has unsaved modification, they can be saved or the
943 operation may be aborted.
944 </p><dl>
945 <dt><i>name</i></dt>
946 <dd>
947 file/directory name to be diffed (string)
948 </dd>
949 </dl><a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
950 <h4>Subversion.vcsExists</h4>
951 <b>vcsExists</b>(<i></i>)
952 <p>
953 Public method used to test for the presence of the svn executable.
954 </p><dl>
955 <dt>Returns:</dt>
956 <dd>
957 flag indicating the existance (boolean) and an error message
958 (string)
959 </dd>
960 </dl><a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
961 <h4>Subversion.vcsExport</h4>
962 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
963 <p>
964 Public method used to export a directory from the Subversion
965 repository.
966 </p><dl>
967 <dt><i>vcsDataDict</i></dt>
968 <dd>
969 dictionary of data required for the checkout
970 </dd><dt><i>projectDir</i></dt>
971 <dd>
972 project directory to create (string)
973 </dd>
974 </dl><dl>
975 <dt>Returns:</dt>
976 <dd>
977 flag indicating an execution without errors (boolean)
978 </dd>
979 </dl><a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
980 <h4>Subversion.vcsGetProjectBrowserHelper</h4>
981 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
982 <p>
983 Public method to instanciate a helper object for the different
984 project browsers.
985 </p><dl>
986 <dt><i>browser</i></dt>
987 <dd>
988 reference to the project browser object
989 </dd><dt><i>project</i></dt>
990 <dd>
991 reference to the project object
992 </dd><dt><i>isTranslationsBrowser</i></dt>
993 <dd>
994 flag indicating, the helper is requested
995 for the translations browser (this needs some special treatment)
996 </dd>
997 </dl><dl>
998 <dt>Returns:</dt>
999 <dd>
1000 the project browser helper object
1001 </dd>
1002 </dl><a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
1003 <h4>Subversion.vcsGetProjectHelper</h4>
1004 <b>vcsGetProjectHelper</b>(<i>project</i>)
1005 <p>
1006 Public method to instanciate a helper object for the project.
1007 </p><dl>
1008 <dt><i>project</i></dt>
1009 <dd>
1010 reference to the project object
1011 </dd>
1012 </dl><dl>
1013 <dt>Returns:</dt>
1014 <dd>
1015 the project helper object
1016 </dd>
1017 </dl><a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
1018 <h4>Subversion.vcsImport</h4>
1019 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1020 <p>
1021 Public method used to import the project into the Subversion
1022 repository.
1023 </p><dl>
1024 <dt><i>vcsDataDict</i></dt>
1025 <dd>
1026 dictionary of data required for the import
1027 </dd><dt><i>projectDir</i></dt>
1028 <dd>
1029 project directory (string)
1030 </dd><dt><i>noDialog</i></dt>
1031 <dd>
1032 flag indicating quiet operations
1033 </dd>
1034 </dl><dl>
1035 <dt>Returns:</dt>
1036 <dd>
1037 flag indicating an execution without errors (boolean)
1038 and a flag indicating the version controll status (boolean)
1039 </dd>
1040 </dl><a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
1041 <h4>Subversion.vcsInit</h4>
1042 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
1043 <p>
1044 Public method used to initialize the subversion repository.
1045 </p><p>
1046 The subversion repository has to be initialized from outside eric6
1047 because the respective command always works locally. Therefore we
1048 always return TRUE without doing anything.
1049 </p><dl>
1050 <dt><i>vcsDir</i></dt>
1051 <dd>
1052 name of the VCS directory (string)
1053 </dd><dt><i>noDialog</i></dt>
1054 <dd>
1055 flag indicating quiet operations (boolean)
1056 </dd>
1057 </dl><dl>
1058 <dt>Returns:</dt>
1059 <dd>
1060 always TRUE
1061 </dd>
1062 </dl><a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
1063 <h4>Subversion.vcsInitConfig</h4>
1064 <b>vcsInitConfig</b>(<i>project</i>)
1065 <p>
1066 Public method to initialize the VCS configuration.
1067 </p><p>
1068 This method ensures, that eric specific files and directories are
1069 ignored.
1070 </p><dl>
1071 <dt><i>project</i></dt>
1072 <dd>
1073 reference to the project (Project)
1074 </dd>
1075 </dl><a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
1076 <h4>Subversion.vcsLogBrowser</h4>
1077 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
1078 <p>
1079 Public method used to browse the log of a file/directory from the
1080 Subversion repository.
1081 </p><dl>
1082 <dt><i>name</i></dt>
1083 <dd>
1084 file/directory name to show the log of (string)
1085 </dd><dt><i>isFile</i></dt>
1086 <dd>
1087 flag indicating log for a file is to be shown (boolean)
1088 </dd>
1089 </dl><a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
1090 <h4>Subversion.vcsMerge</h4>
1091 <b>vcsMerge</b>(<i>name</i>)
1092 <p>
1093 Public method used to merge a URL/revision into the local project.
1094 </p><dl>
1095 <dt><i>name</i></dt>
1096 <dd>
1097 file/directory name to be merged (string)
1098 </dd>
1099 </dl><a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
1100 <h4>Subversion.vcsMove</h4>
1101 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
1102 <p>
1103 Public method used to move a file/directory.
1104 </p><dl>
1105 <dt><i>name</i></dt>
1106 <dd>
1107 file/directory name to be moved (string)
1108 </dd><dt><i>project</i></dt>
1109 <dd>
1110 reference to the project object
1111 </dd><dt><i>target</i></dt>
1112 <dd>
1113 new name of the file/directory (string)
1114 </dd><dt><i>noDialog</i></dt>
1115 <dd>
1116 flag indicating quiet operations
1117 </dd>
1118 </dl><dl>
1119 <dt>Returns:</dt>
1120 <dd>
1121 flag indicating successfull operation (boolean)
1122 </dd>
1123 </dl><a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
1124 <h4>Subversion.vcsName</h4>
1125 <b>vcsName</b>(<i></i>)
1126 <p>
1127 Public method returning the name of the vcs.
1128 </p><dl>
1129 <dt>Returns:</dt>
1130 <dd>
1131 always 'Subversion' (string)
1132 </dd>
1133 </dl><a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
1134 <h4>Subversion.vcsNewProjectOptionsDialog</h4>
1135 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
1136 <p>
1137 Public method to get a dialog to enter repository info for getting a
1138 new project.
1139 </p><dl>
1140 <dt><i>parent</i></dt>
1141 <dd>
1142 parent widget (QWidget)
1143 </dd>
1144 </dl><dl>
1145 <dt>Returns:</dt>
1146 <dd>
1147 reference to the instantiated options dialog
1148 (SvnNewProjectOptionsDialog)
1149 </dd>
1150 </dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
1151 <h4>Subversion.vcsOptionsDialog</h4>
1152 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
1153 <p>
1154 Public method to get a dialog to enter repository info.
1155 </p><dl>
1156 <dt><i>project</i></dt>
1157 <dd>
1158 reference to the project object
1159 </dd><dt><i>archive</i></dt>
1160 <dd>
1161 name of the project in the repository (string)
1162 </dd><dt><i>editable</i></dt>
1163 <dd>
1164 flag indicating that the project name is editable
1165 (boolean)
1166 </dd><dt><i>parent</i></dt>
1167 <dd>
1168 parent widget (QWidget)
1169 </dd>
1170 </dl><dl>
1171 <dt>Returns:</dt>
1172 <dd>
1173 reference to the instantiated options dialog (SvnOptionsDialog)
1174 </dd>
1175 </dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
1176 <h4>Subversion.vcsRegisteredState</h4>
1177 <b>vcsRegisteredState</b>(<i>name</i>)
1178 <p>
1179 Public method used to get the registered state of a file in the vcs.
1180 </p><dl>
1181 <dt><i>name</i></dt>
1182 <dd>
1183 filename to check (string)
1184 </dd>
1185 </dl><dl>
1186 <dt>Returns:</dt>
1187 <dd>
1188 a combination of canBeCommited and canBeAdded
1189 </dd>
1190 </dl><a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
1191 <h4>Subversion.vcsRemove</h4>
1192 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
1193 <p>
1194 Public method used to remove a file/directory from the Subversion
1195 repository.
1196 </p><p>
1197 The default operation is to remove the local copy as well.
1198 </p><dl>
1199 <dt><i>name</i></dt>
1200 <dd>
1201 file/directory name to be removed (string or list of
1202 strings))
1203 </dd><dt><i>project</i></dt>
1204 <dd>
1205 flag indicating deletion of a project tree (boolean)
1206 (not needed)
1207 </dd><dt><i>noDialog</i></dt>
1208 <dd>
1209 flag indicating quiet operations
1210 </dd>
1211 </dl><dl>
1212 <dt>Returns:</dt>
1213 <dd>
1214 flag indicating successfull operation (boolean)
1215 </dd>
1216 </dl><a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
1217 <h4>Subversion.vcsRepositoryInfos</h4>
1218 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1219 <p>
1220 Public method to retrieve information about the repository.
1221 </p><dl>
1222 <dt><i>ppath</i></dt>
1223 <dd>
1224 local path to get the repository infos (string)
1225 </dd>
1226 </dl><dl>
1227 <dt>Returns:</dt>
1228 <dd>
1229 string with ready formated info for display (string)
1230 </dd>
1231 </dl><a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
1232 <h4>Subversion.vcsRevert</h4>
1233 <b>vcsRevert</b>(<i>name</i>)
1234 <p>
1235 Public method used to revert changes made to a file/directory.
1236 </p><dl>
1237 <dt><i>name</i></dt>
1238 <dd>
1239 file/directory name to be reverted (string)
1240 </dd>
1241 </dl><a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
1242 <h4>Subversion.vcsShutdown</h4>
1243 <b>vcsShutdown</b>(<i></i>)
1244 <p>
1245 Public method used to shutdown the Subversion interface.
1246 </p><a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
1247 <h4>Subversion.vcsStatus</h4>
1248 <b>vcsStatus</b>(<i>name</i>)
1249 <p>
1250 Public method used to view the status of files/directories in the
1251 Subversion repository.
1252 </p><dl>
1253 <dt><i>name</i></dt>
1254 <dd>
1255 file/directory name(s) to show the status of
1256 (string or list of strings)
1257 </dd>
1258 </dl><a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
1259 <h4>Subversion.vcsSwitch</h4>
1260 <b>vcsSwitch</b>(<i>name</i>)
1261 <p>
1262 Public method used to switch a directory to a different tag/branch.
1263 </p><dl>
1264 <dt><i>name</i></dt>
1265 <dd>
1266 directory name to be switched (string)
1267 </dd>
1268 </dl><dl>
1269 <dt>Returns:</dt>
1270 <dd>
1271 flag indicating, that the switch contained an add
1272 or delete (boolean)
1273 </dd>
1274 </dl><a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
1275 <h4>Subversion.vcsTag</h4>
1276 <b>vcsTag</b>(<i>name</i>)
1277 <p>
1278 Public method used to set the tag of a file/directory in the
1279 Subversion repository.
1280 </p><dl>
1281 <dt><i>name</i></dt>
1282 <dd>
1283 file/directory name to be tagged (string)
1284 </dd>
1285 </dl><a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
1286 <h4>Subversion.vcsUpdate</h4>
1287 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1288 <p>
1289 Public method used to update a file/directory with the Subversion
1290 repository.
1291 </p><dl>
1292 <dt><i>name</i></dt>
1293 <dd>
1294 file/directory name to be updated (string or list of
1295 strings)
1296 </dd><dt><i>noDialog</i></dt>
1297 <dd>
1298 flag indicating quiet operations (boolean)
1299 </dd>
1300 </dl><dl>
1301 <dt>Returns:</dt>
1302 <dd>
1303 flag indicating, that the update contained an add
1304 or delete (boolean)
1305 </dd>
1306 </dl>
1307 <div align="right"><a href="#top">Up</a></div>
1308 <hr />
1309 </body></html>

Mercurial Repository: eric

eric ide

mercurial