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;
73 /** Get these with modest_msg_edit_window_get_msg_data()
74 * and free them with modest_msg_edit_window_free_msg_data().
77 gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
79 TnyHeaderFlags priority_flags;
89 const gchar *font_family;
91 GtkJustification justification;
92 } ModestMsgEditFormatState;
96 * modest_msg_edit_window_get_type:
98 * get the GType for the #ModestMsgEditWindow class
100 * Returns: a GType for #ModestMsgEditWindow
102 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
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
111 * instantiates a new #ModestMsgEditWindow widget
113 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
115 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg,
116 const gchar *account_name,
117 gboolean preserve_is_rich);
121 * modest_msg_edit_window_get_msg_data:
122 * @self: a #ModestMsgEditWindow
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
128 * Returns: the message data
130 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
133 * modest_msg_edit_window_free_msg_data:
134 * @self: a #ModestMsgEditWindow
137 * frees the message data passed as argument
139 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
143 * modest_msg_edit_window_get_format:
144 * @self: a #ModestMsgEditWindow
146 * obtains the format type of the message body.
148 * Returns: a #ModestMsgEditFormat
150 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
153 * modest_msg_edit_window_set_format:
154 * @self: a #ModestMsgEditWindow
155 * @format: a #ModestMsgEditFormat
157 * set the @format of the edit window message body.
159 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
160 ModestMsgEditFormat format);
163 * modest_msg_edit_window_get_format_state:
164 * @self: a #ModestMsgEditWindow
166 * get the current format state (the format attributes the text user inserts
169 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
171 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
174 * modest_msg_edit_window_set_format_state:
175 * @self: a #ModestMsgEditWindow
176 * @format_state: a #ModestMsgEditWindowFormatState
178 * sets a new format state (the format attributes the text user inserts
181 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
182 const ModestMsgEditFormatState *format_state);
185 * modest_msg_edit_window_select_color:
186 * @self: a #ModestMsgEditWindow
188 * show color selection dialog and update text color
190 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
193 * modest_msg_edit_window_select_background_color:
194 * @self: a #ModestMsgEditWindow
196 * show color selection dialog and update background color
198 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
201 * modest_msg_edit_window_insert_image:
202 * @self: a #ModestMsgEditWindow
204 * show a file selection dialog to insert an image
206 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
209 * modest_msg_edit_window_offer_attach_file:
210 * @self: a #ModestMsgEditWindow
212 * show a file selection dialog to attach a file
214 void modest_msg_edit_window_offer_attach_file (ModestMsgEditWindow *window);
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.
221 * attach a file to a MsgEditWindow non interactively,
222 * without file dialog. This is needed by dbus callbacks.
224 void modest_msg_edit_window_attach_file_one (ModestMsgEditWindow *window, const gchar *file_uri);
227 * modest_msg_edit_window_remove_attachments:
228 * @self: a #ModestMsgEditWindow
229 * @att_list: a #GList of #TnyMimePart
231 * remove attachments in @att_list, with a confirmation dialog
233 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
237 * modest_msg_edit_window_add_part:
238 * @self: a #ModestMsgEditWindow
239 * @part: a #TnyMimePart
241 * Adds @part as an attachment
243 void modest_msg_edit_window_add_part (ModestMsgEditWindow *window,
247 * modest_msg_edit_window_show_cc:
248 * @window: a #ModestMsgEditWindow
251 * Set the CC field as visible (or not visible) depending on @show
253 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
256 * modest_msg_edit_window_show_bcc:
257 * @window: a #ModestMsgEditWindow
260 * Set the BCC field as visible (or not visible) depending on @show
262 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
265 * modest_msg_edit_window_set_priority_flags:
266 * @window: a #ModestMsgEditWindow
267 * @priority_flags: a #TnyHeaderFlags with priority information
269 * Updates the icon and priority flag to send.
271 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
272 TnyHeaderFlags priority_flags);
275 * modest_msg_edit_window_set_file_format:
276 * @window: a #ModestMsgEditWindow
277 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
279 * Changes the current file format.
281 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
285 * modest_msg_edit_window_select_font:
286 * @window: a #ModestMsgEditWindow
288 * Show the dialog to select the editor font and update the
289 * used font in the editor.
291 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
294 * modest_msg_edit_window_undo:
295 * @window: a #ModestMsgEditWindow
297 * Undoes the last operation.
299 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
302 * modest_msg_edit_window_redo:
303 * @window: a #ModestMsgEditWindow
307 void modest_msg_edit_window_redo (ModestMsgEditWindow *window);
310 * modest_msg_edit_window_select_contacts:
311 * @window: a #ModestMsgEditWindow
313 * Shows the dialog to add contacts to the currently focused recipient list,
314 * or to To: recipient if no recipient list is focused.
316 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
319 * modest_msg_edit_window_check_names:
320 * @window: a #ModestMsgEditWindow
321 * @add_to_addressbook: if TRUE, add valid addresses to the addressbook
323 * Validates all the recipients, and shows (if required) dialogs for adding contacts
324 * or fixing problems in specific fields.
326 * Returns: %TRUE if all fields were validated, %FALSE otherwise
328 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window,
329 gboolean add_to_addressbook);
332 * modest_msg_edit_window_toggle_find_toolbar:
333 * @window: a #ModestMsgEditWindow
336 * Shows/Hides the find toolbar
338 void modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
343 * modest_msg_edit_window_is_modified:
344 * @window: a #ModestMsgEditWindow
346 * Examines whether or not the message has been modified
348 * Returns: %TRUE if any field has been modified, %FALSE otherwise
350 gboolean modest_msg_edit_window_is_modified (ModestMsgEditWindow *window);
352 gboolean modest_msg_edit_window_get_sent (ModestMsgEditWindow *window);
353 void modest_msg_edit_window_set_sent (ModestMsgEditWindow *window,
357 * modest_msg_edit_window_set_draft:
358 * @window: a #ModestMsgEditWindow
359 * @draft: a #TnyMsg, or %NULL
361 * Set @draft as the original draft message of the editor. This
362 * message will be removed on saving or sending the message.
364 void modest_msg_edit_window_set_draft (ModestMsgEditWindow *window,
367 * modest_msg_edit_window_get_message_uid:
368 * @msg: an #ModestMsgEditWindow instance
370 * gets the unique identifier for the message in this msg editor.
371 * This is the identifier of the draft or outbox message the editor was
372 * opened from. If it's a new message, then it returns %NULL
374 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
376 const gchar* modest_msg_edit_window_get_message_uid (ModestMsgEditWindow *window);
380 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */