Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Session.SessionManager</h1> 23 <h1>eric6.WebBrowser.Session.SessionManager</h1>
24
23 <p> 25 <p>
24 Module implementing the session manager. 26 Module implementing the session manager.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#SessionManager">SessionManager</a></td> 38 <td><a href="#SessionManager">SessionManager</a></td>
34 <td>Class implementing the session manager.</td> 39 <td>Class implementing the session manager.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#SessionMetaData">SessionMetaData</a></td> 42 <td><a href="#SessionMetaData">SessionMetaData</a></td>
37 <td>Class implementing a data structure to store meta data for a session.</td> 43 <td>Class implementing a data structure to store meta data for a session.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
47
41 <table> 48 <table>
42 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="SessionManager" ID="SessionManager"></a> 53 <a NAME="SessionManager" ID="SessionManager"></a>
46 <h2>SessionManager</h2> 54 <h2>SessionManager</h2>
55
47 <p> 56 <p>
48 Class implementing the session manager. 57 Class implementing the session manager.
49 </p><h3>Signals</h3> 58 </p>
50 <dl> 59 <h3>Signals</h3>
60 <dl>
61
51 <dt>sessionsMetaDataChanged()</dt> 62 <dt>sessionsMetaDataChanged()</dt>
52 <dd> 63 <dd>
53 emitted to indicate a change of the 64 emitted to indicate a change of the
54 list of session meta data 65 list of session meta data
55 </dd> 66 </dd>
56 </dl> 67 </dl>
57 <h3>Derived from</h3> 68 <h3>Derived from</h3>
58 QObject 69 QObject
59 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
71
60 <table> 72 <table>
61 <tr><td>CloneSession</td></tr><tr><td>ReplaceSession</td></tr><tr><td>RestoreSession</td></tr><tr><td>SwitchSession</td></tr> 73 <tr><td>CloneSession</td></tr><tr><td>ReplaceSession</td></tr><tr><td>RestoreSession</td></tr><tr><td>SwitchSession</td></tr>
62 </table> 74 </table>
63 <h3>Class Methods</h3> 75 <h3>Class Methods</h3>
64 <table> 76
77 <table>
78
65 <tr> 79 <tr>
66 <td><a href="#SessionManager.isValidSession">isValidSession</a></td> 80 <td><a href="#SessionManager.isValidSession">isValidSession</a></td>
67 <td>Class method to check the validity of a session.</td> 81 <td>Class method to check the validity of a session.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#SessionManager.readSessionFromFile">readSessionFromFile</a></td> 84 <td><a href="#SessionManager.readSessionFromFile">readSessionFromFile</a></td>
70 <td>Class method to read the session data from a file.</td> 85 <td>Class method to read the session data from a file.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#SessionManager.restoreSessionFromData">restoreSessionFromData</a></td> 88 <td><a href="#SessionManager.restoreSessionFromData">restoreSessionFromData</a></td>
73 <td>Class method to restore a session from a session data dictionary.</td> 89 <td>Class method to restore a session from a session data dictionary.</td>
74 </tr> 90 </tr>
75 </table> 91 </table>
76 <h3>Methods</h3> 92 <h3>Methods</h3>
77 <table> 93
94 <table>
95
78 <tr> 96 <tr>
79 <td><a href="#SessionManager.__init__">SessionManager</a></td> 97 <td><a href="#SessionManager.__init__">SessionManager</a></td>
80 <td>Constructor</td> 98 <td>Constructor</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#SessionManager.__autoSaveSession">__autoSaveSession</a></td> 101 <td><a href="#SessionManager.__autoSaveSession">__autoSaveSession</a></td>
83 <td>Private slot to save the current session state.</td> 102 <td>Private slot to save the current session state.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#SessionManager.__backupSavedSession">__backupSavedSession</a></td> 105 <td><a href="#SessionManager.__backupSavedSession">__backupSavedSession</a></td>
86 <td>Private method to backup the most recently saved session.</td> 106 <td>Private method to backup the most recently saved session.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#SessionManager.__fillMetaDataList">__fillMetaDataList</a></td> 109 <td><a href="#SessionManager.__fillMetaDataList">__fillMetaDataList</a></td>
89 <td>Private method to fill the sessions meta data list.</td> 110 <td>Private method to fill the sessions meta data list.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#SessionManager.__initSessionSaveTimer">__initSessionSaveTimer</a></td> 113 <td><a href="#SessionManager.__initSessionSaveTimer">__initSessionSaveTimer</a></td>
92 <td>Private slot to initialize the auto save timer.</td> 114 <td>Private slot to initialize the auto save timer.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#SessionManager.__isActive">__isActive</a></td> 117 <td><a href="#SessionManager.__isActive">__isActive</a></td>
95 <td>Private method to check, if a given file is the active one.</td> 118 <td>Private method to check, if a given file is the active one.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#SessionManager.__sessionActTriggered">__sessionActTriggered</a></td> 121 <td><a href="#SessionManager.__sessionActTriggered">__sessionActTriggered</a></td>
98 <td>Private slot to handle the menu selection of a session.</td> 122 <td>Private slot to handle the menu selection of a session.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#SessionManager.__sessionDirectoryChanged">__sessionDirectoryChanged</a></td> 125 <td><a href="#SessionManager.__sessionDirectoryChanged">__sessionDirectoryChanged</a></td>
101 <td>Private slot handling changes of the sessions directory.</td> 126 <td>Private slot handling changes of the sessions directory.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#SessionManager.aboutToShowSessionsMenu">aboutToShowSessionsMenu</a></td> 129 <td><a href="#SessionManager.aboutToShowSessionsMenu">aboutToShowSessionsMenu</a></td>
104 <td>Public slot to populate the sessions selection menu.</td> 130 <td>Public slot to populate the sessions selection menu.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#SessionManager.activateTimer">activateTimer</a></td> 133 <td><a href="#SessionManager.activateTimer">activateTimer</a></td>
107 <td>Public method to activate the session save timer.</td> 134 <td>Public method to activate the session save timer.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#SessionManager.autoSaveSession">autoSaveSession</a></td> 137 <td><a href="#SessionManager.autoSaveSession">autoSaveSession</a></td>
110 <td>Public method to save the current session state.</td> 138 <td>Public method to save the current session state.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#SessionManager.cloneSession">cloneSession</a></td> 141 <td><a href="#SessionManager.cloneSession">cloneSession</a></td>
113 <td>Public method to clone a session.</td> 142 <td>Public method to clone a session.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#SessionManager.defaultSessionFile">defaultSessionFile</a></td> 145 <td><a href="#SessionManager.defaultSessionFile">defaultSessionFile</a></td>
116 <td>Public method to get the name of the default session file.</td> 146 <td>Public method to get the name of the default session file.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#SessionManager.deleteSession">deleteSession</a></td> 149 <td><a href="#SessionManager.deleteSession">deleteSession</a></td>
119 <td>Public method to delete a session.</td> 150 <td>Public method to delete a session.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#SessionManager.getSessionsDirectory">getSessionsDirectory</a></td> 153 <td><a href="#SessionManager.getSessionsDirectory">getSessionsDirectory</a></td>
122 <td>Public method to get the directory sessions are stored in.</td> 154 <td>Public method to get the directory sessions are stored in.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#SessionManager.lastActiveSessionFile">lastActiveSessionFile</a></td> 157 <td><a href="#SessionManager.lastActiveSessionFile">lastActiveSessionFile</a></td>
125 <td>Public method to get the name of the last active session file.</td> 158 <td>Public method to get the name of the last active session file.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#SessionManager.newSession">newSession</a></td> 161 <td><a href="#SessionManager.newSession">newSession</a></td>
128 <td>Public method to start a new session.</td> 162 <td>Public method to start a new session.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#SessionManager.openSession">openSession</a></td> 165 <td><a href="#SessionManager.openSession">openSession</a></td>
131 <td>Public method to open a session from a given session file.</td> 166 <td>Public method to open a session from a given session file.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#SessionManager.preferencesChanged">preferencesChanged</a></td> 169 <td><a href="#SessionManager.preferencesChanged">preferencesChanged</a></td>
134 <td>Public slot to react upon changes of the settings.</td> 170 <td>Public slot to react upon changes of the settings.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#SessionManager.renameSession">renameSession</a></td> 173 <td><a href="#SessionManager.renameSession">renameSession</a></td>
137 <td>Public method to rename or clone a session.</td> 174 <td>Public method to rename or clone a session.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#SessionManager.replaceSession">replaceSession</a></td> 177 <td><a href="#SessionManager.replaceSession">replaceSession</a></td>
140 <td>Public method to replace the current session with the given one.</td> 178 <td>Public method to replace the current session with the given one.</td>
141 </tr><tr> 179 </tr>
180 <tr>
142 <td><a href="#SessionManager.saveSession">saveSession</a></td> 181 <td><a href="#SessionManager.saveSession">saveSession</a></td>
143 <td>Public method to save the current session.</td> 182 <td>Public method to save the current session.</td>
144 </tr><tr> 183 </tr>
184 <tr>
145 <td><a href="#SessionManager.selectSession">selectSession</a></td> 185 <td><a href="#SessionManager.selectSession">selectSession</a></td>
146 <td>Public method to select a session to be restored.</td> 186 <td>Public method to select a session to be restored.</td>
147 </tr><tr> 187 </tr>
188 <tr>
148 <td><a href="#SessionManager.sessionMetaData">sessionMetaData</a></td> 189 <td><a href="#SessionManager.sessionMetaData">sessionMetaData</a></td>
149 <td>Public method to get the sessions meta data.</td> 190 <td>Public method to get the sessions meta data.</td>
150 </tr><tr> 191 </tr>
192 <tr>
151 <td><a href="#SessionManager.showSessionManagerDialog">showSessionManagerDialog</a></td> 193 <td><a href="#SessionManager.showSessionManagerDialog">showSessionManagerDialog</a></td>
152 <td>Public method to show the session manager dialog.</td> 194 <td>Public method to show the session manager dialog.</td>
153 </tr><tr> 195 </tr>
196 <tr>
154 <td><a href="#SessionManager.shutdown">shutdown</a></td> 197 <td><a href="#SessionManager.shutdown">shutdown</a></td>
155 <td>Public method to perform any shutdown actions.</td> 198 <td>Public method to perform any shutdown actions.</td>
156 </tr><tr> 199 </tr>
200 <tr>
157 <td><a href="#SessionManager.switchToSession">switchToSession</a></td> 201 <td><a href="#SessionManager.switchToSession">switchToSession</a></td>
158 <td>Public method to switch the current session to the given one.</td> 202 <td>Public method to switch the current session to the given one.</td>
159 </tr><tr> 203 </tr>
204 <tr>
160 <td><a href="#SessionManager.writeCurrentSession">writeCurrentSession</a></td> 205 <td><a href="#SessionManager.writeCurrentSession">writeCurrentSession</a></td>
161 <td>Public method to write the current session to the given file name.</td> 206 <td>Public method to write the current session to the given file name.</td>
162 </tr> 207 </tr>
163 </table> 208 </table>
164 <h3>Static Methods</h3> 209 <h3>Static Methods</h3>
210
165 <table> 211 <table>
166 <tr><td>None</td></tr> 212 <tr><td>None</td></tr>
167 </table> 213 </table>
214
168 <a NAME="SessionManager.isValidSession" ID="SessionManager.isValidSession"></a> 215 <a NAME="SessionManager.isValidSession" ID="SessionManager.isValidSession"></a>
169 <h4>SessionManager.isValidSession (class method)</h4> 216 <h4>SessionManager.isValidSession (class method)</h4>
170 <b>isValidSession</b>(<i>session</i>) 217 <b>isValidSession</b>(<i>session</i>)
218
171 <p> 219 <p>
172 Class method to check the validity of a session. 220 Class method to check the validity of a session.
173 </p><dl> 221 </p>
222 <dl>
223
174 <dt><i>session</i> (dict)</dt> 224 <dt><i>session</i> (dict)</dt>
175 <dd> 225 <dd>
176 dictionary containing the session data 226 dictionary containing the session data
177 </dd> 227 </dd>
178 </dl><dl> 228 </dl>
229 <dl>
179 <dt>Returns:</dt> 230 <dt>Returns:</dt>
180 <dd> 231 <dd>
181 flag indicating validity 232 flag indicating validity
182 </dd> 233 </dd>
183 </dl><dl> 234 </dl>
235 <dl>
184 <dt>Return Type:</dt> 236 <dt>Return Type:</dt>
185 <dd> 237 <dd>
186 bool 238 bool
187 </dd> 239 </dd>
188 </dl><a NAME="SessionManager.readSessionFromFile" ID="SessionManager.readSessionFromFile"></a> 240 </dl>
241 <a NAME="SessionManager.readSessionFromFile" ID="SessionManager.readSessionFromFile"></a>
189 <h4>SessionManager.readSessionFromFile (class method)</h4> 242 <h4>SessionManager.readSessionFromFile (class method)</h4>
190 <b>readSessionFromFile</b>(<i>sessionFileName</i>) 243 <b>readSessionFromFile</b>(<i>sessionFileName</i>)
244
191 <p> 245 <p>
192 Class method to read the session data from a file. 246 Class method to read the session data from a file.
193 </p><dl> 247 </p>
248 <dl>
249
194 <dt><i>sessionFileName</i> (str)</dt> 250 <dt><i>sessionFileName</i> (str)</dt>
195 <dd> 251 <dd>
196 file name of the session file 252 file name of the session file
197 </dd> 253 </dd>
198 </dl><dl> 254 </dl>
255 <dl>
199 <dt>Returns:</dt> 256 <dt>Returns:</dt>
200 <dd> 257 <dd>
201 dictionary containing the session data 258 dictionary containing the session data
202 </dd> 259 </dd>
203 </dl><dl> 260 </dl>
261 <dl>
204 <dt>Return Type:</dt> 262 <dt>Return Type:</dt>
205 <dd> 263 <dd>
206 dict 264 dict
207 </dd> 265 </dd>
208 </dl><a NAME="SessionManager.restoreSessionFromData" ID="SessionManager.restoreSessionFromData"></a> 266 </dl>
267 <a NAME="SessionManager.restoreSessionFromData" ID="SessionManager.restoreSessionFromData"></a>
209 <h4>SessionManager.restoreSessionFromData (class method)</h4> 268 <h4>SessionManager.restoreSessionFromData (class method)</h4>
210 <b>restoreSessionFromData</b>(<i>window=None, sessionData=None</i>) 269 <b>restoreSessionFromData</b>(<i>window=None, sessionData=None</i>)
270
211 <p> 271 <p>
212 Class method to restore a session from a session data dictionary. 272 Class method to restore a session from a session data dictionary.
213 </p><dl> 273 </p>
274 <dl>
275
214 <dt><i>window</i> (WebBrowserWindow)</dt> 276 <dt><i>window</i> (WebBrowserWindow)</dt>
215 <dd> 277 <dd>
216 reference to main window to restore to 278 reference to main window to restore to
217 </dd><dt><i>sessionData</i></dt> 279 </dd>
280 <dt><i>sessionData</i></dt>
218 <dd> 281 <dd>
219 dictionary containing the session data 282 dictionary containing the session data
220 </dd> 283 </dd>
221 </dl><a NAME="SessionManager.__init__" ID="SessionManager.__init__"></a> 284 </dl>
285 <a NAME="SessionManager.__init__" ID="SessionManager.__init__"></a>
222 <h4>SessionManager (Constructor)</h4> 286 <h4>SessionManager (Constructor)</h4>
223 <b>SessionManager</b>(<i>parent=None</i>) 287 <b>SessionManager</b>(<i>parent=None</i>)
288
224 <p> 289 <p>
225 Constructor 290 Constructor
226 </p><dl> 291 </p>
292 <dl>
293
227 <dt><i>parent</i> (QObject)</dt> 294 <dt><i>parent</i> (QObject)</dt>
228 <dd> 295 <dd>
229 reference to the parent object 296 reference to the parent object
230 </dd> 297 </dd>
231 </dl><a NAME="SessionManager.__autoSaveSession" ID="SessionManager.__autoSaveSession"></a> 298 </dl>
299 <a NAME="SessionManager.__autoSaveSession" ID="SessionManager.__autoSaveSession"></a>
232 <h4>SessionManager.__autoSaveSession</h4> 300 <h4>SessionManager.__autoSaveSession</h4>
233 <b>__autoSaveSession</b>(<i>startTimer=True</i>) 301 <b>__autoSaveSession</b>(<i>startTimer=True</i>)
302
234 <p> 303 <p>
235 Private slot to save the current session state. 304 Private slot to save the current session state.
236 </p><dl> 305 </p>
306 <dl>
307
237 <dt><i>startTimer</i> (bool)</dt> 308 <dt><i>startTimer</i> (bool)</dt>
238 <dd> 309 <dd>
239 flag indicating to restart the timer 310 flag indicating to restart the timer
240 </dd> 311 </dd>
241 </dl><a NAME="SessionManager.__backupSavedSession" ID="SessionManager.__backupSavedSession"></a> 312 </dl>
313 <a NAME="SessionManager.__backupSavedSession" ID="SessionManager.__backupSavedSession"></a>
242 <h4>SessionManager.__backupSavedSession</h4> 314 <h4>SessionManager.__backupSavedSession</h4>
243 <b>__backupSavedSession</b>(<i></i>) 315 <b>__backupSavedSession</b>(<i></i>)
316
244 <p> 317 <p>
245 Private method to backup the most recently saved session. 318 Private method to backup the most recently saved session.
246 </p><a NAME="SessionManager.__fillMetaDataList" ID="SessionManager.__fillMetaDataList"></a> 319 </p>
320 <a NAME="SessionManager.__fillMetaDataList" ID="SessionManager.__fillMetaDataList"></a>
247 <h4>SessionManager.__fillMetaDataList</h4> 321 <h4>SessionManager.__fillMetaDataList</h4>
248 <b>__fillMetaDataList</b>(<i></i>) 322 <b>__fillMetaDataList</b>(<i></i>)
323
249 <p> 324 <p>
250 Private method to fill the sessions meta data list. 325 Private method to fill the sessions meta data list.
251 </p><p> 326 </p>
327 <p>
252 The sessions meta data list is only populated, if the variable holding 328 The sessions meta data list is only populated, if the variable holding
253 it is empty (i.e. it is populated on demand). 329 it is empty (i.e. it is populated on demand).
254 </p><a NAME="SessionManager.__initSessionSaveTimer" ID="SessionManager.__initSessionSaveTimer"></a> 330 </p>
331 <a NAME="SessionManager.__initSessionSaveTimer" ID="SessionManager.__initSessionSaveTimer"></a>
255 <h4>SessionManager.__initSessionSaveTimer</h4> 332 <h4>SessionManager.__initSessionSaveTimer</h4>
256 <b>__initSessionSaveTimer</b>(<i></i>) 333 <b>__initSessionSaveTimer</b>(<i></i>)
334
257 <p> 335 <p>
258 Private slot to initialize the auto save timer. 336 Private slot to initialize the auto save timer.
259 </p><a NAME="SessionManager.__isActive" ID="SessionManager.__isActive"></a> 337 </p>
338 <a NAME="SessionManager.__isActive" ID="SessionManager.__isActive"></a>
260 <h4>SessionManager.__isActive</h4> 339 <h4>SessionManager.__isActive</h4>
261 <b>__isActive</b>(<i>filePath</i>) 340 <b>__isActive</b>(<i>filePath</i>)
341
262 <p> 342 <p>
263 Private method to check, if a given file is the active one. 343 Private method to check, if a given file is the active one.
264 </p><dl> 344 </p>
345 <dl>
346
265 <dt><i>filePath</i> (str or QFileInfo)</dt> 347 <dt><i>filePath</i> (str or QFileInfo)</dt>
266 <dd> 348 <dd>
267 path of the session file to be checked 349 path of the session file to be checked
268 </dd> 350 </dd>
269 </dl><dl> 351 </dl>
352 <dl>
270 <dt>Returns:</dt> 353 <dt>Returns:</dt>
271 <dd> 354 <dd>
272 flag indicating the active file 355 flag indicating the active file
273 </dd> 356 </dd>
274 </dl><dl> 357 </dl>
358 <dl>
275 <dt>Return Type:</dt> 359 <dt>Return Type:</dt>
276 <dd> 360 <dd>
277 bool 361 bool
278 </dd> 362 </dd>
279 </dl><a NAME="SessionManager.__sessionActTriggered" ID="SessionManager.__sessionActTriggered"></a> 363 </dl>
364 <a NAME="SessionManager.__sessionActTriggered" ID="SessionManager.__sessionActTriggered"></a>
280 <h4>SessionManager.__sessionActTriggered</h4> 365 <h4>SessionManager.__sessionActTriggered</h4>
281 <b>__sessionActTriggered</b>(<i>act</i>) 366 <b>__sessionActTriggered</b>(<i>act</i>)
367
282 <p> 368 <p>
283 Private slot to handle the menu selection of a session. 369 Private slot to handle the menu selection of a session.
284 </p><dl> 370 </p>
371 <dl>
372
285 <dt><i>act</i> (QAction)</dt> 373 <dt><i>act</i> (QAction)</dt>
286 <dd> 374 <dd>
287 reference to the action that triggered 375 reference to the action that triggered
288 </dd> 376 </dd>
289 </dl><a NAME="SessionManager.__sessionDirectoryChanged" ID="SessionManager.__sessionDirectoryChanged"></a> 377 </dl>
378 <a NAME="SessionManager.__sessionDirectoryChanged" ID="SessionManager.__sessionDirectoryChanged"></a>
290 <h4>SessionManager.__sessionDirectoryChanged</h4> 379 <h4>SessionManager.__sessionDirectoryChanged</h4>
291 <b>__sessionDirectoryChanged</b>(<i></i>) 380 <b>__sessionDirectoryChanged</b>(<i></i>)
381
292 <p> 382 <p>
293 Private slot handling changes of the sessions directory. 383 Private slot handling changes of the sessions directory.
294 </p><a NAME="SessionManager.aboutToShowSessionsMenu" ID="SessionManager.aboutToShowSessionsMenu"></a> 384 </p>
385 <a NAME="SessionManager.aboutToShowSessionsMenu" ID="SessionManager.aboutToShowSessionsMenu"></a>
295 <h4>SessionManager.aboutToShowSessionsMenu</h4> 386 <h4>SessionManager.aboutToShowSessionsMenu</h4>
296 <b>aboutToShowSessionsMenu</b>(<i>menu</i>) 387 <b>aboutToShowSessionsMenu</b>(<i>menu</i>)
388
297 <p> 389 <p>
298 Public slot to populate the sessions selection menu. 390 Public slot to populate the sessions selection menu.
299 </p><dl> 391 </p>
392 <dl>
393
300 <dt><i>menu</i> (QMenu)</dt> 394 <dt><i>menu</i> (QMenu)</dt>
301 <dd> 395 <dd>
302 reference to the menu about to be shown 396 reference to the menu about to be shown
303 </dd> 397 </dd>
304 </dl><a NAME="SessionManager.activateTimer" ID="SessionManager.activateTimer"></a> 398 </dl>
399 <a NAME="SessionManager.activateTimer" ID="SessionManager.activateTimer"></a>
305 <h4>SessionManager.activateTimer</h4> 400 <h4>SessionManager.activateTimer</h4>
306 <b>activateTimer</b>(<i></i>) 401 <b>activateTimer</b>(<i></i>)
402
307 <p> 403 <p>
308 Public method to activate the session save timer. 404 Public method to activate the session save timer.
309 </p><a NAME="SessionManager.autoSaveSession" ID="SessionManager.autoSaveSession"></a> 405 </p>
406 <a NAME="SessionManager.autoSaveSession" ID="SessionManager.autoSaveSession"></a>
310 <h4>SessionManager.autoSaveSession</h4> 407 <h4>SessionManager.autoSaveSession</h4>
311 <b>autoSaveSession</b>(<i></i>) 408 <b>autoSaveSession</b>(<i></i>)
409
312 <p> 410 <p>
313 Public method to save the current session state. 411 Public method to save the current session state.
314 </p><a NAME="SessionManager.cloneSession" ID="SessionManager.cloneSession"></a> 412 </p>
413 <a NAME="SessionManager.cloneSession" ID="SessionManager.cloneSession"></a>
315 <h4>SessionManager.cloneSession</h4> 414 <h4>SessionManager.cloneSession</h4>
316 <b>cloneSession</b>(<i>sessionFilePath</i>) 415 <b>cloneSession</b>(<i>sessionFilePath</i>)
416
317 <p> 417 <p>
318 Public method to clone a session. 418 Public method to clone a session.
319 </p><dl> 419 </p>
420 <dl>
421
320 <dt><i>sessionFilePath</i> (str)</dt> 422 <dt><i>sessionFilePath</i> (str)</dt>
321 <dd> 423 <dd>
322 file name of the session file to be cloned 424 file name of the session file to be cloned
323 </dd> 425 </dd>
324 </dl><a NAME="SessionManager.defaultSessionFile" ID="SessionManager.defaultSessionFile"></a> 426 </dl>
427 <a NAME="SessionManager.defaultSessionFile" ID="SessionManager.defaultSessionFile"></a>
325 <h4>SessionManager.defaultSessionFile</h4> 428 <h4>SessionManager.defaultSessionFile</h4>
326 <b>defaultSessionFile</b>(<i></i>) 429 <b>defaultSessionFile</b>(<i></i>)
430
327 <p> 431 <p>
328 Public method to get the name of the default session file. 432 Public method to get the name of the default session file.
329 </p><dl> 433 </p>
434 <dl>
330 <dt>Returns:</dt> 435 <dt>Returns:</dt>
331 <dd> 436 <dd>
332 name of the default session file 437 name of the default session file
333 </dd> 438 </dd>
334 </dl><dl> 439 </dl>
440 <dl>
335 <dt>Return Type:</dt> 441 <dt>Return Type:</dt>
336 <dd> 442 <dd>
337 str 443 str
338 </dd> 444 </dd>
339 </dl><a NAME="SessionManager.deleteSession" ID="SessionManager.deleteSession"></a> 445 </dl>
446 <a NAME="SessionManager.deleteSession" ID="SessionManager.deleteSession"></a>
340 <h4>SessionManager.deleteSession</h4> 447 <h4>SessionManager.deleteSession</h4>
341 <b>deleteSession</b>(<i>sessionFilePath</i>) 448 <b>deleteSession</b>(<i>sessionFilePath</i>)
449
342 <p> 450 <p>
343 Public method to delete a session. 451 Public method to delete a session.
344 </p><dl> 452 </p>
453 <dl>
454
345 <dt><i>sessionFilePath</i> (str)</dt> 455 <dt><i>sessionFilePath</i> (str)</dt>
346 <dd> 456 <dd>
347 file name of the session file to be deleted 457 file name of the session file to be deleted
348 </dd> 458 </dd>
349 </dl><a NAME="SessionManager.getSessionsDirectory" ID="SessionManager.getSessionsDirectory"></a> 459 </dl>
460 <a NAME="SessionManager.getSessionsDirectory" ID="SessionManager.getSessionsDirectory"></a>
350 <h4>SessionManager.getSessionsDirectory</h4> 461 <h4>SessionManager.getSessionsDirectory</h4>
351 <b>getSessionsDirectory</b>(<i></i>) 462 <b>getSessionsDirectory</b>(<i></i>)
463
352 <p> 464 <p>
353 Public method to get the directory sessions are stored in. 465 Public method to get the directory sessions are stored in.
354 </p><dl> 466 </p>
467 <dl>
355 <dt>Returns:</dt> 468 <dt>Returns:</dt>
356 <dd> 469 <dd>
357 name of the sessions directory 470 name of the sessions directory
358 </dd> 471 </dd>
359 </dl><dl> 472 </dl>
473 <dl>
360 <dt>Return Type:</dt> 474 <dt>Return Type:</dt>
361 <dd> 475 <dd>
362 str 476 str
363 </dd> 477 </dd>
364 </dl><a NAME="SessionManager.lastActiveSessionFile" ID="SessionManager.lastActiveSessionFile"></a> 478 </dl>
479 <a NAME="SessionManager.lastActiveSessionFile" ID="SessionManager.lastActiveSessionFile"></a>
365 <h4>SessionManager.lastActiveSessionFile</h4> 480 <h4>SessionManager.lastActiveSessionFile</h4>
366 <b>lastActiveSessionFile</b>(<i></i>) 481 <b>lastActiveSessionFile</b>(<i></i>)
482
367 <p> 483 <p>
368 Public method to get the name of the last active session file. 484 Public method to get the name of the last active session file.
369 </p><dl> 485 </p>
486 <dl>
370 <dt>Returns:</dt> 487 <dt>Returns:</dt>
371 <dd> 488 <dd>
372 name of the last active session file 489 name of the last active session file
373 </dd> 490 </dd>
374 </dl><dl> 491 </dl>
492 <dl>
375 <dt>Return Type:</dt> 493 <dt>Return Type:</dt>
376 <dd> 494 <dd>
377 str 495 str
378 </dd> 496 </dd>
379 </dl><a NAME="SessionManager.newSession" ID="SessionManager.newSession"></a> 497 </dl>
498 <a NAME="SessionManager.newSession" ID="SessionManager.newSession"></a>
380 <h4>SessionManager.newSession</h4> 499 <h4>SessionManager.newSession</h4>
381 <b>newSession</b>(<i></i>) 500 <b>newSession</b>(<i></i>)
501
382 <p> 502 <p>
383 Public method to start a new session. 503 Public method to start a new session.
384 </p><a NAME="SessionManager.openSession" ID="SessionManager.openSession"></a> 504 </p>
505 <a NAME="SessionManager.openSession" ID="SessionManager.openSession"></a>
385 <h4>SessionManager.openSession</h4> 506 <h4>SessionManager.openSession</h4>
386 <b>openSession</b>(<i>sessionFilePath, flags=0</i>) 507 <b>openSession</b>(<i>sessionFilePath, flags=0</i>)
508
387 <p> 509 <p>
388 Public method to open a session from a given session file. 510 Public method to open a session from a given session file.
389 </p><dl> 511 </p>
512 <dl>
513
390 <dt><i>sessionFilePath</i> (str)</dt> 514 <dt><i>sessionFilePath</i> (str)</dt>
391 <dd> 515 <dd>
392 name of the session file to get session from 516 name of the session file to get session from
393 </dd><dt><i>flags</i> (int)</dt> 517 </dd>
518 <dt><i>flags</i> (int)</dt>
394 <dd> 519 <dd>
395 flags determining the open mode 520 flags determining the open mode
396 </dd> 521 </dd>
397 </dl><a NAME="SessionManager.preferencesChanged" ID="SessionManager.preferencesChanged"></a> 522 </dl>
523 <a NAME="SessionManager.preferencesChanged" ID="SessionManager.preferencesChanged"></a>
398 <h4>SessionManager.preferencesChanged</h4> 524 <h4>SessionManager.preferencesChanged</h4>
399 <b>preferencesChanged</b>(<i></i>) 525 <b>preferencesChanged</b>(<i></i>)
526
400 <p> 527 <p>
401 Public slot to react upon changes of the settings. 528 Public slot to react upon changes of the settings.
402 </p><a NAME="SessionManager.renameSession" ID="SessionManager.renameSession"></a> 529 </p>
530 <a NAME="SessionManager.renameSession" ID="SessionManager.renameSession"></a>
403 <h4>SessionManager.renameSession</h4> 531 <h4>SessionManager.renameSession</h4>
404 <b>renameSession</b>(<i>sessionFilePath, flags=0</i>) 532 <b>renameSession</b>(<i>sessionFilePath, flags=0</i>)
533
405 <p> 534 <p>
406 Public method to rename or clone a session. 535 Public method to rename or clone a session.
407 </p><dl> 536 </p>
537 <dl>
538
408 <dt><i>sessionFilePath</i> (str)</dt> 539 <dt><i>sessionFilePath</i> (str)</dt>
409 <dd> 540 <dd>
410 name of the session file 541 name of the session file
411 </dd><dt><i>flags</i> (int)</dt> 542 </dd>
543 <dt><i>flags</i> (int)</dt>
412 <dd> 544 <dd>
413 flags determining a rename or clone operation 545 flags determining a rename or clone operation
414 </dd> 546 </dd>
415 </dl><a NAME="SessionManager.replaceSession" ID="SessionManager.replaceSession"></a> 547 </dl>
548 <a NAME="SessionManager.replaceSession" ID="SessionManager.replaceSession"></a>
416 <h4>SessionManager.replaceSession</h4> 549 <h4>SessionManager.replaceSession</h4>
417 <b>replaceSession</b>(<i>sessionFilePath</i>) 550 <b>replaceSession</b>(<i>sessionFilePath</i>)
551
418 <p> 552 <p>
419 Public method to replace the current session with the given one. 553 Public method to replace the current session with the given one.
420 </p><dl> 554 </p>
555 <dl>
556
421 <dt><i>sessionFilePath</i> (str)</dt> 557 <dt><i>sessionFilePath</i> (str)</dt>
422 <dd> 558 <dd>
423 file name of the session file to replace with 559 file name of the session file to replace with
424 </dd> 560 </dd>
425 </dl><dl> 561 </dl>
562 <dl>
426 <dt>Returns:</dt> 563 <dt>Returns:</dt>
427 <dd> 564 <dd>
428 flag indicating success 565 flag indicating success
429 </dd> 566 </dd>
430 </dl><dl> 567 </dl>
568 <dl>
431 <dt>Return Type:</dt> 569 <dt>Return Type:</dt>
432 <dd> 570 <dd>
433 bool 571 bool
434 </dd> 572 </dd>
435 </dl><a NAME="SessionManager.saveSession" ID="SessionManager.saveSession"></a> 573 </dl>
574 <a NAME="SessionManager.saveSession" ID="SessionManager.saveSession"></a>
436 <h4>SessionManager.saveSession</h4> 575 <h4>SessionManager.saveSession</h4>
437 <b>saveSession</b>(<i></i>) 576 <b>saveSession</b>(<i></i>)
577
438 <p> 578 <p>
439 Public method to save the current session. 579 Public method to save the current session.
440 </p><a NAME="SessionManager.selectSession" ID="SessionManager.selectSession"></a> 580 </p>
581 <a NAME="SessionManager.selectSession" ID="SessionManager.selectSession"></a>
441 <h4>SessionManager.selectSession</h4> 582 <h4>SessionManager.selectSession</h4>
442 <b>selectSession</b>(<i></i>) 583 <b>selectSession</b>(<i></i>)
584
443 <p> 585 <p>
444 Public method to select a session to be restored. 586 Public method to select a session to be restored.
445 </p><dl> 587 </p>
588 <dl>
446 <dt>Returns:</dt> 589 <dt>Returns:</dt>
447 <dd> 590 <dd>
448 name of the session file to be restored 591 name of the session file to be restored
449 </dd> 592 </dd>
450 </dl><dl> 593 </dl>
594 <dl>
451 <dt>Return Type:</dt> 595 <dt>Return Type:</dt>
452 <dd> 596 <dd>
453 str 597 str
454 </dd> 598 </dd>
455 </dl><a NAME="SessionManager.sessionMetaData" ID="SessionManager.sessionMetaData"></a> 599 </dl>
600 <a NAME="SessionManager.sessionMetaData" ID="SessionManager.sessionMetaData"></a>
456 <h4>SessionManager.sessionMetaData</h4> 601 <h4>SessionManager.sessionMetaData</h4>
457 <b>sessionMetaData</b>(<i>includeBackups=False</i>) 602 <b>sessionMetaData</b>(<i>includeBackups=False</i>)
603
458 <p> 604 <p>
459 Public method to get the sessions meta data. 605 Public method to get the sessions meta data.
460 </p><dl> 606 </p>
607 <dl>
608
461 <dt><i>includeBackups</i> (bool)</dt> 609 <dt><i>includeBackups</i> (bool)</dt>
462 <dd> 610 <dd>
463 flag indicating to include backup sessions 611 flag indicating to include backup sessions
464 </dd> 612 </dd>
465 </dl><dl> 613 </dl>
614 <dl>
466 <dt>Returns:</dt> 615 <dt>Returns:</dt>
467 <dd> 616 <dd>
468 list of session meta data 617 list of session meta data
469 </dd> 618 </dd>
470 </dl><dl> 619 </dl>
620 <dl>
471 <dt>Return Type:</dt> 621 <dt>Return Type:</dt>
472 <dd> 622 <dd>
473 list of SessionMetaData 623 list of SessionMetaData
474 </dd> 624 </dd>
475 </dl><a NAME="SessionManager.showSessionManagerDialog" ID="SessionManager.showSessionManagerDialog"></a> 625 </dl>
626 <a NAME="SessionManager.showSessionManagerDialog" ID="SessionManager.showSessionManagerDialog"></a>
476 <h4>SessionManager.showSessionManagerDialog</h4> 627 <h4>SessionManager.showSessionManagerDialog</h4>
477 <b>showSessionManagerDialog</b>(<i></i>) 628 <b>showSessionManagerDialog</b>(<i></i>)
629
478 <p> 630 <p>
479 Public method to show the session manager dialog. 631 Public method to show the session manager dialog.
480 </p><a NAME="SessionManager.shutdown" ID="SessionManager.shutdown"></a> 632 </p>
633 <a NAME="SessionManager.shutdown" ID="SessionManager.shutdown"></a>
481 <h4>SessionManager.shutdown</h4> 634 <h4>SessionManager.shutdown</h4>
482 <b>shutdown</b>(<i></i>) 635 <b>shutdown</b>(<i></i>)
636
483 <p> 637 <p>
484 Public method to perform any shutdown actions. 638 Public method to perform any shutdown actions.
485 </p><a NAME="SessionManager.switchToSession" ID="SessionManager.switchToSession"></a> 639 </p>
640 <a NAME="SessionManager.switchToSession" ID="SessionManager.switchToSession"></a>
486 <h4>SessionManager.switchToSession</h4> 641 <h4>SessionManager.switchToSession</h4>
487 <b>switchToSession</b>(<i>sessionFilePath</i>) 642 <b>switchToSession</b>(<i>sessionFilePath</i>)
643
488 <p> 644 <p>
489 Public method to switch the current session to the given one. 645 Public method to switch the current session to the given one.
490 </p><dl> 646 </p>
647 <dl>
648
491 <dt><i>sessionFilePath</i> (str)</dt> 649 <dt><i>sessionFilePath</i> (str)</dt>
492 <dd> 650 <dd>
493 file name of the session file to switch to 651 file name of the session file to switch to
494 </dd> 652 </dd>
495 </dl><dl> 653 </dl>
654 <dl>
496 <dt>Returns:</dt> 655 <dt>Returns:</dt>
497 <dd> 656 <dd>
498 flag indicating success 657 flag indicating success
499 </dd> 658 </dd>
500 </dl><dl> 659 </dl>
660 <dl>
501 <dt>Return Type:</dt> 661 <dt>Return Type:</dt>
502 <dd> 662 <dd>
503 bool 663 bool
504 </dd> 664 </dd>
505 </dl><a NAME="SessionManager.writeCurrentSession" ID="SessionManager.writeCurrentSession"></a> 665 </dl>
666 <a NAME="SessionManager.writeCurrentSession" ID="SessionManager.writeCurrentSession"></a>
506 <h4>SessionManager.writeCurrentSession</h4> 667 <h4>SessionManager.writeCurrentSession</h4>
507 <b>writeCurrentSession</b>(<i>sessionFileName</i>) 668 <b>writeCurrentSession</b>(<i>sessionFileName</i>)
669
508 <p> 670 <p>
509 Public method to write the current session to the given file name. 671 Public method to write the current session to the given file name.
510 </p><dl> 672 </p>
673 <dl>
674
511 <dt><i>sessionFileName</i> (str)</dt> 675 <dt><i>sessionFileName</i> (str)</dt>
512 <dd> 676 <dd>
513 file name of the session 677 file name of the session
514 </dd> 678 </dd>
515 </dl> 679 </dl>
516 <div align="right"><a href="#top">Up</a></div> 680 <div align="right"><a href="#top">Up</a></div>
517 <hr /><hr /> 681 <hr />
682 <hr />
518 <a NAME="SessionMetaData" ID="SessionMetaData"></a> 683 <a NAME="SessionMetaData" ID="SessionMetaData"></a>
519 <h2>SessionMetaData</h2> 684 <h2>SessionMetaData</h2>
685
520 <p> 686 <p>
521 Class implementing a data structure to store meta data for a session. 687 Class implementing a data structure to store meta data for a session.
522 </p> 688 </p>
523 <h3>Derived from</h3> 689 <h3>Derived from</h3>
524 object 690 object
525 <h3>Class Attributes</h3> 691 <h3>Class Attributes</h3>
692
526 <table> 693 <table>
527 <tr><td>None</td></tr> 694 <tr><td>None</td></tr>
528 </table> 695 </table>
529 <h3>Class Methods</h3> 696 <h3>Class Methods</h3>
697
530 <table> 698 <table>
531 <tr><td>None</td></tr> 699 <tr><td>None</td></tr>
532 </table> 700 </table>
533 <h3>Methods</h3> 701 <h3>Methods</h3>
534 <table> 702
703 <table>
704
535 <tr> 705 <tr>
536 <td><a href="#SessionMetaData.__init__">SessionMetaData</a></td> 706 <td><a href="#SessionMetaData.__init__">SessionMetaData</a></td>
537 <td>Constructor</td> 707 <td>Constructor</td>
538 </tr> 708 </tr>
539 </table> 709 </table>
540 <h3>Static Methods</h3> 710 <h3>Static Methods</h3>
711
541 <table> 712 <table>
542 <tr><td>None</td></tr> 713 <tr><td>None</td></tr>
543 </table> 714 </table>
715
544 <a NAME="SessionMetaData.__init__" ID="SessionMetaData.__init__"></a> 716 <a NAME="SessionMetaData.__init__" ID="SessionMetaData.__init__"></a>
545 <h4>SessionMetaData (Constructor)</h4> 717 <h4>SessionMetaData (Constructor)</h4>
546 <b>SessionMetaData</b>(<i></i>) 718 <b>SessionMetaData</b>(<i></i>)
719
547 <p> 720 <p>
548 Constructor 721 Constructor
549 </p> 722 </p>
550 <div align="right"><a href="#top">Up</a></div> 723 <div align="right"><a href="#top">Up</a></div>
551 <hr /> 724 <hr />

Mercurial Repository: eric

eric ide

mercurial