* Added ModestWindow object
[modest] / src / widgets / modest-window.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_WINDOW_H__
31 #define __MODEST_WINDOW_H__
32
33 #include <glib-object.h>
34 #include <tny-account-store.h>
35 #include "modest-widget-factory.h"
36
37 G_BEGIN_DECLS
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif /*HAVE_CONFIG_H*/
42
43 /* 
44  * admittedly, the ifdefs for gtk and maemo are rather ugly; still
45  * this way is probably the easiest to maintain
46  */
47 #if MODEST_PLATFORM_ID==1   /* gtk */
48 #include <gtk/gtkwindow.h>
49 typedef GtkWindow      ModestWindowParent;
50 typedef GtkWindowClass ModestWindowParentClass;
51 #elif MODEST_PLATFORM_ID==2   /* hildon (maemo) */
52 #include <hildon-widgets/hildon-window.h>
53 typedef HildonWindow      ModestWindowParent;
54 typedef HildonWindowClass ModestWindowParentClass;
55 #endif /*MODEST_PLATFORM_ID*/
56
57 /* convenience macros */
58 #define MODEST_TYPE_WINDOW             (modest_window_get_type())
59 #define MODEST_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
60 #define MODEST_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
61 #define MODEST_IS_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
62 #define MODEST_IS_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
63 #define MODEST_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
64
65 typedef struct _ModestWindow      ModestWindow;
66 typedef struct _ModestWindowClass ModestWindowClass;
67
68 struct _ModestWindow {
69          ModestWindowParent parent;
70 };
71
72 struct _ModestWindowClass {
73         ModestWindowParentClass parent_class;
74 };
75
76 /* member functions */
77 GType        modest_window_get_type    (void) G_GNUC_CONST;
78
79 /**
80  * modest_window_get_account_store:
81  * @window: a #ModestWindow
82  * 
83  * gets a new reference to the account store associated with the main
84  * window. The caller must free the returned instance
85  * 
86  * Returns: the account store
87  **/
88 TnyAccountStore*        modest_window_get_account_store     (ModestWindow *window);
89
90 /**
91  * modest_window_get_widget_factory:
92  * @window: a #ModestWindow
93  * 
94  * gets a reference to the #ModestWidgetFactory associated with the
95  * Modest Window. The caller must free the returned instance
96  * 
97  * Returns: the widget factory
98  **/
99 ModestWidgetFactory*    modest_window_get_widget_factory    (ModestWindow *window);
100
101
102 G_END_DECLS
103
104 #endif /* __MODEST_WINDOW_H__ */