10036c7af19d92fa2a1e95efc9f5f97e33d92f77
[modest] / src / gnome / modest-transport-widget.h
1 /* Copyright (c) 2006, 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_TRANSPORT_WIDGET_H__
31 #define __MODEST_TRANSPORT_WIDGET_H__
32
33 G_BEGIN_DECLS
34
35 #include <gtk/gtkvbox.h>
36
37 /* convenience macros */
38 #define MODEST_TYPE_TRANSPORT_WIDGET             (modest_transport_widget_get_type())
39 #define MODEST_TRANSPORT_WIDGET(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TRANSPORT_WIDGET,ModestTransportWidget))
40 #define MODEST_TRANSPORT_WIDGET_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TRANSPORT_WIDGET,GtkContainer))
41 #define MODEST_IS_TRANSPORT_WIDGET(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TRANSPORT_WIDGET))
42 #define MODEST_IS_TRANSPORT_WIDGET_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TRANSPORT_WIDGET))
43 #define MODEST_TRANSPORT_WIDGET_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TRANSPORT_WIDGET,ModestTransportWidgetClass))
44
45 typedef struct _ModestTransportWidget      ModestTransportWidget;
46 typedef struct _ModestTransportWidgetClass ModestTransportWidgetClass;
47
48 struct _ModestTransportWidget {
49          GtkVBox parent;
50         /* insert public members, if any */
51 };
52
53 struct _ModestTransportWidgetClass {
54         GtkVBoxClass parent_class;
55         /* insert signal callback declarations, eg. */
56         /* void (* my_event) (ModestTransportWidget* obj); */
57 };
58
59 /* member functions */
60 GType        modest_transport_widget_get_type    (void) G_GNUC_CONST;
61
62 GtkWidget*   modest_transport_widget_new         (ModestTransportStoreProtocol proto);
63
64 gboolean        modest_transport_widget_get_remember_password (ModestTransportWidget *self);
65 gboolean        modest_transport_widget_get_requires_auth     (ModestTransportWidget *self);
66 const gchar*    modest_transport_widget_get_username          (ModestTransportWidget *self);
67 const gchar*    modest_transport_widget_get_servername        (ModestTransportWidget *self);
68 ModestTransportStoreProtocol  modest_transport_widget_get_proto             (ModestTransportWidget *self);
69
70 G_END_DECLS
71
72 #endif /* __MODEST_TRANSPORT_WIDGET_H__ */
73