Documentation/Source/eric5.UI.UserInterface.html

changeset 945
8cd4d08fa9f6
parent 816
53e282890577
child 1127
b1802ebe0066
equal deleted inserted replaced
944:1b59c4ba121e 945:8cd4d08fa9f6
747 <dd> 747 <dd>
748 reference to the action that was triggered (QAction) 748 reference to the action that was triggered (QAction)
749 </dd> 749 </dd>
750 </dl><a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a> 750 </dl><a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
751 <h4>UserInterface.__TRPreviewer</h4> 751 <h4>UserInterface.__TRPreviewer</h4>
752 <b>__TRPreviewer</b>(<i>fileNames = None, ignore = False</i>) 752 <b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>)
753 <p> 753 <p>
754 Private slot to start the Translation Previewer executable. 754 Private slot to start the Translation Previewer executable.
755 </p><dl> 755 </p><dl>
756 <dt><i>fileNames</i></dt> 756 <dt><i>fileNames</i></dt>
757 <dd> 757 <dd>
831 <b>__activateTerminal</b>(<i></i>) 831 <b>__activateTerminal</b>(<i></i>)
832 <p> 832 <p>
833 Private slot to handle the activation of the Terminal window. 833 Private slot to handle the activation of the Terminal window.
834 </p><a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a> 834 </p><a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a>
835 <h4>UserInterface.__activateViewProfile</h4> 835 <h4>UserInterface.__activateViewProfile</h4>
836 <b>__activateViewProfile</b>(<i>name, save = True</i>) 836 <b>__activateViewProfile</b>(<i>name, save=True</i>)
837 <p> 837 <p>
838 Private slot to activate a view profile. 838 Private slot to activate a view profile.
839 </p><dl> 839 </p><dl>
840 <dt><i>name</i></dt> 840 <dt><i>name</i></dt>
841 <dd> 841 <dd>
850 <b>__activateViewmanager</b>(<i></i>) 850 <b>__activateViewmanager</b>(<i></i>)
851 <p> 851 <p>
852 Private slot to handle the activation of the current editor. 852 Private slot to handle the activation of the current editor.
853 </p><a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a> 853 </p><a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a>
854 <h4>UserInterface.__assistant</h4> 854 <h4>UserInterface.__assistant</h4>
855 <b>__assistant</b>(<i>home = None, version = 0</i>) 855 <b>__assistant</b>(<i>home=None, version=0</i>)
856 <p> 856 <p>
857 Private slot to start the Qt-Assistant executable. 857 Private slot to start the Qt-Assistant executable.
858 </p><dl> 858 </p><dl>
859 <dt><i>home</i></dt> 859 <dt><i>home</i></dt>
860 <dd> 860 <dd>
983 <dd> 983 <dd>
984 reference to the debug server object 984 reference to the debug server object
985 </dd> 985 </dd>
986 </dl><a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a> 986 </dl><a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a>
987 <h4>UserInterface.__customViewer</h4> 987 <h4>UserInterface.__customViewer</h4>
988 <b>__customViewer</b>(<i>home = None</i>) 988 <b>__customViewer</b>(<i>home=None</i>)
989 <p> 989 <p>
990 Private slot to start a custom viewer. 990 Private slot to start a custom viewer.
991 </p><dl> 991 </p><dl>
992 <dt><i>home</i></dt> 992 <dt><i>home</i></dt>
993 <dd> 993 <dd>
1003 <b>__deinstallPlugin</b>(<i></i>) 1003 <b>__deinstallPlugin</b>(<i></i>)
1004 <p> 1004 <p>
1005 Private slot to show a dialog to uninstall a plugin. 1005 Private slot to show a dialog to uninstall a plugin.
1006 </p><a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a> 1006 </p><a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a>
1007 <h4>UserInterface.__designer</h4> 1007 <h4>UserInterface.__designer</h4>
1008 <b>__designer</b>(<i>fn = None, version = 0</i>) 1008 <b>__designer</b>(<i>fn=None, version=0</i>)
1009 <p> 1009 <p>
1010 Private slot to start the Qt-Designer executable. 1010 Private slot to start the Qt-Designer executable.
1011 </p><dl> 1011 </p><dl>
1012 <dt><i>fn</i></dt> 1012 <dt><i>fn</i></dt>
1013 <dd> 1013 <dd>
1021 <b>__designer4</b>(<i></i>) 1021 <b>__designer4</b>(<i></i>)
1022 <p> 1022 <p>
1023 Private slot to start the Qt-Designer 4 executable. 1023 Private slot to start the Qt-Designer 4 executable.
1024 </p><a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a> 1024 </p><a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a>
1025 <h4>UserInterface.__editPixmap</h4> 1025 <h4>UserInterface.__editPixmap</h4>
1026 <b>__editPixmap</b>(<i>fn = ""</i>) 1026 <b>__editPixmap</b>(<i>fn=""</i>)
1027 <p> 1027 <p>
1028 Private slot to show a pixmap in a dialog. 1028 Private slot to show a pixmap in a dialog.
1029 </p><dl> 1029 </p><dl>
1030 <dt><i>fn</i></dt> 1030 <dt><i>fn</i></dt>
1031 <dd> 1031 <dd>
1136 <b>__initToolbars</b>(<i></i>) 1136 <b>__initToolbars</b>(<i></i>)
1137 <p> 1137 <p>
1138 Private slot to create the toolbars. 1138 Private slot to create the toolbars.
1139 </p><a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a> 1139 </p><a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a>
1140 <h4>UserInterface.__installPlugins</h4> 1140 <h4>UserInterface.__installPlugins</h4>
1141 <b>__installPlugins</b>(<i>pluginFileNames = []</i>) 1141 <b>__installPlugins</b>(<i>pluginFileNames=[]</i>)
1142 <p> 1142 <p>
1143 Private slot to show a dialog to install a new plugin. 1143 Private slot to show a dialog to install a new plugin.
1144 </p><dl> 1144 </p><dl>
1145 <dt><i>pluginFileNames</i></dt> 1145 <dt><i>pluginFileNames</i></dt>
1146 <dd> 1146 <dd>
1152 <b>__lastEditorClosed</b>(<i></i>) 1152 <b>__lastEditorClosed</b>(<i></i>)
1153 <p> 1153 <p>
1154 Private slot to handle the lastEditorClosed signal. 1154 Private slot to handle the lastEditorClosed signal.
1155 </p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a> 1155 </p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
1156 <h4>UserInterface.__linguist</h4> 1156 <h4>UserInterface.__linguist</h4>
1157 <b>__linguist</b>(<i>fn = None, version = 0</i>) 1157 <b>__linguist</b>(<i>fn=None, version=0</i>)
1158 <p> 1158 <p>
1159 Private slot to start the Qt-Linguist executable. 1159 Private slot to start the Qt-Linguist executable.
1160 </p><dl> 1160 </p><dl>
1161 <dt><i>fn</i></dt> 1161 <dt><i>fn</i></dt>
1162 <dd> 1162 <dd>
1165 <dd> 1165 <dd>
1166 indication for the requested version (Qt 4) (integer) 1166 indication for the requested version (Qt 4) (integer)
1167 </dd> 1167 </dd>
1168 </dl><a NAME="UserInterface.__linguist4" ID="UserInterface.__linguist4"></a> 1168 </dl><a NAME="UserInterface.__linguist4" ID="UserInterface.__linguist4"></a>
1169 <h4>UserInterface.__linguist4</h4> 1169 <h4>UserInterface.__linguist4</h4>
1170 <b>__linguist4</b>(<i>fn = None</i>) 1170 <b>__linguist4</b>(<i>fn=None</i>)
1171 <p> 1171 <p>
1172 Private slot to start the Qt-Linguist 4 executable. 1172 Private slot to start the Qt-Linguist 4 executable.
1173 </p><dl> 1173 </p><dl>
1174 <dt><i>fn</i></dt> 1174 <dt><i>fn</i></dt>
1175 <dd> 1175 <dd>
1185 <b>__openMiniEditor</b>(<i></i>) 1185 <b>__openMiniEditor</b>(<i></i>)
1186 <p> 1186 <p>
1187 Private slot to show a mini editor window. 1187 Private slot to show a mini editor window.
1188 </p><a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a> 1188 </p><a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a>
1189 <h4>UserInterface.__openOnStartup</h4> 1189 <h4>UserInterface.__openOnStartup</h4>
1190 <b>__openOnStartup</b>(<i>startupType = None</i>) 1190 <b>__openOnStartup</b>(<i>startupType=None</i>)
1191 <p> 1191 <p>
1192 Private method to open the last file, project or multiproject. 1192 Private method to open the last file, project or multiproject.
1193 </p><dl> 1193 </p><dl>
1194 <dt><i>startupType</i></dt> 1194 <dt><i>startupType</i></dt>
1195 <dd> 1195 <dd>
1284 flag indicating that the current profile should 1284 flag indicating that the current profile should
1285 be saved (boolean) 1285 be saved (boolean)
1286 </dd> 1286 </dd>
1287 </dl><a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a> 1287 </dl><a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a>
1288 <h4>UserInterface.__setEditProfile</h4> 1288 <h4>UserInterface.__setEditProfile</h4>
1289 <b>__setEditProfile</b>(<i>save = True</i>) 1289 <b>__setEditProfile</b>(<i>save=True</i>)
1290 <p> 1290 <p>
1291 Private slot to activate the edit view profile. 1291 Private slot to activate the edit view profile.
1292 </p><dl> 1292 </p><dl>
1293 <dt><i>save</i></dt> 1293 <dt><i>save</i></dt>
1294 <dd> 1294 <dd>
1300 <b>__setStyle</b>(<i></i>) 1300 <b>__setStyle</b>(<i></i>)
1301 <p> 1301 <p>
1302 Private slot to set the style of the interface. 1302 Private slot to set the style of the interface.
1303 </p><a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a> 1303 </p><a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
1304 <h4>UserInterface.__setWindowCaption</h4> 1304 <h4>UserInterface.__setWindowCaption</h4>
1305 <b>__setWindowCaption</b>(<i>editor = None, project = None</i>) 1305 <b>__setWindowCaption</b>(<i>editor=None, project=None</i>)
1306 <p> 1306 <p>
1307 Private method to set the caption of the Main Window. 1307 Private method to set the caption of the Main Window.
1308 </p><dl> 1308 </p><dl>
1309 <dt><i>editor</i></dt> 1309 <dt><i>editor</i></dt>
1310 <dd> 1310 <dd>
1342 <dd> 1342 <dd>
1343 contents of the downloaded versions file (list of strings) 1343 contents of the downloaded versions file (list of strings)
1344 </dd> 1344 </dd>
1345 </dl><a NAME="UserInterface.__showEmailDialog" ID="UserInterface.__showEmailDialog"></a> 1345 </dl><a NAME="UserInterface.__showEmailDialog" ID="UserInterface.__showEmailDialog"></a>
1346 <h4>UserInterface.__showEmailDialog</h4> 1346 <h4>UserInterface.__showEmailDialog</h4>
1347 <b>__showEmailDialog</b>(<i>mode, attachFile = None, deleteAttachFile = False</i>) 1347 <b>__showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
1348 <p> 1348 <p>
1349 Private slot to show the email dialog in a given mode. 1349 Private slot to show the email dialog in a given mode.
1350 </p><dl> 1350 </p><dl>
1351 <dt><i>mode</i></dt> 1351 <dt><i>mode</i></dt>
1352 <dd> 1352 <dd>
1449 <dd> 1449 <dd>
1450 filename of the file to show (string) 1450 filename of the file to show (string)
1451 </dd> 1451 </dd>
1452 </dl><a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a> 1452 </dl><a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
1453 <h4>UserInterface.__showSystemEmailClient</h4> 1453 <h4>UserInterface.__showSystemEmailClient</h4>
1454 <b>__showSystemEmailClient</b>(<i>mode, attachFile = None, deleteAttachFile = False</i>) 1454 <b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
1455 <p> 1455 <p>
1456 Private slot to show the system email dialog. 1456 Private slot to show the system email dialog.
1457 </p><dl> 1457 </p><dl>
1458 <dt><i>mode</i></dt> 1458 <dt><i>mode</i></dt>
1459 <dd> 1459 <dd>
1535 <dd> 1535 <dd>
1536 list of tool entries 1536 list of tool entries
1537 </dd> 1537 </dd>
1538 </dl><a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a> 1538 </dl><a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
1539 <h4>UserInterface.__startWebBrowser</h4> 1539 <h4>UserInterface.__startWebBrowser</h4>
1540 <b>__startWebBrowser</b>(<i>home = ""</i>) 1540 <b>__startWebBrowser</b>(<i>home=""</i>)
1541 <p> 1541 <p>
1542 Private slot to start the eric5 web browser. 1542 Private slot to start the eric5 web browser.
1543 </p><dl> 1543 </p><dl>
1544 <dt><i>home</i></dt> 1544 <dt><i>home</i></dt>
1545 <dd> 1545 <dd>
1708 <b>__unittestRestart</b>(<i></i>) 1708 <b>__unittestRestart</b>(<i></i>)
1709 <p> 1709 <p>
1710 Private slot to display the unittest dialog and rerun the last test. 1710 Private slot to display the unittest dialog and rerun the last test.
1711 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a> 1711 </p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a>
1712 <h4>UserInterface.__unittestScript</h4> 1712 <h4>UserInterface.__unittestScript</h4>
1713 <b>__unittestScript</b>(<i>prog = None</i>) 1713 <b>__unittestScript</b>(<i>prog=None</i>)
1714 <p> 1714 <p>
1715 Private slot for displaying the unittest dialog and run the current script. 1715 Private slot for displaying the unittest dialog and run the current script.
1716 </p><dl> 1716 </p><dl>
1717 <dt><i>prog</i></dt> 1717 <dt><i>prog</i></dt>
1718 <dd> 1718 <dd>
1810 </dd> 1810 </dd>
1811 </dl><a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a> 1811 </dl><a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a>
1812 <h4>UserInterface.checkConfigurationStatus</h4> 1812 <h4>UserInterface.checkConfigurationStatus</h4>
1813 <b>checkConfigurationStatus</b>(<i></i>) 1813 <b>checkConfigurationStatus</b>(<i></i>)
1814 <p> 1814 <p>
1815 Public method to check, if eric5 has been configured. If it is not, 1815 Public method to check, if eric5 has been configured. If it is not,
1816 the configuration dialog is shown. 1816 the configuration dialog is shown.
1817 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a> 1817 </p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
1818 <h4>UserInterface.checkForErrorLog</h4> 1818 <h4>UserInterface.checkForErrorLog</h4>
1819 <b>checkForErrorLog</b>(<i></i>) 1819 <b>checkForErrorLog</b>(<i></i>)
1820 <p> 1820 <p>
1972 <dd> 1972 <dd>
1973 the name of the current view profile (string) 1973 the name of the current view profile (string)
1974 </dd> 1974 </dd>
1975 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a> 1975 </dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
1976 <h4>UserInterface.launchHelpViewer</h4> 1976 <h4>UserInterface.launchHelpViewer</h4>
1977 <b>launchHelpViewer</b>(<i>home, searchWord = None</i>) 1977 <b>launchHelpViewer</b>(<i>home, searchWord=None</i>)
1978 <p> 1978 <p>
1979 Public slot to start the help viewer. 1979 Public slot to start the help viewer.
1980 </p><dl> 1980 </p><dl>
1981 <dt><i>home</i></dt> 1981 <dt><i>home</i></dt>
1982 <dd> 1982 <dd>
1985 <dd> 1985 <dd>
1986 word to search for (string) 1986 word to search for (string)
1987 </dd> 1987 </dd>
1988 </dl><a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a> 1988 </dl><a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
1989 <h4>UserInterface.performVersionCheck</h4> 1989 <h4>UserInterface.performVersionCheck</h4>
1990 <b>performVersionCheck</b>(<i>manual = True, alternative = 0, showVersions = False</i>) 1990 <b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>)
1991 <p> 1991 <p>
1992 Public method to check the internet for an eric5 update. 1992 Public method to check the internet for an eric5 update.
1993 </p><dl> 1993 </p><dl>
1994 <dt><i>manual</i></dt> 1994 <dt><i>manual</i></dt>
1995 <dd> 1995 <dd>
2009 </p><dl> 2009 </p><dl>
2010 <dt><i>args</i></dt> 2010 <dt><i>args</i></dt>
2011 <dd> 2011 <dd>
2012 list of files to open<br /> 2012 list of files to open<br />
2013 The args are processed one at a time. All arguments after a 2013 The args are processed one at a time. All arguments after a
2014 '--' option are considered debug arguments to the program 2014 '--' option are considered debug arguments to the program
2015 for the debugger. All files named before the '--' option 2015 for the debugger. All files named before the '--' option
2016 are opened in a text editor, unless the argument ends in 2016 are opened in a text editor, unless the argument ends in
2017 .e4p, then it is opened as a project file. If it ends in 2017 .e4p, then it is opened as a project file. If it ends in
2018 .e4m, it is opened as a multiproject. 2018 .e4m, it is opened as a multiproject.
2019 </dd> 2019 </dd>
2020 </dl><a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a> 2020 </dl><a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a>
2021 <h4>UserInterface.registerToolbar</h4> 2021 <h4>UserInterface.registerToolbar</h4>
2022 <b>registerToolbar</b>(<i>name, text, toolbar</i>) 2022 <b>registerToolbar</b>(<i>name, text, toolbar</i>)
2043 raised, if a toolbar with the given name was 2043 raised, if a toolbar with the given name was
2044 already registered 2044 already registered
2045 </dd> 2045 </dd>
2046 </dl><a NAME="UserInterface.removeE5Actions" ID="UserInterface.removeE5Actions"></a> 2046 </dl><a NAME="UserInterface.removeE5Actions" ID="UserInterface.removeE5Actions"></a>
2047 <h4>UserInterface.removeE5Actions</h4> 2047 <h4>UserInterface.removeE5Actions</h4>
2048 <b>removeE5Actions</b>(<i>actions, type = 'ui'</i>) 2048 <b>removeE5Actions</b>(<i>actions, type='ui'</i>)
2049 <p> 2049 <p>
2050 Public method to remove actions from the list of actions. 2050 Public method to remove actions from the list of actions.
2051 </p><dl> 2051 </p><dl>
2052 <dt><i>type</i></dt> 2052 <dt><i>type</i></dt>
2053 <dd> 2053 <dd>
2070 <dd> 2070 <dd>
2071 new user visible text for the toolbar entry (string) 2071 new user visible text for the toolbar entry (string)
2072 </dd> 2072 </dd>
2073 </dl><a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a> 2073 </dl><a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a>
2074 <h4>UserInterface.setDebugProfile</h4> 2074 <h4>UserInterface.setDebugProfile</h4>
2075 <b>setDebugProfile</b>(<i>save = True</i>) 2075 <b>setDebugProfile</b>(<i>save=True</i>)
2076 <p> 2076 <p>
2077 Public slot to activate the debug view profile. 2077 Public slot to activate the debug view profile.
2078 </p><dl> 2078 </p><dl>
2079 <dt><i>save</i></dt> 2079 <dt><i>save</i></dt>
2080 <dd> 2080 <dd>
2106 <dd> 2106 <dd>
2107 string naming the tab to be shown (string) 2107 string naming the tab to be shown (string)
2108 </dd> 2108 </dd>
2109 </dl><a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a> 2109 </dl><a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a>
2110 <h4>UserInterface.showPreferences</h4> 2110 <h4>UserInterface.showPreferences</h4>
2111 <b>showPreferences</b>(<i>pageName = None</i>) 2111 <b>showPreferences</b>(<i>pageName=None</i>)
2112 <p> 2112 <p>
2113 Public slot to set the preferences. 2113 Public slot to set the preferences.
2114 </p><dl> 2114 </p><dl>
2115 <dt><i>pageName</i></dt> 2115 <dt><i>pageName</i></dt>
2116 <dd> 2116 <dd>
2126 <dd> 2126 <dd>
2127 name of the toolbar (string). 2127 name of the toolbar (string).
2128 </dd> 2128 </dd>
2129 </dl><a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a> 2129 </dl><a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a>
2130 <h4>UserInterface.versionIsNewer</h4> 2130 <h4>UserInterface.versionIsNewer</h4>
2131 <b>versionIsNewer</b>(<i>required, snapshot = None</i>) 2131 <b>versionIsNewer</b>(<i>required, snapshot=None</i>)
2132 <p> 2132 <p>
2133 Public method to check, if the eric5 version is good compared to 2133 Public method to check, if the eric5 version is good compared to
2134 the required version. 2134 the required version.
2135 </p><dl> 2135 </p><dl>
2136 <dt><i>required</i></dt> 2136 <dt><i>required</i></dt>

eric ide

mercurial