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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog</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.HgQueuesNewPatchDialog</h1>
<p>
Module implementing a dialog to get the data for a new patch.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgQueuesNewPatchDialog">HgQueuesNewPatchDialog</a></td>
<td>Class implementing a dialog to get the data for a new patch.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialogMode">HgQueuesNewPatchDialogMode</a></td>
<td>Class defining the dialog modes.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgQueuesNewPatchDialog" ID="HgQueuesNewPatchDialog"></a>
<h2>HgQueuesNewPatchDialog</h2>
<p>
    Class implementing a dialog to get the data for a new patch.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgQueuesNewPatchDialog
<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="#HgQueuesNewPatchDialog.__init__">HgQueuesNewPatchDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.__updateUI">__updateUI</a></td>
<td>Private slot to update the UI.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.getData">getData</a></td>
<td>Public method to retrieve the entered data.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled">on_currentUserCheckBox_toggled</a></td>
<td>Private slot to handle changes of the currentuser state.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.on_messageEdit_textChanged">on_messageEdit_textChanged</a></td>
<td>Private slot to handle changes of the patch message.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
<td>Private slot to handle changes of the patch name.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.on_userEdit_textChanged">on_userEdit_textChanged</a></td>
<td>Private slot to handle changes of the user name.</td>
</tr>
<tr>
<td><a href="#HgQueuesNewPatchDialog.on_userGroup_toggled">on_userGroup_toggled</a></td>
<td>Private slot to handle changes of the user group state.</td>
</tr>
</table>

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


<a NAME="HgQueuesNewPatchDialog.__init__" ID="HgQueuesNewPatchDialog.__init__"></a>
<h4>HgQueuesNewPatchDialog (Constructor)</h4>
<b>HgQueuesNewPatchDialog</b>(<i>mode, message="", parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>mode</i> (HgQueuesNewPatchDialogMode)</dt>
<dd>
mode of the dialog
</dd>
<dt><i>message</i> (str)</dt>
<dd>
text to set as the commit message
</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="HgQueuesNewPatchDialog.__updateUI" ID="HgQueuesNewPatchDialog.__updateUI"></a>
<h4>HgQueuesNewPatchDialog.__updateUI</h4>
<b>__updateUI</b>(<i></i>)
<p>
        Private slot to update the UI.
</p>

<a NAME="HgQueuesNewPatchDialog.getData" ID="HgQueuesNewPatchDialog.getData"></a>
<h4>HgQueuesNewPatchDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple giving the patch name and message, a tuple giving a
            flag indicating to set the user, a flag indicating to use the
            current user and the user name and another tuple giving a flag
            indicating to set the date, a flag indicating to use the
            current date and the date
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, tuple of (bool, bool, str), tuple of
            (bool, bool, str))
</dd>
</dl>
<a NAME="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled" ID="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled"></a>
<h4>HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled</h4>
<b>on_currentUserCheckBox_toggled</b>(<i>_checked</i>)
<p>
        Private slot to handle changes of the currentuser state.
</p>

<dl>

<dt><i>_checked</i> (bool)</dt>
<dd>
flag giving the checked state (unused)
</dd>
</dl>
<a NAME="HgQueuesNewPatchDialog.on_messageEdit_textChanged" ID="HgQueuesNewPatchDialog.on_messageEdit_textChanged"></a>
<h4>HgQueuesNewPatchDialog.on_messageEdit_textChanged</h4>
<b>on_messageEdit_textChanged</b>(<i></i>)
<p>
        Private slot to handle changes of the patch message.
</p>

<a NAME="HgQueuesNewPatchDialog.on_nameEdit_textChanged" ID="HgQueuesNewPatchDialog.on_nameEdit_textChanged"></a>
<h4>HgQueuesNewPatchDialog.on_nameEdit_textChanged</h4>
<b>on_nameEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle changes of the patch name.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
text of the edit (unused)
</dd>
</dl>
<a NAME="HgQueuesNewPatchDialog.on_userEdit_textChanged" ID="HgQueuesNewPatchDialog.on_userEdit_textChanged"></a>
<h4>HgQueuesNewPatchDialog.on_userEdit_textChanged</h4>
<b>on_userEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle changes of the user name.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
text of the edit (unused)
</dd>
</dl>
<a NAME="HgQueuesNewPatchDialog.on_userGroup_toggled" ID="HgQueuesNewPatchDialog.on_userGroup_toggled"></a>
<h4>HgQueuesNewPatchDialog.on_userGroup_toggled</h4>
<b>on_userGroup_toggled</b>(<i>_checked</i>)
<p>
        Private slot to handle changes of the user group state.
</p>

<dl>

<dt><i>_checked</i> (bool)</dt>
<dd>
flag giving the checked state (unused)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="HgQueuesNewPatchDialogMode" ID="HgQueuesNewPatchDialogMode"></a>
<h2>HgQueuesNewPatchDialogMode</h2>
<p>
    Class defining the dialog modes.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>NEW</td></tr>
<tr><td>REFRESH</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>