diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,208 +18,280 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog</h1> + <p> Module implementing a dialog to enter the data for a backout operation. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgBackoutDialog">HgBackoutDialog</a></td> <td>Class implementing a dialog to enter the data for a backout operation.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgBackoutDialog" ID="HgBackoutDialog"></a> <h2>HgBackoutDialog</h2> + <p> Class implementing a dialog to enter the data for a backout operation. </p> <h3>Derived from</h3> QDialog, Ui_HgBackoutDialog <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="#HgBackoutDialog.__init__">HgBackoutDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.getParameters">getParameters</a></td> <td>Public method to retrieve the backout data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_bookmarkButton_toggled">on_bookmarkButton_toggled</a></td> <td>Private slot to handle changes of the Bookmark select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_bookmarkCombo_editTextChanged">on_bookmarkCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Bookmark combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> <td>Private slot to handle changes of the Branch select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Branch combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_idButton_toggled">on_idButton_toggled</a></td> <td>Private slot to handle changes of the ID select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td> <td>Private slot to handle changes of the ID edit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_noneButton_toggled">on_noneButton_toggled</a></td> <td>Private slot to handle the toggling of the None revision button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> <td>Private slot to handle changes of the Tag select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBackoutDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Tag combo.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HgBackoutDialog.__init__" ID="HgBackoutDialog.__init__"></a> <h4>HgBackoutDialog (Constructor)</h4> <b>HgBackoutDialog</b>(<i>tagsList, branchesList, bookmarksList=None, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>tagsList</i></dt> <dd> list of tags (list of strings) -</dd><dt><i>branchesList</i></dt> +</dd> +<dt><i>branchesList</i></dt> <dd> list of branches (list of strings) -</dd><dt><i>bookmarksList</i></dt> +</dd> +<dt><i>bookmarksList</i></dt> <dd> list of bookmarks (list of strings) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="HgBackoutDialog.__updateOK" ID="HgBackoutDialog.__updateOK"></a> +</dl> +<a NAME="HgBackoutDialog.__updateOK" ID="HgBackoutDialog.__updateOK"></a> <h4>HgBackoutDialog.__updateOK</h4> <b>__updateOK</b>(<i></i>) + <p> Private slot to update the OK button. -</p><a NAME="HgBackoutDialog.getParameters" ID="HgBackoutDialog.getParameters"></a> +</p> +<a NAME="HgBackoutDialog.getParameters" ID="HgBackoutDialog.getParameters"></a> <h4>HgBackoutDialog.getParameters</h4> <b>getParameters</b>(<i></i>) + <p> Public method to retrieve the backout data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple naming the revision, a flag indicating a merge, the commit date, the commit user and a commit message (string, boolean, string, string, string) </dd> -</dl><a NAME="HgBackoutDialog.on_bookmarkButton_toggled" ID="HgBackoutDialog.on_bookmarkButton_toggled"></a> +</dl> +<a NAME="HgBackoutDialog.on_bookmarkButton_toggled" ID="HgBackoutDialog.on_bookmarkButton_toggled"></a> <h4>HgBackoutDialog.on_bookmarkButton_toggled</h4> <b>on_bookmarkButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Bookmark select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="HgBackoutDialog.on_bookmarkCombo_editTextChanged" ID="HgBackoutDialog.on_bookmarkCombo_editTextChanged"></a> +</dl> +<a NAME="HgBackoutDialog.on_bookmarkCombo_editTextChanged" ID="HgBackoutDialog.on_bookmarkCombo_editTextChanged"></a> <h4>HgBackoutDialog.on_bookmarkCombo_editTextChanged</h4> <b>on_bookmarkCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Bookmark combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="HgBackoutDialog.on_branchButton_toggled" ID="HgBackoutDialog.on_branchButton_toggled"></a> +</dl> +<a NAME="HgBackoutDialog.on_branchButton_toggled" ID="HgBackoutDialog.on_branchButton_toggled"></a> <h4>HgBackoutDialog.on_branchButton_toggled</h4> <b>on_branchButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Branch select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="HgBackoutDialog.on_branchCombo_editTextChanged" ID="HgBackoutDialog.on_branchCombo_editTextChanged"></a> +</dl> +<a NAME="HgBackoutDialog.on_branchCombo_editTextChanged" ID="HgBackoutDialog.on_branchCombo_editTextChanged"></a> <h4>HgBackoutDialog.on_branchCombo_editTextChanged</h4> <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Branch combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="HgBackoutDialog.on_idButton_toggled" ID="HgBackoutDialog.on_idButton_toggled"></a> +</dl> +<a NAME="HgBackoutDialog.on_idButton_toggled" ID="HgBackoutDialog.on_idButton_toggled"></a> <h4>HgBackoutDialog.on_idButton_toggled</h4> <b>on_idButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the ID select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="HgBackoutDialog.on_idEdit_textChanged" ID="HgBackoutDialog.on_idEdit_textChanged"></a> +</dl> +<a NAME="HgBackoutDialog.on_idEdit_textChanged" ID="HgBackoutDialog.on_idEdit_textChanged"></a> <h4>HgBackoutDialog.on_idEdit_textChanged</h4> <b>on_idEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the ID edit. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="HgBackoutDialog.on_noneButton_toggled" ID="HgBackoutDialog.on_noneButton_toggled"></a> +</dl> +<a NAME="HgBackoutDialog.on_noneButton_toggled" ID="HgBackoutDialog.on_noneButton_toggled"></a> <h4>HgBackoutDialog.on_noneButton_toggled</h4> <b>on_noneButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle the toggling of the None revision button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> flag indicating the checked state (boolean) </dd> -</dl><a NAME="HgBackoutDialog.on_tagButton_toggled" ID="HgBackoutDialog.on_tagButton_toggled"></a> +</dl> +<a NAME="HgBackoutDialog.on_tagButton_toggled" ID="HgBackoutDialog.on_tagButton_toggled"></a> <h4>HgBackoutDialog.on_tagButton_toggled</h4> <b>on_tagButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Tag select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="HgBackoutDialog.on_tagCombo_editTextChanged" ID="HgBackoutDialog.on_tagCombo_editTextChanged"></a> +</dl> +<a NAME="HgBackoutDialog.on_tagCombo_editTextChanged" ID="HgBackoutDialog.on_tagCombo_editTextChanged"></a> <h4>HgBackoutDialog.on_tagCombo_editTextChanged</h4> <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Tag combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string)