summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkassistant.sgml
blob: c9210143925bd00bb04d413291509c8364f806a6 (plain)
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
<!-- ##### SECTION Title ##### -->
GtkAssistant

<!-- ##### SECTION Short_Description ##### -->
A widget used to guide users through multi-step operations

<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkAssistant 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.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkAssistant ##### -->
<para>

</para>


<!-- ##### SIGNAL GtkAssistant::apply ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::cancel ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::close ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::prepare ##### -->
<para>

</para>

@assistant: the object which received the signal.
@widget: 

<!-- ##### ARG GtkAssistant:complete ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:header-image ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:page-type ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:sidebar-image ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:title ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:content-padding ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:header-padding ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_assistant_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_assistant_get_current_page ##### -->
<para>

</para>

@assistant: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_current_page ##### -->
<para>

</para>

@assistant: 
@page_num: 


<!-- ##### FUNCTION gtk_assistant_get_n_pages ##### -->
<para>

</para>

@assistant: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_get_nth_page ##### -->
<para>

</para>

@assistant: 
@page_num: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_prepend_page ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_append_page ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_insert_page ##### -->
<para>

</para>

@assistant: 
@page: 
@position: 
@Returns: 


<!-- ##### USER_FUNCTION GtkAssistantPageFunc ##### -->
<para>
A function used by gtk_assistant_set_forward_page_func() 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.
</para>

@current_page: The page number used to calculate the next page.
@data: user data.
@Returns: The next page number.


<!-- ##### FUNCTION gtk_assistant_set_forward_page_func ##### -->
<para>

</para>

@assistant: 
@page_func: 
@data: 
@destroy: 


<!-- ##### ENUM GtkAssistantPageType ##### -->
<para>
An enum for determining the page role inside the #GtkAssistant. It's used to
handle buttons sensitivity and visibility.
</para>

<para>
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.
</para>

@GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents.
@GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the assistant task.
@GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the changes.
@GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes done.
@GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.

<!-- ##### FUNCTION gtk_assistant_set_page_type ##### -->
<para>

</para>

@assistant: 
@page: 
@type: 


<!-- ##### FUNCTION gtk_assistant_get_page_type ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_title ##### -->
<para>

</para>

@assistant: 
@page: 
@title: 


<!-- ##### FUNCTION gtk_assistant_get_page_title ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_header_image ##### -->
<para>

</para>

@assistant: 
@page: 
@pixbuf: 


<!-- ##### FUNCTION gtk_assistant_get_page_header_image ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_side_image ##### -->
<para>

</para>

@assistant: 
@page: 
@pixbuf: 


<!-- ##### FUNCTION gtk_assistant_get_page_side_image ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_complete ##### -->
<para>

</para>

@assistant: 
@page: 
@complete: 


<!-- ##### FUNCTION gtk_assistant_get_page_complete ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_add_action_widget ##### -->
<para>

</para>

@assistant: 
@child: 


<!-- ##### FUNCTION gtk_assistant_remove_action_widget ##### -->
<para>

</para>

@assistant: 
@child: 


<!-- ##### FUNCTION gtk_assistant_update_buttons_state ##### -->
<para>

</para>

@assistant: