1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQSessionManager Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQSessionManager Class Reference</h1>
<p>The TQSessionManager class provides access to the session manager.
<a href="#details">More...</a>
<p><tt>#include <<a href="tqsessionmanager-h.html">tqsessionmanager.h</a>></tt>
<p>Inherits <a href="tqobject.html">TQObject</a>.
<p><a href="tqsessionmanager-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>TQString <a href="#sessionId"><b>sessionId</b></a> () const</li>
<li class=fn>TQString <a href="#sessionKey"><b>sessionKey</b></a> () const</li>
<li class=fn>void * <a href="#handle"><b>handle</b></a> () const</li>
<li class=fn>bool <a href="#allowsInteraction"><b>allowsInteraction</b></a> ()</li>
<li class=fn>bool <a href="#allowsErrorInteraction"><b>allowsErrorInteraction</b></a> ()</li>
<li class=fn>void <a href="#release"><b>release</b></a> ()</li>
<li class=fn>void <a href="#cancel"><b>cancel</b></a> ()</li>
<li class=fn>enum <a href="#RestartHint-enum"><b>RestartHint</b></a> { RestartIfRunning, RestartAnyway, RestartImmediately, RestartNever }</li>
<li class=fn>void <a href="#setRestartHint"><b>setRestartHint</b></a> ( RestartHint hint )</li>
<li class=fn>RestartHint <a href="#restartHint"><b>restartHint</b></a> () const</li>
<li class=fn>void <a href="#setRestartCommand"><b>setRestartCommand</b></a> ( const TQStringList & command )</li>
<li class=fn>TQStringList <a href="#restartCommand"><b>restartCommand</b></a> () const</li>
<li class=fn>void <a href="#setDiscardCommand"><b>setDiscardCommand</b></a> ( const TQStringList & )</li>
<li class=fn>TQStringList <a href="#discardCommand"><b>discardCommand</b></a> () const</li>
<li class=fn>void <a href="#setManagerProperty-2"><b>setManagerProperty</b></a> ( const TQString & name, const TQString & value )</li>
<li class=fn>void <a href="#setManagerProperty"><b>setManagerProperty</b></a> ( const TQString & name, const TQStringList & value )</li>
<li class=fn>bool <a href="#isPhase2"><b>isPhase2</b></a> () const</li>
<li class=fn>void <a href="#requestPhase2"><b>requestPhase2</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The TQSessionManager class provides access to the session manager.
<p>
<p> The session manager is responsible for session management, most
importantly for interruption and resumption. A "session" is a kind
of record of the state of the system, e.g. which applications were
run at start up and which applications are currently running. The
session manager is used to save the session, e.g. when the machine
is shut down; and to restore a session, e.g. when the machine is
started up. Use <a href="tqsettings.html">TQSettings</a> to save and restore an individual
application's settings, e.g. window positions, recently used files,
etc.
<p> TQSessionManager provides an interface between the application and
the session manager so that the program can work well with the
session manager. In TQt, session management requests for action
are handled by the two virtual functions <a href="ntqapplication.html#commitData">TQApplication::commitData</a>()
and <a href="ntqapplication.html#saveState">TQApplication::saveState</a>(). Both provide a reference to
a session manager object as argument, to allow the application
to communicate with the session manager.
<p> During a session management action (i.e. within commitData() and
saveState()), no user interaction is possible <em>unless</em> the
application got explicit permission from the session manager. You
ask for permission by calling <a href="#allowsInteraction">allowsInteraction</a>() or, if it's really
urgent, <a href="#allowsErrorInteraction">allowsErrorInteraction</a>(). TQt does not enforce this, but the
session manager may.
<p> You can try to abort the shutdown process by calling <a href="#cancel">cancel</a>(). The
default commitData() function does this if some top-level window
rejected its closeEvent().
<p> For sophisticated session managers provided on Unix/X11, TQSessionManager
offers further possibilites to fine-tune an application's session
management behavior: <a href="#setRestartCommand">setRestartCommand</a>(), <a href="#setDiscardCommand">setDiscardCommand</a>(),
<a href="#setRestartHint">setRestartHint</a>(), <a href="tqobject.html#setProperty">setProperty</a>(), <a href="#requestPhase2">requestPhase2</a>(). See the respective
function descriptions for further details.
<p>See also <a href="application.html">Main Window and Related Classes</a> and <a href="environment.html">Environment Classes</a>.
<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="RestartHint-enum"></a>TQSessionManager::RestartHint</h3>
<p> This enum type defines the circumstances under which this
application wants to be restarted by the session manager. The
current values are
<ul>
<li><tt>TQSessionManager::RestartIfRunning</tt> - if the application is still running when
the session is shut down, it wants to be restarted at the start of
the next session.
<li><tt>TQSessionManager::RestartAnyway</tt> - the application wants to be started at the
start of the next session, no matter what. (This is useful for
utilities that run just after startup and then quit.)
<li><tt>TQSessionManager::RestartImmediately</tt> - the application wants to be started
immediately whenever it is not running.
<li><tt>TQSessionManager::RestartNever</tt> - the application does not want to be restarted
automatically.
</ul><p> The default hint is <a href="#RestartHint-enum">RestartIfRunning</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn>bool <a name="allowsErrorInteraction"></a>TQSessionManager::allowsErrorInteraction ()
</h3>
<p> This is similar to <a href="#allowsInteraction">allowsInteraction</a>(), but also tells the session
manager that an error occurred. Session managers may give error
interaction request higher priority, which means that it is more likely
that an error interaction is permitted. However, you are still not
guaranteed that the session manager will allow interaction.
<p> <p>See also <a href="#allowsInteraction">allowsInteraction</a>(), <a href="#release">release</a>(), and <a href="#cancel">cancel</a>().
<h3 class=fn>bool <a name="allowsInteraction"></a>TQSessionManager::allowsInteraction ()
</h3>
<p> Asks the session manager for permission to interact with the
user. Returns TRUE if interaction is permitted; otherwise
returns FALSE.
<p> The rationale behind this mechanism is to make it possible to
synchronize user interaction during a shutdown. Advanced session
managers may ask all applications simultaneously to commit their
data, resulting in a much faster shutdown.
<p> When the interaction is completed we strongly recommend releasing the
user interaction semaphore with a call to <a href="#release">release</a>(). This way, other
applications may get the chance to interact with the user while your
application is still busy saving data. (The semaphore is implicitly
released when the application exits.)
<p> If the user decides to cancel the shutdown process during the
interaction phase, you must tell the session manager that this has
happened by calling <a href="#cancel">cancel</a>().
<p> Here's an example of how an application's <a href="ntqapplication.html#commitData">TQApplication::commitData</a>()
might be implemented:
<p> <pre>
void MyApplication::commitData( TQSessionManager& sm ) {
if ( sm.<a href="#allowsInteraction">allowsInteraction</a>() ) {
switch ( TQMessageBox::<a href="tqmessagebox.html#warning">warning</a>(
yourMainWindow,
<a href="tqobject.html#tr">tr</a>("Application Name"),
<a href="tqobject.html#tr">tr</a>("Save changes to document Foo?"),
<a href="tqobject.html#tr">tr</a>("&Yes"),
<a href="tqobject.html#tr">tr</a>("&No"),
<a href="tqobject.html#tr">tr</a>("Cancel"),
0, 2) ) {
case 0: // yes
sm.<a href="#release">release</a>();
// save document here; if saving fails, call sm.<a href="#cancel">cancel</a>()
break;
case 1: // continue without saving
break;
default: // cancel
sm.<a href="#cancel">cancel</a>();
break;
}
} else {
// we did not get permission to interact, then
// do something reasonable instead.
}
}
</pre>
<p> If an error occurred within the application while saving its data,
you may want to try <a href="#allowsErrorInteraction">allowsErrorInteraction</a>() instead.
<p> <p>See also <a href="ntqapplication.html#commitData">TQApplication::commitData</a>(), <a href="#release">release</a>(), and <a href="#cancel">cancel</a>().
<h3 class=fn>void <a name="cancel"></a>TQSessionManager::cancel ()
</h3>
<p> Tells the session manager to cancel the shutdown process. Applications
should not call this function without first asking the user.
<p> <p>See also <a href="#allowsInteraction">allowsInteraction</a>() and <a href="#allowsErrorInteraction">allowsErrorInteraction</a>().
<p>
<h3 class=fn><a href="tqstringlist.html">TQStringList</a> <a name="discardCommand"></a>TQSessionManager::discardCommand () const
</h3>
<p> Returns the currently set discard command.
<p> Note that if you want to iterate over the list, you should
iterate over a copy, e.g.
<pre>
<a href="tqstringlist.html">TQStringList</a> list = mySession.discardCommand();
TQStringList::Iterator it = list.<a href="tqvaluelist.html#begin">begin</a>();
while( it != list.<a href="tqvaluelist.html#end">end</a>() ) {
myProcessing( *it );
++it;
}
</pre>
<p> <p>See also <a href="#setDiscardCommand">setDiscardCommand</a>(), <a href="#restartCommand">restartCommand</a>(), and <a href="#setRestartCommand">setRestartCommand</a>().
<h3 class=fn>void * <a name="handle"></a>TQSessionManager::handle () const
</h3>
<p> X11 only: returns a handle to the current <tt>SmcConnection</tt>.
<h3 class=fn>bool <a name="isPhase2"></a>TQSessionManager::isPhase2 () const
</h3>
<p> Returns TRUE if the session manager is currently performing a second
session management phase; otherwise returns FALSE.
<p> <p>See also <a href="#requestPhase2">requestPhase2</a>().
<h3 class=fn>void <a name="release"></a>TQSessionManager::release ()
</h3>
<p> Releases the session manager's interaction semaphore after an
interaction phase.
<p> <p>See also <a href="#allowsInteraction">allowsInteraction</a>() and <a href="#allowsErrorInteraction">allowsErrorInteraction</a>().
<h3 class=fn>void <a name="requestPhase2"></a>TQSessionManager::requestPhase2 ()
</h3>
<p> Requests a second session management phase for the application. The
application may then return immediately from the
<a href="ntqapplication.html#commitData">TQApplication::commitData</a>() or <a href="ntqapplication.html#saveState">TQApplication::saveState</a>() function,
and they will be called again once most or all other applications have
finished their session management.
<p> The two phases are useful for applications such as the X11 window manager
that need to store information about another application's windows
and therefore have to wait until these applications have completed their
respective session management tasks.
<p> Note that if another application has requested a second phase it
may get called before, simultaneously with, or after your
application's second phase.
<p> <p>See also <a href="#isPhase2">isPhase2</a>().
<h3 class=fn><a href="tqstringlist.html">TQStringList</a> <a name="restartCommand"></a>TQSessionManager::restartCommand () const
</h3>
<p> Returns the currently set restart command.
<p> Note that if you want to iterate over the list, you should
iterate over a copy, e.g.
<pre>
<a href="tqstringlist.html">TQStringList</a> list = mySession.restartCommand();
TQStringList::Iterator it = list.<a href="tqvaluelist.html#begin">begin</a>();
while( it != list.<a href="tqvaluelist.html#end">end</a>() ) {
myProcessing( *it );
++it;
}
</pre>
<p> <p>See also <a href="#setRestartCommand">setRestartCommand</a>() and <a href="#restartHint">restartHint</a>().
<h3 class=fn><a href="tqsessionmanager.html#RestartHint-enum">RestartHint</a> <a name="restartHint"></a>TQSessionManager::restartHint () const
</h3>
<p> Returns the application's current restart hint. The default is
<a href="#RestartHint-enum">RestartIfRunning</a>.
<p> <p>See also <a href="#setRestartHint">setRestartHint</a>().
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="sessionId"></a>TQSessionManager::sessionId () const
</h3>
<p> Returns the identifier of the current session.
<p> If the application has been restored from an earlier session, this
identifier is the same as it was in that earlier session.
<p> <p>See also <a href="#sessionKey">sessionKey</a>() and <a href="ntqapplication.html#sessionId">TQApplication::sessionId</a>().
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="sessionKey"></a>TQSessionManager::sessionKey () const
</h3>
<p> Returns the session key in the current session.
<p> If the application has been restored from an earlier session, this
key is the same as it was when the previous session ended.
<p> The session key changes with every call of commitData() or
saveState().
<p> <p>See also <a href="#sessionId">sessionId</a>() and <a href="ntqapplication.html#sessionKey">TQApplication::sessionKey</a>().
<h3 class=fn>void <a name="setDiscardCommand"></a>TQSessionManager::setDiscardCommand ( const <a href="tqstringlist.html">TQStringList</a> & )
</h3>
<p> <p>See also <a href="#discardCommand">discardCommand</a>() and <a href="#setRestartCommand">setRestartCommand</a>().
<h3 class=fn>void <a name="setManagerProperty"></a>TQSessionManager::setManagerProperty ( const <a href="tqstring.html">TQString</a> & name, const <a href="tqstringlist.html">TQStringList</a> & value )
</h3>
<p> Low-level write access to the application's identification and state
record are kept in the session manager.
<p> The property called <em>name</em> has its value set to the string list <em>value</em>.
<h3 class=fn>void <a name="setManagerProperty-2"></a>TQSessionManager::setManagerProperty ( const <a href="tqstring.html">TQString</a> & name, const <a href="tqstring.html">TQString</a> & value )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Low-level write access to the application's identification and state
records are kept in the session manager.
<p> The property called <em>name</em> has its value set to the string <em>value</em>.
<h3 class=fn>void <a name="setRestartCommand"></a>TQSessionManager::setRestartCommand ( const <a href="tqstringlist.html">TQStringList</a> & command )
</h3>
<p> If the session manager is capable of restoring sessions it will
execute <em>command</em> in order to restore the application. The command
defaults to
<p> <pre>
appname -session id
</pre>
<p> The <tt>-session</tt> option is mandatory; otherwise <a href="ntqapplication.html">TQApplication</a> cannot
tell whether it has been restored or what the current session
identifier is. See <a href="ntqapplication.html#isSessionRestored">TQApplication::isSessionRestored</a>() and
<a href="ntqapplication.html#sessionId">TQApplication::sessionId</a>() for details.
<p> If your application is very simple, it may be possible to store the
entire application state in additional command line options. This
is usually a very bad idea because command lines are often limited
to a few hundred bytes. Instead, use <a href="tqsettings.html">TQSettings</a>, or temporary files
or a database for this purpose. By marking the data with the unique
<a href="#sessionId">sessionId</a>(), you will be able to restore the application in a future
session.
<p> <p>See also <a href="#restartCommand">restartCommand</a>(), <a href="#setDiscardCommand">setDiscardCommand</a>(), and <a href="#setRestartHint">setRestartHint</a>().
<h3 class=fn>void <a name="setRestartHint"></a>TQSessionManager::setRestartHint ( <a href="tqsessionmanager.html#RestartHint-enum">RestartHint</a> hint )
</h3>
<p> Sets the application's restart hint to <em>hint</em>. On application
startup the hint is set to <a href="#RestartHint-enum">RestartIfRunning</a>.
<p> Note that these flags are only hints, a session manager may or may
not respect them.
<p> We recommend setting the restart hint in <a href="ntqapplication.html#saveState">TQApplication::saveState</a>()
because most session managers perform a checkpoint shortly after an
application's startup.
<p> <p>See also <a href="#restartHint">restartHint</a>().
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright © 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>
|
