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.HgArchiveDialog</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>eric7.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 /> <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> <td><a href="#HgArchiveDialog.getData">getData</a></td> <td>Public method to retrieve the data.</td> </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> <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> <dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial object (Hg) </dd> <dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> </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> <dt>Return:</dt> <dd> tuple giving the archive name, the archive type, the directory prefix and a flag indicating to recurse into subrepositories </dd> </dl> <dl> <dt>Return Type:</dt> <dd> tuple of (str, str, str, bool) </dd> </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> <dt><i>archive</i> (str)</dt> <dd> name of the archive </dd> </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> <dt><i>index</i> (int)</dt> <dd> index of the selected type </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>