src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.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.GitStatusDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the output of the git status command 11 Module implementing a dialog to show the output of the git status command
13 process. 12 process.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21
22 <table> 21 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#GitStatusDialog">GitStatusDialog</a></td> 23 <td><a href="#GitStatusDialog">GitStatusDialog</a></td>
26 <td>Class implementing a dialog to show the output of the git status command process.</td> 24 <td>Class implementing a dialog to show the output of the git status command process.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="GitStatusDialog" ID="GitStatusDialog"></a> 35 <a NAME="GitStatusDialog" ID="GitStatusDialog"></a>
37 <h2>GitStatusDialog</h2> 36 <h2>GitStatusDialog</h2>
38
39 <p> 37 <p>
40 Class implementing a dialog to show the output of the git status command 38 Class implementing a dialog to show the output of the git status command
41 process. 39 process.
42 </p> 40 </p>
41
43 <h3>Derived from</h3> 42 <h3>Derived from</h3>
44 QWidget, Ui_GitStatusDialog 43 QWidget, Ui_GitStatusDialog
45 <h3>Class Attributes</h3> 44 <h3>Class Attributes</h3>
46
47 <table> 45 <table>
48 <tr><td>ConflictRole</td></tr><tr><td>ConflictStates</td></tr> 46 <tr><td>ConflictRole</td></tr>
47 <tr><td>ConflictStates</td></tr>
49 </table> 48 </table>
49
50 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
51
52 <table> 51 <table>
53 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
54 </table> 53 </table>
54
55 <h3>Methods</h3> 55 <h3>Methods</h3>
56
57 <table> 56 <table>
58
59 <tr> 57 <tr>
60 <td><a href="#GitStatusDialog.__init__">GitStatusDialog</a></td> 58 <td><a href="#GitStatusDialog.__init__">GitStatusDialog</a></td>
61 <td>Constructor</td> 59 <td>Constructor</td>
62 </tr> 60 </tr>
63 <tr> 61 <tr>
275 <tr> 273 <tr>
276 <td><a href="#GitStatusDialog.start">start</a></td> 274 <td><a href="#GitStatusDialog.start">start</a></td>
277 <td>Public slot to start the git status command.</td> 275 <td>Public slot to start the git status command.</td>
278 </tr> 276 </tr>
279 </table> 277 </table>
278
280 <h3>Static Methods</h3> 279 <h3>Static Methods</h3>
281
282 <table> 280 <table>
283 <tr><td>None</td></tr> 281 <tr><td>None</td></tr>
284 </table> 282 </table>
285 283
284
286 <a NAME="GitStatusDialog.__init__" ID="GitStatusDialog.__init__"></a> 285 <a NAME="GitStatusDialog.__init__" ID="GitStatusDialog.__init__"></a>
287 <h4>GitStatusDialog (Constructor)</h4> 286 <h4>GitStatusDialog (Constructor)</h4>
288 <b>GitStatusDialog</b>(<i>vcs, parent=None</i>) 287 <b>GitStatusDialog</b>(<i>vcs, parent=None</i>)
289
290 <p> 288 <p>
291 Constructor 289 Constructor
292 </p> 290 </p>
291
293 <dl> 292 <dl>
294 293
295 <dt><i>vcs</i> (Git)</dt> 294 <dt><i>vcs</i> (Git)</dt>
296 <dd> 295 <dd>
297 reference to the vcs object 296 reference to the vcs object
302 </dd> 301 </dd>
303 </dl> 302 </dl>
304 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a> 303 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a>
305 <h4>GitStatusDialog.__add</h4> 304 <h4>GitStatusDialog.__add</h4>
306 <b>__add</b>(<i></i>) 305 <b>__add</b>(<i></i>)
307
308 <p> 306 <p>
309 Private slot to handle the Add context menu entry. 307 Private slot to handle the Add context menu entry.
310 </p> 308 </p>
309
311 <a NAME="GitStatusDialog.__amend" ID="GitStatusDialog.__amend"></a> 310 <a NAME="GitStatusDialog.__amend" ID="GitStatusDialog.__amend"></a>
312 <h4>GitStatusDialog.__amend</h4> 311 <h4>GitStatusDialog.__amend</h4>
313 <b>__amend</b>(<i></i>) 312 <b>__amend</b>(<i></i>)
314
315 <p> 313 <p>
316 Private slot to handle the Amend context menu entry. 314 Private slot to handle the Amend context menu entry.
317 </p> 315 </p>
316
318 <a NAME="GitStatusDialog.__commit" ID="GitStatusDialog.__commit"></a> 317 <a NAME="GitStatusDialog.__commit" ID="GitStatusDialog.__commit"></a>
319 <h4>GitStatusDialog.__commit</h4> 318 <h4>GitStatusDialog.__commit</h4>
320 <b>__commit</b>(<i>amend=False</i>) 319 <b>__commit</b>(<i>amend=False</i>)
321
322 <p> 320 <p>
323 Private slot to handle the Commit context menu entry. 321 Private slot to handle the Commit context menu entry.
324 </p> 322 </p>
323
325 <dl> 324 <dl>
326 325
327 <dt><i>amend</i> (bool)</dt> 326 <dt><i>amend</i> (bool)</dt>
328 <dd> 327 <dd>
329 flag indicating to perform an amend operation 328 flag indicating to perform an amend operation
330 </dd> 329 </dd>
331 </dl> 330 </dl>
332 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a> 331 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a>
333 <h4>GitStatusDialog.__commitDeselectAll</h4> 332 <h4>GitStatusDialog.__commitDeselectAll</h4>
334 <b>__commitDeselectAll</b>(<i></i>) 333 <b>__commitDeselectAll</b>(<i></i>)
335
336 <p> 334 <p>
337 Private slot to deselect all entries from commit. 335 Private slot to deselect all entries from commit.
338 </p> 336 </p>
337
339 <a NAME="GitStatusDialog.__commitSelect" ID="GitStatusDialog.__commitSelect"></a> 338 <a NAME="GitStatusDialog.__commitSelect" ID="GitStatusDialog.__commitSelect"></a>
340 <h4>GitStatusDialog.__commitSelect</h4> 339 <h4>GitStatusDialog.__commitSelect</h4>
341 <b>__commitSelect</b>(<i>selected</i>) 340 <b>__commitSelect</b>(<i>selected</i>)
342
343 <p> 341 <p>
344 Private slot to select or deselect all entries. 342 Private slot to select or deselect all entries.
345 </p> 343 </p>
344
346 <dl> 345 <dl>
347 346
348 <dt><i>selected</i> (bool)</dt> 347 <dt><i>selected</i> (bool)</dt>
349 <dd> 348 <dd>
350 commit selection state to be set 349 commit selection state to be set
351 </dd> 350 </dd>
352 </dl> 351 </dl>
353 <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a> 352 <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a>
354 <h4>GitStatusDialog.__commitSelectAll</h4> 353 <h4>GitStatusDialog.__commitSelectAll</h4>
355 <b>__commitSelectAll</b>(<i></i>) 354 <b>__commitSelectAll</b>(<i></i>)
356
357 <p> 355 <p>
358 Private slot to select all entries for commit. 356 Private slot to select all entries for commit.
359 </p> 357 </p>
358
360 <a NAME="GitStatusDialog.__committed" ID="GitStatusDialog.__committed"></a> 359 <a NAME="GitStatusDialog.__committed" ID="GitStatusDialog.__committed"></a>
361 <h4>GitStatusDialog.__committed</h4> 360 <h4>GitStatusDialog.__committed</h4>
362 <b>__committed</b>(<i></i>) 361 <b>__committed</b>(<i></i>)
363
364 <p> 362 <p>
365 Private slot called after the commit has finished. 363 Private slot called after the commit has finished.
366 </p> 364 </p>
365
367 <a NAME="GitStatusDialog.__diff" ID="GitStatusDialog.__diff"></a> 366 <a NAME="GitStatusDialog.__diff" ID="GitStatusDialog.__diff"></a>
368 <h4>GitStatusDialog.__diff</h4> 367 <h4>GitStatusDialog.__diff</h4>
369 <b>__diff</b>(<i></i>) 368 <b>__diff</b>(<i></i>)
370
371 <p> 369 <p>
372 Private slot to handle the Diff context menu entry. 370 Private slot to handle the Diff context menu entry.
373 </p> 371 </p>
372
374 <a NAME="GitStatusDialog.__editConflict" ID="GitStatusDialog.__editConflict"></a> 373 <a NAME="GitStatusDialog.__editConflict" ID="GitStatusDialog.__editConflict"></a>
375 <h4>GitStatusDialog.__editConflict</h4> 374 <h4>GitStatusDialog.__editConflict</h4>
376 <b>__editConflict</b>(<i></i>) 375 <b>__editConflict</b>(<i></i>)
377
378 <p> 376 <p>
379 Private slot to handle the Edit Conflict context menu entry. 377 Private slot to handle the Edit Conflict context menu entry.
380 </p> 378 </p>
379
381 <a NAME="GitStatusDialog.__finish" ID="GitStatusDialog.__finish"></a> 380 <a NAME="GitStatusDialog.__finish" ID="GitStatusDialog.__finish"></a>
382 <h4>GitStatusDialog.__finish</h4> 381 <h4>GitStatusDialog.__finish</h4>
383 <b>__finish</b>(<i></i>) 382 <b>__finish</b>(<i></i>)
384
385 <p> 383 <p>
386 Private slot called when the process finished or the user pressed 384 Private slot called when the process finished or the user pressed
387 the button. 385 the button.
388 </p> 386 </p>
387
389 <a NAME="GitStatusDialog.__forget" ID="GitStatusDialog.__forget"></a> 388 <a NAME="GitStatusDialog.__forget" ID="GitStatusDialog.__forget"></a>
390 <h4>GitStatusDialog.__forget</h4> 389 <h4>GitStatusDialog.__forget</h4>
391 <b>__forget</b>(<i></i>) 390 <b>__forget</b>(<i></i>)
392
393 <p> 391 <p>
394 Private slot to handle the Forget Missing context menu entry. 392 Private slot to handle the Forget Missing context menu entry.
395 </p> 393 </p>
394
396 <a NAME="GitStatusDialog.__generateDiffs" ID="GitStatusDialog.__generateDiffs"></a> 395 <a NAME="GitStatusDialog.__generateDiffs" ID="GitStatusDialog.__generateDiffs"></a>
397 <h4>GitStatusDialog.__generateDiffs</h4> 396 <h4>GitStatusDialog.__generateDiffs</h4>
398 <b>__generateDiffs</b>(<i></i>) 397 <b>__generateDiffs</b>(<i></i>)
399
400 <p> 398 <p>
401 Private slot to generate diff outputs for the selected item. 399 Private slot to generate diff outputs for the selected item.
402 </p> 400 </p>
401
403 <a NAME="GitStatusDialog.__generateItem" ID="GitStatusDialog.__generateItem"></a> 402 <a NAME="GitStatusDialog.__generateItem" ID="GitStatusDialog.__generateItem"></a>
404 <h4>GitStatusDialog.__generateItem</h4> 403 <h4>GitStatusDialog.__generateItem</h4>
405 <b>__generateItem</b>(<i>status, path</i>) 404 <b>__generateItem</b>(<i>status, path</i>)
406
407 <p> 405 <p>
408 Private method to generate a status item in the status list. 406 Private method to generate a status item in the status list.
409 </p> 407 </p>
408
410 <dl> 409 <dl>
411 410
412 <dt><i>status</i> (str)</dt> 411 <dt><i>status</i> (str)</dt>
413 <dd> 412 <dd>
414 status indicator 413 status indicator
419 </dd> 418 </dd>
420 </dl> 419 </dl>
421 <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a> 420 <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a>
422 <h4>GitStatusDialog.__generatorFinished</h4> 421 <h4>GitStatusDialog.__generatorFinished</h4>
423 <b>__generatorFinished</b>(<i></i>) 422 <b>__generatorFinished</b>(<i></i>)
424
425 <p> 423 <p>
426 Private slot connected to the finished signal of the diff generator. 424 Private slot connected to the finished signal of the diff generator.
427 </p> 425 </p>
426
428 <a NAME="GitStatusDialog.__getCommitableItems" ID="GitStatusDialog.__getCommitableItems"></a> 427 <a NAME="GitStatusDialog.__getCommitableItems" ID="GitStatusDialog.__getCommitableItems"></a>
429 <h4>GitStatusDialog.__getCommitableItems</h4> 428 <h4>GitStatusDialog.__getCommitableItems</h4>
430 <b>__getCommitableItems</b>(<i></i>) 429 <b>__getCommitableItems</b>(<i></i>)
431
432 <p> 430 <p>
433 Private method to retrieve all entries the user wants to commit. 431 Private method to retrieve all entries the user wants to commit.
434 </p> 432 </p>
433
435 <dl> 434 <dl>
436 <dt>Return:</dt> 435 <dt>Return:</dt>
437 <dd> 436 <dd>
438 list of all items, the user has checked 437 list of all items, the user has checked
439 </dd> 438 </dd>
445 </dd> 444 </dd>
446 </dl> 445 </dl>
447 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a> 446 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a>
448 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4> 447 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4>
449 <b>__getCommitableUnselectedItems</b>(<i></i>) 448 <b>__getCommitableUnselectedItems</b>(<i></i>)
450
451 <p> 449 <p>
452 Private method to retrieve all entries the user may commit but hasn't 450 Private method to retrieve all entries the user may commit but hasn't
453 selected. 451 selected.
454 </p> 452 </p>
453
455 <dl> 454 <dl>
456 <dt>Return:</dt> 455 <dt>Return:</dt>
457 <dd> 456 <dd>
458 list of all items, the user has not checked 457 list of all items, the user has not checked
459 </dd> 458 </dd>
465 </dd> 464 </dd>
466 </dl> 465 </dl>
467 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a> 466 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a>
468 <h4>GitStatusDialog.__getConflictingItems</h4> 467 <h4>GitStatusDialog.__getConflictingItems</h4>
469 <b>__getConflictingItems</b>(<i></i>) 468 <b>__getConflictingItems</b>(<i></i>)
470
471 <p> 469 <p>
472 Private method to retrieve all entries, that have a conflict status. 470 Private method to retrieve all entries, that have a conflict status.
473 </p> 471 </p>
472
474 <dl> 473 <dl>
475 <dt>Return:</dt> 474 <dt>Return:</dt>
476 <dd> 475 <dd>
477 list of all items with a conflict status 476 list of all items with a conflict status
478 </dd> 477 </dd>
484 </dd> 483 </dd>
485 </dl> 484 </dl>
486 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a> 485 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a>
487 <h4>GitStatusDialog.__getMissingItems</h4> 486 <h4>GitStatusDialog.__getMissingItems</h4>
488 <b>__getMissingItems</b>(<i></i>) 487 <b>__getMissingItems</b>(<i></i>)
489
490 <p> 488 <p>
491 Private method to retrieve all entries, that have a missing status. 489 Private method to retrieve all entries, that have a missing status.
492 </p> 490 </p>
491
493 <dl> 492 <dl>
494 <dt>Return:</dt> 493 <dt>Return:</dt>
495 <dd> 494 <dd>
496 list of all items with a missing status 495 list of all items with a missing status
497 </dd> 496 </dd>
503 </dd> 502 </dd>
504 </dl> 503 </dl>
505 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a> 504 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a>
506 <h4>GitStatusDialog.__getModifiedItems</h4> 505 <h4>GitStatusDialog.__getModifiedItems</h4>
507 <b>__getModifiedItems</b>(<i></i>) 506 <b>__getModifiedItems</b>(<i></i>)
508
509 <p> 507 <p>
510 Private method to retrieve all entries, that have a modified status. 508 Private method to retrieve all entries, that have a modified status.
511 </p> 509 </p>
510
512 <dl> 511 <dl>
513 <dt>Return:</dt> 512 <dt>Return:</dt>
514 <dd> 513 <dd>
515 list of all items with a modified status 514 list of all items with a modified status
516 </dd> 515 </dd>
522 </dd> 521 </dd>
523 </dl> 522 </dl>
524 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a> 523 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a>
525 <h4>GitStatusDialog.__getModifiedOnlyItems</h4> 524 <h4>GitStatusDialog.__getModifiedOnlyItems</h4>
526 <b>__getModifiedOnlyItems</b>(<i></i>) 525 <b>__getModifiedOnlyItems</b>(<i></i>)
527
528 <p> 526 <p>
529 Private method to retrieve all entries, that have a modified status. 527 Private method to retrieve all entries, that have a modified status.
530 </p> 528 </p>
529
531 <dl> 530 <dl>
532 <dt>Return:</dt> 531 <dt>Return:</dt>
533 <dd> 532 <dd>
534 list of all items with a modified status 533 list of all items with a modified status
535 </dd> 534 </dd>
541 </dd> 540 </dd>
542 </dl> 541 </dl>
543 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a> 542 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a>
544 <h4>GitStatusDialog.__getStageableItems</h4> 543 <h4>GitStatusDialog.__getStageableItems</h4>
545 <b>__getStageableItems</b>(<i></i>) 544 <b>__getStageableItems</b>(<i></i>)
546
547 <p> 545 <p>
548 Private method to retrieve all entries, that have a stageable 546 Private method to retrieve all entries, that have a stageable
549 status. 547 status.
550 </p> 548 </p>
549
551 <dl> 550 <dl>
552 <dt>Return:</dt> 551 <dt>Return:</dt>
553 <dd> 552 <dd>
554 list of all items with a stageable status 553 list of all items with a stageable status
555 </dd> 554 </dd>
561 </dd> 560 </dd>
562 </dl> 561 </dl>
563 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a> 562 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a>
564 <h4>GitStatusDialog.__getUnstageableItems</h4> 563 <h4>GitStatusDialog.__getUnstageableItems</h4>
565 <b>__getUnstageableItems</b>(<i></i>) 564 <b>__getUnstageableItems</b>(<i></i>)
566
567 <p> 565 <p>
568 Private method to retrieve all entries, that have an unstageable 566 Private method to retrieve all entries, that have an unstageable
569 status. 567 status.
570 </p> 568 </p>
569
571 <dl> 570 <dl>
572 <dt>Return:</dt> 571 <dt>Return:</dt>
573 <dd> 572 <dd>
574 list of all items with an unstageable status 573 list of all items with an unstageable status
575 </dd> 574 </dd>
581 </dd> 580 </dd>
582 </dl> 581 </dl>
583 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a> 582 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a>
584 <h4>GitStatusDialog.__getUnversionedItems</h4> 583 <h4>GitStatusDialog.__getUnversionedItems</h4>
585 <b>__getUnversionedItems</b>(<i></i>) 584 <b>__getUnversionedItems</b>(<i></i>)
586
587 <p> 585 <p>
588 Private method to retrieve all entries, that have an unversioned 586 Private method to retrieve all entries, that have an unversioned
589 status. 587 status.
590 </p> 588 </p>
589
591 <dl> 590 <dl>
592 <dt>Return:</dt> 591 <dt>Return:</dt>
593 <dd> 592 <dd>
594 list of all items with an unversioned status 593 list of all items with an unversioned status
595 </dd> 594 </dd>
601 </dd> 600 </dd>
602 </dl> 601 </dl>
603 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a> 602 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a>
604 <h4>GitStatusDialog.__initActionsMenu</h4> 603 <h4>GitStatusDialog.__initActionsMenu</h4>
605 <b>__initActionsMenu</b>(<i></i>) 604 <b>__initActionsMenu</b>(<i></i>)
606
607 <p> 605 <p>
608 Private method to initialize the actions menu. 606 Private method to initialize the actions menu.
609 </p> 607 </p>
608
610 <a NAME="GitStatusDialog.__procFinished" ID="GitStatusDialog.__procFinished"></a> 609 <a NAME="GitStatusDialog.__procFinished" ID="GitStatusDialog.__procFinished"></a>
611 <h4>GitStatusDialog.__procFinished</h4> 610 <h4>GitStatusDialog.__procFinished</h4>
612 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 611 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
613
614 <p> 612 <p>
615 Private slot connected to the finished signal. 613 Private slot connected to the finished signal.
616 </p> 614 </p>
615
617 <dl> 616 <dl>
618 617
619 <dt><i>exitCode</i> (int)</dt> 618 <dt><i>exitCode</i> (int)</dt>
620 <dd> 619 <dd>
621 exit code of the process 620 exit code of the process
626 </dd> 625 </dd>
627 </dl> 626 </dl>
628 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a> 627 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a>
629 <h4>GitStatusDialog.__readStderr</h4> 628 <h4>GitStatusDialog.__readStderr</h4>
630 <b>__readStderr</b>(<i></i>) 629 <b>__readStderr</b>(<i></i>)
631
632 <p> 630 <p>
633 Private slot to handle the readyReadStandardError signal. 631 Private slot to handle the readyReadStandardError signal.
634 </p> 632 </p>
635 <p> 633 <p>
636 It reads the error output of the process and inserts it into the 634 It reads the error output of the process and inserts it into the
637 error pane. 635 error pane.
638 </p> 636 </p>
637
639 <a NAME="GitStatusDialog.__readStdout" ID="GitStatusDialog.__readStdout"></a> 638 <a NAME="GitStatusDialog.__readStdout" ID="GitStatusDialog.__readStdout"></a>
640 <h4>GitStatusDialog.__readStdout</h4> 639 <h4>GitStatusDialog.__readStdout</h4>
641 <b>__readStdout</b>(<i></i>) 640 <b>__readStdout</b>(<i></i>)
642
643 <p> 641 <p>
644 Private slot to handle the readyReadStandardOutput signal. 642 Private slot to handle the readyReadStandardOutput signal.
645 </p> 643 </p>
646 <p> 644 <p>
647 It reads the output of the process, formats it and inserts it into 645 It reads the output of the process, formats it and inserts it into
648 the contents pane. 646 the contents pane.
649 </p> 647 </p>
648
650 <a NAME="GitStatusDialog.__refreshDiff" ID="GitStatusDialog.__refreshDiff"></a> 649 <a NAME="GitStatusDialog.__refreshDiff" ID="GitStatusDialog.__refreshDiff"></a>
651 <h4>GitStatusDialog.__refreshDiff</h4> 650 <h4>GitStatusDialog.__refreshDiff</h4>
652 <b>__refreshDiff</b>(<i></i>) 651 <b>__refreshDiff</b>(<i></i>)
653
654 <p> 652 <p>
655 Private method to refresh the diff output after a refresh. 653 Private method to refresh the diff output after a refresh.
656 </p> 654 </p>
655
657 <a NAME="GitStatusDialog.__resizeColumns" ID="GitStatusDialog.__resizeColumns"></a> 656 <a NAME="GitStatusDialog.__resizeColumns" ID="GitStatusDialog.__resizeColumns"></a>
658 <h4>GitStatusDialog.__resizeColumns</h4> 657 <h4>GitStatusDialog.__resizeColumns</h4>
659 <b>__resizeColumns</b>(<i></i>) 658 <b>__resizeColumns</b>(<i></i>)
660
661 <p> 659 <p>
662 Private method to resize the list columns. 660 Private method to resize the list columns.
663 </p> 661 </p>
662
664 <a NAME="GitStatusDialog.__resort" ID="GitStatusDialog.__resort"></a> 663 <a NAME="GitStatusDialog.__resort" ID="GitStatusDialog.__resort"></a>
665 <h4>GitStatusDialog.__resort</h4> 664 <h4>GitStatusDialog.__resort</h4>
666 <b>__resort</b>(<i></i>) 665 <b>__resort</b>(<i></i>)
667
668 <p> 666 <p>
669 Private method to resort the tree. 667 Private method to resort the tree.
670 </p> 668 </p>
669
671 <a NAME="GitStatusDialog.__restoreMissing" ID="GitStatusDialog.__restoreMissing"></a> 670 <a NAME="GitStatusDialog.__restoreMissing" ID="GitStatusDialog.__restoreMissing"></a>
672 <h4>GitStatusDialog.__restoreMissing</h4> 671 <h4>GitStatusDialog.__restoreMissing</h4>
673 <b>__restoreMissing</b>(<i></i>) 672 <b>__restoreMissing</b>(<i></i>)
674
675 <p> 673 <p>
676 Private slot to handle the Restore Missing context menu entry. 674 Private slot to handle the Restore Missing context menu entry.
677 </p> 675 </p>
676
678 <a NAME="GitStatusDialog.__revert" ID="GitStatusDialog.__revert"></a> 677 <a NAME="GitStatusDialog.__revert" ID="GitStatusDialog.__revert"></a>
679 <h4>GitStatusDialog.__revert</h4> 678 <h4>GitStatusDialog.__revert</h4>
680 <b>__revert</b>(<i></i>) 679 <b>__revert</b>(<i></i>)
681
682 <p> 680 <p>
683 Private slot to handle the Revert context menu entry. 681 Private slot to handle the Revert context menu entry.
684 </p> 682 </p>
683
685 <a NAME="GitStatusDialog.__revertHunkOrLines" ID="GitStatusDialog.__revertHunkOrLines"></a> 684 <a NAME="GitStatusDialog.__revertHunkOrLines" ID="GitStatusDialog.__revertHunkOrLines"></a>
686 <h4>GitStatusDialog.__revertHunkOrLines</h4> 685 <h4>GitStatusDialog.__revertHunkOrLines</h4>
687 <b>__revertHunkOrLines</b>(<i></i>) 686 <b>__revertHunkOrLines</b>(<i></i>)
688
689 <p> 687 <p>
690 Private method to revert the selected lines or hunk. 688 Private method to revert the selected lines or hunk.
691 </p> 689 </p>
690
692 <a NAME="GitStatusDialog.__sbsDiff" ID="GitStatusDialog.__sbsDiff"></a> 691 <a NAME="GitStatusDialog.__sbsDiff" ID="GitStatusDialog.__sbsDiff"></a>
693 <h4>GitStatusDialog.__sbsDiff</h4> 692 <h4>GitStatusDialog.__sbsDiff</h4>
694 <b>__sbsDiff</b>(<i></i>) 693 <b>__sbsDiff</b>(<i></i>)
695
696 <p> 694 <p>
697 Private slot to handle the Side-By-Side Diff context menu entry. 695 Private slot to handle the Side-By-Side Diff context menu entry.
698 </p> 696 </p>
697
699 <a NAME="GitStatusDialog.__selectedLinesIndexes" ID="GitStatusDialog.__selectedLinesIndexes"></a> 698 <a NAME="GitStatusDialog.__selectedLinesIndexes" ID="GitStatusDialog.__selectedLinesIndexes"></a>
700 <h4>GitStatusDialog.__selectedLinesIndexes</h4> 699 <h4>GitStatusDialog.__selectedLinesIndexes</h4>
701 <b>__selectedLinesIndexes</b>(<i>diffEdit</i>) 700 <b>__selectedLinesIndexes</b>(<i>diffEdit</i>)
702
703 <p> 701 <p>
704 Private method to extract the indexes of the selected lines. 702 Private method to extract the indexes of the selected lines.
705 </p> 703 </p>
704
706 <dl> 705 <dl>
707 706
708 <dt><i>diffEdit</i> (QTextEdit)</dt> 707 <dt><i>diffEdit</i> (QTextEdit)</dt>
709 <dd> 708 <dd>
710 reference to the edit widget 709 reference to the edit widget
723 </dd> 722 </dd>
724 </dl> 723 </dl>
725 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a> 724 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a>
726 <h4>GitStatusDialog.__showActionsMenu</h4> 725 <h4>GitStatusDialog.__showActionsMenu</h4>
727 <b>__showActionsMenu</b>(<i></i>) 726 <b>__showActionsMenu</b>(<i></i>)
728
729 <p> 727 <p>
730 Private slot to prepare the actions button menu before it is shown. 728 Private slot to prepare the actions button menu before it is shown.
731 </p> 729 </p>
730
732 <a NAME="GitStatusDialog.__showLDiffContextMenu" ID="GitStatusDialog.__showLDiffContextMenu"></a> 731 <a NAME="GitStatusDialog.__showLDiffContextMenu" ID="GitStatusDialog.__showLDiffContextMenu"></a>
733 <h4>GitStatusDialog.__showLDiffContextMenu</h4> 732 <h4>GitStatusDialog.__showLDiffContextMenu</h4>
734 <b>__showLDiffContextMenu</b>(<i>coord</i>) 733 <b>__showLDiffContextMenu</b>(<i>coord</i>)
735
736 <p> 734 <p>
737 Private slot to show the context menu of the status list. 735 Private slot to show the context menu of the status list.
738 </p> 736 </p>
737
739 <dl> 738 <dl>
740 739
741 <dt><i>coord</i> (QPoint)</dt> 740 <dt><i>coord</i> (QPoint)</dt>
742 <dd> 741 <dd>
743 position of the mouse pointer 742 position of the mouse pointer
744 </dd> 743 </dd>
745 </dl> 744 </dl>
746 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a> 745 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a>
747 <h4>GitStatusDialog.__showRDiffContextMenu</h4> 746 <h4>GitStatusDialog.__showRDiffContextMenu</h4>
748 <b>__showRDiffContextMenu</b>(<i>coord</i>) 747 <b>__showRDiffContextMenu</b>(<i>coord</i>)
749
750 <p> 748 <p>
751 Private slot to show the context menu of the status list. 749 Private slot to show the context menu of the status list.
752 </p> 750 </p>
751
753 <dl> 752 <dl>
754 753
755 <dt><i>coord</i> (QPoint)</dt> 754 <dt><i>coord</i> (QPoint)</dt>
756 <dd> 755 <dd>
757 position of the mouse pointer 756 position of the mouse pointer
758 </dd> 757 </dd>
759 </dl> 758 </dl>
760 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a> 759 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a>
761 <h4>GitStatusDialog.__stage</h4> 760 <h4>GitStatusDialog.__stage</h4>
762 <b>__stage</b>(<i></i>) 761 <b>__stage</b>(<i></i>)
763
764 <p> 762 <p>
765 Private slot to handle the Stage context menu entry. 763 Private slot to handle the Stage context menu entry.
766 </p> 764 </p>
765
767 <a NAME="GitStatusDialog.__stageHunkOrLines" ID="GitStatusDialog.__stageHunkOrLines"></a> 766 <a NAME="GitStatusDialog.__stageHunkOrLines" ID="GitStatusDialog.__stageHunkOrLines"></a>
768 <h4>GitStatusDialog.__stageHunkOrLines</h4> 767 <h4>GitStatusDialog.__stageHunkOrLines</h4>
769 <b>__stageHunkOrLines</b>(<i></i>) 768 <b>__stageHunkOrLines</b>(<i></i>)
770
771 <p> 769 <p>
772 Private method to stage the selected lines or hunk. 770 Private method to stage the selected lines or hunk.
773 </p> 771 </p>
772
774 <a NAME="GitStatusDialog.__tmpPatchFileName" ID="GitStatusDialog.__tmpPatchFileName"></a> 773 <a NAME="GitStatusDialog.__tmpPatchFileName" ID="GitStatusDialog.__tmpPatchFileName"></a>
775 <h4>GitStatusDialog.__tmpPatchFileName</h4> 774 <h4>GitStatusDialog.__tmpPatchFileName</h4>
776 <b>__tmpPatchFileName</b>(<i></i>) 775 <b>__tmpPatchFileName</b>(<i></i>)
777
778 <p> 776 <p>
779 Private method to generate a temporary patch file. 777 Private method to generate a temporary patch file.
780 </p> 778 </p>
779
781 <dl> 780 <dl>
782 <dt>Return:</dt> 781 <dt>Return:</dt>
783 <dd> 782 <dd>
784 name of the temporary file 783 name of the temporary file
785 </dd> 784 </dd>
791 </dd> 790 </dd>
792 </dl> 791 </dl>
793 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a> 792 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a>
794 <h4>GitStatusDialog.__unstage</h4> 793 <h4>GitStatusDialog.__unstage</h4>
795 <b>__unstage</b>(<i></i>) 794 <b>__unstage</b>(<i></i>)
796
797 <p> 795 <p>
798 Private slot to handle the Unstage context menu entry. 796 Private slot to handle the Unstage context menu entry.
799 </p> 797 </p>
798
800 <a NAME="GitStatusDialog.__unstageHunkOrLines" ID="GitStatusDialog.__unstageHunkOrLines"></a> 799 <a NAME="GitStatusDialog.__unstageHunkOrLines" ID="GitStatusDialog.__unstageHunkOrLines"></a>
801 <h4>GitStatusDialog.__unstageHunkOrLines</h4> 800 <h4>GitStatusDialog.__unstageHunkOrLines</h4>
802 <b>__unstageHunkOrLines</b>(<i></i>) 801 <b>__unstageHunkOrLines</b>(<i></i>)
803
804 <p> 802 <p>
805 Private method to unstage the selected lines or hunk. 803 Private method to unstage the selected lines or hunk.
806 </p> 804 </p>
805
807 <a NAME="GitStatusDialog.closeEvent" ID="GitStatusDialog.closeEvent"></a> 806 <a NAME="GitStatusDialog.closeEvent" ID="GitStatusDialog.closeEvent"></a>
808 <h4>GitStatusDialog.closeEvent</h4> 807 <h4>GitStatusDialog.closeEvent</h4>
809 <b>closeEvent</b>(<i>e</i>) 808 <b>closeEvent</b>(<i>e</i>)
810
811 <p> 809 <p>
812 Protected slot implementing a close event handler. 810 Protected slot implementing a close event handler.
813 </p> 811 </p>
812
814 <dl> 813 <dl>
815 814
816 <dt><i>e</i> (QCloseEvent)</dt> 815 <dt><i>e</i> (QCloseEvent)</dt>
817 <dd> 816 <dd>
818 close event 817 close event
819 </dd> 818 </dd>
820 </dl> 819 </dl>
821 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a> 820 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a>
822 <h4>GitStatusDialog.keyPressEvent</h4> 821 <h4>GitStatusDialog.keyPressEvent</h4>
823 <b>keyPressEvent</b>(<i>evt</i>) 822 <b>keyPressEvent</b>(<i>evt</i>)
824
825 <p> 823 <p>
826 Protected slot to handle a key press event. 824 Protected slot to handle a key press event.
827 </p> 825 </p>
826
828 <dl> 827 <dl>
829 828
830 <dt><i>evt</i> (QKeyEvent)</dt> 829 <dt><i>evt</i> (QKeyEvent)</dt>
831 <dd> 830 <dd>
832 the key press event 831 the key press event
833 </dd> 832 </dd>
834 </dl> 833 </dl>
835 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a> 834 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a>
836 <h4>GitStatusDialog.on_buttonBox_clicked</h4> 835 <h4>GitStatusDialog.on_buttonBox_clicked</h4>
837 <b>on_buttonBox_clicked</b>(<i>button</i>) 836 <b>on_buttonBox_clicked</b>(<i>button</i>)
838
839 <p> 837 <p>
840 Private slot called by a button of the button box clicked. 838 Private slot called by a button of the button box clicked.
841 </p> 839 </p>
840
842 <dl> 841 <dl>
843 842
844 <dt><i>button</i> (QAbstractButton)</dt> 843 <dt><i>button</i> (QAbstractButton)</dt>
845 <dd> 844 <dd>
846 button that was clicked 845 button that was clicked
847 </dd> 846 </dd>
848 </dl> 847 </dl>
849 <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a> 848 <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a>
850 <h4>GitStatusDialog.on_input_returnPressed</h4> 849 <h4>GitStatusDialog.on_input_returnPressed</h4>
851 <b>on_input_returnPressed</b>(<i></i>) 850 <b>on_input_returnPressed</b>(<i></i>)
852
853 <p> 851 <p>
854 Private slot to handle the press of the return key in the input field. 852 Private slot to handle the press of the return key in the input field.
855 </p> 853 </p>
854
856 <a NAME="GitStatusDialog.on_passwordCheckBox_toggled" ID="GitStatusDialog.on_passwordCheckBox_toggled"></a> 855 <a NAME="GitStatusDialog.on_passwordCheckBox_toggled" ID="GitStatusDialog.on_passwordCheckBox_toggled"></a>
857 <h4>GitStatusDialog.on_passwordCheckBox_toggled</h4> 856 <h4>GitStatusDialog.on_passwordCheckBox_toggled</h4>
858 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 857 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
859
860 <p> 858 <p>
861 Private slot to handle the password checkbox toggled. 859 Private slot to handle the password checkbox toggled.
862 </p> 860 </p>
861
863 <dl> 862 <dl>
864 863
865 <dt><i>isOn</i> (bool)</dt> 864 <dt><i>isOn</i> (bool)</dt>
866 <dd> 865 <dd>
867 flag indicating the status of the check box 866 flag indicating the status of the check box
868 </dd> 867 </dd>
869 </dl> 868 </dl>
870 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a> 869 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a>
871 <h4>GitStatusDialog.on_refreshButton_clicked</h4> 870 <h4>GitStatusDialog.on_refreshButton_clicked</h4>
872 <b>on_refreshButton_clicked</b>(<i></i>) 871 <b>on_refreshButton_clicked</b>(<i></i>)
873
874 <p> 872 <p>
875 Private slot to refresh the status display. 873 Private slot to refresh the status display.
876 </p> 874 </p>
875
877 <a NAME="GitStatusDialog.on_sendButton_clicked" ID="GitStatusDialog.on_sendButton_clicked"></a> 876 <a NAME="GitStatusDialog.on_sendButton_clicked" ID="GitStatusDialog.on_sendButton_clicked"></a>
878 <h4>GitStatusDialog.on_sendButton_clicked</h4> 877 <h4>GitStatusDialog.on_sendButton_clicked</h4>
879 <b>on_sendButton_clicked</b>(<i></i>) 878 <b>on_sendButton_clicked</b>(<i></i>)
880
881 <p> 879 <p>
882 Private slot to send the input to the git process. 880 Private slot to send the input to the git process.
883 </p> 881 </p>
882
884 <a NAME="GitStatusDialog.on_statusFilterCombo_activated" ID="GitStatusDialog.on_statusFilterCombo_activated"></a> 883 <a NAME="GitStatusDialog.on_statusFilterCombo_activated" ID="GitStatusDialog.on_statusFilterCombo_activated"></a>
885 <h4>GitStatusDialog.on_statusFilterCombo_activated</h4> 884 <h4>GitStatusDialog.on_statusFilterCombo_activated</h4>
886 <b>on_statusFilterCombo_activated</b>(<i>index</i>) 885 <b>on_statusFilterCombo_activated</b>(<i>index</i>)
887
888 <p> 886 <p>
889 Private slot to react to the selection of a status filter. 887 Private slot to react to the selection of a status filter.
890 </p> 888 </p>
889
891 <dl> 890 <dl>
892 891
893 <dt><i>index</i> (int)</dt> 892 <dt><i>index</i> (int)</dt>
894 <dd> 893 <dd>
895 index of the selected entry 894 index of the selected entry
896 </dd> 895 </dd>
897 </dl> 896 </dl>
898 <a NAME="GitStatusDialog.on_statusList_itemSelectionChanged" ID="GitStatusDialog.on_statusList_itemSelectionChanged"></a> 897 <a NAME="GitStatusDialog.on_statusList_itemSelectionChanged" ID="GitStatusDialog.on_statusList_itemSelectionChanged"></a>
899 <h4>GitStatusDialog.on_statusList_itemSelectionChanged</h4> 898 <h4>GitStatusDialog.on_statusList_itemSelectionChanged</h4>
900 <b>on_statusList_itemSelectionChanged</b>(<i></i>) 899 <b>on_statusList_itemSelectionChanged</b>(<i></i>)
901
902 <p> 900 <p>
903 Private slot to act upon changes of selected items. 901 Private slot to act upon changes of selected items.
904 </p> 902 </p>
903
905 <a NAME="GitStatusDialog.show" ID="GitStatusDialog.show"></a> 904 <a NAME="GitStatusDialog.show" ID="GitStatusDialog.show"></a>
906 <h4>GitStatusDialog.show</h4> 905 <h4>GitStatusDialog.show</h4>
907 <b>show</b>(<i></i>) 906 <b>show</b>(<i></i>)
908
909 <p> 907 <p>
910 Public slot to show the dialog. 908 Public slot to show the dialog.
911 </p> 909 </p>
910
912 <a NAME="GitStatusDialog.start" ID="GitStatusDialog.start"></a> 911 <a NAME="GitStatusDialog.start" ID="GitStatusDialog.start"></a>
913 <h4>GitStatusDialog.start</h4> 912 <h4>GitStatusDialog.start</h4>
914 <b>start</b>(<i>fn</i>) 913 <b>start</b>(<i>fn</i>)
915
916 <p> 914 <p>
917 Public slot to start the git status command. 915 Public slot to start the git status command.
918 </p> 916 </p>
917
919 <dl> 918 <dl>
920 919
921 <dt><i>fn</i> (str or list of str)</dt> 920 <dt><i>fn</i> (str or list of str)</dt>
922 <dd> 921 <dd>
923 filename(s)/directoryname(s) to show the status of 922 filename(s)/directoryname(s) to show the status of

eric ide

mercurial