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         TnyHeaderFlags priority_flags;
  77 } MsgData;
  78
  79 typedef struct {
  80         gboolean bold;
  81         gboolean italics;
  82         gboolean bullet;
  83         GdkColor color;
  84         const gchar *font_family;
  85         gint font_size;
  86         GtkJustification justification;
  87 } ModestMsgEditFormatState;
  88
  89
  90 /**
  91  * modest_msg_edit_window_get_type:
  92  *
  93  * get the GType for the #ModestMsgEditWindow class
  94  *
  95  * Returns: a GType for #ModestMsgEditWindow
  96  */
  97 GType        modest_msg_edit_window_get_type    (void) G_GNUC_CONST;
  98
  99
 100 /**
 101  * modest_msg_edit_window_new:
 102  * #msg: a #TnyMsg instance
 103  * #account_name: the account this message applies to
 104  *
 105  * instantiates a new #ModestMsgEditWindow widget
 106  *
 107  * Returns: a new #ModestMsgEditWindow, or NULL in case of error
 108  */
 109 ModestWindow*   modest_msg_edit_window_new         (TnyMsg *msg, const gchar *account_name);
 110
 111
 112 /**
 113  * modest_msg_edit_window_get_msg_data:
 114  * @self: a #ModestMsgEditWindow
 115  *
 116  * gets the message data already present in the edit message
 117  * window. The message data must be freed with
 118  * modest_msg_edit_window_free_msg_data
 119  *
 120  * Returns: the message data
 121  **/
 122 MsgData *               modest_msg_edit_window_get_msg_data          (ModestMsgEditWindow *self);
 123
 124 /**
 125  * modest_msg_edit_window_free_msg_data:
 126  * @self: a #ModestMsgEditWindow
 127  * @data:
 128  *
 129  * frees the message data passed as argument
 130  **/
 131 void                    modest_msg_edit_window_free_msg_data         (ModestMsgEditWindow *self,
 132                                                                       MsgData *data);
 133
 134 /**
 135  * modest_msg_edit_window_get_format:
 136  * @self: a #ModestMsgEditWindow
 137  *
 138  * obtains the format type of the message body.
 139  *
 140  * Returns: a #ModestMsgEditFormat
 141  **/
 142 ModestMsgEditFormat     modest_msg_edit_window_get_format            (ModestMsgEditWindow *self);
 143
 144 /**
 145  * modest_msg_edit_window_set_format:
 146  * @self: a #ModestMsgEditWindow
 147  * @format: a #ModestMsgEditFormat
 148  *
 149  * set the @format of the edit window message body.
 150  **/
 151 void                    modest_msg_edit_window_set_format            (ModestMsgEditWindow *self,
 152                                                                       ModestMsgEditFormat format);
 153
 154 /**
 155  * modest_msg_edit_window_get_format_state:
 156  * @self: a #ModestMsgEditWindow
 157  *
 158  * get the current format state (the format attributes the text user inserts
 159  * will get).
 160  *
 161  * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
 162  **/
 163 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state    (ModestMsgEditWindow *self);
 164
 165 /**
 166  * modest_msg_edit_window_set_format_state:
 167  * @self: a #ModestMsgEditWindow
 168  * @format_state: a #ModestMsgEditWindowFormatState
 169  *
 170  * sets a new format state (the format attributes the text user inserts
 171  * will get).
 172  **/
 173 void                    modest_msg_edit_window_set_format_state      (ModestMsgEditWindow *self,
 174                                                                       const ModestMsgEditFormatState *format_state);
 175
 176 /**
 177  * modest_msg_edit_window_select_color:
 178  * @self: a #ModestMsgEditWindow
 179  *
 180  * show color selection dialog and update text color
 181  */
 182 void                    modest_msg_edit_window_select_color          (ModestMsgEditWindow *window);
 183
 184 /**
 185  * modest_msg_edit_window_select_background_color:
 186  * @self: a #ModestMsgEditWindow
 187  *
 188  * show color selection dialog and update background color
 189  */
 190 void                    modest_msg_edit_window_select_background_color          (ModestMsgEditWindow *window);
 191
 192 /**
 193  * modest_msg_edit_window_insert_image:
 194  * @self: a #ModestMsgEditWindow
 195  *
 196  * show a file selection dialog to insert an image
 197  */
 198 void                    modest_msg_edit_window_insert_image          (ModestMsgEditWindow *window);
 199
 200 /**
 201  * modest_msg_edit_window_show_cc:
 202  * @window: a #ModestMsgEditWindow
 203  * @show: a #gboolean
 204  *
 205  * Set the CC field as visible (or not visible) depending on @show
 206  */
 207 void                    modest_msg_edit_window_show_cc               (ModestMsgEditWindow *window, gboolean show);
 208
 209 /**
 210  * modest_msg_edit_window_show_bcc:
 211  * @window: a #ModestMsgEditWindow
 212  * @show: a #gboolean
 213  *
 214  * Set the BCC field as visible (or not visible) depending on @show
 215  */
 216 void                    modest_msg_edit_window_show_bcc               (ModestMsgEditWindow *window, gboolean show);
 217
 218 /**
 219  * modest_msg_edit_window_toggle_fullscreen:
 220  * @window: a #ModestMsgEditWindow
 221  *
 222  * toggles the current fullscreen status
 223  */
 224 void            modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
 225
 226 /**
 227  * modest_msg_edit_window_set_priority_flags:
 228  * @window: a #ModestMsgEditWindow
 229  * @priority_flags: a #TnyHeaderFlags with priority information
 230  *
 231  * Updates the icon and priority flag to send.
 232  */
 233 void            modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
 234                                                            TnyHeaderFlags priority_flags);
 235
 236 /**
 237  * modest_msg_edit_window_set_file_format:
 238  * @window: a #ModestMsgEditWindow
 239  * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
 240  *
 241  * Changes the current file format.
 242  */
 243 void            modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
 244                                                         gint file_format);
 245
 246 /**
 247  * modest_msg_edit_window_select_font:
 248  * @window: a #ModestMsgEditWindow
 249  *
 250  * Show the dialog to select the editor font and update the
 251  * used font in the editor.
 252  */
 253 void            modest_msg_edit_window_select_font        (ModestMsgEditWindow *window);
 254
 255 /**
 256  * modest_msg_edit_window_undo:
 257  * @window: a #ModestMsgEditWindow
 258  *
 259  * Undoes the last operation.
 260  */
 261 void            modest_msg_edit_window_undo               (ModestMsgEditWindow *window);
 262
 263 /**
 264  * modest_msg_edit_window_select_contacts:
 265  * @window: a #ModestMsgEditWindow
 266  *
 267  * Shows the dialog to add contacts to the currently focused recipient list,
 268  * or to To: recipient if no recipient list is focused.
 269  */
 270 void            modest_msg_edit_window_select_contacts    (ModestMsgEditWindow *window);
 271
 272 /**
 273  * modest_msg_edit_window_check_names:
 274  * @window: a #ModestMsgEditWindow
 275  *
 276  * Validates all the recipients, and shows (if required) dialogs for adding contacts
 277  * or fixing problems in specific fields.
 278  *
 279  * Returns: %TRUE if all fields were validated, %FALSE otherwise
 280  */
 281 gboolean        modest_msg_edit_window_check_names    (ModestMsgEditWindow *window);
 282
 283 G_END_DECLS
 284
 285 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */
 286