--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,193 +18,259 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog</h1> + <p> Module implementing a dialog to enter the data for a bundle operation. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgBundleDialog">HgBundleDialog</a></td> <td>Class implementing a dialog to enter the data for a bundle operation.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgBundleDialog" ID="HgBundleDialog"></a> <h2>HgBundleDialog</h2> + <p> Class implementing a dialog to enter the data for a bundle operation. </p> <h3>Derived from</h3> QDialog, Ui_HgBundleDialog <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="#HgBundleDialog.__init__">HgBundleDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBundleDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBundleDialog.getParameters">getParameters</a></td> <td>Public method to retrieve the bundle data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBundleDialog.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="#HgBundleDialog.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="#HgBundleDialog.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="#HgBundleDialog.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="#HgBundleDialog.on_multipleButton_toggled">on_multipleButton_toggled</a></td> <td>Private slot to handle changes of the Multiple select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBundleDialog.on_multipleEdit_textChanged">on_multipleEdit_textChanged</a></td> <td>Private slot to handle changes of the Multiple edit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgBundleDialog.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="#HgBundleDialog.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="HgBundleDialog.__init__" ID="HgBundleDialog.__init__"></a> <h4>HgBundleDialog (Constructor)</h4> <b>HgBundleDialog</b>(<i>tagsList, branchesList, bookmarksList=None, version=(0, 0, 0), parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>tagsList</i> (list of str)</dt> <dd> list of tags -</dd><dt><i>branchesList</i> (list of str)</dt> +</dd> +<dt><i>branchesList</i> (list of str)</dt> <dd> list of branches -</dd><dt><i>bookmarksList</i> (list of str)</dt> +</dd> +<dt><i>bookmarksList</i> (list of str)</dt> <dd> list of bookmarks -</dd><dt><i>version</i> (tuple of three integers)</dt> +</dd> +<dt><i>version</i> (tuple of three integers)</dt> <dd> Mercurial version info -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> parent widget </dd> -</dl><a NAME="HgBundleDialog.__updateOK" ID="HgBundleDialog.__updateOK"></a> +</dl> +<a NAME="HgBundleDialog.__updateOK" ID="HgBundleDialog.__updateOK"></a> <h4>HgBundleDialog.__updateOK</h4> <b>__updateOK</b>(<i></i>) + <p> Private slot to update the OK button. -</p><a NAME="HgBundleDialog.getParameters" ID="HgBundleDialog.getParameters"></a> +</p> +<a NAME="HgBundleDialog.getParameters" ID="HgBundleDialog.getParameters"></a> <h4>HgBundleDialog.getParameters</h4> <b>getParameters</b>(<i></i>) + <p> Public method to retrieve the bundle data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple naming the revisions, base revisions, the compression type and a flag indicating to bundle all changesets (string, string, boolean) </dd> -</dl><a NAME="HgBundleDialog.on_bookmarkButton_toggled" ID="HgBundleDialog.on_bookmarkButton_toggled"></a> +</dl> +<a NAME="HgBundleDialog.on_bookmarkButton_toggled" ID="HgBundleDialog.on_bookmarkButton_toggled"></a> <h4>HgBundleDialog.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="HgBundleDialog.on_bookmarkCombo_editTextChanged" ID="HgBundleDialog.on_bookmarkCombo_editTextChanged"></a> +</dl> +<a NAME="HgBundleDialog.on_bookmarkCombo_editTextChanged" ID="HgBundleDialog.on_bookmarkCombo_editTextChanged"></a> <h4>HgBundleDialog.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="HgBundleDialog.on_branchButton_toggled" ID="HgBundleDialog.on_branchButton_toggled"></a> +</dl> +<a NAME="HgBundleDialog.on_branchButton_toggled" ID="HgBundleDialog.on_branchButton_toggled"></a> <h4>HgBundleDialog.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="HgBundleDialog.on_branchCombo_editTextChanged" ID="HgBundleDialog.on_branchCombo_editTextChanged"></a> +</dl> +<a NAME="HgBundleDialog.on_branchCombo_editTextChanged" ID="HgBundleDialog.on_branchCombo_editTextChanged"></a> <h4>HgBundleDialog.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="HgBundleDialog.on_multipleButton_toggled" ID="HgBundleDialog.on_multipleButton_toggled"></a> +</dl> +<a NAME="HgBundleDialog.on_multipleButton_toggled" ID="HgBundleDialog.on_multipleButton_toggled"></a> <h4>HgBundleDialog.on_multipleButton_toggled</h4> <b>on_multipleButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Multiple select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="HgBundleDialog.on_multipleEdit_textChanged" ID="HgBundleDialog.on_multipleEdit_textChanged"></a> +</dl> +<a NAME="HgBundleDialog.on_multipleEdit_textChanged" ID="HgBundleDialog.on_multipleEdit_textChanged"></a> <h4>HgBundleDialog.on_multipleEdit_textChanged</h4> <b>on_multipleEdit_textChanged</b>(<i></i>) + <p> Private slot to handle changes of the Multiple edit. -</p><a NAME="HgBundleDialog.on_tagButton_toggled" ID="HgBundleDialog.on_tagButton_toggled"></a> +</p> +<a NAME="HgBundleDialog.on_tagButton_toggled" ID="HgBundleDialog.on_tagButton_toggled"></a> <h4>HgBundleDialog.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="HgBundleDialog.on_tagCombo_editTextChanged" ID="HgBundleDialog.on_tagCombo_editTextChanged"></a> +</dl> +<a NAME="HgBundleDialog.on_tagCombo_editTextChanged" ID="HgBundleDialog.on_tagCombo_editTextChanged"></a> <h4>HgBundleDialog.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)