Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgDialog.html
- changeset 178
- dd9f0bca5e2f
- child 189
- 17bb2db7a347
equal
deleted
inserted
replaced
| 177:c822ccc4d138 | 178:dd9f0bca5e2f |
|---|---|
| 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.vcsMercurial.HgDialog</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>eric5.Plugins.VcsPlugins.vcsMercurial.HgDialog</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="#HgDialog">HgDialog</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="HgDialog" ID="HgDialog"></a> | |
| 44 <h2>HgDialog</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_HgDialog | |
| 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="#HgDialog.__init__">HgDialog</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#HgDialog.__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="#HgDialog.__procFinished">__procFinished</a></td> | |
| 68 <td>Private slot connected to the finished signal.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#HgDialog.__readStderr">__readStderr</a></td> | |
| 71 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#HgDialog.__readStdout">__readStdout</a></td> | |
| 74 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#HgDialog.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="#HgDialog.keyPressEvent">keyPressEvent</a></td> | |
| 80 <td>Protected slot to handle a key press event.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#HgDialog.normalExit">normalExit</a></td> | |
| 83 <td>Public method to check for a normal process termination.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#HgDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> | |
| 86 <td>Public method to check for a normal process termination without error messages.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#HgDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 89 <td>Private slot called by a button of the button box clicked.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#HgDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 92 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#HgDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 95 <td>Private slot to handle the password checkbox toggled.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#HgDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 98 <td>Private slot to send the input to the subversion process.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#HgDialog.startProcess">startProcess</a></td> | |
| 101 <td>Public slot used to start the process.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 <a NAME="HgDialog.__init__" ID="HgDialog.__init__"></a> | |
| 105 <h4>HgDialog (Constructor)</h4> | |
| 106 <b>HgDialog</b>(<i>text, parent = None</i>) | |
| 107 <p> | |
| 108 Constructor | |
| 109 </p><dl> | |
| 110 <dt><i>text</i></dt> | |
| 111 <dd> | |
| 112 text to be shown by the label (string) | |
| 113 </dd><dt><i>parent</i></dt> | |
| 114 <dd> | |
| 115 parent widget (QWidget) | |
| 116 </dd> | |
| 117 </dl><a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a> | |
| 118 <h4>HgDialog.__finish</h4> | |
| 119 <b>__finish</b>(<i></i>) | |
| 120 <p> | |
| 121 Private slot called when the process finished or the user pressed the button. | |
| 122 </p><a NAME="HgDialog.__procFinished" ID="HgDialog.__procFinished"></a> | |
| 123 <h4>HgDialog.__procFinished</h4> | |
| 124 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 125 <p> | |
| 126 Private slot connected to the finished signal. | |
| 127 </p><dl> | |
| 128 <dt><i>exitCode</i></dt> | |
| 129 <dd> | |
| 130 exit code of the process (integer) | |
| 131 </dd><dt><i>exitStatus</i></dt> | |
| 132 <dd> | |
| 133 exit status of the process (QProcess.ExitStatus) | |
| 134 </dd> | |
| 135 </dl><a NAME="HgDialog.__readStderr" ID="HgDialog.__readStderr"></a> | |
| 136 <h4>HgDialog.__readStderr</h4> | |
| 137 <b>__readStderr</b>(<i></i>) | |
| 138 <p> | |
| 139 Private slot to handle the readyReadStandardError signal. | |
| 140 </p><p> | |
| 141 It reads the error output of the process and inserts it into the | |
| 142 error pane. | |
| 143 </p><a NAME="HgDialog.__readStdout" ID="HgDialog.__readStdout"></a> | |
| 144 <h4>HgDialog.__readStdout</h4> | |
| 145 <b>__readStdout</b>(<i></i>) | |
| 146 <p> | |
| 147 Private slot to handle the readyReadStandardOutput signal. | |
| 148 </p><p> | |
| 149 It reads the output of the process, formats it and inserts it into | |
| 150 the contents pane. | |
| 151 </p><a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a> | |
| 152 <h4>HgDialog.hasAddOrDelete</h4> | |
| 153 <b>hasAddOrDelete</b>(<i></i>) | |
| 154 <p> | |
| 155 Public method to check, if the last action contained an add or delete. | |
| 156 </p><dl> | |
| 157 <dt>Returns:</dt> | |
| 158 <dd> | |
| 159 flag indicating the presence of an add or delete (boolean) | |
| 160 </dd> | |
| 161 </dl><a NAME="HgDialog.keyPressEvent" ID="HgDialog.keyPressEvent"></a> | |
| 162 <h4>HgDialog.keyPressEvent</h4> | |
| 163 <b>keyPressEvent</b>(<i>evt</i>) | |
| 164 <p> | |
| 165 Protected slot to handle a key press event. | |
| 166 </p><dl> | |
| 167 <dt><i>evt</i></dt> | |
| 168 <dd> | |
| 169 the key press event (QKeyEvent) | |
| 170 </dd> | |
| 171 </dl><a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a> | |
| 172 <h4>HgDialog.normalExit</h4> | |
| 173 <b>normalExit</b>(<i></i>) | |
| 174 <p> | |
| 175 Public method to check for a normal process termination. | |
| 176 </p><dl> | |
| 177 <dt>Returns:</dt> | |
| 178 <dd> | |
| 179 flag indicating normal process termination (boolean) | |
| 180 </dd> | |
| 181 </dl><a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a> | |
| 182 <h4>HgDialog.normalExitWithoutErrors</h4> | |
| 183 <b>normalExitWithoutErrors</b>(<i></i>) | |
| 184 <p> | |
| 185 Public method to check for a normal process termination without | |
| 186 error messages. | |
| 187 </p><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 flag indicating normal process termination (boolean) | |
| 191 </dd> | |
| 192 </dl><a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a> | |
| 193 <h4>HgDialog.on_buttonBox_clicked</h4> | |
| 194 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 195 <p> | |
| 196 Private slot called by a button of the button box clicked. | |
| 197 </p><dl> | |
| 198 <dt><i>button</i></dt> | |
| 199 <dd> | |
| 200 button that was clicked (QAbstractButton) | |
| 201 </dd> | |
| 202 </dl><a NAME="HgDialog.on_input_returnPressed" ID="HgDialog.on_input_returnPressed"></a> | |
| 203 <h4>HgDialog.on_input_returnPressed</h4> | |
| 204 <b>on_input_returnPressed</b>(<i></i>) | |
| 205 <p> | |
| 206 Private slot to handle the press of the return key in the input field. | |
| 207 </p><a NAME="HgDialog.on_passwordCheckBox_toggled" ID="HgDialog.on_passwordCheckBox_toggled"></a> | |
| 208 <h4>HgDialog.on_passwordCheckBox_toggled</h4> | |
| 209 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 210 <p> | |
| 211 Private slot to handle the password checkbox toggled. | |
| 212 </p><dl> | |
| 213 <dt><i>isOn</i></dt> | |
| 214 <dd> | |
| 215 flag indicating the status of the check box (boolean) | |
| 216 </dd> | |
| 217 </dl><a NAME="HgDialog.on_sendButton_clicked" ID="HgDialog.on_sendButton_clicked"></a> | |
| 218 <h4>HgDialog.on_sendButton_clicked</h4> | |
| 219 <b>on_sendButton_clicked</b>(<i></i>) | |
| 220 <p> | |
| 221 Private slot to send the input to the subversion process. | |
| 222 </p><a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a> | |
| 223 <h4>HgDialog.startProcess</h4> | |
| 224 <b>startProcess</b>(<i>args, workingDir = None</i>) | |
| 225 <p> | |
| 226 Public slot used to start the process. | |
| 227 </p><dl> | |
| 228 <dt><i>args</i></dt> | |
| 229 <dd> | |
| 230 list of arguments for the process (list of strings) | |
| 231 </dd><dt><i>workingDir</i></dt> | |
| 232 <dd> | |
| 233 working directory for the process (string) | |
| 234 </dd> | |
| 235 </dl><dl> | |
| 236 <dt>Returns:</dt> | |
| 237 <dd> | |
| 238 flag indicating a successful start of the process | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <div align="right"><a href="#top">Up</a></div> | |
| 242 <hr /> | |
| 243 </body></html> |
