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

branch
eric7
changeset 10828
fc1310995b98
parent 10816
236d97cba7c5
child 10838
2989df16da36
equal deleted inserted replaced
10827:54e6de23c546 10828:fc1310995b98
204 <tr> 204 <tr>
205 <td><a href="#UserInterface.__checkActions">__checkActions</a></td> 205 <td><a href="#UserInterface.__checkActions">__checkActions</a></td>
206 <td>Private slot to check some actions for their enable/disable status.</td> 206 <td>Private slot to check some actions for their enable/disable status.</td>
207 </tr> 207 </tr>
208 <tr> 208 <tr>
209 <td><a href="#UserInterface.__checkCrashSessionExists">__checkCrashSessionExists</a></td>
210 <td>Private method to check for the existence of crash session files and select the one to open.</td>
211 </tr>
212 <tr>
209 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td> 213 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td>
210 <td>Private slot to start the win help viewer to show *.chm files.</td> 214 <td>Private slot to start the win help viewer to show *.chm files.</td>
211 </tr> 215 </tr>
212 <tr> 216 <tr>
217 <td><a href="#UserInterface.__cleanCrashSessions">__cleanCrashSessions</a></td>
218 <td>Private slot to clean all stale crash sessions.</td>
219 </tr>
220 <tr>
213 <td><a href="#UserInterface.__clearPrivateData">__clearPrivateData</a></td> 221 <td><a href="#UserInterface.__clearPrivateData">__clearPrivateData</a></td>
214 <td>Private slot to clear the private data lists.</td> 222 <td>Private slot to clear the private data lists.</td>
215 </tr> 223 </tr>
216 <tr> 224 <tr>
217 <td><a href="#UserInterface.__commitData">__commitData</a></td> 225 <td><a href="#UserInterface.__commitData">__commitData</a></td>
244 <tr> 252 <tr>
245 <td><a href="#UserInterface.__copyVersions">__copyVersions</a></td> 253 <td><a href="#UserInterface.__copyVersions">__copyVersions</a></td>
246 <td>Private method to generated version information and copy that to the clipboard.</td> 254 <td>Private method to generated version information and copy that to the clipboard.</td>
247 </tr> 255 </tr>
248 <tr> 256 <tr>
257 <td><a href="#UserInterface.__crashSessionFilePath">__crashSessionFilePath</a></td>
258 <td>Private method to generate a path name for a unique crash session file.</td>
259 </tr>
260 <tr>
249 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td> 261 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
250 <td>Private method to create a dock window with common properties.</td> 262 <td>Private method to create a dock window with common properties.</td>
251 </tr> 263 </tr>
252 <tr> 264 <tr>
253 <td><a href="#UserInterface.__createLayout">__createLayout</a></td> 265 <td><a href="#UserInterface.__createLayout">__createLayout</a></td>
312 <tr> 324 <tr>
313 <td><a href="#UserInterface.__exportTheme">__exportTheme</a></td> 325 <td><a href="#UserInterface.__exportTheme">__exportTheme</a></td>
314 <td>Private slot to export the current theme to a file.</td> 326 <td>Private slot to export the current theme to a file.</td>
315 </tr> 327 </tr>
316 <tr> 328 <tr>
329 <td><a href="#UserInterface.__getCrashedSessions">__getCrashedSessions</a></td>
330 <td>Private method to get a list of crash session file paths of crashed sessions.</td>
331 </tr>
332 <tr>
317 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td> 333 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td>
318 <td>Private method to get the geometry of a floating windows.</td> 334 <td>Private method to get the geometry of a floating windows.</td>
319 </tr> 335 </tr>
320 <tr> 336 <tr>
321 <td><a href="#UserInterface.__hToolboxCurrentChanged">__hToolboxCurrentChanged</a></td> 337 <td><a href="#UserInterface.__hToolboxCurrentChanged">__hToolboxCurrentChanged</a></td>
406 <td>Private method to start an external web browser and communicate with it.</td> 422 <td>Private method to start an external web browser and communicate with it.</td>
407 </tr> 423 </tr>
408 <tr> 424 <tr>
409 <td><a href="#UserInterface.__linguist">__linguist</a></td> 425 <td><a href="#UserInterface.__linguist">__linguist</a></td>
410 <td>Private slot to start the Qt-Linguist executable.</td> 426 <td>Private slot to start the Qt-Linguist executable.</td>
427 </tr>
428 <tr>
429 <td><a href="#UserInterface.__loadCrashSession">__loadCrashSession</a></td>
430 <td>Private slot to load a crash session.</td>
411 </tr> 431 </tr>
412 <tr> 432 <tr>
413 <td><a href="#UserInterface.__loadSessionFromFile">__loadSessionFromFile</a></td> 433 <td><a href="#UserInterface.__loadSessionFromFile">__loadSessionFromFile</a></td>
414 <td>Private slot to load a session from disk.</td> 434 <td>Private slot to load a session from disk.</td>
415 </tr> 435 </tr>
1358 <dt><i>editor</i> (Editor)</dt> 1378 <dt><i>editor</i> (Editor)</dt>
1359 <dd> 1379 <dd>
1360 editor window 1380 editor window
1361 </dd> 1381 </dd>
1362 </dl> 1382 </dl>
1383 <a NAME="UserInterface.__checkCrashSessionExists" ID="UserInterface.__checkCrashSessionExists"></a>
1384 <h4>UserInterface.__checkCrashSessionExists</h4>
1385 <b>__checkCrashSessionExists</b>(<i></i>)
1386 <p>
1387 Private method to check for the existence of crash session files and
1388 select the one to open.
1389 </p>
1390
1391 <dl>
1392 <dt>Return:</dt>
1393 <dd>
1394 file path of the crash session file to open. An empty string indicates
1395 that no crash session file should be opened or exists.
1396 </dd>
1397 </dl>
1398 <dl>
1399 <dt>Return Type:</dt>
1400 <dd>
1401 str
1402 </dd>
1403 </dl>
1363 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a> 1404 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
1364 <h4>UserInterface.__chmViewer</h4> 1405 <h4>UserInterface.__chmViewer</h4>
1365 <b>__chmViewer</b>(<i>home=None</i>) 1406 <b>__chmViewer</b>(<i>home=None</i>)
1366 <p> 1407 <p>
1367 Private slot to start the win help viewer to show *.chm files. 1408 Private slot to start the win help viewer to show *.chm files.
1372 <dt><i>home</i> (str)</dt> 1413 <dt><i>home</i> (str)</dt>
1373 <dd> 1414 <dd>
1374 full pathname of a file to display 1415 full pathname of a file to display
1375 </dd> 1416 </dd>
1376 </dl> 1417 </dl>
1418 <a NAME="UserInterface.__cleanCrashSessions" ID="UserInterface.__cleanCrashSessions"></a>
1419 <h4>UserInterface.__cleanCrashSessions</h4>
1420 <b>__cleanCrashSessions</b>(<i></i>)
1421 <p>
1422 Private slot to clean all stale crash sessions.
1423 </p>
1424
1377 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a> 1425 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a>
1378 <h4>UserInterface.__clearPrivateData</h4> 1426 <h4>UserInterface.__clearPrivateData</h4>
1379 <b>__clearPrivateData</b>(<i></i>) 1427 <b>__clearPrivateData</b>(<i></i>)
1380 <p> 1428 <p>
1381 Private slot to clear the private data lists. 1429 Private slot to clear the private data lists.
1463 <b>__copyVersions</b>(<i></i>) 1511 <b>__copyVersions</b>(<i></i>)
1464 <p> 1512 <p>
1465 Private method to generated version information and copy that to the clipboard. 1513 Private method to generated version information and copy that to the clipboard.
1466 </p> 1514 </p>
1467 1515
1516 <a NAME="UserInterface.__crashSessionFilePath" ID="UserInterface.__crashSessionFilePath"></a>
1517 <h4>UserInterface.__crashSessionFilePath</h4>
1518 <b>__crashSessionFilePath</b>(<i>globPattern=False</i>)
1519 <p>
1520 Private method to generate a path name for a unique crash session file.
1521 </p>
1522
1523 <dl>
1524
1525 <dt><i>globPattern</i> (bool (optional))</dt>
1526 <dd>
1527 flag indicating to get the glob pattern for crash
1528 session files (defaults to False)
1529 </dd>
1530 </dl>
1531 <dl>
1532 <dt>Return:</dt>
1533 <dd>
1534 crash session file path
1535 </dd>
1536 </dl>
1537 <dl>
1538 <dt>Return Type:</dt>
1539 <dd>
1540 str
1541 </dd>
1542 </dl>
1468 <a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a> 1543 <a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
1469 <h4>UserInterface.__createDockWindow</h4> 1544 <h4>UserInterface.__createDockWindow</h4>
1470 <b>__createDockWindow</b>(<i>name</i>) 1545 <b>__createDockWindow</b>(<i>name</i>)
1471 <p> 1546 <p>
1472 Private method to create a dock window with common properties. 1547 Private method to create a dock window with common properties.
1636 <b>__exportTheme</b>(<i></i>) 1711 <b>__exportTheme</b>(<i></i>)
1637 <p> 1712 <p>
1638 Private slot to export the current theme to a file. 1713 Private slot to export the current theme to a file.
1639 </p> 1714 </p>
1640 1715
1716 <a NAME="UserInterface.__getCrashedSessions" ID="UserInterface.__getCrashedSessions"></a>
1717 <h4>UserInterface.__getCrashedSessions</h4>
1718 <b>__getCrashedSessions</b>(<i></i>)
1719 <p>
1720 Private method to get a list of crash session file paths of crashed sessions.
1721 </p>
1722 <p>
1723 Note: Crashed sessions are those, whose PID does not exist anymore.
1724 </p>
1725
1726 <dl>
1727 <dt>Return:</dt>
1728 <dd>
1729 list of crashed session file paths
1730 </dd>
1731 </dl>
1732 <dl>
1733 <dt>Return Type:</dt>
1734 <dd>
1735 list of str
1736 </dd>
1737 </dl>
1641 <a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a> 1738 <a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a>
1642 <h4>UserInterface.__getFloatingGeometry</h4> 1739 <h4>UserInterface.__getFloatingGeometry</h4>
1643 <b>__getFloatingGeometry</b>(<i>w</i>) 1740 <b>__getFloatingGeometry</b>(<i>w</i>)
1644 <p> 1741 <p>
1645 Private method to get the geometry of a floating windows. 1742 Private method to get the geometry of a floating windows.
1891 <dt><i>fn</i> (str)</dt> 1988 <dt><i>fn</i> (str)</dt>
1892 <dd> 1989 <dd>
1893 filename of the translation file to be opened 1990 filename of the translation file to be opened
1894 </dd> 1991 </dd>
1895 </dl> 1992 </dl>
1993 <a NAME="UserInterface.__loadCrashSession" ID="UserInterface.__loadCrashSession"></a>
1994 <h4>UserInterface.__loadCrashSession</h4>
1995 <b>__loadCrashSession</b>(<i></i>)
1996 <p>
1997 Private slot to load a crash session.
1998 </p>
1999
1896 <a NAME="UserInterface.__loadSessionFromFile" ID="UserInterface.__loadSessionFromFile"></a> 2000 <a NAME="UserInterface.__loadSessionFromFile" ID="UserInterface.__loadSessionFromFile"></a>
1897 <h4>UserInterface.__loadSessionFromFile</h4> 2001 <h4>UserInterface.__loadSessionFromFile</h4>
1898 <b>__loadSessionFromFile</b>(<i></i>) 2002 <b>__loadSessionFromFile</b>(<i></i>)
1899 <p> 2003 <p>
1900 Private slot to load a session from disk. 2004 Private slot to load a session from disk.
2861 Private slot to write a crash session file. 2965 Private slot to write a crash session file.
2862 </p> 2966 </p>
2863 2967
2864 <a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a> 2968 <a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a>
2865 <h4>UserInterface.__writeSession</h4> 2969 <h4>UserInterface.__writeSession</h4>
2866 <b>__writeSession</b>(<i>filename="", crashSession=False</i>) 2970 <b>__writeSession</b>(<i>filename=""</i>)
2867 <p> 2971 <p>
2868 Private slot to write the session data to a JSON file (.esj). 2972 Private slot to write the session data to a JSON file (.esj).
2869 </p> 2973 </p>
2870 2974
2871 <dl> 2975 <dl>
2872 2976
2873 <dt><i>filename</i> (str)</dt> 2977 <dt><i>filename</i> (str)</dt>
2874 <dd> 2978 <dd>
2875 name of a session file to write 2979 name of a session file to write
2876 </dd>
2877 <dt><i>crashSession</i> (bool)</dt>
2878 <dd>
2879 flag indicating to write a crash session file
2880 </dd> 2980 </dd>
2881 </dl> 2981 </dl>
2882 <dl> 2982 <dl>
2883 <dt>Return:</dt> 2983 <dt>Return:</dt>
2884 <dd> 2984 <dd>

eric ide

mercurial