src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to browse the reflog history. 11 Module implementing a dialog to browse the reflog history.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitReflogBrowserDialog">GitReflogBrowserDialog</a></td> 22 <td><a href="#GitReflogBrowserDialog">GitReflogBrowserDialog</a></td>
25 <td>Class implementing a dialog to browse the reflog history.</td> 23 <td>Class implementing a dialog to browse the reflog history.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitReflogBrowserDialog" ID="GitReflogBrowserDialog"></a> 34 <a NAME="GitReflogBrowserDialog" ID="GitReflogBrowserDialog"></a>
36 <h2>GitReflogBrowserDialog</h2> 35 <h2>GitReflogBrowserDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to browse the reflog history. 37 Class implementing a dialog to browse the reflog history.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QWidget, Ui_GitReflogBrowserDialog 41 QWidget, Ui_GitReflogBrowserDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>CommitIdColumn</td></tr>
46 <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> 45 <tr><td>NameColumn</td></tr>
47 </table> 46 <tr><td>OperationColumn</td></tr>
47 <tr><td>SelectorColumn</td></tr>
48 <tr><td>SubjectColumn</td></tr>
49 </table>
50
48 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
49
50 <table> 52 <table>
51 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
52 </table> 54 </table>
55
53 <h3>Methods</h3> 56 <h3>Methods</h3>
54 57 <table>
55 <table>
56
57 <tr> 58 <tr>
58 <td><a href="#GitReflogBrowserDialog.__init__">GitReflogBrowserDialog</a></td> 59 <td><a href="#GitReflogBrowserDialog.__init__">GitReflogBrowserDialog</a></td>
59 <td>Constructor</td> 60 <td>Constructor</td>
60 </tr> 61 </tr>
61 <tr> 62 <tr>
141 <tr> 142 <tr>
142 <td><a href="#GitReflogBrowserDialog.start">start</a></td> 143 <td><a href="#GitReflogBrowserDialog.start">start</a></td>
143 <td>Public slot to start the git log command.</td> 144 <td>Public slot to start the git log command.</td>
144 </tr> 145 </tr>
145 </table> 146 </table>
147
146 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
147
148 <table> 149 <table>
149 <tr><td>None</td></tr> 150 <tr><td>None</td></tr>
150 </table> 151 </table>
152
151 153
152 <a NAME="GitReflogBrowserDialog.__init__" ID="GitReflogBrowserDialog.__init__"></a> 154 <a NAME="GitReflogBrowserDialog.__init__" ID="GitReflogBrowserDialog.__init__"></a>
153 <h4>GitReflogBrowserDialog (Constructor)</h4> 155 <h4>GitReflogBrowserDialog (Constructor)</h4>
154 <b>GitReflogBrowserDialog</b>(<i>vcs, parent=None</i>) 156 <b>GitReflogBrowserDialog</b>(<i>vcs, parent=None</i>)
155
156 <p> 157 <p>
157 Constructor 158 Constructor
158 </p> 159 </p>
160
159 <dl> 161 <dl>
160 162
161 <dt><i>vcs</i> (Git)</dt> 163 <dt><i>vcs</i> (Git)</dt>
162 <dd> 164 <dd>
163 reference to the vcs object 165 reference to the vcs object
168 </dd> 170 </dd>
169 </dl> 171 </dl>
170 <a NAME="GitReflogBrowserDialog.__finish" ID="GitReflogBrowserDialog.__finish"></a> 172 <a NAME="GitReflogBrowserDialog.__finish" ID="GitReflogBrowserDialog.__finish"></a>
171 <h4>GitReflogBrowserDialog.__finish</h4> 173 <h4>GitReflogBrowserDialog.__finish</h4>
172 <b>__finish</b>(<i></i>) 174 <b>__finish</b>(<i></i>)
173
174 <p> 175 <p>
175 Private slot called when the process finished or the user pressed 176 Private slot called when the process finished or the user pressed
176 the button. 177 the button.
177 </p> 178 </p>
179
178 <a NAME="GitReflogBrowserDialog.__generateReflogItem" ID="GitReflogBrowserDialog.__generateReflogItem"></a> 180 <a NAME="GitReflogBrowserDialog.__generateReflogItem" ID="GitReflogBrowserDialog.__generateReflogItem"></a>
179 <h4>GitReflogBrowserDialog.__generateReflogItem</h4> 181 <h4>GitReflogBrowserDialog.__generateReflogItem</h4>
180 <b>__generateReflogItem</b>(<i>commitId, selector, name, subject</i>) 182 <b>__generateReflogItem</b>(<i>commitId, selector, name, subject</i>)
181
182 <p> 183 <p>
183 Private method to generate a reflog tree entry. 184 Private method to generate a reflog tree entry.
184 </p> 185 </p>
186
185 <dl> 187 <dl>
186 188
187 <dt><i>commitId</i> (str)</dt> 189 <dt><i>commitId</i> (str)</dt>
188 <dd> 190 <dd>
189 commit id info 191 commit id info
214 </dd> 216 </dd>
215 </dl> 217 </dl>
216 <a NAME="GitReflogBrowserDialog.__getReflogEntries" ID="GitReflogBrowserDialog.__getReflogEntries"></a> 218 <a NAME="GitReflogBrowserDialog.__getReflogEntries" ID="GitReflogBrowserDialog.__getReflogEntries"></a>
217 <h4>GitReflogBrowserDialog.__getReflogEntries</h4> 219 <h4>GitReflogBrowserDialog.__getReflogEntries</h4>
218 <b>__getReflogEntries</b>(<i>skip=0</i>) 220 <b>__getReflogEntries</b>(<i>skip=0</i>)
219
220 <p> 221 <p>
221 Private method to retrieve reflog entries from the repository. 222 Private method to retrieve reflog entries from the repository.
222 </p> 223 </p>
224
223 <dl> 225 <dl>
224 226
225 <dt><i>skip</i> (int)</dt> 227 <dt><i>skip</i> (int)</dt>
226 <dd> 228 <dd>
227 number of reflog entries to skip 229 number of reflog entries to skip
228 </dd> 230 </dd>
229 </dl> 231 </dl>
230 <a NAME="GitReflogBrowserDialog.__initData" ID="GitReflogBrowserDialog.__initData"></a> 232 <a NAME="GitReflogBrowserDialog.__initData" ID="GitReflogBrowserDialog.__initData"></a>
231 <h4>GitReflogBrowserDialog.__initData</h4> 233 <h4>GitReflogBrowserDialog.__initData</h4>
232 <b>__initData</b>(<i></i>) 234 <b>__initData</b>(<i></i>)
233
234 <p> 235 <p>
235 Private method to (re-)initialize some data. 236 Private method to (re-)initialize some data.
236 </p> 237 </p>
238
237 <a NAME="GitReflogBrowserDialog.__procFinished" ID="GitReflogBrowserDialog.__procFinished"></a> 239 <a NAME="GitReflogBrowserDialog.__procFinished" ID="GitReflogBrowserDialog.__procFinished"></a>
238 <h4>GitReflogBrowserDialog.__procFinished</h4> 240 <h4>GitReflogBrowserDialog.__procFinished</h4>
239 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 241 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
240
241 <p> 242 <p>
242 Private slot connected to the finished signal. 243 Private slot connected to the finished signal.
243 </p> 244 </p>
245
244 <dl> 246 <dl>
245 247
246 <dt><i>exitCode</i> (int)</dt> 248 <dt><i>exitCode</i> (int)</dt>
247 <dd> 249 <dd>
248 exit code of the process 250 exit code of the process
253 </dd> 255 </dd>
254 </dl> 256 </dl>
255 <a NAME="GitReflogBrowserDialog.__processBuffer" ID="GitReflogBrowserDialog.__processBuffer"></a> 257 <a NAME="GitReflogBrowserDialog.__processBuffer" ID="GitReflogBrowserDialog.__processBuffer"></a>
256 <h4>GitReflogBrowserDialog.__processBuffer</h4> 258 <h4>GitReflogBrowserDialog.__processBuffer</h4>
257 <b>__processBuffer</b>(<i></i>) 259 <b>__processBuffer</b>(<i></i>)
258
259 <p> 260 <p>
260 Private method to process the buffered output of the git log command. 261 Private method to process the buffered output of the git log command.
261 </p> 262 </p>
263
262 <a NAME="GitReflogBrowserDialog.__readStderr" ID="GitReflogBrowserDialog.__readStderr"></a> 264 <a NAME="GitReflogBrowserDialog.__readStderr" ID="GitReflogBrowserDialog.__readStderr"></a>
263 <h4>GitReflogBrowserDialog.__readStderr</h4> 265 <h4>GitReflogBrowserDialog.__readStderr</h4>
264 <b>__readStderr</b>(<i></i>) 266 <b>__readStderr</b>(<i></i>)
265
266 <p> 267 <p>
267 Private slot to handle the readyReadStandardError signal. 268 Private slot to handle the readyReadStandardError signal.
268 </p> 269 </p>
269 <p> 270 <p>
270 It reads the error output of the process and inserts it into the 271 It reads the error output of the process and inserts it into the
271 error pane. 272 error pane.
272 </p> 273 </p>
274
273 <a NAME="GitReflogBrowserDialog.__readStdout" ID="GitReflogBrowserDialog.__readStdout"></a> 275 <a NAME="GitReflogBrowserDialog.__readStdout" ID="GitReflogBrowserDialog.__readStdout"></a>
274 <h4>GitReflogBrowserDialog.__readStdout</h4> 276 <h4>GitReflogBrowserDialog.__readStdout</h4>
275 <b>__readStdout</b>(<i></i>) 277 <b>__readStdout</b>(<i></i>)
276
277 <p> 278 <p>
278 Private slot to handle the readyReadStandardOutput signal. 279 Private slot to handle the readyReadStandardOutput signal.
279 </p> 280 </p>
280 <p> 281 <p>
281 It reads the output of the process and inserts it into a buffer. 282 It reads the output of the process and inserts it into a buffer.
282 </p> 283 </p>
284
283 <a NAME="GitReflogBrowserDialog.__resetUI" ID="GitReflogBrowserDialog.__resetUI"></a> 285 <a NAME="GitReflogBrowserDialog.__resetUI" ID="GitReflogBrowserDialog.__resetUI"></a>
284 <h4>GitReflogBrowserDialog.__resetUI</h4> 286 <h4>GitReflogBrowserDialog.__resetUI</h4>
285 <b>__resetUI</b>(<i></i>) 287 <b>__resetUI</b>(<i></i>)
286
287 <p> 288 <p>
288 Private method to reset the user interface. 289 Private method to reset the user interface.
289 </p> 290 </p>
291
290 <a NAME="GitReflogBrowserDialog.__resizeColumnsLog" ID="GitReflogBrowserDialog.__resizeColumnsLog"></a> 292 <a NAME="GitReflogBrowserDialog.__resizeColumnsLog" ID="GitReflogBrowserDialog.__resizeColumnsLog"></a>
291 <h4>GitReflogBrowserDialog.__resizeColumnsLog</h4> 293 <h4>GitReflogBrowserDialog.__resizeColumnsLog</h4>
292 <b>__resizeColumnsLog</b>(<i></i>) 294 <b>__resizeColumnsLog</b>(<i></i>)
293
294 <p> 295 <p>
295 Private method to resize the log tree columns. 296 Private method to resize the log tree columns.
296 </p> 297 </p>
298
297 <a NAME="GitReflogBrowserDialog.__showError" ID="GitReflogBrowserDialog.__showError"></a> 299 <a NAME="GitReflogBrowserDialog.__showError" ID="GitReflogBrowserDialog.__showError"></a>
298 <h4>GitReflogBrowserDialog.__showError</h4> 300 <h4>GitReflogBrowserDialog.__showError</h4>
299 <b>__showError</b>(<i>out</i>) 301 <b>__showError</b>(<i>out</i>)
300
301 <p> 302 <p>
302 Private slot to show some error. 303 Private slot to show some error.
303 </p> 304 </p>
305
304 <dl> 306 <dl>
305 307
306 <dt><i>out</i> (str)</dt> 308 <dt><i>out</i> (str)</dt>
307 <dd> 309 <dd>
308 error to be shown 310 error to be shown
309 </dd> 311 </dd>
310 </dl> 312 </dl>
311 <a NAME="GitReflogBrowserDialog.closeEvent" ID="GitReflogBrowserDialog.closeEvent"></a> 313 <a NAME="GitReflogBrowserDialog.closeEvent" ID="GitReflogBrowserDialog.closeEvent"></a>
312 <h4>GitReflogBrowserDialog.closeEvent</h4> 314 <h4>GitReflogBrowserDialog.closeEvent</h4>
313 <b>closeEvent</b>(<i>e</i>) 315 <b>closeEvent</b>(<i>e</i>)
314
315 <p> 316 <p>
316 Protected slot implementing a close event handler. 317 Protected slot implementing a close event handler.
317 </p> 318 </p>
319
318 <dl> 320 <dl>
319 321
320 <dt><i>e</i> (QCloseEvent)</dt> 322 <dt><i>e</i> (QCloseEvent)</dt>
321 <dd> 323 <dd>
322 close event 324 close event
323 </dd> 325 </dd>
324 </dl> 326 </dl>
325 <a NAME="GitReflogBrowserDialog.keyPressEvent" ID="GitReflogBrowserDialog.keyPressEvent"></a> 327 <a NAME="GitReflogBrowserDialog.keyPressEvent" ID="GitReflogBrowserDialog.keyPressEvent"></a>
326 <h4>GitReflogBrowserDialog.keyPressEvent</h4> 328 <h4>GitReflogBrowserDialog.keyPressEvent</h4>
327 <b>keyPressEvent</b>(<i>evt</i>) 329 <b>keyPressEvent</b>(<i>evt</i>)
328
329 <p> 330 <p>
330 Protected slot to handle a key press event. 331 Protected slot to handle a key press event.
331 </p> 332 </p>
333
332 <dl> 334 <dl>
333 335
334 <dt><i>evt</i> (QKeyEvent)</dt> 336 <dt><i>evt</i> (QKeyEvent)</dt>
335 <dd> 337 <dd>
336 the key press event 338 the key press event
337 </dd> 339 </dd>
338 </dl> 340 </dl>
339 <a NAME="GitReflogBrowserDialog.on_buttonBox_clicked" ID="GitReflogBrowserDialog.on_buttonBox_clicked"></a> 341 <a NAME="GitReflogBrowserDialog.on_buttonBox_clicked" ID="GitReflogBrowserDialog.on_buttonBox_clicked"></a>
340 <h4>GitReflogBrowserDialog.on_buttonBox_clicked</h4> 342 <h4>GitReflogBrowserDialog.on_buttonBox_clicked</h4>
341 <b>on_buttonBox_clicked</b>(<i>button</i>) 343 <b>on_buttonBox_clicked</b>(<i>button</i>)
342
343 <p> 344 <p>
344 Private slot called by a button of the button box clicked. 345 Private slot called by a button of the button box clicked.
345 </p> 346 </p>
347
346 <dl> 348 <dl>
347 349
348 <dt><i>button</i> (QAbstractButton)</dt> 350 <dt><i>button</i> (QAbstractButton)</dt>
349 <dd> 351 <dd>
350 button that was clicked 352 button that was clicked
351 </dd> 353 </dd>
352 </dl> 354 </dl>
353 <a NAME="GitReflogBrowserDialog.on_input_returnPressed" ID="GitReflogBrowserDialog.on_input_returnPressed"></a> 355 <a NAME="GitReflogBrowserDialog.on_input_returnPressed" ID="GitReflogBrowserDialog.on_input_returnPressed"></a>
354 <h4>GitReflogBrowserDialog.on_input_returnPressed</h4> 356 <h4>GitReflogBrowserDialog.on_input_returnPressed</h4>
355 <b>on_input_returnPressed</b>(<i></i>) 357 <b>on_input_returnPressed</b>(<i></i>)
356
357 <p> 358 <p>
358 Private slot to handle the press of the return key in the input field. 359 Private slot to handle the press of the return key in the input field.
359 </p> 360 </p>
361
360 <a NAME="GitReflogBrowserDialog.on_nextButton_clicked" ID="GitReflogBrowserDialog.on_nextButton_clicked"></a> 362 <a NAME="GitReflogBrowserDialog.on_nextButton_clicked" ID="GitReflogBrowserDialog.on_nextButton_clicked"></a>
361 <h4>GitReflogBrowserDialog.on_nextButton_clicked</h4> 363 <h4>GitReflogBrowserDialog.on_nextButton_clicked</h4>
362 <b>on_nextButton_clicked</b>(<i></i>) 364 <b>on_nextButton_clicked</b>(<i></i>)
363
364 <p> 365 <p>
365 Private slot to handle the Next button. 366 Private slot to handle the Next button.
366 </p> 367 </p>
368
367 <a NAME="GitReflogBrowserDialog.on_passwordCheckBox_toggled" ID="GitReflogBrowserDialog.on_passwordCheckBox_toggled"></a> 369 <a NAME="GitReflogBrowserDialog.on_passwordCheckBox_toggled" ID="GitReflogBrowserDialog.on_passwordCheckBox_toggled"></a>
368 <h4>GitReflogBrowserDialog.on_passwordCheckBox_toggled</h4> 370 <h4>GitReflogBrowserDialog.on_passwordCheckBox_toggled</h4>
369 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 371 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
370
371 <p> 372 <p>
372 Private slot to handle the password checkbox toggled. 373 Private slot to handle the password checkbox toggled.
373 </p> 374 </p>
375
374 <dl> 376 <dl>
375 377
376 <dt><i>isOn</i> (bool)</dt> 378 <dt><i>isOn</i> (bool)</dt>
377 <dd> 379 <dd>
378 flag indicating the status of the check box 380 flag indicating the status of the check box
379 </dd> 381 </dd>
380 </dl> 382 </dl>
381 <a NAME="GitReflogBrowserDialog.on_refreshButton_clicked" ID="GitReflogBrowserDialog.on_refreshButton_clicked"></a> 383 <a NAME="GitReflogBrowserDialog.on_refreshButton_clicked" ID="GitReflogBrowserDialog.on_refreshButton_clicked"></a>
382 <h4>GitReflogBrowserDialog.on_refreshButton_clicked</h4> 384 <h4>GitReflogBrowserDialog.on_refreshButton_clicked</h4>
383 <b>on_refreshButton_clicked</b>(<i></i>) 385 <b>on_refreshButton_clicked</b>(<i></i>)
384
385 <p> 386 <p>
386 Private slot to refresh the log. 387 Private slot to refresh the log.
387 </p> 388 </p>
389
388 <a NAME="GitReflogBrowserDialog.on_sendButton_clicked" ID="GitReflogBrowserDialog.on_sendButton_clicked"></a> 390 <a NAME="GitReflogBrowserDialog.on_sendButton_clicked" ID="GitReflogBrowserDialog.on_sendButton_clicked"></a>
389 <h4>GitReflogBrowserDialog.on_sendButton_clicked</h4> 391 <h4>GitReflogBrowserDialog.on_sendButton_clicked</h4>
390 <b>on_sendButton_clicked</b>(<i></i>) 392 <b>on_sendButton_clicked</b>(<i></i>)
391
392 <p> 393 <p>
393 Private slot to send the input to the git process. 394 Private slot to send the input to the git process.
394 </p> 395 </p>
396
395 <a NAME="GitReflogBrowserDialog.show" ID="GitReflogBrowserDialog.show"></a> 397 <a NAME="GitReflogBrowserDialog.show" ID="GitReflogBrowserDialog.show"></a>
396 <h4>GitReflogBrowserDialog.show</h4> 398 <h4>GitReflogBrowserDialog.show</h4>
397 <b>show</b>(<i></i>) 399 <b>show</b>(<i></i>)
398
399 <p> 400 <p>
400 Public slot to show the dialog. 401 Public slot to show the dialog.
401 </p> 402 </p>
403
402 <a NAME="GitReflogBrowserDialog.start" ID="GitReflogBrowserDialog.start"></a> 404 <a NAME="GitReflogBrowserDialog.start" ID="GitReflogBrowserDialog.start"></a>
403 <h4>GitReflogBrowserDialog.start</h4> 405 <h4>GitReflogBrowserDialog.start</h4>
404 <b>start</b>(<i>projectdir</i>) 406 <b>start</b>(<i>projectdir</i>)
405
406 <p> 407 <p>
407 Public slot to start the git log command. 408 Public slot to start the git log command.
408 </p> 409 </p>
410
409 <dl> 411 <dl>
410 412
411 <dt><i>projectdir</i> (str)</dt> 413 <dt><i>projectdir</i> (str)</dt>
412 <dd> 414 <dd>
413 directory name of the project 415 directory name of the project

eric ide

mercurial