src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html

branch
eric7
changeset 10417
c6011e501282
parent 10415
af9a6dac2611
child 10479
856476537696
equal deleted inserted replaced
10416:5d807e997391 10417:c6011e501282
457 <p> 457 <p>
458 Constructor 458 Constructor
459 </p> 459 </p>
460 <dl> 460 <dl>
461 461
462 <dt><i>ui</i></dt> 462 <dt><i>ui</i> (UserInterface)</dt>
463 <dd> 463 <dd>
464 reference to the main UI 464 reference to the main UI
465 </dd> 465 </dd>
466 <dt><i>vm</i></dt> 466 <dt><i>vm</i> (ViewManager)</dt>
467 <dd> 467 <dd>
468 reference to the viewmanager 468 reference to the viewmanager
469 </dd> 469 </dd>
470 <dt><i>debugServer</i></dt> 470 <dt><i>debugServer</i> (DebugServer)</dt>
471 <dd> 471 <dd>
472 reference to the debug server 472 reference to the debug server
473 </dd> 473 </dd>
474 <dt><i>debugViewer</i></dt> 474 <dt><i>debugViewer</i> (DebugViewer)</dt>
475 <dd> 475 <dd>
476 reference to the debug viewer widget 476 reference to the debug viewer widget
477 </dd> 477 </dd>
478 <dt><i>project</i></dt> 478 <dt><i>project</i> (Project)</dt>
479 <dd> 479 <dd>
480 reference to the project object 480 reference to the project object
481 </dd> 481 </dd>
482 </dl> 482 </dl>
483 <a NAME="DebugUI.__applyVariablesFilters" ID="DebugUI.__applyVariablesFilters"></a> 483 <a NAME="DebugUI.__applyVariablesFilters" ID="DebugUI.__applyVariablesFilters"></a>
505 <p> 505 <p>
506 Private method to handle the breakpoint selected signal. 506 Private method to handle the breakpoint selected signal.
507 </p> 507 </p>
508 <dl> 508 <dl>
509 509
510 <dt><i>act</i></dt> 510 <dt><i>act</i> (QAction)</dt>
511 <dd> 511 <dd>
512 reference to the action that triggered (QAction) 512 reference to the action that triggered
513 </dd> 513 </dd>
514 </dl> 514 </dl>
515 <a NAME="DebugUI.__checkActions" ID="DebugUI.__checkActions"></a> 515 <a NAME="DebugUI.__checkActions" ID="DebugUI.__checkActions"></a>
516 <h4>DebugUI.__checkActions</h4> 516 <h4>DebugUI.__checkActions</h4>
517 <b>__checkActions</b>(<i>editor</i>) 517 <b>__checkActions</b>(<i>editor</i>)
519 <p> 519 <p>
520 Private slot to check some actions for their enable/disable status. 520 Private slot to check some actions for their enable/disable status.
521 </p> 521 </p>
522 <dl> 522 <dl>
523 523
524 <dt><i>editor</i></dt> 524 <dt><i>editor</i> (Editor)</dt>
525 <dd> 525 <dd>
526 editor window 526 editor window
527 </dd> 527 </dd>
528 </dl> 528 </dl>
529 <a NAME="DebugUI.__clearBreakpoints" ID="DebugUI.__clearBreakpoints"></a> 529 <a NAME="DebugUI.__clearBreakpoints" ID="DebugUI.__clearBreakpoints"></a>
647 <p> 647 <p>
648 Private method to handle the disconnection of the debugger client. 648 Private method to handle the disconnection of the debugger client.
649 </p> 649 </p>
650 <dl> 650 <dl>
651 651
652 <dt><i>unplanned</i></dt> 652 <dt><i>unplanned</i> (bool)</dt>
653 <dd> 653 <dd>
654 True if the client died, False otherwise 654 True if the client died, False otherwise
655 </dd> 655 </dd>
656 </dl> 656 </dl>
657 <a NAME="DebugUI.__clientLine" ID="DebugUI.__clientLine"></a> 657 <a NAME="DebugUI.__clientLine" ID="DebugUI.__clientLine"></a>
725 <p> 725 <p>
726 Private method to handle a syntax error in the debugged program. 726 Private method to handle a syntax error in the debugged program.
727 </p> 727 </p>
728 <dl> 728 <dl>
729 729
730 <dt><i>message</i></dt> 730 <dt><i>message</i> (str)</dt>
731 <dd> 731 <dd>
732 message of the syntax error (string) 732 message of the syntax error
733 </dd> 733 </dd>
734 <dt><i>filename</i></dt> 734 <dt><i>filename</i> (str)</dt>
735 <dd> 735 <dd>
736 translated filename of the syntax error position 736 translated filename of the syntax error position
737 (string) 737 </dd>
738 </dd> 738 <dt><i>lineNo</i> (int)</dt>
739 <dt><i>lineNo</i></dt> 739 <dd>
740 <dd> 740 line number of the syntax error position
741 line number of the syntax error position (integer) 741 </dd>
742 </dd> 742 <dt><i>characterNo</i> (int)</dt>
743 <dt><i>characterNo</i></dt>
744 <dd> 743 <dd>
745 character number of the syntax error position 744 character number of the syntax error position
746 (integer)
747 </dd> 745 </dd>
748 </dl> 746 </dl>
749 <a NAME="DebugUI.__clientThreadSet" ID="DebugUI.__clientThreadSet"></a> 747 <a NAME="DebugUI.__clientThreadSet" ID="DebugUI.__clientThreadSet"></a>
750 <h4>DebugUI.__clientThreadSet</h4> 748 <h4>DebugUI.__clientThreadSet</h4>
751 <b>__clientThreadSet</b>(<i>debuggerId</i>) 749 <b>__clientThreadSet</b>(<i>debuggerId</i>)
884 <p> 882 <p>
885 Private slot handling the cursorChanged signal of the viewmanager. 883 Private slot handling the cursorChanged signal of the viewmanager.
886 </p> 884 </p>
887 <dl> 885 <dl>
888 886
889 <dt><i>editor</i></dt> 887 <dt><i>editor</i> (Editor)</dt>
890 <dd> 888 <dd>
891 editor window 889 editor window
892 </dd> 890 </dd>
893 </dl> 891 </dl>
894 <a NAME="DebugUI.__debugProject" ID="DebugUI.__debugProject"></a> 892 <a NAME="DebugUI.__debugProject" ID="DebugUI.__debugProject"></a>
927 <p> 925 <p>
928 Private slot to handle the editorOpened signal. 926 Private slot to handle the editorOpened signal.
929 </p> 927 </p>
930 <dl> 928 <dl>
931 929
932 <dt><i>fn</i></dt> 930 <dt><i>fn</i> (str)</dt>
933 <dd> 931 <dd>
934 filename of the opened editor 932 filename of the opened editor
935 </dd> 933 </dd>
936 </dl> 934 </dl>
937 <a NAME="DebugUI.__enterRemote" ID="DebugUI.__enterRemote"></a> 935 <a NAME="DebugUI.__enterRemote" ID="DebugUI.__enterRemote"></a>
1034 <p> 1032 <p>
1035 Private slot to handle a passive debug session start. 1033 Private slot to handle a passive debug session start.
1036 </p> 1034 </p>
1037 <dl> 1035 <dl>
1038 1036
1039 <dt><i>fn</i></dt> 1037 <dt><i>fn</i> (str)</dt>
1040 <dd> 1038 <dd>
1041 filename of the debugged script 1039 filename of the debugged script
1042 </dd> 1040 </dd>
1043 <dt><i>exc</i></dt> 1041 <dt><i>exc</i> (bool)</dt>
1044 <dd> 1042 <dd>
1045 flag to enable exception reporting of the IDE (boolean) 1043 flag to enable exception reporting of the IDE
1046 </dd> 1044 </dd>
1047 </dl> 1045 </dl>
1048 <a NAME="DebugUI.__previousBreakpoint" ID="DebugUI.__previousBreakpoint"></a> 1046 <a NAME="DebugUI.__previousBreakpoint" ID="DebugUI.__previousBreakpoint"></a>
1049 <h4>DebugUI.__previousBreakpoint</h4> 1047 <h4>DebugUI.__previousBreakpoint</h4>
1050 <b>__previousBreakpoint</b>(<i></i>) 1048 <b>__previousBreakpoint</b>(<i></i>)
1264 </dd> 1262 </dd>
1265 <dt><i>workDir</i> (str)</dt> 1263 <dt><i>workDir</i> (str)</dt>
1266 <dd> 1264 <dd>
1267 working directory for the script 1265 working directory for the script
1268 </dd> 1266 </dd>
1269 <dt><i>environment</i> (str)</dt> 1267 <dt><i>environment</i> (str or dict)</dt>
1270 <dd> 1268 <dd>
1271 string defining the additional or changed environment 1269 environment parameter override for the debug run
1272 variables
1273 </dd> 1270 </dd>
1274 <dt><i>clientType</i> (str)</dt> 1271 <dt><i>clientType</i> (str)</dt>
1275 <dd> 1272 <dd>
1276 type (language) of the debug client to be used 1273 type (language) of the debug client to be used
1277 </dd> 1274 </dd>
1364 Public method to get a list of all actions. 1361 Public method to get a list of all actions.
1365 </p> 1362 </p>
1366 <dl> 1363 <dl>
1367 <dt>Return:</dt> 1364 <dt>Return:</dt>
1368 <dd> 1365 <dd>
1369 list of all actions (list of EricAction) 1366 list of all actions
1367 </dd>
1368 </dl>
1369 <dl>
1370 <dt>Return Type:</dt>
1371 <dd>
1372 list of EricAction
1370 </dd> 1373 </dd>
1371 </dl> 1374 </dl>
1372 <a NAME="DebugUI.getProjectEnvironmentString" ID="DebugUI.getProjectEnvironmentString"></a> 1375 <a NAME="DebugUI.getProjectEnvironmentString" ID="DebugUI.getProjectEnvironmentString"></a>
1373 <h4>DebugUI.getProjectEnvironmentString</h4> 1376 <h4>DebugUI.getProjectEnvironmentString</h4>
1374 <b>getProjectEnvironmentString</b>(<i></i>) 1377 <b>getProjectEnvironmentString</b>(<i></i>)
1425 <dt>Return:</dt> 1428 <dt>Return:</dt>
1426 <dd> 1429 <dd>
1427 the generated menu 1430 the generated menu
1428 </dd> 1431 </dd>
1429 </dl> 1432 </dl>
1433 <dl>
1434 <dt>Return Type:</dt>
1435 <dd>
1436 QMenu
1437 </dd>
1438 </dl>
1430 <a NAME="DebugUI.initToolbars" ID="DebugUI.initToolbars"></a> 1439 <a NAME="DebugUI.initToolbars" ID="DebugUI.initToolbars"></a>
1431 <h4>DebugUI.initToolbars</h4> 1440 <h4>DebugUI.initToolbars</h4>
1432 <b>initToolbars</b>(<i>toolbarManager</i>) 1441 <b>initToolbars</b>(<i>toolbarManager</i>)
1433 1442
1434 <p> 1443 <p>
1435 Public slot to initialize the debug toolbars. 1444 Public slot to initialize the debug toolbars.
1436 </p> 1445 </p>
1437 <dl> 1446 <dl>
1438 1447
1439 <dt><i>toolbarManager</i></dt> 1448 <dt><i>toolbarManager</i> (EricToolBarManager)</dt>
1440 <dd> 1449 <dd>
1441 reference to a toolbar manager object 1450 reference to a toolbar manager object
1442 (EricToolBarManager)
1443 </dd> 1451 </dd>
1444 </dl> 1452 </dl>
1445 <dl> 1453 <dl>
1446 <dt>Return:</dt> 1454 <dt>Return:</dt>
1447 <dd> 1455 <dd>
1448 the generated toolbars (list of QToolBar) 1456 the generated toolbars
1457 </dd>
1458 </dl>
1459 <dl>
1460 <dt>Return Type:</dt>
1461 <dd>
1462 list of QToolBar
1449 </dd> 1463 </dd>
1450 </dl> 1464 </dl>
1451 <a NAME="DebugUI.setArgvHistory" ID="DebugUI.setArgvHistory"></a> 1465 <a NAME="DebugUI.setArgvHistory" ID="DebugUI.setArgvHistory"></a>
1452 <h4>DebugUI.setArgvHistory</h4> 1466 <h4>DebugUI.setArgvHistory</h4>
1453 <b>setArgvHistory</b>(<i>argsStr, clearHistories=False, history=None</i>) 1467 <b>setArgvHistory</b>(<i>argsStr, clearHistories=False, history=None</i>)
1455 <p> 1469 <p>
1456 Public slot to initialize the argv history. 1470 Public slot to initialize the argv history.
1457 </p> 1471 </p>
1458 <dl> 1472 <dl>
1459 1473
1460 <dt><i>argsStr</i></dt> 1474 <dt><i>argsStr</i> (str)</dt>
1461 <dd> 1475 <dd>
1462 the commandline arguments (string) 1476 command line arguments
1463 </dd> 1477 </dd>
1464 <dt><i>clearHistories</i></dt> 1478 <dt><i>clearHistories</i> (bool)</dt>
1465 <dd> 1479 <dd>
1466 flag indicating, that the list should 1480 flag indicating, that the list should be cleared
1467 be cleared (boolean) 1481 </dd>
1468 </dd> 1482 <dt><i>history</i> (list of str)</dt>
1469 <dt><i>history</i></dt> 1483 <dd>
1470 <dd> 1484 list of history entries to be set
1471 list of history entries to be set (list of strings)
1472 </dd> 1485 </dd>
1473 </dl> 1486 </dl>
1474 <a NAME="DebugUI.setAutoClearShell" ID="DebugUI.setAutoClearShell"></a> 1487 <a NAME="DebugUI.setAutoClearShell" ID="DebugUI.setAutoClearShell"></a>
1475 <h4>DebugUI.setAutoClearShell</h4> 1488 <h4>DebugUI.setAutoClearShell</h4>
1476 <b>setAutoClearShell</b>(<i>autoClearShell</i>) 1489 <b>setAutoClearShell</b>(<i>autoClearShell</i>)
1478 <p> 1491 <p>
1479 Public slot to initialize the autoClearShell flag. 1492 Public slot to initialize the autoClearShell flag.
1480 </p> 1493 </p>
1481 <dl> 1494 <dl>
1482 1495
1483 <dt><i>autoClearShell</i></dt> 1496 <dt><i>autoClearShell</i> (bool)</dt>
1484 <dd> 1497 <dd>
1485 flag indicating, that the interpreter window 1498 flag indicating, that the interpreter window
1486 should be cleared (boolean) 1499 should be cleared
1487 </dd> 1500 </dd>
1488 </dl> 1501 </dl>
1489 <a NAME="DebugUI.setAutoContinue" ID="DebugUI.setAutoContinue"></a> 1502 <a NAME="DebugUI.setAutoContinue" ID="DebugUI.setAutoContinue"></a>
1490 <h4>DebugUI.setAutoContinue</h4> 1503 <h4>DebugUI.setAutoContinue</h4>
1491 <b>setAutoContinue</b>(<i>autoContinue</i>) 1504 <b>setAutoContinue</b>(<i>autoContinue</i>)
1493 <p> 1506 <p>
1494 Public slot to initialize the autoContinue flag. 1507 Public slot to initialize the autoContinue flag.
1495 </p> 1508 </p>
1496 <dl> 1509 <dl>
1497 1510
1498 <dt><i>autoContinue</i></dt> 1511 <dt><i>autoContinue</i> (bool)</dt>
1499 <dd> 1512 <dd>
1500 flag indicating, that the debugger should not 1513 flag indicating, that the debugger should not
1501 stop at the first executable line (boolean) 1514 stop at the first executable line
1502 </dd> 1515 </dd>
1503 </dl> 1516 </dl>
1504 <a NAME="DebugUI.setDebugActionsEnabled" ID="DebugUI.setDebugActionsEnabled"></a> 1517 <a NAME="DebugUI.setDebugActionsEnabled" ID="DebugUI.setDebugActionsEnabled"></a>
1505 <h4>DebugUI.setDebugActionsEnabled</h4> 1518 <h4>DebugUI.setDebugActionsEnabled</h4>
1506 <b>setDebugActionsEnabled</b>(<i>enable</i>) 1519 <b>setDebugActionsEnabled</b>(<i>enable</i>)
1553 <p> 1566 <p>
1554 Public slot to initialize the env history. 1567 Public slot to initialize the env history.
1555 </p> 1568 </p>
1556 <dl> 1569 <dl>
1557 1570
1558 <dt><i>envStr</i></dt> 1571 <dt><i>envStr</i> (str)</dt>
1559 <dd> 1572 <dd>
1560 the environment settings (string) 1573 the environment settings
1561 </dd> 1574 </dd>
1562 <dt><i>clearHistories</i></dt> 1575 <dt><i>clearHistories</i> (bool)</dt>
1563 <dd> 1576 <dd>
1564 flag indicating, that the list should 1577 flag indicating, that the list should be cleared
1565 be cleared (boolean) 1578 </dd>
1566 </dd> 1579 <dt><i>history</i> (list of str)</dt>
1567 <dt><i>history</i></dt> 1580 <dd>
1568 <dd> 1581 list of history entries to be set
1569 list of history entries to be set (list of strings)
1570 </dd> 1582 </dd>
1571 </dl> 1583 </dl>
1572 <a NAME="DebugUI.setExcIgnoreList" ID="DebugUI.setExcIgnoreList"></a> 1584 <a NAME="DebugUI.setExcIgnoreList" ID="DebugUI.setExcIgnoreList"></a>
1573 <h4>DebugUI.setExcIgnoreList</h4> 1585 <h4>DebugUI.setExcIgnoreList</h4>
1574 <b>setExcIgnoreList</b>(<i>excIgnoreList</i>) 1586 <b>setExcIgnoreList</b>(<i>excIgnoreList</i>)
1576 <p> 1588 <p>
1577 Public slot to initialize the ignored exceptions type list. 1589 Public slot to initialize the ignored exceptions type list.
1578 </p> 1590 </p>
1579 <dl> 1591 <dl>
1580 1592
1581 <dt><i>excIgnoreList</i></dt> 1593 <dt><i>excIgnoreList</i> (list of str)</dt>
1582 <dd> 1594 <dd>
1583 list of ignored exception types (list of strings) 1595 list of ignored exception types
1584 </dd> 1596 </dd>
1585 </dl> 1597 </dl>
1586 <a NAME="DebugUI.setExcList" ID="DebugUI.setExcList"></a> 1598 <a NAME="DebugUI.setExcList" ID="DebugUI.setExcList"></a>
1587 <h4>DebugUI.setExcList</h4> 1599 <h4>DebugUI.setExcList</h4>
1588 <b>setExcList</b>(<i>excList</i>) 1600 <b>setExcList</b>(<i>excList</i>)
1590 <p> 1602 <p>
1591 Public slot to initialize the exceptions type list. 1603 Public slot to initialize the exceptions type list.
1592 </p> 1604 </p>
1593 <dl> 1605 <dl>
1594 1606
1595 <dt><i>excList</i></dt> 1607 <dt><i>excList</i> (list of str)</dt>
1596 <dd> 1608 <dd>
1597 list of exception types (list of strings) 1609 list of exception types
1598 </dd> 1610 </dd>
1599 </dl> 1611 </dl>
1600 <a NAME="DebugUI.setExceptionReporting" ID="DebugUI.setExceptionReporting"></a> 1612 <a NAME="DebugUI.setExceptionReporting" ID="DebugUI.setExceptionReporting"></a>
1601 <h4>DebugUI.setExceptionReporting</h4> 1613 <h4>DebugUI.setExceptionReporting</h4>
1602 <b>setExceptionReporting</b>(<i>reportAllExceptions</i>) 1614 <b>setExceptionReporting</b>(<i>reportAllExceptions</i>)
1664 <p> 1676 <p>
1665 Public slot to initialize the trace Python flag. 1677 Public slot to initialize the trace Python flag.
1666 </p> 1678 </p>
1667 <dl> 1679 <dl>
1668 1680
1669 <dt><i>tracePython</i></dt> 1681 <dt><i>tracePython</i> (bool)</dt>
1670 <dd> 1682 <dd>
1671 flag indicating if the Python library should be 1683 flag indicating if the Python library should be
1672 traced as well (boolean) 1684 traced as well
1673 </dd> 1685 </dd>
1674 </dl> 1686 </dl>
1675 <a NAME="DebugUI.setWdHistory" ID="DebugUI.setWdHistory"></a> 1687 <a NAME="DebugUI.setWdHistory" ID="DebugUI.setWdHistory"></a>
1676 <h4>DebugUI.setWdHistory</h4> 1688 <h4>DebugUI.setWdHistory</h4>
1677 <b>setWdHistory</b>(<i>wdStr, clearHistories=False, history=None</i>) 1689 <b>setWdHistory</b>(<i>wdStr, clearHistories=False, history=None</i>)
1679 <p> 1691 <p>
1680 Public slot to initialize the wd history. 1692 Public slot to initialize the wd history.
1681 </p> 1693 </p>
1682 <dl> 1694 <dl>
1683 1695
1684 <dt><i>wdStr</i></dt> 1696 <dt><i>wdStr</i> (str)</dt>
1685 <dd> 1697 <dd>
1686 the working directory (string) 1698 working directory
1687 </dd> 1699 </dd>
1688 <dt><i>clearHistories</i></dt> 1700 <dt><i>clearHistories</i> (bool)</dt>
1689 <dd> 1701 <dd>
1690 flag indicating, that the list should 1702 flag indicating, that the list should be cleared
1691 be cleared (boolean) 1703 </dd>
1692 </dd> 1704 <dt><i>history</i> (list of str)</dt>
1693 <dt><i>history</i></dt> 1705 <dd>
1694 <dd> 1706 list of history entries to be set
1695 list of history entries to be set (list of strings)
1696 </dd> 1707 </dd>
1697 </dl> 1708 </dl>
1698 <a NAME="DebugUI.showNotification" ID="DebugUI.showNotification"></a> 1709 <a NAME="DebugUI.showNotification" ID="DebugUI.showNotification"></a>
1699 <h4>DebugUI.showNotification</h4> 1710 <h4>DebugUI.showNotification</h4>
1700 <b>showNotification</b>(<i>notification, kind=NotificationTypes.INFORMATION, timeout=None</i>) 1711 <b>showNotification</b>(<i>notification, kind=NotificationTypes.INFORMATION, timeout=None</i>)
1739 <dt>Return:</dt> 1750 <dt>Return:</dt>
1740 <dd> 1751 <dd>
1741 always true 1752 always true
1742 </dd> 1753 </dd>
1743 </dl> 1754 </dl>
1755 <dl>
1756 <dt>Return Type:</dt>
1757 <dd>
1758 bool
1759 </dd>
1760 </dl>
1744 <a NAME="DebugUI.variablesFilter" ID="DebugUI.variablesFilter"></a> 1761 <a NAME="DebugUI.variablesFilter" ID="DebugUI.variablesFilter"></a>
1745 <h4>DebugUI.variablesFilter</h4> 1762 <h4>DebugUI.variablesFilter</h4>
1746 <b>variablesFilter</b>(<i>scope</i>) 1763 <b>variablesFilter</b>(<i>scope</i>)
1747 1764
1748 <p> 1765 <p>
1749 Public method to get the variables filter for a scope. 1766 Public method to get the variables filter for a scope.
1750 </p> 1767 </p>
1751 <dl> 1768 <dl>
1752 1769
1753 <dt><i>scope</i></dt> 1770 <dt><i>scope</i> (bool)</dt>
1754 <dd> 1771 <dd>
1755 flag indicating global (True) or local (False) scope 1772 flag indicating global (True) or local (False) scope
1756 </dd> 1773 </dd>
1757 </dl> 1774 </dl>
1758 <dl> 1775 <dl>

eric ide

mercurial