diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,125 +18,165 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper</h1> + <p> Module implementing the purge extension project helper. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PurgeProjectHelper">PurgeProjectHelper</a></td> <td>Class implementing the purge extension project helper.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PurgeProjectHelper" ID="PurgeProjectHelper"></a> <h2>PurgeProjectHelper</h2> + <p> Class implementing the purge extension project helper. </p> <h3>Derived from</h3> HgExtensionProjectHelper <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="#PurgeProjectHelper.__init__">PurgeProjectHelper</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.__hgPurge">__hgPurge</a></td> <td>Private slot used to remove files not tracked by Mercurial.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.__hgPurgeAll">__hgPurgeAll</a></td> <td>Private slot used to remove all files not tracked by Mercurial.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.__hgPurgeAllList">__hgPurgeAllList</a></td> <td>Private slot used to list all files not tracked by Mercurial.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.__hgPurgeList">__hgPurgeList</a></td> <td>Private slot used to list files not tracked by Mercurial.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.initActions">initActions</a></td> <td>Public method to generate the action objects.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.initMenu">initMenu</a></td> <td>Public method to generate the extension menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PurgeProjectHelper.menuTitle">menuTitle</a></td> <td>Public method to get the menu title.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PurgeProjectHelper.__init__" ID="PurgeProjectHelper.__init__"></a> <h4>PurgeProjectHelper (Constructor)</h4> <b>PurgeProjectHelper</b>(<i></i>) + <p> Constructor -</p><a NAME="PurgeProjectHelper.__hgPurge" ID="PurgeProjectHelper.__hgPurge"></a> +</p> +<a NAME="PurgeProjectHelper.__hgPurge" ID="PurgeProjectHelper.__hgPurge"></a> <h4>PurgeProjectHelper.__hgPurge</h4> <b>__hgPurge</b>(<i></i>) + <p> Private slot used to remove files not tracked by Mercurial. -</p><a NAME="PurgeProjectHelper.__hgPurgeAll" ID="PurgeProjectHelper.__hgPurgeAll"></a> +</p> +<a NAME="PurgeProjectHelper.__hgPurgeAll" ID="PurgeProjectHelper.__hgPurgeAll"></a> <h4>PurgeProjectHelper.__hgPurgeAll</h4> <b>__hgPurgeAll</b>(<i></i>) + <p> Private slot used to remove all files not tracked by Mercurial. -</p><a NAME="PurgeProjectHelper.__hgPurgeAllList" ID="PurgeProjectHelper.__hgPurgeAllList"></a> +</p> +<a NAME="PurgeProjectHelper.__hgPurgeAllList" ID="PurgeProjectHelper.__hgPurgeAllList"></a> <h4>PurgeProjectHelper.__hgPurgeAllList</h4> <b>__hgPurgeAllList</b>(<i></i>) + <p> Private slot used to list all files not tracked by Mercurial. -</p><a NAME="PurgeProjectHelper.__hgPurgeList" ID="PurgeProjectHelper.__hgPurgeList"></a> +</p> +<a NAME="PurgeProjectHelper.__hgPurgeList" ID="PurgeProjectHelper.__hgPurgeList"></a> <h4>PurgeProjectHelper.__hgPurgeList</h4> <b>__hgPurgeList</b>(<i></i>) + <p> Private slot used to list files not tracked by Mercurial. -</p><a NAME="PurgeProjectHelper.initActions" ID="PurgeProjectHelper.initActions"></a> +</p> +<a NAME="PurgeProjectHelper.initActions" ID="PurgeProjectHelper.initActions"></a> <h4>PurgeProjectHelper.initActions</h4> <b>initActions</b>(<i></i>) + <p> Public method to generate the action objects. -</p><a NAME="PurgeProjectHelper.initMenu" ID="PurgeProjectHelper.initMenu"></a> +</p> +<a NAME="PurgeProjectHelper.initMenu" ID="PurgeProjectHelper.initMenu"></a> <h4>PurgeProjectHelper.initMenu</h4> <b>initMenu</b>(<i>mainMenu</i>) + <p> Public method to generate the extension menu. -</p><dl> +</p> +<dl> + <dt><i>mainMenu</i></dt> <dd> reference to the main menu (QMenu) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> populated menu (QMenu) </dd> -</dl><a NAME="PurgeProjectHelper.menuTitle" ID="PurgeProjectHelper.menuTitle"></a> +</dl> +<a NAME="PurgeProjectHelper.menuTitle" ID="PurgeProjectHelper.menuTitle"></a> <h4>PurgeProjectHelper.menuTitle</h4> <b>menuTitle</b>(<i></i>) + <p> Public method to get the menu title. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> title of the menu (string)