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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeClient</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="initialization.html" title="Initialization and Session Management">
<link rel="prev" href="libgnomeui-gnome-ui-init.html" title="gnome-ui-init">
<link rel="next" href="application-mgmt.html" title="Application Management">
<meta name="generator" content="GTK-Doc V1.16 (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="libgnomeui-gnome-ui-init.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="initialization.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">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="application-mgmt.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnomeui-gnome-client.synopsis" class="shortcut">Top</a>
|
<a href="#libgnomeui-gnome-client.description" class="shortcut">Description</a>
|
<a href="#libgnomeui-gnome-client.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libgnomeui-gnome-client.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnomeui-gnome-client"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnomeui-gnome-client.top_of_page"></a>GnomeClient</span></h2>
<p>GnomeClient — Interactions with the session manager.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgnomeui-gnome-client.synopsis"></a><h2>Synopsis</h2>
<a name="GnomeClient"></a><pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
#define <a class="link" href="libgnomeui-gnome-client.html#GNOME-CLIENT-CONNECTED:CAPS" title="GNOME_CLIENT_CONNECTED()">GNOME_CLIENT_CONNECTED</a> (obj)
enum <a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType">GnomeDialogType</a>;
enum <a class="link" href="libgnomeui-gnome-client.html#GnomeRestartStyle" title="enum GnomeRestartStyle">GnomeRestartStyle</a>;
enum <a class="link" href="libgnomeui-gnome-client.html#GnomeClientFlags" title="enum GnomeClientFlags">GnomeClientFlags</a>;
enum <a class="link" href="libgnomeui-gnome-client.html#GnomeSaveStyle" title="enum GnomeSaveStyle">GnomeSaveStyle</a>;
enum <a class="link" href="libgnomeui-gnome-client.html#GnomeInteractStyle" title="enum GnomeInteractStyle">GnomeInteractStyle</a>;
<span class="returnvalue">void</span> (<a class="link" href="libgnomeui-gnome-client.html#GnomeInteractFunction" title="GnomeInteractFunction ()">*GnomeInteractFunction</a>) (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> key</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
struct <a class="link" href="libgnomeui-gnome-client.html#GnomeClient-struct" title="struct GnomeClient">GnomeClient</a>;
#define <a class="link" href="libgnomeui-gnome-client.html#GNOME-CLIENT-PARAM-SM-CONNECT:CAPS" title="GNOME_CLIENT_PARAM_SM_CONNECT">GNOME_CLIENT_PARAM_SM_CONNECT</a>
<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-master-client" title="gnome_master_client ()">gnome_master_client</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-config-prefix" title="gnome_client_get_config_prefix ()">gnome_client_get_config_prefix</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-global-config-prefix" title="gnome_client_get_global_config_prefix ()">gnome_client_get_global_config_prefix</a>
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
const <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-module-info-get" title="gnome_client_module_info_get ()">gnome_client_module_info_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-global-config-prefix" title="gnome_client_set_global_config_prefix ()">gnome_client_set_global_config_prefix</a>
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prefix</code></em>);
<a class="link" href="libgnomeui-gnome-client.html#GnomeClientFlags" title="enum GnomeClientFlags"><span class="returnvalue">GnomeClientFlags</span></a> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-flags" title="gnome_client_get_flags ()">gnome_client_get_flags</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-restart-style" title="gnome_client_set_restart_style ()">gnome_client_set_restart_style</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeRestartStyle" title="enum GnomeRestartStyle"><span class="type">GnomeRestartStyle</span></a> style</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-priority" title="gnome_client_set_priority ()">gnome_client_set_priority</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> priority</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-restart-command" title="gnome_client_set_restart_command ()">gnome_client_set_restart_command</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-add-static-arg" title="gnome_client_add_static_arg ()">gnome_client_add_static_arg</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-discard-command" title="gnome_client_set_discard_command ()">gnome_client_set_discard_command</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-resign-command" title="gnome_client_set_resign_command ()">gnome_client_set_resign_command</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-shutdown-command" title="gnome_client_set_shutdown_command ()">gnome_client_set_shutdown_command</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-current-directory" title="gnome_client_set_current_directory ()">gnome_client_set_current_directory</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-environment" title="gnome_client_set_environment ()">gnome_client_set_environment</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-clone-command" title="gnome_client_set_clone_command ()">gnome_client_set_clone_command</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-process-id" title="gnome_client_set_process_id ()">gnome_client_set_process_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><span class="type">pid_t</span> pid</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-program" title="gnome_client_set_program ()">gnome_client_set_program</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *program</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-user-id" title="gnome_client_set_user_id ()">gnome_client_set_user_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-save-any-dialog" title="gnome_client_save_any_dialog ()">gnome_client_save_any_dialog</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-save-error-dialog" title="gnome_client_save_error_dialog ()">gnome_client_save_error_dialog</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-request-phase-2" title="gnome_client_request_phase_2 ()">gnome_client_request_phase_2</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-request-save" title="gnome_client_request_save ()">gnome_client_request_save</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeSaveStyle" title="enum GnomeSaveStyle"><span class="type">GnomeSaveStyle</span></a> save_style</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> shutdown</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeInteractStyle" title="enum GnomeInteractStyle"><span class="type">GnomeInteractStyle</span></a> interact_style</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fast</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> global</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-flush" title="gnome_client_flush ()">gnome_client_flush</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-disable-master-connection" title="gnome_client_disable_master_connection ()">gnome_client_disable_master_connection</a>
(<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-new" title="gnome_client_new ()">gnome_client_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-new-without-connection" title="gnome_client_new_without_connection ()">gnome_client_new_without_connection</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-connect" title="gnome_client_connect ()">gnome_client_connect</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-disconnect" title="gnome_client_disconnect ()">gnome_client_disconnect</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-id" title="gnome_client_set_id ()">gnome_client_set_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-id" title="gnome_client_get_id ()">gnome_client_get_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-previous-id" title="gnome_client_get_previous_id ()">gnome_client_get_previous_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-desktop-id" title="gnome_client_get_desktop_id ()">gnome_client_get_desktop_id</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-request-interaction" title="gnome_client_request_interaction ()">gnome_client_request_interaction</a> (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeInteractFunction" title="GnomeInteractFunction ()"><span class="type">GnomeInteractFunction</span></a> function</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-client-request-interaction-interp" title="gnome_client_request_interaction_interp ()">gnome_client_request_interaction_interp</a>
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-Types.html#GtkCallbackMarshal"><span class="type">GtkCallbackMarshal</span></a> function</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgnomeui-gnome-client.html#gnome-interaction-key-return" title="gnome_interaction_key_return ()">gnome_interaction_key_return</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> cancel_shutdown</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-client.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
+----GnomeClient
</pre>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-client.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-connect" title='The "connect" signal'>connect</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-die" title='The "die" signal'>die</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-disconnect" title='The "disconnect" signal'>disconnect</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-save-complete" title='The "save-complete" signal'>save-complete</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-save-yourself" title='The "save-yourself" signal'>save-yourself</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="libgnomeui-gnome-client.html#GnomeClient-shutdown-cancelled" title='The "shutdown-cancelled" signal'>shutdown-cancelled</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-client.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-client.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GNOME-CLIENT-CONNECTED:CAPS"></a><h3>GNOME_CLIENT_CONNECTED()</h3>
<pre class="programlisting">#define GNOME_CLIENT_CONNECTED(obj) (GNOME_CLIENT (obj)->smc_conn)
</pre>
<p>
Determine if the <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance has connected to the session manager
already.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if already connected to the session manager, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeDialogType"></a><h3>enum GnomeDialogType</h3>
<pre class="programlisting">typedef enum
{
GNOME_DIALOG_ERROR,
GNOME_DIALOG_NORMAL
} GnomeDialogType;
</pre>
<p>
The dialogs used by the session manager to handler user interactions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-DIALOG-ERROR:CAPS"></a><span class="term"><code class="literal">GNOME_DIALOG_ERROR</code></span></p></td>
<td>Used when an error has occurred.
</td>
</tr>
<tr>
<td><p><a name="GNOME-DIALOG-NORMAL:CAPS"></a><span class="term"><code class="literal">GNOME_DIALOG_NORMAL</code></span></p></td>
<td>Used for all other (non-error) interactions.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeRestartStyle"></a><h3>enum GnomeRestartStyle</h3>
<pre class="programlisting">typedef enum
{
/* update structure when adding an enum */
GNOME_RESTART_IF_RUNNING,
GNOME_RESTART_ANYWAY,
GNOME_RESTART_IMMEDIATELY,
GNOME_RESTART_NEVER
} GnomeRestartStyle;
</pre>
<p>
The various ways in which the session manager can restart a client. Set by
calling <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-restart-style" title="gnome_client_set_restart_style ()"><code class="function">gnome_client_set_restart_style()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-RESTART-IF-RUNNING:CAPS"></a><span class="term"><code class="literal">GNOME_RESTART_IF_RUNNING</code></span></p></td>
<td>Restart if the client was running when the previous
session exited.
</td>
</tr>
<tr>
<td><p><a name="GNOME-RESTART-ANYWAY:CAPS"></a><span class="term"><code class="literal">GNOME_RESTART_ANYWAY</code></span></p></td>
<td>Restart even if the client was exited before the user
logged out of the previous session.
</td>
</tr>
<tr>
<td><p><a name="GNOME-RESTART-IMMEDIATELY:CAPS"></a><span class="term"><code class="literal">GNOME_RESTART_IMMEDIATELY</code></span></p></td>
<td>Restart the client immediately whenever it crashes
or exits.
</td>
</tr>
<tr>
<td><p><a name="GNOME-RESTART-NEVER:CAPS"></a><span class="term"><code class="literal">GNOME_RESTART_NEVER</code></span></p></td>
<td>Do not restart the client.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeClientFlags"></a><h3>enum GnomeClientFlags</h3>
<pre class="programlisting">typedef enum
{
GNOME_CLIENT_IS_CONNECTED= 1 << 0,
GNOME_CLIENT_RESTARTED = 1 << 1,
GNOME_CLIENT_RESTORED = 1 << 2
} GnomeClientFlags;
</pre>
<p>
Flags indicating the status of a client (as seen by the session manager). Used
as return values by <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-flags" title="gnome_client_get_flags ()"><code class="function">gnome_client_get_flags()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-CLIENT-IS-CONNECTED:CAPS"></a><span class="term"><code class="literal">GNOME_CLIENT_IS_CONNECTED</code></span></p></td>
<td>The client is connected to the session manager.
</td>
</tr>
<tr>
<td><p><a name="GNOME-CLIENT-RESTARTED:CAPS"></a><span class="term"><code class="literal">GNOME_CLIENT_RESTARTED</code></span></p></td>
<td>The client has been restarted (i.e. it has been
running with the same client id previously).
</td>
</tr>
<tr>
<td><p><a name="GNOME-CLIENT-RESTORED:CAPS"></a><span class="term"><code class="literal">GNOME_CLIENT_RESTORED</code></span></p></td>
<td>There may be a configuration file from which the
client's state should be restored (applies only to the master client).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeSaveStyle"></a><h3>enum GnomeSaveStyle</h3>
<pre class="programlisting">typedef enum
{
/* update structure when adding an enum */
GNOME_SAVE_GLOBAL,
GNOME_SAVE_LOCAL,
GNOME_SAVE_BOTH
} GnomeSaveStyle;
</pre>
<p>
Which pieces of data a client should save when receiving a "SaveYourself" call
from the session manager.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-SAVE-GLOBAL:CAPS"></a><span class="term"><code class="literal">GNOME_SAVE_GLOBAL</code></span></p></td>
<td>Save data (to somewhere persistent) that affects and is
visible to all users of this application.
</td>
</tr>
<tr>
<td><p><a name="GNOME-SAVE-LOCAL:CAPS"></a><span class="term"><code class="literal">GNOME_SAVE_LOCAL</code></span></p></td>
<td>Save data that only applies to this instance of the
application.
</td>
</tr>
<tr>
<td><p><a name="GNOME-SAVE-BOTH:CAPS"></a><span class="term"><code class="literal">GNOME_SAVE_BOTH</code></span></p></td>
<td>Save both global and local data.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeInteractStyle"></a><h3>enum GnomeInteractStyle</h3>
<pre class="programlisting">typedef enum
{
GNOME_INTERACT_NONE,
GNOME_INTERACT_ERRORS,
GNOME_INTERACT_ANY
} GnomeInteractStyle;
</pre>
<p>
Indicates how a "SaveYourself" command should interact with the user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-INTERACT-NONE:CAPS"></a><span class="term"><code class="literal">GNOME_INTERACT_NONE</code></span></p></td>
<td>The client should never interact with the user.
</td>
</tr>
<tr>
<td><p><a name="GNOME-INTERACT-ERRORS:CAPS"></a><span class="term"><code class="literal">GNOME_INTERACT_ERRORS</code></span></p></td>
<td>The client should only interact when there are errors.
</td>
</tr>
<tr>
<td><p><a name="GNOME-INTERACT-ANY:CAPS"></a><span class="term"><code class="literal">GNOME_INTERACT_ANY</code></span></p></td>
<td>The client cna interact with the user for any reason.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeInteractFunction"></a><h3>GnomeInteractFunction ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GnomeInteractFunction) (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> key</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
A function called when the client wishes to interact with the user a the
session manager's convenience (usually during shutdown and restarts). All other
clients are blocked from interacting with the user until the <em class="parameter"><code>key</code></em> is released
via a call to <a class="link" href="libgnomeui-gnome-client.html#gnome-interaction-key-return" title="gnome_interaction_key_return ()"><code class="function">gnome_interaction_key_return()</code></a>.
</p>
<p>
Although the function is not obliged to respect the passed in <em class="parameter"><code>dialog_type</code></em>, it
is bad form not to do so.
</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>The <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance doing the interaction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>A unique key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog_type</code></em> :</span></p></td>
<td>The <a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> that should be used to do the interaction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Application specific data that was specified at the time the callback
was set up.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeClient-struct"></a><h3>struct GnomeClient</h3>
<pre class="programlisting">struct GnomeClient;</pre>
<p>
A widget representing a client and containing information about the client's
interaction with the session manager.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GNOME-CLIENT-PARAM-SM-CONNECT:CAPS"></a><h3>GNOME_CLIENT_PARAM_SM_CONNECT</h3>
<pre class="programlisting">#define GNOME_CLIENT_PARAM_SM_CONNECT "sm-connect"
</pre>
<p>
Passed as a parameter to the application's <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a> call (with a
value of <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>) to indicate whether the application should attempt to
connect to the session manager or not. Can be overridden by the user passing
<code class="literal">--sm-disable</code> on the command line and defaults to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-master-client"></a><h3>gnome_master_client ()</h3>
<pre class="programlisting"><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * gnome_master_client (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the master session management client. This master client gets a client
id, that may be specified by the '--sm-client-id' command line option. A
master client will be generated by <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a>. If possible the
master client will contact the session manager after command-line parsing is
finished (unless <a class="link" href="libgnomeui-gnome-client.html#gnome-client-disable-master-connection" title="gnome_client_disable_master_connection ()"><code class="function">gnome_client_disable_master_connection()</code></a> was called). The
master client will also set the SM_CLIENT_ID property on the client leader
window of your application.
</p>
<p>
Additionally, the master client gets some static arguments set automatically
(see <a class="link" href="libgnomeui-gnome-client.html#gnome-client-add-static-arg" title="gnome_client_add_static_arg ()"><code class="function">gnome_client_add_static_arg()</code></a> for static arguments):
<a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a> passes all the command line options which are
recognised by gtk as static arguments to the master client.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to the master client</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-config-prefix"></a><h3>gnome_client_get_config_prefix ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_client_get_config_prefix (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Get the config prefix for a client. This config prefix
provides a suitable place to store any details about the state of
the client which can not be described using the app's command line
arguments (as set in the restart command). You may push the
returned value using <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-config.html#gnome-config-push-prefix"><code class="function">gnome_config_push_prefix()</code></a> and read or write
any values you require.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Config prefix. The returned string belongs to libgnomeui library
and should NOT be freed by the caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-global-config-prefix"></a><h3>gnome_client_get_global_config_prefix ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_client_get_global_config_prefix
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Get the config prefix that will be returned by
<a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-config-prefix" title="gnome_client_get_config_prefix ()"><code class="function">gnome_client_get_config_prefix()</code></a> for clients which have NOT been restarted
or cloned (i.e. for clients started by the user without `--sm-' options).
This config prefix may be used to write the user's preferred config for
these "new" clients.
</p>
<p>
You could also use this prefix as a place to store and retrieve config
details that you wish to apply to ALL instances of the app. However, this
practice limits the users freedom to configure each instance in a different
way so it should be used with caution.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The config prefix as a newly allocated string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-module-info-get"></a><h3>gnome_client_module_info_get ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> * gnome_client_module_info_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-global-config-prefix"></a><h3>gnome_client_set_global_config_prefix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_global_config_prefix
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prefix</code></em>);</pre>
<p>
Set the value used for the global config prefix. The config
prefixes returned by <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-config-prefix" title="gnome_client_get_config_prefix ()"><code class="function">gnome_client_get_config_prefix()</code></a> are formed by
extending this prefix with an unique identifier.
</p>
<p>
The global config prefix defaults to a name based on the name of
the executable. This function allows you to set it to a different
value. It should be called BEFORE retrieving the config prefix for
the first time. Later calls will be ignored.
</p>
<p>
For example, setting a global config prefix of "/app.d/session/"
would ensure that all your session save files or directories would
be gathered together into the app.d directory.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>Prefix for saving the global configuration.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-flags"></a><h3>gnome_client_get_flags ()</h3>
<pre class="programlisting"><a class="link" href="libgnomeui-gnome-client.html#GnomeClientFlags" title="enum GnomeClientFlags"><span class="returnvalue">GnomeClientFlags</span></a> gnome_client_get_flags (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Determine the client's status with the session manager.,
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Various <span class="type">GnomeClientFlag</span> flags which have been or'd together.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-restart-style"></a><h3>gnome_client_set_restart_style ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_restart_style (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeRestartStyle" title="enum GnomeRestartStyle"><span class="type">GnomeRestartStyle</span></a> style</code></em>);</pre>
<p>
Tells the session manager how the client should be restarted in future
session. The options are given by the <a class="link" href="libgnomeui-gnome-client.html#GnomeRestartStyle" title="enum GnomeRestartStyle"><span class="type">GnomeRestartStyle</span></a> enum.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>When to restart the client.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-priority"></a><h3>gnome_client_set_priority ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_priority (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> priority</code></em>);</pre>
<p>
The gnome-session manager restarts clients in order of their
priorities in a similar way to the start up ordering in SysV.
This function allows the app to suggest a position in this
ordering. The value should be between 0 and 99. A default
value of 50 is assigned to apps that do not provide a value.
The user may assign a different priority.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
<td>Position of client in session start up ordering.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-restart-command"></a><h3>gnome_client_set_restart_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_restart_command (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);</pre>
<p>
When clients crash or the user logs out and back in, they are
restarted. This command should perform the restart. Executing the restart
command on the local host should reproduce the state of the client at the
time of the session save as closely as possible. Saving config info under
the <a class="link" href="libgnomeui-gnome-client.html#gnome-client-get-config-prefix" title="gnome_client_get_config_prefix ()"><code class="function">gnome_client_get_config_prefix()</code></a> is generally useful.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of strings in argv.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Argument vector to an <code class="function">execv()</code> to restart the client.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-add-static-arg"></a><h3>gnome_client_add_static_arg ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_add_static_arg (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
You can add arguments to your restart command's argv with this
function. This function provides an alternative way of adding new arguments
to the restart command. The arguments are placed before the arguments
specified by <a class="link" href="libgnomeui-gnome-client.html#gnome-client-set-restart-command" title="gnome_client_set_restart_command ()"><code class="function">gnome_client_set_restart_command()</code></a> and after the arguments
recognised by GTK+ that are specified by the user on the original command
line.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of arguments to add to the restart command.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-discard-command"></a><h3>gnome_client_set_discard_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_discard_command (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);</pre>
<p>
Provides a command to run when a client is removed from the session. It might
delete session-specific config files for example. Executing the discard
command on the local host should delete the information saved as part of the
session save that was in progress when the discard command was set. For
example:
</p>
<div class="example">
<a name="id3042134"></a><p class="title"><b>Example 1. Setting up a client's discard command</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">prefix </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libgnomeui-gnome-client.html#gnome-client-get-config-prefix">gnome_client_get_config_prefix</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">client</span><span class="symbol">);</span>
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">argv</span><span class="symbol">[]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"rm"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"-r"</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a> </span><span class="cbracket">}</span><span class="symbol">;</span>
<span class="normal">argv</span><span class="symbol">[</span><span class="number">2</span><span class="symbol">]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-config.html#gnome-config-get-real-path">gnome_config_get_real_path</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">prefix</span><span class="symbol">);</span>
<span class="function"><a href="libgnomeui-gnome-client.html#gnome-client-set-discard-command">gnome_client_set_discard_command</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">client</span><span class="symbol">,</span><span class="normal"> </span><span class="number">3</span><span class="symbol">,</span><span class="normal"> argv</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
</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>The <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> of interest.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of strings in <em class="parameter"><code>argv</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Vector of strings such as those passed to <code class="function">exev()</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-resign-command"></a><h3>gnome_client_set_resign_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_resign_command (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);</pre>
<p>
Some clients can be "undone," removing their effects and
deleting any saved state. For example, xmodmap could register a resign
command to undo the keymap changes it saved.
</p>
<p>
Used by clients that use the <a class="link" href="libgnomeui-gnome-client.html#GNOME-RESTART-ANYWAY:CAPS"><span class="type">GNOME_RESTART_ANYWAY</span></a> restart style to to undo
their effects (these clients usually perform initialisation functions and
leave effects behind after they die). The resign command combines the
effects of a shutdown command and a discard command. It is executed when the
user decides that the client should cease to be restarted.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of strings in <em class="parameter"><code>argv</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>execv()-style command to undo the effects of the client.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-shutdown-command"></a><h3>gnome_client_set_shutdown_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_shutdown_command (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);</pre>
<p>
GNOME_RESTART_ANYWAY clients can set this command to run
when the user logs out but the client is no longer running.
</p>
<p>
Used by clients that use the GNOME_RESTART_ANYWAY restart style to
to undo their effects (these clients usually perform initialisation
functions and leave effects behind after they die). The shutdown
command simply undoes the effects of the client. It is executed
during a normal logout.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of strings in argv.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Command to shutdown the client if the client isn't running.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-current-directory"></a><h3>gnome_client_set_current_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_current_directory (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);</pre>
<p>
Set the directory to be in when running shutdown, discard,
restart, etc. commands.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
<td>Directory path.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-environment"></a><h3>gnome_client_set_environment ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_environment (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>
Set an environment variable to be placed in the
client's environment prior to running restart, shutdown, discard, etc. commands.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Name of the environment variable</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Value of the environment variable</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-clone-command"></a><h3>gnome_client_set_clone_command ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_clone_command (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> argc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *argv[]</code></em>);</pre>
<p>
Set a command the session manager can use to create a new
instance of the application.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of strings in the <em class="parameter"><code>argv</code></em> vector.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Argument strings, suitable for use with <code class="function">execv()</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-process-id"></a><h3>gnome_client_set_process_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_process_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><span class="type">pid_t</span> pid</code></em>);</pre>
<p>
The client should tell the session manager the result of
<code class="function">getpid()</code>. However, GNOME does this automatically; so you do not need this
function.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pid</code></em> :</span></p></td>
<td>PID to set as the client's PID.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-program"></a><h3>gnome_client_set_program ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_program (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *program</code></em>);</pre>
<p>
Used to tell the session manager the name of your program. Set
automatically; this function isn't needed.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>Name of the program.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-user-id"></a><h3>gnome_client_set_user_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_user_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>
Tell the session manager the user's login name. GNOME
does this automatically; no need to call the function.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Username.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-save-any-dialog"></a><h3>gnome_client_save_any_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_save_any_dialog (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>);</pre>
<p>
May be called during a "save_youself" handler to request that a
(modal) dialog is presented to the user. The session manager decides
when the dialog is shown, but it will not be shown it unless the
session manager is sending an interaction style of <a class="link" href="libgnomeui-gnome-client.html#GNOME-INTERACT-ANY:CAPS"><span class="type">GNOME_INTERACT_ANY</span></a>.
A "Cancel Logout" button will be added during a shutdown.
</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>Pointer to <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog</code></em> :</span></p></td>
<td>Pointer to GNOME dialog widget (a <a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> widget).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-save-error-dialog"></a><h3>gnome_client_save_error_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_save_error_dialog (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>);</pre>
<p>
May be called during a "save_youself" handler when an error has occurred
during the save. The session manager decides when the dialog is shown, but
it will not be shown it unless the session manager is sending an interaction
style of <a class="link" href="libgnomeui-gnome-client.html#GNOME-INTERACT-ANY:CAPS"><span class="type">GNOME_INTERACT_ANY</span></a>. A "Cancel Logout" button will be added
during a shutdown.
</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>Pointer to <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog</code></em> :</span></p></td>
<td>Pointer to GNOME dialog widget (a <a href="http://library.gnome.org/devel/gtk/unstable/GtkDialog.html"><span class="type">GtkDialog</span></a> widget).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-request-phase-2"></a><h3>gnome_client_request_phase_2 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_request_phase_2 (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Request the session managaer to emit the "save_yourself"
signal for a second time after all the clients in the session have ceased
interacting with the user and entered an idle state. This might be useful if
your app manages other apps and requires that they are in an idle state
before saving its final data.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-request-save"></a><h3>gnome_client_request_save ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_request_save (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeSaveStyle" title="enum GnomeSaveStyle"><span class="type">GnomeSaveStyle</span></a> save_style</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> shutdown</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeInteractStyle" title="enum GnomeInteractStyle"><span class="type">GnomeInteractStyle</span></a> interact_style</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fast</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> global</code></em>);</pre>
<p>
Request the session manager to save the session in
some way. The arguments correspond with the arguments passed to the
"save_yourself" signal handler.
</p>
<p>
The save_style indicates whether the save should affect data
accessible to other users (<a class="link" href="libgnomeui-gnome-client.html#GNOME-SAVE-GLOBAL:CAPS"><span class="type">GNOME_SAVE_GLOBAL</span></a>) or only the state
visible to the current user (<a class="link" href="libgnomeui-gnome-client.html#GNOME-SAVE-LOCAL:CAPS"><span class="type">GNOME_SAVE_LOCAL</span></a>) or both. Setting
shutdown to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will initiate a logout. The interact_style
specifies which kinds of interaction will be available. Setting
fast to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will limit the save to setting the session manager
properties plus any essential data. Setting the value of global to
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will request that all the other apps in the session do a save
as well. A global save is mandatory when doing a shutdown.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>save_style</code></em> :</span></p></td>
<td>Save style to request.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shutdown</code></em> :</span></p></td>
<td>Whether to log out of the session.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interact_style</code></em> :</span></p></td>
<td>Whether to allow user interaction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fast</code></em> :</span></p></td>
<td>Minimize activity to save as soon as possible.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
<td>Request that all other apps in the session also save their state.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-flush"></a><h3>gnome_client_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_flush (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
This will force the underlying connection to the session manager to be
flushed. This is useful if you have some pending changes that you want to
make sure get committed.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-disable-master-connection"></a><h3>gnome_client_disable_master_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_disable_master_connection
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_client_disable_master_connection</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Don't connect the master client to the session manager. Usually
invoked by users when they pass the --sm-disable argument to a Gnome application.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-new"></a><h3>gnome_client_new ()</h3>
<pre class="programlisting"><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * gnome_client_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Allocates memory for a new GNOME session management client
object. After allocating, the client tries to connect to a session manager.
You probably want to use <a class="link" href="libgnomeui-gnome-client.html#gnome-master-client" title="gnome_master_client ()"><code class="function">gnome_master_client()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to a newly allocated GNOME session management client object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-new-without-connection"></a><h3>gnome_client_new_without_connection ()</h3>
<pre class="programlisting"><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="returnvalue">GnomeClient</span></a> * gnome_client_new_without_connection (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Allocates memory for a new GNOME session management client
object. You probably want to use <a class="link" href="libgnomeui-gnome-client.html#gnome-master-client" title="gnome_master_client ()"><code class="function">gnome_master_client()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to a newly allocated GNOME session management client object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-connect"></a><h3>gnome_client_connect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_connect (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Causes the client to connect to the session manager.
Usually happens automatically; no need to call this function.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-disconnect"></a><h3>gnome_client_disconnect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_disconnect (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Disconnect the client from the session manager.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-set-id"></a><h3>gnome_client_set_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_set_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>
Set the client's session management ID; must be done
before connecting to the session manager. There is usually no reason to call
this function.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Session management ID.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-id"></a><h3>gnome_client_get_id ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_client_get_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Returns session management ID
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Session management ID for this client; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not connected to a
session manager.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-previous-id"></a><h3>gnome_client_get_previous_id ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_client_get_previous_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Get the session management ID from the previous session.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to the session management ID the client had in the last
session, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it was not in a previous session.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-get-desktop-id"></a><h3>gnome_client_get_desktop_id ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_client_get_desktop_id (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>);</pre>
<p>
Get the client ID of the desktop's current instance, i.e. if
you consider the desktop as a whole as a session managed app, this
returns its session ID using a GNOME extension to session
management. May return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for apps not running under a recent
version of gnome-session; apps should handle that case.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Session ID of GNOME desktop instance, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-request-interaction"></a><h3>gnome_client_request_interaction ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_request_interaction (<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeInteractFunction" title="GnomeInteractFunction ()"><span class="type">GnomeInteractFunction</span></a> function</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
Use the following functions, if you want to interact with the
user during a "save_yourself" handler without being restricted to using the
dialog based commands <a class="link" href="libgnomeui-gnome-client.html#gnome-client-save-any-dialog" title="gnome_client_save_any_dialog ()"><code class="function">gnome_client_save_any_dialog()</code></a> or
<a class="link" href="libgnomeui-gnome-client.html#gnome-client-save-error-dialog" title="gnome_client_save_error_dialog ()"><code class="function">gnome_client_save_error_dialog()</code></a>. Note, however, that overriding the session
manager specified preference in this way (by using arbitrary dialog boxes)
is not very nice.
</p>
<p>
If and when the session manager decides that it's the app's turn to interact
then 'func' will be called with the specified arguments and a unique
'GnomeInteractionKey'. The session manager will block other
clients from interacting until this key is returned with
<a class="link" href="libgnomeui-gnome-client.html#gnome-interaction-key-return" title="gnome_interaction_key_return ()"><code class="function">gnome_interaction_key_return()</code></a>.
</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>A <a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog_type</code></em> :</span></p></td>
<td>The type of dialog to create.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Callback to invoke to perform the interaction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Callback data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-client-request-interaction-interp"></a><h3>gnome_client_request_interaction_interp ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_client_request_interaction_interp
(<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client</code></em>,
<em class="parameter"><code><a class="link" href="libgnomeui-gnome-client.html#GnomeDialogType" title="enum GnomeDialogType"><span class="type">GnomeDialogType</span></a> dialog_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-Types.html#GtkCallbackMarshal"><span class="type">GtkCallbackMarshal</span></a> function</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
<p>
Similar to <a class="link" href="libgnomeui-gnome-client.html#gnome-client-request-interaction" title="gnome_client_request_interaction ()"><code class="function">gnome_client_request_interaction()</code></a>, but used when
you need to destroy the callback data after the interaction.
</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>Pointer to GNOME session client object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog_type</code></em> :</span></p></td>
<td>Type of dialog to show.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Callback to perform the interaction (a <a class="link" href="libgnomeui-gnome-client.html#GnomeInteractFunction" title="GnomeInteractFunction ()"><span class="type">GnomeInteractFunction</span></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Callback data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>Function to destroy callback data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-interaction-key-return"></a><h3>gnome_interaction_key_return ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_interaction_key_return (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> cancel_shutdown</code></em>);</pre>
<p>
Used in interaction callback to tell the session manager
you are done interacting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Key passed to interaction callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancel_shutdown</code></em> :</span></p></td>
<td>If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, cancel the shutdown</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-client.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GnomeClient-connect"></a><h3>The <code class="literal">"connect"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Called once the client has been connected to the signal manager.
</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>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the application has been restarted.</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>
<hr>
<div class="refsect2">
<a name="GnomeClient-die"></a><h3>The <code class="literal">"die"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Called when the session manager wants the client to shut down.
</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>the object which received the signal.</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>
<hr>
<div class="refsect2">
<a name="GnomeClient-disconnect"></a><h3>The <code class="literal">"disconnect"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Called when the client is disconnected from the session manager.
</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>the object which received the signal.</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>
<hr>
<div class="refsect2">
<a name="GnomeClient-save-complete"></a><h3>The <code class="literal">"save-complete"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Called when the session manager has finished checkpointing all of the clients.
Clients are then free to change their state.
</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>the object which received the signal.</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>
<hr>
<div class="refsect2">
<a name="GnomeClient-save-yourself"></a><h3>The <code class="literal">"save-yourself"</code> signal</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a class="link" href="libgnomeui-gnome-client.html#GnomeSaveStyle" title="enum GnomeSaveStyle"><span class="type">GnomeSaveStyle</span></a> arg2,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg3,
<a class="link" href="libgnomeui-gnome-client.html#GnomeInteractStyle" title="enum GnomeInteractStyle"><span class="type">GnomeInteractStyle</span></a> arg4,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg5,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Called when either a "SaveYourself" or a "SaveYourselfPhase2" call is made by
the session manager.
</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>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>The phase of the "SaveYourself" command ('1' or '2').</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
<td>The data which should be saved by the client (local, global or both).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the session manager is shutting down.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg4</code></em> :</span></p></td>
<td>How the client is allowed to interact with the user while saving.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg5</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this is to be a "fast" shutdown (saving minimal data).</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>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the "SaveYourself" was completed succesfully, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeClient-shutdown-cancelled"></a><h3>The <code class="literal">"shutdown-cancelled"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libgnomeui-gnome-client.html#GnomeClient"><span class="type">GnomeClient</span></a> *client,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Called if the session manager had sent a "SaveYourself" to all clients in
preparation for shutting down and the shutdown was then cancelled. A client can
then continue running and change its state.
</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>the object which received the signal.</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.16</div>
</body>
</html>
|
