Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial