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