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