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
110 * instantiates a new #ModestMsgEditWindow widget
112 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
114 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg, const gchar *account_name);
118 * modest_msg_edit_window_get_msg_data:
119 * @self: a #ModestMsgEditWindow
121 * gets the message data already present in the edit message
122 * window. The message data must be freed with
123 * modest_msg_edit_window_free_msg_data
125 * Returns: the message data
127 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
130 * modest_msg_edit_window_free_msg_data:
131 * @self: a #ModestMsgEditWindow
134 * frees the message data passed as argument
136 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
140 * modest_msg_edit_window_get_format:
141 * @self: a #ModestMsgEditWindow
143 * obtains the format type of the message body.
145 * Returns: a #ModestMsgEditFormat
147 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
150 * modest_msg_edit_window_set_format:
151 * @self: a #ModestMsgEditWindow
152 * @format: a #ModestMsgEditFormat
154 * set the @format of the edit window message body.
156 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
157 ModestMsgEditFormat format);
160 * modest_msg_edit_window_get_format_state:
161 * @self: a #ModestMsgEditWindow
163 * get the current format state (the format attributes the text user inserts
166 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
168 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
171 * modest_msg_edit_window_set_format_state:
172 * @self: a #ModestMsgEditWindow
173 * @format_state: a #ModestMsgEditWindowFormatState
175 * sets a new format state (the format attributes the text user inserts
178 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
179 const ModestMsgEditFormatState *format_state);
182 * modest_msg_edit_window_select_color:
183 * @self: a #ModestMsgEditWindow
185 * show color selection dialog and update text color
187 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
190 * modest_msg_edit_window_select_background_color:
191 * @self: a #ModestMsgEditWindow
193 * show color selection dialog and update background color
195 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
198 * modest_msg_edit_window_insert_image:
199 * @self: a #ModestMsgEditWindow
201 * show a file selection dialog to insert an image
203 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
206 * modest_msg_edit_window_attach_file:
207 * @self: a #ModestMsgEditWindow
209 * show a file selection dialog to attach a file
211 void modest_msg_edit_window_attach_file (ModestMsgEditWindow *window);
214 * modest_msg_edit_window_attach_file_noninteractive:
215 * @self: a #ModestMsgEditWindow
216 * @file_uri: The URI of a file to attach to the email message.
218 * attach a file to a MsgEditWindow non interactively,
219 * without file dialog. This is needed by dbus callbacks.
221 void modest_msg_edit_window_attach_file_noninteractive (ModestMsgEditWindow *window, const gchar *file_uri);
224 * modest_msg_edit_window_remove_attachments:
225 * @self: a #ModestMsgEditWindow
226 * @att_list: a #GList of #TnyMimePart
228 * remove attachments in @att_list, with a confirmation dialog
230 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
234 * modest_msg_edit_window_show_cc:
235 * @window: a #ModestMsgEditWindow
238 * Set the CC field as visible (or not visible) depending on @show
240 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
243 * modest_msg_edit_window_show_bcc:
244 * @window: a #ModestMsgEditWindow
247 * Set the BCC field as visible (or not visible) depending on @show
249 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
252 * modest_msg_edit_window_toggle_fullscreen:
253 * @window: a #ModestMsgEditWindow
255 * toggles the current fullscreen status
257 void modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
260 * modest_msg_edit_window_set_priority_flags:
261 * @window: a #ModestMsgEditWindow
262 * @priority_flags: a #TnyHeaderFlags with priority information
264 * Updates the icon and priority flag to send.
266 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
267 TnyHeaderFlags priority_flags);
270 * modest_msg_edit_window_set_file_format:
271 * @window: a #ModestMsgEditWindow
272 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
274 * Changes the current file format.
276 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
280 * modest_msg_edit_window_select_font:
281 * @window: a #ModestMsgEditWindow
283 * Show the dialog to select the editor font and update the
284 * used font in the editor.
286 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
289 * modest_msg_edit_window_undo:
290 * @window: a #ModestMsgEditWindow
292 * Undoes the last operation.
294 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
297 * modest_msg_edit_window_select_contacts:
298 * @window: a #ModestMsgEditWindow
300 * Shows the dialog to add contacts to the currently focused recipient list,
301 * or to To: recipient if no recipient list is focused.
303 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
306 * modest_msg_edit_window_check_names:
307 * @window: a #ModestMsgEditWindow
309 * Validates all the recipients, and shows (if required) dialogs for adding contacts
310 * or fixing problems in specific fields.
312 * Returns: %TRUE if all fields were validated, %FALSE otherwise
314 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window);
317 * modest_msg_edit_window_toggle_find_toolbar:
318 * @window: a #ModestMsgEditWindow
321 * Shows/Hides the find toolbar
323 void modest_msg_edit_window_toggle_find_toolbar (ModestMsgEditWindow *window,
328 * modest_msg_edit_window_is_modified:
329 * @window: a #ModestMsgEditWindow
331 * Examines whether or not the message has been modified
333 * Returns: %TRUE if any field has been modified, %FALSE otherwise
335 gboolean modest_msg_edit_window_is_modified (ModestMsgEditWindow *window);
337 gboolean modest_msg_edit_window_get_sent (ModestMsgEditWindow *window);
338 void modest_msg_edit_window_set_sent (ModestMsgEditWindow *window,
343 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */