--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,103 +18,135 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog</h1> + <p> Module implementing a dialog to enter the archive data. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgArchiveDialog">HgArchiveDialog</a></td> <td>Class implementing a dialog to enter the archive data.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgArchiveDialog" ID="HgArchiveDialog"></a> <h2>HgArchiveDialog</h2> + <p> Class implementing a dialog to enter the archive data. </p> <h3>Derived from</h3> QDialog, Ui_HgArchiveDialog <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="#HgArchiveDialog.__init__">HgArchiveDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgArchiveDialog.getData">getData</a></td> <td>Public method to retrieve the data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgArchiveDialog.on_archivePicker_textChanged">on_archivePicker_textChanged</a></td> <td>Private slot to handle changes of the archive name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgArchiveDialog.on_typeComboBox_activated">on_typeComboBox_activated</a></td> <td>Private slot to react on changes of the selected archive type.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HgArchiveDialog.__init__" ID="HgArchiveDialog.__init__"></a> <h4>HgArchiveDialog (Constructor)</h4> <b>HgArchiveDialog</b>(<i>vcs, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the Mercurial object (Hg) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HgArchiveDialog.getData" ID="HgArchiveDialog.getData"></a> +</dl> +<a NAME="HgArchiveDialog.getData" ID="HgArchiveDialog.getData"></a> <h4>HgArchiveDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to retrieve the data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple giving the archive name (string), the archive type (string), the directory prefix 8string) and a flag indicating to recurse into subrepositories (boolean) </dd> -</dl><a NAME="HgArchiveDialog.on_archivePicker_textChanged" ID="HgArchiveDialog.on_archivePicker_textChanged"></a> +</dl> +<a NAME="HgArchiveDialog.on_archivePicker_textChanged" ID="HgArchiveDialog.on_archivePicker_textChanged"></a> <h4>HgArchiveDialog.on_archivePicker_textChanged</h4> <b>on_archivePicker_textChanged</b>(<i>archive</i>) + <p> Private slot to handle changes of the archive name. -</p><dl> +</p> +<dl> + <dt><i>archive</i></dt> <dd> name of the archive (string) </dd> -</dl><a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a> +</dl> +<a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a> <h4>HgArchiveDialog.on_typeComboBox_activated</h4> <b>on_typeComboBox_activated</b>(<i>index</i>) + <p> Private slot to react on changes of the selected archive type. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the selected type (integer)