diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,113 +18,148 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog</h1> + <p> Module implementing a dialog to enter the data for a tagging operation. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgTagDialog">HgTagDialog</a></td> <td>Class implementing a dialog to enter the data for a tagging operation.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgTagDialog" ID="HgTagDialog"></a> <h2>HgTagDialog</h2> + <p> Class implementing a dialog to enter the data for a tagging operation. </p> <h3>Derived from</h3> QDialog, Ui_HgTagDialog <h3>Class Attributes</h3> + <table> <tr><td>CreateGlobalTag</td></tr><tr><td>CreateLocalTag</td></tr><tr><td>DeleteGlobalTag</td></tr><tr><td>DeleteLocalTag</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#HgTagDialog.__init__">HgTagDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgTagDialog.getParameters">getParameters</a></td> <td>Public method to retrieve the tag data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgTagDialog.on_tagCombo_currentIndexChanged">on_tagCombo_currentIndexChanged</a></td> <td>Private slot setting the local status of the selected entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgTagDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> <td>Private method used to enable/disable the OK-button.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HgTagDialog.__init__" ID="HgTagDialog.__init__"></a> <h4>HgTagDialog (Constructor)</h4> <b>HgTagDialog</b>(<i>taglist, revision=None, tagName=None, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>taglist</i></dt> <dd> list of previously entered tags (list of strings) -</dd><dt><i>revision</i></dt> +</dd> +<dt><i>revision</i></dt> <dd> revision to set tag for (string) -</dd><dt><i>tagName</i></dt> +</dd> +<dt><i>tagName</i></dt> <dd> name of the tag (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="HgTagDialog.getParameters" ID="HgTagDialog.getParameters"></a> +</dl> +<a NAME="HgTagDialog.getParameters" ID="HgTagDialog.getParameters"></a> <h4>HgTagDialog.getParameters</h4> <b>getParameters</b>(<i></i>) + <p> Public method to retrieve the tag data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing the tag, revision, tag operation and a flag indicating to enforce the operation </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of str, str, int,bool </dd> -</dl><a NAME="HgTagDialog.on_tagCombo_currentIndexChanged" ID="HgTagDialog.on_tagCombo_currentIndexChanged"></a> +</dl> +<a NAME="HgTagDialog.on_tagCombo_currentIndexChanged" ID="HgTagDialog.on_tagCombo_currentIndexChanged"></a> <h4>HgTagDialog.on_tagCombo_currentIndexChanged</h4> <b>on_tagCombo_currentIndexChanged</b>(<i>index</i>) + <p> Private slot setting the local status of the selected entry. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the selected entrie (integer) </dd> -</dl><a NAME="HgTagDialog.on_tagCombo_editTextChanged" ID="HgTagDialog.on_tagCombo_editTextChanged"></a> +</dl> +<a NAME="HgTagDialog.on_tagCombo_editTextChanged" ID="HgTagDialog.on_tagCombo_editTextChanged"></a> <h4>HgTagDialog.on_tagCombo_editTextChanged</h4> <b>on_tagCombo_editTextChanged</b>(<i>text</i>) + <p> Private method used to enable/disable the OK-button. -</p><dl> +</p> +<dl> + <dt><i>text</i></dt> <dd> tag name entered in the combo (string)