GtkStyle: set style context state before calling gtk_render_icon_pixbuf()

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

diff --git a/gtk/gtkassistant.h b/gtk/gtkassistant.h
index b48c88cab3d36aefd9d6521ac9035a88164e07cc..ea3ae8168da5f28c02481a5566bada1a8f463f42 100644 (file)
--- a/gtk/gtkassistant.h
+++ b/gtk/gtkassistant.h
@@ -23,10 +23,13 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #ifndef __GTK_ASSISTANT_H__
 #define __GTK_ASSISTANT_H__
 
-#include <gtk/gtkwidget.h>
 #include <gtk/gtkwindow.h>
 
 G_BEGIN_DECLS
@@ -38,35 +41,61 @@ 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. 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_PROGRESS,
+  GTK_ASSISTANT_PAGE_CUSTOM
 } GtkAssistantPageType;
 
-typedef struct _GtkAssistant      GtkAssistant;
-typedef struct _GtkAssistantClass GtkAssistantClass;
+typedef struct _GtkAssistant        GtkAssistant;
+typedef struct _GtkAssistantPrivate GtkAssistantPrivate;
+typedef struct _GtkAssistantClass   GtkAssistantClass;
 
 struct _GtkAssistant
 {
   GtkWindow  parent;
 
-  GtkWidget *cancel;
-  GtkWidget *forward;
-  GtkWidget *back;
-  GtkWidget *apply;
-  GtkWidget *close;
-  GtkWidget *last;
+  /*< private >*/
+  GtkAssistantPrivate *priv;
 };
 
 struct _GtkAssistantClass
 {
   GtkWindowClass parent_class;
 
-  void (* prepare) (GtkAssistant *assistant);
+  void (* prepare) (GtkAssistant *assistant, GtkWidget *page);
   void (* apply)   (GtkAssistant *assistant);
   void (* close)   (GtkAssistant *assistant);
   void (* cancel)  (GtkAssistant *assistant);
@@ -79,10 +108,24 @@ 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;
 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);
@@ -130,6 +173,9 @@ void                  gtk_assistant_add_action_widget     (GtkAssistant
 void                  gtk_assistant_remove_action_widget  (GtkAssistant         *assistant,
                                                           GtkWidget            *child);
 
+void                  gtk_assistant_update_buttons_state  (GtkAssistant *assistant);
+void                  gtk_assistant_commit                (GtkAssistant *assistant);
+
 G_END_DECLS
 
 #endif /* __GTK_ASSISTANT_H__ */