Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.UI.UserInterface.html

src/eric7/Documentation/Source/eric7.UI.UserInterface.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 10303
ee1aadab1215
child 10478
de9106c55c3d
equal deleted inserted replaced
10432:2fe91fe443dd 10433:328f3ec4b77a
124 </p> 124 </p>
125 <dl> 125 <dl>
126 <dt>Return:</dt> 126 <dt>Return:</dt>
127 <dd> 127 <dd>
128 number of characters buffered or length of buffered line 128 number of characters buffered or length of buffered line
129 (integer) 129 </dd>
130 </dl>
131 <dl>
132 <dt>Return Type:</dt>
133 <dd>
134 int
130 </dd> 135 </dd>
131 </dl> 136 </dl>
132 <a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a> 137 <a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
133 <h4>Redirector.__nWrite</h4> 138 <h4>Redirector.__nWrite</h4>
134 <b>__nWrite</b>(<i>n</i>) 139 <b>__nWrite</b>(<i>n</i>)
136 <p> 141 <p>
137 Private method used to write data. 142 Private method used to write data.
138 </p> 143 </p>
139 <dl> 144 <dl>
140 145
141 <dt><i>n</i></dt> 146 <dt><i>n</i> (int)</dt>
142 <dd> 147 <dd>
143 max number of bytes to write 148 max number of bytes to write
144 </dd> 149 </dd>
145 </dl> 150 </dl>
146 <a NAME="Redirector.flush" ID="Redirector.flush"></a> 151 <a NAME="Redirector.flush" ID="Redirector.flush"></a>
157 <p> 162 <p>
158 Public method used to write data. 163 Public method used to write data.
159 </p> 164 </p>
160 <dl> 165 <dl>
161 166
162 <dt><i>s</i></dt> 167 <dt><i>s</i> (Any)</dt>
163 <dd> 168 <dd>
164 data to be written (it must support the str-method) 169 data to be written (it must support the str-method)
165 </dd> 170 </dd>
166 </dl> 171 </dl>
167 <div align="right"><a href="#top">Up</a></div> 172 <div align="right"><a href="#top">Up</a></div>
1211 Private method to handle the toggle of a toolbar via the Window-> 1216 Private method to handle the toggle of a toolbar via the Window->
1212 Toolbars submenu. 1217 Toolbars submenu.
1213 </p> 1218 </p>
1214 <dl> 1219 <dl>
1215 1220
1216 <dt><i>act</i></dt> 1221 <dt><i>act</i> (QAction)</dt>
1217 <dd> 1222 <dd>
1218 reference to the action that was triggered (QAction) 1223 reference to the action that was triggered
1219 </dd> 1224 </dd>
1220 </dl> 1225 </dl>
1221 <a NAME="UserInterface.__TBPopupMenuTriggered" ID="UserInterface.__TBPopupMenuTriggered"></a> 1226 <a NAME="UserInterface.__TBPopupMenuTriggered" ID="UserInterface.__TBPopupMenuTriggered"></a>
1222 <h4>UserInterface.__TBPopupMenuTriggered</h4> 1227 <h4>UserInterface.__TBPopupMenuTriggered</h4>
1223 <b>__TBPopupMenuTriggered</b>(<i>act</i>) 1228 <b>__TBPopupMenuTriggered</b>(<i>act</i>)
1226 Private method to handle the toggle of a toolbar via the QMainWindow 1231 Private method to handle the toggle of a toolbar via the QMainWindow
1227 Toolbars popup menu. 1232 Toolbars popup menu.
1228 </p> 1233 </p>
1229 <dl> 1234 <dl>
1230 1235
1231 <dt><i>act</i></dt> 1236 <dt><i>act</i> (QAction)</dt>
1232 <dd> 1237 <dd>
1233 reference to the action that was triggered (QAction) 1238 reference to the action that was triggered
1234 </dd> 1239 </dd>
1235 </dl> 1240 </dl>
1236 <a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a> 1241 <a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
1237 <h4>UserInterface.__TRPreviewer</h4> 1242 <h4>UserInterface.__TRPreviewer</h4>
1238 <b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>) 1243 <b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>)
1240 <p> 1245 <p>
1241 Private slot to start the Translation Previewer executable. 1246 Private slot to start the Translation Previewer executable.
1242 </p> 1247 </p>
1243 <dl> 1248 <dl>
1244 1249
1245 <dt><i>fileNames</i></dt> 1250 <dt><i>fileNames</i> (list of str)</dt>
1246 <dd> 1251 <dd>
1247 filenames of forms and/or translations to be previewed 1252 filenames of forms and/or translations to be previewed
1248 (list of strings) 1253 </dd>
1249 </dd> 1254 <dt><i>ignore</i> (bool)</dt>
1250 <dt><i>ignore</i></dt>
1251 <dd> 1255 <dd>
1252 flag indicating non existing files should be ignored 1256 flag indicating non existing files should be ignored
1253 (boolean)
1254 </dd> 1257 </dd>
1255 </dl> 1258 </dl>
1256 <a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a> 1259 <a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
1257 <h4>UserInterface.__UIPreviewer</h4> 1260 <h4>UserInterface.__UIPreviewer</h4>
1258 <b>__UIPreviewer</b>(<i>fn=None</i>) 1261 <b>__UIPreviewer</b>(<i>fn=None</i>)
1260 <p> 1263 <p>
1261 Private slot to start the UI Previewer executable. 1264 Private slot to start the UI Previewer executable.
1262 </p> 1265 </p>
1263 <dl> 1266 <dl>
1264 1267
1265 <dt><i>fn</i></dt> 1268 <dt><i>fn</i> (str)</dt>
1266 <dd> 1269 <dd>
1267 filename of the form to be previewed (string) 1270 filename of the form to be previewed
1268 </dd> 1271 </dd>
1269 </dl> 1272 </dl>
1270 <a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a> 1273 <a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a>
1271 <h4>UserInterface.__activateBrowser</h4> 1274 <h4>UserInterface.__activateBrowser</h4>
1272 <b>__activateBrowser</b>(<i></i>) 1275 <b>__activateBrowser</b>(<i></i>)
1415 <p> 1418 <p>
1416 Private slot to activate a view profile. 1419 Private slot to activate a view profile.
1417 </p> 1420 </p>
1418 <dl> 1421 <dl>
1419 1422
1420 <dt><i>name</i></dt> 1423 <dt><i>name</i> (str)</dt>
1421 <dd> 1424 <dd>
1422 name of the profile to be activated (string) 1425 name of the profile to be activated
1423 </dd> 1426 </dd>
1424 <dt><i>save</i></dt> 1427 <dt><i>save</i> (bool)</dt>
1425 <dd> 1428 <dd>
1426 flag indicating that the current profile should 1429 flag indicating that the current profile should
1427 be saved (boolean) 1430 be saved
1428 </dd> 1431 </dd>
1429 </dl> 1432 </dl>
1430 <a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a> 1433 <a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a>
1431 <h4>UserInterface.__activateViewmanager</h4> 1434 <h4>UserInterface.__activateViewmanager</h4>
1432 <b>__activateViewmanager</b>(<i></i>) 1435 <b>__activateViewmanager</b>(<i></i>)
1455 <p> 1458 <p>
1456 Private slot to check some actions for their enable/disable status. 1459 Private slot to check some actions for their enable/disable status.
1457 </p> 1460 </p>
1458 <dl> 1461 <dl>
1459 1462
1460 <dt><i>editor</i></dt> 1463 <dt><i>editor</i> (Editor)</dt>
1461 <dd> 1464 <dd>
1462 editor window 1465 editor window
1463 </dd> 1466 </dd>
1464 </dl> 1467 </dl>
1465 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a> 1468 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
1469 <p> 1472 <p>
1470 Private slot to start the win help viewer to show *.chm files. 1473 Private slot to start the win help viewer to show *.chm files.
1471 </p> 1474 </p>
1472 <dl> 1475 <dl>
1473 1476
1474 <dt><i>home</i></dt> 1477 <dt><i>home</i> (str)</dt>
1475 <dd> 1478 <dd>
1476 full pathname of a file to display (string) 1479 full pathname of a file to display
1477 </dd> 1480 </dd>
1478 </dl> 1481 </dl>
1479 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a> 1482 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a>
1480 <h4>UserInterface.__clearPrivateData</h4> 1483 <h4>UserInterface.__clearPrivateData</h4>
1481 <b>__clearPrivateData</b>(<i></i>) 1484 <b>__clearPrivateData</b>(<i></i>)
1567 <p> 1570 <p>
1568 Private method to create a dock window with common properties. 1571 Private method to create a dock window with common properties.
1569 </p> 1572 </p>
1570 <dl> 1573 <dl>
1571 1574
1572 <dt><i>name</i></dt> 1575 <dt><i>name</i> (str)</dt>
1573 <dd> 1576 <dd>
1574 object name of the new dock window (string) 1577 object name of the new dock window
1575 </dd> 1578 </dd>
1576 </dl> 1579 </dl>
1577 <dl> 1580 <dl>
1578 <dt>Return:</dt> 1581 <dt>Return:</dt>
1579 <dd> 1582 <dd>
1580 the generated dock window (QDockWindow) 1583 the generated dock window
1584 </dd>
1585 </dl>
1586 <dl>
1587 <dt>Return Type:</dt>
1588 <dd>
1589 QDockWindow
1581 </dd> 1590 </dd>
1582 </dl> 1591 </dl>
1583 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a> 1592 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
1584 <h4>UserInterface.__createLayout</h4> 1593 <h4>UserInterface.__createLayout</h4>
1585 <b>__createLayout</b>(<i></i>) 1594 <b>__createLayout</b>(<i></i>)
1629 <p> 1638 <p>
1630 Private slot to start a custom viewer. 1639 Private slot to start a custom viewer.
1631 </p> 1640 </p>
1632 <dl> 1641 <dl>
1633 1642
1634 <dt><i>home</i></dt> 1643 <dt><i>home</i> (str)</dt>
1635 <dd> 1644 <dd>
1636 full pathname of a file to display (string) 1645 full pathname of a file to display
1637 </dd> 1646 </dd>
1638 </dl> 1647 </dl>
1639 <a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a> 1648 <a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a>
1640 <h4>UserInterface.__debuggingDone</h4> 1649 <h4>UserInterface.__debuggingDone</h4>
1641 <b>__debuggingDone</b>(<i></i>) 1650 <b>__debuggingDone</b>(<i></i>)
1699 <p> 1708 <p>
1700 Private slot to handle the editorOpened signal. 1709 Private slot to handle the editorOpened signal.
1701 </p> 1710 </p>
1702 <dl> 1711 <dl>
1703 1712
1704 <dt><i>fn</i></dt> 1713 <dt><i>fn</i> (str)</dt>
1705 <dd> 1714 <dd>
1706 filename of the opened editor (string) 1715 filename of the opened editor
1707 </dd> 1716 </dd>
1708 </dl> 1717 </dl>
1709 <a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a> 1718 <a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a>
1710 <h4>UserInterface.__exportPreferences</h4> 1719 <h4>UserInterface.__exportPreferences</h4>
1711 <b>__exportPreferences</b>(<i></i>) 1720 <b>__exportPreferences</b>(<i></i>)
1734 <p> 1743 <p>
1735 Private method to get the geometry of a floating windows. 1744 Private method to get the geometry of a floating windows.
1736 </p> 1745 </p>
1737 <dl> 1746 <dl>
1738 1747
1739 <dt><i>w</i></dt> 1748 <dt><i>w</i> (QWidget)</dt>
1740 <dd> 1749 <dd>
1741 reference to the widget to be saved (QWidget) 1750 reference to the widget to be saved
1742 </dd> 1751 </dd>
1743 </dl> 1752 </dl>
1744 <dl> 1753 <dl>
1745 <dt>Return:</dt> 1754 <dt>Return:</dt>
1746 <dd> 1755 <dd>
1747 list giving the widget's geometry and its visibility 1756 list giving the widget's geometry and its visibility
1757 </dd>
1758 </dl>
1759 <dl>
1760 <dt>Return Type:</dt>
1761 <dd>
1762 list of [int, int, int, int, bool]
1748 </dd> 1763 </dd>
1749 </dl> 1764 </dl>
1750 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a> 1765 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a>
1751 <h4>UserInterface.__hasErrorLog</h4> 1766 <h4>UserInterface.__hasErrorLog</h4>
1752 <b>__hasErrorLog</b>(<i></i>) 1767 <b>__hasErrorLog</b>(<i></i>)
1755 Private method to check, if an error log file exists. 1770 Private method to check, if an error log file exists.
1756 </p> 1771 </p>
1757 <dl> 1772 <dl>
1758 <dt>Return:</dt> 1773 <dt>Return:</dt>
1759 <dd> 1774 <dd>
1760 flag indicating the existence of an error log file (boolean) 1775 flag indicating the existence of an error log file
1776 </dd>
1777 </dl>
1778 <dl>
1779 <dt>Return Type:</dt>
1780 <dd>
1781 bool
1761 </dd> 1782 </dd>
1762 </dl> 1783 </dl>
1763 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a> 1784 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1764 <h4>UserInterface.__helpViewer</h4> 1785 <h4>UserInterface.__helpViewer</h4>
1765 <b>__helpViewer</b>(<i></i>) 1786 <b>__helpViewer</b>(<i></i>)
1889 <p> 1910 <p>
1890 Private slot to show a dialog to install a new plugin. 1911 Private slot to show a dialog to install a new plugin.
1891 </p> 1912 </p>
1892 <dl> 1913 <dl>
1893 1914
1894 <dt><i>pluginFileNames</i></dt> 1915 <dt><i>pluginFileNames</i> (list of str)</dt>
1895 <dd> 1916 <dd>
1896 list of plugin files suggested for 1917 list of plugin files suggested for
1897 installation list of strings 1918 installation
1898 </dd> 1919 </dd>
1899 </dl> 1920 </dl>
1900 <a NAME="UserInterface.__ircAutoConnected" ID="UserInterface.__ircAutoConnected"></a> 1921 <a NAME="UserInterface.__ircAutoConnected" ID="UserInterface.__ircAutoConnected"></a>
1901 <h4>UserInterface.__ircAutoConnected</h4> 1922 <h4>UserInterface.__ircAutoConnected</h4>
1902 <b>__ircAutoConnected</b>(<i></i>) 1923 <b>__ircAutoConnected</b>(<i></i>)
2037 <p> 2058 <p>
2038 Private method to open the last file, project or multiproject. 2059 Private method to open the last file, project or multiproject.
2039 </p> 2060 </p>
2040 <dl> 2061 <dl>
2041 2062
2042 <dt><i>startupType</i></dt> 2063 <dt><i>startupType</i> (str)</dt>
2043 <dd> 2064 <dd>
2044 type of startup requested (string, one of 2065 type of startup requested (one of
2045 "Nothing", "File", "Project", "MultiProject" or "Session") 2066 "Nothing", "File", "Project", "MultiProject" or "Session")
2046 </dd> 2067 </dd>
2047 </dl> 2068 </dl>
2048 <a NAME="UserInterface.__openPdfViewer" ID="UserInterface.__openPdfViewer"></a> 2069 <a NAME="UserInterface.__openPdfViewer" ID="UserInterface.__openPdfViewer"></a>
2049 <h4>UserInterface.__openPdfViewer</h4> 2070 <h4>UserInterface.__openPdfViewer</h4>
2100 <p> 2121 <p>
2101 Private method to populate a toolbars menu. 2122 Private method to populate a toolbars menu.
2102 </p> 2123 </p>
2103 <dl> 2124 <dl>
2104 2125
2105 <dt><i>menu</i></dt> 2126 <dt><i>menu</i> (QMenu)</dt>
2106 <dd> 2127 <dd>
2107 reference to the menu to be populated (QMenu) 2128 reference to the menu to be populated
2108 </dd> 2129 </dd>
2109 </dl> 2130 </dl>
2110 <a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a> 2131 <a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a>
2111 <h4>UserInterface.__preferencesChanged</h4> 2132 <h4>UserInterface.__preferencesChanged</h4>
2112 <b>__preferencesChanged</b>(<i></i>) 2133 <b>__preferencesChanged</b>(<i></i>)
2138 <p> 2159 <p>
2139 This primarily is here to set the currentProg variable. 2160 This primarily is here to set the currentProg variable.
2140 </p> 2161 </p>
2141 <dl> 2162 <dl>
2142 2163
2143 <dt><i>fn</i></dt> 2164 <dt><i>fn</i> (str)</dt>
2144 <dd> 2165 <dd>
2145 filename to be set as current prog (string) 2166 filename to be set as current prog
2146 </dd> 2167 </dd>
2147 </dl> 2168 </dl>
2148 <a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a> 2169 <a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a>
2149 <h4>UserInterface.__projectClosed</h4> 2170 <h4>UserInterface.__projectClosed</h4>
2150 <b>__projectClosed</b>(<i></i>) 2171 <b>__projectClosed</b>(<i></i>)
2276 <p> 2297 <p>
2277 Private slot to save the window geometries of the active profile. 2298 Private slot to save the window geometries of the active profile.
2278 </p> 2299 </p>
2279 <dl> 2300 <dl>
2280 2301
2281 <dt><i>save</i></dt> 2302 <dt><i>save</i> (bool)</dt>
2282 <dd> 2303 <dd>
2283 flag indicating that the current profile should 2304 flag indicating that the current profile should
2284 be saved (boolean) 2305 be saved
2285 </dd> 2306 </dd>
2286 </dl> 2307 </dl>
2287 <a NAME="UserInterface.__saveSessionToFile" ID="UserInterface.__saveSessionToFile"></a> 2308 <a NAME="UserInterface.__saveSessionToFile" ID="UserInterface.__saveSessionToFile"></a>
2288 <h4>UserInterface.__saveSessionToFile</h4> 2309 <h4>UserInterface.__saveSessionToFile</h4>
2289 <b>__saveSessionToFile</b>(<i></i>) 2310 <b>__saveSessionToFile</b>(<i></i>)
2298 <p> 2319 <p>
2299 Private slot to activate the edit view profile. 2320 Private slot to activate the edit view profile.
2300 </p> 2321 </p>
2301 <dl> 2322 <dl>
2302 2323
2303 <dt><i>save</i></dt> 2324 <dt><i>save</i> (bool)</dt>
2304 <dd> 2325 <dd>
2305 flag indicating that the current profile should 2326 flag indicating that the current profile should
2306 be saved (boolean) 2327 be saved
2307 </dd> 2328 </dd>
2308 </dl> 2329 </dl>
2309 <a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a> 2330 <a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
2310 <h4>UserInterface.__setWindowCaption</h4> 2331 <h4>UserInterface.__setWindowCaption</h4>
2311 <b>__setWindowCaption</b>(<i>editor=None, project=None</i>) 2332 <b>__setWindowCaption</b>(<i>editor=None, project=None</i>)
2313 <p> 2334 <p>
2314 Private method to set the caption of the Main Window. 2335 Private method to set the caption of the Main Window.
2315 </p> 2336 </p>
2316 <dl> 2337 <dl>
2317 2338
2318 <dt><i>editor</i></dt> 2339 <dt><i>editor</i> (str)</dt>
2319 <dd> 2340 <dd>
2320 filename to be displayed (string) 2341 filename to be displayed
2321 </dd> 2342 </dd>
2322 <dt><i>project</i></dt> 2343 <dt><i>project</i> (str)</dt>
2323 <dd> 2344 <dd>
2324 project name to be displayed (string) 2345 project name to be displayed
2325 </dd> 2346 </dd>
2326 </dl> 2347 </dl>
2327 <a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a> 2348 <a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
2328 <h4>UserInterface.__setupDockWindow</h4> 2349 <h4>UserInterface.__setupDockWindow</h4>
2329 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>) 2350 <b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>)
2332 Private method to configure the dock window created with 2353 Private method to configure the dock window created with
2333 __createDockWindow(). 2354 __createDockWindow().
2334 </p> 2355 </p>
2335 <dl> 2356 <dl>
2336 2357
2337 <dt><i>dock</i></dt> 2358 <dt><i>dock</i> (QDockWindow)</dt>
2338 <dd> 2359 <dd>
2339 the dock window (QDockWindow) 2360 the dock window
2340 </dd> 2361 </dd>
2341 <dt><i>where</i></dt> 2362 <dt><i>where</i> (Qt.DockWidgetArea)</dt>
2342 <dd> 2363 <dd>
2343 dock area to be docked to (Qt.DockWidgetArea) 2364 dock area to be docked to
2344 </dd> 2365 </dd>
2345 <dt><i>widget</i></dt> 2366 <dt><i>widget</i> (QWidget)</dt>
2346 <dd> 2367 <dd>
2347 widget to be shown in the dock window (QWidget) 2368 widget to be shown in the dock window
2348 </dd> 2369 </dd>
2349 <dt><i>caption</i></dt> 2370 <dt><i>caption</i> (str)</dt>
2350 <dd> 2371 <dd>
2351 caption of the dock window (string) 2372 caption of the dock window
2352 </dd> 2373 </dd>
2353 </dl> 2374 </dl>
2354 <a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a> 2375 <a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a>
2355 <h4>UserInterface.__showCertificatesDialog</h4> 2376 <h4>UserInterface.__showCertificatesDialog</h4>
2356 <b>__showCertificatesDialog</b>(<i></i>) 2377 <b>__showCertificatesDialog</b>(<i></i>)
2528 <p> 2549 <p>
2529 Private slot to show a SVG file in a dialog. 2550 Private slot to show a SVG file in a dialog.
2530 </p> 2551 </p>
2531 <dl> 2552 <dl>
2532 2553
2533 <dt><i>fn</i></dt> 2554 <dt><i>fn</i> (str)</dt>
2534 <dd> 2555 <dd>
2535 filename of the file to show (string) 2556 filename of the file to show
2536 </dd> 2557 </dd>
2537 </dl> 2558 </dl>
2538 <a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a> 2559 <a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
2539 <h4>UserInterface.__showSystemEmailClient</h4> 2560 <h4>UserInterface.__showSystemEmailClient</h4>
2540 <b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>) 2561 <b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
2542 <p> 2563 <p>
2543 Private slot to show the system email dialog. 2564 Private slot to show the system email dialog.
2544 </p> 2565 </p>
2545 <dl> 2566 <dl>
2546 2567
2547 <dt><i>mode</i></dt> 2568 <dt><i>mode</i> (str)</dt>
2548 <dd> 2569 <dd>
2549 mode of the email dialog (string, "bug" or "feature") 2570 mode of the email dialog ("bug" or "feature")
2550 </dd> 2571 </dd>
2551 <dt><i>attachFile</i></dt> 2572 <dt><i>attachFile</i> (str)</dt>
2552 <dd> 2573 <dd>
2553 name of a file to put into the body of the 2574 name of a file to put into the body of the
2554 email (string) 2575 email
2555 </dd> 2576 </dd>
2556 <dt><i>deleteAttachFile</i></dt> 2577 <dt><i>deleteAttachFile</i> (bool)</dt>
2557 <dd> 2578 <dd>
2558 flag indicating to delete the file after 2579 flag indicating to delete the file after
2559 it has been read (boolean) 2580 it has been read
2560 </dd> 2581 </dd>
2561 </dl> 2582 </dl>
2562 <a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a> 2583 <a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a>
2563 <h4>UserInterface.__showToolGroupsMenu</h4> 2584 <h4>UserInterface.__showToolGroupsMenu</h4>
2564 <b>__showToolGroupsMenu</b>(<i></i>) 2585 <b>__showToolGroupsMenu</b>(<i></i>)
2655 <p> 2676 <p>
2656 Private slot to handle SSL errors. 2677 Private slot to handle SSL errors.
2657 </p> 2678 </p>
2658 <dl> 2679 <dl>
2659 2680
2660 <dt><i>reply</i></dt> 2681 <dt><i>reply</i> (QNetworkReply)</dt>
2661 <dd> 2682 <dd>
2662 reference to the reply object (QNetworkReply) 2683 reference to the reply object
2663 </dd> 2684 </dd>
2664 <dt><i>errors</i></dt> 2685 <dt><i>errors</i> (list of QSslError)</dt>
2665 <dd> 2686 <dd>
2666 list of SSL errors (list of QSslError) 2687 list of SSL errors
2667 </dd> 2688 </dd>
2668 </dl> 2689 </dl>
2669 <a NAME="UserInterface.__startTestProject" ID="UserInterface.__startTestProject"></a> 2690 <a NAME="UserInterface.__startTestProject" ID="UserInterface.__startTestProject"></a>
2670 <h4>UserInterface.__startTestProject</h4> 2691 <h4>UserInterface.__startTestProject</h4>
2671 <b>__startTestProject</b>(<i></i>) 2692 <b>__startTestProject</b>(<i></i>)
2703 <p> 2724 <p>
2704 Private slot to start an external tool process. 2725 Private slot to start an external tool process.
2705 </p> 2726 </p>
2706 <dl> 2727 <dl>
2707 2728
2708 <dt><i>tool</i></dt> 2729 <dt><i>tool</i> (dict)</dt>
2709 <dd> 2730 <dd>
2710 list of tool entries 2731 dictionary of tool entries
2711 </dd> 2732 </dd>
2712 </dl> 2733 </dl>
2713 <a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a> 2734 <a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
2714 <h4>UserInterface.__startWebBrowser</h4> 2735 <h4>UserInterface.__startWebBrowser</h4>
2715 <b>__startWebBrowser</b>(<i></i>) 2736 <b>__startWebBrowser</b>(<i></i>)
2781 <p> 2802 <p>
2782 Private method to toggle a workspace editor window. 2803 Private method to toggle a workspace editor window.
2783 </p> 2804 </p>
2784 <dl> 2805 <dl>
2785 2806
2786 <dt><i>w</i></dt> 2807 <dt><i>w</i> (Editor)</dt>
2787 <dd> 2808 <dd>
2788 reference to the workspace editor window 2809 reference to the workspace editor window
2789 </dd> 2810 </dd>
2790 </dl> 2811 </dl>
2791 <dl> 2812 <dl>
2792 <dt>Return:</dt> 2813 <dt>Return:</dt>
2793 <dd> 2814 <dd>
2794 flag indicating, if the window was shown (boolean) 2815 flag indicating, if the window was shown
2816 </dd>
2817 </dl>
2818 <dl>
2819 <dt>Return Type:</dt>
2820 <dd>
2821 bool
2795 </dd> 2822 </dd>
2796 </dl> 2823 </dl>
2797 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a> 2824 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
2798 <h4>UserInterface.__toolActionTriggered</h4> 2825 <h4>UserInterface.__toolActionTriggered</h4>
2799 <b>__toolActionTriggered</b>(<i>act</i>) 2826 <b>__toolActionTriggered</b>(<i>act</i>)
2815 <p> 2842 <p>
2816 Private slot to execute a particular tool. 2843 Private slot to execute a particular tool.
2817 </p> 2844 </p>
2818 <dl> 2845 <dl>
2819 2846
2820 <dt><i>act</i></dt> 2847 <dt><i>act</i> (QAction)</dt>
2821 <dd> 2848 <dd>
2822 reference to the action that was triggered (QAction) 2849 reference to the action that was triggered
2823 </dd> 2850 </dd>
2824 </dl> 2851 </dl>
2825 <a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a> 2852 <a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a>
2826 <h4>UserInterface.__toolFinished</h4> 2853 <h4>UserInterface.__toolFinished</h4>
2827 <b>__toolFinished</b>(<i>exitCode, exitStatus</i>) 2854 <b>__toolFinished</b>(<i>exitCode, exitStatus</i>)
2829 <p> 2856 <p>
2830 Private slot to handle the finished signal of a tool process. 2857 Private slot to handle the finished signal of a tool process.
2831 </p> 2858 </p>
2832 <dl> 2859 <dl>
2833 2860
2834 <dt><i>exitCode</i></dt> 2861 <dt><i>exitCode</i> (int)</dt>
2835 <dd> 2862 <dd>
2836 exit code of the process (integer) 2863 exit code of the process
2837 </dd> 2864 </dd>
2838 <dt><i>exitStatus</i></dt> 2865 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
2839 <dd> 2866 <dd>
2840 exit status of the process (QProcess.ExitStatus) 2867 exit status of the process
2841 </dd> 2868 </dd>
2842 </dl> 2869 </dl>
2843 <a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a> 2870 <a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a>
2844 <h4>UserInterface.__toolGroupSelected</h4> 2871 <h4>UserInterface.__toolGroupSelected</h4>
2845 <b>__toolGroupSelected</b>(<i>act</i>) 2872 <b>__toolGroupSelected</b>(<i>act</i>)
2847 <p> 2874 <p>
2848 Private slot to set the current tool group. 2875 Private slot to set the current tool group.
2849 </p> 2876 </p>
2850 <dl> 2877 <dl>
2851 2878
2852 <dt><i>act</i></dt> 2879 <dt><i>act</i> (QAction)</dt>
2853 <dd> 2880 <dd>
2854 reference to the action that was triggered (QAction) 2881 reference to the action that was triggered
2855 </dd> 2882 </dd>
2856 </dl> 2883 </dl>
2857 <a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a> 2884 <a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a>
2858 <h4>UserInterface.__toolGroupsConfiguration</h4> 2885 <h4>UserInterface.__toolGroupsConfiguration</h4>
2859 <b>__toolGroupsConfiguration</b>(<i></i>) 2886 <b>__toolGroupsConfiguration</b>(<i></i>)
2883 <p> 2910 <p>
2884 Private slot to start the eric web browser. 2911 Private slot to start the eric web browser.
2885 </p> 2912 </p>
2886 <dl> 2913 <dl>
2887 2914
2888 <dt><i>home</i></dt> 2915 <dt><i>home</i> (str)</dt>
2889 <dd> 2916 <dd>
2890 full pathname of a file to display (string) 2917 full pathname of a file to display
2891 </dd> 2918 </dd>
2892 </dl> 2919 </dl>
2893 <a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a> 2920 <a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a>
2894 <h4>UserInterface.__webBrowserFinished</h4> 2921 <h4>UserInterface.__webBrowserFinished</h4>
2895 <b>__webBrowserFinished</b>(<i></i>) 2922 <b>__webBrowserFinished</b>(<i></i>)
3004 <p> 3031 <p>
3005 Public method to add actions to the list of actions. 3032 Public method to add actions to the list of actions.
3006 </p> 3033 </p>
3007 <dl> 3034 <dl>
3008 3035
3009 <dt><i>actions</i></dt> 3036 <dt><i>actions</i> (list of EricAction)</dt>
3010 <dd> 3037 <dd>
3011 list of actions to be added (list of EricAction) 3038 list of actions to be added
3012 </dd> 3039 </dd>
3013 <dt><i>actionType</i></dt> 3040 <dt><i>actionType</i> (str)</dt>
3014 <dd> 3041 <dd>
3015 string denoting the action set to add to. 3042 string denoting the action set to add to.
3016 It must be one of "ui" or "wizards". 3043 It must be one of "ui" or "wizards".
3017 </dd> 3044 </dd>
3018 </dl> 3045 </dl>
3050 <p> 3077 <p>
3051 Public slot to append text to the stderr log viewer tab. 3078 Public slot to append text to the stderr log viewer tab.
3052 </p> 3079 </p>
3053 <dl> 3080 <dl>
3054 3081
3055 <dt><i>s</i></dt> 3082 <dt><i>s</i> (str)</dt>
3056 <dd> 3083 <dd>
3057 output to be appended (string) 3084 output to be appended
3058 </dd> 3085 </dd>
3059 </dl> 3086 </dl>
3060 <a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a> 3087 <a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a>
3061 <h4>UserInterface.appendToStdout</h4> 3088 <h4>UserInterface.appendToStdout</h4>
3062 <b>appendToStdout</b>(<i>s</i>) 3089 <b>appendToStdout</b>(<i>s</i>)
3064 <p> 3091 <p>
3065 Public slot to append text to the stdout log viewer tab. 3092 Public slot to append text to the stdout log viewer tab.
3066 </p> 3093 </p>
3067 <dl> 3094 <dl>
3068 3095
3069 <dt><i>s</i></dt> 3096 <dt><i>s</i> (str)</dt>
3070 <dd> 3097 <dd>
3071 output to be appended (string) 3098 output to be appended
3072 </dd> 3099 </dd>
3073 </dl> 3100 </dl>
3074 <a NAME="UserInterface.autoConnectIrc" ID="UserInterface.autoConnectIrc"></a> 3101 <a NAME="UserInterface.autoConnectIrc" ID="UserInterface.autoConnectIrc"></a>
3075 <h4>UserInterface.autoConnectIrc</h4> 3102 <h4>UserInterface.autoConnectIrc</h4>
3076 <b>autoConnectIrc</b>(<i></i>) 3103 <b>autoConnectIrc</b>(<i></i>)
3119 <p> 3146 <p>
3120 This event handler saves the preferences. 3147 This event handler saves the preferences.
3121 </p> 3148 </p>
3122 <dl> 3149 <dl>
3123 3150
3124 <dt><i>event</i></dt> 3151 <dt><i>event</i> (QCloseEvent)</dt>
3125 <dd> 3152 <dd>
3126 close event (QCloseEvent) 3153 close event
3127 </dd> 3154 </dd>
3128 </dl> 3155 </dl>
3129 <a NAME="UserInterface.createPopupMenu" ID="UserInterface.createPopupMenu"></a> 3156 <a NAME="UserInterface.createPopupMenu" ID="UserInterface.createPopupMenu"></a>
3130 <h4>UserInterface.createPopupMenu</h4> 3157 <h4>UserInterface.createPopupMenu</h4>
3131 <b>createPopupMenu</b>(<i></i>) 3158 <b>createPopupMenu</b>(<i></i>)
3134 Public method to create the toolbars menu for Qt. 3161 Public method to create the toolbars menu for Qt.
3135 </p> 3162 </p>
3136 <dl> 3163 <dl>
3137 <dt>Return:</dt> 3164 <dt>Return:</dt>
3138 <dd> 3165 <dd>
3139 toolbars menu (QMenu) 3166 toolbars menu
3167 </dd>
3168 </dl>
3169 <dl>
3170 <dt>Return Type:</dt>
3171 <dd>
3172 QMenu
3140 </dd> 3173 </dd>
3141 </dl> 3174 </dl>
3142 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a> 3175 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a>
3143 <h4>UserInterface.documentationViewer</h4> 3176 <h4>UserInterface.documentationViewer</h4>
3144 <b>documentationViewer</b>(<i></i>) 3177 <b>documentationViewer</b>(<i></i>)
3165 <p> 3198 <p>
3166 Protected method to handle the drag enter event. 3199 Protected method to handle the drag enter event.
3167 </p> 3200 </p>
3168 <dl> 3201 <dl>
3169 3202
3170 <dt><i>event</i></dt> 3203 <dt><i>event</i> (QDragEnterEvent)</dt>
3171 <dd> 3204 <dd>
3172 the drag enter event (QDragEnterEvent) 3205 the drag enter event
3173 </dd> 3206 </dd>
3174 </dl> 3207 </dl>
3175 <a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a> 3208 <a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a>
3176 <h4>UserInterface.dragLeaveEvent</h4> 3209 <h4>UserInterface.dragLeaveEvent</h4>
3177 <b>dragLeaveEvent</b>(<i>event</i>) 3210 <b>dragLeaveEvent</b>(<i>event</i>)
3179 <p> 3212 <p>
3180 Protected method to handle the drag leave event. 3213 Protected method to handle the drag leave event.
3181 </p> 3214 </p>
3182 <dl> 3215 <dl>
3183 3216
3184 <dt><i>event</i></dt> 3217 <dt><i>event</i> (QDragLeaveEvent)</dt>
3185 <dd> 3218 <dd>
3186 the drag leave event (QDragLeaveEvent) 3219 the drag leave event
3187 </dd> 3220 </dd>
3188 </dl> 3221 </dl>
3189 <a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a> 3222 <a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a>
3190 <h4>UserInterface.dragMoveEvent</h4> 3223 <h4>UserInterface.dragMoveEvent</h4>
3191 <b>dragMoveEvent</b>(<i>event</i>) 3224 <b>dragMoveEvent</b>(<i>event</i>)
3193 <p> 3226 <p>
3194 Protected method to handle the drag move event. 3227 Protected method to handle the drag move event.
3195 </p> 3228 </p>
3196 <dl> 3229 <dl>
3197 3230
3198 <dt><i>event</i></dt> 3231 <dt><i>event</i> (QDragMoveEvent)</dt>
3199 <dd> 3232 <dd>
3200 the drag move event (QDragMoveEvent) 3233 the drag move event
3201 </dd> 3234 </dd>
3202 </dl> 3235 </dl>
3203 <a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a> 3236 <a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a>
3204 <h4>UserInterface.dropEvent</h4> 3237 <h4>UserInterface.dropEvent</h4>
3205 <b>dropEvent</b>(<i>event</i>) 3238 <b>dropEvent</b>(<i>event</i>)
3207 <p> 3240 <p>
3208 Protected method to handle the drop event. 3241 Protected method to handle the drop event.
3209 </p> 3242 </p>
3210 <dl> 3243 <dl>
3211 3244
3212 <dt><i>event</i></dt> 3245 <dt><i>event</i> (QDropEvent)</dt>
3213 <dd> 3246 <dd>
3214 the drop event (QDropEvent) 3247 the drop event
3215 </dd> 3248 </dd>
3216 </dl> 3249 </dl>
3217 <a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a> 3250 <a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a>
3218 <h4>UserInterface.getActions</h4> 3251 <h4>UserInterface.getActions</h4>
3219 <b>getActions</b>(<i>actionType</i>) 3252 <b>getActions</b>(<i>actionType</i>)
3221 <p> 3254 <p>
3222 Public method to get a list of all actions. 3255 Public method to get a list of all actions.
3223 </p> 3256 </p>
3224 <dl> 3257 <dl>
3225 3258
3226 <dt><i>actionType</i></dt> 3259 <dt><i>actionType</i> (str)</dt>
3227 <dd> 3260 <dd>
3228 string denoting the action set to get. 3261 string denoting the action set to get.
3229 It must be one of "ui" or "wizards". 3262 It must be one of "ui" or "wizards".
3230 </dd> 3263 </dd>
3231 </dl> 3264 </dl>
3232 <dl> 3265 <dl>
3233 <dt>Return:</dt> 3266 <dt>Return:</dt>
3234 <dd> 3267 <dd>
3235 list of all actions (list of EricAction) 3268 list of all actions
3269 </dd>
3270 </dl>
3271 <dl>
3272 <dt>Return Type:</dt>
3273 <dd>
3274 list of EricAction
3236 </dd> 3275 </dd>
3237 </dl> 3276 </dl>
3238 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a> 3277 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
3239 <h4>UserInterface.getLayoutType</h4> 3278 <h4>UserInterface.getLayoutType</h4>
3240 <b>getLayoutType</b>(<i></i>) 3279 <b>getLayoutType</b>(<i></i>)
3262 Public method to get the locale of the IDE. 3301 Public method to get the locale of the IDE.
3263 </p> 3302 </p>
3264 <dl> 3303 <dl>
3265 <dt>Return:</dt> 3304 <dt>Return:</dt>
3266 <dd> 3305 <dd>
3267 locale of the IDE (string or None) 3306 locale of the IDE
3307 </dd>
3308 </dl>
3309 <dl>
3310 <dt>Return Type:</dt>
3311 <dd>
3312 str
3268 </dd> 3313 </dd>
3269 </dl> 3314 </dl>
3270 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a> 3315 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
3271 <h4>UserInterface.getMenu</h4> 3316 <h4>UserInterface.getMenu</h4>
3272 <b>getMenu</b>(<i>name</i>) 3317 <b>getMenu</b>(<i>name</i>)
3274 <p> 3319 <p>
3275 Public method to get a reference to a specific menu. 3320 Public method to get a reference to a specific menu.
3276 </p> 3321 </p>
3277 <dl> 3322 <dl>
3278 3323
3279 <dt><i>name</i></dt> 3324 <dt><i>name</i> (str)</dt>
3280 <dd> 3325 <dd>
3281 name of the menu (string) 3326 name of the menu
3282 </dd> 3327 </dd>
3283 </dl> 3328 </dl>
3284 <dl> 3329 <dl>
3285 <dt>Return:</dt> 3330 <dt>Return:</dt>
3286 <dd> 3331 <dd>
3287 reference to the menu (QMenu) 3332 reference to the menu
3333 </dd>
3334 </dl>
3335 <dl>
3336 <dt>Return Type:</dt>
3337 <dd>
3338 QMenu
3288 </dd> 3339 </dd>
3289 </dl> 3340 </dl>
3290 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a> 3341 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
3291 <h4>UserInterface.getMenuAction</h4> 3342 <h4>UserInterface.getMenuAction</h4>
3292 <b>getMenuAction</b>(<i>menuName, actionName</i>) 3343 <b>getMenuAction</b>(<i>menuName, actionName</i>)
3294 <p> 3345 <p>
3295 Public method to get a reference to an action of a menu. 3346 Public method to get a reference to an action of a menu.
3296 </p> 3347 </p>
3297 <dl> 3348 <dl>
3298 3349
3299 <dt><i>menuName</i></dt> 3350 <dt><i>menuName</i> (str)</dt>
3300 <dd> 3351 <dd>
3301 name of the menu to search in (string) 3352 name of the menu to search in
3302 </dd> 3353 </dd>
3303 <dt><i>actionName</i></dt> 3354 <dt><i>actionName</i> (str)</dt>
3304 <dd> 3355 <dd>
3305 object name of the action to search for 3356 object name of the action to search for
3306 (string)
3307 </dd> 3357 </dd>
3308 </dl> 3358 </dl>
3309 <dl> 3359 <dl>
3310 <dt>Return:</dt> 3360 <dt>Return:</dt>
3311 <dd> 3361 <dd>
3312 reference to the menu action (QAction) 3362 reference to the menu action
3363 </dd>
3364 </dl>
3365 <dl>
3366 <dt>Return Type:</dt>
3367 <dd>
3368 QAction
3313 </dd> 3369 </dd>
3314 </dl> 3370 </dl>
3315 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a> 3371 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
3316 <h4>UserInterface.getMenuBarAction</h4> 3372 <h4>UserInterface.getMenuBarAction</h4>
3317 <b>getMenuBarAction</b>(<i>menuName</i>) 3373 <b>getMenuBarAction</b>(<i>menuName</i>)
3319 <p> 3375 <p>
3320 Public method to get a reference to an action of the main menu. 3376 Public method to get a reference to an action of the main menu.
3321 </p> 3377 </p>
3322 <dl> 3378 <dl>
3323 3379
3324 <dt><i>menuName</i></dt> 3380 <dt><i>menuName</i> (str)</dt>
3325 <dd> 3381 <dd>
3326 name of the menu to search in (string) 3382 name of the menu to search in
3327 </dd> 3383 </dd>
3328 </dl> 3384 </dl>
3329 <dl> 3385 <dl>
3330 <dt>Return:</dt> 3386 <dt>Return:</dt>
3331 <dd> 3387 <dd>
3332 reference to the menu bar action (QAction) 3388 reference to the menu bar action
3389 </dd>
3390 </dl>
3391 <dl>
3392 <dt>Return Type:</dt>
3393 <dd>
3394 QAction
3333 </dd> 3395 </dd>
3334 </dl> 3396 </dl>
3335 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a> 3397 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a>
3336 <h4>UserInterface.getOriginalPathString</h4> 3398 <h4>UserInterface.getOriginalPathString</h4>
3337 <b>getOriginalPathString</b>(<i></i>) 3399 <b>getOriginalPathString</b>(<i></i>)
3359 <p> 3421 <p>
3360 Public method to get a reference to a specific toolbar. 3422 Public method to get a reference to a specific toolbar.
3361 </p> 3423 </p>
3362 <dl> 3424 <dl>
3363 3425
3364 <dt><i>name</i></dt> 3426 <dt><i>name</i> (str)</dt>
3365 <dd> 3427 <dd>
3366 name of the toolbar (string) 3428 name of the toolbar
3367 </dd> 3429 </dd>
3368 </dl> 3430 </dl>
3369 <dl> 3431 <dl>
3370 <dt>Return:</dt> 3432 <dt>Return:</dt>
3371 <dd> 3433 <dd>
3372 reference to the toolbar entry (tuple of string and QToolBar) 3434 reference to the toolbar entry
3435 </dd>
3436 </dl>
3437 <dl>
3438 <dt>Return Type:</dt>
3439 <dd>
3440 tuple of (str, QToolBar)
3373 </dd> 3441 </dd>
3374 </dl> 3442 </dl>
3375 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a> 3443 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a>
3376 <h4>UserInterface.getToolbarsByCategory</h4> 3444 <h4>UserInterface.getToolbarsByCategory</h4>
3377 <b>getToolbarsByCategory</b>(<i>category</i>) 3445 <b>getToolbarsByCategory</b>(<i>category</i>)
3407 Public method to get the current view profile. 3475 Public method to get the current view profile.
3408 </p> 3476 </p>
3409 <dl> 3477 <dl>
3410 <dt>Return:</dt> 3478 <dt>Return:</dt>
3411 <dd> 3479 <dd>
3412 the name of the current view profile (string) 3480 the name of the current view profile
3481 </dd>
3482 </dl>
3483 <dl>
3484 <dt>Return Type:</dt>
3485 <dd>
3486 str
3413 </dd> 3487 </dd>
3414 </dl> 3488 </dl>
3415 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a> 3489 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
3416 <h4>UserInterface.handleUrl</h4> 3490 <h4>UserInterface.handleUrl</h4>
3417 <b>handleUrl</b>(<i>url</i>) 3491 <b>handleUrl</b>(<i>url</i>)
3557 <p> 3631 <p>
3558 Public method to remove actions from the list of actions. 3632 Public method to remove actions from the list of actions.
3559 </p> 3633 </p>
3560 <dl> 3634 <dl>
3561 3635
3562 <dt><i>actions</i></dt> 3636 <dt><i>actions</i> (list of EricActio)</dt>
3563 <dd> 3637 <dd>
3564 list of actions (list of EricAction) 3638 list of actions
3565 </dd> 3639 </dd>
3566 <dt><i>actionType</i></dt> 3640 <dt><i>actionType</i> (str)</dt>
3567 <dd> 3641 <dd>
3568 string denoting the action set to remove from. 3642 string denoting the action set to remove from.
3569 It must be one of "ui" or "wizards". 3643 It must be one of "ui" or "wizards".
3570 </dd> 3644 </dd>
3571 </dl> 3645 </dl>
3612 <p> 3686 <p>
3613 Public slot to activate the debug view profile. 3687 Public slot to activate the debug view profile.
3614 </p> 3688 </p>
3615 <dl> 3689 <dl>
3616 3690
3617 <dt><i>save</i></dt> 3691 <dt><i>save</i> (bool)</dt>
3618 <dd> 3692 <dd>
3619 flag indicating that the current profile should 3693 flag indicating that the current profile should
3620 be saved (boolean) 3694 be saved
3621 </dd> 3695 </dd>
3622 </dl> 3696 </dl>
3623 <a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a> 3697 <a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
3624 <h4>UserInterface.showEmailDialog</h4> 3698 <h4>UserInterface.showEmailDialog</h4>
3625 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>) 3699 <b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
3627 <p> 3701 <p>
3628 Public slot to show the email dialog in a given mode. 3702 Public slot to show the email dialog in a given mode.
3629 </p> 3703 </p>
3630 <dl> 3704 <dl>
3631 3705
3632 <dt><i>mode</i></dt> 3706 <dt><i>mode</i> (str)</dt>
3633 <dd> 3707 <dd>
3634 mode of the email dialog (string, "bug" or "feature") 3708 mode of the email dialog ("bug" or "feature")
3635 </dd> 3709 </dd>
3636 <dt><i>attachFile</i></dt> 3710 <dt><i>attachFile</i> (str)</dt>
3637 <dd> 3711 <dd>
3638 name of a file to attach to the email (string) 3712 name of a file to attach to the email
3639 </dd> 3713 </dd>
3640 <dt><i>deleteAttachFile</i></dt> 3714 <dt><i>deleteAttachFile</i> (bool)</dt>
3641 <dd> 3715 <dd>
3642 flag indicating to delete the attached file 3716 flag indicating to delete the attached file
3643 after it has been sent (boolean) 3717 after it has been sent
3644 </dd> 3718 </dd>
3645 </dl> 3719 </dl>
3646 <a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a> 3720 <a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
3647 <h4>UserInterface.showEvent</h4> 3721 <h4>UserInterface.showEvent</h4>
3648 <b>showEvent</b>(<i>evt</i>) 3722 <b>showEvent</b>(<i>evt</i>)
3650 <p> 3724 <p>
3651 Protected method to handle the show event. 3725 Protected method to handle the show event.
3652 </p> 3726 </p>
3653 <dl> 3727 <dl>
3654 3728
3655 <dt><i>evt</i></dt> 3729 <dt><i>evt</i> (QShowEvent)</dt>
3656 <dd> 3730 <dd>
3657 reference to the show event (QShowEvent) 3731 reference to the show event
3658 </dd> 3732 </dd>
3659 </dl> 3733 </dl>
3660 <a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a> 3734 <a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a>
3661 <h4>UserInterface.showFindFileByNameDialog</h4> 3735 <h4>UserInterface.showFindFileByNameDialog</h4>
3662 <b>showFindFileByNameDialog</b>(<i></i>) 3736 <b>showFindFileByNameDialog</b>(<i></i>)
3739 <p> 3813 <p>
3740 Public slot to set the preferences. 3814 Public slot to set the preferences.
3741 </p> 3815 </p>
3742 <dl> 3816 <dl>
3743 3817
3744 <dt><i>pageName</i></dt> 3818 <dt><i>pageName</i> (str)</dt>
3745 <dd> 3819 <dd>
3746 name of the configuration page to show (string) 3820 name of the configuration page to show
3747 </dd> 3821 </dd>
3748 </dl> 3822 </dl>
3749 <a NAME="UserInterface.showReplaceFilesWidget" ID="UserInterface.showReplaceFilesWidget"></a> 3823 <a NAME="UserInterface.showReplaceFilesWidget" ID="UserInterface.showReplaceFilesWidget"></a>
3750 <h4>UserInterface.showReplaceFilesWidget</h4> 3824 <h4>UserInterface.showReplaceFilesWidget</h4>
3751 <b>showReplaceFilesWidget</b>(<i>txt="", searchDir="", openFiles=False</i>) 3825 <b>showReplaceFilesWidget</b>(<i>txt="", searchDir="", openFiles=False</i>)
3790 <p> 3864 <p>
3791 Public method to unregister a toolbar. 3865 Public method to unregister a toolbar.
3792 </p> 3866 </p>
3793 <dl> 3867 <dl>
3794 3868
3795 <dt><i>name</i></dt> 3869 <dt><i>name</i> (str)</dt>
3796 <dd> 3870 <dd>
3797 name of the toolbar (string). 3871 name of the toolbar
3798 </dd> 3872 </dd>
3799 </dl> 3873 </dl>
3800 <a NAME="UserInterface.upgradeEric" ID="UserInterface.upgradeEric"></a> 3874 <a NAME="UserInterface.upgradeEric" ID="UserInterface.upgradeEric"></a>
3801 <h4>UserInterface.upgradeEric</h4> 3875 <h4>UserInterface.upgradeEric</h4>
3802 <b>upgradeEric</b>(<i></i>) 3876 <b>upgradeEric</b>(<i></i>)
3863 Public method to check, if the eric version is good compared to 3937 Public method to check, if the eric version is good compared to
3864 the required version. 3938 the required version.
3865 </p> 3939 </p>
3866 <dl> 3940 <dl>
3867 3941
3868 <dt><i>required</i></dt> 3942 <dt><i>required</i> (str)</dt>
3869 <dd> 3943 <dd>
3870 required version (string) 3944 required version
3871 </dd> 3945 </dd>
3872 <dt><i>snapshot</i></dt> 3946 <dt><i>snapshot</i> (str)</dt>
3873 <dd> 3947 <dd>
3874 required snapshot version (string) 3948 required snapshot version
3875 </dd> 3949 </dd>
3876 </dl> 3950 </dl>
3877 <dl> 3951 <dl>
3878 <dt>Return:</dt> 3952 <dt>Return:</dt>
3879 <dd> 3953 <dd>
3880 flag indicating, that the version is newer than the required 3954 flag indicating, that the version is newer than the required one
3881 one (boolean) 3955 </dd>
3956 </dl>
3957 <dl>
3958 <dt>Return Type:</dt>
3959 <dd>
3960 bool
3882 </dd> 3961 </dd>
3883 </dl> 3962 </dl>
3884 <div align="right"><a href="#top">Up</a></div> 3963 <div align="right"><a href="#top">Up</a></div>
3885 <hr /> 3964 <hr />
3886 </body></html> 3965 </body></html>

Mercurial Repository: eric

eric ide

mercurial