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 /** Get these with modest_msg_edit_window_get_msg_data()
  74  * and free them with modest_msg_edit_window_free_msg_data().
  75  */
  76 typedef struct  {
  77         gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
  78         GList *attachments;
  79         TnyHeaderFlags priority_flags;
  80         TnyMsg *draft_msg;
  81         gchar *account_name;
  82 } MsgData;
  83
  84 typedef struct {
  85         gboolean bold;
  86         gboolean italics;
  87         gboolean bullet;
  88         GdkColor color;
  89         const gchar *font_family;
  90         gint font_size;
  91         GtkJustification justification;
  92 } ModestMsgEditFormatState;
  93
  94
  95 /**
  96  * modest_msg_edit_window_get_type:
  97  *
  98  * get the GType for the #ModestMsgEditWindow class
  99  *
 100  * Returns: a GType for #ModestMsgEditWindow
 101  */
 102 GType        modest_msg_edit_window_get_type    (void) G_GNUC_CONST;
 103
 104
 105 /**
 106  * modest_msg_edit_window_new:
 107  * @msg: a #TnyMsg instance
 108  * @account_name: the account this message applies to
 109  * @preserve_is_rich: if @msg is not rich, open the message as plain text
 110  *
 111  * instantiates a new #ModestMsgEditWindow widget
 112  *
 113  * Returns: a new #ModestMsgEditWindow, or NULL in case of error
 114  */
 115 ModestWindow*   modest_msg_edit_window_new         (TnyMsg *msg,
 116                                                     const gchar *account_name,
 117                                                     gboolean preserve_is_rich);
 118
 119
 120 /**
 121  * modest_msg_edit_window_get_msg_data:
 122  * @self: a #ModestMsgEditWindow
 123  *
 124  * gets the message data already present in the edit message
 125  * window. The message data must be freed with
 126  * modest_msg_edit_window_free_msg_data
 127  *
 128  * Returns: the message data
 129  **/
 130 MsgData *               modest_msg_edit_window_get_msg_data          (ModestMsgEditWindow *self);
 131
 132 /**
 133  * modest_msg_edit_window_free_msg_data:
 134  * @self: a #ModestMsgEditWindow
 135  * @data:
 136  *
 137  * frees the message data passed as argument
 138  **/
 139 void                    modest_msg_edit_window_free_msg_data         (ModestMsgEditWindow *self,
 140                                                                       MsgData *data);
 141
 142 /**
 143  * modest_msg_edit_window_get_format:
 144  * @self: a #ModestMsgEditWindow
 145  *
 146  * obtains the format type of the message body.
 147  *
 148  * Returns: a #ModestMsgEditFormat
 149  **/
 150 ModestMsgEditFormat     modest_msg_edit_window_get_format            (ModestMsgEditWindow *self);
 151
 152 /**
 153  * modest_msg_edit_window_set_format:
 154  * @self: a #ModestMsgEditWindow
 155  * @format: a #ModestMsgEditFormat
 156  *
 157  * set the @format of the edit window message body.
 158  **/
 159 void                    modest_msg_edit_window_set_format            (ModestMsgEditWindow *self,
 160                                                                       ModestMsgEditFormat format);
 161
 162 /**
 163  * modest_msg_edit_window_get_format_state:
 164  * @self: a #ModestMsgEditWindow
 165  *
 166  * get the current format state (the format attributes the text user inserts
 167  * will get).
 168  *
 169  * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
 170  **/
 171 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state    (ModestMsgEditWindow *self);
 172
 173 /**
 174  * modest_msg_edit_window_set_format_state:
 175  * @self: a #ModestMsgEditWindow
 176  * @format_state: a #ModestMsgEditWindowFormatState
 177  *
 178  * sets a new format state (the format attributes the text user inserts
 179  * will get).
 180  **/
 181 void                    modest_msg_edit_window_set_format_state      (ModestMsgEditWindow *self,
 182                                                                       const ModestMsgEditFormatState *format_state);
 183
 184 /**
 185  * modest_msg_edit_window_select_color:
 186  * @self: a #ModestMsgEditWindow
 187  *
 188  * show color selection dialog and update text color
 189  */
 190 void                    modest_msg_edit_window_select_color          (ModestMsgEditWindow *window);
 191
 192 /**
 193  * modest_msg_edit_window_select_background_color:
 194  * @self: a #ModestMsgEditWindow
 195  *
 196  * show color selection dialog and update background color
 197  */
 198 void                    modest_msg_edit_window_select_background_color          (ModestMsgEditWindow *window);
 199
 200 /**
 201  * modest_msg_edit_window_insert_image:
 202  * @self: a #ModestMsgEditWindow
 203  *
 204  * show a file selection dialog to insert an image
 205  */
 206 void                    modest_msg_edit_window_insert_image          (ModestMsgEditWindow *window);
 207
 208 /**
 209  * modest_msg_edit_window_offer_attach_file:
 210  * @self: a #ModestMsgEditWindow
 211  *
 212  * show a file selection dialog to attach a file
 213  */
 214 void                    modest_msg_edit_window_offer_attach_file           (ModestMsgEditWindow *window);
 215
 216 /**
 217  * modest_msg_edit_window_attach_file_one:
 218  * @self: a #ModestMsgEditWindow
 219  * @file_uri: The URI of a file to attach to the email message.
 220  *
 221  * attach a file to a MsgEditWindow non interactively,
 222  * without file dialog. This is needed by dbus callbacks.
 223  */
 224 void                    modest_msg_edit_window_attach_file_one           (ModestMsgEditWindow *window, const gchar *file_uri);
 225
 226 /**
 227  * modest_msg_edit_window_remove_attachments:
 228  * @self: a #ModestMsgEditWindow
 229  * @att_list: a #GList of #TnyMimePart
 230  *
 231  * remove attachments in @att_list, with a confirmation dialog
 232  */
 233 void                    modest_msg_edit_window_remove_attachments    (ModestMsgEditWindow *window,
 234                                                                       GList *att_list);
 235
 236 /**
 237  * modest_msg_edit_window_add_part:
 238  * @self: a #ModestMsgEditWindow
 239  * @part: a #TnyMimePart
 240  *
 241  * Adds @part as an attachment
 242  */
 243 void                    modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
 244                                                          TnyMimePart *part);
 245
 246 /**
 247  * modest_msg_edit_window_show_cc:
 248  * @window: a #ModestMsgEditWindow
 249  * @show: a #gboolean
 250  *
 251  * Set the CC field as visible (or not visible) depending on @show
 252  */
 253 void                    modest_msg_edit_window_show_cc               (ModestMsgEditWindow *window, gboolean show);
 254
 255 /**
 256  * modest_msg_edit_window_show_bcc:
 257  * @window: a #ModestMsgEditWindow
 258  * @show: a #gboolean
 259  *
 260  * Set the BCC field as visible (or not visible) depending on @show
 261  */
 262 void                    modest_msg_edit_window_show_bcc               (ModestMsgEditWindow *window, gboolean show);
 263
 264 /**
 265  * modest_msg_edit_window_toggle_fullscreen:
 266  * @window: a #ModestMsgEditWindow
 267  *
 268  * toggles the current fullscreen status
 269  */
 270 void            modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
 271
 272 /**
 273  * modest_msg_edit_window_set_priority_flags:
 274  * @window: a #ModestMsgEditWindow
 275  * @priority_flags: a #TnyHeaderFlags with priority information
 276  *
 277  * Updates the icon and priority flag to send.
 278  */
 279 void            modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
 280                                                            TnyHeaderFlags priority_flags);
 281
 282 /**
 283  * modest_msg_edit_window_set_file_format:
 284  * @window: a #ModestMsgEditWindow
 285  * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
 286  *
 287  * Changes the current file format.
 288  */
 289 void            modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
 290                                                         gint file_format);
 291
 292 /**
 293  * modest_msg_edit_window_select_font:
 294  * @window: a #ModestMsgEditWindow
 295  *
 296  * Show the dialog to select the editor font and update the
 297  * used font in the editor.
 298  */
 299 void            modest_msg_edit_window_select_font        (ModestMsgEditWindow *window);
 300
 301 /**
 302  * modest_msg_edit_window_undo:
 303  * @window: a #ModestMsgEditWindow
 304  *
 305  * Undoes the last operation.
 306  */
 307 void            modest_msg_edit_window_undo               (ModestMsgEditWindow *window);
 308
 309 /**
 310  * modest_msg_edit_window_redo:
 311  * @window: a #ModestMsgEditWindow
 312  *
 313  * Revert last undo
 314  */
 315 void            modest_msg_edit_window_redo               (ModestMsgEditWindow *window);
 316
 317 /**
 318  * modest_msg_edit_window_select_contacts:
 319  * @window: a #ModestMsgEditWindow
 320  *
 321  * Shows the dialog to add contacts to the currently focused recipient list,
 322  * or to To: recipient if no recipient list is focused.
 323  */
 324 void            modest_msg_edit_window_select_contacts    (ModestMsgEditWindow *window);
 325
 326 /**
 327  * modest_msg_edit_window_check_names:
 328  * @window: a #ModestMsgEditWindow
 329  * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
 330  *
 331  * Validates all the recipients, and shows (if required) dialogs for adding contacts
 332  * or fixing problems in specific fields.
 333  *
 334  * Returns: %TRUE if all fields were validated, %FALSE otherwise
 335  */
 336 gboolean        modest_msg_edit_window_check_names    (ModestMsgEditWindow *window,
 337                                                        gboolean add_to_addressbook);
 338
 339 /**
 340  * modest_msg_edit_window_toggle_find_toolbar:
 341  * @window: a #ModestMsgEditWindow
 342  * @show: a #gboolean
 343  *
 344  * Shows/Hides the find toolbar
 345  */
 346 void            modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
 347                                                             gboolean show);
 348
 349
 350 /**
 351  * modest_msg_edit_window_is_modified:
 352  * @window: a #ModestMsgEditWindow
 353  *
 354  * Examines whether or not the message has been modified
 355  *
 356  * Returns: %TRUE if any field has been modified, %FALSE otherwise
 357  */
 358 gboolean        modest_msg_edit_window_is_modified         (ModestMsgEditWindow *window);
 359
 360 gboolean        modest_msg_edit_window_get_sent            (ModestMsgEditWindow *window);
 361 void            modest_msg_edit_window_set_sent            (ModestMsgEditWindow *window,
 362                                                             gboolean sent);
 363
 364 /**
 365  * modest_msg_edit_window_set_draft:
 366  * @window: a #ModestMsgEditWindow
 367  * @draft: a #TnyMsg, or %NULL
 368  *
 369  * Set @draft as the original draft message of the editor. This
 370  * message will be removed on saving or sending the message.
 371  */
 372 void            modest_msg_edit_window_set_draft           (ModestMsgEditWindow *window,
 373                                                             TnyMsg *draft);
 374
 375 G_END_DECLS
 376
 377 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */