Sat, 20 Aug 2011 17:24:33 +0200
Fixed an issue in the source documentor and regenerated the source docu.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog</title> <style> body { background: #EDECE6; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #85774A; } h2 { color: white; background: #85774A; } h3 { color: white; background: #9D936E; } h4 { color: white; background: #9D936E; } a { color: #BA6D36; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.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 /> <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> <td><a href="#HgBundleDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> </tr><tr> <td><a href="#HgBundleDialog.getParameters">getParameters</a></td> <td>Public method to retrieve the bundle data.</td> </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> <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> <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> <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> <td><a href="#HgBundleDialog.on_idButton_toggled">on_idButton_toggled</a></td> <td>Private slot to handle changes of the ID select button.</td> </tr><tr> <td><a href="#HgBundleDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td> <td>Private slot to handle changes of the ID edit.</td> </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> <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, parent=None</i>) <p> Constructor </p><dl> <dt><i>tagsList</i></dt> <dd> list of tags (list of strings) </dd><dt><i>branchesList</i></dt> <dd> list of branches (list of strings) </dd><dt><i>bookmarksList</i></dt> <dd> list of bookmarks (list of strings) </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> </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> <h4>HgBundleDialog.getParameters</h4> <b>getParameters</b>(<i></i>) <p> Public method to retrieve the bundle data. </p><dl> <dt>Returns:</dt> <dd> tuple naming the revision, 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> <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> <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> <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> <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> <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> <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> <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> <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> </dl><a NAME="HgBundleDialog.on_idButton_toggled" ID="HgBundleDialog.on_idButton_toggled"></a> <h4>HgBundleDialog.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> <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> </dl><a NAME="HgBundleDialog.on_idEdit_textChanged" ID="HgBundleDialog.on_idEdit_textChanged"></a> <h4>HgBundleDialog.on_idEdit_textChanged</h4> <b>on_idEdit_textChanged</b>(<i>txt</i>) <p> Private slot to handle changes of the ID edit. </p><dl> <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> </dl><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> <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> <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> <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>