--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,58 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1>
-
<p>
Module implementing the queues extension interface.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Queues">Queues</a></td>
<td>Class implementing the queues extension interface.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="Queues" ID="Queues"></a>
<h2>Queues</h2>
-
<p>
Class implementing the queues extension interface.
</p>
+
<h3>Derived from</h3>
HgExtension
<h3>Class Attributes</h3>
+<table>
+<tr><td>APPLIED_LIST</td></tr>
+<tr><td>GOTO</td></tr>
+<tr><td>POP</td></tr>
+<tr><td>PUSH</td></tr>
+<tr><td>QUEUE_ACTIVATE</td></tr>
+<tr><td>QUEUE_DELETE</td></tr>
+<tr><td>QUEUE_PURGE</td></tr>
+<tr><td>SERIES_LIST</td></tr>
+<tr><td>UNAPPLIED_LIST</td></tr>
+</table>
-<table>
-<tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#Queues.__init__">Queues</a></td>
<td>Constructor</td>
@@ -167,19 +172,20 @@
<td>Public method used to shutdown the queues interface.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Queues.__init__" ID="Queues.__init__"></a>
<h4>Queues (Constructor)</h4>
<b>Queues</b>(<i>vcs</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vcs</i> (Hg)</dt>
@@ -190,10 +196,10 @@
<a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
<h4>Queues.__getCommitMessage</h4>
<b>__getCommitMessage</b>(<i></i>)
-
<p>
Private method to get the commit message of the current patch.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -209,10 +215,10 @@
<a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
<h4>Queues.__getCurrentPatch</h4>
<b>__getCurrentPatch</b>(<i></i>)
-
<p>
Private method to get the name of the current patch.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -228,10 +234,10 @@
<a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
<h4>Queues.__getPatchesList</h4>
<b>__getPatchesList</b>(<i>listType, withSummary=False</i>)
-
<p>
Private method to get a list of patches of a given type.
</p>
+
<dl>
<dt><i>listType</i> (int)</dt>
@@ -266,10 +272,10 @@
<a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
<h4>Queues.getGuardsList</h4>
<b>getGuardsList</b>(<i>allGuards=True</i>)
-
<p>
Public method to get a list of all guards defined.
</p>
+
<dl>
<dt><i>allGuards</i> (bool)</dt>
@@ -292,10 +298,10 @@
<a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
<h4>Queues.hgQueueCreateRenameQueue</h4>
<b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>)
-
<p>
Public method to create a new queue or rename the active queue.
</p>
+
<dl>
<dt><i>isCreate</i> (bool)</dt>
@@ -306,18 +312,18 @@
<a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
<h4>Queues.hgQueueDeletePatch</h4>
<b>hgQueueDeletePatch</b>(<i></i>)
-
<p>
Public method to delete a selected unapplied patch.
</p>
+
<a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
<h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
<b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>)
-
<p>
Public method to delete the reference to a queue and optionally
remove the patch directory or set the active queue.
</p>
+
<dl>
<dt><i>operation</i> (int)</dt>
@@ -336,102 +342,102 @@
<a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
<h4>Queues.hgQueueFinishAppliedPatches</h4>
<b>hgQueueFinishAppliedPatches</b>(<i></i>)
-
<p>
Public method to finish all applied patches.
</p>
+
<a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
<h4>Queues.hgQueueFoldUnappliedPatches</h4>
<b>hgQueueFoldUnappliedPatches</b>(<i></i>)
-
<p>
Public method to fold patches into the current patch.
</p>
+
<a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
<h4>Queues.hgQueueGuardsDeactivate</h4>
<b>hgQueueGuardsDeactivate</b>(<i></i>)
-
<p>
Public method to deactivate all active guards.
</p>
+
<a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
<h4>Queues.hgQueueGuardsDefine</h4>
<b>hgQueueGuardsDefine</b>(<i></i>)
-
<p>
Public method to define guards for the current or a named patch.
</p>
+
<a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
<h4>Queues.hgQueueGuardsDropAll</h4>
<b>hgQueueGuardsDropAll</b>(<i></i>)
-
<p>
Public method to drop all guards of the current or a named patch.
</p>
+
<a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
<h4>Queues.hgQueueGuardsIdentifyActive</h4>
<b>hgQueueGuardsIdentifyActive</b>(<i></i>)
-
<p>
Public method to list all active guards.
</p>
+
<a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
<h4>Queues.hgQueueGuardsList</h4>
<b>hgQueueGuardsList</b>(<i></i>)
-
<p>
Public method to list the guards for the current or a named patch.
</p>
+
<a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
<h4>Queues.hgQueueGuardsListAll</h4>
<b>hgQueueGuardsListAll</b>(<i></i>)
-
<p>
Public method to list all guards of all patches.
</p>
+
<a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
<h4>Queues.hgQueueGuardsSetActive</h4>
<b>hgQueueGuardsSetActive</b>(<i></i>)
-
<p>
Public method to set the active guards.
</p>
+
<a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
<h4>Queues.hgQueueInit</h4>
<b>hgQueueInit</b>(<i></i>)
-
<p>
Public method to initialize a new queue repository.
</p>
+
<a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
<h4>Queues.hgQueueListPatches</h4>
<b>hgQueueListPatches</b>(<i></i>)
-
<p>
Public method to show a list of all patches.
</p>
+
<a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
<h4>Queues.hgQueueListQueues</h4>
<b>hgQueueListQueues</b>(<i></i>)
-
<p>
Public method to list available queues.
</p>
+
<a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
<h4>Queues.hgQueueNewPatch</h4>
<b>hgQueueNewPatch</b>(<i></i>)
-
<p>
Public method to create a new named patch.
</p>
+
<a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
<h4>Queues.hgQueuePushPopPatches</h4>
<b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>)
-
<p>
Public method to push patches onto the stack or pop patches off the
stack.
</p>
+
<dl>
<dt><i>operation</i> (int)</dt>
@@ -475,10 +481,10 @@
<a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
<h4>Queues.hgQueueRefreshPatch</h4>
<b>hgQueueRefreshPatch</b>(<i>editMessage=False</i>)
-
<p>
Public method to refresh the current patch.
</p>
+
<dl>
<dt><i>editMessage</i> (bool)</dt>
@@ -490,24 +496,24 @@
<a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
<h4>Queues.hgQueueRenamePatch</h4>
<b>hgQueueRenamePatch</b>(<i></i>)
-
<p>
Public method to rename the current or a selected patch.
</p>
+
<a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
<h4>Queues.hgQueueShowHeader</h4>
<b>hgQueueShowHeader</b>(<i></i>)
-
<p>
Public method to show the commit message of the current patch.
</p>
+
<a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
<h4>Queues.hgQueueShowPatch</h4>
<b>hgQueueShowPatch</b>(<i>name</i>)
-
<p>
Public method to show the contents of the current patch.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -518,10 +524,10 @@
<a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a>
<h4>Queues.hgQueueStatus</h4>
<b>hgQueueStatus</b>(<i>name</i>)
-
<p>
Public method used to view the status of a queue repository.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -532,10 +538,10 @@
<a NAME="Queues.shutdown" ID="Queues.shutdown"></a>
<h4>Queues.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method used to shutdown the queues interface.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
