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

branch
eric7
changeset 10828
fc1310995b98
parent 10816
236d97cba7c5
child 10838
2989df16da36
--- a/src/eric7/Documentation/Source/eric7.UI.UserInterface.html	Fri Jul 05 10:36:19 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.UI.UserInterface.html	Sat Jul 06 17:17:07 2024 +0200
@@ -206,10 +206,18 @@
 <td>Private slot to check some actions for their enable/disable status.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__checkCrashSessionExists">__checkCrashSessionExists</a></td>
+<td>Private method to check for the existence of crash session files and select the one to open.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__chmViewer">__chmViewer</a></td>
 <td>Private slot to start the win help viewer to show *.chm files.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__cleanCrashSessions">__cleanCrashSessions</a></td>
+<td>Private slot to clean all stale crash sessions.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__clearPrivateData">__clearPrivateData</a></td>
 <td>Private slot to clear the private data lists.</td>
 </tr>
@@ -246,6 +254,10 @@
 <td>Private method to generated version information and copy that to the clipboard.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__crashSessionFilePath">__crashSessionFilePath</a></td>
+<td>Private method to generate a path name for a unique crash session file.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
 <td>Private method to create a dock window with common properties.</td>
 </tr>
@@ -314,6 +326,10 @@
 <td>Private slot to export the current theme to a file.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__getCrashedSessions">__getCrashedSessions</a></td>
+<td>Private method to get a list of crash session file paths of crashed sessions.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td>
 <td>Private method to get the geometry of a floating windows.</td>
 </tr>
@@ -410,6 +426,10 @@
 <td>Private slot to start the Qt-Linguist executable.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__loadCrashSession">__loadCrashSession</a></td>
+<td>Private slot to load a crash session.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__loadSessionFromFile">__loadSessionFromFile</a></td>
 <td>Private slot to load a session from disk.</td>
 </tr>
@@ -1360,6 +1380,27 @@
 editor window
 </dd>
 </dl>
+<a NAME="UserInterface.__checkCrashSessionExists" ID="UserInterface.__checkCrashSessionExists"></a>
+<h4>UserInterface.__checkCrashSessionExists</h4>
+<b>__checkCrashSessionExists</b>(<i></i>)
+<p>
+        Private method to check for the existence of crash session files and
+        select the one to open.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+file path of the crash session file to open. An empty string indicates
+            that no crash session file should be opened or exists.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
 <h4>UserInterface.__chmViewer</h4>
 <b>__chmViewer</b>(<i>home=None</i>)
@@ -1374,6 +1415,13 @@
 full pathname of a file to display
 </dd>
 </dl>
+<a NAME="UserInterface.__cleanCrashSessions" ID="UserInterface.__cleanCrashSessions"></a>
+<h4>UserInterface.__cleanCrashSessions</h4>
+<b>__cleanCrashSessions</b>(<i></i>)
+<p>
+        Private slot to clean all stale crash sessions.
+</p>
+
 <a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a>
 <h4>UserInterface.__clearPrivateData</h4>
 <b>__clearPrivateData</b>(<i></i>)
@@ -1465,6 +1513,33 @@
         Private method to generated version information and copy that to the clipboard.
 </p>
 
+<a NAME="UserInterface.__crashSessionFilePath" ID="UserInterface.__crashSessionFilePath"></a>
+<h4>UserInterface.__crashSessionFilePath</h4>
+<b>__crashSessionFilePath</b>(<i>globPattern=False</i>)
+<p>
+        Private method to generate a path name for a unique crash session file.
+</p>
+
+<dl>
+
+<dt><i>globPattern</i> (bool (optional))</dt>
+<dd>
+flag indicating to get the glob pattern for crash
+            session files (defaults to False)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+crash session file path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
 <h4>UserInterface.__createDockWindow</h4>
 <b>__createDockWindow</b>(<i>name</i>)
@@ -1638,6 +1713,28 @@
         Private slot to export the current theme to a file.
 </p>
 
+<a NAME="UserInterface.__getCrashedSessions" ID="UserInterface.__getCrashedSessions"></a>
+<h4>UserInterface.__getCrashedSessions</h4>
+<b>__getCrashedSessions</b>(<i></i>)
+<p>
+        Private method to get a list of crash session file paths of crashed sessions.
+</p>
+<p>
+        Note: Crashed sessions are those, whose PID does not exist anymore.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of crashed session file paths
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a>
 <h4>UserInterface.__getFloatingGeometry</h4>
 <b>__getFloatingGeometry</b>(<i>w</i>)
@@ -1893,6 +1990,13 @@
 filename of the translation file to be opened
 </dd>
 </dl>
+<a NAME="UserInterface.__loadCrashSession" ID="UserInterface.__loadCrashSession"></a>
+<h4>UserInterface.__loadCrashSession</h4>
+<b>__loadCrashSession</b>(<i></i>)
+<p>
+        Private slot to load a crash session.
+</p>
+
 <a NAME="UserInterface.__loadSessionFromFile" ID="UserInterface.__loadSessionFromFile"></a>
 <h4>UserInterface.__loadSessionFromFile</h4>
 <b>__loadSessionFromFile</b>(<i></i>)
@@ -2863,7 +2967,7 @@
 
 <a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a>
 <h4>UserInterface.__writeSession</h4>
-<b>__writeSession</b>(<i>filename="", crashSession=False</i>)
+<b>__writeSession</b>(<i>filename=""</i>)
 <p>
         Private slot to write the session data to a JSON file (.esj).
 </p>
@@ -2874,10 +2978,6 @@
 <dd>
 name of a session file to write
 </dd>
-<dt><i>crashSession</i> (bool)</dt>
-<dd>
-flag indicating to write a crash session file
-</dd>
 </dl>
 <dl>
 <dt>Return:</dt>

eric ide

mercurial