1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __MODEST_WIZARD_DIALOG_H__
32 #define __MODEST_WIZARD_DIALOG_H__
34 #include <gtk/gtkwidget.h>
35 #include <gtk/gtkwindow.h>
36 #include <gtk/gtknotebook.h>
37 #include <gtk/gtkdialog.h>
41 #define MODEST_TYPE_WIZARD_DIALOG (modest_wizard_dialog_get_type())
43 #define MODEST_WIZARD_DIALOG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
44 MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialog))
46 #define MODEST_WIZARD_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), \
47 MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialogClass))
49 #define MODEST_IS_WIZARD_DIALOG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
50 MODEST_TYPE_WIZARD_DIALOG))
52 #define MODEST_IS_WIZARD_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), \
53 MODEST_TYPE_WIZARD_DIALOG))
55 #define MODEST_WIZARD_DIALOG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), \
56 MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialogClass))
58 typedef struct _ModestWizardDialog ModestWizardDialog;
60 typedef struct _ModestWizardDialogClass ModestWizardDialogClass;
62 typedef struct _ModestWizardDialogPrivate ModestWizardDialogPrivate;
64 /* button response IDs */
66 MODEST_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
67 MODEST_WIZARD_DIALOG_PREVIOUS = 0,
68 MODEST_WIZARD_DIALOG_NEXT,
69 MODEST_WIZARD_DIALOG_FINISH
72 struct _ModestWizardDialog {
74 ModestWizardDialogPrivate *priv;
77 struct _ModestWizardDialogClass {
78 GtkDialogClass parent_class;
80 /** Implementations of this vfunc should prepare the next page if necessary,
81 * and only return TRUE if the navigation should be allowed.
82 * You may even change the next page, via the GtkNotebook API, in the signal handler. */
83 gboolean (* before_next) (ModestWizardDialog *dialog, GtkWidget *current_page, GtkWidget *next_page);
85 /** Implementations of this vfunc should enable or disable
86 * the next/forward buttons appropriately, based on the entered data. */
87 void (* enable_buttons) (ModestWizardDialog *dialog, GtkWidget *current_page);
90 void (* update_model) (ModestWizardDialog *dialog);
91 gboolean (*save) (ModestWizardDialog *dialog);
92 void (*_gtk_reserved4) (void);
96 * Returning %TRUE means you don't allow further processing of the event in ModestWizardDialog
98 typedef gboolean (* ModestWizardDialogResponseOverrideFunc) (ModestWizardDialog *dialog,
99 gint response_id, gint page_number);
102 GType modest_wizard_dialog_get_type (void) G_GNUC_CONST;
104 GtkWidget* modest_wizard_dialog_new (GtkWindow *parent,
105 const char *wizard_name,
106 GtkNotebook *notebook);
108 void modest_wizard_dialog_force_title_update (ModestWizardDialog* wizard_dialog);
109 void modest_wizard_dialog_update_model (ModestWizardDialog *wizard_dialog);
110 gboolean modest_wizard_dialog_save (ModestWizardDialog *wizard_dialog);
112 void modest_wizard_dialog_set_response_override_handler (ModestWizardDialog *wizard_dialog,
113 ModestWizardDialogResponseOverrideFunc callback);
117 #endif /* __MODEST_WIZARD_DIALOG_H__ */