Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html

changeset 1053
c54aa980ea8e
child 1228
7afaf2fca55b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html	Sun May 22 16:21:32 2011 +0200
@@ -0,0 +1,153 @@
+<?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.HgQueuesQueueManagementDialog</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.HgQueuesQueueManagementDialog</h1>
+<p>
+Module implementing a dialog used by the queue management functions.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HgQueuesQueueManagementDialog">HgQueuesQueueManagementDialog</a></td>
+<td>Class implementing a dialog used by the queue management functions.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HgQueuesQueueManagementDialog" ID="HgQueuesQueueManagementDialog"></a>
+<h2>HgQueuesQueueManagementDialog</h2>
+<p>
+    Class implementing a dialog used by the queue management functions.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_HgQueuesQueueManagementDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>NAME_INPUT</td></tr><tr><td>NO_INPUT</td></tr><tr><td>QUEUE_INPUT</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#HgQueuesQueueManagementDialog.__init__">HgQueuesQueueManagementDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.__getQueuesList">__getQueuesList</a></td>
+<td>Public method to get a list of all queues and the name of the active queue.</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.getData">getData</a></td>
+<td>Public slot to get the data.</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
+<td>Private slot to handle changes of the entered queue name.</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged">on_queuesList_itemSelectionChanged</a></td>
+<td>Private slot to handle changes of selected queue names.</td>
+</tr><tr>
+<td><a href="#HgQueuesQueueManagementDialog.refresh">refresh</a></td>
+<td>Public slot to refresh the list of queues.</td>
+</tr>
+</table>
+<a NAME="HgQueuesQueueManagementDialog.__init__" ID="HgQueuesQueueManagementDialog.__init__"></a>
+<h4>HgQueuesQueueManagementDialog (Constructor)</h4>
+<b>HgQueuesQueueManagementDialog</b>(<i>mode, title, suppressActive, repodir, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>mode</i></dt>
+<dd>
+mode of the dialog (HgQueuesQueueManagementDialog.NO_INPUT
+            HgQueuesQueueManagementDialog.NAME_INPUT,
+            HgQueuesQueueManagementDialog.QUEUE_INPUT)
+</dd><dt><i>title</i></dt>
+<dd>
+title for the dialog (string)
+</dd><dt><i>suppressActive</i></dt>
+<dd>
+flag indicating to not show the name of the active
+            queue (boolean)
+</dd><dt><i>repodir</i></dt>
+<dd>
+name of the repository directory (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="HgQueuesQueueManagementDialog.__getQueuesList" ID="HgQueuesQueueManagementDialog.__getQueuesList"></a>
+<h4>HgQueuesQueueManagementDialog.__getQueuesList</h4>
+<b>__getQueuesList</b>(<i></i>)
+<p>
+        Public method to get a list of all queues and the name of the active queue.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple with a list of all queues and the name of the active queue
+            (list of strings, string)
+</dd>
+</dl><a NAME="HgQueuesQueueManagementDialog.getData" ID="HgQueuesQueueManagementDialog.getData"></a>
+<h4>HgQueuesQueueManagementDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public slot to get the data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+queue name (string)
+</dd>
+</dl><a NAME="HgQueuesQueueManagementDialog.on_buttonBox_clicked" ID="HgQueuesQueueManagementDialog.on_buttonBox_clicked"></a>
+<h4>HgQueuesQueueManagementDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot called by a button of the button box clicked.
+</p><dl>
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl><a NAME="HgQueuesQueueManagementDialog.on_nameEdit_textChanged" ID="HgQueuesQueueManagementDialog.on_nameEdit_textChanged"></a>
+<h4>HgQueuesQueueManagementDialog.on_nameEdit_textChanged</h4>
+<b>on_nameEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle changes of the entered queue name.
+</p><a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a>
+<h4>HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged</h4>
+<b>on_queuesList_itemSelectionChanged</b>(<i></i>)
+<p>
+        Private slot to handle changes of selected queue names.
+</p><a NAME="HgQueuesQueueManagementDialog.refresh" ID="HgQueuesQueueManagementDialog.refresh"></a>
+<h4>HgQueuesQueueManagementDialog.refresh</h4>
+<b>refresh</b>(<i></i>)
+<p>
+        Public slot to refresh the list of queues.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial