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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkassistant">
<refnamediv>
<refname>gtk.Assistant</refname>
<refpurpose>a widget used to guide users through multi-step operations
(new in PyGTK 2.10)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Assistant</classname></ooclass>
<ooclass><classname><link linkend="class-gtkwindow">gtk.Window</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname>gtk.Assistant</methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-current-page">get_current_page</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-current-page">set_current_page</link></methodname>
<methodparam><parameter role="keyword">page_num</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-n-pages">get_n_pages</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-nth-page">get_nth_page</link></methodname>
<methodparam><parameter role="keyword">page_num</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--prepend-page">prepend_page</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--append-page">append_page</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--insert-page">insert_page</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-forward-page-func">set_forward_page_func</link></methodname>
<methodparam><parameter role="keyword">page_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-page-type">set_page_type</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-page-type">get_page_type</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-page-title">set_page_title</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-page-title">get_page_title</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-page-header-image">set_page_header_image</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-page-header-image">get_page_header_image</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-page-side-image">set_page_side_image</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-page-side-image">get_page_side_image</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--set-page-complete">set_page_complete</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">complete</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--get-page-complete">get_page_complete</link></methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--add-action-widget">add_action_widget</link></methodname>
<methodparam><parameter role="keyword">child</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--remove-action-widget">remove_action_widget</link></methodname>
<methodparam><parameter role="keyword">child</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--update-buttons-state">update_buttons_state</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkassistant--commit">commit</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkwindow">gtk.Window</link>
+-- <link linkend="class-gtkwidget">gtk.Assistant</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkassistant">
<title>gtk.Assistant Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
</refsect1>
<refsect1 id="style-properties-gtkassistant">
<title>gtk.Assistant Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"content-padding"</entry>
<entry>Read</entry>
<entry>Number of pixels around the content pages. Allowed
values: >= 0. Default value: 1. This property is available in
GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"header-padding"</entry>
<entry>Read</entry>
<entry>Number of pixels around the header. Allowed values: >=
0 Default value: 6. This property is available in GTK+ 2.10
and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="child-properties-gtkassistant">
<title>gtk.Assistant Child Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"complete"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, 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. Default value: <literal>False</literal>. This property
is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"header-image"</entry>
<entry>Read-Write</entry>
<entry>The <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
image that is displayed in the page header. This property is
available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"page-type"</entry>
<entry>Read-Write</entry>
<entry>The type of the assistant page - one of the <xref
linkend="gtk-assistant-page-type-constants"
endterm="gtk-assistant-page-type-constants-title"></xref> .
Default value:
<literal>gtk.ASSISTANT_PAGE_CONTENT</literal>. This property
is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"sidebar-image"</entry>
<entry>Read-Write</entry>
<entry>The <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
image displayed in the sidebar for the assistant page. Set
this to <literal>None</literal> to make the sidebar
disappear. This property is available in GTK+ 2.10 and
above.</entry>
</row>
<row valign="top">
<entry>"title"</entry>
<entry>Read-Write</entry>
<entry>The title that is displayed in the page header. If
"title" and "header-image" are both <literal>None</literal>,
no header is displayed. Default value:
<literal>None</literal>. This property is available in GTK+
2.10 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkassistant">
<title>gtk.Assistant Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkassistant--apply">apply</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkassistant--cancel">cancel</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkassistant--close">close</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkassistant--prepare">prepare</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>page</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
is a widget used to guide the user through a complex operation by
breaking it into several steps. Each step is generally handled by one
assistant page. The assistant controls the page flow to collect the
necessary data to complete the application task.</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gtkassistant">
<title>gtk.Assistant</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.Assistant</methodname>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
object.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.10 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkassistant--get-current-page">
<title>gtk.Assistant.get_current_page</title>
<programlisting><methodsynopsis language="python">
<methodname>get_current_page</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<term><parameter
role="keyword"></parameter> :</term>
<listitem><simpara>The index (starting from 0) of the current page
in the assistant, if the assistant has no pages, -1 will be
returned.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_current_page</methodname>() method returns
the page number of the current page.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-current-page">
<title>gtk.Assistant.set_current_page</title>
<programlisting><methodsynopsis language="python">
<methodname>set_current_page</methodname>
<methodparam><parameter
role="keyword">page_num</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page_num</parameter> :</term>
<listitem><simpara>the 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 assistant, there will be no
change.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_current_page</methodname>() method switches
the page to the page specified by
<parameter>page_num</parameter>. Note that this will only be necessary
in custom buttons, as the assistant flow can be set with the <link
linkend="method-gtkassistant--set-forward-page-func"><methodname>set_forward_page_func</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-n-pages">
<title>gtk.Assistant.get_n_pages</title>
<programlisting><methodsynopsis language="python">
<methodname>get_n_pages</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The number of pages in the assistant.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_n_pages</methodname>() method returns the
number of pages in the assistant</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-nth-page">
<title>gtk.Assistant.get_nth_page</title>
<programlisting><methodsynopsis language="python">
<methodname>get_nth_page</methodname>
<methodparam><parameter role="keyword">page_num</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page_num</parameter> :</term>
<listitem><simpara>The index of a page in the assistant, or -1 to
get the last page;</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The child widget, or <literal>None</literal> if
<parameter>page_num</parameter> is out of
bounds.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_nth_page</methodname>() method returns the
child widget contained in the page specified by
<parameter>page_num</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--prepend-page">
<title>gtk.Assistant.prepend_page</title>
<programlisting><methodsynopsis language="python">
<methodname>prepend_page</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the index (starting at 0) of the inserted
page</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>prepend_page</methodname>() method prepends the
page specified by <parameter>page</parameter> to the assistant.</para>
</refsect2>
<refsect2 id="method-gtkassistant--append-page">
<title>gtk.Assistant.append_page</title>
<programlisting><methodsynopsis language="python">
<methodname>append_page</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the index (starting at 0) of the inserted
page</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>append_page</methodname>() method appends the
page specified by <parameter>page</parameter> to the assistant.</para>
</refsect2>
<refsect2 id="method-gtkassistant--insert-page">
<title>gtk.Assistant.insert_page</title>
<programlisting><methodsynopsis language="python">
<methodname>insert_page</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the index (starting at 0) at which to insert the
page, or -1 to append the page to the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the index (starting from 0) of the inserted
page</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>insert_page</methodname>() method inserts the
page specified by <parameter>page</parameter> in the assistant at the
position index specified by <parameter>position</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-forward-page-func">
<title>gtk.Assistant.set_forward_page_func</title>
<programlisting><methodsynopsis language="python">
<methodname>set_forward_page_func</methodname>
<methodparam><parameter role="keyword">page_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page_func</parameter> :</term>
<listitem><simpara>the function, or <literal>None</literal> to use
the default function.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>user data for
<parameter>page_func</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_forward_page_func</methodname>() method sets
the page forwarding function to be
<parameter>page_func</parameter>. This function will be used to
determine what will be the next page when the user presses the forward
button. Setting <parameter>page_func</parameter> to
<literal>None</literal> will make the assistant use the default
forward function, which just goes to the next visible page.</para>
<para>The signature of <parameter>page_func</parameter> is:</para>
<programlisting>
def page_func(current_page, user_data):
</programlisting>
<para>where <parameter>current_page</parameter> is the index of the
current page and <parameter>user_data</parameter> is
<parameter>data</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-page-type">
<title>gtk.Assistant.set_page_type</title>
<programlisting><methodsynopsis language="python">
<methodname>set_page_type</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page in the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara>the new type for
<parameter>page</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_page_type</methodname>() method sets the
page type, which specifies the page behavior, for the page specified
by <parameter>page</parameter> to the value specified by
<parameter>type</parameter>. The page type must be one of the <xref
linkend="gtk-assistant-page-type-constants"
endterm="gtk-assistant-page-type-constants-title"></xref>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-page-type">
<title>gtk.Assistant.get_page_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_page_type</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page in the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the page type of
<parameter>page</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_page_type</methodname>() method returns the
page type of the page specified by <parameter>page</parameter>. The
page type will be one of the <xref
linkend="gtk-assistant-page-type-constants"
endterm="gtk-assistant-page-type-constants-title"></xref>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-page-title">
<title>gtk.Assistant.set_page_title</title>
<programlisting><methodsynopsis language="python">
<methodname>set_page_title</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara>the new title for
<parameter>page</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_page_title</methodname>() method sets the
title for the page specified by <parameter>page</parameter> to the
string specified by <parameter>title</parameter>. The title is
displayed in the header area of the assistant when
<parameter>page</parameter> is the current page.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-page-title">
<title>gtk.Assistant.get_page_title</title>
<programlisting><methodsynopsis language="python">
<methodname>get_page_title</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the title for
<parameter>page</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_page_title</methodname>() method returns the
title for the page specified by <parameter>page</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-page-header-image">
<title>gtk.Assistant.set_page_header_image</title>
<programlisting><methodsynopsis language="python">
<methodname>set_page_header_image</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">pixbuf</parameter> :</term>
<listitem><simpara>the new header image for
<parameter>page</parameter> or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_page_header_image</methodname>() method sets
the <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
specified by <parameter>pixbuf</parameter> as the header image for the
page specified by <parameter>page</parameter>. This image is displayed
in the header area of the assistant when <parameter>page</parameter>
is the current page. If <parameter>pixbuf</parameter> is
<literal>None</literal> the header image will be removed.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-page-header-image">
<title>gtk.Assistant.get_page_header_image</title>
<programlisting><methodsynopsis language="python">
<methodname>get_page_header_image</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the header image for <parameter>page</parameter>,
or <literal>None</literal> if there's no header image for the
page.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_page_header_image</methodname>() method
returns the header image for the page specified by
<parameter>page</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-page-side-image">
<title>gtk.Assistant.set_page_side_image</title>
<programlisting><methodsynopsis language="python">
<methodname>set_page_side_image</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">pixbuf</parameter> :</term>
<listitem><simpara>the new side image for
<parameter>page</parameter> or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_page_side_image</methodname>() method sets
the <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
specified by <parameter>pixbuf</parameter> as the header image for the
page specified by <parameter>page</parameter>. This image is displayed
in the side area of the assistant when <parameter>page</parameter> is
the current page. If <parameter>pixbuf</parameter> is
<literal>None</literal> the side image will be removed.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-page-side-image">
<title>gtk.Assistant.get_page_side_image</title>
<programlisting><methodsynopsis language="python">
<methodname>get_page_side_image</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the side image for <parameter>page</parameter>,
or <literal>None</literal> if there's no side image for the
page.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_page_side_image</methodname>() method
returns the header image for the page specified by
<parameter>page</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkassistant--set-page-complete">
<title>gtk.Assistant.set_page_complete</title>
<programlisting><methodsynopsis language="python">
<methodname>set_page_complete</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
<methodparam><parameter role="keyword">complete</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">complete</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the page status is
complete.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_page_complete</methodname>() method sets the
"complete" property of the page specified by
<parameter>page</parameter> to the value specified by
<parameter>complete</parameter>. If <parameter>complete</parameter> is
<literal>True</literal> the <parameter>page</parameter> contents are
complete. This will make the assistant update the state of its
buttons.</para>
</refsect2>
<refsect2 id="method-gtkassistant--get-page-complete">
<title>gtk.Assistant.get_page_complete</title>
<programlisting><methodsynopsis language="python">
<methodname>get_page_complete</methodname>
<methodparam><parameter role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>a page of the assistant</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if
<parameter>page</parameter> is complete.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_page_complete</methodname>() method returns
the value of the "complete" property of the page specified by
<parameter>page</parameter>. If the return value is
<literal>True</literal>, the <parameter>page</parameter> contents are
complete.</para>
</refsect2>
<refsect2 id="method-gtkassistant--add-action-widget">
<title>gtk.Assistant.add_action_widget</title>
<programlisting><methodsynopsis language="python">
<methodname>add_action_widget</methodname>
<methodparam><parameter role="keyword">child</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">child</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>add_action_widget</methodname>() method adds the
widget specified by <parameter>child</parameter> to the action area of
the assistant.</para>
</refsect2>
<refsect2 id="method-gtkassistant--remove-action-widget">
<title>gtk.Assistant.remove_action_widget</title>
<programlisting><methodsynopsis language="python">
<methodname>remove_action_widget</methodname>
<methodparam><parameter role="keyword">child</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">child</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>remove_action_widget</methodname>() method
removes the widget specified by <parameter>child</parameter> from the
action area of the assistant.</para>
</refsect2>
<refsect2 id="method-gtkassistant--update-buttons-state">
<title>gtk.Assistant.update_buttons_state</title>
<programlisting><methodsynopsis language="python">
<methodname>update_buttons_state</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>update_buttons_state</methodname>() method
forces the assistant to recompute the state of its buttons.</para>
<para>PyGTK 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.</para>
<para>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.</para>
</refsect2>
<refsect2 id="method-gtkassistant--commit">
<title>gtk.Assistant.commit</title>
<programlisting><methodsynopsis language="python">
<methodname>commit</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>commit</methodname>() method erases the visited
page history so the back button is not shown on the current page, and
removes the cancel button from subsequent pages.</para>
<para>Use this when the information provided up to the current page is
hereafter deemed permanent and cannot be modified or undone. For example,
showing a progress page to track a long-running, unreversible operation
after the user has clicked apply on a confirmation page.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkassistant--apply">
<title>The "apply" Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>assistant</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>assistant</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "apply" signal is emitted when the apply button is
clicked. The default behavior of the <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
is to switch to the page after the current page, unless the current
page is the last one.</para>
<para>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
<literal>gtk.ASSISTANT_PAGE_PROGRESS</literal> after the confirmation
page and handle this operation within the "prepare" signal of the
progress page.</para>
</refsect2>
<refsect2 id="signal-gtkassistant--cancel">
<title>The "cancel" Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>assistant</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>assistant</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "cancel" signal is emitted when the cancel button is
clicked.</para>
</refsect2>
<refsect2 id="signal-gtkassistant--close">
<title>The "close" Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>assistant</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>assistant</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>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 <literal>gtk.ASSISTANT_PAGE_CONFIRM</literal>) is
clicked.</para>
</refsect2>
<refsect2 id="signal-gtkassistant--prepare">
<title>The "prepare" Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>assistant</parameter></methodparam>
<methodparam><parameter>page</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>assistant</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>page</parameter> :</term>
<listitem><simpara>the new page to prepare for
display</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "prepare" signal is emitted when a new page is set as the
assistant's current page, but before making the new page visible. A
handler for this signal can do any preparation that are necessary
before showing <parameter>page</parameter>.</para>
</refsect2>
</refsect1>
</refentry>
|
