git.maemo.org Git - modest/blob - src/widgets/modest-msg-edit-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_MSG_EDIT_WINDOW_H__
  31 #define __MODEST_MSG_EDIT_WINDOW_H__
  32
  33 #include <tny-msg.h>
  34 #include <widgets/modest-window.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_MSG_EDIT_WINDOW             (modest_msg_edit_window_get_type())
  40 #define MODEST_MSG_EDIT_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindow))
  41 #define MODEST_MSG_EDIT_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_EDIT_WINDOW,ModestWindow))
  42 #define MODEST_IS_MSG_EDIT_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_EDIT_WINDOW))
  43 #define MODEST_IS_MSG_EDIT_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_EDIT_WINDOW))
  44 #define MODEST_MSG_EDIT_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindowClass))
  45
  46 typedef struct _ModestMsgEditWindow      ModestMsgEditWindow;
  47 typedef struct _ModestMsgEditWindowClass ModestMsgEditWindowClass;
  48
  49 struct _ModestMsgEditWindow {
  50          ModestWindow parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestMsgEditWindowClass {
  55         ModestWindowClass parent_class;
  56         /* insert signal callback declarations, eg. */
  57         /* void (* my_event) (ModestMsgEditWindow* obj); */
  58 };
  59
  60 typedef enum  {
  61         MODEST_EDIT_TYPE_NEW,
  62         MODEST_EDIT_TYPE_REPLY,
  63         MODEST_EDIT_TYPE_FORWARD,
  64
  65         MODEST_EDIT_TYPE_NUM
  66 } ModestEditType;
  67
  68 typedef struct  {
  69         gchar *from, *to, *cc, *bcc, *subject, *body;
  70 } MsgData;
  71
  72
  73 /**
  74  * modest_msg_edit_window_get_type:
  75  *
  76  * get the GType for the #ModestMsgEditWindow class
  77  *
  78  * Returns: a GType for #ModestMsgEditWindow
  79  */
  80 GType        modest_msg_edit_window_get_type    (void) G_GNUC_CONST;
  81
  82
  83 /**
  84  * modest_msg_edit_window_new:
  85  * #msg: a #TnyMsg instance
  86  * #account_name: the account this message applies to
  87  *
  88  * instantiates a new #ModestMsgEditWindow widget
  89  *
  90  * Returns: a new #ModestMsgEditWindow, or NULL in case of error
  91  */
  92 ModestWindow*   modest_msg_edit_window_new         (TnyMsg *msg, const gchar *account_name);
  93
  94
  95 /**
  96  * modest_msg_edit_window_get_msg_data:
  97  * @self: a #ModestMsgEditWindow
  98  *
  99  * gets the message data already present in the edit message
 100  * window. The message data must be freed with
 101  * modest_msg_edit_window_free_msg_data
 102  *
 103  * Returns: the message data
 104  **/
 105 MsgData *               modest_msg_edit_window_get_msg_data          (ModestMsgEditWindow *self);
 106
 107 /**
 108  * modest_msg_edit_window_free_msg_data:
 109  * @self: a #ModestMsgEditWindow
 110  * @data:
 111  *
 112  * frees the message data passed as argument
 113  **/
 114 void                    modest_msg_edit_window_free_msg_data         (ModestMsgEditWindow *self,
 115                                                                       MsgData *data);
 116 G_END_DECLS
 117
 118 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */
 119