Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial