Documentation/Source/eric6.UI.UserInterface.html

changeset 6632
084880ed940c
parent 6589
613426e62983
child 6934
eae7d1d9cc7b
equal deleted inserted replaced
6631:0a2f0feac79d 6632:084880ed940c
265 <td>Private slot to configure the various view profiles.</td> 265 <td>Private slot to configure the various view profiles.</td>
266 </tr><tr> 266 </tr><tr>
267 <td><a href="#UserInterface.__configureDockareaCornerUsage">__configureDockareaCornerUsage</a></td> 267 <td><a href="#UserInterface.__configureDockareaCornerUsage">__configureDockareaCornerUsage</a></td>
268 <td>Private method to configure the usage of the dockarea corners.</td> 268 <td>Private method to configure the usage of the dockarea corners.</td>
269 </tr><tr> 269 </tr><tr>
270 <td><a href="#UserInterface.__connectToWebBrowser">__connectToWebBrowser</a></td>
271 <td>Private method to connect to a started web browser.</td>
272 </tr><tr>
270 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td> 273 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
271 <td>Private method to create a dock window with common properties.</td> 274 <td>Private method to create a dock window with common properties.</td>
272 </tr><tr> 275 </tr><tr>
273 <td><a href="#UserInterface.__createLayout">__createLayout</a></td> 276 <td><a href="#UserInterface.__createLayout">__createLayout</a></td>
274 <td>Private method to create the layout of the various windows.</td> 277 <td>Private method to create the layout of the various windows.</td>
319 <td>Private method to get the geometry of a floating windows.</td> 322 <td>Private method to get the geometry of a floating windows.</td>
320 </tr><tr> 323 </tr><tr>
321 <td><a href="#UserInterface.__hasErrorLog">__hasErrorLog</a></td> 324 <td><a href="#UserInterface.__hasErrorLog">__hasErrorLog</a></td>
322 <td>Private method to check, if an error log file exists.</td> 325 <td>Private method to check, if an error log file exists.</td>
323 </tr><tr> 326 </tr><tr>
324 <td><a href="#UserInterface.__helpClosed">__helpClosed</a></td>
325 <td>Private slot to handle the helpClosed signal of the help window.</td>
326 </tr><tr>
327 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td> 327 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
328 <td>Private slot to start an empty help viewer/web browser.</td> 328 <td>Private slot to start an empty help viewer/web browser.</td>
329 </tr><tr> 329 </tr><tr>
330 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td> 330 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
331 <td>Private slot to import preferences.</td> 331 <td>Private slot to import preferences.</td>
373 <td>Private slot handling the automatic connection of the IRC client.</td> 373 <td>Private slot handling the automatic connection of the IRC client.</td>
374 </tr><tr> 374 </tr><tr>
375 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td> 375 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td>
376 <td>Private slot to handle the lastEditorClosed signal.</td> 376 <td>Private slot to handle the lastEditorClosed signal.</td>
377 </tr><tr> 377 </tr><tr>
378 <td><a href="#UserInterface.__launchExternalWebBrowser">__launchExternalWebBrowser</a></td>
379 <td>Private method to start an external web browser and communicate with it.</td>
380 </tr><tr>
378 <td><a href="#UserInterface.__linguist">__linguist</a></td> 381 <td><a href="#UserInterface.__linguist">__linguist</a></td>
379 <td>Private slot to start the Qt-Linguist executable.</td> 382 <td>Private slot to start the Qt-Linguist executable.</td>
380 </tr><tr> 383 </tr><tr>
381 <td><a href="#UserInterface.__linguist4">__linguist4</a></td> 384 <td><a href="#UserInterface.__linguist4">__linguist4</a></td>
382 <td>Private slot to start the Qt-Linguist 4/5 executable.</td> 385 <td>Private slot to start the Qt-Linguist 4/5 executable.</td>
658 <td>Private slot called, after the versions file has been downloaded from the internet.</td> 661 <td>Private slot called, after the versions file has been downloaded from the internet.</td>
659 </tr><tr> 662 </tr><tr>
660 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td> 663 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
661 <td>Private slot to start the eric6 web browser.</td> 664 <td>Private slot to start the eric6 web browser.</td>
662 </tr><tr> 665 </tr><tr>
666 <td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td>
667 <td>Private slot handling the end of the external web browser process.</td>
668 </tr><tr>
669 <td><a href="#UserInterface.__webBrowserShutdown">__webBrowserShutdown</a></td>
670 <td>Private method to shut down the web browser.</td>
671 </tr><tr>
663 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td> 672 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td>
664 <td>Private slot called in to enter Whats This mode.</td> 673 <td>Private slot called in to enter Whats This mode.</td>
665 </tr><tr> 674 </tr><tr>
666 <td><a href="#UserInterface.__writeCrashSession">__writeCrashSession</a></td> 675 <td><a href="#UserInterface.__writeCrashSession">__writeCrashSession</a></td>
667 <td>Private slot to write a crash session file.</td> 676 <td>Private slot to write a crash session file.</td>
729 <td><a href="#UserInterface.dropEvent">dropEvent</a></td> 738 <td><a href="#UserInterface.dropEvent">dropEvent</a></td>
730 <td>Protected method to handle the drop event.</td> 739 <td>Protected method to handle the drop event.</td>
731 </tr><tr> 740 </tr><tr>
732 <td><a href="#UserInterface.getActions">getActions</a></td> 741 <td><a href="#UserInterface.getActions">getActions</a></td>
733 <td>Public method to get a list of all actions.</td> 742 <td>Public method to get a list of all actions.</td>
734 </tr><tr>
735 <td><a href="#UserInterface.getHelpViewer">getHelpViewer</a></td>
736 <td>Public method to get a reference to the help window instance.</td>
737 </tr><tr> 743 </tr><tr>
738 <td><a href="#UserInterface.getLayoutType">getLayoutType</a></td> 744 <td><a href="#UserInterface.getLayoutType">getLayoutType</a></td>
739 <td>Public method to get the current layout type.</td> 745 <td>Public method to get the current layout type.</td>
740 </tr><tr> 746 </tr><tr>
741 <td><a href="#UserInterface.getLocale">getLocale</a></td> 747 <td><a href="#UserInterface.getLocale">getLocale</a></td>
1066 </p><a NAME="UserInterface.__configureDockareaCornerUsage" ID="UserInterface.__configureDockareaCornerUsage"></a> 1072 </p><a NAME="UserInterface.__configureDockareaCornerUsage" ID="UserInterface.__configureDockareaCornerUsage"></a>
1067 <h4>UserInterface.__configureDockareaCornerUsage</h4> 1073 <h4>UserInterface.__configureDockareaCornerUsage</h4>
1068 <b>__configureDockareaCornerUsage</b>(<i></i>) 1074 <b>__configureDockareaCornerUsage</b>(<i></i>)
1069 <p> 1075 <p>
1070 Private method to configure the usage of the dockarea corners. 1076 Private method to configure the usage of the dockarea corners.
1071 </p><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a> 1077 </p><a NAME="UserInterface.__connectToWebBrowser" ID="UserInterface.__connectToWebBrowser"></a>
1078 <h4>UserInterface.__connectToWebBrowser</h4>
1079 <b>__connectToWebBrowser</b>(<i>process</i>)
1080 <p>
1081 Private method to connect to a started web browser.
1082 </p><dl>
1083 <dt><i>process</i> (QProcess)</dt>
1084 <dd>
1085 reference to the started web browser process
1086 </dd>
1087 </dl><dl>
1088 <dt>Returns:</dt>
1089 <dd>
1090 error indication (1 = connection not possible, 0 = ok,
1091 -1 = server exited with an error code)
1092 </dd>
1093 </dl><dl>
1094 <dt>Return Type:</dt>
1095 <dd>
1096 int
1097 </dd>
1098 </dl><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
1072 <h4>UserInterface.__createDockWindow</h4> 1099 <h4>UserInterface.__createDockWindow</h4>
1073 <b>__createDockWindow</b>(<i>name</i>) 1100 <b>__createDockWindow</b>(<i>name</i>)
1074 <p> 1101 <p>
1075 Private method to create a dock window with common properties. 1102 Private method to create a dock window with common properties.
1076 </p><dl> 1103 </p><dl>
1224 </p><dl> 1251 </p><dl>
1225 <dt>Returns:</dt> 1252 <dt>Returns:</dt>
1226 <dd> 1253 <dd>
1227 flag indicating the existence of an error log file (boolean) 1254 flag indicating the existence of an error log file (boolean)
1228 </dd> 1255 </dd>
1229 </dl><a NAME="UserInterface.__helpClosed" ID="UserInterface.__helpClosed"></a> 1256 </dl><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1230 <h4>UserInterface.__helpClosed</h4>
1231 <b>__helpClosed</b>(<i></i>)
1232 <p>
1233 Private slot to handle the helpClosed signal of the help window.
1234 </p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1235 <h4>UserInterface.__helpViewer</h4> 1257 <h4>UserInterface.__helpViewer</h4>
1236 <b>__helpViewer</b>(<i></i>) 1258 <b>__helpViewer</b>(<i></i>)
1237 <p> 1259 <p>
1238 Private slot to start an empty help viewer/web browser. 1260 Private slot to start an empty help viewer/web browser.
1239 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a> 1261 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
1327 </p><a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a> 1349 </p><a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a>
1328 <h4>UserInterface.__lastEditorClosed</h4> 1350 <h4>UserInterface.__lastEditorClosed</h4>
1329 <b>__lastEditorClosed</b>(<i></i>) 1351 <b>__lastEditorClosed</b>(<i></i>)
1330 <p> 1352 <p>
1331 Private slot to handle the lastEditorClosed signal. 1353 Private slot to handle the lastEditorClosed signal.
1332 </p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a> 1354 </p><a NAME="UserInterface.__launchExternalWebBrowser" ID="UserInterface.__launchExternalWebBrowser"></a>
1355 <h4>UserInterface.__launchExternalWebBrowser</h4>
1356 <b>__launchExternalWebBrowser</b>(<i>home, searchWord=None</i>)
1357 <p>
1358 Private method to start an external web browser and communicate with
1359 it.
1360 </p><dl>
1361 <dt><i>home</i> (str)</dt>
1362 <dd>
1363 filename of file to be shown or URL to be opened
1364 </dd><dt><i>searchWord=</i> (str)</dt>
1365 <dd>
1366 word to search for
1367 </dd>
1368 </dl><dl>
1369 <dt>Returns:</dt>
1370 <dd>
1371 flag indicating a successful launch
1372 </dd>
1373 </dl><dl>
1374 <dt>Return Type:</dt>
1375 <dd>
1376 bool
1377 </dd>
1378 </dl><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
1333 <h4>UserInterface.__linguist</h4> 1379 <h4>UserInterface.__linguist</h4>
1334 <b>__linguist</b>(<i>fn=None, version=0</i>) 1380 <b>__linguist</b>(<i>fn=None, version=0</i>)
1335 <p> 1381 <p>
1336 Private slot to start the Qt-Linguist executable. 1382 Private slot to start the Qt-Linguist executable.
1337 </p><dl> 1383 </p><dl>
2057 </p><dl> 2103 </p><dl>
2058 <dt><i>home</i></dt> 2104 <dt><i>home</i></dt>
2059 <dd> 2105 <dd>
2060 full pathname of a file to display (string) 2106 full pathname of a file to display (string)
2061 </dd> 2107 </dd>
2062 </dl><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a> 2108 </dl><a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a>
2109 <h4>UserInterface.__webBrowserFinished</h4>
2110 <b>__webBrowserFinished</b>(<i></i>)
2111 <p>
2112 Private slot handling the end of the external web browser process.
2113 </p><a NAME="UserInterface.__webBrowserShutdown" ID="UserInterface.__webBrowserShutdown"></a>
2114 <h4>UserInterface.__webBrowserShutdown</h4>
2115 <b>__webBrowserShutdown</b>(<i></i>)
2116 <p>
2117 Private method to shut down the web browser.
2118 </p><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
2063 <h4>UserInterface.__whatsThis</h4> 2119 <h4>UserInterface.__whatsThis</h4>
2064 <b>__whatsThis</b>(<i></i>) 2120 <b>__whatsThis</b>(<i></i>)
2065 <p> 2121 <p>
2066 Private slot called in to enter Whats This mode. 2122 Private slot called in to enter Whats This mode.
2067 </p><a NAME="UserInterface.__writeCrashSession" ID="UserInterface.__writeCrashSession"></a> 2123 </p><a NAME="UserInterface.__writeCrashSession" ID="UserInterface.__writeCrashSession"></a>
2289 </dd> 2345 </dd>
2290 </dl><dl> 2346 </dl><dl>
2291 <dt>Returns:</dt> 2347 <dt>Returns:</dt>
2292 <dd> 2348 <dd>
2293 list of all actions (list of E5Action) 2349 list of all actions (list of E5Action)
2294 </dd>
2295 </dl><a NAME="UserInterface.getHelpViewer" ID="UserInterface.getHelpViewer"></a>
2296 <h4>UserInterface.getHelpViewer</h4>
2297 <b>getHelpViewer</b>(<i>preview=False</i>)
2298 <p>
2299 Public method to get a reference to the help window instance.
2300 </p><dl>
2301 <dt><i>preview=</i></dt>
2302 <dd>
2303 flag indicating to get a help window for preview
2304 (boolean)
2305 </dd>
2306 </dl><dl>
2307 <dt>Returns:</dt>
2308 <dd>
2309 reference to the help window instance (HelpWindow)
2310 </dd> 2350 </dd>
2311 </dl><a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a> 2351 </dl><a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
2312 <h4>UserInterface.getLayoutType</h4> 2352 <h4>UserInterface.getLayoutType</h4>
2313 <b>getLayoutType</b>(<i></i>) 2353 <b>getLayoutType</b>(<i></i>)
2314 <p> 2354 <p>

eric ide

mercurial