Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9421
- 989ee2535d59
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitBlameDialog</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.GitBlameDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the output of git blame. | |
| 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="#GitBlameDialog">GitBlameDialog</a></td> | |
| 25 <td>Class implementing a dialog to show the output of git blame.</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="GitBlameDialog" ID="GitBlameDialog"></a> | |
| 36 <h2>GitBlameDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show the output of git blame. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_GitBlameDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</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="#GitBlameDialog.__init__">GitBlameDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitBlameDialog.__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="#GitBlameDialog.__generateItem">__generateItem</a></td> | |
| 67 <td>Private method to generate a blame item in the annotation list.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitBlameDialog.__procFinished">__procFinished</a></td> | |
| 71 <td>Private slot connected to the finished signal.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitBlameDialog.__readStderr">__readStderr</a></td> | |
| 75 <td>Private slot to handle the readyReadStderr signal.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitBlameDialog.__readStdout">__readStdout</a></td> | |
| 79 <td>Private slot to handle the readyReadStdout signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitBlameDialog.__resizeColumns">__resizeColumns</a></td> | |
| 83 <td>Private method to resize the list columns.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitBlameDialog.closeEvent">closeEvent</a></td> | |
| 87 <td>Protected slot implementing a close event handler.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitBlameDialog.keyPressEvent">keyPressEvent</a></td> | |
| 91 <td>Protected slot to handle a key press event.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitBlameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 95 <td>Private slot called by a button of the button box clicked.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GitBlameDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 99 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GitBlameDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 103 <td>Private slot to handle the password checkbox toggled.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GitBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 107 <td>Private slot to send the input to the git process.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#GitBlameDialog.start">start</a></td> | |
| 111 <td>Public slot to start the blame command.</td> | |
| 112 </tr> | |
| 113 </table> | |
| 114 <h3>Static Methods</h3> | |
| 115 | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 | |
| 120 <a NAME="GitBlameDialog.__init__" ID="GitBlameDialog.__init__"></a> | |
| 121 <h4>GitBlameDialog (Constructor)</h4> | |
| 122 <b>GitBlameDialog</b>(<i>vcs, parent=None</i>) | |
| 123 | |
| 124 <p> | |
| 125 Constructor | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>vcs</i></dt> | |
| 130 <dd> | |
| 131 reference to the vcs object | |
| 132 </dd> | |
| 133 <dt><i>parent</i></dt> | |
| 134 <dd> | |
| 135 reference to the parent widget (QWidget) | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="GitBlameDialog.__finish" ID="GitBlameDialog.__finish"></a> | |
| 139 <h4>GitBlameDialog.__finish</h4> | |
| 140 <b>__finish</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Private slot called when the process finished or the user pressed | |
| 144 the button. | |
| 145 </p> | |
| 146 <a NAME="GitBlameDialog.__generateItem" ID="GitBlameDialog.__generateItem"></a> | |
| 147 <h4>GitBlameDialog.__generateItem</h4> | |
| 148 <b>__generateItem</b>(<i>commitId, author, date, time, lineno, text</i>) | |
| 149 | |
| 150 <p> | |
| 151 Private method to generate a blame item in the annotation list. | |
| 152 </p> | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>commitId</i></dt> | |
| 156 <dd> | |
| 157 commit identifier (string) | |
| 158 </dd> | |
| 159 <dt><i>author</i></dt> | |
| 160 <dd> | |
| 161 author of the change (string) | |
| 162 </dd> | |
| 163 <dt><i>date</i></dt> | |
| 164 <dd> | |
| 165 date of the change (string) | |
| 166 </dd> | |
| 167 <dt><i>time</i></dt> | |
| 168 <dd> | |
| 169 time of the change (string) | |
| 170 </dd> | |
| 171 <dt><i>lineno</i></dt> | |
| 172 <dd> | |
| 173 line number of the change (string) | |
| 174 </dd> | |
| 175 <dt><i>text</i></dt> | |
| 176 <dd> | |
| 177 name (path) of the tag (string) | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <a NAME="GitBlameDialog.__procFinished" ID="GitBlameDialog.__procFinished"></a> | |
| 181 <h4>GitBlameDialog.__procFinished</h4> | |
| 182 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 183 | |
| 184 <p> | |
| 185 Private slot connected to the finished signal. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>exitCode</i></dt> | |
| 190 <dd> | |
| 191 exit code of the process (integer) | |
| 192 </dd> | |
| 193 <dt><i>exitStatus</i></dt> | |
| 194 <dd> | |
| 195 exit status of the process (QProcess.ExitStatus) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="GitBlameDialog.__readStderr" ID="GitBlameDialog.__readStderr"></a> | |
| 199 <h4>GitBlameDialog.__readStderr</h4> | |
| 200 <b>__readStderr</b>(<i></i>) | |
| 201 | |
| 202 <p> | |
| 203 Private slot to handle the readyReadStderr signal. | |
| 204 </p> | |
| 205 <p> | |
| 206 It reads the error output of the process and inserts it into the | |
| 207 error pane. | |
| 208 </p> | |
| 209 <a NAME="GitBlameDialog.__readStdout" ID="GitBlameDialog.__readStdout"></a> | |
| 210 <h4>GitBlameDialog.__readStdout</h4> | |
| 211 <b>__readStdout</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Private slot to handle the readyReadStdout signal. | |
| 215 </p> | |
| 216 <p> | |
| 217 It reads the output of the process, formats it and inserts it into | |
| 218 the annotation list. | |
| 219 </p> | |
| 220 <a NAME="GitBlameDialog.__resizeColumns" ID="GitBlameDialog.__resizeColumns"></a> | |
| 221 <h4>GitBlameDialog.__resizeColumns</h4> | |
| 222 <b>__resizeColumns</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Private method to resize the list columns. | |
| 226 </p> | |
| 227 <a NAME="GitBlameDialog.closeEvent" ID="GitBlameDialog.closeEvent"></a> | |
| 228 <h4>GitBlameDialog.closeEvent</h4> | |
| 229 <b>closeEvent</b>(<i>e</i>) | |
| 230 | |
| 231 <p> | |
| 232 Protected slot implementing a close event handler. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>e</i></dt> | |
| 237 <dd> | |
| 238 close event (QCloseEvent) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="GitBlameDialog.keyPressEvent" ID="GitBlameDialog.keyPressEvent"></a> | |
| 242 <h4>GitBlameDialog.keyPressEvent</h4> | |
| 243 <b>keyPressEvent</b>(<i>evt</i>) | |
| 244 | |
| 245 <p> | |
| 246 Protected slot to handle a key press event. | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>evt</i></dt> | |
| 251 <dd> | |
| 252 the key press event (QKeyEvent) | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <a NAME="GitBlameDialog.on_buttonBox_clicked" ID="GitBlameDialog.on_buttonBox_clicked"></a> | |
| 256 <h4>GitBlameDialog.on_buttonBox_clicked</h4> | |
| 257 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 258 | |
| 259 <p> | |
| 260 Private slot called by a button of the button box clicked. | |
| 261 </p> | |
| 262 <dl> | |
| 263 | |
| 264 <dt><i>button</i></dt> | |
| 265 <dd> | |
| 266 button that was clicked (QAbstractButton) | |
| 267 </dd> | |
| 268 </dl> | |
| 269 <a NAME="GitBlameDialog.on_input_returnPressed" ID="GitBlameDialog.on_input_returnPressed"></a> | |
| 270 <h4>GitBlameDialog.on_input_returnPressed</h4> | |
| 271 <b>on_input_returnPressed</b>(<i></i>) | |
| 272 | |
| 273 <p> | |
| 274 Private slot to handle the press of the return key in the input field. | |
| 275 </p> | |
| 276 <a NAME="GitBlameDialog.on_passwordCheckBox_toggled" ID="GitBlameDialog.on_passwordCheckBox_toggled"></a> | |
| 277 <h4>GitBlameDialog.on_passwordCheckBox_toggled</h4> | |
| 278 <b>on_passwordCheckBox_toggled</b>(<i>checked</i>) | |
| 279 | |
| 280 <p> | |
| 281 Private slot to handle the password checkbox toggled. | |
| 282 </p> | |
| 283 <dl> | |
| 284 | |
| 285 <dt><i>checked</i></dt> | |
| 286 <dd> | |
| 287 flag indicating the status of the check box (boolean) | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <a NAME="GitBlameDialog.on_sendButton_clicked" ID="GitBlameDialog.on_sendButton_clicked"></a> | |
| 291 <h4>GitBlameDialog.on_sendButton_clicked</h4> | |
| 292 <b>on_sendButton_clicked</b>(<i></i>) | |
| 293 | |
| 294 <p> | |
| 295 Private slot to send the input to the git process. | |
| 296 </p> | |
| 297 <a NAME="GitBlameDialog.start" ID="GitBlameDialog.start"></a> | |
| 298 <h4>GitBlameDialog.start</h4> | |
| 299 <b>start</b>(<i>fn</i>) | |
| 300 | |
| 301 <p> | |
| 302 Public slot to start the blame command. | |
| 303 </p> | |
| 304 <dl> | |
| 305 | |
| 306 <dt><i>fn</i></dt> | |
| 307 <dd> | |
| 308 filename to show the blame for (string) | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <div align="right"><a href="#top">Up</a></div> | |
| 312 <hr /> | |
| 313 </body></html> |
