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 <tny-vfs-stream.h>
  35 #ifdef MODEST_TOOLKIT_HILDON2
  36 #include <modest-hildon2-window.h>
  37 #endif
  38 #include <widgets/modest-window.h>
  39
  40 G_BEGIN_DECLS
  41
  42 /* convenience macros */
  43 #define MODEST_TYPE_MSG_EDIT_WINDOW             (modest_msg_edit_window_get_type())
  44 #define MODEST_MSG_EDIT_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindow))
  45 #define MODEST_MSG_EDIT_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_EDIT_WINDOW,ModestWindow))
  46 #define MODEST_IS_MSG_EDIT_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_EDIT_WINDOW))
  47 #define MODEST_IS_MSG_EDIT_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_EDIT_WINDOW))
  48 #define MODEST_MSG_EDIT_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindowClass))
  49
  50 typedef struct _ModestMsgEditWindow      ModestMsgEditWindow;
  51 typedef struct _ModestMsgEditWindowClass ModestMsgEditWindowClass;
  52
  53 struct _ModestMsgEditWindow {
  54 #ifdef MODEST_TOOLKIT_HILDON2
  55         ModestHildon2Window parent;
  56 #else
  57          ModestWindow parent;
  58 #endif
  59         /* insert public members, if any */
  60 };
  61
  62 struct _ModestMsgEditWindowClass {
  63 #ifdef MODEST_TOOLKIT_HILDON2
  64         ModestHildon2WindowClass parent_class;
  65 #else
  66         ModestWindowClass parent_class;
  67 #endif
  68         /* insert signal callback declarations, eg. */
  69         /* void (* my_event) (ModestMsgEditWindow* obj); */
  70 };
  71
  72 typedef enum  {
  73         MODEST_EDIT_TYPE_NEW,
  74         MODEST_EDIT_TYPE_REPLY,
  75         MODEST_EDIT_TYPE_FORWARD,
  76
  77         MODEST_EDIT_TYPE_NUM
  78 } ModestEditType;
  79
  80 typedef enum {
  81         MODEST_MSG_EDIT_FORMAT_TEXT,
  82         MODEST_MSG_EDIT_FORMAT_HTML
  83 } ModestMsgEditFormat;
  84
  85 typedef enum {
  86         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BODY,
  87         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_TO,
  88         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_CC,
  89         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BCC,
  90         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_SUBJECT,
  91         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_ATTACHMENTS,
  92         MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_NUM,
  93 } ModestMsgEditWindowWidgetType;
  94
  95 /** Get these with modest_msg_edit_window_get_msg_data()
  96  * and free them with modest_msg_edit_window_free_msg_data().
  97  */
  98 typedef struct  {
  99         gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
 100         gchar *references, *in_reply_to;
 101         GList *attachments;
 102         GList *images;
 103         TnyHeaderFlags priority_flags;
 104         TnyMsg *draft_msg;
 105         gchar *account_name;
 106 } MsgData;
 107
 108 typedef struct {
 109         gboolean bold;
 110         gboolean italics;
 111         gboolean bullet;
 112         GdkColor color;
 113         const gchar *font_family;
 114         gint font_size;
 115         GtkJustification justification;
 116 } ModestMsgEditFormatState;
 117
 118
 119 /**
 120  * modest_msg_edit_window_get_type:
 121  *
 122  * get the GType for the #ModestMsgEditWindow class
 123  *
 124  * Returns: a GType for #ModestMsgEditWindow
 125  */
 126 GType        modest_msg_edit_window_get_type    (void) G_GNUC_CONST;
 127
 128
 129 /**
 130  * modest_msg_edit_window_new:
 131  * @msg: a #TnyMsg instance
 132  * @account_name: the account this message applies to
 133  * @preserve_is_rich: if @msg is not rich, open the message as plain text
 134  *
 135  * instantiates a new #ModestMsgEditWindow widget
 136  *
 137  * Returns: a new #ModestMsgEditWindow, or NULL in case of error
 138  */
 139 ModestWindow*   modest_msg_edit_window_new         (TnyMsg *msg,
 140                                                     const gchar *account_name,
 141                                                     gboolean preserve_is_rich);
 142
 143
 144 /**
 145  * modest_msg_edit_window_get_msg_data:
 146  * @self: a #ModestMsgEditWindow
 147  *
 148  * gets the message data already present in the edit message
 149  * window. The message data must be freed with
 150  * modest_msg_edit_window_free_msg_data
 151  *
 152  * Returns: the message data
 153  **/
 154 MsgData *               modest_msg_edit_window_get_msg_data          (ModestMsgEditWindow *self);
 155
 156 /**
 157  * modest_msg_edit_window_free_msg_data:
 158  * @self: a #ModestMsgEditWindow
 159  * @data:
 160  *
 161  * frees the message data passed as argument
 162  **/
 163 void                    modest_msg_edit_window_free_msg_data         (ModestMsgEditWindow *self,
 164                                                                       MsgData *data);
 165
 166 /**
 167  * modest_msg_edit_window_get_format:
 168  * @self: a #ModestMsgEditWindow
 169  *
 170  * obtains the format type of the message body.
 171  *
 172  * Returns: a #ModestMsgEditFormat
 173  **/
 174 ModestMsgEditFormat     modest_msg_edit_window_get_format            (ModestMsgEditWindow *self);
 175
 176 /**
 177  * modest_msg_edit_window_set_format:
 178  * @self: a #ModestMsgEditWindow
 179  * @format: a #ModestMsgEditFormat
 180  *
 181  * set the @format of the edit window message body.
 182  **/
 183 void                    modest_msg_edit_window_set_format            (ModestMsgEditWindow *self,
 184                                                                       ModestMsgEditFormat format);
 185
 186 /**
 187  * modest_msg_edit_window_get_format_state:
 188  * @self: a #ModestMsgEditWindow
 189  *
 190  * get the current format state (the format attributes the text user inserts
 191  * will get).
 192  *
 193  * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
 194  **/
 195 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state    (ModestMsgEditWindow *self);
 196
 197 /**
 198  * modest_msg_edit_window_set_format_state:
 199  * @self: a #ModestMsgEditWindow
 200  * @format_state: a #ModestMsgEditWindowFormatState
 201  *
 202  * sets a new format state (the format attributes the text user inserts
 203  * will get).
 204  **/
 205 void                    modest_msg_edit_window_set_format_state      (ModestMsgEditWindow *self,
 206                                                                       const ModestMsgEditFormatState *format_state);
 207
 208 /**
 209  * modest_msg_edit_window_select_color:
 210  * @self: a #ModestMsgEditWindow
 211  *
 212  * show color selection dialog and update text color
 213  */
 214 void                    modest_msg_edit_window_select_color          (ModestMsgEditWindow *window);
 215
 216 /**
 217  * modest_msg_edit_window_select_background_color:
 218  * @self: a #ModestMsgEditWindow
 219  *
 220  * show color selection dialog and update background color
 221  */
 222 void                    modest_msg_edit_window_select_background_color          (ModestMsgEditWindow *window);
 223
 224 /**
 225  * modest_msg_edit_window_insert_image:
 226  * @self: a #ModestMsgEditWindow
 227  *
 228  * show a file selection dialog to insert an image
 229  */
 230 void                    modest_msg_edit_window_insert_image          (ModestMsgEditWindow *window);
 231
 232 /**
 233  * modest_msg_edit_window_offer_attach_file:
 234  * @self: a #ModestMsgEditWindow
 235  *
 236  * show a file selection dialog to attach a file
 237  */
 238 void                    modest_msg_edit_window_offer_attach_file           (ModestMsgEditWindow *window);
 239
 240 /**
 241  * modest_msg_edit_window_attach_file_one:
 242  * @self: a #ModestMsgEditWindow
 243  * @file_uri: The URI of a file to attach to the email message.
 244  * @allowed_size: max size allowed for this attachment, 0 for unlimited
 245  *
 246  * attach a file to a MsgEditWindow non interactively,
 247  * without file dialog. This is needed by dbus callbacks.
 248  *
 249  * Returns: the filesize (if available)
 250  */
 251 GnomeVFSFileSize modest_msg_edit_window_attach_file_one           (ModestMsgEditWindow *window, const gchar *file_uri, GnomeVFSFileSize allowed_size);
 252
 253 /**
 254  * modest_msg_edit_window_remove_attachments:
 255  * @self: a #ModestMsgEditWindow
 256  * @att_list: a #GList of #TnyMimePart
 257  *
 258  * remove attachments in @att_list, with a confirmation dialog
 259  */
 260 void                    modest_msg_edit_window_remove_attachments    (ModestMsgEditWindow *window,
 261                                                                       TnyList *att_list);
 262
 263 /**
 264  * modest_msg_edit_window_get_parts_size:
 265  * @window: a #ModestMsgEditWindow
 266  * @parts_count: number of attachments and images attached to the message
 267  * @parts_size: sum of sizes of attachments and images
 268  */
 269 void                    modest_msg_edit_window_get_parts_size (ModestMsgEditWindow *window,
 270                                                                gint *parts_count,
 271                                                                guint64 *parts_size);
 272 /**
 273  * modest_msg_edit_window_add_part:
 274  * @self: a #ModestMsgEditWindow
 275  * @part: a #TnyMimePart
 276  *
 277  * Adds @part as an attachment
 278  */
 279 void                    modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
 280                                                          TnyMimePart *part);
 281
 282 /**
 283  * modest_msg_edit_window_show_cc:
 284  * @window: a #ModestMsgEditWindow
 285  * @show: a #gboolean
 286  *
 287  * Set the CC field as visible (or not visible) depending on @show
 288  */
 289 void                    modest_msg_edit_window_show_cc               (ModestMsgEditWindow *window, gboolean show);
 290
 291 /**
 292  * modest_msg_edit_window_show_bcc:
 293  * @window: a #ModestMsgEditWindow
 294  * @show: a #gboolean
 295  *
 296  * Set the BCC field as visible (or not visible) depending on @show
 297  */
 298 void                    modest_msg_edit_window_show_bcc               (ModestMsgEditWindow *window, gboolean show);
 299
 300 /**
 301  * modest_msg_edit_window_set_priority_flags:
 302  * @window: a #ModestMsgEditWindow
 303  * @priority_flags: a #TnyHeaderFlags with priority information
 304  *
 305  * Updates the icon and priority flag to send.
 306  */
 307 void            modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
 308                                                            TnyHeaderFlags priority_flags);
 309
 310 /**
 311  * modest_msg_edit_window_set_file_format:
 312  * @window: a #ModestMsgEditWindow
 313  * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
 314  *
 315  * Changes the current file format.
 316  */
 317 void            modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
 318                                                         gint file_format);
 319
 320 /**
 321  * modest_msg_edit_window_select_font:
 322  * @window: a #ModestMsgEditWindow
 323  *
 324  * Show the dialog to select the editor font and update the
 325  * used font in the editor.
 326  */
 327 void            modest_msg_edit_window_select_font        (ModestMsgEditWindow *window);
 328
 329 /**
 330  * modest_msg_edit_window_undo:
 331  * @window: a #ModestMsgEditWindow
 332  *
 333  * Undoes the last operation.
 334  */
 335 void            modest_msg_edit_window_undo               (ModestMsgEditWindow *window);
 336
 337 /**
 338  * modest_msg_edit_window_can_undo:
 339  * @window: a #ModestMsgEditWindow
 340  *
 341  * Checks if an undo operation is available
 342  *
 343  * Returns: %TRUE if undo can be done, %FALSE otherwise.
 344  */
 345 gboolean            modest_msg_edit_window_can_undo               (ModestMsgEditWindow *window);
 346
 347 /**
 348  * modest_msg_edit_window_redo:
 349  * @window: a #ModestMsgEditWindow
 350  *
 351  * Revert last undo
 352  */
 353 void            modest_msg_edit_window_redo               (ModestMsgEditWindow *window);
 354
 355 /**
 356  * modest_msg_edit_window_can_redo:
 357  * @window: a #ModestMsgEditWindow
 358  *
 359  * Checks if a redp operation is available
 360  *
 361  * Returns: %TRUE if redo can be done, %FALSE otherwise.
 362  */
 363 gboolean            modest_msg_edit_window_can_redo               (ModestMsgEditWindow *window);
 364
 365 /**
 366  * modest_msg_edit_window_select_contacts:
 367  * @window: a #ModestMsgEditWindow
 368  *
 369  * Shows the dialog to add contacts to the currently focused recipient list,
 370  * or to To: recipient if no recipient list is focused.
 371  */
 372 void            modest_msg_edit_window_select_contacts    (ModestMsgEditWindow *window);
 373
 374 /**
 375  * modest_msg_edit_window_check_names:
 376  * @window: a #ModestMsgEditWindow
 377  * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
 378  *
 379  * Validates all the recipients, and shows (if required) dialogs for adding contacts
 380  * or fixing problems in specific fields.
 381  *
 382  * Returns: %TRUE if all fields were validated, %FALSE otherwise
 383  */
 384 gboolean        modest_msg_edit_window_check_names    (ModestMsgEditWindow *window,
 385                                                        gboolean add_to_addressbook);
 386
 387 /**
 388  * modest_msg_edit_window_toggle_find_toolbar:
 389  * @window: a #ModestMsgEditWindow
 390  * @show: a #gboolean
 391  *
 392  * Shows/Hides the find toolbar
 393  */
 394 void            modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
 395                                                             gboolean show);
 396
 397
 398 /**
 399  * modest_msg_edit_window_is_modified:
 400  * @window: a #ModestMsgEditWindow
 401  *
 402  * Examines whether or not the message has been modified
 403  *
 404  * Returns: %TRUE if any field has been modified, %FALSE otherwise
 405  */
 406 gboolean        modest_msg_edit_window_is_modified         (ModestMsgEditWindow *window);
 407
 408 /**
 409  * modest_msg_edit_window_reset_modified:
 410  * @window: a #ModestMsgEditWindow
 411  * @modified: wheter or not we want to make the buffer as modified or not
 412  *
 413  * Sets the message as modified or not
 414  */
 415 void            modest_msg_edit_window_set_modified      (ModestMsgEditWindow *window,
 416                                                           gboolean modified);
 417
 418
 419 gboolean        modest_msg_edit_window_get_sent            (ModestMsgEditWindow *window);
 420 void            modest_msg_edit_window_set_sent            (ModestMsgEditWindow *window,
 421                                                             gboolean sent);
 422
 423 /**
 424  * modest_msg_edit_window_set_draft:
 425  * @window: a #ModestMsgEditWindow
 426  * @draft: a #TnyMsg, or %NULL
 427  *
 428  * Set @draft as the original draft message of the editor. This
 429  * message will be removed on saving or sending the message.
 430  */
 431 void            modest_msg_edit_window_set_draft           (ModestMsgEditWindow *window,
 432                                                             TnyMsg *draft);
 433 /**
 434  * modest_msg_edit_window_get_message_uid:
 435  * @msg: an #ModestMsgEditWindow instance
 436  *
 437  * gets the unique identifier for the message in this msg editor.
 438  * This is the identifier of the draft or outbox message the editor was
 439  * opened from. If it's a new message, then it returns %NULL
 440  *
 441  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 442  */
 443 const gchar*    modest_msg_edit_window_get_message_uid (ModestMsgEditWindow *window);
 444
 445 /**
 446  * modest_msg_edit_window_get_child_widget:
 447  * @win: a #ModestMsgEditWindow
 448  * @widget_type: the type of the child to obtain
 449  *
 450  * Obtain the child widget of @win of type @widget_type
 451  *
 452  * Returns: a #GtkWidget, or %NULL
 453  */
 454 GtkWidget *
 455 modest_msg_edit_window_get_child_widget (ModestMsgEditWindow *win,
 456                                          ModestMsgEditWindowWidgetType widget_type);
 457
 458 /**
 459  * modest_msg_edit_window_get_clipboard_text:
 460  * @win: a #ModestMsgEditWindow
 461  *
 462  * Obtains the currently selected text in selection clipboard
 463  *
 464  * Returns: a string
 465  */
 466 const gchar *
 467 modest_msg_edit_window_get_clipboard_text (ModestMsgEditWindow *win);
 468
 469 G_END_DECLS
 470
 471 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */