diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,98 +18,128 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog</h1> + <p> Module implementing a dialog to enter the data for a graft session. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgGraftDialog">HgGraftDialog</a></td> <td>Class implementing a dialog to enter the data for a graft session.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgGraftDialog" ID="HgGraftDialog"></a> <h2>HgGraftDialog</h2> + <p> Class implementing a dialog to enter the data for a graft session. </p> <h3>Derived from</h3> QDialog, Ui_HgGraftDialog <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="#HgGraftDialog.__init__">HgGraftDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgGraftDialog.__updateOk">__updateOk</a></td> <td>Private slot to update the state of the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgGraftDialog.getData">getData</a></td> <td>Public method to retrieve the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgGraftDialog.on_currentUserCheckBox_toggled">on_currentUserCheckBox_toggled</a></td> <td>Private slot to handle changes of the current user state.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgGraftDialog.on_revisionsEdit_textChanged">on_revisionsEdit_textChanged</a></td> <td>Private slot to react upon changes of revisions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgGraftDialog.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="#HgGraftDialog.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="HgGraftDialog.__init__" ID="HgGraftDialog.__init__"></a> <h4>HgGraftDialog (Constructor)</h4> <b>HgGraftDialog</b>(<i>vcs, revs=None, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i> (Hg)</dt> <dd> reference to the VCS object -</dd><dt><i>revs</i> (list of str)</dt> +</dd> +<dt><i>revs</i> (list of str)</dt> <dd> list of revisions to show in the revisions pane -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="HgGraftDialog.__updateOk" ID="HgGraftDialog.__updateOk"></a> +</dl> +<a NAME="HgGraftDialog.__updateOk" ID="HgGraftDialog.__updateOk"></a> <h4>HgGraftDialog.__updateOk</h4> <b>__updateOk</b>(<i></i>) + <p> Private slot to update the state of the OK button. -</p><a NAME="HgGraftDialog.getData" ID="HgGraftDialog.getData"></a> +</p> +<a NAME="HgGraftDialog.getData" ID="HgGraftDialog.getData"></a> <h4>HgGraftDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to retrieve the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple with list of revisions, a tuple giving a @@ -120,43 +150,58 @@ to the log message, a flag indicating a dry-run and a flag indicating to not commit the copied changesets </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (list of str, (bool, bool, str), (bool, bool, str), bool, bool, bool) </dd> -</dl><a NAME="HgGraftDialog.on_currentUserCheckBox_toggled" ID="HgGraftDialog.on_currentUserCheckBox_toggled"></a> +</dl> +<a NAME="HgGraftDialog.on_currentUserCheckBox_toggled" ID="HgGraftDialog.on_currentUserCheckBox_toggled"></a> <h4>HgGraftDialog.on_currentUserCheckBox_toggled</h4> <b>on_currentUserCheckBox_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the current user state. -</p><dl> +</p> +<dl> + <dt><i>checked</i> (bool)</dt> <dd> flag giving the checked state </dd> -</dl><a NAME="HgGraftDialog.on_revisionsEdit_textChanged" ID="HgGraftDialog.on_revisionsEdit_textChanged"></a> +</dl> +<a NAME="HgGraftDialog.on_revisionsEdit_textChanged" ID="HgGraftDialog.on_revisionsEdit_textChanged"></a> <h4>HgGraftDialog.on_revisionsEdit_textChanged</h4> <b>on_revisionsEdit_textChanged</b>(<i></i>) + <p> Private slot to react upon changes of revisions. -</p><a NAME="HgGraftDialog.on_userEdit_textChanged" ID="HgGraftDialog.on_userEdit_textChanged"></a> +</p> +<a NAME="HgGraftDialog.on_userEdit_textChanged" ID="HgGraftDialog.on_userEdit_textChanged"></a> <h4>HgGraftDialog.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="HgGraftDialog.on_userGroup_toggled" ID="HgGraftDialog.on_userGroup_toggled"></a> +</dl> +<a NAME="HgGraftDialog.on_userGroup_toggled" ID="HgGraftDialog.on_userGroup_toggled"></a> <h4>HgGraftDialog.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> (bool)</dt> <dd> flag giving the checked state