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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesFoldDialog</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.HgQueuesFoldDialog</h1>

<p>
Module implementing a dialog to enter data to fold patches.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#HgQueuesFoldDialog">HgQueuesFoldDialog</a></td>
<td>Class implementing a dialog to enter data to fold patches.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="HgQueuesFoldDialog" ID="HgQueuesFoldDialog"></a>
<h2>HgQueuesFoldDialog</h2>

<p>
    Class implementing a dialog to enter data to fold patches.
</p>
<h3>Derived from</h3>
QDialog, Ui_HgQueuesFoldDialog
<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="#HgQueuesFoldDialog.__init__">HgQueuesFoldDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private slot to update the status of the OK button.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.getData">getData</a></td>
<td>Public method to retrieve the entered data.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a patch to the list of selected patches.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_downButton_clicked">on_downButton_clicked</a></td>
<td>Private slot to move a patch down in the list.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
<td>Private slot to remove a patch from the list of selected patches.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_selectedPatches_currentItemChanged">on_selectedPatches_currentItemChanged</a></td>
<td>Private slot to react on changes of the current item of selected patches.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_sourcePatches_currentItemChanged">on_sourcePatches_currentItemChanged</a></td>
<td>Private slot to react on changes of the current item of source patches.</td>
</tr>
<tr>
<td><a href="#HgQueuesFoldDialog.on_upButton_clicked">on_upButton_clicked</a></td>
<td>Private slot to move a patch up in the list.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="HgQueuesFoldDialog.__init__" ID="HgQueuesFoldDialog.__init__"></a>
<h4>HgQueuesFoldDialog (Constructor)</h4>
<b>HgQueuesFoldDialog</b>(<i>patchesList, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>patchesList</i></dt>
<dd>
list of patches to select from (list of strings)
</dd>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<a NAME="HgQueuesFoldDialog.__updateOkButton" ID="HgQueuesFoldDialog.__updateOkButton"></a>
<h4>HgQueuesFoldDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)

<p>
        Private slot to update the status of the OK button.
</p>
<a NAME="HgQueuesFoldDialog.getData" ID="HgQueuesFoldDialog.getData"></a>
<h4>HgQueuesFoldDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to retrieve the entered data.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple of commit message and list of selected patches
            (string, list of strings)
</dd>
</dl>
<a NAME="HgQueuesFoldDialog.on_addButton_clicked" ID="HgQueuesFoldDialog.on_addButton_clicked"></a>
<h4>HgQueuesFoldDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)

<p>
        Private slot to add a patch to the list of selected patches.
</p>
<a NAME="HgQueuesFoldDialog.on_downButton_clicked" ID="HgQueuesFoldDialog.on_downButton_clicked"></a>
<h4>HgQueuesFoldDialog.on_downButton_clicked</h4>
<b>on_downButton_clicked</b>(<i></i>)

<p>
        Private slot to move a patch down in the list.
</p>
<a NAME="HgQueuesFoldDialog.on_removeButton_clicked" ID="HgQueuesFoldDialog.on_removeButton_clicked"></a>
<h4>HgQueuesFoldDialog.on_removeButton_clicked</h4>
<b>on_removeButton_clicked</b>(<i></i>)

<p>
        Private slot to remove a patch from the list of selected patches.
</p>
<a NAME="HgQueuesFoldDialog.on_selectedPatches_currentItemChanged" ID="HgQueuesFoldDialog.on_selectedPatches_currentItemChanged"></a>
<h4>HgQueuesFoldDialog.on_selectedPatches_currentItemChanged</h4>
<b>on_selectedPatches_currentItemChanged</b>(<i>current, previous</i>)

<p>
        Private slot to react on changes of the current item of selected
        patches.
</p>
<dl>

<dt><i>current</i></dt>
<dd>
reference to the new current item (QTreeWidgetItem)
</dd>
<dt><i>previous</i></dt>
<dd>
reference to the previous current item
            (QTreeWidgetItem)
</dd>
</dl>
<a NAME="HgQueuesFoldDialog.on_sourcePatches_currentItemChanged" ID="HgQueuesFoldDialog.on_sourcePatches_currentItemChanged"></a>
<h4>HgQueuesFoldDialog.on_sourcePatches_currentItemChanged</h4>
<b>on_sourcePatches_currentItemChanged</b>(<i>current, previous</i>)

<p>
        Private slot to react on changes of the current item of source patches.
</p>
<dl>

<dt><i>current</i></dt>
<dd>
reference to the new current item (QTreeWidgetItem)
</dd>
<dt><i>previous</i></dt>
<dd>
reference to the previous current item
            (QTreeWidgetItem)
</dd>
</dl>
<a NAME="HgQueuesFoldDialog.on_upButton_clicked" ID="HgQueuesFoldDialog.on_upButton_clicked"></a>
<h4>HgQueuesFoldDialog.on_upButton_clicked</h4>
<b>on_upButton_clicked</b>(<i></i>)

<p>
        Private slot to move a patch up in the list.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>