Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.VCS.VersionControl.html

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

Mercurial Repository: eric

eric ide

mercurial