Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html
Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnDialog.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.vcsSubversion.SvnDialog</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.vcsSubversion.SvnDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog starting a process and showing its output. | |
| 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="#SvnDialog">SvnDialog</a></td> | |
| 35 <td>Class implementing a dialog starting a process and showing its output.</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="SvnDialog" ID="SvnDialog"></a> | |
| 44 <h2>SvnDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog starting a process and showing its output. | |
| 47 </p><p> | |
| 48 It starts a QProcess and displays a dialog that | |
| 49 shows the output of the process. The dialog is modal, | |
| 50 which causes a synchronized execution of the process. | |
| 51 </p> | |
| 52 <h3>Derived from</h3> | |
| 53 QDialog, Ui_SvnDialog | |
| 54 <h3>Class Attributes</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#SvnDialog.__init__">SvnDialog</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#SvnDialog.__finish">__finish</a></td> | |
| 65 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#SvnDialog.__procFinished">__procFinished</a></td> | |
| 68 <td>Private slot connected to the finished signal.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#SvnDialog.__readStderr">__readStderr</a></td> | |
| 71 <td>Private slot to handle the readyReadStderr signal.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#SvnDialog.__readStdout">__readStdout</a></td> | |
| 74 <td>Private slot to handle the readyReadStdout signal.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#SvnDialog.hasAddOrDelete">hasAddOrDelete</a></td> | |
| 77 <td>Public method to check, if the last action contained an add or delete.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#SvnDialog.keyPressEvent">keyPressEvent</a></td> | |
| 80 <td>Protected slot to handle a key press event.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#SvnDialog.normalExit">normalExit</a></td> | |
| 83 <td>Public method to check for a normal process termination.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#SvnDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 86 <td>Private slot called by a button of the button box clicked.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#SvnDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 89 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#SvnDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 92 <td>Private slot to handle the password checkbox toggled.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#SvnDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 95 <td>Private slot to send the input to the subversion process.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#SvnDialog.startProcess">startProcess</a></td> | |
| 98 <td>Public slot used to start the process.</td> | |
| 99 </tr> | |
| 100 </table> | |
| 101 <a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a> | |
| 102 <h4>SvnDialog (Constructor)</h4> | |
| 103 <b>SvnDialog</b>(<i>text, parent = None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>text</i></dt> | |
| 108 <dd> | |
| 109 text to be shown by the label (string) | |
| 110 </dd><dt><i>parent</i></dt> | |
| 111 <dd> | |
| 112 parent widget (QWidget) | |
| 113 </dd> | |
| 114 </dl><a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a> | |
| 115 <h4>SvnDialog.__finish</h4> | |
| 116 <b>__finish</b>(<i></i>) | |
| 117 <p> | |
| 118 Private slot called when the process finished or the user pressed the button. | |
| 119 </p><a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a> | |
| 120 <h4>SvnDialog.__procFinished</h4> | |
| 121 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 122 <p> | |
| 123 Private slot connected to the finished signal. | |
| 124 </p><dl> | |
| 125 <dt><i>exitCode</i></dt> | |
| 126 <dd> | |
| 127 exit code of the process (integer) | |
| 128 </dd><dt><i>exitStatus</i></dt> | |
| 129 <dd> | |
| 130 exit status of the process (QProcess.ExitStatus) | |
| 131 </dd> | |
| 132 </dl><a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a> | |
| 133 <h4>SvnDialog.__readStderr</h4> | |
| 134 <b>__readStderr</b>(<i></i>) | |
| 135 <p> | |
| 136 Private slot to handle the readyReadStderr signal. | |
| 137 </p><p> | |
| 138 It reads the error output of the process and inserts it into the | |
| 139 error pane. | |
| 140 </p><a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a> | |
| 141 <h4>SvnDialog.__readStdout</h4> | |
| 142 <b>__readStdout</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to handle the readyReadStdout signal. | |
| 145 </p><p> | |
| 146 It reads the output of the process, formats it and inserts it into | |
| 147 the contents pane. | |
| 148 </p><a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a> | |
| 149 <h4>SvnDialog.hasAddOrDelete</h4> | |
| 150 <b>hasAddOrDelete</b>(<i></i>) | |
| 151 <p> | |
| 152 Public method to check, if the last action contained an add or delete. | |
| 153 </p><a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a> | |
| 154 <h4>SvnDialog.keyPressEvent</h4> | |
| 155 <b>keyPressEvent</b>(<i>evt</i>) | |
| 156 <p> | |
| 157 Protected slot to handle a key press event. | |
| 158 </p><dl> | |
| 159 <dt><i>evt</i></dt> | |
| 160 <dd> | |
| 161 the key press event (QKeyEvent) | |
| 162 </dd> | |
| 163 </dl><a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a> | |
| 164 <h4>SvnDialog.normalExit</h4> | |
| 165 <b>normalExit</b>(<i></i>) | |
| 166 <p> | |
| 167 Public method to check for a normal process termination. | |
| 168 </p><dl> | |
| 169 <dt>Returns:</dt> | |
| 170 <dd> | |
| 171 flag indicating normal process termination (boolean) | |
| 172 </dd> | |
| 173 </dl><a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> | |
| 174 <h4>SvnDialog.on_buttonBox_clicked</h4> | |
| 175 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 176 <p> | |
| 177 Private slot called by a button of the button box clicked. | |
| 178 </p><dl> | |
| 179 <dt><i>button</i></dt> | |
| 180 <dd> | |
| 181 button that was clicked (QAbstractButton) | |
| 182 </dd> | |
| 183 </dl><a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a> | |
| 184 <h4>SvnDialog.on_input_returnPressed</h4> | |
| 185 <b>on_input_returnPressed</b>(<i></i>) | |
| 186 <p> | |
| 187 Private slot to handle the press of the return key in the input field. | |
| 188 </p><a NAME="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a> | |
| 189 <h4>SvnDialog.on_passwordCheckBox_toggled</h4> | |
| 190 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 191 <p> | |
| 192 Private slot to handle the password checkbox toggled. | |
| 193 </p><dl> | |
| 194 <dt><i>isOn</i></dt> | |
| 195 <dd> | |
| 196 flag indicating the status of the check box (boolean) | |
| 197 </dd> | |
| 198 </dl><a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a> | |
| 199 <h4>SvnDialog.on_sendButton_clicked</h4> | |
| 200 <b>on_sendButton_clicked</b>(<i></i>) | |
| 201 <p> | |
| 202 Private slot to send the input to the subversion process. | |
| 203 </p><a NAME="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a> | |
| 204 <h4>SvnDialog.startProcess</h4> | |
| 205 <b>startProcess</b>(<i>args, workingDir = None</i>) | |
| 206 <p> | |
| 207 Public slot used to start the process. | |
| 208 </p><dl> | |
| 209 <dt><i>args</i></dt> | |
| 210 <dd> | |
| 211 list of arguments for the process (list of strings) | |
| 212 </dd><dt><i>workingDir</i></dt> | |
| 213 <dd> | |
| 214 working directory for the process (string) | |
| 215 </dd> | |
| 216 </dl><dl> | |
| 217 <dt>Returns:</dt> | |
| 218 <dd> | |
| 219 flag indicating a successful start of the process | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <div align="right"><a href="#top">Up</a></div> | |
| 223 <hr /> | |
| 224 </body></html> |
