1 /* Copyright (c) 2006,2007 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_MSG_EDIT_WINDOW_H__
31 #define __MODEST_MSG_EDIT_WINDOW_H__
34 #include <tny-vfs-stream.h>
35 #ifdef MODEST_TOOLKIT_HILDON2
36 #include <modest-hildon2-window.h>
38 #include <widgets/modest-window.h>
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))
50 typedef struct _ModestMsgEditWindow ModestMsgEditWindow;
51 typedef struct _ModestMsgEditWindowClass ModestMsgEditWindowClass;
53 struct _ModestMsgEditWindow {
54 #ifdef MODEST_TOOLKIT_HILDON2
55 ModestHildon2Window parent;
59 /* insert public members, if any */
62 struct _ModestMsgEditWindowClass {
63 #ifdef MODEST_TOOLKIT_HILDON2
64 ModestHildon2WindowClass parent_class;
66 ModestWindowClass parent_class;
68 /* insert signal callback declarations, eg. */
69 /* void (* my_event) (ModestMsgEditWindow* obj); */
74 MODEST_EDIT_TYPE_REPLY,
75 MODEST_EDIT_TYPE_FORWARD,
81 MODEST_MSG_EDIT_FORMAT_TEXT,
82 MODEST_MSG_EDIT_FORMAT_HTML
83 } ModestMsgEditFormat;
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;
95 /** Get these with modest_msg_edit_window_get_msg_data()
96 * and free them with modest_msg_edit_window_free_msg_data().
99 gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
100 gchar *references, *in_reply_to;
103 TnyHeaderFlags priority_flags;
106 TnyList *custom_header_pairs;
114 const gchar *font_family;
116 GtkJustification justification;
117 } ModestMsgEditFormatState;
121 * modest_msg_edit_window_get_type:
123 * get the GType for the #ModestMsgEditWindow class
125 * Returns: a GType for #ModestMsgEditWindow
127 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
131 * modest_msg_edit_window_new:
132 * @msg: a #TnyMsg instance
133 * @account_name: the account this message applies to
134 * @mailbox: the mailbox (if any)
135 * @preserve_is_rich: if @msg is not rich, open the message as plain text
137 * instantiates a new #ModestMsgEditWindow widget
139 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
141 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg,
142 const gchar *account_name,
143 const gchar *mailbox,
144 gboolean preserve_is_rich);
148 * modest_msg_edit_window_get_msg_data:
149 * @self: a #ModestMsgEditWindow
151 * gets the message data already present in the edit message
152 * window. The message data must be freed with
153 * modest_msg_edit_window_free_msg_data
155 * Returns: the message data
157 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
160 * modest_msg_edit_window_free_msg_data:
161 * @self: a #ModestMsgEditWindow
164 * frees the message data passed as argument
166 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
170 * modest_msg_edit_window_get_format:
171 * @self: a #ModestMsgEditWindow
173 * obtains the format type of the message body.
175 * Returns: a #ModestMsgEditFormat
177 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
180 * modest_msg_edit_window_set_format:
181 * @self: a #ModestMsgEditWindow
182 * @format: a #ModestMsgEditFormat
184 * set the @format of the edit window message body.
186 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
187 ModestMsgEditFormat format);
190 * modest_msg_edit_window_get_format_state:
191 * @self: a #ModestMsgEditWindow
193 * get the current format state (the format attributes the text user inserts
196 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
198 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
201 * modest_msg_edit_window_set_format_state:
202 * @self: a #ModestMsgEditWindow
203 * @format_state: a #ModestMsgEditWindowFormatState
205 * sets a new format state (the format attributes the text user inserts
208 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
209 const ModestMsgEditFormatState *format_state);
212 * modest_msg_edit_window_select_color:
213 * @self: a #ModestMsgEditWindow
215 * show color selection dialog and update text color
217 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
220 * modest_msg_edit_window_select_background_color:
221 * @self: a #ModestMsgEditWindow
223 * show color selection dialog and update background color
225 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
228 * modest_msg_edit_window_insert_image:
229 * @self: a #ModestMsgEditWindow
231 * show a file selection dialog to insert an image
233 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
236 * modest_msg_edit_window_offer_attach_file:
237 * @self: a #ModestMsgEditWindow
239 * show a file selection dialog to attach a file
241 void modest_msg_edit_window_offer_attach_file (ModestMsgEditWindow *window);
244 * modest_msg_edit_window_attach_file_one:
245 * @self: a #ModestMsgEditWindow
246 * @file_uri: The URI of a file to attach to the email message.
247 * @allowed_size: max size allowed for this attachment, 0 for unlimited
249 * attach a file to a MsgEditWindow non interactively,
250 * without file dialog. This is needed by dbus callbacks.
252 * Returns: the filesize (if available)
254 GnomeVFSFileSize modest_msg_edit_window_attach_file_one (ModestMsgEditWindow *window, const gchar *file_uri, GnomeVFSFileSize allowed_size);
257 * modest_msg_edit_window_remove_attachments:
258 * @self: a #ModestMsgEditWindow
259 * @att_list: a #GList of #TnyMimePart
261 * remove attachments in @att_list, with a confirmation dialog
263 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
267 * modest_msg_edit_window_get_parts_size:
268 * @window: a #ModestMsgEditWindow
269 * @parts_count: number of attachments and images attached to the message
270 * @parts_size: sum of sizes of attachments and images
272 void modest_msg_edit_window_get_parts_size (ModestMsgEditWindow *window,
274 guint64 *parts_size);
276 * modest_msg_edit_window_add_part:
277 * @self: a #ModestMsgEditWindow
278 * @part: a #TnyMimePart
280 * Adds @part as an attachment
282 void modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
286 * modest_msg_edit_window_show_cc:
287 * @window: a #ModestMsgEditWindow
290 * Set the CC field as visible (or not visible) depending on @show
292 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
295 * modest_msg_edit_window_show_bcc:
296 * @window: a #ModestMsgEditWindow
299 * Set the BCC field as visible (or not visible) depending on @show
301 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
304 * modest_msg_edit_window_set_priority_flags:
305 * @window: a #ModestMsgEditWindow
306 * @priority_flags: a #TnyHeaderFlags with priority information
308 * Updates the icon and priority flag to send.
310 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
311 TnyHeaderFlags priority_flags);
314 * modest_msg_edit_window_set_file_format:
315 * @window: a #ModestMsgEditWindow
316 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
318 * Changes the current file format.
320 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
324 * modest_msg_edit_window_select_font:
325 * @window: a #ModestMsgEditWindow
327 * Show the dialog to select the editor font and update the
328 * used font in the editor.
330 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
333 * modest_msg_edit_window_undo:
334 * @window: a #ModestMsgEditWindow
336 * Undoes the last operation.
338 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
341 * modest_msg_edit_window_can_undo:
342 * @window: a #ModestMsgEditWindow
344 * Checks if an undo operation is available
346 * Returns: %TRUE if undo can be done, %FALSE otherwise.
348 gboolean modest_msg_edit_window_can_undo (ModestMsgEditWindow *window);
351 * modest_msg_edit_window_redo:
352 * @window: a #ModestMsgEditWindow
356 void modest_msg_edit_window_redo (ModestMsgEditWindow *window);
359 * modest_msg_edit_window_can_redo:
360 * @window: a #ModestMsgEditWindow
362 * Checks if a redp operation is available
364 * Returns: %TRUE if redo can be done, %FALSE otherwise.
366 gboolean modest_msg_edit_window_can_redo (ModestMsgEditWindow *window);
369 * modest_msg_edit_window_select_contacts:
370 * @window: a #ModestMsgEditWindow
372 * Shows the dialog to add contacts to the currently focused recipient list,
373 * or to To: recipient if no recipient list is focused.
375 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
378 * modest_msg_edit_window_add_to_contacts:
379 * @self: a #ModestMsgEditWindow
381 * activates the add to contacts use. It shows the add to contacts
382 * dialog to select the recipient to add.
384 void modest_msg_edit_window_add_to_contacts (ModestMsgEditWindow *self);
387 * modest_msg_edit_window_check_names:
388 * @window: a #ModestMsgEditWindow
389 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
391 * Validates all the recipients, and shows (if required) dialogs for adding contacts
392 * or fixing problems in specific fields.
394 * Returns: %TRUE if all fields were validated, %FALSE otherwise
396 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window,
397 gboolean add_to_addressbook);
400 * modest_msg_edit_window_has_pending_addresses:
401 * @window: a #ModestMsgEditWindow
402 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
404 * Validates all the recipients, and checks if there are addresses in
405 * any field that could be added to the addressbook
407 * Returns: %TRUE if there are valid pending addresses, %FALSE otherwise
409 gboolean modest_msg_edit_window_has_pending_addresses (ModestMsgEditWindow *window);
412 * modest_msg_edit_window_toggle_find_toolbar:
413 * @window: a #ModestMsgEditWindow
416 * Shows/Hides the find toolbar
418 void modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
423 * modest_msg_edit_window_is_modified:
424 * @window: a #ModestMsgEditWindow
426 * Examines whether or not the message has been modified
428 * Returns: %TRUE if any field has been modified, %FALSE otherwise
430 gboolean modest_msg_edit_window_is_modified (ModestMsgEditWindow *window);
433 * modest_msg_edit_window_reset_modified:
434 * @window: a #ModestMsgEditWindow
435 * @modified: wheter or not we want to make the buffer as modified or not
437 * Sets the message as modified or not
439 void modest_msg_edit_window_set_modified (ModestMsgEditWindow *window,
443 gboolean modest_msg_edit_window_get_sent (ModestMsgEditWindow *window);
444 void modest_msg_edit_window_set_sent (ModestMsgEditWindow *window,
448 * modest_msg_edit_window_set_draft:
449 * @window: a #ModestMsgEditWindow
450 * @draft: a #TnyMsg, or %NULL
452 * Set @draft as the original draft message of the editor. This
453 * message will be removed on saving or sending the message.
455 void modest_msg_edit_window_set_draft (ModestMsgEditWindow *window,
458 * modest_msg_edit_window_get_message_uid:
459 * @msg: an #ModestMsgEditWindow instance
461 * gets the unique identifier for the message in this msg editor.
462 * This is the identifier of the draft or outbox message the editor was
463 * opened from. If it's a new message, then it returns %NULL
465 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
467 const gchar* modest_msg_edit_window_get_message_uid (ModestMsgEditWindow *window);
470 * modest_msg_edit_window_get_child_widget:
471 * @win: a #ModestMsgEditWindow
472 * @widget_type: the type of the child to obtain
474 * Obtain the child widget of @win of type @widget_type
476 * Returns: a #GtkWidget, or %NULL
479 modest_msg_edit_window_get_child_widget (ModestMsgEditWindow *win,
480 ModestMsgEditWindowWidgetType widget_type);
483 * modest_msg_edit_window_get_clipboard_text:
484 * @win: a #ModestMsgEditWindow
486 * Obtains the currently selected text in selection clipboard
491 modest_msg_edit_window_get_clipboard_text (ModestMsgEditWindow *win);
494 * modest_msg_edit_window_set_custom_header_pairs:
495 * @win: a #ModestMsgEditWindow
496 * @header_pairs: a #TnyList of #TnyPair
498 * sets a list of custom header pairs that will be added to the created
502 modest_msg_edit_window_set_custom_header_pairs (ModestMsgEditWindow *self,
503 TnyList *header_pairs);
507 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */