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
|
/*
* GTK - The GIMP Toolkit
* Copyright (C) 1999 Red Hat, Inc.
* Copyright (C) 2002 Anders Carlsson <andersca@gnu.org>
* Copyright (C) 2003 Matthias Clasen <mclasen@redhat.com>
* Copyright (C) 2005 Carlos Garnacho Parro <carlosg@gnome.org>
*
* All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GTK_ASSISTANT_H__
#define __GTK_ASSISTANT_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gtk/gtkwindow.h>
G_BEGIN_DECLS
#define GTK_TYPE_ASSISTANT (gtk_assistant_get_type ())
#define GTK_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_ASSISTANT, GtkAssistant))
#define GTK_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), GTK_TYPE_ASSISTANT, GtkAssistantClass))
#define GTK_IS_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_ASSISTANT))
#define GTK_IS_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_ASSISTANT))
#define GTK_ASSISTANT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass))
/**
* GtkAssistantPageType:
* @GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. Both the
* Back and forward buttons will be shown.
* @GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the
* assistant task. Only the Forward button will be shown if there is a
* next page.
* @GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the
* changes. The Back and Apply buttons will be shown.
* @GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes
* done. Only the Close button will be shown.
* @GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to
* complete, blocks the assistant until the page is marked as complete.
* Only the back button will be shown.
* @GTK_ASSISTANT_PAGE_CUSTOM: Used for when other page types are not
* appropriate. No buttons will be shown, and the application must
* add its own buttons through gtk_assistant_add_action_widget().
*
* An enum for determining the page role inside the #GtkAssistant. It's
* used to handle buttons sensitivity and visibility.
*
* Note that an assistant needs to end its page flow with a page of type
* %GTK_ASSISTANT_PAGE_CONFIRM, %GTK_ASSISTANT_PAGE_SUMMARY or
* %GTK_ASSISTANT_PAGE_PROGRESS to be correct.
*
* The Cancel button will only be shown if the page isn’t “committed”.
* See gtk_assistant_commit() for details.
*/
typedef enum
{
GTK_ASSISTANT_PAGE_CONTENT,
GTK_ASSISTANT_PAGE_INTRO,
GTK_ASSISTANT_PAGE_CONFIRM,
GTK_ASSISTANT_PAGE_SUMMARY,
GTK_ASSISTANT_PAGE_PROGRESS,
GTK_ASSISTANT_PAGE_CUSTOM
} GtkAssistantPageType;
typedef struct _GtkAssistant GtkAssistant;
typedef struct _GtkAssistantPrivate GtkAssistantPrivate;
typedef struct _GtkAssistantClass GtkAssistantClass;
struct _GtkAssistant
{
GtkWindow parent;
/*< private >*/
GtkAssistantPrivate *priv;
};
/**
* GtkAssistantClass:
* @parent_class: The parent class.
* @prepare: Signal emitted when a new page is set as the assistant’s current page, before making the new page visible.
* @apply: Signal emitted when the apply button is clicked.
* @close: Signal emitted either when the close button or last page apply button is clicked.
* @cancel: Signal emitted when the cancel button is clicked.
*/
struct _GtkAssistantClass
{
GtkWindowClass parent_class;
/*< public >*/
void (* prepare) (GtkAssistant *assistant, GtkWidget *page);
void (* apply) (GtkAssistant *assistant);
void (* close) (GtkAssistant *assistant);
void (* cancel) (GtkAssistant *assistant);
/*< private >*/
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
void (*_gtk_reserved5) (void);
};
/**
* GtkAssistantPageFunc:
* @current_page: The page number used to calculate the next page.
* @data: (closure): user data.
*
* 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.
*
* Returns: The next page number.
*/
typedef gint (*GtkAssistantPageFunc) (gint current_page, gpointer data);
GDK_AVAILABLE_IN_ALL
GType gtk_assistant_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GtkWidget *gtk_assistant_new (void);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_next_page (GtkAssistant *assistant);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_previous_page (GtkAssistant *assistant);
GDK_AVAILABLE_IN_ALL
gint gtk_assistant_get_current_page (GtkAssistant *assistant);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_set_current_page (GtkAssistant *assistant,
gint page_num);
GDK_AVAILABLE_IN_ALL
gint gtk_assistant_get_n_pages (GtkAssistant *assistant);
GDK_AVAILABLE_IN_ALL
GtkWidget *gtk_assistant_get_nth_page (GtkAssistant *assistant,
gint page_num);
GDK_AVAILABLE_IN_ALL
gint gtk_assistant_prepend_page (GtkAssistant *assistant,
GtkWidget *page);
GDK_AVAILABLE_IN_ALL
gint gtk_assistant_append_page (GtkAssistant *assistant,
GtkWidget *page);
GDK_AVAILABLE_IN_ALL
gint gtk_assistant_insert_page (GtkAssistant *assistant,
GtkWidget *page,
gint position);
GDK_AVAILABLE_IN_3_2
void gtk_assistant_remove_page (GtkAssistant *assistant,
gint page_num);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_set_forward_page_func (GtkAssistant *assistant,
GtkAssistantPageFunc page_func,
gpointer data,
GDestroyNotify destroy);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_set_page_type (GtkAssistant *assistant,
GtkWidget *page,
GtkAssistantPageType type);
GDK_AVAILABLE_IN_ALL
GtkAssistantPageType gtk_assistant_get_page_type (GtkAssistant *assistant,
GtkWidget *page);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_set_page_title (GtkAssistant *assistant,
GtkWidget *page,
const gchar *title);
GDK_AVAILABLE_IN_ALL
const gchar * gtk_assistant_get_page_title (GtkAssistant *assistant,
GtkWidget *page);
GDK_DEPRECATED_IN_3_2
void gtk_assistant_set_page_header_image (GtkAssistant *assistant,
GtkWidget *page,
GdkPixbuf *pixbuf);
GDK_DEPRECATED_IN_3_2
GdkPixbuf *gtk_assistant_get_page_header_image (GtkAssistant *assistant,
GtkWidget *page);
GDK_DEPRECATED_IN_3_2
void gtk_assistant_set_page_side_image (GtkAssistant *assistant,
GtkWidget *page,
GdkPixbuf *pixbuf);
GDK_DEPRECATED_IN_3_2
GdkPixbuf *gtk_assistant_get_page_side_image (GtkAssistant *assistant,
GtkWidget *page);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_set_page_complete (GtkAssistant *assistant,
GtkWidget *page,
gboolean complete);
GDK_AVAILABLE_IN_ALL
gboolean gtk_assistant_get_page_complete (GtkAssistant *assistant,
GtkWidget *page);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_add_action_widget (GtkAssistant *assistant,
GtkWidget *child);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_remove_action_widget (GtkAssistant *assistant,
GtkWidget *child);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_update_buttons_state (GtkAssistant *assistant);
GDK_AVAILABLE_IN_ALL
void gtk_assistant_commit (GtkAssistant *assistant);
GDK_AVAILABLE_IN_3_18
void gtk_assistant_set_page_has_padding (GtkAssistant *assistant,
GtkWidget *page,
gboolean has_padding);
GDK_AVAILABLE_IN_3_18
gboolean gtk_assistant_get_page_has_padding (GtkAssistant *assistant,
GtkWidget *page);
G_END_DECLS
#endif /* __GTK_ASSISTANT_H__ */
|
