diff -r 1922b6ce2a57 -r b547147ccb4b Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Sun May 15 19:13:36 2011 +0200
@@ -0,0 +1,286 @@
+<?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.QueuesExtension.queues</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.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>
+QObject
+<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>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Queues.__init__">Queues</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Queues.__getCommitMessage">__getCommitMessage</a></td>
+<td>Public method to get the commit message of the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.__getCurrentPatch">__getCurrentPatch</a></td>
+<td>Public method to get the name of the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.__getPatchesList">__getPatchesList</a></td>
+<td>Public method to get a list of patches of a given type.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueDeletePatch">hgQueueDeletePatch</a></td>
+<td>Public method to delete a selected unapplied patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueFinishAppliedPatches">hgQueueFinishAppliedPatches</a></td>
+<td>Public method to finish all applied patches.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueFoldUnappliedPatches">hgQueueFoldUnappliedPatches</a></td>
+<td>Public method to fold patches into the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueListPatches">hgQueueListPatches</a></td>
+<td>Public method to show a list of all patches.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueNewPatch">hgQueueNewPatch</a></td>
+<td>Public method to create a new named patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueuePushPopPatches">hgQueuePushPopPatches</a></td>
+<td>Public method to push patches onto the stack or pop patches off the stack.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueRefreshPatch">hgQueueRefreshPatch</a></td>
+<td>Public method to refresh the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueRenamePatch">hgQueueRenamePatch</a></td>
+<td>Public method to rename the current or a selected patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueShowHeader">hgQueueShowHeader</a></td>
+<td>Public method to show the commit message of the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.hgQueueShowPatch">hgQueueShowPatch</a></td>
+<td>Public method to show the contents of the current patch.</td>
+</tr><tr>
+<td><a href="#Queues.shutdown">shutdown</a></td>
+<td>Public method used to shutdown the queues interface.</td>
+</tr>
+</table>
+<a NAME="Queues.__init__" ID="Queues.__init__"></a>
+<h4>Queues (Constructor)</h4>
+<b>Queues</b>(<i>vcs</i>)
+<p>
+ Constructor
+</p><a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
+<h4>Queues.__getCommitMessage</h4>
+<b>__getCommitMessage</b>(<i>repodir</i>)
+<p>
+ Public method to get the commit message of the current patch.
+</p><dl>
+<dt><i>repodir</i></dt>
+<dd>
+directory name of the repository (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+name of the current patch (string)
+</dd>
+</dl><a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
+<h4>Queues.__getCurrentPatch</h4>
+<b>__getCurrentPatch</b>(<i>repodir</i>)
+<p>
+ Public method to get the name of the current patch.
+</p><dl>
+<dt><i>repodir</i></dt>
+<dd>
+directory name of the repository (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+name of the current patch (string)
+</dd>
+</dl><a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
+<h4>Queues.__getPatchesList</h4>
+<b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>)
+<p>
+ Public method to get a list of patches of a given type.
+</p><dl>
+<dt><i>repodir</i></dt>
+<dd>
+directory name of the repository (string)
+</dd><dt><i>listType</i></dt>
+<dd>
+type of patches list to get
+ (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
+</dd><dt><i>withSummary</i></dt>
+<dd>
+flag indicating to get a summary as well (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of patches (list of string)
+</dd>
+</dl><a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
+<h4>Queues.hgQueueDeletePatch</h4>
+<b>hgQueueDeletePatch</b>(<i>name</i>)
+<p>
+ Public method to delete a selected unapplied patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
+<h4>Queues.hgQueueFinishAppliedPatches</h4>
+<b>hgQueueFinishAppliedPatches</b>(<i>name</i>)
+<p>
+ Public method to finish all applied patches.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
+<h4>Queues.hgQueueFoldUnappliedPatches</h4>
+<b>hgQueueFoldUnappliedPatches</b>(<i>name</i>)
+<p>
+ Public method to fold patches into the current patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
+<h4>Queues.hgQueueListPatches</h4>
+<b>hgQueueListPatches</b>(<i>name</i>)
+<p>
+ Public method to show a list of all patches.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
+<h4>Queues.hgQueueNewPatch</h4>
+<b>hgQueueNewPatch</b>(<i>name</i>)
+<p>
+ Public method to create a new named patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
+<h4>Queues.hgQueuePushPopPatches</h4>
+<b>hgQueuePushPopPatches</b>(<i>name, operation, all=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>name</i></dt>
+<dd>
+file/directory name (string)
+</dd><dt><i>operation</i></dt>
+<dd>
+operation type to be performed (Queues.POP,
+ Queues.PUSH, Queues.GOTO)
+</dd><dt><i>all=</i></dt>
+<dd>
+flag indicating to push/pop all (boolean)
+</dd><dt><i>named=</i></dt>
+<dd>
+flag indicating to push/pop until a named patch
+ is at the top of the stack (boolean)
+</dd><dt><i>force=</i></dt>
+<dd>
+flag indicating a forceful pop (boolean)
+</dd>
+</dl><a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
+<h4>Queues.hgQueueRefreshPatch</h4>
+<b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>)
+<p>
+ Public method to refresh the current patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd><dt><i>editMessage</i></dt>
+<dd>
+flag indicating to edit the current
+ commit message (boolean)
+</dd>
+</dl><a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
+<h4>Queues.hgQueueRenamePatch</h4>
+<b>hgQueueRenamePatch</b>(<i>name</i>)
+<p>
+ Public method to rename the current or a selected patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
+<h4>Queues.hgQueueShowHeader</h4>
+<b>hgQueueShowHeader</b>(<i>name</i>)
+<p>
+ Public method to show the commit message of the current patch.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><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></dt>
+<dd>
+file/directory name (string)
+</dd>
+</dl><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
