src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.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>
<tr>
<td><a href="#HgQueuesQueueManagementDialogMode">HgQueuesQueueManagementDialogMode</a></td>
<td>Class defining the supported dialog modes.</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>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</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>Private 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>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HgQueuesQueueManagementDialog.__init__" ID="HgQueuesQueueManagementDialog.__init__"></a>
<h4>HgQueuesQueueManagementDialog (Constructor)</h4>
<b>HgQueuesQueueManagementDialog</b>(<i>mode, title, suppressActive, vcs, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>mode</i> (HgQueuesQueueManagementDialogMode)</dt>
<dd>
mode of the dialog
</dd>
<dt><i>title</i> (str)</dt>
<dd>
title for the dialog
</dd>
<dt><i>suppressActive</i> (bool)</dt>
<dd>
flag indicating to not show the name of the
            active queue
</dd>
<dt><i>vcs</i> (Hg)</dt>
<dd>
reference to the vcs object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<dl>

<dt>Raises <b>ValueError</b>:</dt>
<dd>
raised to indicate an invalid dialog mode
</dd>
</dl>
<a NAME="HgQueuesQueueManagementDialog.__getQueuesList" ID="HgQueuesQueueManagementDialog.__getQueuesList"></a>
<h4>HgQueuesQueueManagementDialog.__getQueuesList</h4>
<b>__getQueuesList</b>(<i></i>)
<p>
        Private method to get a list of all queues and the name of the active
        queue.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple with a list of all queues and the name of the active queue
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (list of str, str)
</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>Return:</dt>
<dd>
queue name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</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> (QAbstractButton)</dt>
<dd>
button that was clicked
</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>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the edit
</dd>
</dl>
<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 />
<hr />
<a NAME="HgQueuesQueueManagementDialogMode" ID="HgQueuesQueueManagementDialogMode"></a>
<h2>HgQueuesQueueManagementDialogMode</h2>
<p>
    Class defining the supported dialog modes.
</p>

<h3>Derived from</h3>
enum.Enum
<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>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>