2 * This file is part of hildon-libs
4 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
6 * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
7 * Fixes: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; version 2.1 of
12 * the License or any later version.
14 * This library is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
27 * SECTION:hildon-wizard-dialog
28 * @short_description: A widget to create a guided installation
31 * #HildonWizardDialog is a widget to create a guided installation
32 * process. The dialog has four standard buttons, previous, next,
33 * finish, cancel, and contains several pages with optional icons.
34 * Response buttons are dimmed/undimmed automatically and the standard
35 * icon is shown/hidden in response to page navigation. The notebook
36 * widget provided by users contains the actual wizard pages.
39 #include <gtk/gtkdialog.h>
40 #include <gtk/gtknotebook.h>
41 #include <gtk/gtkimage.h>
42 #include <gtk/gtkbox.h>
43 #include <gtk/gtkhbox.h>
44 #include <gtk/gtkvbox.h>
45 #include <gtk/gtkbutton.h>
46 #include <hildon-widgets/hildon-defines.h>
48 #include "hildon-wizard-dialog.h"
56 #define _(String) dgettext(PACKAGE, String)
58 static GtkDialogClass *parent_class;
60 static void class_init (HildonWizardDialogClass *wizard_dialog_class);
62 static void init (HildonWizardDialog *wizard_dialog);
64 static void create_title (HildonWizardDialog *wizard_dialog);
66 static void set_property (GObject *object,
71 static void get_property (GObject *object,
76 static void finalize (GObject *object);
78 static void response (HildonWizardDialog *wizard,
82 static void make_buttons_sensitive (HildonWizardDialog *wizard_dialog,
94 struct _HildonWizardDialogPrivate {
96 GtkNotebook *notebook;
104 hildon_wizard_dialog_get_type (void)
106 static GType wizard_dialog_type = 0;
108 if (!wizard_dialog_type) {
110 static const GTypeInfo wizard_dialog_info = {
111 sizeof (HildonWizardDialogClass),
112 NULL, /* base_init */
113 NULL, /* base_finalize */
114 (GClassInitFunc) class_init,
115 NULL, /* class_finalize */
116 NULL, /* class_data */
117 sizeof (HildonWizardDialog),
119 (GInstanceInitFunc) init,
122 wizard_dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
123 "HildonWizardDialog",
128 return wizard_dialog_type;
132 class_init (HildonWizardDialogClass *wizard_dialog_class)
134 GObjectClass *object_class = G_OBJECT_CLASS (wizard_dialog_class);
136 parent_class = g_type_class_peek_parent (wizard_dialog_class);
138 g_type_class_add_private (wizard_dialog_class,
139 sizeof(HildonWizardDialogPrivate));
141 /* Override virtual methods */
142 object_class->set_property = set_property;
143 object_class->get_property = get_property;
144 object_class->finalize = finalize;
147 * HildonWizardDialog:wizard-name:
149 * The name of the wizard.
151 g_object_class_install_property (object_class, PROP_WIZARD_NAME,
155 "The name of the HildonWizardDialog",
160 * HildonWizardDialog:wizard-notebook:
162 * The notebook object, which is used by the HildonWizardDialog.
164 g_object_class_install_property(object_class, PROP_WIZARD_NOTEBOOK,
168 "GtkNotebook object to be used in the "
169 "HildonWizardDialog",
170 GTK_TYPE_NOTEBOOK, G_PARAM_READWRITE));
173 * HildonWizardDialog:autotitle
175 * If the wizard should automatically try to change the window title when changing steps.
176 * Set to FALSE if you'd like to override the default behaviour.
180 g_object_class_install_property(object_class, PROP_WIZARD_AUTOTITLE,
184 "If the wizard should autotitle itself",
190 finalize (GObject *object)
192 HildonWizardDialog *dialog = HILDON_WIZARD_DIALOG (object);
193 g_return_if_fail (dialog != NULL);
195 if (dialog->priv->wizard_name != NULL)
196 g_free (HILDON_WIZARD_DIALOG (object)->priv->wizard_name);
198 if (G_OBJECT_CLASS (parent_class)->finalize)
199 G_OBJECT_CLASS (parent_class)->finalize(object);
202 /* Disable or enable the Previous, Next and Finish buttons */
204 make_buttons_sensitive (HildonWizardDialog *wizard_dialog,
209 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
210 HILDON_WIZARD_DIALOG_PREVIOUS,
213 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
214 HILDON_WIZARD_DIALOG_FINISH,
217 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
218 HILDON_WIZARD_DIALOG_NEXT,
223 init (HildonWizardDialog *wizard_dialog)
225 /* Initialize private structure for faster member access */
226 HildonWizardDialogPrivate *priv =
227 G_TYPE_INSTANCE_GET_PRIVATE (wizard_dialog,
228 HILDON_TYPE_WIZARD_DIALOG,
229 HildonWizardDialogPrivate);
231 GtkDialog *dialog = GTK_DIALOG (wizard_dialog);
233 /* Init internal widgets */
234 GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
235 gtk_dialog_set_has_separator (dialog, FALSE);
236 wizard_dialog->priv = priv;
237 priv->box = GTK_BOX (gtk_hbox_new (FALSE, 0));
238 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard",
239 HILDON_ICON_SIZE_WIDG_WIZARD);
241 /* Default values for user provided properties */
242 priv->notebook = NULL;
243 priv->wizard_name = NULL;
244 priv->autotitle = TRUE;
246 /* Build wizard layout */
247 gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (priv->box));
248 gtk_box_pack_start_defaults (GTK_BOX (priv->box), GTK_WIDGET (vbox));
249 gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (priv->image), FALSE, FALSE, 0);
251 /* Add response buttons: finish, previous, next, cancel */
252 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_finish"), HILDON_WIZARD_DIALOG_FINISH);
253 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_previous"), HILDON_WIZARD_DIALOG_PREVIOUS);
254 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_next"), HILDON_WIZARD_DIALOG_NEXT);
255 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_cancel"), HILDON_WIZARD_DIALOG_CANCEL);
257 /* Set initial button states: previous and finish buttons are disabled */
258 make_buttons_sensitive (wizard_dialog, FALSE, FALSE, TRUE);
260 /* Show all the internal widgets */
261 gtk_widget_show_all (GTK_WIDGET (dialog->vbox));
263 /* connect to dialog's response signal */
264 g_signal_connect (G_OBJECT (dialog), "response",
265 G_CALLBACK (response), NULL);
269 set_property (GObject *object,
274 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG(object)->priv;
276 switch (property_id) {
278 case PROP_WIZARD_AUTOTITLE:
280 priv->autotitle = g_value_get_boolean (value);
282 if (priv->autotitle &&
285 create_title (HILDON_WIZARD_DIALOG (object));
286 else if (priv->wizard_name)
287 gtk_window_set_title (GTK_WINDOW (object), priv->wizard_name);
291 case PROP_WIZARD_NAME:
293 /* Set new wizard name. This name will appear in titlebar */
294 if (priv->wizard_name)
295 g_free (priv->wizard_name);
297 gchar *str = (gchar *) g_value_get_string (value);
298 g_return_if_fail (str != NULL);
300 priv->wizard_name = g_strdup (str);
302 /* We need notebook in order to create title, since page information
303 is used in title generation */
305 if (priv->notebook && priv->autotitle)
306 create_title (HILDON_WIZARD_DIALOG (object));
310 case PROP_WIZARD_NOTEBOOK: {
312 GtkNotebook *book = GTK_NOTEBOOK (g_value_get_object (value));
313 g_return_if_fail (book != NULL);
315 priv->notebook = book;
317 /* Set the default properties for the notebook (disable tabs,
318 * and remove borders) to make it look like a nice wizard widget */
319 gtk_notebook_set_show_tabs (priv->notebook, FALSE);
320 gtk_notebook_set_show_border (priv->notebook, FALSE);
321 gtk_box_pack_start_defaults (GTK_BOX( priv->box), GTK_WIDGET (priv->notebook));
323 /* Show the notebook so that a gtk_widget_show on the dialog is
324 * all that is required to display the dialog correctly */
325 gtk_widget_show (priv->notebook);
327 /* Update dialog title to reflect current page stats etc */
328 if (priv->wizard_name && priv->autotitle)
329 create_title (HILDON_WIZARD_DIALOG (object));
334 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
340 get_property (GObject *object,
345 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG (object)->priv;
347 switch (property_id) {
349 case PROP_WIZARD_NAME:
350 g_value_set_string (value, priv->wizard_name);
353 case PROP_WIZARD_NOTEBOOK:
354 g_value_set_object (value, priv->notebook);
358 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
364 * Creates the title of the dialog taking into account the current
365 * page of the notebook.
368 create_title (HildonWizardDialog *wizard_dialog)
372 HildonWizardDialogPrivate *priv = wizard_dialog->priv;
373 GtkNotebook *notebook = priv->notebook;
378 /* Get page information, we'll need that when creating title */
379 pages = gtk_notebook_get_n_pages (notebook);
380 current = gtk_notebook_get_current_page (priv->notebook);
384 /* the welcome title on the initial page */
386 str = g_strdup_printf (_("ecdg_ti_wizard_welcome"),
387 priv->wizard_name, pages);
389 const gchar *steps = gtk_notebook_get_tab_label_text (notebook,
390 gtk_notebook_get_nth_page (notebook, current));
392 str = g_strdup_printf (_("ecdg_ti_wizard_step"),
393 priv->wizard_name, current + 1, pages, steps);
396 /* Update the dialog to display the generated title */
397 gtk_window_set_title (GTK_WINDOW (wizard_dialog), str);
402 * Response signal handler. This function is needed because GtkDialog's
403 * handler for this signal closes the dialog and we don't want that, we
404 * want to change pages and, dimm certain response buttons. Overriding the
405 * virtual function would not work because that would be called after the
406 * signal handler implemented by GtkDialog.
407 * FIXME: There is a much saner way to do that [MDK]
410 response (HildonWizardDialog *wizard_dialog,
414 HildonWizardDialogPrivate *priv = wizard_dialog->priv;
415 GtkNotebook *notebook = priv->notebook;
417 gint last = gtk_notebook_get_n_pages (notebook) - 1;
418 gboolean is_first, is_last;
420 switch (response_id) {
422 case HILDON_WIZARD_DIALOG_PREVIOUS:
423 gtk_notebook_prev_page (notebook); /* go to previous page */
426 case HILDON_WIZARD_DIALOG_NEXT:
427 gtk_notebook_next_page (notebook); /* go to next page */
430 case HILDON_WIZARD_DIALOG_CANCEL:
431 case HILDON_WIZARD_DIALOG_FINISH:
436 current = gtk_notebook_get_current_page (notebook);
437 is_last = current == last;
438 is_first = current == 0;
440 /* If first page, previous and finish are disabled,
441 if last page, next is disabled */
442 make_buttons_sensitive (wizard_dialog,
443 !is_first, !is_first, !is_last);
445 /* Don't let the dialog close */
446 g_signal_stop_emission_by_name (wizard_dialog, "response");
448 /* We show the default image on first and last pages */
449 if (current == last || current == 0)
450 gtk_widget_show (GTK_WIDGET(priv->image));
452 gtk_widget_hide (GTK_WIDGET(priv->image));
454 /* New page number may appear in the title, update it */
456 create_title (wizard_dialog);
460 * hildon_wizard_dialog_new:
461 * @parent: a #GtkWindow
462 * @wizard_name: the name of dialog
463 * @notebook: the notebook to be shown on the dialog
465 * Creates a new #HildonWizardDialog.
467 * Returns: a new #HildonWizardDialog
470 hildon_wizard_dialog_new (GtkWindow *parent,
471 const char *wizard_name,
472 GtkNotebook *notebook)
476 g_return_val_if_fail (GTK_IS_NOTEBOOK (notebook), NULL);
478 widget = GTK_WIDGET (g_object_new
479 (HILDON_TYPE_WIZARD_DIALOG,
480 "wizard-name", wizard_name,
481 "wizard-notebook", notebook, NULL));
484 gtk_window_set_transient_for (GTK_WINDOW (widget), parent);