Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial