Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html

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

Mercurial Repository: eric

eric ide

mercurial