diff options
Diffstat (limited to 'gtk/gtkassistant.h')
| -rw-r--r-- | gtk/gtkassistant.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/gtk/gtkassistant.h b/gtk/gtkassistant.h index b39afef43b..5f26325bfa 100644 --- a/gtk/gtkassistant.h +++ b/gtk/gtkassistant.h @@ -41,6 +41,24 @@ G_BEGIN_DECLS #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. + * @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. + * + * 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 or %GTK_ASSISTANT_PAGE_SUMMARY to be correct. + */ typedef enum { GTK_ASSISTANT_PAGE_CONTENT, @@ -86,6 +104,18 @@ struct _GtkAssistantClass void (*_gtk_reserved5) (void); }; +/** + * GtkAssistantPageFunc: + * @current_page: The page number used to calculate the next page. + * @data: 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); GType gtk_assistant_get_type (void) G_GNUC_CONST; |