46693d713154c6273eb73ece7d0ab7cb9fae9871
[modest] / src / widgets / modest-easysetup-wizard-page.h
1 /* Copyright (c) 2008, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __MODEST_EASYSETUP_WIZARD_PAGE_H__
31 #define __MODEST_EASYSETUP_WIZARD_PAGE_H__
32
33 /* other include files */
34 #include <glib.h>
35 #include <glib-object.h>
36 #include "modest-account-settings.h"
37
38 G_BEGIN_DECLS
39
40 /* convenience macros */
41 #define MODEST_TYPE_EASYSETUP_WIZARD_PAGE             (modest_easysetup_wizard_page_get_type())
42 #define MODEST_EASYSETUP_WIZARD_PAGE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_EASYSETUP_WIZARD_PAGE,ModestEasysetupWizardPage))
43 #define MODEST_IS_EASYSETUP_WIZARD_PAGE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_EASYSETUP_WIZARD_PAGE))
44 #define MODEST_EASYSETUP_WIZARD_PAGE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE((obj),MODEST_TYPE_EASYSETUP_WIZARD_PAGE,ModestEasysetupWizardPageClass))
45
46 typedef struct _ModestEasysetupWizardPage      ModestEasysetupWizardPage;
47 typedef struct _ModestEasysetupWizardPageClass ModestEasysetupWizardPageClass;
48
49 struct _ModestEasysetupWizardPageClass {
50         GTypeInterface parent_class;
51
52         /* Functions to be redefined */
53         gboolean (*validate) (ModestEasysetupWizardPage* self);
54         void (*save_settings) (ModestEasysetupWizardPage* self, ModestAccountSettings *settings);
55
56         /* Signals */
57         void (*missing_mandatory_data) (ModestEasysetupWizardPage* self, 
58                                         gboolean missing, 
59                                         gpointer user_data);
60 };
61
62 GType        modest_easysetup_wizard_page_get_type    (void) G_GNUC_CONST;
63
64 gboolean     modest_easysetup_wizard_page_validate    (ModestEasysetupWizardPage *self);
65
66 void         modest_easysetup_wizard_page_save_settings    (ModestEasysetupWizardPage *self,
67                                                             ModestAccountSettings *settings);
68
69 G_END_DECLS
70
71 #endif /* __MODEST_EASYSETUP_WIZARD_PAGE_H__ */