-/* \r
- * GTK - The GIMP Toolkit\r
- * Copyright (C) 1999 Red Hat, Inc.\r
- * Copyright (C) 2002 Anders Carlsson <andersca@gnu.org>\r
- * Copyright (C) 2003 Matthias Clasen <mclasen@redhat.com>\r
- * Copyright (C) 2005 Carlos Garnacho Parro <carlosg@gnome.org>\r
- *\r
- * All rights reserved.\r
- *\r
- * This library is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU Lesser General Public\r
- * License as published by the Free Software Foundation; either\r
- * version 2 of the License, or (at your option) any later version.\r
- *\r
- * This library is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
- * Lesser General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU Lesser General Public\r
- * License along with this library; if not, write to the\r
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,\r
- * Boston, MA 02111-1307, USA.\r
- */\r
-\r
-#ifndef __GTK_ASSISTANT_H__\r
-#define __GTK_ASSISTANT_H__\r
-\r
-#include <gtk/gtkwidget.h>\r
-#include <gtk/gtkwindow.h>\r
-\r
-G_BEGIN_DECLS\r
-\r
-#define GTK_TYPE_ASSISTANT (gtk_assistant_get_type ())\r
-#define GTK_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_ASSISTANT, GtkAssistant))\r
-#define GTK_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), GTK_TYPE_ASSISTANT, GtkAssistantClass))\r
-#define GTK_IS_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_ASSISTANT))\r
-#define GTK_IS_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_ASSISTANT))\r
-#define GTK_ASSISTANT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass))\r
-\r
-typedef enum\r
-{\r
- GTK_ASSISTANT_PAGE_CONTENT,\r
- GTK_ASSISTANT_PAGE_INTRO,\r
- GTK_ASSISTANT_PAGE_CONFIRM,\r
- GTK_ASSISTANT_PAGE_SUMMARY,\r
- GTK_ASSISTANT_PAGE_PROGRESS\r
-} GtkAssistantPageType;\r
-\r
-typedef struct _GtkAssistant GtkAssistant;\r
-typedef struct _GtkAssistantClass GtkAssistantClass;\r
-\r
-struct _GtkAssistant\r
-{\r
- GtkWindow parent;\r
-\r
- GtkWidget *cancel;\r
- GtkWidget *forward;\r
- GtkWidget *back;\r
- GtkWidget *apply;\r
- GtkWidget *close;\r
- GtkWidget *last;\r
-};\r
-\r
-struct _GtkAssistantClass\r
-{\r
- GtkWindowClass parent_class;\r
-\r
- void (* prepare) (GtkAssistant *assistant);\r
- void (* apply) (GtkAssistant *assistant);\r
- void (* close) (GtkAssistant *assistant);\r
- void (* cancel) (GtkAssistant *assistant);\r
-\r
- /* Padding for future expansion */\r
- void (*_gtk_reserved1) (void);\r
- void (*_gtk_reserved2) (void);\r
- void (*_gtk_reserved3) (void);\r
- void (*_gtk_reserved4) (void);\r
- void (*_gtk_reserved5) (void);\r
-};\r
-\r
-typedef gint (*GtkAssistantPageFunc) (gint current_page, gpointer data);\r
-\r
-GType gtk_assistant_get_type (void) G_GNUC_CONST;\r
-GtkWidget *gtk_assistant_new (void);\r
-gint gtk_assistant_get_current_page (GtkAssistant *assistant);\r
-void gtk_assistant_set_current_page (GtkAssistant *assistant,\r
- gint page_num);\r
-gint gtk_assistant_get_n_pages (GtkAssistant *assistant);\r
-GtkWidget *gtk_assistant_get_nth_page (GtkAssistant *assistant,\r
- gint page_num);\r
-gint gtk_assistant_prepend_page (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-gint gtk_assistant_append_page (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-gint gtk_assistant_insert_page (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- gint position);\r
-void gtk_assistant_set_forward_page_func (GtkAssistant *assistant,\r
- GtkAssistantPageFunc page_func,\r
- gpointer data,\r
- GDestroyNotify destroy);\r
-void gtk_assistant_set_page_type (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- GtkAssistantPageType type);\r
-GtkAssistantPageType gtk_assistant_get_page_type (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-void gtk_assistant_set_page_title (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- const gchar *title);\r
-G_CONST_RETURN gchar *gtk_assistant_get_page_title (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-void gtk_assistant_set_page_header_image (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- GdkPixbuf *pixbuf);\r
-GdkPixbuf *gtk_assistant_get_page_header_image (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-void gtk_assistant_set_page_side_image (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- GdkPixbuf *pixbuf);\r
-GdkPixbuf *gtk_assistant_get_page_side_image (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-void gtk_assistant_set_page_complete (GtkAssistant *assistant,\r
- GtkWidget *page,\r
- gboolean complete);\r
-gboolean gtk_assistant_get_page_complete (GtkAssistant *assistant,\r
- GtkWidget *page);\r
-void gtk_assistant_add_action_widget (GtkAssistant *assistant,\r
- GtkWidget *child);\r
-void gtk_assistant_remove_action_widget (GtkAssistant *assistant,\r
- GtkWidget *child);\r
-\r
-G_END_DECLS\r
-\r
-#endif /* __GTK_ASSISTANT_H__ */\r
+/*
+ * 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;
+};
+
+struct _GtkAssistantClass
+{
+ GtkWindowClass parent_class;
+
+ void (* prepare) (GtkAssistant *assistant, GtkWidget *page);
+ void (* apply) (GtkAssistant *assistant);
+ void (* close) (GtkAssistant *assistant);
+ void (* cancel) (GtkAssistant *assistant);
+
+ /* 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);
+
+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);
+gint gtk_assistant_get_n_pages (GtkAssistant *assistant);
+GtkWidget *gtk_assistant_get_nth_page (GtkAssistant *assistant,
+ gint page_num);
+gint gtk_assistant_prepend_page (GtkAssistant *assistant,
+ GtkWidget *page);
+gint gtk_assistant_append_page (GtkAssistant *assistant,
+ GtkWidget *page);
+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);
+void gtk_assistant_set_forward_page_func (GtkAssistant *assistant,
+ GtkAssistantPageFunc page_func,
+ gpointer data,
+ GDestroyNotify destroy);
+void gtk_assistant_set_page_type (GtkAssistant *assistant,
+ GtkWidget *page,
+ GtkAssistantPageType type);
+GtkAssistantPageType gtk_assistant_get_page_type (GtkAssistant *assistant,
+ GtkWidget *page);
+void gtk_assistant_set_page_title (GtkAssistant *assistant,
+ GtkWidget *page,
+ const gchar *title);
+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);
+
+void gtk_assistant_set_page_complete (GtkAssistant *assistant,
+ GtkWidget *page,
+ gboolean complete);
+gboolean gtk_assistant_get_page_complete (GtkAssistant *assistant,
+ GtkWidget *page);
+void gtk_assistant_add_action_widget (GtkAssistant *assistant,
+ GtkWidget *child);
+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__ */
projects / ~andy / gtk / blobdiff