Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgDialog</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.vcsMercurial.HgDialog</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="#HgDialog">HgDialog</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="HgDialog" ID="HgDialog"></a> | |
| 36 <h2>HgDialog</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_HgDialog | |
| 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="#HgDialog.__init__">HgDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#HgDialog.__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="#HgDialog.__getInput">__getInput</a></td> | |
| 72 <td>Private method to get some input from the user.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#HgDialog.__showError">__showError</a></td> | |
| 76 <td>Private slot to show some error.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#HgDialog.__showOutput">__showOutput</a></td> | |
| 80 <td>Private slot to show some output.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#HgDialog.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="#HgDialog.normalExit">normalExit</a></td> | |
| 88 <td>Public method to check for a normal process termination.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HgDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> | |
| 92 <td>Public method to check for a normal process termination without error messages.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HgDialog.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="#HgDialog.startProcess">startProcess</a></td> | |
| 100 <td>Public slot used to start the process.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <h3>Static Methods</h3> | |
| 104 | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 <a NAME="HgDialog.__init__" ID="HgDialog.__init__"></a> | |
| 110 <h4>HgDialog (Constructor)</h4> | |
| 111 <b>HgDialog</b>(<i>text, hg=None, useClient=True, parent=None</i>) | |
| 112 | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 <dl> | |
| 117 | |
| 118 <dt><i>text</i></dt> | |
| 119 <dd> | |
| 120 text to be shown by the label (string) | |
| 121 </dd> | |
| 122 <dt><i>hg</i></dt> | |
| 123 <dd> | |
| 124 reference to the Mercurial interface object (Hg) | |
| 125 </dd> | |
| 126 <dt><i>useClient</i></dt> | |
| 127 <dd> | |
| 128 flag indicating to use the command server client | |
| 129 if possible (boolean) | |
| 130 </dd> | |
| 131 <dt><i>parent</i></dt> | |
| 132 <dd> | |
| 133 parent widget (QWidget) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a> | |
| 137 <h4>HgDialog.__finish</h4> | |
| 138 <b>__finish</b>(<i></i>) | |
| 139 | |
| 140 <p> | |
| 141 Private slot called when the process finished or the user pressed | |
| 142 the button. | |
| 143 </p> | |
| 144 <a NAME="HgDialog.__getInput" ID="HgDialog.__getInput"></a> | |
| 145 <h4>HgDialog.__getInput</h4> | |
| 146 <b>__getInput</b>(<i>size, message</i>) | |
| 147 | |
| 148 <p> | |
| 149 Private method to get some input from the user. | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>size</i> (int)</dt> | |
| 154 <dd> | |
| 155 maximum length of the requested input | |
| 156 </dd> | |
| 157 <dt><i>message</i> (str)</dt> | |
| 158 <dd> | |
| 159 message sent by the server | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return:</dt> | |
| 164 <dd> | |
| 165 tuple containing data entered by the user and | |
| 166 a flag indicating a password input | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <dl> | |
| 170 <dt>Return Type:</dt> | |
| 171 <dd> | |
| 172 tuple of (str, bool) | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <a NAME="HgDialog.__showError" ID="HgDialog.__showError"></a> | |
| 176 <h4>HgDialog.__showError</h4> | |
| 177 <b>__showError</b>(<i>out</i>) | |
| 178 | |
| 179 <p> | |
| 180 Private slot to show some error. | |
| 181 </p> | |
| 182 <dl> | |
| 183 | |
| 184 <dt><i>out</i></dt> | |
| 185 <dd> | |
| 186 error to be shown (string) | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="HgDialog.__showOutput" ID="HgDialog.__showOutput"></a> | |
| 190 <h4>HgDialog.__showOutput</h4> | |
| 191 <b>__showOutput</b>(<i>out</i>) | |
| 192 | |
| 193 <p> | |
| 194 Private slot to show some output. | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>out</i></dt> | |
| 199 <dd> | |
| 200 output to be shown (string) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a> | |
| 204 <h4>HgDialog.hasAddOrDelete</h4> | |
| 205 <b>hasAddOrDelete</b>(<i></i>) | |
| 206 | |
| 207 <p> | |
| 208 Public method to check, if the last action contained an add or delete. | |
| 209 </p> | |
| 210 <dl> | |
| 211 <dt>Return:</dt> | |
| 212 <dd> | |
| 213 flag indicating the presence of an add or delete (boolean) | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a> | |
| 217 <h4>HgDialog.normalExit</h4> | |
| 218 <b>normalExit</b>(<i></i>) | |
| 219 | |
| 220 <p> | |
| 221 Public method to check for a normal process termination. | |
| 222 </p> | |
| 223 <dl> | |
| 224 <dt>Return:</dt> | |
| 225 <dd> | |
| 226 flag indicating normal process termination (boolean) | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a> | |
| 230 <h4>HgDialog.normalExitWithoutErrors</h4> | |
| 231 <b>normalExitWithoutErrors</b>(<i></i>) | |
| 232 | |
| 233 <p> | |
| 234 Public method to check for a normal process termination without | |
| 235 error messages. | |
| 236 </p> | |
| 237 <dl> | |
| 238 <dt>Return:</dt> | |
| 239 <dd> | |
| 240 flag indicating normal process termination (boolean) | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a> | |
| 244 <h4>HgDialog.on_buttonBox_clicked</h4> | |
| 245 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 246 | |
| 247 <p> | |
| 248 Private slot called by a button of the button box clicked. | |
| 249 </p> | |
| 250 <dl> | |
| 251 | |
| 252 <dt><i>button</i></dt> | |
| 253 <dd> | |
| 254 button that was clicked (QAbstractButton) | |
| 255 </dd> | |
| 256 </dl> | |
| 257 <a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a> | |
| 258 <h4>HgDialog.startProcess</h4> | |
| 259 <b>startProcess</b>(<i>args, showArgs=True, environment=None, client=None</i>) | |
| 260 | |
| 261 <p> | |
| 262 Public slot used to start the process. | |
| 263 </p> | |
| 264 <dl> | |
| 265 | |
| 266 <dt><i>args</i> (list of str)</dt> | |
| 267 <dd> | |
| 268 list of arguments for the process | |
| 269 </dd> | |
| 270 <dt><i>showArgs</i> (bool)</dt> | |
| 271 <dd> | |
| 272 flag indicating to show the arguments | |
| 273 </dd> | |
| 274 <dt><i>environment</i> (dict)</dt> | |
| 275 <dd> | |
| 276 dictionary of environment settings to add | |
| 277 or change for the git process | |
| 278 </dd> | |
| 279 <dt><i>client</i> (HgClient)</dt> | |
| 280 <dd> | |
| 281 reference to a non-standard command client | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <dl> | |
| 285 <dt>Return:</dt> | |
| 286 <dd> | |
| 287 flag indicating a successful start of the process | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <dl> | |
| 291 <dt>Return Type:</dt> | |
| 292 <dd> | |
| 293 bool | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /> | |
| 298 </body></html> |
