Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial