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