Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial