1fc7121369a712d0f6450f8399d740c1c5291ee0
[modest] / src / widgets / modest-security-options-view.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_SECURITY_OPTIONS_VIEW_H__
31 #define __MODEST_SECURITY_OPTIONS_VIEW_H__
32
33 #include <glib.h>
34 #include <glib-object.h>
35 #include "modest-account-settings.h"
36 #include "modest-protocol.h"
37
38 G_BEGIN_DECLS
39
40 /* convenience macros */
41 #define MODEST_TYPE_SECURITY_OPTIONS_VIEW             (modest_security_options_view_get_type())
42 #define MODEST_SECURITY_OPTIONS_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SECURITY_OPTIONS_VIEW,ModestSecurityOptionsView))
43 #define MODEST_SECURITY_OPTIONS_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SECURITY_OPTIONS_VIEW,ModestSecurityOptionsViewClass))
44 #define MODEST_IS_SECURITY_OPTIONS_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SECURITY_OPTIONS_VIEW))
45 #define MODEST_IS_SECURITY_OPTIONS_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SECURITY_OPTIONS_VIEW))
46 #define MODEST_SECURITY_OPTIONS_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SECURITY_OPTIONS_VIEW,ModestSecurityOptionsViewClass))
47
48 typedef enum {
49         MODEST_SECURITY_OPTIONS_INCOMING,
50         MODEST_SECURITY_OPTIONS_OUTGOING,
51 } ModestSecurityOptionsType;
52
53 typedef struct _ModestSecurityOptionsView      ModestSecurityOptionsView;
54 typedef struct _ModestSecurityOptionsViewClass ModestSecurityOptionsViewClass;
55
56 struct _ModestSecurityOptionsView {
57         GtkVBox parent;
58
59         /* Incoming or outgoing */
60         ModestSecurityOptionsType type;
61 };
62
63 struct _ModestSecurityOptionsViewClass {
64         GtkVBoxClass parent_class;
65
66         void (*load_settings) (ModestSecurityOptionsView* self, ModestAccountSettings *settings);
67         void (*save_settings) (ModestSecurityOptionsView* self, ModestAccountSettings *settings);
68         gboolean (*changed) (ModestSecurityOptionsView* self, ModestAccountSettings *settings);
69
70         /* Signals */
71         void (*missing_mandatory_data) (ModestSecurityOptionsView* self, 
72                                         gboolean missing, 
73                                         gpointer user_data);
74 };
75
76 GType        modest_security_options_view_get_type    (void) G_GNUC_CONST;
77
78 void modest_security_options_view_load_settings (ModestSecurityOptionsView* self, 
79                                                  ModestAccountSettings *settings);
80
81 void modest_security_options_view_save_settings (ModestSecurityOptionsView* self, 
82                                                  ModestAccountSettings *settings);
83
84 void modest_security_options_view_set_server_type (ModestSecurityOptionsView* self, 
85                                                    ModestProtocolType server_type);
86
87 gboolean modest_security_options_view_changed (ModestSecurityOptionsView* self,
88                                                ModestAccountSettings *settings);
89
90 void modest_security_options_view_enable_changes (ModestSecurityOptionsView* self,
91                                                   gboolean enable);
92
93 /**
94  * modest_security_options_view_auth_check:
95  * @self: a #ModestSecurityOptionsView
96  * 
97  * checks if the supported authentication methods for the server
98  * should be checked. This happens when the user have checked the
99  * "require auth" option but is not selecting a secure protocol (like
100  * TLS or SSL)
101  * 
102  * Returns: TRUE if require auth is true and no security protocol is
103  * selected
104  **/
105 gboolean modest_security_options_view_auth_check (ModestSecurityOptionsView* self);
106
107 G_END_DECLS
108
109 #endif /* __MODEST_SECURITY_OPTIONS_VIEW_H__ */
110