Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.VCS.VersionControl.html

eric7/Documentation/Source/eric7.VCS.VersionControl.html

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

Mercurial Repository: eric

eric ide

mercurial