* A lot of changes in the documentation, now it's generated correctly
[modest] / src / gtk / modest-edit-msg-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_EDIT_MSG_WINDOW_H__
31 #define __MODEST_EDIT_MSG_WINDOW_H__
32
33 #include <gtk/gtk.h>
34 #include <tny-msg.h>
35 #include "modest-conf.h"
36 #include "modest-widget-factory.h"
37
38 G_BEGIN_DECLS
39
40 /* convenience macros */
41 #define MODEST_TYPE_EDIT_MSG_WINDOW             (modest_edit_msg_window_get_type())
42 #define MODEST_EDIT_MSG_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_EDIT_MSG_WINDOW,ModestEditMsgWindow))
43 #define MODEST_EDIT_MSG_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_EDIT_MSG_WINDOW,GtkWindow))
44 #define MODEST_IS_EDIT_MSG_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_EDIT_MSG_WINDOW))
45 #define MODEST_IS_EDIT_MSG_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_EDIT_MSG_WINDOW))
46 #define MODEST_EDIT_MSG_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_EDIT_MSG_WINDOW,ModestEditMsgWindowClass))
47
48 typedef struct _ModestEditMsgWindow      ModestEditMsgWindow;
49 typedef struct _ModestEditMsgWindowClass ModestEditMsgWindowClass;
50
51 struct _ModestEditMsgWindow {
52          GtkWindow parent;
53         /* insert public members, if any */
54 };
55
56 struct _ModestEditMsgWindowClass {
57         GtkWindowClass parent_class;
58         /* insert signal callback declarations, eg. */
59         /* void (* my_event) (ModestEditMsgWindow* obj); */
60 };
61
62
63 typedef enum _ModestEditType {
64         MODEST_EDIT_TYPE_NEW,
65         MODEST_EDIT_TYPE_REPLY,
66         MODEST_EDIT_TYPE_FORWARD,
67         MODEST_EDIT_TYPE_VIEW,
68         
69         MODEST_EDIT_TYPE_NUM
70 } ModestEditType;
71 /* typedef enum _ModestEditType ModestEditType; */
72
73
74 /* member functions */
75 GType        modest_edit_msg_window_get_type    (void) G_GNUC_CONST;
76
77 GtkWidget*   modest_edit_msg_window_new         (ModestWidgetFactory *factory,
78                                                  ModestEditType type,
79                                                  TnyMsg *msg);
80 G_END_DECLS
81
82 #endif /* __MODEST_EDIT_MSG_WINDOW_H__ */
83