Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.WebBrowser.Session.SessionManager.html

Documentation/Source/eric6.WebBrowser.Session.SessionManager.html

changeset 5788
b01d2c1e0973
child 6123
39cd368143db
equal deleted inserted replaced
5787:0a83583316c2 5788:b01d2c1e0973
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.Session.SessionManager</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Session.SessionManager</h1>
23 <p>
24 Module implementing the session manager.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SessionManager">SessionManager</a></td>
34 <td>Class implementing the session manager.</td>
35 </tr><tr>
36 <td><a href="#SessionMetaData">SessionMetaData</a></td>
37 <td>Class implementing a data structure to store meta data for a session.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="SessionManager" ID="SessionManager"></a>
46 <h2>SessionManager</h2>
47 <p>
48 Class implementing the session manager.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>sessionsMetaDataChanged()</dt>
52 <dd>
53 emitted to indicate a change of the
54 list of session meta data
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QObject
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>CloneSession</td></tr><tr><td>ReplaceSession</td></tr><tr><td>RestoreSession</td></tr><tr><td>SwitchSession</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#SessionManager.isValidSession">isValidSession</a></td>
67 <td>Class method to check the validity of a session.</td>
68 </tr><tr>
69 <td><a href="#SessionManager.readSessionFromFile">readSessionFromFile</a></td>
70 <td>Class method to read the session data from a file.</td>
71 </tr><tr>
72 <td><a href="#SessionManager.restoreSessionFromData">restoreSessionFromData</a></td>
73 <td>Class method to restore a session from a session data dictionary.</td>
74 </tr>
75 </table>
76 <h3>Methods</h3>
77 <table>
78 <tr>
79 <td><a href="#SessionManager.__init__">SessionManager</a></td>
80 <td>Constructor</td>
81 </tr><tr>
82 <td><a href="#SessionManager.__autoSaveSession">__autoSaveSession</a></td>
83 <td>Private slot to save the current session state.</td>
84 </tr><tr>
85 <td><a href="#SessionManager.__backupSavedSession">__backupSavedSession</a></td>
86 <td>Private method to backup the most recently saved session.</td>
87 </tr><tr>
88 <td><a href="#SessionManager.__fillMetaDataList">__fillMetaDataList</a></td>
89 <td>Private method to fill the sessions meta data list.</td>
90 </tr><tr>
91 <td><a href="#SessionManager.__initSessionSaveTimer">__initSessionSaveTimer</a></td>
92 <td>Private slot to initialize the auto save timer.</td>
93 </tr><tr>
94 <td><a href="#SessionManager.__isActive">__isActive</a></td>
95 <td>Private method to check, if a given file is the active one.</td>
96 </tr><tr>
97 <td><a href="#SessionManager.__sessionActTriggered">__sessionActTriggered</a></td>
98 <td>Private slot to handle the menu selection of a session.</td>
99 </tr><tr>
100 <td><a href="#SessionManager.__sessionDirectoryChanged">__sessionDirectoryChanged</a></td>
101 <td>Private slot handling changes of the sessions directory.</td>
102 </tr><tr>
103 <td><a href="#SessionManager.aboutToShowSessionsMenu">aboutToShowSessionsMenu</a></td>
104 <td>Public slot to populate the sessions selection menu.</td>
105 </tr><tr>
106 <td><a href="#SessionManager.activateTimer">activateTimer</a></td>
107 <td>Public method to activate the session save timer.</td>
108 </tr><tr>
109 <td><a href="#SessionManager.autoSaveSession">autoSaveSession</a></td>
110 <td>Public method to save the current session state.</td>
111 </tr><tr>
112 <td><a href="#SessionManager.cloneSession">cloneSession</a></td>
113 <td>Public method to clone a session.</td>
114 </tr><tr>
115 <td><a href="#SessionManager.defaultSessionFile">defaultSessionFile</a></td>
116 <td>Public method to get the name of the default session file.</td>
117 </tr><tr>
118 <td><a href="#SessionManager.deleteSession">deleteSession</a></td>
119 <td>Public method to delete a session.</td>
120 </tr><tr>
121 <td><a href="#SessionManager.getSessionsDirectory">getSessionsDirectory</a></td>
122 <td>Public method to get the directory sessions are stored in.</td>
123 </tr><tr>
124 <td><a href="#SessionManager.lastActiveSessionFile">lastActiveSessionFile</a></td>
125 <td>Public method to get the name of the last active session file.</td>
126 </tr><tr>
127 <td><a href="#SessionManager.newSession">newSession</a></td>
128 <td>Public method to start a new session.</td>
129 </tr><tr>
130 <td><a href="#SessionManager.openSession">openSession</a></td>
131 <td>Public method to open a session from a given session file.</td>
132 </tr><tr>
133 <td><a href="#SessionManager.preferencesChanged">preferencesChanged</a></td>
134 <td>Public slot to react upon changes of the settings.</td>
135 </tr><tr>
136 <td><a href="#SessionManager.renameSession">renameSession</a></td>
137 <td>Public method to rename or clone a session.</td>
138 </tr><tr>
139 <td><a href="#SessionManager.replaceSession">replaceSession</a></td>
140 <td>Public method to replace the current session with the given one.</td>
141 </tr><tr>
142 <td><a href="#SessionManager.saveSession">saveSession</a></td>
143 <td>Public method to save the current session.</td>
144 </tr><tr>
145 <td><a href="#SessionManager.selectSession">selectSession</a></td>
146 <td>Public method to select a session to be restored.</td>
147 </tr><tr>
148 <td><a href="#SessionManager.sessionMetaData">sessionMetaData</a></td>
149 <td>Public method to get the sessions meta data.</td>
150 </tr><tr>
151 <td><a href="#SessionManager.showSessionManagerDialog">showSessionManagerDialog</a></td>
152 <td>Public method to show the session manager dialog.</td>
153 </tr><tr>
154 <td><a href="#SessionManager.shutdown">shutdown</a></td>
155 <td>Public method to perform any shutdown actions.</td>
156 </tr><tr>
157 <td><a href="#SessionManager.switchToSession">switchToSession</a></td>
158 <td>Public method to switch the current session to the given one.</td>
159 </tr><tr>
160 <td><a href="#SessionManager.writeCurrentSession">writeCurrentSession</a></td>
161 <td>Public method to write the current session to the given file name.</td>
162 </tr>
163 </table>
164 <h3>Static Methods</h3>
165 <table>
166 <tr><td>None</td></tr>
167 </table>
168 <a NAME="SessionManager.isValidSession" ID="SessionManager.isValidSession"></a>
169 <h4>SessionManager.isValidSession (class method)</h4>
170 <b>isValidSession</b>(<i>session</i>)
171 <p>
172 Class method to check the validity of a session.
173 </p><dl>
174 <dt><i>session</i> (dict)</dt>
175 <dd>
176 dictionary containing the session data
177 </dd>
178 </dl><dl>
179 <dt>Returns:</dt>
180 <dd>
181 flag indicating validity
182 </dd>
183 </dl><dl>
184 <dt>Return Type:</dt>
185 <dd>
186 bool
187 </dd>
188 </dl><a NAME="SessionManager.readSessionFromFile" ID="SessionManager.readSessionFromFile"></a>
189 <h4>SessionManager.readSessionFromFile (class method)</h4>
190 <b>readSessionFromFile</b>(<i>sessionFileName</i>)
191 <p>
192 Class method to read the session data from a file.
193 </p><dl>
194 <dt><i>sessionFileName</i> (str)</dt>
195 <dd>
196 file name of the session file
197 </dd>
198 </dl><dl>
199 <dt>Returns:</dt>
200 <dd>
201 dictionary containing the session data
202 </dd>
203 </dl><dl>
204 <dt>Return Type:</dt>
205 <dd>
206 dict
207 </dd>
208 </dl><a NAME="SessionManager.restoreSessionFromData" ID="SessionManager.restoreSessionFromData"></a>
209 <h4>SessionManager.restoreSessionFromData (class method)</h4>
210 <b>restoreSessionFromData</b>(<i>window=None, sessionData=None</i>)
211 <p>
212 Class method to restore a session from a session data dictionary.
213 </p><dl>
214 <dt><i>window</i> (WebBrowserWindow)</dt>
215 <dd>
216 reference to main window to restore to
217 </dd><dt><i>sessionData</i></dt>
218 <dd>
219 dictionary containing the session data
220 </dd>
221 </dl><a NAME="SessionManager.__init__" ID="SessionManager.__init__"></a>
222 <h4>SessionManager (Constructor)</h4>
223 <b>SessionManager</b>(<i>parent=None</i>)
224 <p>
225 Constructor
226 </p><dl>
227 <dt><i>parent</i> (QObject)</dt>
228 <dd>
229 reference to the parent object
230 </dd>
231 </dl><a NAME="SessionManager.__autoSaveSession" ID="SessionManager.__autoSaveSession"></a>
232 <h4>SessionManager.__autoSaveSession</h4>
233 <b>__autoSaveSession</b>(<i>startTimer=True</i>)
234 <p>
235 Private slot to save the current session state.
236 </p><dl>
237 <dt><i>startTimer</i> (bool)</dt>
238 <dd>
239 flag indicating to restart the timer
240 </dd>
241 </dl><a NAME="SessionManager.__backupSavedSession" ID="SessionManager.__backupSavedSession"></a>
242 <h4>SessionManager.__backupSavedSession</h4>
243 <b>__backupSavedSession</b>(<i></i>)
244 <p>
245 Private method to backup the most recently saved session.
246 </p><a NAME="SessionManager.__fillMetaDataList" ID="SessionManager.__fillMetaDataList"></a>
247 <h4>SessionManager.__fillMetaDataList</h4>
248 <b>__fillMetaDataList</b>(<i></i>)
249 <p>
250 Private method to fill the sessions meta data list.
251 </p><p>
252 The sessions meta data list is only populated, if the variable holding
253 it is empty (i.e. it is populated on demand).
254 </p><a NAME="SessionManager.__initSessionSaveTimer" ID="SessionManager.__initSessionSaveTimer"></a>
255 <h4>SessionManager.__initSessionSaveTimer</h4>
256 <b>__initSessionSaveTimer</b>(<i></i>)
257 <p>
258 Private slot to initialize the auto save timer.
259 </p><a NAME="SessionManager.__isActive" ID="SessionManager.__isActive"></a>
260 <h4>SessionManager.__isActive</h4>
261 <b>__isActive</b>(<i>filePath</i>)
262 <p>
263 Private method to check, if a given file is the active one.
264 </p><dl>
265 <dt><i>filePath</i> (str or QFileInfo)</dt>
266 <dd>
267 path of the session file to be checked
268 </dd>
269 </dl><dl>
270 <dt>Returns:</dt>
271 <dd>
272 flag indicating the active file
273 </dd>
274 </dl><dl>
275 <dt>Return Type:</dt>
276 <dd>
277 bool
278 </dd>
279 </dl><a NAME="SessionManager.__sessionActTriggered" ID="SessionManager.__sessionActTriggered"></a>
280 <h4>SessionManager.__sessionActTriggered</h4>
281 <b>__sessionActTriggered</b>(<i></i>)
282 <p>
283 Private slot to handle the menu selection of a session.
284 </p><a NAME="SessionManager.__sessionDirectoryChanged" ID="SessionManager.__sessionDirectoryChanged"></a>
285 <h4>SessionManager.__sessionDirectoryChanged</h4>
286 <b>__sessionDirectoryChanged</b>(<i></i>)
287 <p>
288 Private slot handling changes of the sessions directory.
289 </p><a NAME="SessionManager.aboutToShowSessionsMenu" ID="SessionManager.aboutToShowSessionsMenu"></a>
290 <h4>SessionManager.aboutToShowSessionsMenu</h4>
291 <b>aboutToShowSessionsMenu</b>(<i></i>)
292 <p>
293 Public slot to populate the sessions selection menu.
294 </p><a NAME="SessionManager.activateTimer" ID="SessionManager.activateTimer"></a>
295 <h4>SessionManager.activateTimer</h4>
296 <b>activateTimer</b>(<i></i>)
297 <p>
298 Public method to activate the session save timer.
299 </p><a NAME="SessionManager.autoSaveSession" ID="SessionManager.autoSaveSession"></a>
300 <h4>SessionManager.autoSaveSession</h4>
301 <b>autoSaveSession</b>(<i></i>)
302 <p>
303 Public method to save the current session state.
304 </p><a NAME="SessionManager.cloneSession" ID="SessionManager.cloneSession"></a>
305 <h4>SessionManager.cloneSession</h4>
306 <b>cloneSession</b>(<i>sessionFilePath</i>)
307 <p>
308 Public method to clone a session.
309 </p><dl>
310 <dt><i>sessionFilePath</i> (str)</dt>
311 <dd>
312 file name of the session file to be cloned
313 </dd>
314 </dl><a NAME="SessionManager.defaultSessionFile" ID="SessionManager.defaultSessionFile"></a>
315 <h4>SessionManager.defaultSessionFile</h4>
316 <b>defaultSessionFile</b>(<i></i>)
317 <p>
318 Public method to get the name of the default session file.
319 </p><dl>
320 <dt>Returns:</dt>
321 <dd>
322 name of the default session file
323 </dd>
324 </dl><dl>
325 <dt>Return Type:</dt>
326 <dd>
327 str
328 </dd>
329 </dl><a NAME="SessionManager.deleteSession" ID="SessionManager.deleteSession"></a>
330 <h4>SessionManager.deleteSession</h4>
331 <b>deleteSession</b>(<i>sessionFilePath</i>)
332 <p>
333 Public method to delete a session.
334 </p><dl>
335 <dt><i>sessionFilePath</i> (str)</dt>
336 <dd>
337 file name of the session file to be deleted
338 </dd>
339 </dl><a NAME="SessionManager.getSessionsDirectory" ID="SessionManager.getSessionsDirectory"></a>
340 <h4>SessionManager.getSessionsDirectory</h4>
341 <b>getSessionsDirectory</b>(<i></i>)
342 <p>
343 Public method to get the directory sessions are stored in.
344 </p><dl>
345 <dt>Returns:</dt>
346 <dd>
347 name of the sessions directory
348 </dd>
349 </dl><dl>
350 <dt>Return Type:</dt>
351 <dd>
352 str
353 </dd>
354 </dl><a NAME="SessionManager.lastActiveSessionFile" ID="SessionManager.lastActiveSessionFile"></a>
355 <h4>SessionManager.lastActiveSessionFile</h4>
356 <b>lastActiveSessionFile</b>(<i></i>)
357 <p>
358 Public method to get the name of the last active session file.
359 </p><dl>
360 <dt>Returns:</dt>
361 <dd>
362 name of the last active session file
363 </dd>
364 </dl><dl>
365 <dt>Return Type:</dt>
366 <dd>
367 str
368 </dd>
369 </dl><a NAME="SessionManager.newSession" ID="SessionManager.newSession"></a>
370 <h4>SessionManager.newSession</h4>
371 <b>newSession</b>(<i></i>)
372 <p>
373 Public method to start a new session.
374 </p><a NAME="SessionManager.openSession" ID="SessionManager.openSession"></a>
375 <h4>SessionManager.openSession</h4>
376 <b>openSession</b>(<i>sessionFilePath, flags=0</i>)
377 <p>
378 Public method to open a session from a given session file.
379 </p><dl>
380 <dt><i>sessionFilePath</i> (str)</dt>
381 <dd>
382 name of the session file to get session from
383 </dd><dt><i>flags</i> (int)</dt>
384 <dd>
385 flags determining the open mode
386 </dd>
387 </dl><a NAME="SessionManager.preferencesChanged" ID="SessionManager.preferencesChanged"></a>
388 <h4>SessionManager.preferencesChanged</h4>
389 <b>preferencesChanged</b>(<i></i>)
390 <p>
391 Public slot to react upon changes of the settings.
392 </p><a NAME="SessionManager.renameSession" ID="SessionManager.renameSession"></a>
393 <h4>SessionManager.renameSession</h4>
394 <b>renameSession</b>(<i>sessionFilePath, flags=0</i>)
395 <p>
396 Public method to rename or clone a session.
397 </p><dl>
398 <dt><i>sessionFilePath</i> (str)</dt>
399 <dd>
400 name of the session file
401 </dd><dt><i>flags</i> (int)</dt>
402 <dd>
403 flags determining a rename or clone operation
404 </dd>
405 </dl><a NAME="SessionManager.replaceSession" ID="SessionManager.replaceSession"></a>
406 <h4>SessionManager.replaceSession</h4>
407 <b>replaceSession</b>(<i>sessionFilePath</i>)
408 <p>
409 Public method to replace the current session with the given one.
410 </p><dl>
411 <dt><i>sessionFilePath</i> (str)</dt>
412 <dd>
413 file name of the session file to replace with
414 </dd>
415 </dl><dl>
416 <dt>Returns:</dt>
417 <dd>
418 flag indicating success
419 </dd>
420 </dl><dl>
421 <dt>Return Type:</dt>
422 <dd>
423 bool
424 </dd>
425 </dl><a NAME="SessionManager.saveSession" ID="SessionManager.saveSession"></a>
426 <h4>SessionManager.saveSession</h4>
427 <b>saveSession</b>(<i></i>)
428 <p>
429 Public method to save the current session.
430 </p><a NAME="SessionManager.selectSession" ID="SessionManager.selectSession"></a>
431 <h4>SessionManager.selectSession</h4>
432 <b>selectSession</b>(<i></i>)
433 <p>
434 Public method to select a session to be restored.
435 </p><dl>
436 <dt>Returns:</dt>
437 <dd>
438 name of the session file to be restored
439 </dd>
440 </dl><dl>
441 <dt>Return Type:</dt>
442 <dd>
443 str
444 </dd>
445 </dl><a NAME="SessionManager.sessionMetaData" ID="SessionManager.sessionMetaData"></a>
446 <h4>SessionManager.sessionMetaData</h4>
447 <b>sessionMetaData</b>(<i>includeBackups=False</i>)
448 <p>
449 Public method to get the sessions meta data.
450 </p><dl>
451 <dt><i>includeBackups</i> (bool)</dt>
452 <dd>
453 flag indicating to include backup sessions
454 </dd>
455 </dl><dl>
456 <dt>Returns:</dt>
457 <dd>
458 list of session meta data
459 </dd>
460 </dl><dl>
461 <dt>Return Type:</dt>
462 <dd>
463 list of SessionMetaData
464 </dd>
465 </dl><a NAME="SessionManager.showSessionManagerDialog" ID="SessionManager.showSessionManagerDialog"></a>
466 <h4>SessionManager.showSessionManagerDialog</h4>
467 <b>showSessionManagerDialog</b>(<i></i>)
468 <p>
469 Public method to show the session manager dialog.
470 </p><a NAME="SessionManager.shutdown" ID="SessionManager.shutdown"></a>
471 <h4>SessionManager.shutdown</h4>
472 <b>shutdown</b>(<i></i>)
473 <p>
474 Public method to perform any shutdown actions.
475 </p><a NAME="SessionManager.switchToSession" ID="SessionManager.switchToSession"></a>
476 <h4>SessionManager.switchToSession</h4>
477 <b>switchToSession</b>(<i>sessionFilePath</i>)
478 <p>
479 Public method to switch the current session to the given one.
480 </p><dl>
481 <dt><i>sessionFilePath</i> (str)</dt>
482 <dd>
483 file name of the session file to switch to
484 </dd>
485 </dl><dl>
486 <dt>Returns:</dt>
487 <dd>
488 flag indicating success
489 </dd>
490 </dl><dl>
491 <dt>Return Type:</dt>
492 <dd>
493 bool
494 </dd>
495 </dl><a NAME="SessionManager.writeCurrentSession" ID="SessionManager.writeCurrentSession"></a>
496 <h4>SessionManager.writeCurrentSession</h4>
497 <b>writeCurrentSession</b>(<i>sessionFileName</i>)
498 <p>
499 Public method to write the current session to the given file name.
500 </p><dl>
501 <dt><i>sessionFileName</i> (str)</dt>
502 <dd>
503 file name of the session
504 </dd>
505 </dl>
506 <div align="right"><a href="#top">Up</a></div>
507 <hr /><hr />
508 <a NAME="SessionMetaData" ID="SessionMetaData"></a>
509 <h2>SessionMetaData</h2>
510 <p>
511 Class implementing a data structure to store meta data for a session.
512 </p>
513 <h3>Derived from</h3>
514 object
515 <h3>Class Attributes</h3>
516 <table>
517 <tr><td>None</td></tr>
518 </table>
519 <h3>Class Methods</h3>
520 <table>
521 <tr><td>None</td></tr>
522 </table>
523 <h3>Methods</h3>
524 <table>
525 <tr>
526 <td><a href="#SessionMetaData.__init__">SessionMetaData</a></td>
527 <td>Constructor</td>
528 </tr>
529 </table>
530 <h3>Static Methods</h3>
531 <table>
532 <tr><td>None</td></tr>
533 </table>
534 <a NAME="SessionMetaData.__init__" ID="SessionMetaData.__init__"></a>
535 <h4>SessionMetaData (Constructor)</h4>
536 <b>SessionMetaData</b>(<i></i>)
537 <p>
538 Constructor
539 </p>
540 <div align="right"><a href="#top">Up</a></div>
541 <hr />
542 </body></html>

Mercurial Repository: eric

eric ide

mercurial