Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.UI.UserInterface.html

Documentation/Source/eric5.UI.UserInterface.html

changeset 2966
f85f686981ad
parent 2763
e4794166ad70
child 3018
70924c0bdaf1
equal deleted inserted replaced
2965:d133c7edd88a 2966:f85f686981ad
29 </table> 29 </table>
30 <h3>Classes</h3> 30 <h3>Classes</h3>
31 <table> 31 <table>
32 <tr> 32 <tr>
33 <td><a href="#Redirector">Redirector</a></td> 33 <td><a href="#Redirector">Redirector</a></td>
34 <td>Helper class used to redirect stdout and stderr to the log window</td> 34 <td>Helper class used to redirect stdout and stderr to the log window.</td>
35 </tr><tr> 35 </tr><tr>
36 <td><a href="#UserInterface">UserInterface</a></td> 36 <td><a href="#UserInterface">UserInterface</a></td>
37 <td>Class implementing the main user interface.</td> 37 <td>Class implementing the main user interface.</td>
38 </tr> 38 </tr>
39 </table> 39 </table>
43 </table> 43 </table>
44 <hr /><hr /> 44 <hr /><hr />
45 <a NAME="Redirector" ID="Redirector"></a> 45 <a NAME="Redirector" ID="Redirector"></a>
46 <h2>Redirector</h2> 46 <h2>Redirector</h2>
47 <p> 47 <p>
48 Helper class used to redirect stdout and stderr to the log window 48 Helper class used to redirect stdout and stderr to the log window.
49 </p><h3>Signals</h3> 49 </p><h3>Signals</h3>
50 <dl> 50 <dl>
51 <dt>appendStderr(str)</dt> 51 <dt>appendStderr(str)</dt>
52 <dd> 52 <dd>
53 emitted to write data to stderr logger 53 emitted to write data to stderr logger
402 </tr><tr> 402 </tr><tr>
403 <td><a href="#UserInterface.__quit">__quit</a></td> 403 <td><a href="#UserInterface.__quit">__quit</a></td>
404 <td>Private method to quit the application.</td> 404 <td>Private method to quit the application.</td>
405 </tr><tr> 405 </tr><tr>
406 <td><a href="#UserInterface.__readSession">__readSession</a></td> 406 <td><a href="#UserInterface.__readSession">__readSession</a></td>
407 <td>Private slot to read in the session file (.e4s)</td> 407 <td>Private slot to read in the session file (.e4s).</td>
408 </tr><tr> 408 </tr><tr>
409 <td><a href="#UserInterface.__readTasks">__readTasks</a></td> 409 <td><a href="#UserInterface.__readTasks">__readTasks</a></td>
410 <td>Private slot to read in the tasks file (.e4t)</td> 410 <td>Private slot to read in the tasks file (.e4t).</td>
411 </tr><tr> 411 </tr><tr>
412 <td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td> 412 <td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td>
413 <td>Private slot to reload the api information.</td> 413 <td>Private slot to reload the api information.</td>
414 </tr><tr> 414 </tr><tr>
415 <td><a href="#UserInterface.__reportBug">__reportBug</a></td> 415 <td><a href="#UserInterface.__reportBug">__reportBug</a></td>
988 </p><dl> 988 </p><dl>
989 <dt><i>debugServer</i></dt> 989 <dt><i>debugServer</i></dt>
990 <dd> 990 <dd>
991 reference to the debug server object 991 reference to the debug server object
992 </dd> 992 </dd>
993 </dl><dl>
994 <dt>Raises <b>ValueError</b>:</dt>
995 <dd>
996 raised to indicate an invalid layout type
997 </dd>
993 </dl><a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a> 998 </dl><a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
994 <h4>UserInterface.__createSidebarsLayout</h4> 999 <h4>UserInterface.__createSidebarsLayout</h4>
995 <b>__createSidebarsLayout</b>(<i>debugServer</i>) 1000 <b>__createSidebarsLayout</b>(<i>debugServer</i>)
996 <p> 1001 <p>
997 Private method to create the Sidebars layout. 1002 Private method to create the Sidebars layout.
1305 Private method to quit the application. 1310 Private method to quit the application.
1306 </p><a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a> 1311 </p><a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a>
1307 <h4>UserInterface.__readSession</h4> 1312 <h4>UserInterface.__readSession</h4>
1308 <b>__readSession</b>(<i></i>) 1313 <b>__readSession</b>(<i></i>)
1309 <p> 1314 <p>
1310 Private slot to read in the session file (.e4s) 1315 Private slot to read in the session file (.e4s).
1311 </p><a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a> 1316 </p><a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a>
1312 <h4>UserInterface.__readTasks</h4> 1317 <h4>UserInterface.__readTasks</h4>
1313 <b>__readTasks</b>(<i></i>) 1318 <b>__readTasks</b>(<i></i>)
1314 <p> 1319 <p>
1315 Private slot to read in the tasks file (.e4t) 1320 Private slot to read in the tasks file (.e4t).
1316 </p><a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a> 1321 </p><a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a>
1317 <h4>UserInterface.__reloadAPIs</h4> 1322 <h4>UserInterface.__reloadAPIs</h4>
1318 <b>__reloadAPIs</b>(<i></i>) 1323 <b>__reloadAPIs</b>(<i></i>)
1319 <p> 1324 <p>
1320 Private slot to reload the api information. 1325 Private slot to reload the api information.
1822 <h4>UserInterface.addE5Actions</h4> 1827 <h4>UserInterface.addE5Actions</h4>
1823 <b>addE5Actions</b>(<i>actions, type</i>) 1828 <b>addE5Actions</b>(<i>actions, type</i>)
1824 <p> 1829 <p>
1825 Public method to add actions to the list of actions. 1830 Public method to add actions to the list of actions.
1826 </p><dl> 1831 </p><dl>
1827 <dt><i>type</i></dt> 1832 <dt><i>actions</i></dt>
1833 <dd>
1834 list of actions to be added (list of E5Action)
1835 </dd><dt><i>type</i></dt>
1828 <dd> 1836 <dd>
1829 string denoting the action set to get. 1837 string denoting the action set to get.
1830 It must be one of "ui" or "wizards". 1838 It must be one of "ui" or "wizards".
1831 </dd><dt><i>actions</i></dt>
1832 <dd>
1833 list of actions to be added (list of E5Action)
1834 </dd> 1839 </dd>
1835 </dl><a NAME="UserInterface.addSideWidget" ID="UserInterface.addSideWidget"></a> 1840 </dl><a NAME="UserInterface.addSideWidget" ID="UserInterface.addSideWidget"></a>
1836 <h4>UserInterface.addSideWidget</h4> 1841 <h4>UserInterface.addSideWidget</h4>
1837 <b>addSideWidget</b>(<i>side, widget, icon, label</i>) 1842 <b>addSideWidget</b>(<i>side, widget, icon, label</i>)
1838 <p> 1843 <p>
2015 </dd><dt><i>actionName</i></dt> 2020 </dd><dt><i>actionName</i></dt>
2016 <dd> 2021 <dd>
2017 object name of the action to search for 2022 object name of the action to search for
2018 (string) 2023 (string)
2019 </dd> 2024 </dd>
2025 </dl><dl>
2026 <dt>Returns:</dt>
2027 <dd>
2028 reference to the menu action (QAction)
2029 </dd>
2020 </dl><a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a> 2030 </dl><a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
2021 <h4>UserInterface.getMenuBarAction</h4> 2031 <h4>UserInterface.getMenuBarAction</h4>
2022 <b>getMenuBarAction</b>(<i>menuName</i>) 2032 <b>getMenuBarAction</b>(<i>menuName</i>)
2023 <p> 2033 <p>
2024 Public method to get a reference to an action of the main menu. 2034 Public method to get a reference to an action of the main menu.
2025 </p><dl> 2035 </p><dl>
2026 <dt><i>menuName</i></dt> 2036 <dt><i>menuName</i></dt>
2027 <dd> 2037 <dd>
2028 name of the menu to search in (string) 2038 name of the menu to search in (string)
2029 </dd> 2039 </dd>
2040 </dl><dl>
2041 <dt>Returns:</dt>
2042 <dd>
2043 reference to the menu bar action (QAction)
2044 </dd>
2030 </dl><a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a> 2045 </dl><a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a>
2031 <h4>UserInterface.getToolBarIconSize</h4> 2046 <h4>UserInterface.getToolBarIconSize</h4>
2032 <b>getToolBarIconSize</b>(<i></i>) 2047 <b>getToolBarIconSize</b>(<i></i>)
2033 <p> 2048 <p>
2034 Public method to get the toolbar icon size. 2049 Public method to get the toolbar icon size.
2098 <dd> 2113 <dd>
2099 flag indicating an invocation via the menu (boolean) 2114 flag indicating an invocation via the menu (boolean)
2100 </dd><dt><i>alternative</i></dt> 2115 </dd><dt><i>alternative</i></dt>
2101 <dd> 2116 <dd>
2102 index of server to download from (integer) 2117 index of server to download from (integer)
2103 </dd><dt><i>showVersion=</i></dt> 2118 </dd><dt><i>showVersions=</i></dt>
2104 <dd> 2119 <dd>
2105 flag indicating the show versions mode (boolean) 2120 flag indicating the show versions mode (boolean)
2106 </dd> 2121 </dd>
2107 </dl><a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a> 2122 </dl><a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a>
2108 <h4>UserInterface.processArgs</h4> 2123 <h4>UserInterface.processArgs</h4>
2150 <h4>UserInterface.removeE5Actions</h4> 2165 <h4>UserInterface.removeE5Actions</h4>
2151 <b>removeE5Actions</b>(<i>actions, type='ui'</i>) 2166 <b>removeE5Actions</b>(<i>actions, type='ui'</i>)
2152 <p> 2167 <p>
2153 Public method to remove actions from the list of actions. 2168 Public method to remove actions from the list of actions.
2154 </p><dl> 2169 </p><dl>
2155 <dt><i>type</i></dt> 2170 <dt><i>actions</i></dt>
2171 <dd>
2172 list of actions (list of E5Action)
2173 </dd><dt><i>type</i></dt>
2156 <dd> 2174 <dd>
2157 string denoting the action set to get. 2175 string denoting the action set to get.
2158 It must be one of "ui" or "wizards". 2176 It must be one of "ui" or "wizards".
2159 </dd><dt><i>actions</i></dt>
2160 <dd>
2161 list of actions (list of E5Action)
2162 </dd> 2177 </dd>
2163 </dl><a NAME="UserInterface.removeSideWidget" ID="UserInterface.removeSideWidget"></a> 2178 </dl><a NAME="UserInterface.removeSideWidget" ID="UserInterface.removeSideWidget"></a>
2164 <h4>UserInterface.removeSideWidget</h4> 2179 <h4>UserInterface.removeSideWidget</h4>
2165 <b>removeSideWidget</b>(<i>widget</i>) 2180 <b>removeSideWidget</b>(<i>widget</i>)
2166 <p> 2181 <p>

Mercurial Repository: eric

eric ide

mercurial