aboutsummaryrefslogtreecommitdiff
path: root/hildon/hildon-wizard-dialog.h
blob: d298c4bdbf788224b14c55b12b1b0ac09f03ffa8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
 * This file is a part of hildon
 *
 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
 *
 * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
 *   Fixes: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
 
#ifndef                                         __HILDON_WIZARD_DIALOG_H__
#define                                         __HILDON_WIZARD_DIALOG_H__

#include                                        <gtk/gtk.h>

G_BEGIN_DECLS

#define                                         HILDON_TYPE_WIZARD_DIALOG \
                                                (hildon_wizard_dialog_get_type())

#define                                         HILDON_WIZARD_DIALOG(obj) \
                                                (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
                                                HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialog))

#define                                         HILDON_WIZARD_DIALOG_CLASS(klass) \
                                                (G_TYPE_CHECK_CLASS_CAST ((klass), \
                                                HILDON_TYPE_WIZARD_DIALOG, HildonWizardDialogClass))

#define                                         HILDON_IS_WIZARD_DIALOG(obj) \
                                                (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
                                                HILDON_TYPE_WIZARD_DIALOG))

#define                                         HILDON_IS_WIZARD_DIALOG_CLASS(klass) \
                                                (G_TYPE_CHECK_CLASS_TYPE ((klass), \
                                                HILDON_TYPE_WIZARD_DIALOG))

typedef struct                                  _HildonWizardDialog HildonWizardDialog;

typedef struct                                  _HildonWizardDialogClass HildonWizardDialogClass;

/* HILDON_WIZARD_DIALOG_CANCEL should be marked as deprecated */

/**
 * HildonWizardDialogResponse:
 * @HILDON_WIZARD_DIALOG_CANCEL: Returned by the 'Cancel' button.
 * @HILDON_WIZARD_DIALOG_PREVIOUS: Returned by the 'Previous' button.
 * @HILDON_WIZARD_DIALOG_NEXT: Returned by the 'Next' button.
 * @HILDON_WIZARD_DIALOG_FINISH: Returned by the 'Finish' button.
 *
 * Predefined values for use as response ids for #HildonWizardDialog.
 *
 * <warning>
 *   <para>
 *     HILDON_WIZARD_DIALOG_CANCEL is deprecated and should not be used in newly-written code.
 *   </para>
 * </warning>
 **/
typedef enum
{
    HILDON_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
    HILDON_WIZARD_DIALOG_PREVIOUS = 0,
    HILDON_WIZARD_DIALOG_NEXT,
    HILDON_WIZARD_DIALOG_FINISH
}                                               HildonWizardDialogResponse;

struct                                          _HildonWizardDialog 
{
    GtkDialog parent;
};

struct                                          _HildonWizardDialogClass 
{
    GtkDialogClass parent_class;
};

typedef gboolean (*HildonWizardDialogPageFunc) (GtkNotebook *notebook, gint current_page, gpointer data);

GType G_GNUC_CONST
hildon_wizard_dialog_get_type                   (void);

GtkWidget* 
hildon_wizard_dialog_new                        (GtkWindow *parent,
                                                 const char *wizard_name,
                                                 GtkNotebook *notebook);

void
hildon_wizard_dialog_set_forward_page_func      (HildonWizardDialog *wizard_dialog,
                                                 HildonWizardDialogPageFunc page_func,
                                                 gpointer data,
                                                 GDestroyNotify destroy);

G_END_DECLS

#endif                                          /* __HILDON_WIZARD_DIALOG_H__ */