Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog.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.vcsGit.GitReflogBrowserDialog</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.vcsGit.GitReflogBrowserDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to browse the reflog history. | |
| 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="#GitReflogBrowserDialog">GitReflogBrowserDialog</a></td> | |
| 25 <td>Class implementing a dialog to browse the reflog history.</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="GitReflogBrowserDialog" ID="GitReflogBrowserDialog"></a> | |
| 36 <h2>GitReflogBrowserDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to browse the reflog history. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QWidget, Ui_GitReflogBrowserDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>CommitIdColumn</td></tr><tr><td>NameColumn</td></tr><tr><td>OperationColumn</td></tr><tr><td>SelectorColumn</td></tr><tr><td>SubjectColumn</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#GitReflogBrowserDialog.__init__">GitReflogBrowserDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitReflogBrowserDialog.__finish">__finish</a></td> | |
| 63 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitReflogBrowserDialog.__generateReflogItem">__generateReflogItem</a></td> | |
| 67 <td>Private method to generate a reflog tree entry.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitReflogBrowserDialog.__getReflogEntries">__getReflogEntries</a></td> | |
| 71 <td>Private method to retrieve reflog entries from the repository.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitReflogBrowserDialog.__initData">__initData</a></td> | |
| 75 <td>Private method to (re-)initialize some data.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitReflogBrowserDialog.__procFinished">__procFinished</a></td> | |
| 79 <td>Private slot connected to the finished signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitReflogBrowserDialog.__processBuffer">__processBuffer</a></td> | |
| 83 <td>Private method to process the buffered output of the git log command.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitReflogBrowserDialog.__readStderr">__readStderr</a></td> | |
| 87 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitReflogBrowserDialog.__readStdout">__readStdout</a></td> | |
| 91 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitReflogBrowserDialog.__resetUI">__resetUI</a></td> | |
| 95 <td>Private method to reset the user interface.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GitReflogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td> | |
| 99 <td>Private method to resize the log tree columns.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GitReflogBrowserDialog.__showError">__showError</a></td> | |
| 103 <td>Private slot to show some error.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GitReflogBrowserDialog.closeEvent">closeEvent</a></td> | |
| 107 <td>Protected slot implementing a close event handler.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#GitReflogBrowserDialog.keyPressEvent">keyPressEvent</a></td> | |
| 111 <td>Protected slot to handle a key press event.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#GitReflogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 115 <td>Private slot called by a button of the button box clicked.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#GitReflogBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 119 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#GitReflogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td> | |
| 123 <td>Private slot to handle the Next button.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#GitReflogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 127 <td>Private slot to handle the password checkbox toggled.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#GitReflogBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 131 <td>Private slot to refresh the log.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#GitReflogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 135 <td>Private slot to send the input to the git process.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#GitReflogBrowserDialog.show">show</a></td> | |
| 139 <td>Public slot to show the dialog.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#GitReflogBrowserDialog.start">start</a></td> | |
| 143 <td>Public slot to start the git log command.</td> | |
| 144 </tr> | |
| 145 </table> | |
| 146 <h3>Static Methods</h3> | |
| 147 | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 | |
| 152 <a NAME="GitReflogBrowserDialog.__init__" ID="GitReflogBrowserDialog.__init__"></a> | |
| 153 <h4>GitReflogBrowserDialog (Constructor)</h4> | |
| 154 <b>GitReflogBrowserDialog</b>(<i>vcs, parent=None</i>) | |
| 155 | |
| 156 <p> | |
| 157 Constructor | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>vcs</i></dt> | |
| 162 <dd> | |
| 163 reference to the vcs object | |
| 164 </dd> | |
| 165 <dt><i>parent</i></dt> | |
| 166 <dd> | |
| 167 reference to the parent widget (QWidget) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="GitReflogBrowserDialog.__finish" ID="GitReflogBrowserDialog.__finish"></a> | |
| 171 <h4>GitReflogBrowserDialog.__finish</h4> | |
| 172 <b>__finish</b>(<i></i>) | |
| 173 | |
| 174 <p> | |
| 175 Private slot called when the process finished or the user pressed | |
| 176 the button. | |
| 177 </p> | |
| 178 <a NAME="GitReflogBrowserDialog.__generateReflogItem" ID="GitReflogBrowserDialog.__generateReflogItem"></a> | |
| 179 <h4>GitReflogBrowserDialog.__generateReflogItem</h4> | |
| 180 <b>__generateReflogItem</b>(<i>commitId, selector, name, subject</i>) | |
| 181 | |
| 182 <p> | |
| 183 Private method to generate a reflog tree entry. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>commitId</i></dt> | |
| 188 <dd> | |
| 189 commit id info (string) | |
| 190 </dd> | |
| 191 <dt><i>selector</i></dt> | |
| 192 <dd> | |
| 193 selector info (string) | |
| 194 </dd> | |
| 195 <dt><i>name</i></dt> | |
| 196 <dd> | |
| 197 name info (string) | |
| 198 </dd> | |
| 199 <dt><i>subject</i></dt> | |
| 200 <dd> | |
| 201 subject of the reflog entry (string) | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <dl> | |
| 205 <dt>Return:</dt> | |
| 206 <dd> | |
| 207 reference to the generated item (QTreeWidgetItem) | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="GitReflogBrowserDialog.__getReflogEntries" ID="GitReflogBrowserDialog.__getReflogEntries"></a> | |
| 211 <h4>GitReflogBrowserDialog.__getReflogEntries</h4> | |
| 212 <b>__getReflogEntries</b>(<i>skip=0</i>) | |
| 213 | |
| 214 <p> | |
| 215 Private method to retrieve reflog entries from the repository. | |
| 216 </p> | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>skip</i></dt> | |
| 220 <dd> | |
| 221 number of reflog entries to skip (integer) | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="GitReflogBrowserDialog.__initData" ID="GitReflogBrowserDialog.__initData"></a> | |
| 225 <h4>GitReflogBrowserDialog.__initData</h4> | |
| 226 <b>__initData</b>(<i></i>) | |
| 227 | |
| 228 <p> | |
| 229 Private method to (re-)initialize some data. | |
| 230 </p> | |
| 231 <a NAME="GitReflogBrowserDialog.__procFinished" ID="GitReflogBrowserDialog.__procFinished"></a> | |
| 232 <h4>GitReflogBrowserDialog.__procFinished</h4> | |
| 233 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 234 | |
| 235 <p> | |
| 236 Private slot connected to the finished signal. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>exitCode</i></dt> | |
| 241 <dd> | |
| 242 exit code of the process (integer) | |
| 243 </dd> | |
| 244 <dt><i>exitStatus</i></dt> | |
| 245 <dd> | |
| 246 exit status of the process (QProcess.ExitStatus) | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <a NAME="GitReflogBrowserDialog.__processBuffer" ID="GitReflogBrowserDialog.__processBuffer"></a> | |
| 250 <h4>GitReflogBrowserDialog.__processBuffer</h4> | |
| 251 <b>__processBuffer</b>(<i></i>) | |
| 252 | |
| 253 <p> | |
| 254 Private method to process the buffered output of the git log command. | |
| 255 </p> | |
| 256 <a NAME="GitReflogBrowserDialog.__readStderr" ID="GitReflogBrowserDialog.__readStderr"></a> | |
| 257 <h4>GitReflogBrowserDialog.__readStderr</h4> | |
| 258 <b>__readStderr</b>(<i></i>) | |
| 259 | |
| 260 <p> | |
| 261 Private slot to handle the readyReadStandardError signal. | |
| 262 </p> | |
| 263 <p> | |
| 264 It reads the error output of the process and inserts it into the | |
| 265 error pane. | |
| 266 </p> | |
| 267 <a NAME="GitReflogBrowserDialog.__readStdout" ID="GitReflogBrowserDialog.__readStdout"></a> | |
| 268 <h4>GitReflogBrowserDialog.__readStdout</h4> | |
| 269 <b>__readStdout</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Private slot to handle the readyReadStandardOutput signal. | |
| 273 </p> | |
| 274 <p> | |
| 275 It reads the output of the process and inserts it into a buffer. | |
| 276 </p> | |
| 277 <a NAME="GitReflogBrowserDialog.__resetUI" ID="GitReflogBrowserDialog.__resetUI"></a> | |
| 278 <h4>GitReflogBrowserDialog.__resetUI</h4> | |
| 279 <b>__resetUI</b>(<i></i>) | |
| 280 | |
| 281 <p> | |
| 282 Private method to reset the user interface. | |
| 283 </p> | |
| 284 <a NAME="GitReflogBrowserDialog.__resizeColumnsLog" ID="GitReflogBrowserDialog.__resizeColumnsLog"></a> | |
| 285 <h4>GitReflogBrowserDialog.__resizeColumnsLog</h4> | |
| 286 <b>__resizeColumnsLog</b>(<i></i>) | |
| 287 | |
| 288 <p> | |
| 289 Private method to resize the log tree columns. | |
| 290 </p> | |
| 291 <a NAME="GitReflogBrowserDialog.__showError" ID="GitReflogBrowserDialog.__showError"></a> | |
| 292 <h4>GitReflogBrowserDialog.__showError</h4> | |
| 293 <b>__showError</b>(<i>out</i>) | |
| 294 | |
| 295 <p> | |
| 296 Private slot to show some error. | |
| 297 </p> | |
| 298 <dl> | |
| 299 | |
| 300 <dt><i>out</i></dt> | |
| 301 <dd> | |
| 302 error to be shown (string) | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <a NAME="GitReflogBrowserDialog.closeEvent" ID="GitReflogBrowserDialog.closeEvent"></a> | |
| 306 <h4>GitReflogBrowserDialog.closeEvent</h4> | |
| 307 <b>closeEvent</b>(<i>e</i>) | |
| 308 | |
| 309 <p> | |
| 310 Protected slot implementing a close event handler. | |
| 311 </p> | |
| 312 <dl> | |
| 313 | |
| 314 <dt><i>e</i></dt> | |
| 315 <dd> | |
| 316 close event (QCloseEvent) | |
| 317 </dd> | |
| 318 </dl> | |
| 319 <a NAME="GitReflogBrowserDialog.keyPressEvent" ID="GitReflogBrowserDialog.keyPressEvent"></a> | |
| 320 <h4>GitReflogBrowserDialog.keyPressEvent</h4> | |
| 321 <b>keyPressEvent</b>(<i>evt</i>) | |
| 322 | |
| 323 <p> | |
| 324 Protected slot to handle a key press event. | |
| 325 </p> | |
| 326 <dl> | |
| 327 | |
| 328 <dt><i>evt</i></dt> | |
| 329 <dd> | |
| 330 the key press event (QKeyEvent) | |
| 331 </dd> | |
| 332 </dl> | |
| 333 <a NAME="GitReflogBrowserDialog.on_buttonBox_clicked" ID="GitReflogBrowserDialog.on_buttonBox_clicked"></a> | |
| 334 <h4>GitReflogBrowserDialog.on_buttonBox_clicked</h4> | |
| 335 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 336 | |
| 337 <p> | |
| 338 Private slot called by a button of the button box clicked. | |
| 339 </p> | |
| 340 <dl> | |
| 341 | |
| 342 <dt><i>button</i></dt> | |
| 343 <dd> | |
| 344 button that was clicked (QAbstractButton) | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <a NAME="GitReflogBrowserDialog.on_input_returnPressed" ID="GitReflogBrowserDialog.on_input_returnPressed"></a> | |
| 348 <h4>GitReflogBrowserDialog.on_input_returnPressed</h4> | |
| 349 <b>on_input_returnPressed</b>(<i></i>) | |
| 350 | |
| 351 <p> | |
| 352 Private slot to handle the press of the return key in the input field. | |
| 353 </p> | |
| 354 <a NAME="GitReflogBrowserDialog.on_nextButton_clicked" ID="GitReflogBrowserDialog.on_nextButton_clicked"></a> | |
| 355 <h4>GitReflogBrowserDialog.on_nextButton_clicked</h4> | |
| 356 <b>on_nextButton_clicked</b>(<i></i>) | |
| 357 | |
| 358 <p> | |
| 359 Private slot to handle the Next button. | |
| 360 </p> | |
| 361 <a NAME="GitReflogBrowserDialog.on_passwordCheckBox_toggled" ID="GitReflogBrowserDialog.on_passwordCheckBox_toggled"></a> | |
| 362 <h4>GitReflogBrowserDialog.on_passwordCheckBox_toggled</h4> | |
| 363 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 364 | |
| 365 <p> | |
| 366 Private slot to handle the password checkbox toggled. | |
| 367 </p> | |
| 368 <dl> | |
| 369 | |
| 370 <dt><i>isOn</i></dt> | |
| 371 <dd> | |
| 372 flag indicating the status of the check box (boolean) | |
| 373 </dd> | |
| 374 </dl> | |
| 375 <a NAME="GitReflogBrowserDialog.on_refreshButton_clicked" ID="GitReflogBrowserDialog.on_refreshButton_clicked"></a> | |
| 376 <h4>GitReflogBrowserDialog.on_refreshButton_clicked</h4> | |
| 377 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 378 | |
| 379 <p> | |
| 380 Private slot to refresh the log. | |
| 381 </p> | |
| 382 <a NAME="GitReflogBrowserDialog.on_sendButton_clicked" ID="GitReflogBrowserDialog.on_sendButton_clicked"></a> | |
| 383 <h4>GitReflogBrowserDialog.on_sendButton_clicked</h4> | |
| 384 <b>on_sendButton_clicked</b>(<i></i>) | |
| 385 | |
| 386 <p> | |
| 387 Private slot to send the input to the git process. | |
| 388 </p> | |
| 389 <a NAME="GitReflogBrowserDialog.show" ID="GitReflogBrowserDialog.show"></a> | |
| 390 <h4>GitReflogBrowserDialog.show</h4> | |
| 391 <b>show</b>(<i></i>) | |
| 392 | |
| 393 <p> | |
| 394 Public slot to show the dialog. | |
| 395 </p> | |
| 396 <a NAME="GitReflogBrowserDialog.start" ID="GitReflogBrowserDialog.start"></a> | |
| 397 <h4>GitReflogBrowserDialog.start</h4> | |
| 398 <b>start</b>(<i>projectdir</i>) | |
| 399 | |
| 400 <p> | |
| 401 Public slot to start the git log command. | |
| 402 </p> | |
| 403 <dl> | |
| 404 | |
| 405 <dt><i>projectdir</i></dt> | |
| 406 <dd> | |
| 407 directory name of the project (string) | |
| 408 </dd> | |
| 409 </dl> | |
| 410 <div align="right"><a href="#top">Up</a></div> | |
| 411 <hr /> | |
| 412 </body></html> |
