git.maemo.org Git - modest/blob - src/widgets/modest-edit-msg-window.h

   1 /* Copyright (c) 2006,2007 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 <tny-msg.h>
  34 #include <modest-window.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_EDIT_MSG_WINDOW             (modest_edit_msg_window_get_type())
  40 #define MODEST_EDIT_MSG_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_EDIT_MSG_WINDOW,ModestEditMsgWindow))
  41 #define MODEST_EDIT_MSG_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_EDIT_MSG_WINDOW,ModestWindow))
  42 #define MODEST_IS_EDIT_MSG_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_EDIT_MSG_WINDOW))
  43 #define MODEST_IS_EDIT_MSG_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_EDIT_MSG_WINDOW))
  44 #define MODEST_EDIT_MSG_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_EDIT_MSG_WINDOW,ModestEditMsgWindowClass))
  45
  46 typedef struct _ModestEditMsgWindow      ModestEditMsgWindow;
  47 typedef struct _ModestEditMsgWindowClass ModestEditMsgWindowClass;
  48
  49 struct _ModestEditMsgWindow {
  50          ModestWindow parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestEditMsgWindowClass {
  55         ModestWindowClass parent_class;
  56         /* insert signal callback declarations, eg. */
  57         /* void (* my_event) (ModestEditMsgWindow* obj); */
  58 };
  59
  60 typedef enum  {
  61         MODEST_EDIT_TYPE_NEW,
  62         MODEST_EDIT_TYPE_REPLY,
  63         MODEST_EDIT_TYPE_FORWARD,
  64         MODEST_EDIT_TYPE_VIEW,
  65
  66         MODEST_EDIT_TYPE_NUM
  67 } ModestEditType;
  68
  69 typedef struct _MsgData {
  70         gchar *from, *to, *cc, *bcc, *subject, *body;
  71 } MsgData;
  72
  73
  74 /**
  75  * modest_edit_msg_window_get_type:
  76  *
  77  * get the GType for the #ModestEditMsgWindow class
  78  *
  79  * Returns: a GType for #ModestEditMsgWindow
  80  */
  81 GType        modest_edit_msg_window_get_type    (void) G_GNUC_CONST;
  82
  83
  84 /**
  85  * modest_edit_msg_window_new:
  86  *
  87  * instantiates a new #ModestEditMsgWindow widget
  88  *
  89  * Returns: a new #ModestEditMsgWindow, or NULL in case of error
  90  */
  91 ModestWindow*   modest_edit_msg_window_new         (ModestEditType type);
  92
  93
  94 /**
  95  * modest_edit_msg_window_set_msg:
  96  * @self: a #ModestEditMsgWindow
  97  * @msg: a #TnyMsg
  98  *
  99  * shows the message @msg in a #ModestEditMsgWindow
 100  **/
 101 void         modest_edit_msg_window_set_msg     (ModestEditMsgWindow *self,
 102                                                  TnyMsg *msg);
 103
 104
 105 /**
 106  * modest_edit_msg_window_get_msg_data:
 107  * @self: a #ModestEditMsgWindow
 108  *
 109  * gets the message data already present in the edit message
 110  * window. The message data must be freed with
 111  * modest_edit_msg_window_free_msg_data
 112  *
 113  * Returns: the message data
 114  **/
 115 MsgData *               modest_edit_msg_window_get_msg_data          (ModestEditMsgWindow *self);
 116
 117 /**
 118  * modest_edit_msg_window_free_msg_data:
 119  * @self: a #ModestEditMsgWindow
 120  * @data:
 121  *
 122  * frees the message data passed as argument
 123  **/
 124 void                    modest_edit_msg_window_free_msg_data         (ModestEditMsgWindow *self,
 125                                                                       MsgData *data);
 126 G_END_DECLS
 127
 128 #endif /* __MODEST_EDIT_MSG_WINDOW_H__ */
 129