Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html

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

Mercurial Repository: eric

eric ide

mercurial