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) (GTK_CHECK_CAST ((obj), \
  37                                                 HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialog))
  38
  39 #define                                         HILDON_WIZARD_DIALOG_CLASS(klass) \
  40                                                 (GTK_CHECK_CLASS_CAST ((klass), \
  41                                                 HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialogClass))
  42
  43 #define                                         HILDON_IS_WIZARD_DIALOG(obj) \
  44                                                 (GTK_CHECK_TYPE ((obj), \
  45                                                 HILDON_TYPE_WIZARD_DIALOG))
  46
  47 #define                                         HILDON_IS_WIZARD_DIALOG_CLASS(klass) \
  48                                                 (GTK_CHECK_CLASS_TYPE ((klass), \
  49                                                 HILDON_TYPE_WIZARD_DIALOG))
  50
  51 typedef struct                                  _HildonWizardDialog HildonWizardDialog;
  52
  53 typedef struct                                  _HildonWizardDialogClass HildonWizardDialogClass;
  54
  55 /* HILDON_WIZARD_DIALOG_CANCEL should be marked as deprecated */
  56
  57 /**
  58  * HildonWizardDialogResponse:
  59  * @HILDON_WIZARD_DIALOG_CANCEL: Returned by the 'Cancel' button.
  60  * @HILDON_WIZARD_DIALOG_PREVIOUS: Returned by the 'Previous' button.
  61  * @HILDON_WIZARD_DIALOG_NEXT: Returned by the 'Next' button.
  62  * @HILDON_WIZARD_DIALOG_FINISH: Returned by the 'Finish' button.
  63  *
  64  * Predefined values for use as response ids for #HildonWizardDialog.
  65  *
  66  * <warning>
  67  *   <para>
  68  *     HILDON_WIZARD_DIALOG_CANCEL is deprecated and should not be used in newly-written code.
  69  *   </para>
  70  * </warning>
  71  **/
  72 typedef enum
  73 {
  74     HILDON_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
  75     HILDON_WIZARD_DIALOG_PREVIOUS = 0,
  76     HILDON_WIZARD_DIALOG_NEXT,
  77     HILDON_WIZARD_DIALOG_FINISH
  78 }                                               HildonWizardDialogResponse;
  79
  80 struct                                          _HildonWizardDialog
  81 {
  82     GtkDialog parent;
  83 };
  84
  85 struct                                          _HildonWizardDialogClass
  86 {
  87     GtkDialogClass parent_class;
  88 };
  89
  90 typedef gboolean (*HildonWizardDialogPageFunc) (GtkNotebook *notebook, gint current_page, gpointer data);
  91
  92 GType G_GNUC_CONST
  93 hildon_wizard_dialog_get_type                   (void);
  94
  95 GtkWidget*
  96 hildon_wizard_dialog_new                        (GtkWindow *parent,
  97                                                  const char *wizard_name,
  98                                                  GtkNotebook *notebook);
  99
 100 void
 101 hildon_wizard_dialog_set_forward_page_func      (HildonWizardDialog *wizard_dialog,
 102                                                  HildonWizardDialogPageFunc page_func,
 103                                                  gpointer data,
 104                                                  GDestroyNotify destroy);
 105
 106 G_END_DECLS
 107
 108 #endif                                          /* __HILDON_WIZARD_DIALOG_H__ */
 109