diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,125 +18,166 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog</h1> + <p> Module implementing a dialog to enter the data to rename a patch. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgQueuesRenamePatchDialog">HgQueuesRenamePatchDialog</a></td> <td>Class implementing a dialog to enter the data to rename a patch.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgQueuesRenamePatchDialog" ID="HgQueuesRenamePatchDialog"></a> <h2>HgQueuesRenamePatchDialog</h2> + <p> Class implementing a dialog to enter the data to rename a patch. </p> <h3>Derived from</h3> QDialog, Ui_HgQueuesRenamePatchDialog <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="#HgQueuesRenamePatchDialog.__init__">HgQueuesRenamePatchDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesRenamePatchDialog.__updateUI">__updateUI</a></td> <td>Private slot to update the UI.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesRenamePatchDialog.getData">getData</a></td> <td>Public method to retrieve the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged">on_nameCombo_currentIndexChanged</a></td> <td>Private slot to handle changes of the selected patch name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesRenamePatchDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> <td>Private slot to handle changes of the new name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesRenamePatchDialog.on_namedButton_toggled">on_namedButton_toggled</a></td> <td>Private slot to handle changes of the selection method.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HgQueuesRenamePatchDialog.__init__" ID="HgQueuesRenamePatchDialog.__init__"></a> <h4>HgQueuesRenamePatchDialog (Constructor)</h4> <b>HgQueuesRenamePatchDialog</b>(<i>currentPatch, patchesList, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>currentPatch</i></dt> <dd> name of the current patch (string) -</dd><dt><i>patchesList</i></dt> +</dd> +<dt><i>patchesList</i></dt> <dd> list of patches to select from (list of strings) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HgQueuesRenamePatchDialog.__updateUI" ID="HgQueuesRenamePatchDialog.__updateUI"></a> +</dl> +<a NAME="HgQueuesRenamePatchDialog.__updateUI" ID="HgQueuesRenamePatchDialog.__updateUI"></a> <h4>HgQueuesRenamePatchDialog.__updateUI</h4> <b>__updateUI</b>(<i></i>) + <p> Private slot to update the UI. -</p><a NAME="HgQueuesRenamePatchDialog.getData" ID="HgQueuesRenamePatchDialog.getData"></a> +</p> +<a NAME="HgQueuesRenamePatchDialog.getData" ID="HgQueuesRenamePatchDialog.getData"></a> <h4>HgQueuesRenamePatchDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to retrieve the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of new name and selected patch (string, string) </dd> -</dl><a NAME="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged" ID="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged"></a> +</dl> +<a NAME="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged" ID="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged"></a> <h4>HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged</h4> <b>on_nameCombo_currentIndexChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the selected patch name. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> selected patch name (string) </dd> -</dl><a NAME="HgQueuesRenamePatchDialog.on_nameEdit_textChanged" ID="HgQueuesRenamePatchDialog.on_nameEdit_textChanged"></a> +</dl> +<a NAME="HgQueuesRenamePatchDialog.on_nameEdit_textChanged" ID="HgQueuesRenamePatchDialog.on_nameEdit_textChanged"></a> <h4>HgQueuesRenamePatchDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the new name. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="HgQueuesRenamePatchDialog.on_namedButton_toggled" ID="HgQueuesRenamePatchDialog.on_namedButton_toggled"></a> +</dl> +<a NAME="HgQueuesRenamePatchDialog.on_namedButton_toggled" ID="HgQueuesRenamePatchDialog.on_namedButton_toggled"></a> <h4>HgQueuesRenamePatchDialog.on_namedButton_toggled</h4> <b>on_namedButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the selection method. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the check box (boolean)