WIP: refactor ModestWindow and create ModestShell
[modest] / src / widgets / modest-shell.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_SHELL_H__
31 #define __MODEST_SHELL_H__
32
33 #ifdef HAVE_CONFIG_H
34 #include <config.h>
35 #endif /*HAVE_CONFIG_H*/
36
37 #include <glib-object.h>
38 #include <gtk/gtk.h>
39
40 G_BEGIN_DECLS
41  
42 typedef GtkWindow      ModestShellParent;
43 typedef GtkWindowClass ModestShellParentClass;
44
45 /* convenience macros */
46 #define MODEST_TYPE_SHELL             (modest_shell_get_type())
47 #define MODEST_SHELL(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SHELL,ModestShell))
48 #define MODEST_SHELL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SHELL,GObject))
49 #define MODEST_IS_SHELL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SHELL))
50 #define MODEST_IS_SHELL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SHELL))
51 #define MODEST_SHELL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SHELL,ModestShellClass))
52
53 typedef struct _ModestShell      ModestShell;
54 typedef struct _ModestShellClass ModestShellClass;
55
56 struct _ModestShell {
57          ModestShellParent parent;
58 };
59
60 struct _ModestShellClass {
61         ModestShellParentClass parent_class;
62
63         /* virtual methods */
64         void (*add_window_func) (ModestShell *self, ModestShellWindow *window);
65 };
66
67 /**
68  * modest_shell_get_type:
69  *
70  * get the #GType for #ModestShell
71  * 
72  * Returns: the type
73  */     
74 GType        modest_shell_get_type    (void) G_GNUC_CONST;
75
76
77 void modest_shell_add_window (ModestShell *self, ModestShellWindow *window);
78
79
80 G_END_DECLS
81
82 #endif /* __MODEST_WINDOW_H__ */