Sat, 23 Dec 2023 15:40:23 +0100
Converted some source code documentation to the new style.
<!DOCTYPE html> <html><head> <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>eric7.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 /> <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> <td><a href="#HgGraftDialog.__updateOk">__updateOk</a></td> <td>Private slot to update the state of the OK button.</td> </tr> <tr> <td><a href="#HgGraftDialog.getData">getData</a></td> <td>Public method to retrieve the entered data.</td> </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> <td><a href="#HgGraftDialog.on_revisionsEdit_textChanged">on_revisionsEdit_textChanged</a></td> <td>Private slot to react upon changes of revisions.</td> </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> <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> <dt><i>vcs</i> (Hg)</dt> <dd> reference to the VCS object </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> reference to the parent widget </dd> </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> <h4>HgGraftDialog.getData</h4> <b>getData</b>(<i></i>) <p> Public method to retrieve the entered data. </p> <dl> <dt>Return:</dt> <dd> tuple with list of revisions, a tuple giving a flag indicating to set the user, a flag indicating to use the current user and the user name, another tuple giving a flag indicating to set the date, a flag indicating to use the current date and the date, a flag indicating to append graft info to the log message, a flag indicating a dry-run and a flag indicating to not commit the copied changesets </dd> </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> <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> <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> <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> <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> <dt><i>txt</i> (str)</dt> <dd> text of the edit </dd> </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> <dt><i>checked</i> (bool)</dt> <dd> flag giving the checked state </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>