Sat, 02 Jan 2010 18:19:35 +0000
Updated documentation.
<?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.vcsPySvn.SvnDiffDialog</title> <style> b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</h1> <p> Module implementing a dialog to show the output of the svn diff command process. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> <td>Class implementing a dialog to show the output of the svn diff command.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> <h2>SvnDiffDialog</h2> <p> Class implementing a dialog to show the output of the svn diff command. </p> <h3>Derived from</h3> QWidget, SvnDialogMixin, Ui_SvnDiffDialog <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> <td>Constructor</td> </tr><tr> <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> <td>Private method to append text to the end of the contents pane.</td> </tr><tr> <td><a href="#SvnDiffDialog.__finish">__finish</a></td> <td>Private slot called when the user pressed the button.</td> </tr><tr> <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td> <td>Private method to get a string descripion of the diff summary.</td> </tr><tr> <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> <td>Private method to get a pysvn revision object for the given version number.</td> </tr><tr> <td><a href="#SvnDiffDialog.__showError">__showError</a></td> <td>Private slot to show an error message.</td> </tr><tr> <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> </tr><tr> <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> <td>Private slot to handle the Save button press.</td> </tr><tr> <td><a href="#SvnDiffDialog.start">start</a></td> <td>Public slot to start the svn diff command.</td> </tr> </table> <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> <h4>SvnDiffDialog (Constructor)</h4> <b>SvnDiffDialog</b>(<i>vcs, parent = None</i>) <p> Constructor </p><dl> <dt><i>vcs</i></dt> <dd> reference to the vcs object </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> <h4>SvnDiffDialog.__appendText</h4> <b>__appendText</b>(<i>line</i>) <p> Private method to append text to the end of the contents pane. </p><dl> <dt><i>line</i></dt> <dd> line of text to insert (string) </dd> </dl><a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a> <h4>SvnDiffDialog.__finish</h4> <b>__finish</b>(<i></i>) <p> Private slot called when the user pressed the button. </p><a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a> <h4>SvnDiffDialog.__getDiffSummaryKind</h4> <b>__getDiffSummaryKind</b>(<i>summaryKind</i>) <p> Private method to get a string descripion of the diff summary. </p><dl> <dt><i>summaryKind</i></dt> <dd> (pysvn.diff_summarize.summarize_kind) </dd> </dl><dl> <dt>Returns:</dt> <dd> one letter string indicating the change type (string) </dd> </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> <h4>SvnDiffDialog.__getVersionArg</h4> <b>__getVersionArg</b>(<i>version</i>) <p> Private method to get a pysvn revision object for the given version number. </p><dl> <dt><i>version</i></dt> <dd> revision (integer or string) </dd> </dl><dl> <dt>Returns:</dt> <dd> revision object (pysvn.Revision) </dd> </dl><a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a> <h4>SvnDiffDialog.__showError</h4> <b>__showError</b>(<i>msg</i>) <p> Private slot to show an error message. </p><dl> <dt><i>msg</i></dt> <dd> error message to show (string) </dd> </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> <h4>SvnDiffDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot called by a button of the button box clicked. </p><dl> <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> </dl><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> <h4>SvnDiffDialog.on_saveButton_clicked</h4> <b>on_saveButton_clicked</b>(<i></i>) <p> Private slot to handle the Save button press. </p><p> It saves the diff shown in the dialog to a file in the local filesystem. </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> <h4>SvnDiffDialog.start</h4> <b>start</b>(<i>fn, versions = None, urls = None, summary = False, pegRev = None</i>) <p> Public slot to start the svn diff command. </p><dl> <dt><i>fn</i></dt> <dd> filename to be diffed (string) </dd><dt><i>versions</i></dt> <dd> list of versions to be diffed (list of up to 2 integer or None) </dd><dt><i>urls=</i></dt> <dd> list of repository URLs (list of 2 strings) </dd><dt><i>summary=</i></dt> <dd> flag indicating a summarizing diff (only valid for URL diffs) (boolean) </dd><dt><i>pegRev=</i></dt> <dd> revision number the filename is valid (integer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>