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 <widgets/modest-window.h>
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))
46 typedef struct _ModestMsgEditWindow ModestMsgEditWindow;
47 typedef struct _ModestMsgEditWindowClass ModestMsgEditWindowClass;
49 struct _ModestMsgEditWindow {
51 /* insert public members, if any */
54 struct _ModestMsgEditWindowClass {
55 ModestWindowClass parent_class;
56 /* insert signal callback declarations, eg. */
57 /* void (* my_event) (ModestMsgEditWindow* obj); */
62 MODEST_EDIT_TYPE_REPLY,
63 MODEST_EDIT_TYPE_FORWARD,
69 MODEST_MSG_EDIT_FORMAT_TEXT,
70 MODEST_MSG_EDIT_FORMAT_HTML
71 } ModestMsgEditFormat;
74 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BODY,
75 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_TO,
76 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_CC,
77 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_BCC,
78 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_SUBJECT,
79 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_ATTACHMENTS,
80 MODEST_MSG_EDIT_WINDOW_WIDGET_TYPE_NUM,
81 } ModestMsgEditWindowWidgetType;
83 /** Get these with modest_msg_edit_window_get_msg_data()
84 * and free them with modest_msg_edit_window_free_msg_data().
87 gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
90 TnyHeaderFlags priority_flags;
100 const gchar *font_family;
102 GtkJustification justification;
103 } ModestMsgEditFormatState;
107 * modest_msg_edit_window_get_type:
109 * get the GType for the #ModestMsgEditWindow class
111 * Returns: a GType for #ModestMsgEditWindow
113 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
117 * modest_msg_edit_window_new:
118 * @msg: a #TnyMsg instance
119 * @account_name: the account this message applies to
120 * @preserve_is_rich: if @msg is not rich, open the message as plain text
122 * instantiates a new #ModestMsgEditWindow widget
124 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
126 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg,
127 const gchar *account_name,
128 gboolean preserve_is_rich);
132 * modest_msg_edit_window_get_msg_data:
133 * @self: a #ModestMsgEditWindow
135 * gets the message data already present in the edit message
136 * window. The message data must be freed with
137 * modest_msg_edit_window_free_msg_data
139 * Returns: the message data
141 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
144 * modest_msg_edit_window_free_msg_data:
145 * @self: a #ModestMsgEditWindow
148 * frees the message data passed as argument
150 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
154 * modest_msg_edit_window_get_format:
155 * @self: a #ModestMsgEditWindow
157 * obtains the format type of the message body.
159 * Returns: a #ModestMsgEditFormat
161 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
164 * modest_msg_edit_window_set_format:
165 * @self: a #ModestMsgEditWindow
166 * @format: a #ModestMsgEditFormat
168 * set the @format of the edit window message body.
170 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
171 ModestMsgEditFormat format);
174 * modest_msg_edit_window_get_format_state:
175 * @self: a #ModestMsgEditWindow
177 * get the current format state (the format attributes the text user inserts
180 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
182 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
185 * modest_msg_edit_window_set_format_state:
186 * @self: a #ModestMsgEditWindow
187 * @format_state: a #ModestMsgEditWindowFormatState
189 * sets a new format state (the format attributes the text user inserts
192 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
193 const ModestMsgEditFormatState *format_state);
196 * modest_msg_edit_window_select_color:
197 * @self: a #ModestMsgEditWindow
199 * show color selection dialog and update text color
201 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
204 * modest_msg_edit_window_select_background_color:
205 * @self: a #ModestMsgEditWindow
207 * show color selection dialog and update background color
209 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
212 * modest_msg_edit_window_insert_image:
213 * @self: a #ModestMsgEditWindow
215 * show a file selection dialog to insert an image
217 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
220 * modest_msg_edit_window_offer_attach_file:
221 * @self: a #ModestMsgEditWindow
223 * show a file selection dialog to attach a file
225 void modest_msg_edit_window_offer_attach_file (ModestMsgEditWindow *window);
228 * modest_msg_edit_window_attach_file_one:
229 * @self: a #ModestMsgEditWindow
230 * @file_uri: The URI of a file to attach to the email message.
232 * attach a file to a MsgEditWindow non interactively,
233 * without file dialog. This is needed by dbus callbacks.
235 void modest_msg_edit_window_attach_file_one (ModestMsgEditWindow *window, const gchar *file_uri);
238 * modest_msg_edit_window_remove_attachments:
239 * @self: a #ModestMsgEditWindow
240 * @att_list: a #GList of #TnyMimePart
242 * remove attachments in @att_list, with a confirmation dialog
244 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
248 * modest_msg_edit_window_get_parts_size:
249 * @window: a #ModestMsgEditWindow
250 * @parts_count: number of attachments and images attached to the message
251 * @parts_size: sum of sizes of attachments and images
253 void modest_msg_edit_window_get_parts_size (ModestMsgEditWindow *window,
255 guint64 *parts_size);
257 * modest_msg_edit_window_add_part:
258 * @self: a #ModestMsgEditWindow
259 * @part: a #TnyMimePart
261 * Adds @part as an attachment
263 void modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
267 * modest_msg_edit_window_show_cc:
268 * @window: a #ModestMsgEditWindow
271 * Set the CC field as visible (or not visible) depending on @show
273 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
276 * modest_msg_edit_window_show_bcc:
277 * @window: a #ModestMsgEditWindow
280 * Set the BCC field as visible (or not visible) depending on @show
282 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
285 * modest_msg_edit_window_set_priority_flags:
286 * @window: a #ModestMsgEditWindow
287 * @priority_flags: a #TnyHeaderFlags with priority information
289 * Updates the icon and priority flag to send.
291 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
292 TnyHeaderFlags priority_flags);
295 * modest_msg_edit_window_set_file_format:
296 * @window: a #ModestMsgEditWindow
297 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
299 * Changes the current file format.
301 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
305 * modest_msg_edit_window_select_font:
306 * @window: a #ModestMsgEditWindow
308 * Show the dialog to select the editor font and update the
309 * used font in the editor.
311 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
314 * modest_msg_edit_window_undo:
315 * @window: a #ModestMsgEditWindow
317 * Undoes the last operation.
319 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
322 * modest_msg_edit_window_can_undo:
323 * @window: a #ModestMsgEditWindow
325 * Checks if an undo operation is available
327 * Returns: %TRUE if undo can be done, %FALSE otherwise.
329 gboolean modest_msg_edit_window_can_undo (ModestMsgEditWindow *window);
332 * modest_msg_edit_window_redo:
333 * @window: a #ModestMsgEditWindow
337 void modest_msg_edit_window_redo (ModestMsgEditWindow *window);
340 * modest_msg_edit_window_can_redo:
341 * @window: a #ModestMsgEditWindow
343 * Checks if a redp operation is available
345 * Returns: %TRUE if redo can be done, %FALSE otherwise.
347 gboolean modest_msg_edit_window_can_redo (ModestMsgEditWindow *window);
350 * modest_msg_edit_window_select_contacts:
351 * @window: a #ModestMsgEditWindow
353 * Shows the dialog to add contacts to the currently focused recipient list,
354 * or to To: recipient if no recipient list is focused.
356 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
359 * modest_msg_edit_window_check_names:
360 * @window: a #ModestMsgEditWindow
361 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
363 * Validates all the recipients, and shows (if required) dialogs for adding contacts
364 * or fixing problems in specific fields.
366 * Returns: %TRUE if all fields were validated, %FALSE otherwise
368 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window,
369 gboolean add_to_addressbook);
372 * modest_msg_edit_window_toggle_find_toolbar:
373 * @window: a #ModestMsgEditWindow
376 * Shows/Hides the find toolbar
378 void modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
383 * modest_msg_edit_window_is_modified:
384 * @window: a #ModestMsgEditWindow
386 * Examines whether or not the message has been modified
388 * Returns: %TRUE if any field has been modified, %FALSE otherwise
390 gboolean modest_msg_edit_window_is_modified (ModestMsgEditWindow *window);
393 * modest_msg_edit_window_reset_modified:
394 * @window: a #ModestMsgEditWindow
395 * @modified: wheter or not we want to make the buffer as modified or not
397 * Sets the message as modified or not
399 void modest_msg_edit_window_set_modified (ModestMsgEditWindow *window,
403 gboolean modest_msg_edit_window_get_sent (ModestMsgEditWindow *window);
404 void modest_msg_edit_window_set_sent (ModestMsgEditWindow *window,
408 * modest_msg_edit_window_set_draft:
409 * @window: a #ModestMsgEditWindow
410 * @draft: a #TnyMsg, or %NULL
412 * Set @draft as the original draft message of the editor. This
413 * message will be removed on saving or sending the message.
415 void modest_msg_edit_window_set_draft (ModestMsgEditWindow *window,
418 * modest_msg_edit_window_get_message_uid:
419 * @msg: an #ModestMsgEditWindow instance
421 * gets the unique identifier for the message in this msg editor.
422 * This is the identifier of the draft or outbox message the editor was
423 * opened from. If it's a new message, then it returns %NULL
425 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
427 const gchar* modest_msg_edit_window_get_message_uid (ModestMsgEditWindow *window);
430 * modest_msg_edit_window_get_child_widget:
431 * @win: a #ModestMsgEditWindow
432 * @widget_type: the type of the child to obtain
434 * Obtain the child widget of @win of type @widget_type
436 * Returns: a #GtkWidget, or %NULL
439 modest_msg_edit_window_get_child_widget (ModestMsgEditWindow *win,
440 ModestMsgEditWindowWidgetType widget_type);
443 * modest_msg_edit_window_get_clipboard_text:
444 * @win: a #ModestMsgEditWindow
446 * Obtains the currently selected text in selection clipboard
451 modest_msg_edit_window_get_clipboard_text (ModestMsgEditWindow *win);
455 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */