git.maemo.org Git - hildon/blob - hildon/hildon-wizard-dialog.h

   1 /*
   2  * This file is a part of hildon
   3  *
   4  * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
   5  *
   6  * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
   7  *   Fixes: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  * 02110-1301 USA
  23  *
  24  */
  25
  26 #ifndef                                         __HILDON_WIZARD_DIALOG_H__
  27 #define                                         __HILDON_WIZARD_DIALOG_H__
  28
  29 #include                                        <gtk/gtk.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define                                         HILDON_TYPE_WIZARD_DIALOG \
  34                                                 (hildon_wizard_dialog_get_type())
  35
  36 #define                                         HILDON_WIZARD_DIALOG(obj) \
  37                                                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  38                                                 HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialog))
  39
  40 #define                                         HILDON_WIZARD_DIALOG_CLASS(klass) \
  41                                                 (G_TYPE_CHECK_CLASS_CAST ((klass), \
  42                                                 HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialogClass))
  43
  44 #define                                         HILDON_IS_WIZARD_DIALOG(obj) \
  45                                                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  46                                                 HILDON_TYPE_WIZARD_DIALOG))
  47
  48 #define                                         HILDON_IS_WIZARD_DIALOG_CLASS(klass) \
  49                                                 (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  50                                                 HILDON_TYPE_WIZARD_DIALOG))
  51
  52 typedef struct                                  _HildonWizardDialog HildonWizardDialog;
  53
  54 typedef struct                                  _HildonWizardDialogClass HildonWizardDialogClass;
  55
  56 /* HILDON_WIZARD_DIALOG_CANCEL should be marked as deprecated */
  57
  58 /**
  59  * HildonWizardDialogResponse:
  60  * @HILDON_WIZARD_DIALOG_CANCEL: Returned by the 'Cancel' button.
  61  * @HILDON_WIZARD_DIALOG_PREVIOUS: Returned by the 'Previous' button.
  62  * @HILDON_WIZARD_DIALOG_NEXT: Returned by the 'Next' button.
  63  * @HILDON_WIZARD_DIALOG_FINISH: Returned by the 'Finish' button.
  64  *
  65  * Predefined values for use as response ids for #HildonWizardDialog.
  66  *
  67  * <warning>
  68  *   <para>
  69  *     HILDON_WIZARD_DIALOG_CANCEL is deprecated and should not be used in newly-written code.
  70  *   </para>
  71  * </warning>
  72  **/
  73 typedef enum
  74 {
  75     HILDON_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
  76     HILDON_WIZARD_DIALOG_PREVIOUS = 0,
  77     HILDON_WIZARD_DIALOG_NEXT,
  78     HILDON_WIZARD_DIALOG_FINISH
  79 }                                               HildonWizardDialogResponse;
  80
  81 struct                                          _HildonWizardDialog
  82 {
  83     GtkDialog parent;
  84 };
  85
  86 struct                                          _HildonWizardDialogClass
  87 {
  88     GtkDialogClass parent_class;
  89 };
  90
  91 typedef gboolean (*HildonWizardDialogPageFunc) (GtkNotebook *notebook, gint current_page, gpointer data);
  92
  93 GType G_GNUC_CONST
  94 hildon_wizard_dialog_get_type                   (void);
  95
  96 GtkWidget*
  97 hildon_wizard_dialog_new                        (GtkWindow *parent,
  98                                                  const char *wizard_name,
  99                                                  GtkNotebook *notebook);
 100
 101 void
 102 hildon_wizard_dialog_set_forward_page_func      (HildonWizardDialog *wizard_dialog,
 103                                                  HildonWizardDialogPageFunc page_func,
 104                                                  gpointer data,
 105                                                  GDestroyNotify destroy);
 106
 107 G_END_DECLS
 108
 109 #endif                                          /* __HILDON_WIZARD_DIALOG_H__ */
 110