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

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Plugins.VcsPlugins.vcsMercurial.hg</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Plugins.VcsPlugins.vcsMercurial.hg</h1>
<p>
Module implementing the version control systems interface to Mercurial.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Hg">Hg</a></td>
<td>Class implementing the version control systems interface to Mercurial.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Hg" ID="Hg"></a>
<h2>Hg</h2>
<p>
    Class implementing the version control systems interface to Mercurial.
</p><h3>Signals</h3>
<dl>
<dt>activeExtensionsChanged()</dt>
<dd>
emitted when the list of active extensions
            has changed
</dd><dt>committed()</dt>
<dd>
emitted after the commit action has completed
</dd>
</dl>
<h3>Derived from</h3>
VersionControl
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Hg.__init__">Hg</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Hg.__getExtensionsInfo">__getExtensionsInfo</a></td>
<td>Private method to get the active extensions from Mercurial.</td>
</tr><tr>
<td><a href="#Hg.__hgURL">__hgURL</a></td>
<td>Private method to format a url for Mercurial.</td>
</tr><tr>
<td><a href="#Hg.__iniFileChanged">__iniFileChanged</a></td>
<td>Private slot to handle a change of the Mercurial configuration file.</td>
</tr><tr>
<td><a href="#Hg.__monitorRepoIniFile">__monitorRepoIniFile</a></td>
<td>Private slot to add a repository configuration file to the list of monitored files.</td>
</tr><tr>
<td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
<td>Private slot performing the second step of the commit action.</td>
</tr><tr>
<td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td>
<td>Protected method to create an instance of the VCS status monitor thread.</td>
</tr><tr>
<td><a href="#Hg.clearStatusCache">clearStatusCache</a></td>
<td>Public method to clear the status cache.</td>
</tr><tr>
<td><a href="#Hg.getExtensionObject">getExtensionObject</a></td>
<td>Public method to get a reference to an extension object.</td>
</tr><tr>
<td><a href="#Hg.getPlugin">getPlugin</a></td>
<td>Public method to get a reference to the plugin object.</td>
</tr><tr>
<td><a href="#Hg.hgAnnotate">hgAnnotate</a></td>
<td>Public method to show the output of the hg annotate command.</td>
</tr><tr>
<td><a href="#Hg.hgBackout">hgBackout</a></td>
<td>Public method used to backout an earlier changeset from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgBisect">hgBisect</a></td>
<td>Public method to perform bisect commands.</td>
</tr><tr>
<td><a href="#Hg.hgBranch">hgBranch</a></td>
<td>Public method used to create a branch in the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgBundle">hgBundle</a></td>
<td>Public method to create a changegroup file.</td>
</tr><tr>
<td><a href="#Hg.hgCopy">hgCopy</a></td>
<td>Public method used to copy a file/directory.</td>
</tr><tr>
<td><a href="#Hg.hgCreateIgnoreFile">hgCreateIgnoreFile</a></td>
<td>Public method to create the ignore file.</td>
</tr><tr>
<td><a href="#Hg.hgEditConfig">hgEditConfig</a></td>
<td>Public method used to edit the repository configuration file.</td>
</tr><tr>
<td><a href="#Hg.hgEditUserConfig">hgEditUserConfig</a></td>
<td>Public method used to edit the user configuration file.</td>
</tr><tr>
<td><a href="#Hg.hgExtendedDiff">hgExtendedDiff</a></td>
<td>Public method used to view the difference of a file/directory to the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgForget">hgForget</a></td>
<td>Public method used to remove a file from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td>
<td>Public method to get the list of branches.</td>
</tr><tr>
<td><a href="#Hg.hgGetTagsList">hgGetTagsList</a></td>
<td>Public method to get the list of tags.</td>
</tr><tr>
<td><a href="#Hg.hgIdentify">hgIdentify</a></td>
<td>Public method to identify the current working directory.</td>
</tr><tr>
<td><a href="#Hg.hgIdentifyBundle">hgIdentifyBundle</a></td>
<td>Public method used to identify a changegroup file.</td>
</tr><tr>
<td><a href="#Hg.hgIncoming">hgIncoming</a></td>
<td>Public method used to view the log of incoming changes from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgInfo">hgInfo</a></td>
<td>Public method to show information about the heads of the repository.</td>
</tr><tr>
<td><a href="#Hg.hgListTagBranch">hgListTagBranch</a></td>
<td>Public method used to list the available tags or branches.</td>
</tr><tr>
<td><a href="#Hg.hgLogBrowser">hgLogBrowser</a></td>
<td>Public method used to browse the log of a file/directory from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgLogLimited">hgLogLimited</a></td>
<td>Public method used to view the (limited) log of a file/directory from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgNormalizeURL">hgNormalizeURL</a></td>
<td>Public method to normalize a url for Mercurial.</td>
</tr><tr>
<td><a href="#Hg.hgOutgoing">hgOutgoing</a></td>
<td>Public method used to view the log of outgoing changes from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgPreviewBundle">hgPreviewBundle</a></td>
<td>Public method used to view the log of incoming changes from a changegroup file.</td>
</tr><tr>
<td><a href="#Hg.hgPull">hgPull</a></td>
<td>Public method used to pull changes from a remote Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgPush">hgPush</a></td>
<td>Public method used to push changes to a remote Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.hgRecover">hgRecover</a></td>
<td>Public method to recover an interrupted transaction.</td>
</tr><tr>
<td><a href="#Hg.hgResolve">hgResolve</a></td>
<td>Public method used to resolve conflicts of a file/directory.</td>
</tr><tr>
<td><a href="#Hg.hgRollback">hgRollback</a></td>
<td>Public method used to rollback the last transaction.</td>
</tr><tr>
<td><a href="#Hg.hgServe">hgServe</a></td>
<td>Public method used to serve the project.</td>
</tr><tr>
<td><a href="#Hg.hgShowBranch">hgShowBranch</a></td>
<td>Public method used to show the current branch the working directory.</td>
</tr><tr>
<td><a href="#Hg.hgShowConfig">hgShowConfig</a></td>
<td>Public method to show the combined configuration.</td>
</tr><tr>
<td><a href="#Hg.hgShowPaths">hgShowPaths</a></td>
<td>Public method to show the path aliases for remote repositories.</td>
</tr><tr>
<td><a href="#Hg.hgUnbundle">hgUnbundle</a></td>
<td>Public method to apply changegroup files.</td>
</tr><tr>
<td><a href="#Hg.hgVerify">hgVerify</a></td>
<td>Public method to verify the integrity of the repository.</td>
</tr><tr>
<td><a href="#Hg.isExtensionActive">isExtensionActive</a></td>
<td>Public method to check, if an extension is active.</td>
</tr><tr>
<td><a href="#Hg.vcsAdd">vcsAdd</a></td>
<td>Public method used to add a file/directory to the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td>
<td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsAddTree">vcsAddTree</a></td>
<td>Public method to add a directory tree rooted at path to the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
<td>Public method used to get the registered states of a number of files in the vcs.</td>
</tr><tr>
<td><a href="#Hg.vcsCheckout">vcsCheckout</a></td>
<td>Public method used to check the project out of a Mercurial repository (clone).</td>
</tr><tr>
<td><a href="#Hg.vcsCleanup">vcsCleanup</a></td>
<td>Public method used to cleanup the working directory.</td>
</tr><tr>
<td><a href="#Hg.vcsCommandLine">vcsCommandLine</a></td>
<td>Public method used to execute arbitrary mercurial commands.</td>
</tr><tr>
<td><a href="#Hg.vcsCommit">vcsCommit</a></td>
<td>Public method used to make the change of a file/directory permanent in the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsConvertProject">vcsConvertProject</a></td>
<td>Public method to convert an uncontrolled project to a version controlled project.</td>
</tr><tr>
<td><a href="#Hg.vcsDiff">vcsDiff</a></td>
<td>Public method used to view the difference of a file/directory to the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsExists">vcsExists</a></td>
<td>Public method used to test for the presence of the hg executable.</td>
</tr><tr>
<td><a href="#Hg.vcsExport">vcsExport</a></td>
<td>Public method used to export a directory from the Subversion repository.</td>
</tr><tr>
<td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
<td>Public method to instantiate a helper object for the different project browsers.</td>
</tr><tr>
<td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
<td>Public method to instantiate a helper object for the project.</td>
</tr><tr>
<td><a href="#Hg.vcsImport">vcsImport</a></td>
<td>Public method used to import the project into the Subversion repository.</td>
</tr><tr>
<td><a href="#Hg.vcsInit">vcsInit</a></td>
<td>Public method used to initialize the mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsLog">vcsLog</a></td>
<td>Public method used to view the log of a file/directory from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsMerge">vcsMerge</a></td>
<td>Public method used to merge a URL/revision into the local project.</td>
</tr><tr>
<td><a href="#Hg.vcsMove">vcsMove</a></td>
<td>Public method used to move a file/directory.</td>
</tr><tr>
<td><a href="#Hg.vcsName">vcsName</a></td>
<td>Public method returning the name of the vcs.</td>
</tr><tr>
<td><a href="#Hg.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
<td>Public method to get a dialog to enter repository info for getting a new project.</td>
</tr><tr>
<td><a href="#Hg.vcsOptionsDialog">vcsOptionsDialog</a></td>
<td>Public method to get a dialog to enter repository info.</td>
</tr><tr>
<td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td>
<td>Public method used to get the registered state of a file in the vcs.</td>
</tr><tr>
<td><a href="#Hg.vcsRemove">vcsRemove</a></td>
<td>Public method used to remove a file/directory from the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
<td>Public method to retrieve information about the repository.</td>
</tr><tr>
<td><a href="#Hg.vcsRevert">vcsRevert</a></td>
<td>Public method used to revert changes made to a file/directory.</td>
</tr><tr>
<td><a href="#Hg.vcsShutdown">vcsShutdown</a></td>
<td>Public method used to shutdown the Mercurial interface.</td>
</tr><tr>
<td><a href="#Hg.vcsStatus">vcsStatus</a></td>
<td>Public method used to view the status of files/directories in the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsSwitch">vcsSwitch</a></td>
<td>Public method used to switch a working directory to a different revision.</td>
</tr><tr>
<td><a href="#Hg.vcsTag">vcsTag</a></td>
<td>Public method used to set the tag in the Mercurial repository.</td>
</tr><tr>
<td><a href="#Hg.vcsUpdate">vcsUpdate</a></td>
<td>Public method used to update a file/directory with the Mercurial repository.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Hg.__init__" ID="Hg.__init__"></a>
<h4>Hg (Constructor)</h4>
<b>Hg</b>(<i>plugin, parent=None, name=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>plugin</i></dt>
<dd>
reference to the plugin object
</dd><dt><i>parent</i></dt>
<dd>
parent widget (QWidget)
</dd><dt><i>name</i></dt>
<dd>
name of this object (string)
</dd>
</dl><a NAME="Hg.__getExtensionsInfo" ID="Hg.__getExtensionsInfo"></a>
<h4>Hg.__getExtensionsInfo</h4>
<b>__getExtensionsInfo</b>(<i></i>)
<p>
        Private method to get the active extensions from Mercurial.
</p><a NAME="Hg.__hgURL" ID="Hg.__hgURL"></a>
<h4>Hg.__hgURL</h4>
<b>__hgURL</b>(<i>url</i>)
<p>
        Private method to format a url for Mercurial.
</p><dl>
<dt><i>url</i></dt>
<dd>
unformatted url string (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
properly formated url for subversion (string)
</dd>
</dl><a NAME="Hg.__iniFileChanged" ID="Hg.__iniFileChanged"></a>
<h4>Hg.__iniFileChanged</h4>
<b>__iniFileChanged</b>(<i>path</i>)
<p>
        Private slot to handle a change of the Mercurial configuration file.
</p><dl>
<dt><i>path</i></dt>
<dd>
name of the changed file (string)
</dd>
</dl><a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
<h4>Hg.__monitorRepoIniFile</h4>
<b>__monitorRepoIniFile</b>(<i>name</i>)
<p>
        Private slot to add a repository configuration file to the list of monitored
        files.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name pointing into the repository (string)
</dd>
</dl><a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a>
<h4>Hg.__vcsCommit_Step2</h4>
<b>__vcsCommit_Step2</b>(<i></i>)
<p>
        Private slot performing the second step of the commit action.
</p><a NAME="Hg._createStatusMonitorThread" ID="Hg._createStatusMonitorThread"></a>
<h4>Hg._createStatusMonitorThread</h4>
<b>_createStatusMonitorThread</b>(<i>interval, project</i>)
<p>
        Protected method to create an instance of the VCS status monitor thread.
</p><dl>
<dt><i>project</i></dt>
<dd>
reference to the project object (Project)
</dd><dt><i>interval</i></dt>
<dd>
check interval for the monitor thread in seconds (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the monitor thread (QThread)
</dd>
</dl><a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a>
<h4>Hg.clearStatusCache</h4>
<b>clearStatusCache</b>(<i></i>)
<p>
        Public method to clear the status cache.
</p><a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a>
<h4>Hg.getExtensionObject</h4>
<b>getExtensionObject</b>(<i>extensionName</i>)
<p>
        Public method to get a reference to an extension object.
</p><dl>
<dt><i>extensionName</i></dt>
<dd>
name of the extension (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the extension object (boolean)
</dd>
</dl><a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a>
<h4>Hg.getPlugin</h4>
<b>getPlugin</b>(<i></i>)
<p>
        Public method to get a reference to the plugin object.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the plugin object (VcsMercurialPlugin)
</dd>
</dl><a NAME="Hg.hgAnnotate" ID="Hg.hgAnnotate"></a>
<h4>Hg.hgAnnotate</h4>
<b>hgAnnotate</b>(<i>name</i>)
<p>
        Public method to show the output of the hg annotate command.
</p><dl>
<dt><i>name</i></dt>
<dd>
file name to show the annotations for (string)
</dd>
</dl><a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a>
<h4>Hg.hgBackout</h4>
<b>hgBackout</b>(<i>name</i>)
<p>
        Public method used to backout an earlier changeset from the Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name (string or list of strings)
</dd>
</dl><a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a>
<h4>Hg.hgBisect</h4>
<b>hgBisect</b>(<i>name, subcommand</i>)
<p>
        Public method to perform bisect commands.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd><dt><i>subcommand</i></dt>
<dd>
name of the subcommand (string, one of 'good', 'bad',
            'skip' or 'reset')
</dd>
</dl><a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a>
<h4>Hg.hgBranch</h4>
<b>hgBranch</b>(<i>name</i>)
<p>
        Public method used to create a branch in the Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be branched (string)
</dd>
</dl><a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a>
<h4>Hg.hgBundle</h4>
<b>hgBundle</b>(<i>name</i>)
<p>
        Public method to create a changegroup file.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a>
<h4>Hg.hgCopy</h4>
<b>hgCopy</b>(<i>name, project</i>)
<p>
        Public method used to copy a file/directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be copied (string)
</dd><dt><i>project</i></dt>
<dd>
reference to the project object
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating successfull operation (boolean)
</dd>
</dl><a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a>
<h4>Hg.hgCreateIgnoreFile</h4>
<b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>)
<p>
        Public method to create the ignore file.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name to create the ignore file in (string)
</dd><dt><i>autoAdd</i></dt>
<dd>
flag indicating to add it automatically (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success
</dd>
</dl><a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a>
<h4>Hg.hgEditConfig</h4>
<b>hgEditConfig</b>(<i>name</i>)
<p>
        Public method used to edit the repository configuration file.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a>
<h4>Hg.hgEditUserConfig</h4>
<b>hgEditUserConfig</b>(<i></i>)
<p>
        Public method used to edit the user configuration file.
</p><a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a>
<h4>Hg.hgExtendedDiff</h4>
<b>hgExtendedDiff</b>(<i>name</i>)
<p>
        Public method used to view the difference of a file/directory to the
        Mercurial repository.
</p><p>
        If name is a directory and is the project directory, all project files
        are saved first. If name is a file (or list of files), which is/are being edited
        and has unsaved modification, they can be saved or the operation may be aborted.
</p><p>
        This method gives the chance to enter the revisions to be compared.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be diffed (string)
</dd>
</dl><a NAME="Hg.hgForget" ID="Hg.hgForget"></a>
<h4>Hg.hgForget</h4>
<b>hgForget</b>(<i>name</i>)
<p>
        Public method used to remove a file from the Mercurial repository.
</p><p>
        This will not remove the file from the project directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be removed (string or list of strings))
</dd>
</dl><a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
<h4>Hg.hgGetBranchesList</h4>
<b>hgGetBranchesList</b>(<i>repodir</i>)
<p>
        Public method to get the list of branches.
</p><dl>
<dt><i>repodir</i></dt>
<dd>
directory name of the repository (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of branches (list of string)
</dd>
</dl><a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a>
<h4>Hg.hgGetTagsList</h4>
<b>hgGetTagsList</b>(<i>repodir</i>)
<p>
        Public method to get the list of tags.
</p><dl>
<dt><i>repodir</i></dt>
<dd>
directory name of the repository (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of tags (list of string)
</dd>
</dl><a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a>
<h4>Hg.hgIdentify</h4>
<b>hgIdentify</b>(<i>name</i>)
<p>
        Public method to identify the current working directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgIdentifyBundle" ID="Hg.hgIdentifyBundle"></a>
<h4>Hg.hgIdentifyBundle</h4>
<b>hgIdentifyBundle</b>(<i>name</i>)
<p>
        Public method used to identify a changegroup file.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name on which to base the changegroup (string)
</dd>
</dl><a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a>
<h4>Hg.hgIncoming</h4>
<b>hgIncoming</b>(<i>name</i>)
<p>
        Public method used to view the log of incoming changes from the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to show the log of (string)
</dd>
</dl><a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a>
<h4>Hg.hgInfo</h4>
<b>hgInfo</b>(<i>ppath, mode="heads"</i>)
<p>
        Public method to show information about the heads of the repository.
</p><dl>
<dt><i>ppath</i></dt>
<dd>
local path to get the repository infos (string)
</dd><dt><i>mode=</i></dt>
<dd>
mode of the operation (string, one of heads, parents, tip)
</dd>
</dl><a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a>
<h4>Hg.hgListTagBranch</h4>
<b>hgListTagBranch</b>(<i>path, tags=True</i>)
<p>
        Public method used to list the available tags or branches.
</p><dl>
<dt><i>path</i></dt>
<dd>
directory name of the project (string)
</dd><dt><i>tags</i></dt>
<dd>
flag indicating listing of branches or tags
                (False = branches, True = tags)
</dd>
</dl><a NAME="Hg.hgLogBrowser" ID="Hg.hgLogBrowser"></a>
<h4>Hg.hgLogBrowser</h4>
<b>hgLogBrowser</b>(<i>path</i>)
<p>
        Public method used to browse the log of a file/directory from the
        Mercurial repository.
</p><dl>
<dt><i>path</i></dt>
<dd>
file/directory name to show the log of (string)
</dd>
</dl><a NAME="Hg.hgLogLimited" ID="Hg.hgLogLimited"></a>
<h4>Hg.hgLogLimited</h4>
<b>hgLogLimited</b>(<i>name</i>)
<p>
        Public method used to view the (limited) log of a file/directory from the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to show the log of (string)
</dd>
</dl><a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a>
<h4>Hg.hgNormalizeURL</h4>
<b>hgNormalizeURL</b>(<i>url</i>)
<p>
        Public method to normalize a url for Mercurial.
</p><dl>
<dt><i>url</i></dt>
<dd>
url string (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
properly normalized url for subversion (string)
</dd>
</dl><a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a>
<h4>Hg.hgOutgoing</h4>
<b>hgOutgoing</b>(<i>name</i>)
<p>
        Public method used to view the log of outgoing changes from the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to show the log of (string)
</dd>
</dl><a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a>
<h4>Hg.hgPreviewBundle</h4>
<b>hgPreviewBundle</b>(<i>name</i>)
<p>
        Public method used to view the log of incoming changes from a
        changegroup file.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name on which to base the changegroup (string)
</dd>
</dl><a NAME="Hg.hgPull" ID="Hg.hgPull"></a>
<h4>Hg.hgPull</h4>
<b>hgPull</b>(<i>name</i>)
<p>
        Public method used to pull changes from a remote Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name of the project to be pulled to (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, that the update contained an add
            or delete (boolean)
</dd>
</dl><a NAME="Hg.hgPush" ID="Hg.hgPush"></a>
<h4>Hg.hgPush</h4>
<b>hgPush</b>(<i>name, force=False, newBranch=False</i>)
<p>
        Public method used to push changes to a remote Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name of the project to be pushed from (string)
</dd><dt><i>force=</i></dt>
<dd>
flag indicating a forced push (boolean)
</dd><dt><i>newBranch=</i></dt>
<dd>
flag indicating to push a new branch (boolean)
</dd>
</dl><a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a>
<h4>Hg.hgRecover</h4>
<b>hgRecover</b>(<i>name</i>)
<p>
        Public method to recover an interrupted transaction.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgResolve" ID="Hg.hgResolve"></a>
<h4>Hg.hgResolve</h4>
<b>hgResolve</b>(<i>name</i>)
<p>
        Public method used to resolve conflicts of a file/directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be resolved (string)
</dd>
</dl><a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a>
<h4>Hg.hgRollback</h4>
<b>hgRollback</b>(<i>name</i>)
<p>
        Public method used to rollback the last transaction.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name (string or list of strings)
</dd>
</dl><a NAME="Hg.hgServe" ID="Hg.hgServe"></a>
<h4>Hg.hgServe</h4>
<b>hgServe</b>(<i>name</i>)
<p>
        Public method used to serve the project.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name (string)
</dd>
</dl><a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a>
<h4>Hg.hgShowBranch</h4>
<b>hgShowBranch</b>(<i>name</i>)
<p>
        Public method used to show the current branch the working directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a>
<h4>Hg.hgShowConfig</h4>
<b>hgShowConfig</b>(<i>name</i>)
<p>
        Public method to show the combined configuration.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a>
<h4>Hg.hgShowPaths</h4>
<b>hgShowPaths</b>(<i>name</i>)
<p>
        Public method to show the path aliases for remote repositories.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a>
<h4>Hg.hgUnbundle</h4>
<b>hgUnbundle</b>(<i>name</i>)
<p>
        Public method to apply changegroup files.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name (string)
</dd>
</dl><a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a>
<h4>Hg.hgVerify</h4>
<b>hgVerify</b>(<i>name</i>)
<p>
        Public method to verify the integrity of the repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a>
<h4>Hg.isExtensionActive</h4>
<b>isExtensionActive</b>(<i>extensionName</i>)
<p>
        Public method to check, if an extension is active.
</p><dl>
<dt><i>extensionName</i></dt>
<dd>
name of the extension to check for (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating an active extension (boolean)
</dd>
</dl><a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a>
<h4>Hg.vcsAdd</h4>
<b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
<p>
        Public method used to add a file/directory to the Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be added (string)
</dd><dt><i>isDir</i></dt>
<dd>
flag indicating name is a directory (boolean)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd>
</dl><a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a>
<h4>Hg.vcsAddBinary</h4>
<b>vcsAddBinary</b>(<i>name, isDir=False</i>)
<p>
        Public method used to add a file/directory in binary mode to the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be added (string)
</dd><dt><i>isDir</i></dt>
<dd>
flag indicating name is a directory (boolean)
</dd>
</dl><a NAME="Hg.vcsAddTree" ID="Hg.vcsAddTree"></a>
<h4>Hg.vcsAddTree</h4>
<b>vcsAddTree</b>(<i>path</i>)
<p>
        Public method to add a directory tree rooted at path to the Mercurial repository.
</p><dl>
<dt><i>path</i></dt>
<dd>
root directory of the tree to be added (string or list of strings))
</dd>
</dl><a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a>
<h4>Hg.vcsAllRegisteredStates</h4>
<b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
<p>
        Public method used to get the registered states of a number of files in the vcs.
</p><p>
        <b>Note:</b> If a shortcut is to be taken, the code will only check, if the named
        directory has been scanned already. If so, it is assumed, that the states for
        all files have been populated by the previous run.
</p><dl>
<dt><i>names</i></dt>
<dd>
dictionary with all filenames to be checked as keys
</dd><dt><i>dname</i></dt>
<dd>
directory to check in (string)
</dd><dt><i>shortcut</i></dt>
<dd>
flag indicating a shortcut should be taken (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the received dictionary completed with a combination of
            canBeCommited and canBeAdded or None in order to signal an error
</dd>
</dl><a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a>
<h4>Hg.vcsCheckout</h4>
<b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
<p>
        Public method used to check the project out of a Mercurial repository (clone).
</p><dl>
<dt><i>vcsDataDict</i></dt>
<dd>
dictionary of data required for the checkout
</dd><dt><i>projectDir</i></dt>
<dd>
project directory to create (string)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating an execution without errors (boolean)
</dd>
</dl><a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a>
<h4>Hg.vcsCleanup</h4>
<b>vcsCleanup</b>(<i>name</i>)
<p>
        Public method used to cleanup the working directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name to be cleaned up (string)
</dd>
</dl><a NAME="Hg.vcsCommandLine" ID="Hg.vcsCommandLine"></a>
<h4>Hg.vcsCommandLine</h4>
<b>vcsCommandLine</b>(<i>name</i>)
<p>
        Public method used to execute arbitrary mercurial commands.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name of the working directory (string)
</dd>
</dl><a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a>
<h4>Hg.vcsCommit</h4>
<b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False</i>)
<p>
        Public method used to make the change of a file/directory permanent in the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be committed (string or list of strings)
</dd><dt><i>message</i></dt>
<dd>
message for this operation (string)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd><dt><i>closeBranch=</i></dt>
<dd>
flag indicating a close branch commit (boolean)
</dd>
</dl><a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a>
<h4>Hg.vcsConvertProject</h4>
<b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
<p>
        Public method to convert an uncontrolled project to a version controlled project.
</p><dl>
<dt><i>vcsDataDict</i></dt>
<dd>
dictionary of data required for the conversion
</dd><dt><i>project</i></dt>
<dd>
reference to the project object
</dd>
</dl><a NAME="Hg.vcsDiff" ID="Hg.vcsDiff"></a>
<h4>Hg.vcsDiff</h4>
<b>vcsDiff</b>(<i>name</i>)
<p>
        Public method used to view the difference of a file/directory to the
        Mercurial repository.
</p><p>
        If name is a directory and is the project directory, all project files
        are saved first. If name is a file (or list of files), which is/are being edited
        and has unsaved modification, they can be saved or the operation may be aborted.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be diffed (string)
</dd>
</dl><a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a>
<h4>Hg.vcsExists</h4>
<b>vcsExists</b>(<i></i>)
<p>
        Public method used to test for the presence of the hg executable.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating the existance (boolean) and an error message (string)
</dd>
</dl><a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a>
<h4>Hg.vcsExport</h4>
<b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
<p>
        Public method used to export a directory from the Subversion repository.
</p><dl>
<dt><i>vcsDataDict</i></dt>
<dd>
dictionary of data required for the checkout
</dd><dt><i>projectDir</i></dt>
<dd>
project directory to create (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating an execution without errors (boolean)
</dd>
</dl><a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a>
<h4>Hg.vcsGetProjectBrowserHelper</h4>
<b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
<p>
        Public method to instantiate a helper object for the different project browsers.
</p><dl>
<dt><i>browser</i></dt>
<dd>
reference to the project browser object
</dd><dt><i>project</i></dt>
<dd>
reference to the project object
</dd><dt><i>isTranslationsBrowser</i></dt>
<dd>
flag indicating, the helper is requested for the
            translations browser (this needs some special treatment)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the project browser helper object
</dd>
</dl><a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a>
<h4>Hg.vcsGetProjectHelper</h4>
<b>vcsGetProjectHelper</b>(<i>project</i>)
<p>
        Public method to instantiate a helper object for the project.
</p><dl>
<dt><i>project</i></dt>
<dd>
reference to the project object
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the project helper object
</dd>
</dl><a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a>
<h4>Hg.vcsImport</h4>
<b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
<p>
        Public method used to import the project into the Subversion repository.
</p><dl>
<dt><i>vcsDataDict</i></dt>
<dd>
dictionary of data required for the import
</dd><dt><i>projectDir</i></dt>
<dd>
project directory (string)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating an execution without errors (boolean)
            and a flag indicating the version controll status (boolean)
</dd>
</dl><a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a>
<h4>Hg.vcsInit</h4>
<b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
<p>
        Public method used to initialize the mercurial repository.
</p><p>
        The initialization is done, when a project is converted into a Mercurial
        controlled project. Therefore we always return TRUE without doing anything.
</p><dl>
<dt><i>vcsDir</i></dt>
<dd>
name of the VCS directory (string)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
always TRUE
</dd>
</dl><a NAME="Hg.vcsLog" ID="Hg.vcsLog"></a>
<h4>Hg.vcsLog</h4>
<b>vcsLog</b>(<i>name</i>)
<p>
        Public method used to view the log of a file/directory from the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to show the log of (string)
</dd>
</dl><a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a>
<h4>Hg.vcsMerge</h4>
<b>vcsMerge</b>(<i>name</i>)
<p>
        Public method used to merge a URL/revision into the local project.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be merged (string)
</dd>
</dl><a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a>
<h4>Hg.vcsMove</h4>
<b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
<p>
        Public method used to move a file/directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be moved (string)
</dd><dt><i>project</i></dt>
<dd>
reference to the project object
</dd><dt><i>target</i></dt>
<dd>
new name of the file/directory (string)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating successfull operation (boolean)
</dd>
</dl><a NAME="Hg.vcsName" ID="Hg.vcsName"></a>
<h4>Hg.vcsName</h4>
<b>vcsName</b>(<i></i>)
<p>
        Public method returning the name of the vcs.
</p><dl>
<dt>Returns:</dt>
<dd>
always 'Mercurial' (string)
</dd>
</dl><a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a>
<h4>Hg.vcsNewProjectOptionsDialog</h4>
<b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
<p>
        Public method to get a dialog to enter repository info for getting a new project.
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent widget (QWidget)
</dd>
</dl><a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a>
<h4>Hg.vcsOptionsDialog</h4>
<b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
<p>
        Public method to get a dialog to enter repository info.
</p><dl>
<dt><i>project</i></dt>
<dd>
reference to the project object
</dd><dt><i>archive</i></dt>
<dd>
name of the project in the repository (string)
</dd><dt><i>editable</i></dt>
<dd>
flag indicating that the project name is editable (boolean)
</dd><dt><i>parent</i></dt>
<dd>
parent widget (QWidget)
</dd>
</dl><a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a>
<h4>Hg.vcsRegisteredState</h4>
<b>vcsRegisteredState</b>(<i>name</i>)
<p>
        Public method used to get the registered state of a file in the vcs.
</p><dl>
<dt><i>name</i></dt>
<dd>
filename to check (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
a combination of canBeCommited and canBeAdded
</dd>
</dl><a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a>
<h4>Hg.vcsRemove</h4>
<b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
<p>
        Public method used to remove a file/directory from the Mercurial repository.
</p><p>
        The default operation is to remove the local copy as well.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be removed (string or list of strings))
</dd><dt><i>project</i></dt>
<dd>
flag indicating deletion of a project tree (boolean) (not needed)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating successfull operation (boolean)
</dd>
</dl><a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
<h4>Hg.vcsRepositoryInfos</h4>
<b>vcsRepositoryInfos</b>(<i>ppath</i>)
<p>
        Public method to retrieve information about the repository.
</p><dl>
<dt><i>ppath</i></dt>
<dd>
local path to get the repository infos (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
string with ready formated info for display (string)
</dd>
</dl><a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a>
<h4>Hg.vcsRevert</h4>
<b>vcsRevert</b>(<i>name</i>)
<p>
        Public method used to revert changes made to a file/directory.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be reverted (string)
</dd>
</dl><a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a>
<h4>Hg.vcsShutdown</h4>
<b>vcsShutdown</b>(<i></i>)
<p>
        Public method used to shutdown the Mercurial interface.
</p><a NAME="Hg.vcsStatus" ID="Hg.vcsStatus"></a>
<h4>Hg.vcsStatus</h4>
<b>vcsStatus</b>(<i>name</i>)
<p>
        Public method used to view the status of files/directories in the
        Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name(s) to show the status of
            (string or list of strings)
</dd>
</dl><a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a>
<h4>Hg.vcsSwitch</h4>
<b>vcsSwitch</b>(<i>name</i>)
<p>
        Public method used to switch a working directory to a different revision.
</p><dl>
<dt><i>name</i></dt>
<dd>
directory name to be switched (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, that the switch contained an add
            or delete (boolean)
</dd>
</dl><a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
<h4>Hg.vcsTag</h4>
<b>vcsTag</b>(<i>name</i>)
<p>
        Public method used to set the tag in the Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be tagged (string)
</dd>
</dl><a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
<h4>Hg.vcsUpdate</h4>
<b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>)
<p>
        Public method used to update a file/directory with the Mercurial repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name to be updated (string or list of strings)
</dd><dt><i>noDialog</i></dt>
<dd>
flag indicating quiet operations (boolean)
</dd><dt><i>revision=</i></dt>
<dd>
revision to update to (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, that the update contained an add
            or delete (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>