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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkAssistant</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="WindowWidgets.html" title="Windows">
<link rel="prev" href="GtkAboutDialog.html" title="GtkAboutDialog">
<link rel="next" href="DisplayWidgets.html" title="Display Widgets">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
</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="GtkAboutDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="WindowWidgets.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">GTK+ Reference Manual</th>
<td><a accesskey="n" href="DisplayWidgets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2972994" class="shortcut">Top</a>
 | 
<a href="#id2974063" class="shortcut">Description</a>
 | 
<a href="#id2973769" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2973838" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2973860" class="shortcut">Child Properties</a>
 | 
<a href="#id2973958" class="shortcut">Style Properties</a>
 | 
<a href="#id2974008" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkAssistant"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2972994"></a><span class="refentrytitle">GtkAssistant</span>
</h2>
<p>GtkAssistant — A widget used to guide users through multi-step operations</p>
</td>
<td valign="top" align="right"><img src="assistant.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkAssistant.html#GtkAssistant-struct">GtkAssistant</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkAssistant.html#gtk-assistant-new">gtk_assistant_new</a> (void);
gint <a href="GtkAssistant.html#gtk-assistant-get-current-page">gtk_assistant_get_current_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
void <a href="GtkAssistant.html#gtk-assistant-set-current-page">gtk_assistant_set_current_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gint page_num);
gint <a href="GtkAssistant.html#gtk-assistant-get-n-pages">gtk_assistant_get_n_pages</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkAssistant.html#gtk-assistant-get-nth-page">gtk_assistant_get_nth_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gint page_num);
gint <a href="GtkAssistant.html#gtk-assistant-prepend-page">gtk_assistant_prepend_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
gint <a href="GtkAssistant.html#gtk-assistant-append-page">gtk_assistant_append_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
gint <a href="GtkAssistant.html#gtk-assistant-insert-page">gtk_assistant_insert_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
gint position);
gint (<a href="GtkAssistant.html#GtkAssistantPageFunc">*GtkAssistantPageFunc</a>) (gint current_page,
gpointer data);
void <a href="GtkAssistant.html#gtk-assistant-set-forward-page-func">gtk_assistant_set_forward_page_func</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkAssistant.html#GtkAssistantPageFunc">GtkAssistantPageFunc</a> page_func,
gpointer data,
GDestroyNotify destroy);
enum <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a>;
void <a href="GtkAssistant.html#gtk-assistant-set-page-type">gtk_assistant_set_page_type</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> type);
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> <a href="GtkAssistant.html#gtk-assistant-get-page-type">gtk_assistant_get_page_type</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-title">gtk_assistant_set_page_title</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const gchar *title);
const gchar* <a href="GtkAssistant.html#gtk-assistant-get-page-title">gtk_assistant_get_page_title</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-header-image">gtk_assistant_set_page_header_image</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkAssistant.html#gtk-assistant-get-page-header-image">gtk_assistant_get_page_header_image</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-side-image">gtk_assistant_set_page_side_image</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkAssistant.html#gtk-assistant-get-page-side-image">gtk_assistant_get_page_side_image</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-complete">gtk_assistant_set_page_complete</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
gboolean complete);
gboolean <a href="GtkAssistant.html#gtk-assistant-get-page-complete">gtk_assistant_get_page_complete</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-add-action-widget">gtk_assistant_add_action_widget</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a href="GtkAssistant.html#gtk-assistant-remove-action-widget">gtk_assistant_remove_action_widget</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a href="GtkAssistant.html#gtk-assistant-update-buttons-state">gtk_assistant_update_buttons_state</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2973769"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
+----GtkAssistant
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2973838"></a><h2>Implemented Interfaces</h2>
<p>
GtkAssistant implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2973860"></a><h2>Child Properties</h2>
<pre class="synopsis">
<a href="GtkAssistant.html#GtkAssistant--complete">complete</a> gboolean : Read / Write
<a href="GtkAssistant.html#GtkAssistant--header-image">header-image</a> <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write
<a href="GtkAssistant.html#GtkAssistant--page-type">page-type</a> <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> : Read / Write
<a href="GtkAssistant.html#GtkAssistant--sidebar-image">sidebar-image</a> <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write
<a href="GtkAssistant.html#GtkAssistant--title">title</a> gchararray : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2973958"></a><h2>Style Properties</h2>
<pre class="synopsis">
<a href="GtkAssistant.html#GtkAssistant--content-padding">content-padding</a> gint : Read
<a href="GtkAssistant.html#GtkAssistant--header-padding">header-padding</a> gint : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2974008"></a><h2>Signals</h2>
<pre class="synopsis">
<a href="GtkAssistant.html#GtkAssistant-apply">apply</a> : Run Last
<a href="GtkAssistant.html#GtkAssistant-cancel">cancel</a> : Run Last
<a href="GtkAssistant.html#GtkAssistant-close">close</a> : Run Last
<a href="GtkAssistant.html#GtkAssistant-prepare">prepare</a> : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2974063"></a><h2>Description</h2>
<p>
A <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is a widget used to represent a generally complex
operation splitted in several steps, guiding the user through its pages
and controlling the page flow to collect the necessary data.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2974088"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2974099"></a><h3>
<a name="GtkAssistant-struct"></a>GtkAssistant</h3>
<a class="indexterm" name="id2974110"></a><pre class="programlisting">typedef struct _GtkAssistant GtkAssistant;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974126"></a><h3>
<a name="gtk-assistant-new"></a>gtk_assistant_new ()</h3>
<a class="indexterm" name="id2974141"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_assistant_new (void);</pre>
<p>
Creates a new <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a newly created <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974204"></a><h3>
<a name="gtk-assistant-get-current-page"></a>gtk_assistant_get_current_page ()</h3>
<a class="indexterm" name="id2974219"></a><pre class="programlisting">gint gtk_assistant_get_current_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Returns the page number of the current page</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The index (starting from 0) of the current page in
the <em class="parameter"><code>assistant</code></em>, if the <em class="parameter"><code>assistant</code></em> has no pages, -1 will be returned
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974309"></a><h3>
<a name="gtk-assistant-set-current-page"></a>gtk_assistant_set_current_page ()</h3>
<a class="indexterm" name="id2974325"></a><pre class="programlisting">void gtk_assistant_set_current_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gint page_num);</pre>
<p>
Switches the page to <em class="parameter"><code>page_num</code></em>. Note that this will only be necessary
in custom buttons, as the <em class="parameter"><code>assistant</code></em> flow can be set with
<a href="GtkAssistant.html#gtk-assistant-set-forward-page-func"><code class="function">gtk_assistant_set_forward_page_func()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page_num</code></em> :</span></td>
<td> index of the page to switch to, starting from 0.
If negative, the last page will be used. If greater
than the number of pages in the <em class="parameter"><code>assistant</code></em>, nothing
will be done.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974446"></a><h3>
<a name="gtk-assistant-get-n-pages"></a>gtk_assistant_get_n_pages ()</h3>
<a class="indexterm" name="id2974462"></a><pre class="programlisting">gint gtk_assistant_get_n_pages (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Returns the number of pages in the <em class="parameter"><code>assistant</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The number of pages in the <em class="parameter"><code>assistant</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974549"></a><h3>
<a name="gtk-assistant-get-nth-page"></a>gtk_assistant_get_nth_page ()</h3>
<a class="indexterm" name="id2974564"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_assistant_get_nth_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gint page_num);</pre>
<p>
Returns the child widget contained in page number <em class="parameter"><code>page_num</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page_num</code></em> :</span></td>
<td> The index of a page in the <em class="parameter"><code>assistant</code></em>, or -1 to get the last page;
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The child widget, or <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> if <em class="parameter"><code>page_num</code></em> is out of bounds.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974691"></a><h3>
<a name="gtk-assistant-prepend-page"></a>gtk_assistant_prepend_page ()</h3>
<a class="indexterm" name="id2974707"></a><pre class="programlisting">gint gtk_assistant_prepend_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Prepends a page to the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974818"></a><h3>
<a name="gtk-assistant-append-page"></a>gtk_assistant_append_page ()</h3>
<a class="indexterm" name="id2974834"></a><pre class="programlisting">gint gtk_assistant_append_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Appends a page to the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2974945"></a><h3>
<a name="gtk-assistant-insert-page"></a>gtk_assistant_insert_page ()</h3>
<a class="indexterm" name="id2974961"></a><pre class="programlisting">gint gtk_assistant_insert_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
gint position);</pre>
<p>
Inserts a page in the <em class="parameter"><code>assistant</code></em> at a given position.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> the index (starting at 0) at which to insert the page,
or -1 to append the page to the <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting from 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975101"></a><h3>
<a name="GtkAssistantPageFunc"></a>GtkAssistantPageFunc ()</h3>
<a class="indexterm" name="id2975114"></a><pre class="programlisting">gint (*GtkAssistantPageFunc) (gint current_page,
gpointer data);</pre>
<p>
A function used by <a href="GtkAssistant.html#gtk-assistant-set-forward-page-func"><code class="function">gtk_assistant_set_forward_page_func()</code></a> to know which
is the next page given a current one. It's called both for computing the
next page when the user presses the "forward" button and for handling
the behavior of the "last" button.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>current_page</code></em> :</span></td>
<td>The page number used to calculate the next page.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>user data.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>The next page number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975210"></a><h3>
<a name="gtk-assistant-set-forward-page-func"></a>gtk_assistant_set_forward_page_func ()</h3>
<a class="indexterm" name="id2975226"></a><pre class="programlisting">void gtk_assistant_set_forward_page_func (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkAssistant.html#GtkAssistantPageFunc">GtkAssistantPageFunc</a> page_func,
gpointer data,
GDestroyNotify destroy);</pre>
<p>
Sets the page forwarding function to be <em class="parameter"><code>page_func</code></em>, this function will
be used to determine what will be the next page when the user presses
the forward button. Setting <em class="parameter"><code>page_func</code></em> to <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> will make the assistant
to use the default forward function, which just goes to the next visible
page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page_func</code></em> :</span></td>
<td> the <a href="GtkAssistant.html#GtkAssistantPageFunc"><span class="type">GtkAssistantPageFunc</span></a>, or <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to use the default one
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> user data for <em class="parameter"><code>page_func</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>destroy</code></em> :</span></td>
<td> destroy notifier for <em class="parameter"><code>data</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975414"></a><h3>
<a name="GtkAssistantPageType"></a>enum GtkAssistantPageType</h3>
<a class="indexterm" name="id2975427"></a><pre class="programlisting">typedef enum
{
GTK_ASSISTANT_PAGE_CONTENT,
GTK_ASSISTANT_PAGE_INTRO,
GTK_ASSISTANT_PAGE_CONFIRM,
GTK_ASSISTANT_PAGE_SUMMARY,
GTK_ASSISTANT_PAGE_PROGRESS
} GtkAssistantPageType;
</pre>
<p>
An enum for determining the page role inside the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>. It's used to
handle buttons sensitivity and visibility.
</p>
<p>
Note that an assistant needs to end its page flow with a page of type GTK_ASSISTANT_PAGE_CONFIRM
or GTK_ASSISTANT_PAGE_SUMMARY to be correct.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GTK-ASSISTANT-PAGE-CONTENT:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_CONTENT</code></span></td>
<td>The page has regular contents.
</td>
</tr>
<tr>
<td><span class="term"><a name="GTK-ASSISTANT-PAGE-INTRO:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_INTRO</code></span></td>
<td>The page contains an introduction to the assistant task.
</td>
</tr>
<tr>
<td><span class="term"><a name="GTK-ASSISTANT-PAGE-CONFIRM:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></span></td>
<td>The page lets the user confirm or deny the changes.
</td>
</tr>
<tr>
<td><span class="term"><a name="GTK-ASSISTANT-PAGE-SUMMARY:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></span></td>
<td>The page informs the user of the changes done.
</td>
</tr>
<tr>
<td><span class="term"><a name="GTK-ASSISTANT-PAGE-PROGRESS:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></span></td>
<td>Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975585"></a><h3>
<a name="gtk-assistant-set-page-type"></a>gtk_assistant_set_page_type ()</h3>
<a class="indexterm" name="id2975600"></a><pre class="programlisting">void gtk_assistant_set_page_type (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> type);</pre>
<p>
Sets the page type for <em class="parameter"><code>page</code></em>. The page type determines the page
behavior in the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> the new type for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975733"></a><h3>
<a name="gtk-assistant-get-page-type"></a>gtk_assistant_get_page_type ()</h3>
<a class="indexterm" name="id2975750"></a><pre class="programlisting"><a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> gtk_assistant_get_page_type (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the page type of <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the page type of <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2975865"></a><h3>
<a name="gtk-assistant-set-page-title"></a>gtk_assistant_set_page_title ()</h3>
<a class="indexterm" name="id2975881"></a><pre class="programlisting">void gtk_assistant_set_page_title (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const gchar *title);</pre>
<p>
Sets a title for <em class="parameter"><code>page</code></em>. The title is displayed in the header
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> the new title for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976014"></a><h3>
<a name="gtk-assistant-get-page-title"></a>gtk_assistant_get_page_title ()</h3>
<a class="indexterm" name="id2976030"></a><pre class="programlisting">const gchar* gtk_assistant_get_page_title (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the title for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the title for <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976146"></a><h3>
<a name="gtk-assistant-set-page-header-image"></a>gtk_assistant_set_page_header_image ()</h3>
<a class="indexterm" name="id2976163"></a><pre class="programlisting">void gtk_assistant_set_page_header_image (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</pre>
<p>
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the header
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976296"></a><h3>
<a name="gtk-assistant-get-page-header-image"></a>gtk_assistant_get_page_header_image ()</h3>
<a class="indexterm" name="id2976312"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_assistant_get_page_header_image (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the header image for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the header image for <em class="parameter"><code>page</code></em>, or <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if there's no header image for the page.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976438"></a><h3>
<a name="gtk-assistant-set-page-side-image"></a>gtk_assistant_set_page_side_image ()</h3>
<a class="indexterm" name="id2976454"></a><pre class="programlisting">void gtk_assistant_set_page_side_image (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</pre>
<p>
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the side
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976587"></a><h3>
<a name="gtk-assistant-get-page-side-image"></a>gtk_assistant_get_page_side_image ()</h3>
<a class="indexterm" name="id2976604"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_assistant_get_page_side_image (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the header image for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the side image for <em class="parameter"><code>page</code></em>, or <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if there's no side image for the page.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976730"></a><h3>
<a name="gtk-assistant-set-page-complete"></a>gtk_assistant_set_page_complete ()</h3>
<a class="indexterm" name="id2976745"></a><pre class="programlisting">void gtk_assistant_set_page_complete (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
gboolean complete);</pre>
<p>
Sets whether <em class="parameter"><code>page</code></em> contents are complete. This will make
<em class="parameter"><code>assistant</code></em> update the buttons state to be able to continue the task.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>complete</code></em> :</span></td>
<td> the completeness status of the page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2976874"></a><h3>
<a name="gtk-assistant-get-page-complete"></a>gtk_assistant_get_page_complete ()</h3>
<a class="indexterm" name="id2976890"></a><pre class="programlisting">gboolean gtk_assistant_get_page_complete (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets whether <em class="parameter"><code>page</code></em> is complete..</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>page</code></em> is complete.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977015"></a><h3>
<a name="gtk-assistant-add-action-widget"></a>gtk_assistant_add_action_widget ()</h3>
<a class="indexterm" name="id2977031"></a><pre class="programlisting">void gtk_assistant_add_action_widget (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Adds a widget to the action area of a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>child</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977134"></a><h3>
<a name="gtk-assistant-remove-action-widget"></a>gtk_assistant_remove_action_widget ()</h3>
<a class="indexterm" name="id2977151"></a><pre class="programlisting">void gtk_assistant_remove_action_widget (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Removes a widget from the action area of a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>child</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977254"></a><h3>
<a name="gtk-assistant-update-buttons-state"></a>gtk_assistant_update_buttons_state ()</h3>
<a class="indexterm" name="id2977270"></a><pre class="programlisting">void gtk_assistant_update_buttons_state (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Forces <em class="parameter"><code>assistant</code></em> to recompute the buttons state.
</p>
<p>
GTK+ automatically takes care of this in most situations,
e.g. when the user goes to a different page, or when the
visibility or completeness of a page changes.
</p>
<p>
One situation where it can be necessary to call this
function is when changing a value on the current page
affects the future page flow of the assistant.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.10
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2977354"></a><h2>Child Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2977365"></a><h3>
<a name="GtkAssistant--complete"></a>The :<code class="literal">complete</code> child property</h3>
<a class="indexterm" name="id2977382"></a><pre class="programlisting"> complete gboolean : Read / Write</pre>
<p>
Setting the "complete" child property to <code class="literal">TRUE</code> marks a page as complete
(i.e.: all the required fields are filled out). GTK+ uses this information
to control the sensitivity of the navigation buttons.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977430"></a><h3>
<a name="GtkAssistant--header-image"></a>The :<code class="literal">header-image</code> child property</h3>
<a class="indexterm" name="id2977446"></a><pre class="programlisting"> header-image <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write</pre>
<p>
The image that is displayed next to the page.
</p>
<p>
Set this to <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to make the sidebar disappear.</p>
<p>
</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977492"></a><h3>
<a name="GtkAssistant--page-type"></a>The :<code class="literal">page-type</code> child property</h3>
<a class="indexterm" name="id2977508"></a><pre class="programlisting"> page-type <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> : Read / Write</pre>
<p>
The type of the assistant page.</p>
<p>
</p>
<p>Default value: GTK_ASSISTANT_PAGE_CONTENT</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977545"></a><h3>
<a name="GtkAssistant--sidebar-image"></a>The :<code class="literal">sidebar-image</code> child property</h3>
<a class="indexterm" name="id2977561"></a><pre class="programlisting"> sidebar-image <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write</pre>
<p>Sidebar image for the assistant page.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977584"></a><h3>
<a name="GtkAssistant--title"></a>The :<code class="literal">title</code> child property</h3>
<a class="indexterm" name="id2977599"></a><pre class="programlisting"> title gchararray : Read / Write</pre>
<p>
The title that is displayed in the page header.
</p>
<p>
If title and header-image are both <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>, no header is displayed.</p>
<p>
</p>
<p>Default value: NULL</p>
<p>Since 2.10
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2977651"></a><h2>Style Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2977662"></a><h3>
<a name="GtkAssistant--content-padding"></a>The :<code class="literal">content-padding</code> style property</h3>
<a class="indexterm" name="id2977679"></a><pre class="programlisting"> content-padding gint : Read</pre>
<p>Number of pixels around the content pages.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977709"></a><h3>
<a name="GtkAssistant--header-padding"></a>The :<code class="literal">header-padding</code> style property</h3>
<a class="indexterm" name="id2977725"></a><pre class="programlisting"> header-padding gint : Read</pre>
<p>Number of pixels around the header.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 6</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2977756"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2977767"></a><h3>
<a name="GtkAssistant-apply"></a>The <code class="literal">::apply</code> signal</h3>
<a class="indexterm" name="id2977783"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gpointer user_data) : Run Last</pre>
<p>
The ::apply signal is emitted when the apply button is clicked. The default
behavior of the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is to switch to the page after the current page,
unless the current page is the last one.
</p>
<p>
A handler for the ::apply signal should carry out the actions for which the
wizard has collected data. If the action takes a long time to complete, you
might consider to put a page of type GTK_ASSISTANT_PAGE_PROGRESS after the
confirmation page and handle this operation within the ::prepare signal of
the progress page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <em class="parameter"><code>GtkAssistant</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977885"></a><h3>
<a name="GtkAssistant-cancel"></a>The <code class="literal">::cancel</code> signal</h3>
<a class="indexterm" name="id2977900"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gpointer user_data) : Run Last</pre>
<p>
The ::cancel signal is emitted when then the cancel button is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2977986"></a><h3>
<a name="GtkAssistant-close"></a>The <code class="literal">::close</code> signal</h3>
<a class="indexterm" name="id2978002"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
gpointer user_data) : Run Last</pre>
<p>
The ::close signal is emitted either when the close button of
a summary page is clicked, or when the apply button in the last
page in the flow (of type GTK_ASSISTANT_PAGE_CONFIRM) is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2978090"></a><h3>
<a name="GtkAssistant-prepare"></a>The <code class="literal">::prepare</code> signal</h3>
<a class="indexterm" name="id2978106"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
gpointer user_data) : Run Last</pre>
<p>
The ::prepared signal is emitted when a new page is set as the assistant's
current page, before making the new page visible. A handler for this signal
can do any preparation which are necessary before showing <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> the current page
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
</div>
</div>
</body>
</html>
|