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 * SECTION:modest-wizard-dialog
32 * @short_description: A widget to create a guided installation
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.
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>
57 #ifndef MODEST_TOOLKIT_GTK
58 #if MODEST_HILDON_API == 0
59 #include <hildon-widgets/hildon-defines.h>
61 #include <hildon/hildon-defines.h>
62 #endif /*MODEST_HILDON_API == 0*/
63 #endif /*!MODEST_TOOLKIT_GTK*/
65 #include "modest-wizard-dialog.h"
66 #include "modest-debug.h"
67 #include "modest-text-utils.h"
69 static GtkDialogClass *parent_class;
71 static void class_init (ModestWizardDialogClass *wizard_dialog_class);
73 static void init (ModestWizardDialog *wizard_dialog);
75 static void create_title (ModestWizardDialog *wizard_dialog);
77 static void set_property (GObject *object,
82 static void get_property (GObject *object,
87 static void finalize (GObject *object);
89 static void response (ModestWizardDialog *wizard,
93 static void make_buttons_sensitive (ModestWizardDialog *wizard_dialog,
98 static gboolean invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog);
99 static void invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog);
104 PROP_WIZARD_NOTEBOOK,
105 PROP_WIZARD_AUTOTITLE
108 struct _ModestWizardDialogPrivate {
110 GtkNotebook *notebook;
115 ModestWizardDialogResponseOverrideFunc override_func;
120 modest_wizard_dialog_get_type (void)
122 static GType wizard_dialog_type = 0;
124 if (!wizard_dialog_type) {
126 static const GTypeInfo wizard_dialog_info = {
127 sizeof (ModestWizardDialogClass),
128 NULL, /* base_init */
129 NULL, /* base_finalize */
130 (GClassInitFunc) class_init,
131 NULL, /* class_finalize */
132 NULL, /* class_data */
133 sizeof (ModestWizardDialog),
135 (GInstanceInitFunc) init,
138 wizard_dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
139 "ModestWizardDialog",
144 return wizard_dialog_type;
148 class_init (ModestWizardDialogClass *wizard_dialog_class)
150 GObjectClass *object_class = G_OBJECT_CLASS (wizard_dialog_class);
152 parent_class = g_type_class_peek_parent (wizard_dialog_class);
154 g_type_class_add_private (wizard_dialog_class,
155 sizeof(ModestWizardDialogPrivate));
157 /* Override virtual methods */
158 object_class->set_property = set_property;
159 object_class->get_property = get_property;
160 object_class->finalize = finalize;
163 * ModestWizardDialog:wizard-name:
165 * The name of the wizard.
167 g_object_class_install_property (object_class, PROP_WIZARD_NAME,
171 "The name of the ModestWizardDialog",
176 * ModestWizardDialog:wizard-notebook:
178 * The notebook object, which is used by the ModestWizardDialog.
180 g_object_class_install_property(object_class, PROP_WIZARD_NOTEBOOK,
184 "GtkNotebook object to be used in the "
185 "ModestWizardDialog",
186 GTK_TYPE_NOTEBOOK, G_PARAM_READWRITE));
189 * ModestWizardDialog:autotitle
191 * If the wizard should automatically try to change the window title when changing steps.
192 * Set to FALSE if you'd like to override the default behaviour.
196 g_object_class_install_property(object_class, PROP_WIZARD_AUTOTITLE,
200 "If the wizard should autotitle itself",
206 finalize (GObject *object)
208 ModestWizardDialog *dialog = MODEST_WIZARD_DIALOG (object);
209 g_return_if_fail (dialog != NULL);
211 if (dialog->priv->wizard_name != NULL)
212 g_free (MODEST_WIZARD_DIALOG (object)->priv->wizard_name);
214 if (G_OBJECT_CLASS (parent_class)->finalize)
215 G_OBJECT_CLASS (parent_class)->finalize(object);
218 /* Disable or enable the Previous, Next and Finish buttons */
220 make_buttons_sensitive (ModestWizardDialog *wizard_dialog,
225 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
226 MODEST_WIZARD_DIALOG_PREVIOUS,
229 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
230 MODEST_WIZARD_DIALOG_FINISH,
233 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
234 MODEST_WIZARD_DIALOG_NEXT,
239 init (ModestWizardDialog *wizard_dialog)
241 /* Initialize private structure for faster member access */
242 ModestWizardDialogPrivate *priv =
243 G_TYPE_INSTANCE_GET_PRIVATE (wizard_dialog,
244 MODEST_TYPE_WIZARD_DIALOG,
245 ModestWizardDialogPrivate);
247 GtkDialog *dialog = GTK_DIALOG (wizard_dialog);
249 /* Init internal widgets */
250 GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
251 gtk_dialog_set_has_separator (dialog, FALSE);
252 wizard_dialog->priv = priv;
253 priv->override_func = NULL;
254 priv->box = GTK_BOX (gtk_hbox_new (FALSE, 0));
255 #ifdef MODEST_TOOLKIT_HILDON2
258 #ifdef MODEST_TOOLKIT_GTK
259 priv->image = gtk_image_new_from_stock (GTK_STOCK_PREFERENCES, GTK_ICON_SIZE_DIALOG);
260 #else /*MODEST_TOOLKIT_GTK*/
261 #if MODEST_HILDON_API == 0
262 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
263 HILDON_ICON_SIZE_WIDG_WIZARD);
265 static int icon_size = 0;
267 icon_size = gtk_icon_size_register("modest_wizard", 50, 50);
268 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
270 #endif /*MODEST_HILDON_API == 0*/
271 #endif /*!MODEST_TOOLKIT_GTK*/
272 #endif /*MODEST_TOOLKIT_HILDON2 */
273 /* Default values for user provided properties */
274 priv->notebook = NULL;
275 priv->wizard_name = NULL;
276 priv->autotitle = TRUE;
278 /* Build wizard layout */
279 gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (priv->box));
280 gtk_box_pack_start_defaults (GTK_BOX (priv->box), GTK_WIDGET (vbox));
282 gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (priv->image), FALSE, FALSE, 0);
284 /* Add response buttons: finish, previous, next, cancel */
285 #ifdef MODEST_TOOLKIT_HILDON1
286 gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_finish"), MODEST_WIZARD_DIALOG_FINISH);
287 gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_previous"), MODEST_WIZARD_DIALOG_PREVIOUS);
288 gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_next"), MODEST_WIZARD_DIALOG_NEXT);
289 gtk_dialog_add_button (dialog, _HL("ecdg_bd_wizard_cancel"), MODEST_WIZARD_DIALOG_CANCEL);
291 #ifdef MODEST_TOOLKIT_HILDON2
292 gtk_dialog_add_button (dialog, _HL("wdgt_bd_finish"), MODEST_WIZARD_DIALOG_FINISH);
293 gtk_dialog_add_button (dialog, _HL("wdgt_bd_previous"), MODEST_WIZARD_DIALOG_PREVIOUS);
294 gtk_dialog_add_button (dialog, _HL("wdgt_bd_next"), MODEST_WIZARD_DIALOG_NEXT);
296 #ifdef MODEST_TOOLKIT_GTK
297 gtk_dialog_add_button (dialog, GTK_STOCK_SAVE, MODEST_WIZARD_DIALOG_FINISH);
298 gtk_dialog_add_button (dialog, GTK_STOCK_GO_BACK, MODEST_WIZARD_DIALOG_PREVIOUS);
299 gtk_dialog_add_button (dialog, GTK_STOCK_GO_FORWARD, MODEST_WIZARD_DIALOG_NEXT);
300 gtk_dialog_add_button (dialog, GTK_STOCK_CANCEL, MODEST_WIZARD_DIALOG_CANCEL);
303 /* Set initial button states: previous and finish buttons are disabled */
304 make_buttons_sensitive (wizard_dialog, FALSE, FALSE, TRUE);
306 /* Show all the internal widgets */
307 gtk_widget_show_all (GTK_WIDGET (dialog->vbox));
309 /* connect to dialog's response signal */
310 g_signal_connect (G_OBJECT (dialog), "response",
311 G_CALLBACK (response), NULL);
314 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
315 static void on_notebook_page_added(GtkNotebook *notebook,
320 ModestWizardDialog* dialog = NULL;
322 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
323 dialog = MODEST_WIZARD_DIALOG(user_data);
325 /* The title should show the total number of pages: */
326 create_title (dialog);
329 static void on_notebook_page_removed(GtkNotebook *notebook,
334 ModestWizardDialog* dialog = NULL;
336 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
337 dialog = MODEST_WIZARD_DIALOG(user_data);
339 /* The title should show the total number of pages: */
340 create_title (dialog);
342 #endif /* GTK_CHECK_VERSION */
345 connect_to_notebook_signals(ModestWizardDialog* dialog)
347 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
348 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(dialog)->priv;
349 g_return_if_fail (priv->notebook);
351 /* Connect to the notebook signals,
352 * so we can update the title when necessary: */
353 g_signal_connect (G_OBJECT (priv->notebook), "page-added",
354 G_CALLBACK (on_notebook_page_added), dialog);
355 g_signal_connect (G_OBJECT (priv->notebook), "page-removed",
356 G_CALLBACK (on_notebook_page_removed), dialog);
357 #endif /* GTK_CHECK_VERSION */
362 set_property (GObject *object,
367 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(object)->priv;
369 switch (property_id) {
371 case PROP_WIZARD_AUTOTITLE:
373 priv->autotitle = g_value_get_boolean (value);
375 if (priv->autotitle &&
378 create_title (MODEST_WIZARD_DIALOG (object));
379 else if (priv->wizard_name)
380 gtk_window_set_title (GTK_WINDOW (object), priv->wizard_name);
384 case PROP_WIZARD_NAME:
386 /* Set new wizard name. This name will appear in titlebar */
387 if (priv->wizard_name)
388 g_free (priv->wizard_name);
390 gchar *str = (gchar *) g_value_get_string (value);
391 g_return_if_fail (str != NULL);
393 priv->wizard_name = g_strdup (str);
395 /* We need notebook in order to create title, since page information
396 is used in title generation */
398 if (priv->notebook && priv->autotitle)
399 create_title (MODEST_WIZARD_DIALOG (object));
403 case PROP_WIZARD_NOTEBOOK: {
405 GtkNotebook *book = GTK_NOTEBOOK (g_value_get_object (value));
406 g_return_if_fail (book != NULL);
408 priv->notebook = book;
410 /* Set the default properties for the notebook (disable tabs,
411 * and remove borders) to make it look like a nice wizard widget */
412 gtk_notebook_set_show_tabs (priv->notebook, FALSE);
413 gtk_notebook_set_show_border (priv->notebook, FALSE);
414 gtk_box_pack_start_defaults (GTK_BOX( priv->box), GTK_WIDGET (priv->notebook));
416 /* Show the notebook so that a gtk_widget_show on the dialog is
417 * all that is required to display the dialog correctly */
418 gtk_widget_show ( GTK_WIDGET (priv->notebook));
420 /* Update dialog title to reflect current page stats etc */
421 ModestWizardDialog *wizard_dialog = MODEST_WIZARD_DIALOG (object);
422 if (priv->wizard_name && priv->autotitle)
423 create_title (wizard_dialog);
425 connect_to_notebook_signals (wizard_dialog);
430 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
436 get_property (GObject *object,
441 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG (object)->priv;
443 switch (property_id) {
445 case PROP_WIZARD_NAME:
446 g_value_set_string (value, priv->wizard_name);
449 case PROP_WIZARD_NOTEBOOK:
450 g_value_set_object (value, priv->notebook);
454 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
460 * Creates the title of the dialog taking into account the current
461 * page of the notebook.
464 create_title (ModestWizardDialog *wizard_dialog)
467 ModestWizardDialogPrivate *priv = NULL;
468 GtkNotebook *notebook = NULL;
470 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(wizard_dialog));
471 g_return_if_fail (wizard_dialog->priv != NULL);
473 priv = wizard_dialog->priv;
474 notebook = priv->notebook;
479 /* Get page information, we'll need that when creating title */
480 gint pages = gtk_notebook_get_n_pages (notebook);
484 gint current = gtk_notebook_get_current_page (priv->notebook);
488 /* the welcome title on the initial page */
489 /* This is the standard wizard title, with, e.g., 1/4 at the end,
490 * but the Modest UI spec does not want this. */
493 str = g_strdup_printf (_HL("ecdg_ti_wizard_welcome"),
494 priv->wizard_name, pages);
497 const gchar *steps = gtk_notebook_get_tab_label_text (notebook,
498 gtk_notebook_get_nth_page (notebook, current));
500 /* This is the standard wizard title, with, e.g., 1/4 at the end,
501 * but the Modest UI spec does not want this.
504 str = g_strdup_printf (_HL("ecdg_ti_wizard_step"),
505 priv->wizard_name, current + 1, pages, steps);
508 str = g_strdup_printf ((steps&&*steps)?_HL("%s: %s"):_HL("%s"),
509 priv->wizard_name, steps);
512 /* Update the dialog to display the generated title */
513 gtk_window_set_title (GTK_WINDOW (wizard_dialog), str);
518 * Response signal handler. This function is needed because GtkDialog's
519 * handler for this signal closes the dialog and we don't want that, we
520 * want to change pages and, dim certain response buttons. Overriding the
521 * virtual function would not work because that would be called after the
522 * signal handler implemented by GtkDialog.
523 * FIXME: There is a much saner way to do that [MDK]
526 response (ModestWizardDialog *wizard_dialog,
530 ModestWizardDialogPrivate *priv = wizard_dialog->priv;
531 GtkNotebook *notebook = priv->notebook;
533 gboolean is_first, is_last;
535 if (priv->override_func) {
536 priv->override_func (wizard_dialog, response_id, gtk_notebook_get_current_page (notebook));
539 switch (response_id) {
541 case MODEST_WIZARD_DIALOG_PREVIOUS:
542 gtk_notebook_prev_page (notebook); /* go to previous page */
545 case MODEST_WIZARD_DIALOG_NEXT:
546 if (invoke_before_next_vfunc (wizard_dialog))
547 gtk_notebook_next_page (notebook); /* go to next page */
551 case MODEST_WIZARD_DIALOG_CANCEL:
554 case MODEST_WIZARD_DIALOG_FINISH:
555 if (invoke_before_next_vfunc (wizard_dialog))
562 current = gtk_notebook_get_current_page (notebook);
563 gint last = gtk_notebook_get_n_pages (notebook) - 1;
564 is_last = current == last;
565 is_first = current == 0;
567 /* If first page, previous and finish are disabled,
568 if last page, next is disabled */
569 make_buttons_sensitive (wizard_dialog,
570 (is_first) ? FALSE : TRUE,
572 (is_last) ? FALSE : TRUE);
574 /* Allow derived classes to disable buttons to prevent navigation,
575 * according to their own validation logic: */
576 invoke_enable_buttons_vfunc (wizard_dialog);
578 /* Don't let the dialog close */
579 g_signal_stop_emission_by_name (wizard_dialog, "response");
581 /* We show the default image on first and last pages */
582 last = gtk_notebook_get_n_pages (notebook) - 1;
584 if (current == last || current == 0)
585 gtk_widget_show (GTK_WIDGET(priv->image));
587 gtk_widget_hide (GTK_WIDGET(priv->image));
590 /* New page number may appear in the title, update it */
592 create_title (wizard_dialog);
596 * modest_wizard_dialog_new:
597 * @parent: a #GtkWindow
598 * @wizard_name: the name of dialog
599 * @notebook: the notebook to be shown on the dialog
601 * Creates a new #ModestWizardDialog.
603 * Returns: a new #ModestWizardDialog
606 modest_wizard_dialog_new (GtkWindow *parent,
607 const char *wizard_name,
608 GtkNotebook *notebook)
612 g_return_val_if_fail (GTK_IS_NOTEBOOK (notebook), NULL);
614 widget = GTK_WIDGET (g_object_new
615 (MODEST_TYPE_WIZARD_DIALOG,
616 "wizard-name", wizard_name,
617 "wizard-notebook", notebook, NULL));
620 gtk_window_set_transient_for (GTK_WINDOW (widget), parent);
626 * modest_wizard_dialog_force_title_update:
627 * @wizard_dialog: The wizard dialog
629 * Force the title to be rebuilt, for instance when you have added or
630 * removed notebook pages. This function is not necessary when using GTK+ 2.10,
631 * because that has GtkNotebook signals that will be used to update the title
635 modest_wizard_dialog_force_title_update (ModestWizardDialog *wizard_dialog)
637 create_title (wizard_dialog);
641 invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog)
643 ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
645 /* Call the vfunc, which may be overridden by derived classes: */
646 if (klass->before_next) {
647 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
649 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
651 /* Get widgets for the two pages: */
652 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
654 GtkWidget* next_page_widget = NULL;
655 if ((current_page_num + 1) < gtk_notebook_get_n_pages (priv->notebook))
656 next_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num + 1);
659 g_debug ("Switching to page %d (%s)",
660 gtk_notebook_page_num (priv->notebook, next_page_widget),
661 gtk_notebook_get_tab_label_text (priv->notebook, next_page_widget));
666 g_debug ("\t***************");
667 for (i=0; i<gtk_notebook_get_n_pages(priv->notebook);i++) {
668 p = gtk_notebook_get_nth_page (priv->notebook, i);
669 g_debug ("\t%d - %s", i, gtk_notebook_get_tab_label_text (priv->notebook, p));
671 g_debug ("\t***************");
675 /* Ask the vfunc implementation whether navigation should be allowed: */
676 return (*(klass->before_next))(wizard_dialog, current_page_widget, next_page_widget);
679 /* Allow navigation by default if there is no vfunc implementation: */
684 invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog)
686 ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
688 /* Call the vfunc, which may be overridden by derived classes: */
689 if (klass->enable_buttons) {
690 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
692 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
694 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
696 (*(klass->enable_buttons))(wizard_dialog, current_page_widget);
701 modest_wizard_dialog_set_response_override_handler (ModestWizardDialog *wizard_dialog,
702 ModestWizardDialogResponseOverrideFunc callback)
704 ModestWizardDialogPrivate *priv = wizard_dialog->priv;
706 priv->override_func = callback;