eric6/Documentation/Source/eric6.UI.UserInterface.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8049
af58c1d47e5e
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
135 135
136 <p> 136 <p>
137 Private method returning number of characters to write. 137 Private method returning number of characters to write.
138 </p> 138 </p>
139 <dl> 139 <dl>
140 <dt>Returns:</dt> 140 <dt>Return:</dt>
141 <dd> 141 <dd>
142 number of characters buffered or length of buffered line 142 number of characters buffered or length of buffered line
143 (integer) 143 (integer)
144 </dd> 144 </dd>
145 </dl> 145 </dl>
201 <dt>masterPasswordChanged(str, str)</dt> 201 <dt>masterPasswordChanged(str, str)</dt>
202 <dd> 202 <dd>
203 emitted after the master 203 emitted after the master
204 password has been changed with the old and the new password 204 password has been changed with the old and the new password
205 </dd> 205 </dd>
206 <dt>onlineStateChanged(online)</dt>
207 <dd>
208 emitted to indicate a change of the
209 network state
210 </dd>
211 <dt>preferencesChanged()</dt> 206 <dt>preferencesChanged()</dt>
212 <dd> 207 <dd>
213 emitted after the preferences were changed 208 emitted after the preferences were changed
214 </dd> 209 </dd>
215 <dt>reloadAPIs()</dt> 210 <dt>reloadAPIs()</dt>
446 <td><a href="#UserInterface.__initDebugToolbarsLayout">__initDebugToolbarsLayout</a></td> 441 <td><a href="#UserInterface.__initDebugToolbarsLayout">__initDebugToolbarsLayout</a></td>
447 <td>Private slot to initialize the toolbars layout for the debug profile.</td> 442 <td>Private slot to initialize the toolbars layout for the debug profile.</td>
448 </tr> 443 </tr>
449 <tr> 444 <tr>
450 <td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td> 445 <td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td>
451 <td>Private slot to initialize the action to show the eric6 documentation.</td> 446 <td>Private slot to initialize the action to show the eric documentation.</td>
452 </tr> 447 </tr>
453 <tr> 448 <tr>
454 <td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td> 449 <td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td>
455 <td>Private slot to create actions for the configured external tools.</td> 450 <td>Private slot to create actions for the configured external tools.</td>
456 </tr> 451 </tr>
514 <td><a href="#UserInterface.__newProject">__newProject</a></td> 509 <td><a href="#UserInterface.__newProject">__newProject</a></td>
515 <td>Private slot to handle the NewProject signal.</td> 510 <td>Private slot to handle the NewProject signal.</td>
516 </tr> 511 </tr>
517 <tr> 512 <tr>
518 <td><a href="#UserInterface.__newWindow">__newWindow</a></td> 513 <td><a href="#UserInterface.__newWindow">__newWindow</a></td>
519 <td>Private slot to start a new instance of eric6.</td> 514 <td>Private slot to start a new instance of eric.</td>
520 </tr>
521 <tr>
522 <td><a href="#UserInterface.__onlineStateChanged">__onlineStateChanged</a></td>
523 <td>Private slot handling changes in online state.</td>
524 </tr> 515 </tr>
525 <tr> 516 <tr>
526 <td><a href="#UserInterface.__openHexEditor">__openHexEditor</a></td> 517 <td><a href="#UserInterface.__openHexEditor">__openHexEditor</a></td>
527 <td>Private slot to open the hex editor window.</td> 518 <td>Private slot to open the hex editor window.</td>
528 </tr> 519 </tr>
634 <td><a href="#UserInterface.__showErrorLog">__showErrorLog</a></td> 625 <td><a href="#UserInterface.__showErrorLog">__showErrorLog</a></td>
635 <td>Private slot to show the most recent error log message.</td> 626 <td>Private slot to show the most recent error log message.</td>
636 </tr> 627 </tr>
637 <tr> 628 <tr>
638 <td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td> 629 <td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td>
639 <td>Private slot to display a dialog show a list of external tools used by eric6.</td> 630 <td>Private slot to display a dialog show a list of external tools used by eric.</td>
640 </tr> 631 </tr>
641 <tr> 632 <tr>
642 <td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td> 633 <td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td>
643 <td>Private slot to display the Extras menu.</td> 634 <td>Private slot to display the Extras menu.</td>
644 </tr> 635 </tr>
673 <tr> 664 <tr>
674 <td><a href="#UserInterface.__showPrevious">__showPrevious</a></td> 665 <td><a href="#UserInterface.__showPrevious">__showPrevious</a></td>
675 <td>Private slot used to show the previous tab or file.</td> 666 <td>Private slot used to show the previous tab or file.</td>
676 </tr> 667 </tr>
677 <tr> 668 <tr>
678 <td><a href="#UserInterface.__showPyQt5Doc">__showPyQt5Doc</a></td> 669 <td><a href="#UserInterface.__showPyQtDoc">__showPyQtDoc</a></td>
679 <td>Private slot to show the PyQt5 documentation.</td> 670 <td>Private slot to show the PyQt5/6 documentation.</td>
680 </tr> 671 </tr>
681 <tr> 672 <tr>
682 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td> 673 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
683 <td>Private slot to show the PySide2 documentation.</td> 674 <td>Private slot to show the PySide2/PySide6 documentation.</td>
684 </tr> 675 </tr>
685 <tr> 676 <tr>
686 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td> 677 <td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
687 <td>Private slot to show the Python 3 documentation.</td> 678 <td>Private slot to show the Python 3 documentation.</td>
688 </tr> 679 </tr>
689 <tr> 680 <tr>
690 <td><a href="#UserInterface.__showQt5Doc">__showQt5Doc</a></td>
691 <td>Private slot to show the Qt5 documentation.</td>
692 </tr>
693 <tr>
694 <td><a href="#UserInterface.__showQtDoc">__showQtDoc</a></td> 681 <td><a href="#UserInterface.__showQtDoc">__showQtDoc</a></td>
695 <td>Private method to show the Qt documentation.</td> 682 <td>Private method to show the Qt documentation.</td>
696 </tr> 683 </tr>
697 <tr> 684 <tr>
698 <td><a href="#UserInterface.__showSettingsMenu">__showSettingsMenu</a></td> 685 <td><a href="#UserInterface.__showSettingsMenu">__showSettingsMenu</a></td>
754 <td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td> 741 <td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td>
755 <td>Private slot to start an external tool process.</td> 742 <td>Private slot to start an external tool process.</td>
756 </tr> 743 </tr>
757 <tr> 744 <tr>
758 <td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td> 745 <td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td>
759 <td>Private slot to start the eric6 web browser.</td> 746 <td>Private slot to start the eric web browser.</td>
760 </tr> 747 </tr>
761 <tr> 748 <tr>
762 <td><a href="#UserInterface.__switchTab">__switchTab</a></td> 749 <td><a href="#UserInterface.__switchTab">__switchTab</a></td>
763 <td>Private slot used to switch between the current and the previous current tab.</td> 750 <td>Private slot used to switch between the current and the previous current tab.</td>
764 </tr> 751 </tr>
862 <td><a href="#UserInterface.__versionsDownloadDone">__versionsDownloadDone</a></td> 849 <td><a href="#UserInterface.__versionsDownloadDone">__versionsDownloadDone</a></td>
863 <td>Private slot called, after the versions file has been downloaded from the internet.</td> 850 <td>Private slot called, after the versions file has been downloaded from the internet.</td>
864 </tr> 851 </tr>
865 <tr> 852 <tr>
866 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td> 853 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
867 <td>Private slot to start the eric6 web browser.</td> 854 <td>Private slot to start the eric web browser.</td>
868 </tr> 855 </tr>
869 <tr> 856 <tr>
870 <td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td> 857 <td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td>
871 <td>Private slot handling the end of the external web browser process.</td> 858 <td>Private slot handling the end of the external web browser process.</td>
872 </tr> 859 </tr>
922 <td><a href="#UserInterface.autoConnectIrc">autoConnectIrc</a></td> 909 <td><a href="#UserInterface.autoConnectIrc">autoConnectIrc</a></td>
923 <td>Public method to initiate the IRC auto connection.</td> 910 <td>Public method to initiate the IRC auto connection.</td>
924 </tr> 911 </tr>
925 <tr> 912 <tr>
926 <td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td> 913 <td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td>
927 <td>Public method to check, if eric6 has been configured.</td> 914 <td>Public method to check, if eric has been configured.</td>
928 </tr> 915 </tr>
929 <tr> 916 <tr>
930 <td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td> 917 <td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td>
931 <td>Public method to check for the presence of an error log and ask the user, what to do with it.</td> 918 <td>Public method to check for the presence of an error log and ask the user, what to do with it.</td>
932 </tr> 919 </tr>
1013 <tr> 1000 <tr>
1014 <td><a href="#UserInterface.handleUrl">handleUrl</a></td> 1001 <td><a href="#UserInterface.handleUrl">handleUrl</a></td>
1015 <td>Public slot to handle opening a URL.</td> 1002 <td>Public slot to handle opening a URL.</td>
1016 </tr> 1003 </tr>
1017 <tr> 1004 <tr>
1018 <td><a href="#UserInterface.isOnline">isOnline</a></td>
1019 <td>Public method to get the online state.</td>
1020 </tr>
1021 <tr>
1022 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td> 1005 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
1023 <td>Public slot to start the help viewer/web browser.</td> 1006 <td>Public slot to start the help viewer/web browser.</td>
1024 </tr> 1007 </tr>
1025 <tr> 1008 <tr>
1026 <td><a href="#UserInterface.networkAccessManager">networkAccessManager</a></td> 1009 <td><a href="#UserInterface.networkAccessManager">networkAccessManager</a></td>
1027 <td>Public method to get a reference to the network access manager object.</td> 1010 <td>Public method to get a reference to the network access manager object.</td>
1028 </tr> 1011 </tr>
1029 <tr> 1012 <tr>
1030 <td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td>
1031 <td>Public method to check, if notifications are enabled.</td>
1032 </tr>
1033 <tr>
1034 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td> 1013 <td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
1035 <td>Public method to check the internet for an eric6 update.</td> 1014 <td>Public method to check the internet for an eric update.</td>
1036 </tr> 1015 </tr>
1037 <tr> 1016 <tr>
1038 <td><a href="#UserInterface.processArgs">processArgs</a></td> 1017 <td><a href="#UserInterface.processArgs">processArgs</a></td>
1039 <td>Public method to process the command line args passed to the UI.</td> 1018 <td>Public method to process the command line args passed to the UI.</td>
1040 </tr> 1019 </tr>
1062 <td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td> 1041 <td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td>
1063 <td>Public slot to activate the debug view profile.</td> 1042 <td>Public slot to activate the debug view profile.</td>
1064 </tr> 1043 </tr>
1065 <tr> 1044 <tr>
1066 <td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td> 1045 <td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td>
1067 <td>Public method to show the eric6 versions available for download.</td> 1046 <td>Public method to show the eric versions available for download.</td>
1068 </tr> 1047 </tr>
1069 <tr> 1048 <tr>
1070 <td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td> 1049 <td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td>
1071 <td>Public slot to show the email dialog in a given mode.</td> 1050 <td>Public slot to show the email dialog in a given mode.</td>
1072 </tr> 1051 </tr>
1110 <td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td> 1089 <td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td>
1111 <td>Public method to unregister a toolbar.</td> 1090 <td>Public method to unregister a toolbar.</td>
1112 </tr> 1091 </tr>
1113 <tr> 1092 <tr>
1114 <td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td> 1093 <td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td>
1115 <td>Public method to check, if the eric6 version is good compared to the required version.</td> 1094 <td>Public method to check, if the eric version is good compared to the required version.</td>
1116 </tr> 1095 </tr>
1117 </table> 1096 </table>
1118 <h3>Static Methods</h3> 1097 <h3>Static Methods</h3>
1119 1098
1120 <table> 1099 <table>
1455 <dd> 1434 <dd>
1456 reference to the started web browser process 1435 reference to the started web browser process
1457 </dd> 1436 </dd>
1458 </dl> 1437 </dl>
1459 <dl> 1438 <dl>
1460 <dt>Returns:</dt> 1439 <dt>Return:</dt>
1461 <dd> 1440 <dd>
1462 error indication (1 = connection not possible, 0 = ok, 1441 error indication (1 = connection not possible, 0 = ok,
1463 -1 = server exited with an error code) 1442 -1 = server exited with an error code)
1464 </dd> 1443 </dd>
1465 </dl> 1444 </dl>
1482 <dd> 1461 <dd>
1483 object name of the new dock window (string) 1462 object name of the new dock window (string)
1484 </dd> 1463 </dd>
1485 </dl> 1464 </dl>
1486 <dl> 1465 <dl>
1487 <dt>Returns:</dt> 1466 <dt>Return:</dt>
1488 <dd> 1467 <dd>
1489 the generated dock window (QDockWindow) 1468 the generated dock window (QDockWindow)
1490 </dd> 1469 </dd>
1491 </dl> 1470 </dl>
1492 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a> 1471 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
1656 <dd> 1635 <dd>
1657 reference to the widget to be saved (QWidget) 1636 reference to the widget to be saved (QWidget)
1658 </dd> 1637 </dd>
1659 </dl> 1638 </dl>
1660 <dl> 1639 <dl>
1661 <dt>Returns:</dt> 1640 <dt>Return:</dt>
1662 <dd> 1641 <dd>
1663 list giving the widget's geometry and its visibility 1642 list giving the widget's geometry and its visibility
1664 </dd> 1643 </dd>
1665 </dl> 1644 </dl>
1666 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a> 1645 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a>
1669 1648
1670 <p> 1649 <p>
1671 Private method to check, if an error log file exists. 1650 Private method to check, if an error log file exists.
1672 </p> 1651 </p>
1673 <dl> 1652 <dl>
1674 <dt>Returns:</dt> 1653 <dt>Return:</dt>
1675 <dd> 1654 <dd>
1676 flag indicating the existence of an error log file (boolean) 1655 flag indicating the existence of an error log file (boolean)
1677 </dd> 1656 </dd>
1678 </dl> 1657 </dl>
1679 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a> 1658 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1714 <a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a> 1693 <a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a>
1715 <h4>UserInterface.__initEricDocAction</h4> 1694 <h4>UserInterface.__initEricDocAction</h4>
1716 <b>__initEricDocAction</b>(<i></i>) 1695 <b>__initEricDocAction</b>(<i></i>)
1717 1696
1718 <p> 1697 <p>
1719 Private slot to initialize the action to show the eric6 documentation. 1698 Private slot to initialize the action to show the eric documentation.
1720 </p> 1699 </p>
1721 <a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a> 1700 <a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a>
1722 <h4>UserInterface.__initExternalToolsActions</h4> 1701 <h4>UserInterface.__initExternalToolsActions</h4>
1723 <b>__initExternalToolsActions</b>(<i></i>) 1702 <b>__initExternalToolsActions</b>(<i></i>)
1724 1703
1824 1803
1825 <dt><i>home</i> (str)</dt> 1804 <dt><i>home</i> (str)</dt>
1826 <dd> 1805 <dd>
1827 filename of file to be shown or URL to be opened 1806 filename of file to be shown or URL to be opened
1828 </dd> 1807 </dd>
1829 <dt><i>searchWord=</i> (str)</dt> 1808 <dt><i>searchWord</i> (str)</dt>
1830 <dd> 1809 <dd>
1831 word to search for 1810 word to search for
1832 </dd> 1811 </dd>
1833 </dl> 1812 </dl>
1834 <dl> 1813 <dl>
1835 <dt>Returns:</dt> 1814 <dt>Return:</dt>
1836 <dd> 1815 <dd>
1837 flag indicating a successful launch 1816 flag indicating a successful launch
1838 </dd> 1817 </dd>
1839 </dl> 1818 </dl>
1840 <dl> 1819 <dl>
1892 <a NAME="UserInterface.__newWindow" ID="UserInterface.__newWindow"></a> 1871 <a NAME="UserInterface.__newWindow" ID="UserInterface.__newWindow"></a>
1893 <h4>UserInterface.__newWindow</h4> 1872 <h4>UserInterface.__newWindow</h4>
1894 <b>__newWindow</b>(<i></i>) 1873 <b>__newWindow</b>(<i></i>)
1895 1874
1896 <p> 1875 <p>
1897 Private slot to start a new instance of eric6. 1876 Private slot to start a new instance of eric.
1898 </p> 1877 </p>
1899 <a NAME="UserInterface.__onlineStateChanged" ID="UserInterface.__onlineStateChanged"></a>
1900 <h4>UserInterface.__onlineStateChanged</h4>
1901 <b>__onlineStateChanged</b>(<i>online</i>)
1902
1903 <p>
1904 Private slot handling changes in online state.
1905 </p>
1906 <dl>
1907
1908 <dt><i>online</i> (bool)</dt>
1909 <dd>
1910 flag indicating the online state
1911 </dd>
1912 </dl>
1913 <a NAME="UserInterface.__openHexEditor" ID="UserInterface.__openHexEditor"></a> 1878 <a NAME="UserInterface.__openHexEditor" ID="UserInterface.__openHexEditor"></a>
1914 <h4>UserInterface.__openHexEditor</h4> 1879 <h4>UserInterface.__openHexEditor</h4>
1915 <b>__openHexEditor</b>(<i>fn=""</i>) 1880 <b>__openHexEditor</b>(<i>fn=""</i>)
1916 1881
1917 <p> 1882 <p>
2032 1997
2033 <p> 1998 <p>
2034 Private method to check for and read a crash session. 1999 Private method to check for and read a crash session.
2035 </p> 2000 </p>
2036 <dl> 2001 <dl>
2037 <dt>Returns:</dt> 2002 <dt>Return:</dt>
2038 <dd> 2003 <dd>
2039 flag indicating a crash session file was found and read 2004 flag indicating a crash session file was found and read
2040 </dd> 2005 </dd>
2041 </dl> 2006 </dl>
2042 <dl> 2007 <dl>
2058 <dd> 2023 <dd>
2059 name of a session file to read 2024 name of a session file to read
2060 </dd> 2025 </dd>
2061 </dl> 2026 </dl>
2062 <dl> 2027 <dl>
2063 <dt>Returns:</dt> 2028 <dt>Return:</dt>
2064 <dd> 2029 <dd>
2065 flag indicating success 2030 flag indicating success
2066 </dd> 2031 </dd>
2067 </dl> 2032 </dl>
2068 <dl> 2033 <dl>
2235 <h4>UserInterface.__showExternalTools</h4> 2200 <h4>UserInterface.__showExternalTools</h4>
2236 <b>__showExternalTools</b>(<i></i>) 2201 <b>__showExternalTools</b>(<i></i>)
2237 2202
2238 <p> 2203 <p>
2239 Private slot to display a dialog show a list of external tools used 2204 Private slot to display a dialog show a list of external tools used
2240 by eric6. 2205 by eric.
2241 </p> 2206 </p>
2242 <a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a> 2207 <a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
2243 <h4>UserInterface.__showExtrasMenu</h4> 2208 <h4>UserInterface.__showExtrasMenu</h4>
2244 <b>__showExtrasMenu</b>(<i></i>) 2209 <b>__showExtrasMenu</b>(<i></i>)
2245 2210
2308 <b>__showPrevious</b>(<i></i>) 2273 <b>__showPrevious</b>(<i></i>)
2309 2274
2310 <p> 2275 <p>
2311 Private slot used to show the previous tab or file. 2276 Private slot used to show the previous tab or file.
2312 </p> 2277 </p>
2313 <a NAME="UserInterface.__showPyQt5Doc" ID="UserInterface.__showPyQt5Doc"></a> 2278 <a NAME="UserInterface.__showPyQtDoc" ID="UserInterface.__showPyQtDoc"></a>
2314 <h4>UserInterface.__showPyQt5Doc</h4> 2279 <h4>UserInterface.__showPyQtDoc</h4>
2315 <b>__showPyQt5Doc</b>(<i></i>) 2280 <b>__showPyQtDoc</b>(<i>variant=5</i>)
2316 2281
2317 <p> 2282 <p>
2318 Private slot to show the PyQt5 documentation. 2283 Private slot to show the PyQt5/6 documentation.
2319 </p> 2284 </p>
2285 <dl>
2286
2287 <dt><i>variant</i> (int or str)</dt>
2288 <dd>
2289 PyQt variant to show documentation for (5 or 6)
2290 </dd>
2291 </dl>
2320 <a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a> 2292 <a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
2321 <h4>UserInterface.__showPySideDoc</h4> 2293 <h4>UserInterface.__showPySideDoc</h4>
2322 <b>__showPySideDoc</b>(<i>variant="2"</i>) 2294 <b>__showPySideDoc</b>(<i>variant=2</i>)
2323 2295
2324 <p> 2296 <p>
2325 Private slot to show the PySide2 documentation. 2297 Private slot to show the PySide2/PySide6 documentation.
2326 </p> 2298 </p>
2327 <dl> 2299 <dl>
2328 2300
2329 <dt><i>variant</i> (str)</dt> 2301 <dt><i>variant</i> (int or str)</dt>
2330 <dd> 2302 <dd>
2331 PySide variant (2) 2303 PySide variant (2 or 6)
2332 </dd> 2304 </dd>
2333 </dl> 2305 </dl>
2334 <a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a> 2306 <a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
2335 <h4>UserInterface.__showPythonDoc</h4> 2307 <h4>UserInterface.__showPythonDoc</h4>
2336 <b>__showPythonDoc</b>(<i></i>) 2308 <b>__showPythonDoc</b>(<i></i>)
2337 2309
2338 <p> 2310 <p>
2339 Private slot to show the Python 3 documentation. 2311 Private slot to show the Python 3 documentation.
2340 </p> 2312 </p>
2341 <a NAME="UserInterface.__showQt5Doc" ID="UserInterface.__showQt5Doc"></a>
2342 <h4>UserInterface.__showQt5Doc</h4>
2343 <b>__showQt5Doc</b>(<i></i>)
2344
2345 <p>
2346 Private slot to show the Qt5 documentation.
2347 </p>
2348 <a NAME="UserInterface.__showQtDoc" ID="UserInterface.__showQtDoc"></a> 2313 <a NAME="UserInterface.__showQtDoc" ID="UserInterface.__showQtDoc"></a>
2349 <h4>UserInterface.__showQtDoc</h4> 2314 <h4>UserInterface.__showQtDoc</h4>
2350 <b>__showQtDoc</b>(<i>version</i>) 2315 <b>__showQtDoc</b>(<i>version</i>)
2351 2316
2352 <p> 2317 <p>
2353 Private method to show the Qt documentation. 2318 Private method to show the Qt documentation.
2354 </p> 2319 </p>
2355 <dl> 2320 <dl>
2356 2321
2357 <dt><i>version</i></dt> 2322 <dt><i>version</i> (int)</dt>
2358 <dd> 2323 <dd>
2359 Qt version to show documentation for (integer) 2324 Qt version to show documentation for
2360 </dd> 2325 </dd>
2361 </dl> 2326 </dl>
2362 <a NAME="UserInterface.__showSettingsMenu" ID="UserInterface.__showSettingsMenu"></a> 2327 <a NAME="UserInterface.__showSettingsMenu" ID="UserInterface.__showSettingsMenu"></a>
2363 <h4>UserInterface.__showSettingsMenu</h4> 2328 <h4>UserInterface.__showSettingsMenu</h4>
2364 <b>__showSettingsMenu</b>(<i></i>) 2329 <b>__showSettingsMenu</b>(<i></i>)
2459 2424
2460 <p> 2425 <p>
2461 Private method to perform all necessary steps to close down the IDE. 2426 Private method to perform all necessary steps to close down the IDE.
2462 </p> 2427 </p>
2463 <dl> 2428 <dl>
2464 <dt>Returns:</dt> 2429 <dt>Return:</dt>
2465 <dd> 2430 <dd>
2466 flag indicating success 2431 flag indicating success
2467 </dd> 2432 </dd>
2468 </dl> 2433 </dl>
2469 <a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a> 2434 <a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a>
2515 <a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a> 2480 <a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
2516 <h4>UserInterface.__startWebBrowser</h4> 2481 <h4>UserInterface.__startWebBrowser</h4>
2517 <b>__startWebBrowser</b>(<i></i>) 2482 <b>__startWebBrowser</b>(<i></i>)
2518 2483
2519 <p> 2484 <p>
2520 Private slot to start the eric6 web browser. 2485 Private slot to start the eric web browser.
2521 </p> 2486 </p>
2522 <a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a> 2487 <a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
2523 <h4>UserInterface.__switchTab</h4> 2488 <h4>UserInterface.__switchTab</h4>
2524 <b>__switchTab</b>(<i></i>) 2489 <b>__switchTab</b>(<i></i>)
2525 2490
2582 <dd> 2547 <dd>
2583 reference to the workspace editor window 2548 reference to the workspace editor window
2584 </dd> 2549 </dd>
2585 </dl> 2550 </dl>
2586 <dl> 2551 <dl>
2587 <dt>Returns:</dt> 2552 <dt>Return:</dt>
2588 <dd> 2553 <dd>
2589 flag indicating, if the window was shown (boolean) 2554 flag indicating, if the window was shown (boolean)
2590 </dd> 2555 </dd>
2591 </dl> 2556 </dl>
2592 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a> 2557 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
2768 <dd> 2733 <dd>
2769 version string 2734 version string
2770 </dd> 2735 </dd>
2771 </dl> 2736 </dl>
2772 <dl> 2737 <dl>
2773 <dt>Returns:</dt> 2738 <dt>Return:</dt>
2774 <dd> 2739 <dd>
2775 version tuple 2740 version tuple
2776 </dd> 2741 </dd>
2777 </dl> 2742 </dl>
2778 <dl> 2743 <dl>
2806 <a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a> 2771 <a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a>
2807 <h4>UserInterface.__webBrowser</h4> 2772 <h4>UserInterface.__webBrowser</h4>
2808 <b>__webBrowser</b>(<i>home=""</i>) 2773 <b>__webBrowser</b>(<i>home=""</i>)
2809 2774
2810 <p> 2775 <p>
2811 Private slot to start the eric6 web browser. 2776 Private slot to start the eric web browser.
2812 </p> 2777 </p>
2813 <dl> 2778 <dl>
2814 2779
2815 <dt><i>home</i></dt> 2780 <dt><i>home</i></dt>
2816 <dd> 2781 <dd>
2862 <dd> 2827 <dd>
2863 flag indicating to write a crash session file 2828 flag indicating to write a crash session file
2864 </dd> 2829 </dd>
2865 </dl> 2830 </dl>
2866 <dl> 2831 <dl>
2867 <dt>Returns:</dt> 2832 <dt>Return:</dt>
2868 <dd> 2833 <dd>
2869 flag indicating success 2834 flag indicating success
2870 </dd> 2835 </dd>
2871 </dl> 2836 </dl>
2872 <dl> 2837 <dl>
2994 <a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a> 2959 <a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a>
2995 <h4>UserInterface.checkConfigurationStatus</h4> 2960 <h4>UserInterface.checkConfigurationStatus</h4>
2996 <b>checkConfigurationStatus</b>(<i></i>) 2961 <b>checkConfigurationStatus</b>(<i></i>)
2997 2962
2998 <p> 2963 <p>
2999 Public method to check, if eric6 has been configured. If it is not, 2964 Public method to check, if eric has been configured. If it is not,
3000 the configuration dialog is shown. 2965 the configuration dialog is shown.
3001 </p> 2966 </p>
3002 <a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a> 2967 <a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
3003 <h4>UserInterface.checkForErrorLog</h4> 2968 <h4>UserInterface.checkForErrorLog</h4>
3004 <b>checkForErrorLog</b>(<i></i>) 2969 <b>checkForErrorLog</b>(<i></i>)
3045 3010
3046 <p> 3011 <p>
3047 Public method to create the toolbars menu for Qt. 3012 Public method to create the toolbars menu for Qt.
3048 </p> 3013 </p>
3049 <dl> 3014 <dl>
3050 <dt>Returns:</dt> 3015 <dt>Return:</dt>
3051 <dd> 3016 <dd>
3052 toolbars menu (QMenu) 3017 toolbars menu (QMenu)
3053 </dd> 3018 </dd>
3054 </dl> 3019 </dl>
3055 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a> 3020 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a>
3058 3023
3059 <p> 3024 <p>
3060 Public method to provide a reference to the code documentation viewer. 3025 Public method to provide a reference to the code documentation viewer.
3061 </p> 3026 </p>
3062 <dl> 3027 <dl>
3063 <dt>Returns:</dt> 3028 <dt>Return:</dt>
3064 <dd> 3029 <dd>
3065 reference to the code documentation viewer 3030 reference to the code documentation viewer
3066 </dd> 3031 </dd>
3067 </dl> 3032 </dl>
3068 <dl> 3033 <dl>
3141 string denoting the action set to get. 3106 string denoting the action set to get.
3142 It must be one of "ui" or "wizards". 3107 It must be one of "ui" or "wizards".
3143 </dd> 3108 </dd>
3144 </dl> 3109 </dl>
3145 <dl> 3110 <dl>
3146 <dt>Returns:</dt> 3111 <dt>Return:</dt>
3147 <dd> 3112 <dd>
3148 list of all actions (list of E5Action) 3113 list of all actions (list of E5Action)
3149 </dd> 3114 </dd>
3150 </dl> 3115 </dl>
3151 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a> 3116 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
3154 3119
3155 <p> 3120 <p>
3156 Public method to get the current layout type. 3121 Public method to get the current layout type.
3157 </p> 3122 </p>
3158 <dl> 3123 <dl>
3159 <dt>Returns:</dt> 3124 <dt>Return:</dt>
3160 <dd> 3125 <dd>
3161 current layout type 3126 current layout type
3162 </dd> 3127 </dd>
3163 </dl> 3128 </dl>
3164 <dl> 3129 <dl>
3173 3138
3174 <p> 3139 <p>
3175 Public method to get the locale of the IDE. 3140 Public method to get the locale of the IDE.
3176 </p> 3141 </p>
3177 <dl> 3142 <dl>
3178 <dt>Returns:</dt> 3143 <dt>Return:</dt>
3179 <dd> 3144 <dd>
3180 locale of the IDE (string or None) 3145 locale of the IDE (string or None)
3181 </dd> 3146 </dd>
3182 </dl> 3147 </dl>
3183 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a> 3148 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
3193 <dd> 3158 <dd>
3194 name of the menu (string) 3159 name of the menu (string)
3195 </dd> 3160 </dd>
3196 </dl> 3161 </dl>
3197 <dl> 3162 <dl>
3198 <dt>Returns:</dt> 3163 <dt>Return:</dt>
3199 <dd> 3164 <dd>
3200 reference to the menu (QMenu) 3165 reference to the menu (QMenu)
3201 </dd> 3166 </dd>
3202 </dl> 3167 </dl>
3203 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a> 3168 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
3218 object name of the action to search for 3183 object name of the action to search for
3219 (string) 3184 (string)
3220 </dd> 3185 </dd>
3221 </dl> 3186 </dl>
3222 <dl> 3187 <dl>
3223 <dt>Returns:</dt> 3188 <dt>Return:</dt>
3224 <dd> 3189 <dd>
3225 reference to the menu action (QAction) 3190 reference to the menu action (QAction)
3226 </dd> 3191 </dd>
3227 </dl> 3192 </dl>
3228 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a> 3193 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
3238 <dd> 3203 <dd>
3239 name of the menu to search in (string) 3204 name of the menu to search in (string)
3240 </dd> 3205 </dd>
3241 </dl> 3206 </dl>
3242 <dl> 3207 <dl>
3243 <dt>Returns:</dt> 3208 <dt>Return:</dt>
3244 <dd> 3209 <dd>
3245 reference to the menu bar action (QAction) 3210 reference to the menu bar action (QAction)
3246 </dd> 3211 </dd>
3247 </dl> 3212 </dl>
3248 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a> 3213 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a>
3249 <h4>UserInterface.getOriginalPathString</h4> 3214 <h4>UserInterface.getOriginalPathString</h4>
3250 <b>getOriginalPathString</b>(<i></i>) 3215 <b>getOriginalPathString</b>(<i></i>)
3251 3216
3252 <p> 3217 <p>
3253 Public method to get the original PATH environment variable 3218 Public method to get the original PATH environment variable
3254 (i.e. before modifications by eric6 and PyQt5). 3219 (i.e. before modifications by eric and PyQt5).
3255 </p> 3220 </p>
3256 <dl> 3221 <dl>
3257 <dt>Returns:</dt> 3222 <dt>Return:</dt>
3258 <dd> 3223 <dd>
3259 original PATH environment variable 3224 original PATH environment variable
3260 </dd> 3225 </dd>
3261 </dl> 3226 </dl>
3262 <dl> 3227 <dl>
3271 3236
3272 <p> 3237 <p>
3273 Public method to get the toolbar icon size. 3238 Public method to get the toolbar icon size.
3274 </p> 3239 </p>
3275 <dl> 3240 <dl>
3276 <dt>Returns:</dt> 3241 <dt>Return:</dt>
3277 <dd> 3242 <dd>
3278 toolbar icon size (QSize) 3243 toolbar icon size (QSize)
3279 </dd> 3244 </dd>
3280 </dl> 3245 </dl>
3281 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a> 3246 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
3291 <dd> 3256 <dd>
3292 name of the toolbar (string) 3257 name of the toolbar (string)
3293 </dd> 3258 </dd>
3294 </dl> 3259 </dl>
3295 <dl> 3260 <dl>
3296 <dt>Returns:</dt> 3261 <dt>Return:</dt>
3297 <dd> 3262 <dd>
3298 reference to the toolbar entry (tuple of string and QToolBar) 3263 reference to the toolbar entry (tuple of string and QToolBar)
3299 </dd> 3264 </dd>
3300 </dl> 3265 </dl>
3301 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a> 3266 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a>
3312 <dd> 3277 <dd>
3313 toolbar category 3278 toolbar category
3314 </dd> 3279 </dd>
3315 </dl> 3280 </dl>
3316 <dl> 3281 <dl>
3317 <dt>Returns:</dt> 3282 <dt>Return:</dt>
3318 <dd> 3283 <dd>
3319 list of toolbars 3284 list of toolbars
3320 </dd> 3285 </dd>
3321 </dl> 3286 </dl>
3322 <dl> 3287 <dl>
3331 3296
3332 <p> 3297 <p>
3333 Public method to get the current view profile. 3298 Public method to get the current view profile.
3334 </p> 3299 </p>
3335 <dl> 3300 <dl>
3336 <dt>Returns:</dt> 3301 <dt>Return:</dt>
3337 <dd> 3302 <dd>
3338 the name of the current view profile (string) 3303 the name of the current view profile (string)
3339 </dd> 3304 </dd>
3340 </dl> 3305 </dl>
3341 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a> 3306 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
3350 <dt><i>url</i> (QUrl)</dt> 3315 <dt><i>url</i> (QUrl)</dt>
3351 <dd> 3316 <dd>
3352 URL to be shown 3317 URL to be shown
3353 </dd> 3318 </dd>
3354 </dl> 3319 </dl>
3355 <a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a>
3356 <h4>UserInterface.isOnline</h4>
3357 <b>isOnline</b>(<i></i>)
3358
3359 <p>
3360 Public method to get the online state.
3361 </p>
3362 <dl>
3363 <dt>Returns:</dt>
3364 <dd>
3365 online state
3366 </dd>
3367 </dl>
3368 <dl>
3369 <dt>Return Type:</dt>
3370 <dd>
3371 bool
3372 </dd>
3373 </dl>
3374 <a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a> 3320 <a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
3375 <h4>UserInterface.launchHelpViewer</h4> 3321 <h4>UserInterface.launchHelpViewer</h4>
3376 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>) 3322 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
3377 3323
3378 <p> 3324 <p>
3382 3328
3383 <dt><i>home</i> (str or QUrl)</dt> 3329 <dt><i>home</i> (str or QUrl)</dt>
3384 <dd> 3330 <dd>
3385 filename of file to be shown or URL to be opened 3331 filename of file to be shown or URL to be opened
3386 </dd> 3332 </dd>
3387 <dt><i>searchWord=</i> (str)</dt> 3333 <dt><i>searchWord</i> (str)</dt>
3388 <dd> 3334 <dd>
3389 word to search for 3335 word to search for
3390 </dd> 3336 </dd>
3391 <dt><i>useSingle=</i> (bool)</dt> 3337 <dt><i>useSingle</i> (bool)</dt>
3392 <dd> 3338 <dd>
3393 flag indicating to use a single browser window 3339 flag indicating to use a single browser window
3394 </dd> 3340 </dd>
3395 </dl> 3341 </dl>
3396 <a NAME="UserInterface.networkAccessManager" ID="UserInterface.networkAccessManager"></a> 3342 <a NAME="UserInterface.networkAccessManager" ID="UserInterface.networkAccessManager"></a>
3399 3345
3400 <p> 3346 <p>
3401 Public method to get a reference to the network access manager object. 3347 Public method to get a reference to the network access manager object.
3402 </p> 3348 </p>
3403 <dl> 3349 <dl>
3404 <dt>Returns:</dt> 3350 <dt>Return:</dt>
3405 <dd> 3351 <dd>
3406 reference to the network access manager object 3352 reference to the network access manager object
3407 </dd> 3353 </dd>
3408 </dl> 3354 </dl>
3409 <dl> 3355 <dl>
3410 <dt>Return Type:</dt> 3356 <dt>Return Type:</dt>
3411 <dd> 3357 <dd>
3412 QNetworkAccessManager 3358 QNetworkAccessManager
3413 </dd>
3414 </dl>
3415 <a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
3416 <h4>UserInterface.notificationsEnabled</h4>
3417 <b>notificationsEnabled</b>(<i></i>)
3418
3419 <p>
3420 Public method to check, if notifications are enabled.
3421 </p>
3422 <dl>
3423 <dt>Returns:</dt>
3424 <dd>
3425 flag indicating, if notifications are enabled (boolean)
3426 </dd> 3359 </dd>
3427 </dl> 3360 </dl>
3428 <a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a> 3361 <a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
3429 <h4>UserInterface.performVersionCheck</h4> 3362 <h4>UserInterface.performVersionCheck</h4>
3430 <b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>) 3363 <b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>)
3431 3364
3432 <p> 3365 <p>
3433 Public method to check the internet for an eric6 update. 3366 Public method to check the internet for an eric update.
3434 </p> 3367 </p>
3435 <dl> 3368 <dl>
3436 3369
3437 <dt><i>manual</i></dt> 3370 <dt><i>manual</i></dt>
3438 <dd> 3371 <dd>
3440 </dd> 3373 </dd>
3441 <dt><i>alternative</i></dt> 3374 <dt><i>alternative</i></dt>
3442 <dd> 3375 <dd>
3443 index of server to download from (integer) 3376 index of server to download from (integer)
3444 </dd> 3377 </dd>
3445 <dt><i>showVersions=</i></dt> 3378 <dt><i>showVersions</i></dt>
3446 <dd> 3379 <dd>
3447 flag indicating the show versions mode (boolean) 3380 flag indicating the show versions mode (boolean)
3448 </dd> 3381 </dd>
3449 </dl> 3382 </dl>
3450 <a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a> 3383 <a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a>
3586 <a NAME="UserInterface.showAvailableVersionsInfo" ID="UserInterface.showAvailableVersionsInfo"></a> 3519 <a NAME="UserInterface.showAvailableVersionsInfo" ID="UserInterface.showAvailableVersionsInfo"></a>
3587 <h4>UserInterface.showAvailableVersionsInfo</h4> 3520 <h4>UserInterface.showAvailableVersionsInfo</h4>
3588 <b>showAvailableVersionsInfo</b>(<i></i>) 3521 <b>showAvailableVersionsInfo</b>(<i></i>)
3589 3522
3590 <p> 3523 <p>
3591 Public method to show the eric6 versions available for download. 3524 Public method to show the eric versions available for download.
3592 </p> 3525 </p>
3593 <a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a> 3526 <a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
3594 <h4>UserInterface.showEmailDialog</h4> 3527 <h4>UserInterface.showEmailDialog</h4>
3595 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>) 3528 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
3596 3529
3641 <p> 3574 <p>
3642 Public slot to show the Find In Files dialog. 3575 Public slot to show the Find In Files dialog.
3643 </p> 3576 </p>
3644 <dl> 3577 <dl>
3645 3578
3646 <dt><i>txt=</i></dt> 3579 <dt><i>txt</i></dt>
3647 <dd> 3580 <dd>
3648 text to search for (string) 3581 text to search for (string)
3649 </dd> 3582 </dd>
3650 <dt><i>searchDir=</i></dt> 3583 <dt><i>searchDir</i></dt>
3651 <dd> 3584 <dd>
3652 directory to search in (string) 3585 directory to search in (string)
3653 </dd> 3586 </dd>
3654 <dt><i>openFiles=</i></dt> 3587 <dt><i>openFiles</i></dt>
3655 <dd> 3588 <dd>
3656 flag indicating to operate on open files (boolean) 3589 flag indicating to operate on open files (boolean)
3657 </dd> 3590 </dd>
3658 </dl> 3591 </dl>
3659 <a NAME="UserInterface.showLogViewer" ID="UserInterface.showLogViewer"></a> 3592 <a NAME="UserInterface.showLogViewer" ID="UserInterface.showLogViewer"></a>
3663 <p> 3596 <p>
3664 Public method to show the Log-Viewer. 3597 Public method to show the Log-Viewer.
3665 </p> 3598 </p>
3666 <a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a> 3599 <a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a>
3667 <h4>UserInterface.showNotification</h4> 3600 <h4>UserInterface.showNotification</h4>
3668 <b>showNotification</b>(<i>icon, heading, text, timeout=None</i>) 3601 <b>showNotification</b>(<i>icon, heading, text, kind=NotificationTypes.Information, timeout=None</i>)
3669 3602
3670 <p> 3603 <p>
3671 Public method to show a desktop notification. 3604 Public method to show a desktop notification.
3672 </p> 3605 </p>
3673 <dl> 3606 <dl>
3681 heading of the notification 3614 heading of the notification
3682 </dd> 3615 </dd>
3683 <dt><i>text</i> (str)</dt> 3616 <dt><i>text</i> (str)</dt>
3684 <dd> 3617 <dd>
3685 text of the notification 3618 text of the notification
3619 </dd>
3620 <dt><i>kind</i> (NotificationTypes)</dt>
3621 <dd>
3622 kind of notification to be shown
3686 </dd> 3623 </dd>
3687 <dt><i>timeout</i> (int)</dt> 3624 <dt><i>timeout</i> (int)</dt>
3688 <dd> 3625 <dd>
3689 time in seconds the notification should be shown 3626 time in seconds the notification should be shown
3690 (None = use configured timeout, 0 = indefinitely) 3627 (None = use configured timeout, 0 = indefinitely)
3718 <p> 3655 <p>
3719 Public slot to show the Find & Replace In Files dialog. 3656 Public slot to show the Find & Replace In Files dialog.
3720 </p> 3657 </p>
3721 <dl> 3658 <dl>
3722 3659
3723 <dt><i>txt=</i></dt> 3660 <dt><i>txt</i></dt>
3724 <dd> 3661 <dd>
3725 text to search for (string) 3662 text to search for (string)
3726 </dd> 3663 </dd>
3727 <dt><i>searchDir=</i></dt> 3664 <dt><i>searchDir</i></dt>
3728 <dd> 3665 <dd>
3729 directory to search in (string) 3666 directory to search in (string)
3730 </dd> 3667 </dd>
3731 <dt><i>openFiles=</i></dt> 3668 <dt><i>openFiles</i></dt>
3732 <dd> 3669 <dd>
3733 flag indicating to operate on open files (boolean) 3670 flag indicating to operate on open files (boolean)
3734 </dd> 3671 </dd>
3735 </dl> 3672 </dl>
3736 <a NAME="UserInterface.showSideWidget" ID="UserInterface.showSideWidget"></a> 3673 <a NAME="UserInterface.showSideWidget" ID="UserInterface.showSideWidget"></a>
3764 <a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a> 3701 <a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a>
3765 <h4>UserInterface.versionIsNewer</h4> 3702 <h4>UserInterface.versionIsNewer</h4>
3766 <b>versionIsNewer</b>(<i>required, snapshot=None</i>) 3703 <b>versionIsNewer</b>(<i>required, snapshot=None</i>)
3767 3704
3768 <p> 3705 <p>
3769 Public method to check, if the eric6 version is good compared to 3706 Public method to check, if the eric version is good compared to
3770 the required version. 3707 the required version.
3771 </p> 3708 </p>
3772 <dl> 3709 <dl>
3773 3710
3774 <dt><i>required</i></dt> 3711 <dt><i>required</i></dt>
3779 <dd> 3716 <dd>
3780 required snapshot version (string) 3717 required snapshot version (string)
3781 </dd> 3718 </dd>
3782 </dl> 3719 </dl>
3783 <dl> 3720 <dl>
3784 <dt>Returns:</dt> 3721 <dt>Return:</dt>
3785 <dd> 3722 <dd>
3786 flag indicating, that the version is newer than the required 3723 flag indicating, that the version is newer than the required
3787 one (boolean) 3724 one (boolean)
3788 </dd> 3725 </dd>
3789 </dl> 3726 </dl>

eric ide

mercurial