Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Session.SessionManager.html

src/eric7/Documentation/Source/eric7.WebBrowser.Session.SessionManager.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
child 10679
4d3e0ce54322
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Session.SessionManager</h1> 9 <h1>eric7.WebBrowser.Session.SessionManager</h1>
10
11 <p> 10 <p>
12 Module implementing the session manager. 11 Module implementing the session manager.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SessionManager">SessionManager</a></td> 22 <td><a href="#SessionManager">SessionManager</a></td>
25 <td>Class implementing the session manager.</td> 23 <td>Class implementing the session manager.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#SessionMetaData">SessionMetaData</a></td> 26 <td><a href="#SessionMetaData">SessionMetaData</a></td>
29 <td>Class implementing a data structure to store meta data for a session.</td> 27 <td>Class implementing a data structure to store meta data for a session.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33
34 <table> 32 <table>
35 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
36 </table> 34 </table>
35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="SessionManager" ID="SessionManager"></a> 38 <a NAME="SessionManager" ID="SessionManager"></a>
40 <h2>SessionManager</h2> 39 <h2>SessionManager</h2>
41
42 <p> 40 <p>
43 Class implementing the session manager. 41 Class implementing the session manager.
44 </p> 42 </p>
43
45 <h3>Signals</h3> 44 <h3>Signals</h3>
46 <dl> 45 <dl>
47 46
48 <dt>sessionsMetaDataChanged()</dt> 47 <dt>sessionsMetaDataChanged()</dt>
49 <dd> 48 <dd>
52 </dd> 51 </dd>
53 </dl> 52 </dl>
54 <h3>Derived from</h3> 53 <h3>Derived from</h3>
55 QObject 54 QObject
56 <h3>Class Attributes</h3> 55 <h3>Class Attributes</h3>
57 56 <table>
58 <table> 57 <tr><td>CloneSession</td></tr>
59 <tr><td>CloneSession</td></tr><tr><td>ReplaceSession</td></tr><tr><td>RestoreSession</td></tr><tr><td>SwitchSession</td></tr> 58 <tr><td>ReplaceSession</td></tr>
60 </table> 59 <tr><td>RestoreSession</td></tr>
60 <tr><td>SwitchSession</td></tr>
61 </table>
62
61 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
62 64 <table>
63 <table>
64
65 <tr> 65 <tr>
66 <td><a href="#SessionManager.isValidSession">isValidSession</a></td> 66 <td><a href="#SessionManager.isValidSession">isValidSession</a></td>
67 <td>Class method to check the validity of a session.</td> 67 <td>Class method to check the validity of a session.</td>
68 </tr> 68 </tr>
69 <tr> 69 <tr>
73 <tr> 73 <tr>
74 <td><a href="#SessionManager.restoreSessionFromData">restoreSessionFromData</a></td> 74 <td><a href="#SessionManager.restoreSessionFromData">restoreSessionFromData</a></td>
75 <td>Class method to restore a session from a session data dictionary.</td> 75 <td>Class method to restore a session from a session data dictionary.</td>
76 </tr> 76 </tr>
77 </table> 77 </table>
78
78 <h3>Methods</h3> 79 <h3>Methods</h3>
79 80 <table>
80 <table>
81
82 <tr> 81 <tr>
83 <td><a href="#SessionManager.__init__">SessionManager</a></td> 82 <td><a href="#SessionManager.__init__">SessionManager</a></td>
84 <td>Constructor</td> 83 <td>Constructor</td>
85 </tr> 84 </tr>
86 <tr> 85 <tr>
190 <tr> 189 <tr>
191 <td><a href="#SessionManager.writeCurrentSession">writeCurrentSession</a></td> 190 <td><a href="#SessionManager.writeCurrentSession">writeCurrentSession</a></td>
192 <td>Public method to write the current session to the given file name.</td> 191 <td>Public method to write the current session to the given file name.</td>
193 </tr> 192 </tr>
194 </table> 193 </table>
194
195 <h3>Static Methods</h3> 195 <h3>Static Methods</h3>
196
197 <table> 196 <table>
198 <tr><td>None</td></tr> 197 <tr><td>None</td></tr>
199 </table> 198 </table>
199
200 200
201 <a NAME="SessionManager.isValidSession" ID="SessionManager.isValidSession"></a> 201 <a NAME="SessionManager.isValidSession" ID="SessionManager.isValidSession"></a>
202 <h4>SessionManager.isValidSession (class method)</h4> 202 <h4>SessionManager.isValidSession (class method)</h4>
203 <b>isValidSession</b>(<i>session</i>) 203 <b>isValidSession</b>(<i>session</i>)
204
205 <p> 204 <p>
206 Class method to check the validity of a session. 205 Class method to check the validity of a session.
207 </p> 206 </p>
207
208 <dl> 208 <dl>
209 209
210 <dt><i>session</i> (dict)</dt> 210 <dt><i>session</i> (dict)</dt>
211 <dd> 211 <dd>
212 dictionary containing the session data 212 dictionary containing the session data
225 </dd> 225 </dd>
226 </dl> 226 </dl>
227 <a NAME="SessionManager.readSessionFromFile" ID="SessionManager.readSessionFromFile"></a> 227 <a NAME="SessionManager.readSessionFromFile" ID="SessionManager.readSessionFromFile"></a>
228 <h4>SessionManager.readSessionFromFile (class method)</h4> 228 <h4>SessionManager.readSessionFromFile (class method)</h4>
229 <b>readSessionFromFile</b>(<i>sessionFileName</i>) 229 <b>readSessionFromFile</b>(<i>sessionFileName</i>)
230
231 <p> 230 <p>
232 Class method to read the session data from a file. 231 Class method to read the session data from a file.
233 </p> 232 </p>
233
234 <dl> 234 <dl>
235 235
236 <dt><i>sessionFileName</i> (str)</dt> 236 <dt><i>sessionFileName</i> (str)</dt>
237 <dd> 237 <dd>
238 file name of the session file 238 file name of the session file
251 </dd> 251 </dd>
252 </dl> 252 </dl>
253 <a NAME="SessionManager.restoreSessionFromData" ID="SessionManager.restoreSessionFromData"></a> 253 <a NAME="SessionManager.restoreSessionFromData" ID="SessionManager.restoreSessionFromData"></a>
254 <h4>SessionManager.restoreSessionFromData (class method)</h4> 254 <h4>SessionManager.restoreSessionFromData (class method)</h4>
255 <b>restoreSessionFromData</b>(<i>window=None, sessionData=None</i>) 255 <b>restoreSessionFromData</b>(<i>window=None, sessionData=None</i>)
256
257 <p> 256 <p>
258 Class method to restore a session from a session data dictionary. 257 Class method to restore a session from a session data dictionary.
259 </p> 258 </p>
259
260 <dl> 260 <dl>
261 261
262 <dt><i>window</i> (WebBrowserWindow)</dt> 262 <dt><i>window</i> (WebBrowserWindow)</dt>
263 <dd> 263 <dd>
264 reference to main window to restore to 264 reference to main window to restore to
269 </dd> 269 </dd>
270 </dl> 270 </dl>
271 <a NAME="SessionManager.__init__" ID="SessionManager.__init__"></a> 271 <a NAME="SessionManager.__init__" ID="SessionManager.__init__"></a>
272 <h4>SessionManager (Constructor)</h4> 272 <h4>SessionManager (Constructor)</h4>
273 <b>SessionManager</b>(<i>parent=None</i>) 273 <b>SessionManager</b>(<i>parent=None</i>)
274
275 <p> 274 <p>
276 Constructor 275 Constructor
277 </p> 276 </p>
277
278 <dl> 278 <dl>
279 279
280 <dt><i>parent</i> (QObject)</dt> 280 <dt><i>parent</i> (QObject)</dt>
281 <dd> 281 <dd>
282 reference to the parent object 282 reference to the parent object
283 </dd> 283 </dd>
284 </dl> 284 </dl>
285 <a NAME="SessionManager.__autoSaveSession" ID="SessionManager.__autoSaveSession"></a> 285 <a NAME="SessionManager.__autoSaveSession" ID="SessionManager.__autoSaveSession"></a>
286 <h4>SessionManager.__autoSaveSession</h4> 286 <h4>SessionManager.__autoSaveSession</h4>
287 <b>__autoSaveSession</b>(<i>startTimer=True</i>) 287 <b>__autoSaveSession</b>(<i>startTimer=True</i>)
288
289 <p> 288 <p>
290 Private slot to save the current session state. 289 Private slot to save the current session state.
291 </p> 290 </p>
291
292 <dl> 292 <dl>
293 293
294 <dt><i>startTimer</i> (bool)</dt> 294 <dt><i>startTimer</i> (bool)</dt>
295 <dd> 295 <dd>
296 flag indicating to restart the timer 296 flag indicating to restart the timer
297 </dd> 297 </dd>
298 </dl> 298 </dl>
299 <a NAME="SessionManager.__backupSavedSession" ID="SessionManager.__backupSavedSession"></a> 299 <a NAME="SessionManager.__backupSavedSession" ID="SessionManager.__backupSavedSession"></a>
300 <h4>SessionManager.__backupSavedSession</h4> 300 <h4>SessionManager.__backupSavedSession</h4>
301 <b>__backupSavedSession</b>(<i></i>) 301 <b>__backupSavedSession</b>(<i></i>)
302
303 <p> 302 <p>
304 Private method to backup the most recently saved session. 303 Private method to backup the most recently saved session.
305 </p> 304 </p>
305
306 <a NAME="SessionManager.__fillMetaDataList" ID="SessionManager.__fillMetaDataList"></a> 306 <a NAME="SessionManager.__fillMetaDataList" ID="SessionManager.__fillMetaDataList"></a>
307 <h4>SessionManager.__fillMetaDataList</h4> 307 <h4>SessionManager.__fillMetaDataList</h4>
308 <b>__fillMetaDataList</b>(<i></i>) 308 <b>__fillMetaDataList</b>(<i></i>)
309
310 <p> 309 <p>
311 Private method to fill the sessions meta data list. 310 Private method to fill the sessions meta data list.
312 </p> 311 </p>
313 <p> 312 <p>
314 The sessions meta data list is only populated, if the variable holding 313 The sessions meta data list is only populated, if the variable holding
315 it is empty (i.e. it is populated on demand). 314 it is empty (i.e. it is populated on demand).
316 </p> 315 </p>
316
317 <a NAME="SessionManager.__initSessionSaveTimer" ID="SessionManager.__initSessionSaveTimer"></a> 317 <a NAME="SessionManager.__initSessionSaveTimer" ID="SessionManager.__initSessionSaveTimer"></a>
318 <h4>SessionManager.__initSessionSaveTimer</h4> 318 <h4>SessionManager.__initSessionSaveTimer</h4>
319 <b>__initSessionSaveTimer</b>(<i></i>) 319 <b>__initSessionSaveTimer</b>(<i></i>)
320
321 <p> 320 <p>
322 Private slot to initialize the auto save timer. 321 Private slot to initialize the auto save timer.
323 </p> 322 </p>
323
324 <a NAME="SessionManager.__isActive" ID="SessionManager.__isActive"></a> 324 <a NAME="SessionManager.__isActive" ID="SessionManager.__isActive"></a>
325 <h4>SessionManager.__isActive</h4> 325 <h4>SessionManager.__isActive</h4>
326 <b>__isActive</b>(<i>filePath</i>) 326 <b>__isActive</b>(<i>filePath</i>)
327
328 <p> 327 <p>
329 Private method to check, if a given file is the active one. 328 Private method to check, if a given file is the active one.
330 </p> 329 </p>
330
331 <dl> 331 <dl>
332 332
333 <dt><i>filePath</i> (str or pathlib.Path)</dt> 333 <dt><i>filePath</i> (str or pathlib.Path)</dt>
334 <dd> 334 <dd>
335 path of the session file to be checked 335 path of the session file to be checked
348 </dd> 348 </dd>
349 </dl> 349 </dl>
350 <a NAME="SessionManager.__sessionActTriggered" ID="SessionManager.__sessionActTriggered"></a> 350 <a NAME="SessionManager.__sessionActTriggered" ID="SessionManager.__sessionActTriggered"></a>
351 <h4>SessionManager.__sessionActTriggered</h4> 351 <h4>SessionManager.__sessionActTriggered</h4>
352 <b>__sessionActTriggered</b>(<i>act</i>) 352 <b>__sessionActTriggered</b>(<i>act</i>)
353
354 <p> 353 <p>
355 Private slot to handle the menu selection of a session. 354 Private slot to handle the menu selection of a session.
356 </p> 355 </p>
356
357 <dl> 357 <dl>
358 358
359 <dt><i>act</i> (QAction)</dt> 359 <dt><i>act</i> (QAction)</dt>
360 <dd> 360 <dd>
361 reference to the action that triggered 361 reference to the action that triggered
362 </dd> 362 </dd>
363 </dl> 363 </dl>
364 <a NAME="SessionManager.__sessionDirectoryChanged" ID="SessionManager.__sessionDirectoryChanged"></a> 364 <a NAME="SessionManager.__sessionDirectoryChanged" ID="SessionManager.__sessionDirectoryChanged"></a>
365 <h4>SessionManager.__sessionDirectoryChanged</h4> 365 <h4>SessionManager.__sessionDirectoryChanged</h4>
366 <b>__sessionDirectoryChanged</b>(<i></i>) 366 <b>__sessionDirectoryChanged</b>(<i></i>)
367
368 <p> 367 <p>
369 Private slot handling changes of the sessions directory. 368 Private slot handling changes of the sessions directory.
370 </p> 369 </p>
370
371 <a NAME="SessionManager.aboutToShowSessionsMenu" ID="SessionManager.aboutToShowSessionsMenu"></a> 371 <a NAME="SessionManager.aboutToShowSessionsMenu" ID="SessionManager.aboutToShowSessionsMenu"></a>
372 <h4>SessionManager.aboutToShowSessionsMenu</h4> 372 <h4>SessionManager.aboutToShowSessionsMenu</h4>
373 <b>aboutToShowSessionsMenu</b>(<i>menu</i>) 373 <b>aboutToShowSessionsMenu</b>(<i>menu</i>)
374
375 <p> 374 <p>
376 Public slot to populate the sessions selection menu. 375 Public slot to populate the sessions selection menu.
377 </p> 376 </p>
377
378 <dl> 378 <dl>
379 379
380 <dt><i>menu</i> (QMenu)</dt> 380 <dt><i>menu</i> (QMenu)</dt>
381 <dd> 381 <dd>
382 reference to the menu about to be shown 382 reference to the menu about to be shown
383 </dd> 383 </dd>
384 </dl> 384 </dl>
385 <a NAME="SessionManager.activateTimer" ID="SessionManager.activateTimer"></a> 385 <a NAME="SessionManager.activateTimer" ID="SessionManager.activateTimer"></a>
386 <h4>SessionManager.activateTimer</h4> 386 <h4>SessionManager.activateTimer</h4>
387 <b>activateTimer</b>(<i></i>) 387 <b>activateTimer</b>(<i></i>)
388
389 <p> 388 <p>
390 Public method to activate the session save timer. 389 Public method to activate the session save timer.
391 </p> 390 </p>
391
392 <a NAME="SessionManager.autoSaveSession" ID="SessionManager.autoSaveSession"></a> 392 <a NAME="SessionManager.autoSaveSession" ID="SessionManager.autoSaveSession"></a>
393 <h4>SessionManager.autoSaveSession</h4> 393 <h4>SessionManager.autoSaveSession</h4>
394 <b>autoSaveSession</b>(<i></i>) 394 <b>autoSaveSession</b>(<i></i>)
395
396 <p> 395 <p>
397 Public method to save the current session state. 396 Public method to save the current session state.
398 </p> 397 </p>
398
399 <a NAME="SessionManager.cloneSession" ID="SessionManager.cloneSession"></a> 399 <a NAME="SessionManager.cloneSession" ID="SessionManager.cloneSession"></a>
400 <h4>SessionManager.cloneSession</h4> 400 <h4>SessionManager.cloneSession</h4>
401 <b>cloneSession</b>(<i>sessionFilePath</i>) 401 <b>cloneSession</b>(<i>sessionFilePath</i>)
402
403 <p> 402 <p>
404 Public method to clone a session. 403 Public method to clone a session.
405 </p> 404 </p>
405
406 <dl> 406 <dl>
407 407
408 <dt><i>sessionFilePath</i> (str)</dt> 408 <dt><i>sessionFilePath</i> (str)</dt>
409 <dd> 409 <dd>
410 file name of the session file to be cloned 410 file name of the session file to be cloned
411 </dd> 411 </dd>
412 </dl> 412 </dl>
413 <a NAME="SessionManager.defaultSessionFile" ID="SessionManager.defaultSessionFile"></a> 413 <a NAME="SessionManager.defaultSessionFile" ID="SessionManager.defaultSessionFile"></a>
414 <h4>SessionManager.defaultSessionFile</h4> 414 <h4>SessionManager.defaultSessionFile</h4>
415 <b>defaultSessionFile</b>(<i></i>) 415 <b>defaultSessionFile</b>(<i></i>)
416
417 <p> 416 <p>
418 Public method to get the name of the default session file. 417 Public method to get the name of the default session file.
419 </p> 418 </p>
419
420 <dl> 420 <dl>
421 <dt>Return:</dt> 421 <dt>Return:</dt>
422 <dd> 422 <dd>
423 name of the default session file 423 name of the default session file
424 </dd> 424 </dd>
430 </dd> 430 </dd>
431 </dl> 431 </dl>
432 <a NAME="SessionManager.deleteSession" ID="SessionManager.deleteSession"></a> 432 <a NAME="SessionManager.deleteSession" ID="SessionManager.deleteSession"></a>
433 <h4>SessionManager.deleteSession</h4> 433 <h4>SessionManager.deleteSession</h4>
434 <b>deleteSession</b>(<i>sessionFilePath</i>) 434 <b>deleteSession</b>(<i>sessionFilePath</i>)
435
436 <p> 435 <p>
437 Public method to delete a session. 436 Public method to delete a session.
438 </p> 437 </p>
438
439 <dl> 439 <dl>
440 440
441 <dt><i>sessionFilePath</i> (str)</dt> 441 <dt><i>sessionFilePath</i> (str)</dt>
442 <dd> 442 <dd>
443 file name of the session file to be deleted 443 file name of the session file to be deleted
444 </dd> 444 </dd>
445 </dl> 445 </dl>
446 <a NAME="SessionManager.getSessionsDirectory" ID="SessionManager.getSessionsDirectory"></a> 446 <a NAME="SessionManager.getSessionsDirectory" ID="SessionManager.getSessionsDirectory"></a>
447 <h4>SessionManager.getSessionsDirectory</h4> 447 <h4>SessionManager.getSessionsDirectory</h4>
448 <b>getSessionsDirectory</b>(<i></i>) 448 <b>getSessionsDirectory</b>(<i></i>)
449
450 <p> 449 <p>
451 Public method to get the directory sessions are stored in. 450 Public method to get the directory sessions are stored in.
452 </p> 451 </p>
452
453 <dl> 453 <dl>
454 <dt>Return:</dt> 454 <dt>Return:</dt>
455 <dd> 455 <dd>
456 name of the sessions directory 456 name of the sessions directory
457 </dd> 457 </dd>
463 </dd> 463 </dd>
464 </dl> 464 </dl>
465 <a NAME="SessionManager.lastActiveSessionFile" ID="SessionManager.lastActiveSessionFile"></a> 465 <a NAME="SessionManager.lastActiveSessionFile" ID="SessionManager.lastActiveSessionFile"></a>
466 <h4>SessionManager.lastActiveSessionFile</h4> 466 <h4>SessionManager.lastActiveSessionFile</h4>
467 <b>lastActiveSessionFile</b>(<i></i>) 467 <b>lastActiveSessionFile</b>(<i></i>)
468
469 <p> 468 <p>
470 Public method to get the name of the last active session file. 469 Public method to get the name of the last active session file.
471 </p> 470 </p>
471
472 <dl> 472 <dl>
473 <dt>Return:</dt> 473 <dt>Return:</dt>
474 <dd> 474 <dd>
475 name of the last active session file 475 name of the last active session file
476 </dd> 476 </dd>
482 </dd> 482 </dd>
483 </dl> 483 </dl>
484 <a NAME="SessionManager.newSession" ID="SessionManager.newSession"></a> 484 <a NAME="SessionManager.newSession" ID="SessionManager.newSession"></a>
485 <h4>SessionManager.newSession</h4> 485 <h4>SessionManager.newSession</h4>
486 <b>newSession</b>(<i></i>) 486 <b>newSession</b>(<i></i>)
487
488 <p> 487 <p>
489 Public method to start a new session. 488 Public method to start a new session.
490 </p> 489 </p>
490
491 <a NAME="SessionManager.openSession" ID="SessionManager.openSession"></a> 491 <a NAME="SessionManager.openSession" ID="SessionManager.openSession"></a>
492 <h4>SessionManager.openSession</h4> 492 <h4>SessionManager.openSession</h4>
493 <b>openSession</b>(<i>sessionFilePath, flags=0</i>) 493 <b>openSession</b>(<i>sessionFilePath, flags=0</i>)
494
495 <p> 494 <p>
496 Public method to open a session from a given session file. 495 Public method to open a session from a given session file.
497 </p> 496 </p>
497
498 <dl> 498 <dl>
499 499
500 <dt><i>sessionFilePath</i> (str)</dt> 500 <dt><i>sessionFilePath</i> (str)</dt>
501 <dd> 501 <dd>
502 name of the session file to get session from 502 name of the session file to get session from
507 </dd> 507 </dd>
508 </dl> 508 </dl>
509 <a NAME="SessionManager.preferencesChanged" ID="SessionManager.preferencesChanged"></a> 509 <a NAME="SessionManager.preferencesChanged" ID="SessionManager.preferencesChanged"></a>
510 <h4>SessionManager.preferencesChanged</h4> 510 <h4>SessionManager.preferencesChanged</h4>
511 <b>preferencesChanged</b>(<i></i>) 511 <b>preferencesChanged</b>(<i></i>)
512
513 <p> 512 <p>
514 Public slot to react upon changes of the settings. 513 Public slot to react upon changes of the settings.
515 </p> 514 </p>
515
516 <a NAME="SessionManager.renameSession" ID="SessionManager.renameSession"></a> 516 <a NAME="SessionManager.renameSession" ID="SessionManager.renameSession"></a>
517 <h4>SessionManager.renameSession</h4> 517 <h4>SessionManager.renameSession</h4>
518 <b>renameSession</b>(<i>sessionFilePath, flags=0</i>) 518 <b>renameSession</b>(<i>sessionFilePath, flags=0</i>)
519
520 <p> 519 <p>
521 Public method to rename or clone a session. 520 Public method to rename or clone a session.
522 </p> 521 </p>
522
523 <dl> 523 <dl>
524 524
525 <dt><i>sessionFilePath</i> (str)</dt> 525 <dt><i>sessionFilePath</i> (str)</dt>
526 <dd> 526 <dd>
527 name of the session file 527 name of the session file
532 </dd> 532 </dd>
533 </dl> 533 </dl>
534 <a NAME="SessionManager.replaceSession" ID="SessionManager.replaceSession"></a> 534 <a NAME="SessionManager.replaceSession" ID="SessionManager.replaceSession"></a>
535 <h4>SessionManager.replaceSession</h4> 535 <h4>SessionManager.replaceSession</h4>
536 <b>replaceSession</b>(<i>sessionFilePath</i>) 536 <b>replaceSession</b>(<i>sessionFilePath</i>)
537
538 <p> 537 <p>
539 Public method to replace the current session with the given one. 538 Public method to replace the current session with the given one.
540 </p> 539 </p>
540
541 <dl> 541 <dl>
542 542
543 <dt><i>sessionFilePath</i> (str)</dt> 543 <dt><i>sessionFilePath</i> (str)</dt>
544 <dd> 544 <dd>
545 file name of the session file to replace with 545 file name of the session file to replace with
558 </dd> 558 </dd>
559 </dl> 559 </dl>
560 <a NAME="SessionManager.saveSession" ID="SessionManager.saveSession"></a> 560 <a NAME="SessionManager.saveSession" ID="SessionManager.saveSession"></a>
561 <h4>SessionManager.saveSession</h4> 561 <h4>SessionManager.saveSession</h4>
562 <b>saveSession</b>(<i></i>) 562 <b>saveSession</b>(<i></i>)
563
564 <p> 563 <p>
565 Public method to save the current session. 564 Public method to save the current session.
566 </p> 565 </p>
566
567 <a NAME="SessionManager.selectSession" ID="SessionManager.selectSession"></a> 567 <a NAME="SessionManager.selectSession" ID="SessionManager.selectSession"></a>
568 <h4>SessionManager.selectSession</h4> 568 <h4>SessionManager.selectSession</h4>
569 <b>selectSession</b>(<i></i>) 569 <b>selectSession</b>(<i></i>)
570
571 <p> 570 <p>
572 Public method to select a session to be restored. 571 Public method to select a session to be restored.
573 </p> 572 </p>
573
574 <dl> 574 <dl>
575 <dt>Return:</dt> 575 <dt>Return:</dt>
576 <dd> 576 <dd>
577 name of the session file to be restored 577 name of the session file to be restored
578 </dd> 578 </dd>
584 </dd> 584 </dd>
585 </dl> 585 </dl>
586 <a NAME="SessionManager.sessionMetaData" ID="SessionManager.sessionMetaData"></a> 586 <a NAME="SessionManager.sessionMetaData" ID="SessionManager.sessionMetaData"></a>
587 <h4>SessionManager.sessionMetaData</h4> 587 <h4>SessionManager.sessionMetaData</h4>
588 <b>sessionMetaData</b>(<i>includeBackups=False</i>) 588 <b>sessionMetaData</b>(<i>includeBackups=False</i>)
589
590 <p> 589 <p>
591 Public method to get the sessions meta data. 590 Public method to get the sessions meta data.
592 </p> 591 </p>
592
593 <dl> 593 <dl>
594 594
595 <dt><i>includeBackups</i> (bool)</dt> 595 <dt><i>includeBackups</i> (bool)</dt>
596 <dd> 596 <dd>
597 flag indicating to include backup sessions 597 flag indicating to include backup sessions
610 </dd> 610 </dd>
611 </dl> 611 </dl>
612 <a NAME="SessionManager.showSessionManagerDialog" ID="SessionManager.showSessionManagerDialog"></a> 612 <a NAME="SessionManager.showSessionManagerDialog" ID="SessionManager.showSessionManagerDialog"></a>
613 <h4>SessionManager.showSessionManagerDialog</h4> 613 <h4>SessionManager.showSessionManagerDialog</h4>
614 <b>showSessionManagerDialog</b>(<i></i>) 614 <b>showSessionManagerDialog</b>(<i></i>)
615
616 <p> 615 <p>
617 Public method to show the session manager dialog. 616 Public method to show the session manager dialog.
618 </p> 617 </p>
618
619 <a NAME="SessionManager.shutdown" ID="SessionManager.shutdown"></a> 619 <a NAME="SessionManager.shutdown" ID="SessionManager.shutdown"></a>
620 <h4>SessionManager.shutdown</h4> 620 <h4>SessionManager.shutdown</h4>
621 <b>shutdown</b>(<i></i>) 621 <b>shutdown</b>(<i></i>)
622
623 <p> 622 <p>
624 Public method to perform any shutdown actions. 623 Public method to perform any shutdown actions.
625 </p> 624 </p>
625
626 <a NAME="SessionManager.switchToSession" ID="SessionManager.switchToSession"></a> 626 <a NAME="SessionManager.switchToSession" ID="SessionManager.switchToSession"></a>
627 <h4>SessionManager.switchToSession</h4> 627 <h4>SessionManager.switchToSession</h4>
628 <b>switchToSession</b>(<i>sessionFilePath</i>) 628 <b>switchToSession</b>(<i>sessionFilePath</i>)
629
630 <p> 629 <p>
631 Public method to switch the current session to the given one. 630 Public method to switch the current session to the given one.
632 </p> 631 </p>
632
633 <dl> 633 <dl>
634 634
635 <dt><i>sessionFilePath</i> (str)</dt> 635 <dt><i>sessionFilePath</i> (str)</dt>
636 <dd> 636 <dd>
637 file name of the session file to switch to 637 file name of the session file to switch to
650 </dd> 650 </dd>
651 </dl> 651 </dl>
652 <a NAME="SessionManager.writeCurrentSession" ID="SessionManager.writeCurrentSession"></a> 652 <a NAME="SessionManager.writeCurrentSession" ID="SessionManager.writeCurrentSession"></a>
653 <h4>SessionManager.writeCurrentSession</h4> 653 <h4>SessionManager.writeCurrentSession</h4>
654 <b>writeCurrentSession</b>(<i>sessionFileName</i>) 654 <b>writeCurrentSession</b>(<i>sessionFileName</i>)
655
656 <p> 655 <p>
657 Public method to write the current session to the given file name. 656 Public method to write the current session to the given file name.
658 </p> 657 </p>
658
659 <dl> 659 <dl>
660 660
661 <dt><i>sessionFileName</i> (str)</dt> 661 <dt><i>sessionFileName</i> (str)</dt>
662 <dd> 662 <dd>
663 file name of the session 663 file name of the session
666 <div align="right"><a href="#top">Up</a></div> 666 <div align="right"><a href="#top">Up</a></div>
667 <hr /> 667 <hr />
668 <hr /> 668 <hr />
669 <a NAME="SessionMetaData" ID="SessionMetaData"></a> 669 <a NAME="SessionMetaData" ID="SessionMetaData"></a>
670 <h2>SessionMetaData</h2> 670 <h2>SessionMetaData</h2>
671
672 <p> 671 <p>
673 Class implementing a data structure to store meta data for a session. 672 Class implementing a data structure to store meta data for a session.
674 </p> 673 </p>
674
675 <h3>Derived from</h3> 675 <h3>Derived from</h3>
676 None 676 None
677 <h3>Class Attributes</h3> 677 <h3>Class Attributes</h3>
678 678 <table>
679 <table> 679 <tr><td>filePath</td></tr>
680 <tr><td>filePath</td></tr><tr><td>isActive</td></tr><tr><td>isBackup</td></tr><tr><td>isDefault</td></tr><tr><td>name</td></tr> 680 <tr><td>isActive</td></tr>
681 </table> 681 <tr><td>isBackup</td></tr>
682 <tr><td>isDefault</td></tr>
683 <tr><td>name</td></tr>
684 </table>
685
682 <h3>Class Methods</h3> 686 <h3>Class Methods</h3>
683
684 <table> 687 <table>
685 <tr><td>None</td></tr> 688 <tr><td>None</td></tr>
686 </table> 689 </table>
690
687 <h3>Methods</h3> 691 <h3>Methods</h3>
688
689 <table> 692 <table>
690 <tr><td>None</td></tr> 693 <tr><td>None</td></tr>
691 </table> 694 </table>
695
692 <h3>Static Methods</h3> 696 <h3>Static Methods</h3>
693
694 <table> 697 <table>
695 <tr><td>None</td></tr> 698 <tr><td>None</td></tr>
696 </table> 699 </table>
700
697 701
698 <div align="right"><a href="#top">Up</a></div> 702 <div align="right"><a href="#top">Up</a></div>
699 <hr /> 703 <hr />
700 </body></html> 704 </body></html>

Mercurial Repository: eric

eric ide

mercurial