diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,107 +18,140 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<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>NEW_MODE</td></tr><tr><td>REFRESH_MODE</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> +</tr> +<tr> <td><a href="#HgQueuesNewPatchDialog.__updateUI">__updateUI</a></td> <td>Private slot to update the UI.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesNewPatchDialog.getData">getData</a></td> <td>Public method to retrieve the entered data.</td> -</tr><tr> +</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> +</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> +</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> +</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> +</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> +</p> +<dl> + <dt><i>mode</i></dt> <dd> mode of the dialog (HgQueuesNewPatchDialog.NEW_MODE, HgQueuesNewPatchDialog.REFRESH_MODE) -</dd><dt><i>message</i></dt> +</dd> +<dt><i>message</i></dt> <dd> text to set as the commit message (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><dl> +</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> +</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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> tuple giving the patch name and message, a tuple giving a @@ -128,47 +161,65 @@ current date and the date (string, string, (boolean, boolean, string), (boolean, boolean, string)) </dd> -</dl><a NAME="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled" ID="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled"></a> +</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> +</p> +<dl> + <dt><i>checked</i></dt> <dd> flag giving the checked state (boolean) </dd> -</dl><a NAME="HgQueuesNewPatchDialog.on_messageEdit_textChanged" ID="HgQueuesNewPatchDialog.on_messageEdit_textChanged"></a> +</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> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="HgQueuesNewPatchDialog.on_userEdit_textChanged" ID="HgQueuesNewPatchDialog.on_userEdit_textChanged"></a> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="HgQueuesNewPatchDialog.on_userGroup_toggled" ID="HgQueuesNewPatchDialog.on_userGroup_toggled"></a> +</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> +</p> +<dl> + <dt><i>checked</i></dt> <dd> flag giving the checked state (boolean)