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 enum {
  69         MODEST_MSG_EDIT_FORMAT_TEXT,
  70         MODEST_MSG_EDIT_FORMAT_HTML
  71 } ModestMsgEditFormat;
  72
  73 typedef struct  {
  74         gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
  75         GList *attachments;
  76 } MsgData;
  77
  78 typedef struct {
  79         gboolean bold;
  80         gboolean italics;
  81         gboolean bullet;
  82         GdkColor color;
  83         const gchar *font_family;
  84         gint font_size;
  85         GtkJustification justification;
  86 } ModestMsgEditFormatState;
  87
  88
  89 /**
  90  * modest_msg_edit_window_get_type:
  91  *
  92  * get the GType for the #ModestMsgEditWindow class
  93  *
  94  * Returns: a GType for #ModestMsgEditWindow
  95  */
  96 GType        modest_msg_edit_window_get_type    (void) G_GNUC_CONST;
  97
  98
  99 /**
 100  * modest_msg_edit_window_new:
 101  * #msg: a #TnyMsg instance
 102  * #account_name: the account this message applies to
 103  *
 104  * instantiates a new #ModestMsgEditWindow widget
 105  *
 106  * Returns: a new #ModestMsgEditWindow, or NULL in case of error
 107  */
 108 ModestWindow*   modest_msg_edit_window_new         (TnyMsg *msg, const gchar *account_name);
 109
 110
 111 /**
 112  * modest_msg_edit_window_get_msg_data:
 113  * @self: a #ModestMsgEditWindow
 114  *
 115  * gets the message data already present in the edit message
 116  * window. The message data must be freed with
 117  * modest_msg_edit_window_free_msg_data
 118  *
 119  * Returns: the message data
 120  **/
 121 MsgData *               modest_msg_edit_window_get_msg_data          (ModestMsgEditWindow *self);
 122
 123 /**
 124  * modest_msg_edit_window_free_msg_data:
 125  * @self: a #ModestMsgEditWindow
 126  * @data:
 127  *
 128  * frees the message data passed as argument
 129  **/
 130 void                    modest_msg_edit_window_free_msg_data         (ModestMsgEditWindow *self,
 131                                                                       MsgData *data);
 132
 133 /**
 134  * modest_msg_edit_window_get_format:
 135  * @self: a #ModestMsgEditWindow
 136  *
 137  * obtains the format type of the message body.
 138  *
 139  * Returns: a #ModestMsgEditFormat
 140  **/
 141 ModestMsgEditFormat     modest_msg_edit_window_get_format            (ModestMsgEditWindow *self);
 142
 143 /**
 144  * modest_msg_edit_window_set_format:
 145  * @self: a #ModestMsgEditWindow
 146  * @format: a #ModestMsgEditFormat
 147  *
 148  * set the @format of the edit window message body.
 149  **/
 150 void                    modest_msg_edit_window_set_format            (ModestMsgEditWindow *self,
 151                                                                       ModestMsgEditFormat format);
 152
 153 /**
 154  * modest_msg_edit_window_get_format_state:
 155  * @self: a #ModestMsgEditWindow
 156  *
 157  * get the current format state (the format attributes the text user inserts
 158  * will get).
 159  *
 160  * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
 161  **/
 162 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state    (ModestMsgEditWindow *self);
 163
 164 /**
 165  * modest_msg_edit_window_set_format_state:
 166  * @self: a #ModestMsgEditWindow
 167  * @format_state: a #ModestMsgEditWindowFormatState
 168  *
 169  * sets a new format state (the format attributes the text user inserts
 170  * will get).
 171  **/
 172 void                    modest_msg_edit_window_set_format_state      (ModestMsgEditWindow *self,
 173                                                                       const ModestMsgEditFormatState *format_state);
 174
 175 /**
 176  * modest_msg_edit_window_select_color:
 177  * @self: a #ModestMsgEditWindow
 178  *
 179  * show color selection dialog and update text color
 180  */
 181 void                    modest_msg_edit_window_select_color          (ModestMsgEditWindow *window);
 182
 183 /**
 184  * modest_msg_edit_window_select_background_color:
 185  * @self: a #ModestMsgEditWindow
 186  *
 187  * show color selection dialog and update background color
 188  */
 189 void                    modest_msg_edit_window_select_background_color          (ModestMsgEditWindow *window);
 190
 191 /**
 192  * modest_msg_edit_window_insert_image:
 193  * @self: a #ModestMsgEditWindow
 194  *
 195  * show a file selection dialog to insert an image
 196  */
 197 void                    modest_msg_edit_window_insert_image          (ModestMsgEditWindow *window);
 198
 199 G_END_DECLS
 200
 201 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */
 202