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

   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  * SECTION:modest-wizard-dialog
  32  * @short_description: A widget to create a guided installation
  33  * process wizard
  34  *
  35  * #ModestWizardDialog is a widget to create a guided installation
  36  * process. The dialog has four standard buttons, previous, next,
  37  * finish, cancel, and contains several pages with optional icons.
  38  * Response buttons are dimmed/undimmed automatically and the standard
  39  * icon is shown/hidden in response to page navigation. The notebook
  40  * widget provided by users contains the actual wizard pages.
  41  */
  42
  43 #include <config.h>
  44 #include <gtk/gtkdialog.h>
  45 #include <gtk/gtknotebook.h>
  46 #include <gtk/gtkimage.h>
  47 #include <gtk/gtkbox.h>
  48 #include <gtk/gtkhbox.h>
  49 #include <gtk/gtkvbox.h>
  50 #include <gtk/gtkbutton.h>
  51 #include <gtk/gtk.h>
  52
  53 #ifdef HAVE_CONFIG_H
  54 #include <config.h>
  55 #endif
  56
  57 #ifndef MODEST_TOOLKIT_GTK
  58 #if MODEST_HILDON_API == 0
  59 #include <hildon-widgets/hildon-defines.h>
  60 #else
  61 #include <hildon/hildon-defines.h>
  62 #endif /*MODEST_HILDON_API == 0*/
  63 #endif /*!MODEST_TOOLKIT_GTK*/
  64
  65 #include "modest-wizard-dialog.h"
  66 #include "modest-debug.h"
  67 #include "modest-text-utils.h"
  68
  69 static GtkDialogClass *parent_class;
  70
  71 static void class_init              (ModestWizardDialogClass   *wizard_dialog_class);
  72
  73 static void init                    (ModestWizardDialog        *wizard_dialog);
  74
  75 static void create_title            (ModestWizardDialog        *wizard_dialog);
  76
  77 static void set_property            (GObject                   *object,
  78                                      guint                     property_id,
  79                                      const GValue              *value,
  80                                      GParamSpec                *pspec);
  81
  82 static void get_property            (GObject                   *object,
  83                                      guint                     property_id,
  84                                      GValue                    *value,
  85                                      GParamSpec                *pspec);
  86
  87 static void finalize                (GObject                   *object);
  88
  89 static void response                (ModestWizardDialog        *wizard,
  90                                      gint                      response_id,
  91                                      gpointer                  unused);
  92
  93 static void make_buttons_sensitive  (ModestWizardDialog *wizard_dialog,
  94                                      gboolean           previous,
  95                                      gboolean           finish,
  96                                      gboolean next);
  97
  98 static gboolean invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog);
  99 static void invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog);
 100 static void invoke_update_model_vfunc (ModestWizardDialog *wizard_dialog);
 101 static gboolean invoke_save_vfunc (ModestWizardDialog *wizard_dialog);
 102
 103 enum {
 104     PROP_ZERO,
 105     PROP_WIZARD_NAME,
 106     PROP_WIZARD_NOTEBOOK,
 107     PROP_WIZARD_AUTOTITLE
 108 };
 109
 110 struct _ModestWizardDialogPrivate {
 111     gchar       *wizard_name;
 112     GtkNotebook *notebook;
 113     GtkBox      *box;
 114     GtkWidget   *image;
 115     gboolean    autotitle;
 116
 117     ModestWizardDialogResponseOverrideFunc override_func;
 118 };
 119
 120
 121 GType
 122 modest_wizard_dialog_get_type (void)
 123 {
 124     static GType wizard_dialog_type = 0;
 125
 126     if (!wizard_dialog_type) {
 127
 128         static const GTypeInfo wizard_dialog_info = {
 129             sizeof (ModestWizardDialogClass),
 130             NULL,       /* base_init      */
 131             NULL,       /* base_finalize  */
 132             (GClassInitFunc) class_init,
 133             NULL,       /* class_finalize */
 134             NULL,       /* class_data     */
 135             sizeof (ModestWizardDialog),
 136             0,          /* n_preallocs    */
 137             (GInstanceInitFunc) init,
 138         };
 139
 140         wizard_dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
 141                                                      "ModestWizardDialog",
 142                                                      &wizard_dialog_info,
 143                                                      0);
 144     }
 145
 146     return wizard_dialog_type;
 147 }
 148
 149 static void
 150 class_init (ModestWizardDialogClass *wizard_dialog_class)
 151 {
 152     GObjectClass *object_class = G_OBJECT_CLASS (wizard_dialog_class);
 153
 154     parent_class = g_type_class_peek_parent (wizard_dialog_class);
 155
 156     g_type_class_add_private (wizard_dialog_class,
 157                               sizeof(ModestWizardDialogPrivate));
 158
 159     /* Override virtual methods */
 160     object_class->set_property = set_property;
 161     object_class->get_property = get_property;
 162     object_class->finalize     = finalize;
 163
 164     wizard_dialog_class->before_next = NULL;
 165     wizard_dialog_class->update_model = NULL;
 166     wizard_dialog_class->save = NULL;
 167     wizard_dialog_class->enable_buttons = NULL;
 168
 169     /**
 170      * ModestWizardDialog:wizard-name:
 171      *
 172      * The name of the wizard.
 173      */
 174     g_object_class_install_property (object_class, PROP_WIZARD_NAME,
 175             g_param_spec_string
 176             ("wizard-name",
 177              "Wizard Name",
 178              "The name of the ModestWizardDialog",
 179              NULL,
 180              G_PARAM_READWRITE));
 181
 182     /**
 183      * ModestWizardDialog:wizard-notebook:
 184      *
 185      * The notebook object, which is used by the ModestWizardDialog.
 186      */
 187     g_object_class_install_property(object_class, PROP_WIZARD_NOTEBOOK,
 188             g_param_spec_object
 189             ("wizard-notebook",
 190              "Wizard Notebook",
 191              "GtkNotebook object to be used in the "
 192              "ModestWizardDialog",
 193              GTK_TYPE_NOTEBOOK, G_PARAM_READWRITE));
 194
 195     /**
 196      * ModestWizardDialog:autotitle
 197      *
 198      * If the wizard should automatically try to change the window title when changing steps.
 199      * Set to FALSE if you'd like to override the default behaviour.
 200      *
 201      * Since: 0.14.5
 202      */
 203     g_object_class_install_property(object_class, PROP_WIZARD_AUTOTITLE,
 204             g_param_spec_boolean
 205             ("autotitle",
 206              "AutoTitle",
 207              "If the wizard should autotitle itself",
 208              TRUE,
 209              G_PARAM_READWRITE));
 210 }
 211
 212 static void
 213 finalize (GObject *object)
 214 {
 215     ModestWizardDialog *dialog = MODEST_WIZARD_DIALOG (object);
 216     g_return_if_fail (dialog != NULL);
 217
 218     if (dialog->priv->wizard_name != NULL)
 219         g_free (MODEST_WIZARD_DIALOG (object)->priv->wizard_name);
 220
 221     if (G_OBJECT_CLASS (parent_class)->finalize)
 222         G_OBJECT_CLASS (parent_class)->finalize(object);
 223 }
 224
 225 /* Disable or enable the Previous, Next and Finish buttons */
 226 static void
 227 make_buttons_sensitive (ModestWizardDialog *wizard_dialog,
 228                         gboolean previous,
 229                         gboolean finish,
 230                         gboolean next)
 231 {
 232     gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
 233                                        MODEST_WIZARD_DIALOG_PREVIOUS,
 234                                        previous);
 235
 236     gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
 237                                        MODEST_WIZARD_DIALOG_FINISH,
 238                                        finish);
 239
 240     gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
 241                                        MODEST_WIZARD_DIALOG_NEXT,
 242                                        next);
 243 }
 244
 245 static void
 246 init (ModestWizardDialog *wizard_dialog)
 247 {
 248     /* Initialize private structure for faster member access */
 249     ModestWizardDialogPrivate *priv =
 250         G_TYPE_INSTANCE_GET_PRIVATE (wizard_dialog,
 251                 MODEST_TYPE_WIZARD_DIALOG,
 252                 ModestWizardDialogPrivate);
 253
 254     GtkDialog *dialog = GTK_DIALOG (wizard_dialog);
 255
 256     /* Init internal widgets */
 257     GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
 258     gtk_dialog_set_has_separator (dialog, FALSE);
 259     wizard_dialog->priv = priv;
 260     priv->override_func = NULL;
 261     priv->box = GTK_BOX (gtk_hbox_new (FALSE, 0));
 262 #ifdef MODEST_TOOLKIT_HILDON2
 263     priv->image = NULL;
 264 #else
 265 #ifdef MODEST_TOOLKIT_GTK
 266     priv->image = gtk_image_new_from_stock (GTK_STOCK_PREFERENCES, GTK_ICON_SIZE_DIALOG);
 267 #else /*MODEST_TOOLKIT_GTK*/
 268 #if MODEST_HILDON_API == 0
 269     priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
 270                                                 HILDON_ICON_SIZE_WIDG_WIZARD);
 271 #else
 272     static int icon_size = 0;
 273     if (!icon_size)
 274             icon_size = gtk_icon_size_register("modest_wizard", 50, 50);
 275     priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
 276                                                 icon_size);
 277 #endif /*MODEST_HILDON_API == 0*/
 278 #endif /*!MODEST_TOOLKIT_GTK*/
 279 #endif /*MODEST_TOOLKIT_HILDON2 */
 280     /* Default values for user provided properties */
 281     priv->notebook = NULL;
 282     priv->wizard_name = NULL;
 283     priv->autotitle = TRUE;
 284
 285     /* Build wizard layout */
 286     gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (priv->box));
 287     gtk_box_pack_start_defaults (GTK_BOX (priv->box), GTK_WIDGET (vbox));
 288     if (priv->image)
 289       gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (priv->image), FALSE, FALSE, 0);
 290
 291     /* Add response buttons: finish, previous, next, cancel */
 292 #ifdef MODEST_TOOLKIT_HILDON1
 293     gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_finish"), MODEST_WIZARD_DIALOG_FINISH);
 294     gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_previous"), MODEST_WIZARD_DIALOG_PREVIOUS);
 295     gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_next"), MODEST_WIZARD_DIALOG_NEXT);
 296     gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_cancel"), MODEST_WIZARD_DIALOG_CANCEL);
 297 #endif
 298 #ifdef MODEST_TOOLKIT_HILDON2
 299     gtk_dialog_add_button (dialog, _HL("wdgt_bd_finish"), MODEST_WIZARD_DIALOG_FINISH);
 300     gtk_dialog_add_button (dialog, _HL("wdgt_bd_previous"), MODEST_WIZARD_DIALOG_PREVIOUS);
 301     gtk_dialog_add_button (dialog, _HL("wdgt_bd_next"), MODEST_WIZARD_DIALOG_NEXT);
 302 #endif
 303 #ifdef MODEST_TOOLKIT_GTK
 304     gtk_dialog_add_button (dialog, GTK_STOCK_SAVE, MODEST_WIZARD_DIALOG_FINISH);
 305     gtk_dialog_add_button (dialog, GTK_STOCK_GO_BACK, MODEST_WIZARD_DIALOG_PREVIOUS);
 306     gtk_dialog_add_button (dialog, GTK_STOCK_GO_FORWARD, MODEST_WIZARD_DIALOG_NEXT);
 307     gtk_dialog_add_button (dialog, GTK_STOCK_CANCEL, MODEST_WIZARD_DIALOG_CANCEL);
 308 #endif
 309
 310     /* Set initial button states: previous and finish buttons are disabled */
 311     make_buttons_sensitive (wizard_dialog, FALSE, FALSE, TRUE);
 312
 313     /* Show all the internal widgets */
 314     gtk_widget_show_all (GTK_WIDGET (dialog->vbox));
 315
 316     /* connect to dialog's response signal */
 317     g_signal_connect (G_OBJECT (dialog), "response",
 318             G_CALLBACK (response), NULL);
 319
 320 }
 321
 322 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
 323 static void on_notebook_page_added(GtkNotebook *notebook,
 324                                    GtkWidget   *child,
 325                                    guint        page_num,
 326                                    gpointer     user_data)
 327 {
 328         ModestWizardDialog* dialog = NULL;
 329
 330         g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
 331         dialog = MODEST_WIZARD_DIALOG(user_data);
 332
 333         /* The title should show the total number of pages: */
 334         create_title (dialog);
 335 }
 336
 337 static void on_notebook_page_removed(GtkNotebook *notebook,
 338                                      GtkWidget   *child,
 339                                      guint        page_num,
 340                                      gpointer     user_data)
 341 {
 342         ModestWizardDialog* dialog = NULL;
 343
 344         g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
 345         dialog = MODEST_WIZARD_DIALOG(user_data);
 346
 347         /* The title should show the total number of pages: */
 348         create_title (dialog);
 349 }
 350 #endif /* GTK_CHECK_VERSION */
 351
 352 static void
 353 on_notebook_switch_page (GtkNotebook *notebook,
 354                          GtkNotebookPage *page,
 355                          guint page_num,
 356                          ModestWizardDialog *self)
 357 {
 358         g_return_if_fail (MODEST_IS_WIZARD_DIALOG(self));
 359
 360         create_title (self);
 361 }
 362
 363 static void
 364 connect_to_notebook_signals(ModestWizardDialog* dialog)
 365 {
 366 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
 367         ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(dialog)->priv;
 368         g_return_if_fail (priv->notebook);
 369
 370         /* Connect to the notebook signals,
 371          * so we can update the title when necessary: */
 372         g_signal_connect (G_OBJECT (priv->notebook), "page-added",
 373                       G_CALLBACK (on_notebook_page_added), dialog);
 374         g_signal_connect (G_OBJECT (priv->notebook), "page-removed",
 375                       G_CALLBACK (on_notebook_page_removed), dialog);
 376 #endif /* GTK_CHECK_VERSION */
 377         g_signal_connect_after (G_OBJECT (priv->notebook), "switch-page",
 378                                 G_CALLBACK (on_notebook_switch_page), dialog);
 379 }
 380
 381
 382 static void
 383 set_property (GObject      *object,
 384               guint        property_id,
 385               const GValue *value,
 386               GParamSpec   *pspec)
 387 {
 388     ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(object)->priv;
 389
 390     switch (property_id) {
 391
 392         case PROP_WIZARD_AUTOTITLE:
 393
 394             priv->autotitle = g_value_get_boolean (value);
 395
 396             if (priv->autotitle &&
 397                 priv->wizard_name &&
 398                 priv->notebook)
 399                 create_title (MODEST_WIZARD_DIALOG (object));
 400             else if (priv->wizard_name)
 401                 gtk_window_set_title (GTK_WINDOW (object), priv->wizard_name);
 402
 403             break;
 404
 405         case PROP_WIZARD_NAME:
 406
 407             /* Set new wizard name. This name will appear in titlebar */
 408             if (priv->wizard_name)
 409                 g_free (priv->wizard_name);
 410
 411             gchar *str = (gchar *) g_value_get_string (value);
 412             g_return_if_fail (str != NULL);
 413
 414             priv->wizard_name = g_strdup (str);
 415
 416             /* We need notebook in order to create title, since page information
 417                is used in title generation */
 418
 419             if (priv->notebook && priv->autotitle)
 420                 create_title (MODEST_WIZARD_DIALOG (object));
 421
 422             break;
 423
 424         case PROP_WIZARD_NOTEBOOK: {
 425
 426             GtkNotebook *book = GTK_NOTEBOOK (g_value_get_object (value));
 427             g_return_if_fail (book != NULL);
 428
 429             priv->notebook = book;
 430
 431             /* Set the default properties for the notebook (disable tabs,
 432              * and remove borders) to make it look like a nice wizard widget */
 433             gtk_notebook_set_show_tabs (priv->notebook, FALSE);
 434             gtk_notebook_set_show_border (priv->notebook, FALSE);
 435             gtk_box_pack_start_defaults (GTK_BOX( priv->box), GTK_WIDGET (priv->notebook));
 436
 437             /* Show the notebook so that a gtk_widget_show on the dialog is
 438              * all that is required to display the dialog correctly */
 439             gtk_widget_show ( GTK_WIDGET (priv->notebook));
 440
 441             /* Update dialog title to reflect current page stats etc */
 442             ModestWizardDialog *wizard_dialog = MODEST_WIZARD_DIALOG (object);
 443             if (priv->wizard_name && priv->autotitle)
 444                 create_title (wizard_dialog);
 445
 446             connect_to_notebook_signals (wizard_dialog);
 447
 448             }break;
 449
 450         default:
 451             G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 452             break;
 453     }
 454 }
 455
 456 static void
 457 get_property (GObject      *object,
 458               guint        property_id,
 459               GValue       *value,
 460               GParamSpec   *pspec)
 461 {
 462     ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG (object)->priv;
 463
 464     switch (property_id) {
 465
 466         case PROP_WIZARD_NAME:
 467             g_value_set_string (value, priv->wizard_name);
 468             break;
 469
 470         case PROP_WIZARD_NOTEBOOK:
 471             g_value_set_object (value, priv->notebook);
 472             break;
 473
 474         default:
 475             G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 476             break;
 477     }
 478 }
 479
 480 /*
 481  * Creates the title of the dialog taking into account the current
 482  * page of the notebook.
 483  */
 484 static void
 485 create_title (ModestWizardDialog *wizard_dialog)
 486 {
 487     gchar *str = NULL;
 488     ModestWizardDialogPrivate *priv = NULL;
 489     GtkNotebook *notebook = NULL;
 490
 491     g_return_if_fail (MODEST_IS_WIZARD_DIALOG(wizard_dialog));
 492     g_return_if_fail (wizard_dialog->priv != NULL);
 493
 494     priv = wizard_dialog->priv;
 495     notebook = priv->notebook;
 496
 497     if (!notebook)
 498         return;
 499
 500     /* Get page information, we'll need that when creating title */
 501     gint pages = gtk_notebook_get_n_pages (notebook);
 502     if (pages == 0)
 503       return;
 504
 505     gint current = gtk_notebook_get_current_page (priv->notebook);
 506     if (current < 0)
 507         current = 0;
 508
 509     /* the welcome title on the initial page */
 510     /* This is the standard wizard title, with, e.g., 1/4 at the end,
 511          * but the Modest UI spec does not want this. */
 512         /*
 513     if (current == 0) {
 514         str = g_strdup_printf (_HL("ecdg_ti_wizard_welcome"),
 515                 priv->wizard_name, pages);
 516     } else {
 517     */
 518         const gchar *steps = gtk_notebook_get_tab_label_text (notebook,
 519                 gtk_notebook_get_nth_page (notebook, current));
 520
 521                 /* This is the standard wizard title, with, e.g., 1/4 at the end,
 522                  * but the Modest UI spec does not want this.
 523                  */
 524                 /*
 525         str = g_strdup_printf (_HL("ecdg_ti_wizard_step"),
 526                 priv->wizard_name, current + 1, pages, steps);
 527         */
 528
 529         str = g_strdup_printf ((steps&&*steps)?_HL("%s: %s"):_HL("%s"),
 530                 priv->wizard_name, steps);
 531     /* } */
 532
 533     /* Update the dialog to display the generated title */
 534     gtk_window_set_title (GTK_WINDOW (wizard_dialog), str);
 535     g_free (str);
 536 }
 537
 538 /*
 539  * Response signal handler. This function is needed because GtkDialog's
 540  * handler for this signal closes the dialog and we don't want that, we
 541  * want to change pages and, dim certain response buttons. Overriding the
 542  * virtual function would not work because that would be called after the
 543  * signal handler implemented by GtkDialog.
 544  * FIXME: There is a much saner way to do that [MDK]
 545  */
 546 static void
 547 response (ModestWizardDialog   *wizard_dialog,
 548           gint                 response_id,
 549           gpointer             unused)
 550 {
 551     ModestWizardDialogPrivate *priv = wizard_dialog->priv;
 552     GtkNotebook *notebook = priv->notebook;
 553     gint current = 0;
 554     gboolean is_first, is_last;
 555
 556     if (priv->override_func) {
 557             if (priv->override_func (wizard_dialog, response_id, gtk_notebook_get_current_page (notebook))) {
 558                     /* Don't let the dialog close */
 559                     g_signal_stop_emission_by_name (wizard_dialog, "response");
 560
 561                     /* Force refresh of title */
 562                     if (priv->autotitle)
 563                             create_title (wizard_dialog);
 564                     return;
 565             }
 566     }
 567
 568     switch (response_id) {
 569
 570         case MODEST_WIZARD_DIALOG_PREVIOUS:
 571             gtk_notebook_prev_page (notebook); /* go to previous page */
 572             break;
 573
 574         case MODEST_WIZARD_DIALOG_NEXT:
 575                 if (invoke_before_next_vfunc (wizard_dialog))
 576                         gtk_notebook_next_page (notebook); /* go to next page */
 577
 578             break;
 579
 580         case MODEST_WIZARD_DIALOG_CANCEL:
 581                 return;
 582                 break;
 583         case MODEST_WIZARD_DIALOG_FINISH:
 584                 if (invoke_before_next_vfunc (wizard_dialog))
 585                 return;
 586
 587             break;
 588
 589     }
 590
 591     current = gtk_notebook_get_current_page (notebook);
 592     gint last = gtk_notebook_get_n_pages (notebook) - 1;
 593     is_last = current == last;
 594     is_first = current == 0;
 595
 596     /* If first page, previous and finish are disabled,
 597        if last page, next is disabled */
 598     make_buttons_sensitive (wizard_dialog,
 599                             (is_first) ? FALSE : TRUE,
 600                             TRUE,
 601                             (is_last) ? FALSE : TRUE);
 602
 603     /* Allow derived classes to disable buttons to prevent navigation,
 604      * according to their own validation logic: */
 605     invoke_enable_buttons_vfunc (wizard_dialog);
 606
 607     /* Don't let the dialog close */
 608     g_signal_stop_emission_by_name (wizard_dialog, "response");
 609
 610     /* We show the default image on first and last pages */
 611     last = gtk_notebook_get_n_pages (notebook) - 1;
 612     if (priv->image) {
 613             if (current == last || current == 0)
 614                     gtk_widget_show (GTK_WIDGET(priv->image));
 615             else
 616                     gtk_widget_hide (GTK_WIDGET(priv->image));
 617     }
 618
 619     /* New page number may appear in the title, update it */
 620     if (priv->autotitle)
 621         create_title (wizard_dialog);
 622 }
 623
 624 /**
 625  * modest_wizard_dialog_new:
 626  * @parent: a #GtkWindow
 627  * @wizard_name: the name of dialog
 628  * @notebook: the notebook to be shown on the dialog
 629  *
 630  * Creates a new #ModestWizardDialog.
 631  *
 632  * Returns: a new #ModestWizardDialog
 633  */
 634 GtkWidget*
 635 modest_wizard_dialog_new (GtkWindow   *parent,
 636                           const char  *wizard_name,
 637                           GtkNotebook *notebook)
 638 {
 639     GtkWidget *widget;
 640
 641     g_return_val_if_fail (GTK_IS_NOTEBOOK (notebook), NULL);
 642
 643     widget = GTK_WIDGET (g_object_new
 644             (MODEST_TYPE_WIZARD_DIALOG,
 645              "wizard-name", wizard_name,
 646              "wizard-notebook", notebook, NULL));
 647
 648     if (parent)
 649         gtk_window_set_transient_for (GTK_WINDOW (widget), parent);
 650
 651     return widget;
 652 }
 653
 654 /**
 655  * modest_wizard_dialog_force_title_update:
 656  * @wizard_dialog: The wizard dialog
 657  *
 658  * Force the title to be rebuilt, for instance when you have added or
 659  * removed notebook pages. This function is not necessary when using GTK+ 2.10,
 660  * because that has GtkNotebook signals that will be used to update the title
 661  * automatically.
 662  */
 663 void
 664 modest_wizard_dialog_force_title_update (ModestWizardDialog   *wizard_dialog)
 665 {
 666         create_title (wizard_dialog);
 667 }
 668
 669 static gboolean
 670 invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog)
 671 {
 672         ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
 673
 674         /* Call the vfunc, which may be overridden by derived classes: */
 675         if (klass->before_next) {
 676                 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
 677
 678                 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
 679
 680                 /* Get widgets for the two pages: */
 681                 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
 682
 683                 GtkWidget* next_page_widget = NULL;
 684                 if ((current_page_num + 1) < gtk_notebook_get_n_pages (priv->notebook))
 685                         next_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num + 1);
 686
 687                 MODEST_DEBUG_BLOCK (
 688                 g_debug ("Switching to page %d (%s)",
 689                          gtk_notebook_page_num (priv->notebook, next_page_widget),
 690                          gtk_notebook_get_tab_label_text (priv->notebook, next_page_widget));
 691
 692                 {
 693                         GtkWidget *p;
 694                         gint i;
 695                         g_debug ("\t***************");
 696                         for (i=0; i<gtk_notebook_get_n_pages(priv->notebook);i++) {
 697                                 p = gtk_notebook_get_nth_page (priv->notebook, i);
 698                                 g_debug ("\t%d - %s", i, gtk_notebook_get_tab_label_text (priv->notebook, p));
 699                         }
 700                         g_debug ("\t***************");
 701                 }
 702                                     );
 703
 704                 /* Ask the vfunc implementation whether navigation should be allowed: */
 705                 return (*(klass->before_next))(wizard_dialog, current_page_widget, next_page_widget);
 706         }
 707
 708         /* Allow navigation by default if there is no vfunc implementation: */
 709         return TRUE;
 710 }
 711
 712 static void
 713 invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog)
 714 {
 715         ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
 716
 717         /* Call the vfunc, which may be overridden by derived classes: */
 718         if (klass->enable_buttons) {
 719                 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
 720
 721                 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
 722
 723                 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
 724
 725                 (*(klass->enable_buttons))(wizard_dialog, current_page_widget);
 726         }
 727 }
 728
 729 static void
 730 invoke_update_model_vfunc (ModestWizardDialog *wizard_dialog)
 731 {
 732         ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
 733
 734         /* Call the vfunc, which may be overridden by derived classes: */
 735         if (klass->update_model) {
 736                 (*(klass->update_model)) (wizard_dialog);
 737         }
 738 }
 739
 740 static gboolean
 741 invoke_save_vfunc (ModestWizardDialog *wizard_dialog)
 742 {
 743         ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
 744
 745         /* Call the vfunc, which may be overridden by derived classes: */
 746         if (klass->save) {
 747                 return (*(klass->save)) (wizard_dialog);
 748         } else {
 749                 return TRUE;
 750         }
 751 }
 752
 753 void
 754 modest_wizard_dialog_set_response_override_handler (ModestWizardDialog *wizard_dialog,
 755                                                     ModestWizardDialogResponseOverrideFunc callback)
 756 {
 757     ModestWizardDialogPrivate *priv = wizard_dialog->priv;
 758
 759     priv->override_func = callback;
 760 }
 761
 762 void
 763 modest_wizard_dialog_update_model (ModestWizardDialog *wizard_dialog)
 764 {
 765         g_return_if_fail (MODEST_IS_WIZARD_DIALOG (wizard_dialog));
 766
 767         invoke_update_model_vfunc (wizard_dialog);
 768 }
 769
 770 gboolean
 771 modest_wizard_dialog_save (ModestWizardDialog *wizard_dialog)
 772 {
 773         g_return_val_if_fail (MODEST_IS_WIZARD_DIALOG (wizard_dialog), FALSE);
 774
 775         return invoke_save_vfunc (wizard_dialog);
 776 }