Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html
Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to show the output of the svn diff command process. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> | |
| 35 <td>Class implementing a dialog to show the output of the svn diff command.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> | |
| 44 <h2>SvnDiffDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show the output of the svn diff command. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QWidget, SvnDialogMixin, Ui_SvnDiffDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> | |
| 61 <td>Private method to append text to the end of the contents pane.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SvnDiffDialog.__finish">__finish</a></td> | |
| 64 <td>Private slot called when the user pressed the button.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td> | |
| 67 <td>Private method to get a string descripion of the diff summary.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> | |
| 70 <td>Private method to get a pysvn revision object for the given version number.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#SvnDiffDialog.__showError">__showError</a></td> | |
| 73 <td>Private slot to show an error message.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 76 <td>Private slot called by a button of the button box clicked.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 79 <td>Private slot to handle the Save button press.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#SvnDiffDialog.start">start</a></td> | |
| 82 <td>Public slot to start the svn diff command.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> | |
| 86 <h4>SvnDiffDialog (Constructor)</h4> | |
| 87 <b>SvnDiffDialog</b>(<i>vcs, parent = None</i>) | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p><dl> | |
| 91 <dt><i>vcs</i></dt> | |
| 92 <dd> | |
| 93 reference to the vcs object | |
| 94 </dd><dt><i>parent</i></dt> | |
| 95 <dd> | |
| 96 parent widget (QWidget) | |
| 97 </dd> | |
| 98 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> | |
| 99 <h4>SvnDiffDialog.__appendText</h4> | |
| 100 <b>__appendText</b>(<i>line</i>) | |
| 101 <p> | |
| 102 Private method to append text to the end of the contents pane. | |
| 103 </p><dl> | |
| 104 <dt><i>line</i></dt> | |
| 105 <dd> | |
| 106 line of text to insert (string) | |
| 107 </dd> | |
| 108 </dl><a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a> | |
| 109 <h4>SvnDiffDialog.__finish</h4> | |
| 110 <b>__finish</b>(<i></i>) | |
| 111 <p> | |
| 112 Private slot called when the user pressed the button. | |
| 113 </p><a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a> | |
| 114 <h4>SvnDiffDialog.__getDiffSummaryKind</h4> | |
| 115 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>) | |
| 116 <p> | |
| 117 Private method to get a string descripion of the diff summary. | |
| 118 </p><dl> | |
| 119 <dt><i>summaryKind</i></dt> | |
| 120 <dd> | |
| 121 (pysvn.diff_summarize.summarize_kind) | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Returns:</dt> | |
| 125 <dd> | |
| 126 one letter string indicating the change type (string) | |
| 127 </dd> | |
| 128 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> | |
| 129 <h4>SvnDiffDialog.__getVersionArg</h4> | |
| 130 <b>__getVersionArg</b>(<i>version</i>) | |
| 131 <p> | |
| 132 Private method to get a pysvn revision object for the given version number. | |
| 133 </p><dl> | |
| 134 <dt><i>version</i></dt> | |
| 135 <dd> | |
| 136 revision (integer or string) | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Returns:</dt> | |
| 140 <dd> | |
| 141 revision object (pysvn.Revision) | |
| 142 </dd> | |
| 143 </dl><a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a> | |
| 144 <h4>SvnDiffDialog.__showError</h4> | |
| 145 <b>__showError</b>(<i>msg</i>) | |
| 146 <p> | |
| 147 Private slot to show an error message. | |
| 148 </p><dl> | |
| 149 <dt><i>msg</i></dt> | |
| 150 <dd> | |
| 151 error message to show (string) | |
| 152 </dd> | |
| 153 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> | |
| 154 <h4>SvnDiffDialog.on_buttonBox_clicked</h4> | |
| 155 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 156 <p> | |
| 157 Private slot called by a button of the button box clicked. | |
| 158 </p><dl> | |
| 159 <dt><i>button</i></dt> | |
| 160 <dd> | |
| 161 button that was clicked (QAbstractButton) | |
| 162 </dd> | |
| 163 </dl><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> | |
| 164 <h4>SvnDiffDialog.on_saveButton_clicked</h4> | |
| 165 <b>on_saveButton_clicked</b>(<i></i>) | |
| 166 <p> | |
| 167 Private slot to handle the Save button press. | |
| 168 </p><p> | |
| 169 It saves the diff shown in the dialog to a file in the local | |
| 170 filesystem. | |
| 171 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> | |
| 172 <h4>SvnDiffDialog.start</h4> | |
| 173 <b>start</b>(<i>fn, versions = None, urls = None, summary = False, pegRev = None</i>) | |
| 174 <p> | |
| 175 Public slot to start the svn diff command. | |
| 176 </p><dl> | |
| 177 <dt><i>fn</i></dt> | |
| 178 <dd> | |
| 179 filename to be diffed (string) | |
| 180 </dd><dt><i>versions</i></dt> | |
| 181 <dd> | |
| 182 list of versions to be diffed (list of up to 2 integer or None) | |
| 183 </dd><dt><i>urls=</i></dt> | |
| 184 <dd> | |
| 185 list of repository URLs (list of 2 strings) | |
| 186 </dd><dt><i>summary=</i></dt> | |
| 187 <dd> | |
| 188 flag indicating a summarizing diff | |
| 189 (only valid for URL diffs) (boolean) | |
| 190 </dd><dt><i>pegRev=</i></dt> | |
| 191 <dd> | |
| 192 revision number the filename is valid (integer) | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <div align="right"><a href="#top">Up</a></div> | |
| 196 <hr /> | |
| 197 </body></html> |
