--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html Mon Apr 12 18:00:42 2010 +0000
@@ -0,0 +1,295 @@
+<?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.ProjectBrowserHelper</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper</h1>
+<p>
+Module implementing the VCS project browser helper for Mercurial.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HgProjectBrowserHelper">HgProjectBrowserHelper</a></td>
+<td>Class implementing the VCS project browser helper for Mercurial.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HgProjectBrowserHelper" ID="HgProjectBrowserHelper"></a>
+<h2>HgProjectBrowserHelper</h2>
+<p>
+ Class implementing the VCS project browser helper for Mercurial.
+</p>
+<h3>Derived from</h3>
+VcsProjectBrowserHelper
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#HgProjectBrowserHelper.__init__">HgProjectBrowserHelper</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgAnnotate">__HgAnnotate</a></td>
+<td>Private slot called by the context menu to show the annotations of a file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgCopy">__HgCopy</a></td>
+<td>Private slot called by the context menu to copy the selected file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgExtendedDiff">__HgExtendedDiff</a></td>
+<td>Private slot called by the context menu to show the difference of a file to the repository.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgLogBrowser">__HgLogBrowser</a></td>
+<td>Private slot called by the context menu to show the log browser for a file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgLogLimited">__HgLogLimited</a></td>
+<td>Private slot called by the context menu to show the limited log of a file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgMove">__HgMove</a></td>
+<td>Private slot called by the context menu to move the selected file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.__HgResolve">__HgResolve</a></td>
+<td>Private slot called by the context menu to resolve conflicts of a file.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
+<td>Protected method used to add the VCS menu to all project browsers.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td>
+<td>Protected method used to add the VCS menu to all project browsers.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td>
+<td>Protected method used to add the VCS menu to all project browsers.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td>
+<td>Protected method used to add the VCS menu to all project browsers.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td>
+<td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
+<td>Slot called before the context menu is shown.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
+<td>Slot called before the context menu is shown.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
+<td>Slot called before the context menu is shown.</td>
+</tr><tr>
+<td><a href="#HgProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
+<td>Slot called before the context menu (multiple selections) is shown.</td>
+</tr>
+</table>
+<a NAME="HgProjectBrowserHelper.__init__" ID="HgProjectBrowserHelper.__init__"></a>
+<h4>HgProjectBrowserHelper (Constructor)</h4>
+<b>HgProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent = None, name = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>vcsObject</i></dt>
+<dd>
+reference to the vcs object
+</dd><dt><i>browserObject</i></dt>
+<dd>
+reference to the project browser object
+</dd><dt><i>projectObject</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><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="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a>
+<h4>HgProjectBrowserHelper.__HgAnnotate</h4>
+<b>__HgAnnotate</b>(<i></i>)
+<p>
+ Private slot called by the context menu to show the annotations of a file.
+</p><a NAME="HgProjectBrowserHelper.__HgCopy" ID="HgProjectBrowserHelper.__HgCopy"></a>
+<h4>HgProjectBrowserHelper.__HgCopy</h4>
+<b>__HgCopy</b>(<i></i>)
+<p>
+ Private slot called by the context menu to copy the selected file.
+</p><a NAME="HgProjectBrowserHelper.__HgExtendedDiff" ID="HgProjectBrowserHelper.__HgExtendedDiff"></a>
+<h4>HgProjectBrowserHelper.__HgExtendedDiff</h4>
+<b>__HgExtendedDiff</b>(<i></i>)
+<p>
+ Private slot called by the context menu to show the difference of a file to
+ the repository.
+</p><p>
+ This gives the chance to enter the revisions to compare.
+</p><a NAME="HgProjectBrowserHelper.__HgLogBrowser" ID="HgProjectBrowserHelper.__HgLogBrowser"></a>
+<h4>HgProjectBrowserHelper.__HgLogBrowser</h4>
+<b>__HgLogBrowser</b>(<i></i>)
+<p>
+ Private slot called by the context menu to show the log browser for a file.
+</p><a NAME="HgProjectBrowserHelper.__HgLogLimited" ID="HgProjectBrowserHelper.__HgLogLimited"></a>
+<h4>HgProjectBrowserHelper.__HgLogLimited</h4>
+<b>__HgLogLimited</b>(<i></i>)
+<p>
+ Private slot called by the context menu to show the limited log of a file.
+</p><a NAME="HgProjectBrowserHelper.__HgMove" ID="HgProjectBrowserHelper.__HgMove"></a>
+<h4>HgProjectBrowserHelper.__HgMove</h4>
+<b>__HgMove</b>(<i></i>)
+<p>
+ Private slot called by the context menu to move the selected file.
+</p><a NAME="HgProjectBrowserHelper.__HgResolve" ID="HgProjectBrowserHelper.__HgResolve"></a>
+<h4>HgProjectBrowserHelper.__HgResolve</h4>
+<b>__HgResolve</b>(<i></i>)
+<p>
+ Private slot called by the context menu to resolve conflicts of a file.
+</p><a NAME="HgProjectBrowserHelper._addVCSMenu" ID="HgProjectBrowserHelper._addVCSMenu"></a>
+<h4>HgProjectBrowserHelper._addVCSMenu</h4>
+<b>_addVCSMenu</b>(<i>mainMenu</i>)
+<p>
+ Protected method used to add the VCS menu to all project browsers.
+</p><dl>
+<dt><i>mainMenu</i></dt>
+<dd>
+reference to the menu to be amended
+</dd>
+</dl><a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a>
+<h4>HgProjectBrowserHelper._addVCSMenuBack</h4>
+<b>_addVCSMenuBack</b>(<i>mainMenu</i>)
+<p>
+ Protected method used to add the VCS menu to all project browsers.
+</p><dl>
+<dt><i>mainMenu</i></dt>
+<dd>
+reference to the menu to be amended
+</dd>
+</dl><a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a>
+<h4>HgProjectBrowserHelper._addVCSMenuDir</h4>
+<b>_addVCSMenuDir</b>(<i>mainMenu</i>)
+<p>
+ Protected method used to add the VCS menu to all project browsers.
+</p><dl>
+<dt><i>mainMenu</i></dt>
+<dd>
+reference to the menu to be amended
+</dd>
+</dl><a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a>
+<h4>HgProjectBrowserHelper._addVCSMenuDirMulti</h4>
+<b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
+<p>
+ Protected method used to add the VCS menu to all project browsers.
+</p><dl>
+<dt><i>mainMenu</i></dt>
+<dd>
+reference to the menu to be amended
+</dd>
+</dl><a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a>
+<h4>HgProjectBrowserHelper._addVCSMenuMulti</h4>
+<b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
+<p>
+ Protected method used to add the VCS menu for multi selection to all
+ project browsers.
+</p><dl>
+<dt><i>mainMenu</i></dt>
+<dd>
+reference to the menu to be amended
+</dd>
+</dl><a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a>
+<h4>HgProjectBrowserHelper.showContextMenu</h4>
+<b>showContextMenu</b>(<i>menu, standardItems</i>)
+<p>
+ Slot called before the context menu is shown.
+</p><p>
+ It enables/disables the VCS menu entries depending on the overall
+ VCS status and the file status.
+</p><dl>
+<dt><i>menu</i></dt>
+<dd>
+reference to the menu to be shown
+</dd><dt><i>standardItems</i></dt>
+<dd>
+array of standard items that need activation/deactivation
+ depending on the overall VCS status
+</dd>
+</dl><a NAME="HgProjectBrowserHelper.showContextMenuDir" ID="HgProjectBrowserHelper.showContextMenuDir"></a>
+<h4>HgProjectBrowserHelper.showContextMenuDir</h4>
+<b>showContextMenuDir</b>(<i>menu, standardItems</i>)
+<p>
+ Slot called before the context menu is shown.
+</p><p>
+ It enables/disables the VCS menu entries depending on the overall
+ VCS status and the directory status.
+</p><dl>
+<dt><i>menu</i></dt>
+<dd>
+reference to the menu to be shown
+</dd><dt><i>standardItems</i></dt>
+<dd>
+array of standard items that need activation/deactivation
+ depending on the overall VCS status
+</dd>
+</dl><a NAME="HgProjectBrowserHelper.showContextMenuDirMulti" ID="HgProjectBrowserHelper.showContextMenuDirMulti"></a>
+<h4>HgProjectBrowserHelper.showContextMenuDirMulti</h4>
+<b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
+<p>
+ Slot called before the context menu is shown.
+</p><p>
+ It enables/disables the VCS menu entries depending on the overall
+ VCS status and the directory status.
+</p><dl>
+<dt><i>menu</i></dt>
+<dd>
+reference to the menu to be shown
+</dd><dt><i>standardItems</i></dt>
+<dd>
+array of standard items that need activation/deactivation
+ depending on the overall VCS status
+</dd>
+</dl><a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a>
+<h4>HgProjectBrowserHelper.showContextMenuMulti</h4>
+<b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
+<p>
+ Slot called before the context menu (multiple selections) is shown.
+</p><p>
+ It enables/disables the VCS menu entries depending on the overall
+ VCS status and the files status.
+</p><dl>
+<dt><i>menu</i></dt>
+<dd>
+reference to the menu to be shown
+</dd><dt><i>standardItems</i></dt>
+<dd>
+array of standard items that need activation/deactivation
+ depending on the overall VCS status
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
