Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial