Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog starting a process and showing its output. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#SvnDialog">SvnDialog</a></td> | |
| 25 <td>Class implementing a dialog starting a process and showing its output.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="SvnDialog" ID="SvnDialog"></a> | |
| 36 <h2>SvnDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog starting a process and showing its output. | |
| 40 </p> | |
| 41 <p> | |
| 42 It starts a QProcess and displays a dialog that | |
| 43 shows the output of the process. The dialog is modal, | |
| 44 which causes a synchronized execution of the process. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QDialog, Ui_SvnDialog | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#SvnDialog.__init__">SvnDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#SvnDialog.__finish">__finish</a></td> | |
| 68 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#SvnDialog.__procFinished">__procFinished</a></td> | |
| 72 <td>Private slot connected to the finished signal.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#SvnDialog.__readStderr">__readStderr</a></td> | |
| 76 <td>Private slot to handle the readyReadStderr signal.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#SvnDialog.__readStdout">__readStdout</a></td> | |
| 80 <td>Private slot to handle the readyReadStdout signal.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#SvnDialog.hasAddOrDelete">hasAddOrDelete</a></td> | |
| 84 <td>Public method to check, if the last action contained an add or delete.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#SvnDialog.keyPressEvent">keyPressEvent</a></td> | |
| 88 <td>Protected slot to handle a key press event.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#SvnDialog.normalExit">normalExit</a></td> | |
| 92 <td>Public method to check for a normal process termination.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#SvnDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 96 <td>Private slot called by a button of the button box clicked.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#SvnDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 100 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#SvnDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 104 <td>Private slot to handle the password checkbox toggled.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#SvnDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 108 <td>Private slot to send the input to the subversion process.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#SvnDialog.startProcess">startProcess</a></td> | |
| 112 <td>Public slot used to start the process.</td> | |
| 113 </tr> | |
| 114 </table> | |
| 115 <h3>Static Methods</h3> | |
| 116 | |
| 117 <table> | |
| 118 <tr><td>None</td></tr> | |
| 119 </table> | |
| 120 | |
| 121 <a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a> | |
| 122 <h4>SvnDialog (Constructor)</h4> | |
| 123 <b>SvnDialog</b>(<i>text, parent=None</i>) | |
| 124 | |
| 125 <p> | |
| 126 Constructor | |
| 127 </p> | |
| 128 <dl> | |
| 129 | |
| 130 <dt><i>text</i></dt> | |
| 131 <dd> | |
| 132 text to be shown by the label (string) | |
| 133 </dd> | |
| 134 <dt><i>parent</i></dt> | |
| 135 <dd> | |
| 136 parent widget (QWidget) | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a> | |
| 140 <h4>SvnDialog.__finish</h4> | |
| 141 <b>__finish</b>(<i></i>) | |
| 142 | |
| 143 <p> | |
| 144 Private slot called when the process finished or the user pressed the | |
| 145 button. | |
| 146 </p> | |
| 147 <a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a> | |
| 148 <h4>SvnDialog.__procFinished</h4> | |
| 149 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 150 | |
| 151 <p> | |
| 152 Private slot connected to the finished signal. | |
| 153 </p> | |
| 154 <dl> | |
| 155 | |
| 156 <dt><i>exitCode</i></dt> | |
| 157 <dd> | |
| 158 exit code of the process (integer) | |
| 159 </dd> | |
| 160 <dt><i>exitStatus</i></dt> | |
| 161 <dd> | |
| 162 exit status of the process (QProcess.ExitStatus) | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a> | |
| 166 <h4>SvnDialog.__readStderr</h4> | |
| 167 <b>__readStderr</b>(<i></i>) | |
| 168 | |
| 169 <p> | |
| 170 Private slot to handle the readyReadStderr signal. | |
| 171 </p> | |
| 172 <p> | |
| 173 It reads the error output of the process and inserts it into the | |
| 174 error pane. | |
| 175 </p> | |
| 176 <a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a> | |
| 177 <h4>SvnDialog.__readStdout</h4> | |
| 178 <b>__readStdout</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Private slot to handle the readyReadStdout signal. | |
| 182 </p> | |
| 183 <p> | |
| 184 It reads the output of the process, formats it and inserts it into | |
| 185 the contents pane. | |
| 186 </p> | |
| 187 <a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a> | |
| 188 <h4>SvnDialog.hasAddOrDelete</h4> | |
| 189 <b>hasAddOrDelete</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Public method to check, if the last action contained an add or delete. | |
| 193 </p> | |
| 194 <dl> | |
| 195 <dt>Return:</dt> | |
| 196 <dd> | |
| 197 flag indicating the presence of an add or delete (boolean) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a> | |
| 201 <h4>SvnDialog.keyPressEvent</h4> | |
| 202 <b>keyPressEvent</b>(<i>evt</i>) | |
| 203 | |
| 204 <p> | |
| 205 Protected slot to handle a key press event. | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>evt</i></dt> | |
| 210 <dd> | |
| 211 the key press event (QKeyEvent) | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a> | |
| 215 <h4>SvnDialog.normalExit</h4> | |
| 216 <b>normalExit</b>(<i></i>) | |
| 217 | |
| 218 <p> | |
| 219 Public method to check for a normal process termination. | |
| 220 </p> | |
| 221 <dl> | |
| 222 <dt>Return:</dt> | |
| 223 <dd> | |
| 224 flag indicating normal process termination (boolean) | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> | |
| 228 <h4>SvnDialog.on_buttonBox_clicked</h4> | |
| 229 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 230 | |
| 231 <p> | |
| 232 Private slot called by a button of the button box clicked. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>button</i></dt> | |
| 237 <dd> | |
| 238 button that was clicked (QAbstractButton) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a> | |
| 242 <h4>SvnDialog.on_input_returnPressed</h4> | |
| 243 <b>on_input_returnPressed</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to handle the press of the return key in the input field. | |
| 247 </p> | |
| 248 <a NAME="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a> | |
| 249 <h4>SvnDialog.on_passwordCheckBox_toggled</h4> | |
| 250 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 251 | |
| 252 <p> | |
| 253 Private slot to handle the password checkbox toggled. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>isOn</i></dt> | |
| 258 <dd> | |
| 259 flag indicating the status of the check box (boolean) | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a> | |
| 263 <h4>SvnDialog.on_sendButton_clicked</h4> | |
| 264 <b>on_sendButton_clicked</b>(<i></i>) | |
| 265 | |
| 266 <p> | |
| 267 Private slot to send the input to the subversion process. | |
| 268 </p> | |
| 269 <a NAME="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a> | |
| 270 <h4>SvnDialog.startProcess</h4> | |
| 271 <b>startProcess</b>(<i>args, workingDir=None, setLanguage=False</i>) | |
| 272 | |
| 273 <p> | |
| 274 Public slot used to start the process. | |
| 275 </p> | |
| 276 <dl> | |
| 277 | |
| 278 <dt><i>args</i></dt> | |
| 279 <dd> | |
| 280 list of arguments for the process (list of strings) | |
| 281 </dd> | |
| 282 <dt><i>workingDir</i></dt> | |
| 283 <dd> | |
| 284 working directory for the process (string) | |
| 285 </dd> | |
| 286 <dt><i>setLanguage</i></dt> | |
| 287 <dd> | |
| 288 flag indicating to set the language to "C" (boolean) | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <dl> | |
| 292 <dt>Return:</dt> | |
| 293 <dd> | |
| 294 flag indicating a successful start of the process | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <div align="right"><a href="#top">Up</a></div> | |
| 298 <hr /> | |
| 299 </body></html> |
