Pileus Git - ~andy/gtk/blob - gtk/gtkassistant.h

   1 /*
   2  * GTK - The GIMP Toolkit
   3  * Copyright (C) 1999  Red Hat, Inc.
   4  * Copyright (C) 2002  Anders Carlsson <andersca@gnu.org>
   5  * Copyright (C) 2003  Matthias Clasen <mclasen@redhat.com>
   6  * Copyright (C) 2005  Carlos Garnacho Parro <carlosg@gnome.org>
   7  *
   8  * All rights reserved.
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25
  26 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  27 #error "Only <gtk/gtk.h> can be included directly."
  28 #endif
  29
  30 #ifndef __GTK_ASSISTANT_H__
  31 #define __GTK_ASSISTANT_H__
  32
  33 #include <gtk/gtkwindow.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define GTK_TYPE_ASSISTANT         (gtk_assistant_get_type ())
  38 #define GTK_ASSISTANT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_ASSISTANT, GtkAssistant))
  39 #define GTK_ASSISTANT_CLASS(c)     (G_TYPE_CHECK_CLASS_CAST    ((c), GTK_TYPE_ASSISTANT, GtkAssistantClass))
  40 #define GTK_IS_ASSISTANT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_ASSISTANT))
  41 #define GTK_IS_ASSISTANT_CLASS(c)  (G_TYPE_CHECK_CLASS_TYPE    ((c), GTK_TYPE_ASSISTANT))
  42 #define GTK_ASSISTANT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS  ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass))
  43
  44 /**
  45  * GtkAssistantPageType:
  46  * @GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. Both the
  47  *  Back and forward buttons will be shown.
  48  * @GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the
  49  *  assistant task. Only the Forward button will be shown if there is a
  50  *   next page.
  51  * @GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the
  52  *  changes. The Back and Apply buttons will be shown.
  53  * @GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes
  54  *  done. Only the Close button will be shown.
  55  * @GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to
  56  *  complete, blocks the assistant until the page is marked as complete.
  57  *   Only the back button will be shown.
  58  * @GTK_ASSISTANT_PAGE_CUSTOM: Used for when other page types are not
  59  *  appropriate. No buttons will be shown, and the application must
  60  *  add its own buttons through gtk_assistant_add_action_widget().
  61  *
  62  * An enum for determining the page role inside the #GtkAssistant. It's
  63  * used to handle buttons sensitivity and visibility.
  64  *
  65  * Note that an assistant needs to end its page flow with a page of type
  66  * %GTK_ASSISTANT_PAGE_CONFIRM, %GTK_ASSISTANT_PAGE_SUMMARY or
  67  * %GTK_ASSISTANT_PAGE_PROGRESS to be correct.
  68  *
  69  * The Cancel button will only be shown if the page isn't "committed".
  70  * See gtk_assistant_commit() for details.
  71  */
  72 typedef enum
  73 {
  74   GTK_ASSISTANT_PAGE_CONTENT,
  75   GTK_ASSISTANT_PAGE_INTRO,
  76   GTK_ASSISTANT_PAGE_CONFIRM,
  77   GTK_ASSISTANT_PAGE_SUMMARY,
  78   GTK_ASSISTANT_PAGE_PROGRESS,
  79   GTK_ASSISTANT_PAGE_CUSTOM
  80 } GtkAssistantPageType;
  81
  82 typedef struct _GtkAssistant        GtkAssistant;
  83 typedef struct _GtkAssistantPrivate GtkAssistantPrivate;
  84 typedef struct _GtkAssistantClass   GtkAssistantClass;
  85
  86 struct _GtkAssistant
  87 {
  88   GtkWindow  parent;
  89
  90   /*< private >*/
  91   GtkAssistantPrivate *priv;
  92 };
  93
  94 struct _GtkAssistantClass
  95 {
  96   GtkWindowClass parent_class;
  97
  98   void (* prepare) (GtkAssistant *assistant, GtkWidget *page);
  99   void (* apply)   (GtkAssistant *assistant);
 100   void (* close)   (GtkAssistant *assistant);
 101   void (* cancel)  (GtkAssistant *assistant);
 102
 103   /* Padding for future expansion */
 104   void (*_gtk_reserved1) (void);
 105   void (*_gtk_reserved2) (void);
 106   void (*_gtk_reserved3) (void);
 107   void (*_gtk_reserved4) (void);
 108   void (*_gtk_reserved5) (void);
 109 };
 110
 111 /**
 112  * GtkAssistantPageFunc:
 113  * @current_page: The page number used to calculate the next page.
 114  * @data: (closure): user data.
 115  *
 116  * A function used by gtk_assistant_set_forward_page_func() to know which
 117  * is the next page given a current one. It's called both for computing the
 118  * next page when the user presses the "forward" button and for handling
 119  * the behavior of the "last" button.
 120  *
 121  * Returns: The next page number.
 122  */
 123 typedef gint (*GtkAssistantPageFunc) (gint current_page, gpointer data);
 124
 125 GType                 gtk_assistant_get_type              (void) G_GNUC_CONST;
 126 GtkWidget            *gtk_assistant_new                   (void);
 127 void                  gtk_assistant_next_page             (GtkAssistant         *assistant);
 128 void                  gtk_assistant_previous_page         (GtkAssistant         *assistant);
 129 gint                  gtk_assistant_get_current_page      (GtkAssistant         *assistant);
 130 void                  gtk_assistant_set_current_page      (GtkAssistant         *assistant,
 131                                                            gint                  page_num);
 132 gint                  gtk_assistant_get_n_pages           (GtkAssistant         *assistant);
 133 GtkWidget            *gtk_assistant_get_nth_page          (GtkAssistant         *assistant,
 134                                                            gint                  page_num);
 135 gint                  gtk_assistant_prepend_page          (GtkAssistant         *assistant,
 136                                                            GtkWidget            *page);
 137 gint                  gtk_assistant_append_page           (GtkAssistant         *assistant,
 138                                                            GtkWidget            *page);
 139 gint                  gtk_assistant_insert_page           (GtkAssistant         *assistant,
 140                                                            GtkWidget            *page,
 141                                                            gint                  position);
 142 void                  gtk_assistant_remove_page           (GtkAssistant         *assistant,
 143                                                            gint                  page_num);
 144 void                  gtk_assistant_set_forward_page_func (GtkAssistant         *assistant,
 145                                                            GtkAssistantPageFunc  page_func,
 146                                                            gpointer              data,
 147                                                            GDestroyNotify        destroy);
 148 void                  gtk_assistant_set_page_type         (GtkAssistant         *assistant,
 149                                                            GtkWidget            *page,
 150                                                            GtkAssistantPageType  type);
 151 GtkAssistantPageType  gtk_assistant_get_page_type         (GtkAssistant         *assistant,
 152                                                            GtkWidget            *page);
 153 void                  gtk_assistant_set_page_title        (GtkAssistant         *assistant,
 154                                                            GtkWidget            *page,
 155                                                            const gchar          *title);
 156 const gchar *         gtk_assistant_get_page_title        (GtkAssistant         *assistant,
 157                                                            GtkWidget            *page);
 158
 159 #if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
 160 GDK_DEPRECATED
 161 void                  gtk_assistant_set_page_header_image (GtkAssistant         *assistant,
 162                                                            GtkWidget            *page,
 163                                                            GdkPixbuf            *pixbuf);
 164 GDK_DEPRECATED
 165 GdkPixbuf            *gtk_assistant_get_page_header_image (GtkAssistant         *assistant,
 166                                                            GtkWidget            *page);
 167 GDK_DEPRECATED
 168 void                  gtk_assistant_set_page_side_image   (GtkAssistant         *assistant,
 169                                                            GtkWidget            *page,
 170                                                            GdkPixbuf            *pixbuf);
 171 GDK_DEPRECATED
 172 GdkPixbuf            *gtk_assistant_get_page_side_image   (GtkAssistant         *assistant,
 173                                                            GtkWidget            *page);
 174 #endif
 175
 176 void                  gtk_assistant_set_page_complete     (GtkAssistant         *assistant,
 177                                                            GtkWidget            *page,
 178                                                            gboolean              complete);
 179 gboolean              gtk_assistant_get_page_complete     (GtkAssistant         *assistant,
 180                                                            GtkWidget            *page);
 181 void                  gtk_assistant_add_action_widget     (GtkAssistant         *assistant,
 182                                                            GtkWidget            *child);
 183 void                  gtk_assistant_remove_action_widget  (GtkAssistant         *assistant,
 184                                                            GtkWidget            *child);
 185
 186 void                  gtk_assistant_update_buttons_state  (GtkAssistant *assistant);
 187 void                  gtk_assistant_commit                (GtkAssistant *assistant);
 188
 189 G_END_DECLS
 190
 191 #endif /* __GTK_ASSISTANT_H__ */