This file is indexed.

/usr/share/gtk-doc/html/exo-1/ExoXsessionClient.html is in libexo-1-dev 0.6.2-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExoXsessionClient</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-miscelleanous.html" title="Part VII. Miscelleanous">
<link rel="prev" href="exo-Miscellaneous-Utility-Functions.html" title="Miscellaneous Utility Functions">
<link rel="next" href="exo-tools.html" title="Part VIII. Tools">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="exo-Miscellaneous-Utility-Functions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="exo-miscelleanous.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Exo Reference Manual</th>
<td><a accesskey="n" href="exo-tools.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ExoXsessionClient.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ExoXsessionClient.description" class="shortcut">Description</a>
                   | 
                  <a href="#ExoXsessionClient.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#ExoXsessionClient.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#ExoXsessionClient.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="ExoXsessionClient"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ExoXsessionClient.top_of_page"></a>ExoXsessionClient</span></h2>
<p>ExoXsessionClient — Lightweight session management support</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ExoXsessionClient.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;exo/exo.h&gt;

                    <a class="link" href="ExoXsessionClient.html#ExoXsessionClient-struct" title="ExoXsessionClient">ExoXsessionClient</a>;
<a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="returnvalue">ExoXsessionClient</span></a> * <a class="link" href="ExoXsessionClient.html#exo-xsession-client-new-with-group" title="exo_xsession_client_new_with_group ()">exo_xsession_client_new_with_group</a>  (<em class="parameter"><code><span class="type">GdkWindow</span> *leader</code></em>);
<span class="returnvalue">GdkWindow</span> *         <a class="link" href="ExoXsessionClient.html#exo-xsession-client-get-group" title="exo_xsession_client_get_group ()">exo_xsession_client_get_group</a>       (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ExoXsessionClient.html#exo-xsession-client-set-group" title="exo_xsession_client_set_group ()">exo_xsession_client_set_group</a>       (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkWindow</span> *leader</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="ExoXsessionClient.html#exo-xsession-client-get-restart-command" title="exo_xsession_client_get_restart_command ()">exo_xsession_client_get_restart_command</a>
                                                        (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *argc</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ExoXsessionClient.html#exo-xsession-client-set-restart-command" title="exo_xsession_client_set_restart_command ()">exo_xsession_client_set_restart_command</a>
                                                        (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> argc</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----ExoXsessionClient
</pre>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="ExoXsessionClient.html#ExoXsessionClient--group" title='The "group" property'>group</a>"                    <span class="type">GdkWindow</span>*            : Read / Write
  "<a class="link" href="ExoXsessionClient.html#ExoXsessionClient--restart-command" title='The "restart-command" property'>restart-command</a>"          <span class="type">GStrv</span>                 : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="ExoXsessionClient.html#ExoXsessionClient-save-yourself" title='The "save-yourself" signal'>save-yourself</a>"                                  : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.description"></a><h2>Description</h2>
<p>
This module provides application developers with lightweight
session management functions, based on the X11R5 session management
protocol. The X11R5 session management protocol is very limited in
its functionality and flexibility compared to the newer X11R6
session management protocol (XSMP), but - on the other hand - offers several
advantages for applications that do not need the complicated features
of the XSMP. Most importantly, the setup is much easier and
faster than with XSMP, because no special actions must be taken.
</p>
<p>
So, in case your application is simple in its session management
requirements, e.g. it only needs to tell the session manager
its restart command, you may want to use the <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>
instead of a full featured XSMP client.
</p>
<p>
Lets say, for example, you are developing a text editor, which
should provide basic session management support, limited to
proper restarting all editor windows that where left open
when you logged off the X session. In case the user was editing
a file when logging off, the same file should be opened in the
window on next startup.
</p>
<p>
</p>
<div class="example">
<a name="id414616"></a><p class="title"><b>Example 4. Texteditor with <span class="structname">ExoXsessionClient</span></b></p>
<div class="example-contents"><pre class="programlisting">
static gchar *open_file_name = NULL;

static void
save_yourself (ExoXsessionClient *client)
{
  gchar *argv[2];

  if (open_file_name != NULL)
    {
      argv[0] = "myeditor";
      argv[1] = open_file_name;

      exo_xsession_client_set_restart_command (client, argv, 2);
    }
  else
    {
      argv[0] = "myeditor";

      exo_xsession_client_set_restart_command (client, argv, 1);
    }
}

// ...

int
main (int argc, char **argv)
{
  ExoXsessionClient *client;
  GdkDisplay        *display;
  GdkWindow         *leader;
  GtkWidget         *window;

  gtk_init (&amp;argc, &amp;argv);

  if (argc &gt; 1)
    open_file_name = argv[1];

  // create the main window
  window = create_window ();

  // setup the session client
  display = gtk_widget_get_display (window);
  leader = gdk_display_get_default_group (display);
  client = exo_xsession_client_new_with_group (leader);
  g_signal_connect (G_OBJECT (client), "save-yourself",
                    G_CALLBACK (save_yourself), NULL);

  // ...
}
</pre></div>
</div>
<p><br class="example-break">
</p>
<p>
This example demonstrates the basic handling of <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>. It is
oversimplified, but we hope you get the point. The rule of thumb is, use
<a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> if you can store all session data in the restart command,
else use a full-featured XSMP client.
</p>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ExoXsessionClient-struct"></a><h3>ExoXsessionClient</h3>
<pre class="programlisting">typedef struct _ExoXsessionClient ExoXsessionClient;</pre>
<p>
The ExoXsessionClient struct contains only private fields and should
not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-xsession-client-new-with-group"></a><h3>exo_xsession_client_new_with_group ()</h3>
<pre class="programlisting"><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="returnvalue">ExoXsessionClient</span></a> * exo_xsession_client_new_with_group  (<em class="parameter"><code><span class="type">GdkWindow</span> *leader</code></em>);</pre>
<p>
Creates a new <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> and associates it
with the group, which is lead by <em class="parameter"><code>leader</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>leader</code></em> :</span></p></td>
<td>The client leader window of the group.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-xsession-client-get-group"></a><h3>exo_xsession_client_get_group ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> *         exo_xsession_client_get_group       (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>);</pre>
<p>
Returns the client leader window of the group with which
the <em class="parameter"><code>client</code></em> is associated or <code class="literal">NULL</code> if <em class="parameter"><code>client</code></em> is not
associated with any group.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The client leader window of the group with which <em class="parameter"><code>client</code></em> is
associated or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-xsession-client-set-group"></a><h3>exo_xsession_client_set_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                exo_xsession_client_set_group       (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkWindow</span> *leader</code></em>);</pre>
<p>
Sets the group according to the specified <em class="parameter"><code>leader</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>leader</code></em> :</span></p></td>
<td>The client leader window of a group or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-xsession-client-get-restart-command"></a><h3>exo_xsession_client_get_restart_command ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            exo_xsession_client_get_restart_command
                                                        (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *argc</code></em>);</pre>
<p>
Retrieves the restart command previously set on <em class="parameter"><code>client</code></em>. The
result is stored in <em class="parameter"><code>argv</code></em> and should be freed using
<code class="function">g_strfreev()</code> when no longer needed.
</p>
<p>
See <a class="link" href="ExoXsessionClient.html#exo-xsession-client-set-restart-command" title="exo_xsession_client_set_restart_command ()"><code class="function">exo_xsession_client_set_restart_command()</code></a> for further
explanation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Pointer to the location where the
pointer to the argument vector should
be stored to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Pointer to the location where the
number of arguments should be stored
to or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-xsession-client-set-restart-command"></a><h3>exo_xsession_client_set_restart_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                exo_xsession_client_set_restart_command
                                                        (<em class="parameter"><code><a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> argc</code></em>);</pre>
<p>
Sets the <code class="literal">WM_COMMAND</code> property on the client leader window,
which instructs the session manager (or session-enabled window
manager) how to restart the application on next login.
</p>
<p>
This function can only be used if <em class="parameter"><code>client</code></em> is associated with
a client leader window.
</p>
<p>
If <em class="parameter"><code>argc</code></em> is specify as -1, the argument vector <em class="parameter"><code>argv</code></em> is expected
to be <code class="literal">NULL</code>-terminated and <em class="parameter"><code>argc</code></em> will be automatically
calculated from <em class="parameter"><code>argv</code></em>.
</p>
<p>
Please take note, that <code class="function">gtk_init()</code> automatically sets the
<code class="literal">WM_COMMAND</code> property on all client leader windows that are
implicitly created by Gtk+. So, you may only need to call
this function in response to the ::save-yourself signal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The argument vector.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>The number of arguments in <em class="parameter"><code>argv</code></em> or -1.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ExoXsessionClient--group"></a><h3>The <code class="literal">"group"</code> property</h3>
<pre class="programlisting">  "group"                    <span class="type">GdkWindow</span>*            : Read / Write</pre>
<p>Window group leader.</p>
</div>
<hr>
<div class="refsect2">
<a name="ExoXsessionClient--restart-command"></a><h3>The <code class="literal">"restart-command"</code> property</h3>
<pre class="programlisting">  "restart-command"          <span class="type">GStrv</span>                 : Read / Write</pre>
<p>Session restart command.</p>
</div>
</div>
<div class="refsect1">
<a name="ExoXsessionClient.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ExoXsessionClient-save-yourself"></a><h3>The <code class="literal">"save-yourself"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a> *client,
                                                        <span class="type">gpointer</span>           user_data)      : <code class="literal">Run First</code></pre>
<p>
This signal is emitted when <em class="parameter"><code>client</code></em> receives a <code class="literal">WM_SAVE_YOURSELF</code>
message from the session manager or the window manager on the
specified client leader window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>An <a class="link" href="ExoXsessionClient.html" title="ExoXsessionClient"><span class="type">ExoXsessionClient</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>