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