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 #ifdef MODEST_HILDON_VERSION_0
58 #include <hildon-widgets/hildon-defines.h>
60 #include <hildon/hildon-defines.h>
61 #endif /*MODEST_HILDON_VERSION_0*/
63 #include "modest-wizard-dialog.h"
67 /* Specify the hildon-libs translation domain,
68 * so we can reuse its translations
69 * instead of repeating them in our own translations.
71 /* #define _(String) dgettext(PACKAGE, String) */
73 #define _(String) dgettext("hildon-libs", String)
75 static GtkDialogClass *parent_class;
77 static void class_init (ModestWizardDialogClass *wizard_dialog_class);
79 static void init (ModestWizardDialog *wizard_dialog);
81 static void create_title (ModestWizardDialog *wizard_dialog);
83 static void set_property (GObject *object,
88 static void get_property (GObject *object,
93 static void finalize (GObject *object);
95 static void response (ModestWizardDialog *wizard,
99 static void make_buttons_sensitive (ModestWizardDialog *wizard_dialog,
104 static gboolean invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog);
105 static void invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog);
110 PROP_WIZARD_NOTEBOOK,
111 PROP_WIZARD_AUTOTITLE
114 struct _ModestWizardDialogPrivate {
116 GtkNotebook *notebook;
124 modest_wizard_dialog_get_type (void)
126 static GType wizard_dialog_type = 0;
128 if (!wizard_dialog_type) {
130 static const GTypeInfo wizard_dialog_info = {
131 sizeof (ModestWizardDialogClass),
132 NULL, /* base_init */
133 NULL, /* base_finalize */
134 (GClassInitFunc) class_init,
135 NULL, /* class_finalize */
136 NULL, /* class_data */
137 sizeof (ModestWizardDialog),
139 (GInstanceInitFunc) init,
142 wizard_dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
143 "ModestWizardDialog",
148 return wizard_dialog_type;
152 class_init (ModestWizardDialogClass *wizard_dialog_class)
154 GObjectClass *object_class = G_OBJECT_CLASS (wizard_dialog_class);
156 parent_class = g_type_class_peek_parent (wizard_dialog_class);
158 g_type_class_add_private (wizard_dialog_class,
159 sizeof(ModestWizardDialogPrivate));
161 /* Override virtual methods */
162 object_class->set_property = set_property;
163 object_class->get_property = get_property;
164 object_class->finalize = finalize;
167 * ModestWizardDialog:wizard-name:
169 * The name of the wizard.
171 g_object_class_install_property (object_class, PROP_WIZARD_NAME,
175 "The name of the ModestWizardDialog",
180 * ModestWizardDialog:wizard-notebook:
182 * The notebook object, which is used by the ModestWizardDialog.
184 g_object_class_install_property(object_class, PROP_WIZARD_NOTEBOOK,
188 "GtkNotebook object to be used in the "
189 "ModestWizardDialog",
190 GTK_TYPE_NOTEBOOK, G_PARAM_READWRITE));
193 * ModestWizardDialog:autotitle
195 * If the wizard should automatically try to change the window title when changing steps.
196 * Set to FALSE if you'd like to override the default behaviour.
200 g_object_class_install_property(object_class, PROP_WIZARD_AUTOTITLE,
204 "If the wizard should autotitle itself",
210 finalize (GObject *object)
212 ModestWizardDialog *dialog = MODEST_WIZARD_DIALOG (object);
213 g_return_if_fail (dialog != NULL);
215 if (dialog->priv->wizard_name != NULL)
216 g_free (MODEST_WIZARD_DIALOG (object)->priv->wizard_name);
218 if (G_OBJECT_CLASS (parent_class)->finalize)
219 G_OBJECT_CLASS (parent_class)->finalize(object);
222 /* Disable or enable the Previous, Next and Finish buttons */
224 make_buttons_sensitive (ModestWizardDialog *wizard_dialog,
229 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
230 MODEST_WIZARD_DIALOG_PREVIOUS,
233 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
234 MODEST_WIZARD_DIALOG_FINISH,
237 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
238 MODEST_WIZARD_DIALOG_NEXT,
243 init (ModestWizardDialog *wizard_dialog)
245 /* Initialize private structure for faster member access */
246 ModestWizardDialogPrivate *priv =
247 G_TYPE_INSTANCE_GET_PRIVATE (wizard_dialog,
248 MODEST_TYPE_WIZARD_DIALOG,
249 ModestWizardDialogPrivate);
251 GtkDialog *dialog = GTK_DIALOG (wizard_dialog);
253 /* Init internal widgets */
254 GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
255 gtk_dialog_set_has_separator (dialog, FALSE);
256 wizard_dialog->priv = priv;
257 priv->box = GTK_BOX (gtk_hbox_new (FALSE, 0));
258 #ifdef MODEST_HILDON_VERSION_0
259 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
260 HILDON_ICON_SIZE_WIDG_WIZARD);
262 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
263 HILDON_ICON_SIZE_WIZARD);
264 #endif /*MODEST_HILDON_VERSION_0*/
265 /* Default values for user provided properties */
266 priv->notebook = NULL;
267 priv->wizard_name = NULL;
268 priv->autotitle = TRUE;
270 /* Build wizard layout */
271 gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (priv->box));
272 gtk_box_pack_start_defaults (GTK_BOX (priv->box), GTK_WIDGET (vbox));
273 gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (priv->image), FALSE, FALSE, 0);
275 /* Add response buttons: finish, previous, next, cancel */
276 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_finish"), MODEST_WIZARD_DIALOG_FINISH);
277 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_previous"), MODEST_WIZARD_DIALOG_PREVIOUS);
278 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_next"), MODEST_WIZARD_DIALOG_NEXT);
279 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_cancel"), MODEST_WIZARD_DIALOG_CANCEL);
281 /* Set initial button states: previous and finish buttons are disabled */
282 make_buttons_sensitive (wizard_dialog, FALSE, FALSE, TRUE);
284 /* Show all the internal widgets */
285 gtk_widget_show_all (GTK_WIDGET (dialog->vbox));
287 /* connect to dialog's response signal */
288 g_signal_connect (G_OBJECT (dialog), "response",
289 G_CALLBACK (response), NULL);
292 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
293 static void on_notebook_page_added(GtkNotebook *notebook,
298 ModestWizardDialog* dialog = NULL;
300 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
301 dialog = MODEST_WIZARD_DIALOG(user_data);
303 /* The title should show the total number of pages: */
304 create_title (dialog);
307 static void on_notebook_page_removed(GtkNotebook *notebook,
312 ModestWizardDialog* dialog = NULL;
314 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(user_data));
315 dialog = MODEST_WIZARD_DIALOG(user_data);
317 /* The title should show the total number of pages: */
318 create_title (dialog);
320 #endif /* GTK_CHECK_VERSION */
323 connect_to_notebook_signals(ModestWizardDialog* dialog)
325 #if GTK_CHECK_VERSION(2, 10, 0) /* These signals were added in GTK+ 2.10: */
326 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(dialog)->priv;
327 g_return_if_fail (priv->notebook);
329 /* Connect to the notebook signals,
330 * so we can update the title when necessary: */
331 g_signal_connect (G_OBJECT (priv->notebook), "page-added",
332 G_CALLBACK (on_notebook_page_added), dialog);
333 g_signal_connect (G_OBJECT (priv->notebook), "page-removed",
334 G_CALLBACK (on_notebook_page_removed), dialog);
335 #endif /* GTK_CHECK_VERSION */
340 set_property (GObject *object,
345 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(object)->priv;
347 switch (property_id) {
349 case PROP_WIZARD_AUTOTITLE:
351 priv->autotitle = g_value_get_boolean (value);
353 if (priv->autotitle &&
356 create_title (MODEST_WIZARD_DIALOG (object));
357 else if (priv->wizard_name)
358 gtk_window_set_title (GTK_WINDOW (object), priv->wizard_name);
362 case PROP_WIZARD_NAME:
364 /* Set new wizard name. This name will appear in titlebar */
365 if (priv->wizard_name)
366 g_free (priv->wizard_name);
368 gchar *str = (gchar *) g_value_get_string (value);
369 g_return_if_fail (str != NULL);
371 priv->wizard_name = g_strdup (str);
373 /* We need notebook in order to create title, since page information
374 is used in title generation */
376 if (priv->notebook && priv->autotitle)
377 create_title (MODEST_WIZARD_DIALOG (object));
381 case PROP_WIZARD_NOTEBOOK: {
383 GtkNotebook *book = GTK_NOTEBOOK (g_value_get_object (value));
384 g_return_if_fail (book != NULL);
386 priv->notebook = book;
388 /* Set the default properties for the notebook (disable tabs,
389 * and remove borders) to make it look like a nice wizard widget */
390 gtk_notebook_set_show_tabs (priv->notebook, FALSE);
391 gtk_notebook_set_show_border (priv->notebook, FALSE);
392 gtk_box_pack_start_defaults (GTK_BOX( priv->box), GTK_WIDGET (priv->notebook));
394 /* Show the notebook so that a gtk_widget_show on the dialog is
395 * all that is required to display the dialog correctly */
396 gtk_widget_show ( GTK_WIDGET (priv->notebook));
398 /* Update dialog title to reflect current page stats etc */
399 ModestWizardDialog *wizard_dialog = MODEST_WIZARD_DIALOG (object);
400 if (priv->wizard_name && priv->autotitle)
401 create_title (wizard_dialog);
403 connect_to_notebook_signals (wizard_dialog);
408 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
414 get_property (GObject *object,
419 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG (object)->priv;
421 switch (property_id) {
423 case PROP_WIZARD_NAME:
424 g_value_set_string (value, priv->wizard_name);
427 case PROP_WIZARD_NOTEBOOK:
428 g_value_set_object (value, priv->notebook);
432 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
438 * Creates the title of the dialog taking into account the current
439 * page of the notebook.
442 create_title (ModestWizardDialog *wizard_dialog)
446 ModestWizardDialogPrivate *priv = NULL;
447 GtkNotebook *notebook = NULL;
449 g_return_if_fail (MODEST_IS_WIZARD_DIALOG(wizard_dialog));
450 g_return_if_fail (wizard_dialog->priv != NULL);
452 priv = wizard_dialog->priv;
453 notebook = priv->notebook;
458 /* Get page information, we'll need that when creating title */
459 pages = gtk_notebook_get_n_pages (notebook);
460 current = gtk_notebook_get_current_page (priv->notebook);
464 /* the welcome title on the initial page */
466 str = g_strdup_printf (_("ecdg_ti_wizard_welcome"),
467 priv->wizard_name, pages);
469 const gchar *steps = gtk_notebook_get_tab_label_text (notebook,
470 gtk_notebook_get_nth_page (notebook, current));
472 str = g_strdup_printf (_("ecdg_ti_wizard_step"),
473 priv->wizard_name, current + 1, pages, steps);
476 /* Update the dialog to display the generated title */
477 gtk_window_set_title (GTK_WINDOW (wizard_dialog), str);
482 * Response signal handler. This function is needed because GtkDialog's
483 * handler for this signal closes the dialog and we don't want that, we
484 * want to change pages and, dim certain response buttons. Overriding the
485 * virtual function would not work because that would be called after the
486 * signal handler implemented by GtkDialog.
487 * FIXME: There is a much saner way to do that [MDK]
490 response (ModestWizardDialog *wizard_dialog,
494 ModestWizardDialogPrivate *priv = wizard_dialog->priv;
495 GtkNotebook *notebook = priv->notebook;
497 gboolean is_first, is_last;
499 switch (response_id) {
501 case MODEST_WIZARD_DIALOG_PREVIOUS:
502 gtk_notebook_prev_page (notebook); /* go to previous page */
505 case MODEST_WIZARD_DIALOG_NEXT:
506 if (invoke_before_next_vfunc (wizard_dialog))
507 gtk_notebook_next_page (notebook); /* go to next page */
511 case MODEST_WIZARD_DIALOG_CANCEL:
514 case MODEST_WIZARD_DIALOG_FINISH:
515 if (invoke_before_next_vfunc (wizard_dialog))
522 current = gtk_notebook_get_current_page (notebook);
523 gint last = gtk_notebook_get_n_pages (notebook) - 1;
524 is_last = current == last;
525 is_first = current == 0;
527 /* If first page, previous and finish are disabled,
528 if last page, next is disabled */
529 make_buttons_sensitive (wizard_dialog,
530 !is_first /* previous */, !is_first /* finish */, !is_last /* next*/);
532 /* Allow derived classes to disable buttons to prevent navigation,
533 * according to their own validation logic: */
534 invoke_enable_buttons_vfunc (wizard_dialog);
536 /* Don't let the dialog close */
537 g_signal_stop_emission_by_name (wizard_dialog, "response");
539 /* We show the default image on first and last pages */
540 last = gtk_notebook_get_n_pages (notebook) - 1;
541 if (current == last || current == 0)
542 gtk_widget_show (GTK_WIDGET(priv->image));
544 gtk_widget_hide (GTK_WIDGET(priv->image));
546 /* New page number may appear in the title, update it */
548 create_title (wizard_dialog);
552 * modest_wizard_dialog_new:
553 * @parent: a #GtkWindow
554 * @wizard_name: the name of dialog
555 * @notebook: the notebook to be shown on the dialog
557 * Creates a new #ModestWizardDialog.
559 * Returns: a new #ModestWizardDialog
562 modest_wizard_dialog_new (GtkWindow *parent,
563 const char *wizard_name,
564 GtkNotebook *notebook)
568 g_return_val_if_fail (GTK_IS_NOTEBOOK (notebook), NULL);
570 widget = GTK_WIDGET (g_object_new
571 (MODEST_TYPE_WIZARD_DIALOG,
572 "wizard-name", wizard_name,
573 "wizard-notebook", notebook, NULL));
576 gtk_window_set_transient_for (GTK_WINDOW (widget), parent);
582 * modest_wizard_dialog_force_title_update:
583 * @wizard_dialog: The wizard dialog
585 * Force the title to be rebuilt, for instance when you have added or
586 * removed notebook pages. This function is not necessary when using GTK+ 2.10,
587 * because that has GtkNotebook signals that will be used to update the title
591 modest_wizard_dialog_force_title_update (ModestWizardDialog *wizard_dialog)
593 create_title (wizard_dialog);
597 invoke_before_next_vfunc (ModestWizardDialog *wizard_dialog)
599 ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
601 /* Call the vfunc, which may be overridden by derived classes: */
602 if (klass->before_next) {
603 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
605 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
607 /* Get widgets for the two pages: */
608 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
610 GtkWidget* next_page_widget = NULL;
611 if ((current_page_num + 1) < gtk_notebook_get_n_pages (priv->notebook))
612 next_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num + 1);
614 /* Ask the vfunc implementation whether navigation should be allowed: */
615 return (*(klass->before_next))(wizard_dialog, current_page_widget, next_page_widget);
618 /* Allow navigation by default if there is no vfunc implementation: */
623 invoke_enable_buttons_vfunc (ModestWizardDialog *wizard_dialog)
625 ModestWizardDialogClass *klass = MODEST_WIZARD_DIALOG_GET_CLASS (wizard_dialog);
627 /* Call the vfunc, which may be overridden by derived classes: */
628 if (klass->enable_buttons) {
629 ModestWizardDialogPrivate *priv = MODEST_WIZARD_DIALOG(wizard_dialog)->priv;
631 gint current_page_num = gtk_notebook_get_current_page (priv->notebook);
633 GtkWidget* current_page_widget = gtk_notebook_get_nth_page (priv->notebook, current_page_num);
635 (*(klass->enable_buttons))(wizard_dialog, current_page_widget);