git.maemo.org Git - modest/blob - src/widgets/modest-wizard-dialog.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30
  31 #ifndef __MODEST_WIZARD_DIALOG_H__
  32 #define __MODEST_WIZARD_DIALOG_H__
  33
  34 #include <gtk/gtkwidget.h>
  35 #include <gtk/gtkwindow.h>
  36 #include <gtk/gtknotebook.h>
  37 #include <gtk/gtkdialog.h>
  38
  39 G_BEGIN_DECLS
  40
  41 #define MODEST_TYPE_WIZARD_DIALOG (modest_wizard_dialog_get_type())
  42
  43 #define MODEST_WIZARD_DIALOG(obj) (GTK_CHECK_CAST ((obj), \
  44             MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialog))
  45
  46 #define MODEST_WIZARD_DIALOG_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), \
  47             MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialogClass))
  48
  49 #define MODEST_IS_WIZARD_DIALOG(obj) (GTK_CHECK_TYPE ((obj), \
  50             MODEST_TYPE_WIZARD_DIALOG))
  51
  52 #define MODEST_IS_WIZARD_DIALOG_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), \
  53             MODEST_TYPE_WIZARD_DIALOG))
  54
  55 #define MODEST_WIZARD_DIALOG_GET_CLASS(obj) \
  56             (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  57             MODEST_TYPE_WIZARD_DIALOG, ModestWizardDialogClass))
  58
  59 typedef struct _ModestWizardDialog ModestWizardDialog;
  60
  61 typedef struct _ModestWizardDialogClass ModestWizardDialogClass;
  62
  63 typedef struct _ModestWizardDialogPrivate ModestWizardDialogPrivate;
  64
  65 /* button response IDs */
  66 enum {
  67     MODEST_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
  68     MODEST_WIZARD_DIALOG_PREVIOUS = 0,
  69     MODEST_WIZARD_DIALOG_NEXT,
  70     MODEST_WIZARD_DIALOG_FINISH
  71 };
  72
  73 struct _ModestWizardDialog {
  74     GtkDialog                   parent;
  75     ModestWizardDialogPrivate   *priv;
  76 };
  77
  78 struct _ModestWizardDialogClass {
  79     GtkDialogClass          parent_class;
  80
  81         /** Implementations of this vfunc should prepare the next page if necessary,
  82          * and only return TRUE if the navigation should be allowed.
  83          * You may even change the next page, via the GtkNotebook API, in the signal handler. */
  84         gboolean (* before_next) (ModestWizardDialog *dialog, GtkWidget *current_page, GtkWidget *next_page);
  85
  86         /** Implementations of this vfunc should enable or disable
  87          * the next/forward buttons appropriately, based on the entered data. */
  88         void (* enable_buttons) (ModestWizardDialog *dialog, GtkWidget *current_page);
  89
  90
  91     void (* update_model)  (ModestWizardDialog *dialog);
  92     gboolean (*save)  (ModestWizardDialog *dialog);
  93     void (*_gtk_reserved4)  (void);
  94 };
  95
  96 /*
  97  * Returning %TRUE means you don't allow further processing of the event in ModestWizardDialog
  98  */
  99 typedef gboolean (* ModestWizardDialogResponseOverrideFunc) (ModestWizardDialog *dialog,
 100                                                              gint response_id, gint page_number);
 101
 102
 103 GType modest_wizard_dialog_get_type   (void) G_GNUC_CONST;
 104
 105 GtkWidget* modest_wizard_dialog_new   (GtkWindow        *parent,
 106                                        const char       *wizard_name,
 107                                        GtkNotebook      *notebook);
 108
 109 void modest_wizard_dialog_force_title_update (ModestWizardDialog* wizard_dialog);
 110 void modest_wizard_dialog_update_model (ModestWizardDialog *wizard_dialog);
 111 gboolean modest_wizard_dialog_save (ModestWizardDialog *wizard_dialog);
 112
 113 void modest_wizard_dialog_set_response_override_handler (ModestWizardDialog *wizard_dialog,
 114                                                          ModestWizardDialogResponseOverrideFunc callback);
 115
 116 G_END_DECLS
 117
 118 #endif /* __MODEST_WIZARD_DIALOG_H__ */