Documentation/Source/eric5.UI.UserInterface.html

changeset 3018
70924c0bdaf1
parent 2966
f85f686981ad
child 3092
f7ec7a3e7270
equal deleted inserted replaced
3017:6a8cb7632448 3018:70924c0bdaf1
105 <p> 105 <p>
106 Private method returning number of characters to write. 106 Private method returning number of characters to write.
107 </p><dl> 107 </p><dl>
108 <dt>Returns:</dt> 108 <dt>Returns:</dt>
109 <dd> 109 <dd>
110 number of characters buffered or length of buffered line (integer) 110 number of characters buffered or length of buffered line
111 (integer)
111 </dd> 112 </dd>
112 </dl><a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a> 113 </dl><a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
113 <h4>Redirector.__nWrite</h4> 114 <h4>Redirector.__nWrite</h4>
114 <b>__nWrite</b>(<i>n</i>) 115 <b>__nWrite</b>(<i>n</i>)
115 <p> 116 <p>
150 <dd> 151 <dd>
151 emitted to write data to stdout logger 152 emitted to write data to stdout logger
152 </dd><dt>masterPasswordChanged(str, str)</dt> 153 </dd><dt>masterPasswordChanged(str, str)</dt>
153 <dd> 154 <dd>
154 emitted after the master 155 emitted after the master
155 password has been changed with the old and the new password 156 password has been changed with the old and the new password
156 </dd><dt>preferencesChanged()</dt> 157 </dd><dt>preferencesChanged()</dt>
157 <dd> 158 <dd>
158 emitted after the preferences were changed 159 emitted after the preferences were changed
159 </dd><dt>reloadAPIs()</dt> 160 </dd><dt>reloadAPIs()</dt>
160 <dd> 161 <dd>
161 emitted to reload the api information 162 emitted to reload the api information
162 </dd><dt>showMenu(str, QMenu)</dt> 163 </dd><dt>showMenu(str, QMenu)</dt>
163 <dd> 164 <dd>
164 emitted when a menu is about to be shown. The name 165 emitted when a menu is about to be shown. The
165 of the menu and a reference to the menu are given. 166 name of the menu and a reference to the menu are given.
166 </dd> 167 </dd>
167 </dl> 168 </dl>
168 <h3>Derived from</h3> 169 <h3>Derived from</h3>
169 E5MainWindow 170 E5MainWindow
170 <h3>Class Attributes</h3> 171 <h3>Class Attributes</h3>
774 </dd><dt><i>locale</i></dt> 775 </dd><dt><i>locale</i></dt>
775 <dd> 776 <dd>
776 locale to be used by the UI (string) 777 locale to be used by the UI (string)
777 </dd><dt><i>splash</i></dt> 778 </dd><dt><i>splash</i></dt>
778 <dd> 779 <dd>
779 reference to the splashscreen (UI.SplashScreen.SplashScreen) 780 reference to the splashscreen
781 (UI.SplashScreen.SplashScreen)
780 </dd><dt><i>plugin</i></dt> 782 </dd><dt><i>plugin</i></dt>
781 <dd> 783 <dd>
782 filename of a plugin to be loaded (used for plugin development) 784 filename of a plugin to be loaded (used for plugin
785 development)
783 </dd><dt><i>noOpenAtStartup</i></dt> 786 </dd><dt><i>noOpenAtStartup</i></dt>
784 <dd> 787 <dd>
785 flag indicating that the open at startup option 788 flag indicating that the open at startup option
786 should not be executed (boolean) 789 should not be executed (boolean)
787 </dd><dt><i>restartArguments</i></dt> 790 </dd><dt><i>restartArguments</i></dt>
788 <dd> 791 <dd>
789 list of command line parameters to be used for a 792 list of command line parameters to be used for
790 restart (list of strings) 793 a restart (list of strings)
791 </dd> 794 </dd>
792 </dl><a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a> 795 </dl><a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a>
793 <h4>UserInterface.__TBMenuTriggered</h4> 796 <h4>UserInterface.__TBMenuTriggered</h4>
794 <b>__TBMenuTriggered</b>(<i>act</i>) 797 <b>__TBMenuTriggered</b>(<i>act</i>)
795 <p> 798 <p>
809 <dd> 812 <dd>
810 filenames of forms and/or translations to be previewed 813 filenames of forms and/or translations to be previewed
811 (list of strings) 814 (list of strings)
812 </dd><dt><i>ignore</i></dt> 815 </dd><dt><i>ignore</i></dt>
813 <dd> 816 <dd>
814 flag indicating non existing files should be ignored (boolean) 817 flag indicating non existing files should be ignored
818 (boolean)
815 </dd> 819 </dd>
816 </dl><a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a> 820 </dl><a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
817 <h4>UserInterface.__UIPreviewer</h4> 821 <h4>UserInterface.__UIPreviewer</h4>
818 <b>__UIPreviewer</b>(<i>fn=None</i>) 822 <b>__UIPreviewer</b>(<i>fn=None</i>)
819 <p> 823 <p>
1160 Private slot to initialize the action to show the PySide documentation. 1164 Private slot to initialize the action to show the PySide documentation.
1161 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a> 1165 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a>
1162 <h4>UserInterface.__initPythonDocActions</h4> 1166 <h4>UserInterface.__initPythonDocActions</h4>
1163 <b>__initPythonDocActions</b>(<i></i>) 1167 <b>__initPythonDocActions</b>(<i></i>)
1164 <p> 1168 <p>
1165 Private slot to initialize the actions to show the Python documentation. 1169 Private slot to initialize the actions to show the Python
1170 documentation.
1166 </p><a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a> 1171 </p><a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a>
1167 <h4>UserInterface.__initQtDocActions</h4> 1172 <h4>UserInterface.__initQtDocActions</h4>
1168 <b>__initQtDocActions</b>(<i></i>) 1173 <b>__initQtDocActions</b>(<i></i>)
1169 <p> 1174 <p>
1170 Private slot to initialize the action to show the Qt documentation. 1175 Private slot to initialize the action to show the Qt documentation.
1375 </dd> 1380 </dd>
1376 </dl><a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a> 1381 </dl><a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
1377 <h4>UserInterface.__setupDockWindow</h4> 1382 <h4>UserInterface.__setupDockWindow</h4>
1378 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>) 1383 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>)
1379 <p> 1384 <p>
1380 Private method to configure the dock window created with __createDockWindow(). 1385 Private method to configure the dock window created with
1386 __createDockWindow().
1381 </p><dl> 1387 </p><dl>
1382 <dt><i>dock</i></dt> 1388 <dt><i>dock</i></dt>
1383 <dd> 1389 <dd>
1384 the dock window (QDockWindow) 1390 the dock window (QDockWindow)
1385 </dd><dt><i>where</i></dt> 1391 </dd><dt><i>where</i></dt>
1398 <p> 1404 <p>
1399 Private method to show the versions available for download. 1405 Private method to show the versions available for download.
1400 </p><dl> 1406 </p><dl>
1401 <dt><i>versions</i></dt> 1407 <dt><i>versions</i></dt>
1402 <dd> 1408 <dd>
1403 contents of the downloaded versions file (list of strings) 1409 contents of the downloaded versions file (list of
1410 strings)
1404 </dd> 1411 </dd>
1405 </dl><a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a> 1412 </dl><a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a>
1406 <h4>UserInterface.__showCertificatesDialog</h4> 1413 <h4>UserInterface.__showCertificatesDialog</h4>
1407 <b>__showCertificatesDialog</b>(<i></i>) 1414 <b>__showCertificatesDialog</b>(<i></i>)
1408 <p> 1415 <p>
1414 Private slot to show the Eric documentation. 1421 Private slot to show the Eric documentation.
1415 </p><a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a> 1422 </p><a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a>
1416 <h4>UserInterface.__showExternalTools</h4> 1423 <h4>UserInterface.__showExternalTools</h4>
1417 <b>__showExternalTools</b>(<i></i>) 1424 <b>__showExternalTools</b>(<i></i>)
1418 <p> 1425 <p>
1419 Private slot to display a dialog show a list of external tools used by eric5. 1426 Private slot to display a dialog show a list of external tools used
1427 by eric5.
1420 </p><a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a> 1428 </p><a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
1421 <h4>UserInterface.__showExtrasMenu</h4> 1429 <h4>UserInterface.__showExtrasMenu</h4>
1422 <b>__showExtrasMenu</b>(<i></i>) 1430 <b>__showExtrasMenu</b>(<i></i>)
1423 <p> 1431 <p>
1424 Private slot to display the Extras menu. 1432 Private slot to display the Extras menu.
1625 Private slot to start the eric5 web browser. 1633 Private slot to start the eric5 web browser.
1626 </p><a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a> 1634 </p><a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
1627 <h4>UserInterface.__switchTab</h4> 1635 <h4>UserInterface.__switchTab</h4>
1628 <b>__switchTab</b>(<i></i>) 1636 <b>__switchTab</b>(<i></i>)
1629 <p> 1637 <p>
1630 Private slot used to switch between the current and the previous current tab. 1638 Private slot used to switch between the current and the previous
1639 current tab.
1631 </p><a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a> 1640 </p><a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a>
1632 <h4>UserInterface.__toggleBottomSidebar</h4> 1641 <h4>UserInterface.__toggleBottomSidebar</h4>
1633 <b>__toggleBottomSidebar</b>(<i></i>) 1642 <b>__toggleBottomSidebar</b>(<i></i>)
1634 <p> 1643 <p>
1635 Private slot to handle the toggle of the bottom sidebar window. 1644 Private slot to handle the toggle of the bottom sidebar window.
1728 Private slot for displaying the unittest dialog. 1737 Private slot for displaying the unittest dialog.
1729 </p><a NAME="UserInterface.__unittestProject" ID="UserInterface.__unittestProject"></a> 1738 </p><a NAME="UserInterface.__unittestProject" ID="UserInterface.__unittestProject"></a>
1730 <h4>UserInterface.__unittestProject</h4> 1739 <h4>UserInterface.__unittestProject</h4>
1731 <b>__unittestProject</b>(<i></i>) 1740 <b>__unittestProject</b>(<i></i>)
1732 <p> 1741 <p>
1733 Private slot for displaying the unittest dialog and run the current project. 1742 Private slot for displaying the unittest dialog and run the current
1743 project.
1734 </p><a NAME="UserInterface.__unittestRerunFailed" ID="UserInterface.__unittestRerunFailed"></a> 1744 </p><a NAME="UserInterface.__unittestRerunFailed" ID="UserInterface.__unittestRerunFailed"></a>
1735 <h4>UserInterface.__unittestRerunFailed</h4> 1745 <h4>UserInterface.__unittestRerunFailed</h4>
1736 <b>__unittestRerunFailed</b>(<i></i>) 1746 <b>__unittestRerunFailed</b>(<i></i>)
1737 <p> 1747 <p>
1738 Private slot to display the unittest dialog and rerun all failed tests 1748 Private slot to display the unittest dialog and rerun all failed tests
1739 of the last run. 1749 of the last run.
1740 </p><a NAME="UserInterface.__unittestRestart" ID="UserInterface.__unittestRestart"></a> 1750 </p><a NAME="UserInterface.__unittestRestart" ID="UserInterface.__unittestRestart"></a>
1741 <h4>UserInterface.__unittestRestart</h4> 1751 <h4>UserInterface.__unittestRestart</h4>
1742 <b>__unittestRestart</b>(<i></i>) 1752 <b>__unittestRestart</b>(<i></i>)
1743 <p> 1753 <p>
1744 Private slot to display the unittest dialog and rerun the last unit test. 1754 Private slot to display the unittest dialog and rerun the last
1755 unit test.
1745 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a> 1756 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a>
1746 <h4>UserInterface.__unittestScript</h4> 1757 <h4>UserInterface.__unittestScript</h4>
1747 <b>__unittestScript</b>(<i>prog=None</i>) 1758 <b>__unittestScript</b>(<i>prog=None</i>)
1748 <p> 1759 <p>
1749 Private slot for displaying the unittest dialog and run the current script. 1760 Private slot for displaying the unittest dialog and run the current
1761 script.
1750 </p><dl> 1762 </p><dl>
1751 <dt><i>prog</i></dt> 1763 <dt><i>prog</i></dt>
1752 <dd> 1764 <dd>
1753 the python program to be opened 1765 the python program to be opened
1754 </dd> 1766 </dd>
1759 Private slot to handle the end of a unit test run. 1771 Private slot to handle the end of a unit test run.
1760 </p><a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a> 1772 </p><a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a>
1761 <h4>UserInterface.__updateExternalToolsActions</h4> 1773 <h4>UserInterface.__updateExternalToolsActions</h4>
1762 <b>__updateExternalToolsActions</b>(<i></i>) 1774 <b>__updateExternalToolsActions</b>(<i></i>)
1763 <p> 1775 <p>
1764 Private method to update the external tools actions for the current tool group. 1776 Private method to update the external tools actions for the current
1777 tool group.
1765 </p><a NAME="UserInterface.__updateVersionsUrls" ID="UserInterface.__updateVersionsUrls"></a> 1778 </p><a NAME="UserInterface.__updateVersionsUrls" ID="UserInterface.__updateVersionsUrls"></a>
1766 <h4>UserInterface.__updateVersionsUrls</h4> 1779 <h4>UserInterface.__updateVersionsUrls</h4>
1767 <b>__updateVersionsUrls</b>(<i>versions</i>) 1780 <b>__updateVersionsUrls</b>(<i>versions</i>)
1768 <p> 1781 <p>
1769 Private method to update the URLs from which to retrieve the versions file. 1782 Private method to update the URLs from which to retrieve the versions
1783 file.
1770 </p><dl> 1784 </p><dl>
1771 <dt><i>versions</i></dt> 1785 <dt><i>versions</i></dt>
1772 <dd> 1786 <dd>
1773 contents of the downloaded versions file (list of strings) 1787 contents of the downloaded versions file (list of
1788 strings)
1774 </dd> 1789 </dd>
1775 </dl><a NAME="UserInterface.__versionCheckResult" ID="UserInterface.__versionCheckResult"></a> 1790 </dl><a NAME="UserInterface.__versionCheckResult" ID="UserInterface.__versionCheckResult"></a>
1776 <h4>UserInterface.__versionCheckResult</h4> 1791 <h4>UserInterface.__versionCheckResult</h4>
1777 <b>__versionCheckResult</b>(<i>versions</i>) 1792 <b>__versionCheckResult</b>(<i>versions</i>)
1778 <p> 1793 <p>
1779 Private method to show the result of the version check action. 1794 Private method to show the result of the version check action.
1780 </p><dl> 1795 </p><dl>
1781 <dt><i>versions</i></dt> 1796 <dt><i>versions</i></dt>
1782 <dd> 1797 <dd>
1783 contents of the downloaded versions file (list of strings) 1798 contents of the downloaded versions file (list of
1799 strings)
1784 </dd> 1800 </dd>
1785 </dl><a NAME="UserInterface.__versionsDownloadCanceled" ID="UserInterface.__versionsDownloadCanceled"></a> 1801 </dl><a NAME="UserInterface.__versionsDownloadCanceled" ID="UserInterface.__versionsDownloadCanceled"></a>
1786 <h4>UserInterface.__versionsDownloadCanceled</h4> 1802 <h4>UserInterface.__versionsDownloadCanceled</h4>
1787 <b>__versionsDownloadCanceled</b>(<i></i>) 1803 <b>__versionsDownloadCanceled</b>(<i></i>)
1788 <p> 1804 <p>
1890 the configuration dialog is shown. 1906 the configuration dialog is shown.
1891 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a> 1907 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
1892 <h4>UserInterface.checkForErrorLog</h4> 1908 <h4>UserInterface.checkForErrorLog</h4>
1893 <b>checkForErrorLog</b>(<i></i>) 1909 <b>checkForErrorLog</b>(<i></i>)
1894 <p> 1910 <p>
1895 Public method to check for the presence of an error log and ask the user, 1911 Public method to check for the presence of an error log and ask the
1896 what to do with it. 1912 user, what to do with it.
1897 </p><a NAME="UserInterface.checkProjectsWorkspace" ID="UserInterface.checkProjectsWorkspace"></a> 1913 </p><a NAME="UserInterface.checkProjectsWorkspace" ID="UserInterface.checkProjectsWorkspace"></a>
1898 <h4>UserInterface.checkProjectsWorkspace</h4> 1914 <h4>UserInterface.checkProjectsWorkspace</h4>
1899 <b>checkProjectsWorkspace</b>(<i></i>) 1915 <b>checkProjectsWorkspace</b>(<i></i>)
1900 <p> 1916 <p>
1901 Public method to check, if a projects workspace has been configured. If 1917 Public method to check, if a projects workspace has been configured. If
1974 <p> 1990 <p>
1975 Public method to get a reference to the help window instance. 1991 Public method to get a reference to the help window instance.
1976 </p><dl> 1992 </p><dl>
1977 <dt><i>preview=</i></dt> 1993 <dt><i>preview=</i></dt>
1978 <dd> 1994 <dd>
1979 flag indicating to get a help window for preview (boolean) 1995 flag indicating to get a help window for preview
1996 (boolean)
1980 </dd> 1997 </dd>
1981 </dl><dl> 1998 </dl><dl>
1982 <dt>Returns:</dt> 1999 <dt>Returns:</dt>
1983 <dd> 2000 <dd>
1984 reference to the help window instance (HelpWindow) 2001 reference to the help window instance (HelpWindow)
2089 </dd><dt><i>searchWord=</i></dt> 2106 </dd><dt><i>searchWord=</i></dt>
2090 <dd> 2107 <dd>
2091 word to search for (string) 2108 word to search for (string)
2092 </dd><dt><i>useSingle=</i></dt> 2109 </dd><dt><i>useSingle=</i></dt>
2093 <dd> 2110 <dd>
2094 flag indicating to use a single browser window (boolean) 2111 flag indicating to use a single browser window
2112 (boolean)
2095 </dd> 2113 </dd>
2096 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a> 2114 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
2097 <h4>UserInterface.notificationsEnabled</h4> 2115 <h4>UserInterface.notificationsEnabled</h4>
2098 <b>notificationsEnabled</b>(<i></i>) 2116 <b>notificationsEnabled</b>(<i></i>)
2099 <p> 2117 <p>
2226 </dd><dt><i>attachFile</i></dt> 2244 </dd><dt><i>attachFile</i></dt>
2227 <dd> 2245 <dd>
2228 name of a file to attach to the email (string) 2246 name of a file to attach to the email (string)
2229 </dd><dt><i>deleteAttachFile</i></dt> 2247 </dd><dt><i>deleteAttachFile</i></dt>
2230 <dd> 2248 <dd>
2231 flag indicating to delete the attached file after 2249 flag indicating to delete the attached file
2232 it has been sent (boolean) 2250 after it has been sent (boolean)
2233 </dd> 2251 </dd>
2234 </dl><a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a> 2252 </dl><a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
2235 <h4>UserInterface.showEvent</h4> 2253 <h4>UserInterface.showEvent</h4>
2236 <b>showEvent</b>(<i>evt</i>) 2254 <b>showEvent</b>(<i>evt</i>)
2237 <p> 2255 <p>
2339 required snapshot version (string) 2357 required snapshot version (string)
2340 </dd> 2358 </dd>
2341 </dl><dl> 2359 </dl><dl>
2342 <dt>Returns:</dt> 2360 <dt>Returns:</dt>
2343 <dd> 2361 <dd>
2344 flag indicating, that the version is newer than the required one 2362 flag indicating, that the version is newer than the required
2345 (boolean) 2363 one (boolean)
2346 </dd> 2364 </dd>
2347 </dl> 2365 </dl>
2348 <div align="right"><a href="#top">Up</a></div> 2366 <div align="right"><a href="#top">Up</a></div>
2349 <hr /> 2367 <hr />
2350 </body></html> 2368 </body></html>

eric ide

mercurial