Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog</title> | |
| 6 <style> | |
| 7 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' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to show the output of the svn diff command process. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> | |
| 23 <td>Class implementing a dialog to show the output of the svn diff command process.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> | |
| 32 <h2>SvnDiffDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to show the output of the svn diff command process. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QWidget, Ui_SvnDiffDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> | |
| 49 <td>Private method to append text to the end of the contents pane.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> | |
| 52 <td>Private method to get a svn revision argument for the given revision.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#SvnDiffDialog.__procFinished">__procFinished</a></td> | |
| 55 <td>Private slot connected to the finished signal.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#SvnDiffDialog.__readStderr">__readStderr</a></td> | |
| 58 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#SvnDiffDialog.__readStdout">__readStdout</a></td> | |
| 61 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SvnDiffDialog.closeEvent">closeEvent</a></td> | |
| 64 <td>Private slot implementing a close event handler.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SvnDiffDialog.keyPressEvent">keyPressEvent</a></td> | |
| 67 <td>Protected slot to handle a key press event.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 70 <td>Private slot called by a button of the button box clicked.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#SvnDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 73 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SvnDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 76 <td>Private slot to handle the password checkbox toggled.</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.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 82 <td>Private slot to send the input to the subversion process.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#SvnDiffDialog.start">start</a></td> | |
| 85 <td>Public slot to start the svn diff command.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> | |
| 89 <h4>SvnDiffDialog (Constructor)</h4> | |
| 90 <b>SvnDiffDialog</b>(<i>vcs, parent = None</i>) | |
| 91 <p> | |
| 92 Constructor | |
| 93 </p><dl> | |
| 94 <dt><i>vcs</i></dt> | |
| 95 <dd> | |
| 96 reference to the vcs object | |
| 97 </dd><dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 parent widget (QWidget) | |
| 100 </dd> | |
| 101 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> | |
| 102 <h4>SvnDiffDialog.__appendText</h4> | |
| 103 <b>__appendText</b>(<i>txt, format</i>) | |
| 104 <p> | |
| 105 Private method to append text to the end of the contents pane. | |
| 106 </p><dl> | |
| 107 <dt><i>txt</i></dt> | |
| 108 <dd> | |
| 109 text to insert (string) | |
| 110 </dd><dt><i>format</i></dt> | |
| 111 <dd> | |
| 112 text format to be used (QTextCharFormat) | |
| 113 </dd> | |
| 114 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> | |
| 115 <h4>SvnDiffDialog.__getVersionArg</h4> | |
| 116 <b>__getVersionArg</b>(<i>version</i>) | |
| 117 <p> | |
| 118 Private method to get a svn revision argument for the given revision. | |
| 119 </p><dl> | |
| 120 <dt><i>version</i></dt> | |
| 121 <dd> | |
| 122 revision (integer or string) | |
| 123 </dd> | |
| 124 </dl><dl> | |
| 125 <dt>Returns:</dt> | |
| 126 <dd> | |
| 127 version argument (string) | |
| 128 </dd> | |
| 129 </dl><a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a> | |
| 130 <h4>SvnDiffDialog.__procFinished</h4> | |
| 131 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 132 <p> | |
| 133 Private slot connected to the finished signal. | |
| 134 </p><dl> | |
| 135 <dt><i>exitCode</i></dt> | |
| 136 <dd> | |
| 137 exit code of the process (integer) | |
| 138 </dd><dt><i>exitStatus</i></dt> | |
| 139 <dd> | |
| 140 exit status of the process (QProcess.ExitStatus) | |
| 141 </dd> | |
| 142 </dl><a NAME="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a> | |
| 143 <h4>SvnDiffDialog.__readStderr</h4> | |
| 144 <b>__readStderr</b>(<i></i>) | |
| 145 <p> | |
| 146 Private slot to handle the readyReadStandardError signal. | |
| 147 </p><p> | |
| 148 It reads the error output of the process and inserts it into the | |
| 149 error pane. | |
| 150 </p><a NAME="SvnDiffDialog.__readStdout" ID="SvnDiffDialog.__readStdout"></a> | |
| 151 <h4>SvnDiffDialog.__readStdout</h4> | |
| 152 <b>__readStdout</b>(<i></i>) | |
| 153 <p> | |
| 154 Private slot to handle the readyReadStandardOutput signal. | |
| 155 </p><p> | |
| 156 It reads the output of the process, formats it and inserts it into | |
| 157 the contents pane. | |
| 158 </p><a NAME="SvnDiffDialog.closeEvent" ID="SvnDiffDialog.closeEvent"></a> | |
| 159 <h4>SvnDiffDialog.closeEvent</h4> | |
| 160 <b>closeEvent</b>(<i>e</i>) | |
| 161 <p> | |
| 162 Private slot implementing a close event handler. | |
| 163 </p><dl> | |
| 164 <dt><i>e</i></dt> | |
| 165 <dd> | |
| 166 close event (QCloseEvent) | |
| 167 </dd> | |
| 168 </dl><a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a> | |
| 169 <h4>SvnDiffDialog.keyPressEvent</h4> | |
| 170 <b>keyPressEvent</b>(<i>evt</i>) | |
| 171 <p> | |
| 172 Protected slot to handle a key press event. | |
| 173 </p><dl> | |
| 174 <dt><i>evt</i></dt> | |
| 175 <dd> | |
| 176 the key press event (QKeyEvent) | |
| 177 </dd> | |
| 178 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> | |
| 179 <h4>SvnDiffDialog.on_buttonBox_clicked</h4> | |
| 180 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 181 <p> | |
| 182 Private slot called by a button of the button box clicked. | |
| 183 </p><dl> | |
| 184 <dt><i>button</i></dt> | |
| 185 <dd> | |
| 186 button that was clicked (QAbstractButton) | |
| 187 </dd> | |
| 188 </dl><a NAME="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a> | |
| 189 <h4>SvnDiffDialog.on_input_returnPressed</h4> | |
| 190 <b>on_input_returnPressed</b>(<i></i>) | |
| 191 <p> | |
| 192 Private slot to handle the press of the return key in the input field. | |
| 193 </p><a NAME="SvnDiffDialog.on_passwordCheckBox_toggled" ID="SvnDiffDialog.on_passwordCheckBox_toggled"></a> | |
| 194 <h4>SvnDiffDialog.on_passwordCheckBox_toggled</h4> | |
| 195 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 196 <p> | |
| 197 Private slot to handle the password checkbox toggled. | |
| 198 </p><dl> | |
| 199 <dt><i>isOn</i></dt> | |
| 200 <dd> | |
| 201 flag indicating the status of the check box (boolean) | |
| 202 </dd> | |
| 203 </dl><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> | |
| 204 <h4>SvnDiffDialog.on_saveButton_clicked</h4> | |
| 205 <b>on_saveButton_clicked</b>(<i></i>) | |
| 206 <p> | |
| 207 Private slot to handle the Save button press. | |
| 208 </p><p> | |
| 209 It saves the diff shown in the dialog to a file in the local | |
| 210 filesystem. | |
| 211 </p><a NAME="SvnDiffDialog.on_sendButton_clicked" ID="SvnDiffDialog.on_sendButton_clicked"></a> | |
| 212 <h4>SvnDiffDialog.on_sendButton_clicked</h4> | |
| 213 <b>on_sendButton_clicked</b>(<i></i>) | |
| 214 <p> | |
| 215 Private slot to send the input to the subversion process. | |
| 216 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> | |
| 217 <h4>SvnDiffDialog.start</h4> | |
| 218 <b>start</b>(<i>fn, versions = None, urls = None, summary = False</i>) | |
| 219 <p> | |
| 220 Public slot to start the svn diff command. | |
| 221 </p><dl> | |
| 222 <dt><i>fn</i></dt> | |
| 223 <dd> | |
| 224 filename to be diffed (string) | |
| 225 </dd><dt><i>versions</i></dt> | |
| 226 <dd> | |
| 227 list of versions to be diffed (list of up to 2 strings or None) | |
| 228 </dd><dt><i>urls=</i></dt> | |
| 229 <dd> | |
| 230 list of repository URLs (list of 2 strings) | |
| 231 </dd><dt><i>summary=</i></dt> | |
| 232 <dd> | |
| 233 flag indicating a summarizing diff | |
| 234 (only valid for URL diffs) (boolean) | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
