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 <modest-shell-window.h>
40 #include <widgets/modest-window.h>
44 /* convenience macros */
45 #define MODEST_TYPE_MSG_EDIT_WINDOW (modest_msg_edit_window_get_type())
46 #define MODEST_MSG_EDIT_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindow))
47 #define MODEST_MSG_EDIT_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_EDIT_WINDOW,ModestWindow))
48 #define MODEST_IS_MSG_EDIT_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_EDIT_WINDOW))
49 #define MODEST_IS_MSG_EDIT_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_EDIT_WINDOW))
50 #define MODEST_MSG_EDIT_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_EDIT_WINDOW,ModestMsgEditWindowClass))
52 typedef struct _ModestMsgEditWindow ModestMsgEditWindow;
53 typedef struct _ModestMsgEditWindowClass ModestMsgEditWindowClass;
55 struct _ModestMsgEditWindow {
56 #ifdef MODEST_TOOLKIT_HILDON2
57 ModestHildon2Window parent;
59 ModestShellWindow parent;
61 /* insert public members, if any */
64 struct _ModestMsgEditWindowClass {
65 #ifdef MODEST_TOOLKIT_HILDON2
66 ModestHildon2WindowClass parent_class;
68 ModestShellWindowClass parent_class;
70 /* insert signal callback declarations, eg. */
71 /* void (* my_event) (ModestMsgEditWindow* obj); */
76 MODEST_EDIT_TYPE_REPLY,
77 MODEST_EDIT_TYPE_FORWARD,
83 MODEST_MSG_EDIT_FORMAT_TEXT,
84 MODEST_MSG_EDIT_FORMAT_HTML
85 } ModestMsgEditFormat;
88 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BODY,
89 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_TO,
90 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_CC,
91 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BCC,
92 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_SUBJECT,
93 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_ATTACHMENTS,
94 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_NUM,
95 } ModestMsgEditWindowWidgetType;
97 /** Get these with modest_msg_edit_window_get_msg_data()
98 * and free them with modest_msg_edit_window_free_msg_data().
101 gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
102 gchar *references, *in_reply_to;
105 TnyHeaderFlags priority_flags;
108 TnyList *custom_header_pairs;
116 const gchar *font_family;
118 GtkJustification justification;
119 } ModestMsgEditFormatState;
123 * modest_msg_edit_window_get_type:
125 * get the GType for the #ModestMsgEditWindow class
127 * Returns: a GType for #ModestMsgEditWindow
129 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
133 * modest_msg_edit_window_new:
134 * @msg: a #TnyMsg instance
135 * @account_name: the account this message applies to
136 * @mailbox: the mailbox (if any)
137 * @preserve_is_rich: if @msg is not rich, open the message as plain text
139 * instantiates a new #ModestMsgEditWindow widget
141 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
143 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg,
144 const gchar *account_name,
145 const gchar *mailbox,
146 gboolean preserve_is_rich);
150 * modest_msg_edit_window_get_msg_data:
151 * @self: a #ModestMsgEditWindow
153 * gets the message data already present in the edit message
154 * window. The message data must be freed with
155 * modest_msg_edit_window_free_msg_data
157 * Returns: the message data
159 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
162 * modest_msg_edit_window_free_msg_data:
163 * @self: a #ModestMsgEditWindow
166 * frees the message data passed as argument
168 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
172 * modest_msg_edit_window_get_format:
173 * @self: a #ModestMsgEditWindow
175 * obtains the format type of the message body.
177 * Returns: a #ModestMsgEditFormat
179 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
182 * modest_msg_edit_window_set_format:
183 * @self: a #ModestMsgEditWindow
184 * @format: a #ModestMsgEditFormat
186 * set the @format of the edit window message body.
188 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
189 ModestMsgEditFormat format);
192 * modest_msg_edit_window_get_format_state:
193 * @self: a #ModestMsgEditWindow
195 * get the current format state (the format attributes the text user inserts
198 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
200 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
203 * modest_msg_edit_window_set_format_state:
204 * @self: a #ModestMsgEditWindow
205 * @format_state: a #ModestMsgEditWindowFormatState
207 * sets a new format state (the format attributes the text user inserts
210 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
211 const ModestMsgEditFormatState *format_state);
214 * modest_msg_edit_window_select_color:
215 * @self: a #ModestMsgEditWindow
217 * show color selection dialog and update text color
219 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
222 * modest_msg_edit_window_select_background_color:
223 * @self: a #ModestMsgEditWindow
225 * show color selection dialog and update background color
227 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
230 * modest_msg_edit_window_insert_image:
231 * @self: a #ModestMsgEditWindow
233 * show a file selection dialog to insert an image
235 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
238 * modest_msg_edit_window_offer_attach_file:
239 * @self: a #ModestMsgEditWindow
241 * show a file selection dialog to attach a file
243 void modest_msg_edit_window_offer_attach_file (ModestMsgEditWindow *window);
246 * modest_msg_edit_window_attach_file_one:
247 * @self: a #ModestMsgEditWindow
248 * @file_uri: The URI of a file to attach to the email message.
249 * @allowed_size: max size allowed for this attachment, 0 for unlimited
251 * attach a file to a MsgEditWindow non interactively,
252 * without file dialog. This is needed by dbus callbacks.
254 * Returns: the filesize (if available)
256 GnomeVFSFileSize modest_msg_edit_window_attach_file_one (ModestMsgEditWindow *window, const gchar *file_uri, GnomeVFSFileSize allowed_size);
259 * modest_msg_edit_window_remove_attachments:
260 * @self: a #ModestMsgEditWindow
261 * @att_list: a #GList of #TnyMimePart
263 * remove attachments in @att_list, with a confirmation dialog
265 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
269 * modest_msg_edit_window_get_parts_size:
270 * @window: a #ModestMsgEditWindow
271 * @parts_count: number of attachments and images attached to the message
272 * @parts_size: sum of sizes of attachments and images
274 void modest_msg_edit_window_get_parts_size (ModestMsgEditWindow *window,
276 guint64 *parts_size);
278 * modest_msg_edit_window_add_part:
279 * @self: a #ModestMsgEditWindow
280 * @part: a #TnyMimePart
282 * Adds @part as an attachment
284 void modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
288 * modest_msg_edit_window_show_cc:
289 * @window: a #ModestMsgEditWindow
292 * Set the CC field as visible (or not visible) depending on @show
294 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
297 * modest_msg_edit_window_show_bcc:
298 * @window: a #ModestMsgEditWindow
301 * Set the BCC field as visible (or not visible) depending on @show
303 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
306 * modest_msg_edit_window_set_priority_flags:
307 * @window: a #ModestMsgEditWindow
308 * @priority_flags: a #TnyHeaderFlags with priority information
310 * Updates the icon and priority flag to send.
312 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
313 TnyHeaderFlags priority_flags);
316 * modest_msg_edit_window_set_file_format:
317 * @window: a #ModestMsgEditWindow
318 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
320 * Changes the current file format.
322 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
326 * modest_msg_edit_window_select_font:
327 * @window: a #ModestMsgEditWindow
329 * Show the dialog to select the editor font and update the
330 * used font in the editor.
332 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
335 * modest_msg_edit_window_undo:
336 * @window: a #ModestMsgEditWindow
338 * Undoes the last operation.
340 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
343 * modest_msg_edit_window_can_undo:
344 * @window: a #ModestMsgEditWindow
346 * Checks if an undo operation is available
348 * Returns: %TRUE if undo can be done, %FALSE otherwise.
350 gboolean modest_msg_edit_window_can_undo (ModestMsgEditWindow *window);
353 * modest_msg_edit_window_redo:
354 * @window: a #ModestMsgEditWindow
358 void modest_msg_edit_window_redo (ModestMsgEditWindow *window);
361 * modest_msg_edit_window_can_redo:
362 * @window: a #ModestMsgEditWindow
364 * Checks if a redp operation is available
366 * Returns: %TRUE if redo can be done, %FALSE otherwise.
368 gboolean modest_msg_edit_window_can_redo (ModestMsgEditWindow *window);
371 * modest_msg_edit_window_select_contacts:
372 * @window: a #ModestMsgEditWindow
374 * Shows the dialog to add contacts to the currently focused recipient list,
375 * or to To: recipient if no recipient list is focused.
377 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
380 * modest_msg_edit_window_add_to_contacts:
381 * @self: a #ModestMsgEditWindow
383 * activates the add to contacts use. It shows the add to contacts
384 * dialog to select the recipient to add.
386 void modest_msg_edit_window_add_to_contacts (ModestMsgEditWindow *self);
389 * modest_msg_edit_window_check_names:
390 * @window: a #ModestMsgEditWindow
391 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
393 * Validates all the recipients, and shows (if required) dialogs for adding contacts
394 * or fixing problems in specific fields.
396 * Returns: %TRUE if all fields were validated, %FALSE otherwise
398 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window,
399 gboolean add_to_addressbook);
402 * modest_msg_edit_window_has_pending_addresses:
403 * @window: a #ModestMsgEditWindow
404 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
406 * Validates all the recipients, and checks if there are addresses in
407 * any field that could be added to the addressbook
409 * Returns: %TRUE if there are valid pending addresses, %FALSE otherwise
411 gboolean modest_msg_edit_window_has_pending_addresses (ModestMsgEditWindow *window);
414 * modest_msg_edit_window_toggle_isearch_toolbar:
415 * @window: a #ModestMsgEditWindow
418 * Shows/Hides the isearch toolbar
420 void modest_msg_edit_window_toggle_isearch_toolbar (ModestMsgEditWindow *window,
425 * modest_msg_edit_window_is_modified:
426 * @window: a #ModestMsgEditWindow
428 * Examines whether or not the message has been modified
430 * Returns: %TRUE if any field has been modified, %FALSE otherwise
432 gboolean modest_msg_edit_window_is_modified (ModestMsgEditWindow *window);
435 * modest_msg_edit_window_reset_modified:
436 * @window: a #ModestMsgEditWindow
437 * @modified: wheter or not we want to make the buffer as modified or not
439 * Sets the message as modified or not
441 void modest_msg_edit_window_set_modified (ModestMsgEditWindow *window,
445 gboolean modest_msg_edit_window_get_sent (ModestMsgEditWindow *window);
446 void modest_msg_edit_window_set_sent (ModestMsgEditWindow *window,
450 * modest_msg_edit_window_set_draft:
451 * @window: a #ModestMsgEditWindow
452 * @draft: a #TnyMsg, or %NULL
454 * Set @draft as the original draft message of the editor. This
455 * message will be removed on saving or sending the message.
457 void modest_msg_edit_window_set_draft (ModestMsgEditWindow *window,
460 * modest_msg_edit_window_get_message_uid:
461 * @msg: an #ModestMsgEditWindow instance
463 * gets the unique identifier for the message in this msg editor.
464 * This is the identifier of the draft or outbox message the editor was
465 * opened from. If it's a new message, then it returns %NULL
467 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
469 const gchar* modest_msg_edit_window_get_message_uid (ModestMsgEditWindow *window);
472 * modest_msg_edit_window_get_child_widget:
473 * @win: a #ModestMsgEditWindow
474 * @widget_type: the type of the child to obtain
476 * Obtain the child widget of @win of type @widget_type
478 * Returns: a #GtkWidget, or %NULL
481 modest_msg_edit_window_get_child_widget (ModestMsgEditWindow *win,
482 ModestMsgEditWindowWidgetType widget_type);
485 * modest_msg_edit_window_get_clipboard_text:
486 * @win: a #ModestMsgEditWindow
488 * Obtains the currently selected text in selection clipboard
493 modest_msg_edit_window_get_clipboard_text (ModestMsgEditWindow *win);
496 * modest_msg_edit_window_set_custom_header_pairs:
497 * @win: a #ModestMsgEditWindow
498 * @header_pairs: a #TnyList of #TnyPair
500 * sets a list of custom header pairs that will be added to the created
504 modest_msg_edit_window_set_custom_header_pairs (ModestMsgEditWindow *self,
505 TnyList *header_pairs);
509 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */