2 * This file is a part of hildon
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 (at your option) 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.
38 * Using of the API is very simple, it has only one function to create it
39 * and the rest of it is handled by developers notebook.
40 * Also the response is returned, either cancel or finnish.
41 * Next and previous buttons are handled by the wizard dialog it self, by
42 * switching the page either forward or backward in the notebook.
49 #include "hildon-wizard-dialog.h"
50 #include <gtk/gtkdialog.h>
51 #include <gtk/gtknotebook.h>
52 #include <gtk/gtkimage.h>
53 #include <gtk/gtkbox.h>
54 #include <gtk/gtkhbox.h>
55 #include <gtk/gtkvbox.h>
56 #include <gtk/gtkbutton.h>
57 #include "hildon-defines.h"
59 #include "hildon-wizard-dialog-private.h"
61 #define _(String) dgettext("hildon-libs", String)
63 static GtkDialogClass* parent_class;
66 hildon_wizard_dialog_class_init (HildonWizardDialogClass *wizard_dialog_class);
69 hildon_wizard_dialog_init (HildonWizardDialog *wizard_dialog);
72 create_title (HildonWizardDialog *wizard_dialog);
75 hildon_wizard_dialog_set_property (GObject *object,
81 hildon_wizard_dialog_get_property (GObject *object,
87 finalize (GObject *object);
90 response (HildonWizardDialog *wizard,
95 make_buttons_sensitive (HildonWizardDialog *wizard_dialog,
109 * hildon_wizard_dialog_get_type:
111 * Initializes and returns the type of a hildon wizard dialog.
113 * @Returns: GType of #HildonWzardDialog
116 hildon_wizard_dialog_get_type (void)
118 static GType wizard_dialog_type = 0;
120 if (! wizard_dialog_type) {
122 static const GTypeInfo wizard_dialog_info = {
123 sizeof (HildonWizardDialogClass),
124 NULL, /* base_init */
125 NULL, /* base_finalize */
126 (GClassInitFunc) hildon_wizard_dialog_class_init,
127 NULL, /* class_finalize */
128 NULL, /* class_data */
129 sizeof (HildonWizardDialog),
131 (GInstanceInitFunc) hildon_wizard_dialog_init,
134 wizard_dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
135 "HildonWizardDialog",
140 return wizard_dialog_type;
144 hildon_wizard_dialog_class_init (HildonWizardDialogClass *wizard_dialog_class)
146 GObjectClass *object_class = G_OBJECT_CLASS (wizard_dialog_class);
148 parent_class = g_type_class_peek_parent (wizard_dialog_class);
150 g_type_class_add_private (wizard_dialog_class, sizeof (HildonWizardDialogPrivate));
152 /* Override virtual methods */
153 object_class->set_property = hildon_wizard_dialog_set_property;
154 object_class->get_property = hildon_wizard_dialog_get_property;
155 object_class->finalize = finalize;
158 * HildonWizardDialog:wizard-name:
160 * The name of the wizard.
162 g_object_class_install_property (object_class, PROP_NAME,
166 "The name of the HildonWizardDialog",
171 * HildonWizardDialog:wizard-notebook:
173 * The notebook object, which is used by the HildonWizardDialog.
175 g_object_class_install_property (object_class, PROP_NOTEBOOK,
179 "GtkNotebook object to be used in the "
180 "HildonWizardDialog",
181 GTK_TYPE_NOTEBOOK, G_PARAM_READWRITE));
184 * HildonWizardDialog:autotitle
186 * If the wizard should automatically try to change the window title when changing steps.
187 * Set to FALSE if you'd like to override the default behaviour.
191 g_object_class_install_property (object_class, PROP_AUTOTITLE,
195 "If the wizard should autotitle itself",
201 finalize (GObject *object)
203 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (object);
207 if (priv->wizard_name != NULL)
208 g_free (priv->wizard_name);
210 if (G_OBJECT_CLASS (parent_class)->finalize)
211 G_OBJECT_CLASS (parent_class)->finalize (object);
214 /* Disable or enable the Previous, Next and Finish buttons */
216 make_buttons_sensitive (HildonWizardDialog *wizard_dialog,
221 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
222 HILDON_WIZARD_DIALOG_PREVIOUS,
225 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
226 HILDON_WIZARD_DIALOG_FINISH,
229 gtk_dialog_set_response_sensitive (GTK_DIALOG (wizard_dialog),
230 HILDON_WIZARD_DIALOG_NEXT,
235 hildon_wizard_dialog_init (HildonWizardDialog *wizard_dialog)
237 /* Initialize private structure for faster member access */
238 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (wizard_dialog);
241 GtkDialog *dialog = GTK_DIALOG (wizard_dialog);
243 /* Init internal widgets */
244 GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
245 gtk_dialog_set_has_separator (dialog, FALSE);
247 priv->box = GTK_BOX (gtk_hbox_new (FALSE, 0));
248 priv->image = gtk_image_new_from_icon_name ("qgn_widg_wizard", HILDON_ICON_SIZE_WIZARD);
250 /* Default values for user provided properties */
251 priv->notebook = NULL;
252 priv->wizard_name = NULL;
253 priv->autotitle = TRUE;
255 /* Build wizard layout */
256 gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (priv->box));
257 gtk_box_pack_start_defaults (GTK_BOX (priv->box), GTK_WIDGET (vbox));
258 gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (priv->image), FALSE, FALSE, 0);
260 /* Add response buttons: finish, previous, next, cancel */
261 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_finish"), HILDON_WIZARD_DIALOG_FINISH);
262 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_previous"), HILDON_WIZARD_DIALOG_PREVIOUS);
263 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_next"), HILDON_WIZARD_DIALOG_NEXT);
264 gtk_dialog_add_button (dialog, _("ecdg_bd_wizard_cancel"), HILDON_WIZARD_DIALOG_CANCEL);
266 /* Set initial button states: previous and finish buttons are disabled */
267 make_buttons_sensitive (wizard_dialog, FALSE, FALSE, TRUE);
269 /* Show all the internal widgets */
270 gtk_widget_show_all (GTK_WIDGET (dialog->vbox));
272 /* connect to dialog's response signal */
273 g_signal_connect (G_OBJECT (dialog), "response",
274 G_CALLBACK (response), NULL);
278 hildon_wizard_dialog_set_property (GObject *object,
283 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (object);
286 switch (property_id) {
290 priv->autotitle = g_value_get_boolean (value);
292 if (priv->autotitle &&
295 create_title (HILDON_WIZARD_DIALOG (object));
296 else if (priv->wizard_name)
297 gtk_window_set_title (GTK_WINDOW (object), priv->wizard_name);
302 /* Set new wizard name. This name will appear in titlebar */
303 if (priv->wizard_name)
304 g_free (priv->wizard_name);
306 gchar *str = (gchar *) g_value_get_string (value);
307 g_return_if_fail (str != NULL);
309 priv->wizard_name = g_strdup (str);
311 /* We need notebook in order to create title, since page information
312 is used in title generation */
314 if (priv->notebook && priv->autotitle)
315 create_title (HILDON_WIZARD_DIALOG (object));
318 case PROP_NOTEBOOK: {
320 GtkNotebook *book = GTK_NOTEBOOK (g_value_get_object (value));
321 g_return_if_fail (book != NULL);
323 priv->notebook = book;
325 /* Set the default properties for the notebook (disable tabs,
326 * and remove borders) to make it look like a nice wizard widget */
327 gtk_notebook_set_show_tabs (priv->notebook, FALSE);
328 gtk_notebook_set_show_border (priv->notebook, FALSE);
329 gtk_box_pack_start_defaults (GTK_BOX( priv->box), GTK_WIDGET (priv->notebook));
331 /* Show the notebook so that a gtk_widget_show on the dialog is
332 * all that is required to display the dialog correctly */
333 gtk_widget_show (GTK_WIDGET (priv->notebook));
335 /* Update dialog title to reflect current page stats etc */
336 if (priv->wizard_name && priv->autotitle)
337 create_title (HILDON_WIZARD_DIALOG (object));
342 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
348 hildon_wizard_dialog_get_property (GObject *object,
353 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (object);
356 switch (property_id) {
359 g_value_set_string (value, priv->wizard_name);
363 g_value_set_object (value, priv->notebook);
367 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
372 /* Creates the title of the dialog taking into account the current
373 * page of the notebook. */
375 create_title (HildonWizardDialog *wizard_dialog)
379 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (wizard_dialog);
380 GtkNotebook *notebook;
383 notebook = priv->notebook;
388 /* Get page information, we'll need that when creating title */
389 pages = gtk_notebook_get_n_pages (notebook);
390 current = gtk_notebook_get_current_page (priv->notebook);
394 /* the welcome title on the initial page */
396 str = g_strdup_printf (_("ecdg_ti_wizard_welcome"),
397 priv->wizard_name, pages);
399 const gchar *steps = gtk_notebook_get_tab_label_text (notebook,
400 gtk_notebook_get_nth_page (notebook, current));
402 str = g_strdup_printf (_("ecdg_ti_wizard_step"),
403 priv->wizard_name, current + 1, pages, steps);
406 /* Update the dialog to display the generated title */
407 gtk_window_set_title (GTK_WINDOW (wizard_dialog), str);
411 /* Response signal handler. This function is needed because GtkDialog's
412 * handler for this signal closes the dialog and we don't want that, we
413 * want to change pages and, dimm certain response buttons. Overriding the
414 * virtual function would not work because that would be called after the
415 * signal handler implemented by GtkDialog.
416 * FIXME: There is a much saner way to do that [MDK] */
418 response (HildonWizardDialog *wizard_dialog,
422 HildonWizardDialogPrivate *priv = HILDON_WIZARD_DIALOG_GET_PRIVATE (wizard_dialog);
423 GtkNotebook *notebook = priv->notebook;
425 gint last = gtk_notebook_get_n_pages (notebook) - 1;
426 gboolean is_first, is_last;
430 current = gtk_notebook_current_page (notebook);
432 switch (response_id) {
434 case HILDON_WIZARD_DIALOG_PREVIOUS:
436 is_last = (current == last);
437 is_first = (current == 0);
438 make_buttons_sensitive (wizard_dialog,
439 !is_first, !is_first, !is_last);
440 gtk_notebook_prev_page (notebook); /* go to previous page */
443 case HILDON_WIZARD_DIALOG_NEXT:
445 is_last = (current == last);
446 is_first = (current == 0);
447 make_buttons_sensitive (wizard_dialog,
448 !is_first, !is_first, !is_last);
449 gtk_notebook_next_page (notebook); /* go to next page */
452 case HILDON_WIZARD_DIALOG_CANCEL:
453 case HILDON_WIZARD_DIALOG_FINISH:
458 current = gtk_notebook_get_current_page (notebook);
459 is_last = current == last;
460 is_first = current == 0;
462 /* Don't let the dialog close */
463 g_signal_stop_emission_by_name (wizard_dialog, "response");
465 /* We show the default image on first and last pages */
466 if (current == last || current == 0)
467 gtk_widget_show (GTK_WIDGET(priv->image));
469 gtk_widget_hide (GTK_WIDGET(priv->image));
471 /* New page number may appear in the title, update it */
473 create_title (wizard_dialog);
477 * hildon_wizard_dialog_new:
478 * @parent: a #GtkWindow
479 * @wizard_name: the name of dialog
480 * @notebook: the notebook to be shown on the dialog
482 * Creates a new #HildonWizardDialog.
484 * Returns: a new #HildonWizardDialog
487 hildon_wizard_dialog_new (GtkWindow *parent,
488 const char *wizard_name,
489 GtkNotebook *notebook)
493 g_return_val_if_fail (GTK_IS_NOTEBOOK (notebook), NULL);
495 widget = GTK_WIDGET (g_object_new
496 (HILDON_TYPE_WIZARD_DIALOG,
497 "wizard-name", wizard_name,
498 "wizard-notebook", notebook, NULL));
501 gtk_window_set_transient_for (GTK_WINDOW (widget), parent);