Update about dialog design to not use a swarm of dialogs

[~andy/gtk] / gtk / gtkassistant.h

diff --git a/gtk/gtkassistant.h b/gtk/gtkassistant.h
index 47fd16ba866d506a5c7f1ce9313e9a6a0b69f538..ea3ae8168da5f28c02481a5566bada1a8f463f42 100644 (file)
--- a/gtk/gtkassistant.h
+++ b/gtk/gtkassistant.h
@@ -43,21 +43,31 @@ G_BEGIN_DECLS
 
 /**
  * GtkAssistantPageType:
- * @GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents.
+ * @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.
+ *  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.
+ *  changes. The Back and Apply buttons will be shown.
  * @GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes
- *  done.
+ *  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 or %GTK_ASSISTANT_PAGE_SUMMARY to be correct.
+ * %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
 {
@@ -65,7 +75,8 @@ typedef enum
   GTK_ASSISTANT_PAGE_INTRO,
   GTK_ASSISTANT_PAGE_CONFIRM,
   GTK_ASSISTANT_PAGE_SUMMARY,
-  GTK_ASSISTANT_PAGE_PROGRESS
+  GTK_ASSISTANT_PAGE_PROGRESS,
+  GTK_ASSISTANT_PAGE_CUSTOM
 } GtkAssistantPageType;
 
 typedef struct _GtkAssistant        GtkAssistant;
@@ -76,15 +87,8 @@ struct _GtkAssistant
 {
   GtkWindow  parent;
 
-  GtkWidget *GSEAL (cancel);
-  GtkWidget *GSEAL (forward);
-  GtkWidget *GSEAL (back);
-  GtkWidget *GSEAL (apply);
-  GtkWidget *GSEAL (close);
-  GtkWidget *GSEAL (last);
-
   /*< private >*/
-  GtkAssistantPrivate *GSEAL (priv);
+  GtkAssistantPrivate *priv;
 };
 
 struct _GtkAssistantClass
@@ -120,6 +124,8 @@ typedef gint (*GtkAssistantPageFunc) (gint current_page, gpointer data);
 
 GType                 gtk_assistant_get_type              (void) G_GNUC_CONST;
 GtkWidget            *gtk_assistant_new                   (void);
+void                  gtk_assistant_next_page             (GtkAssistant         *assistant);
+void                  gtk_assistant_previous_page         (GtkAssistant         *assistant);
 gint                  gtk_assistant_get_current_page      (GtkAssistant         *assistant);
 void                  gtk_assistant_set_current_page      (GtkAssistant         *assistant,
                                                           gint                  page_num);
@@ -168,6 +174,7 @@ void                  gtk_assistant_remove_action_widget  (GtkAssistant
                                                           GtkWidget            *child);
 
 void                  gtk_assistant_update_buttons_state  (GtkAssistant *assistant);
+void                  gtk_assistant_commit                (GtkAssistant *assistant);
 
 G_END_DECLS