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;
87 const gchar *font_family;
89 GtkJustification justification;
90 } ModestMsgEditFormatState;
94 * modest_msg_edit_window_get_type:
96 * get the GType for the #ModestMsgEditWindow class
98 * Returns: a GType for #ModestMsgEditWindow
100 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
104 * modest_msg_edit_window_new:
105 * #msg: a #TnyMsg instance
106 * #account_name: the account this message applies to
108 * instantiates a new #ModestMsgEditWindow widget
110 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
112 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg, const gchar *account_name);
116 * modest_msg_edit_window_get_msg_data:
117 * @self: a #ModestMsgEditWindow
119 * gets the message data already present in the edit message
120 * window. The message data must be freed with
121 * modest_msg_edit_window_free_msg_data
123 * Returns: the message data
125 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
128 * modest_msg_edit_window_free_msg_data:
129 * @self: a #ModestMsgEditWindow
132 * frees the message data passed as argument
134 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
138 * modest_msg_edit_window_get_format:
139 * @self: a #ModestMsgEditWindow
141 * obtains the format type of the message body.
143 * Returns: a #ModestMsgEditFormat
145 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
148 * modest_msg_edit_window_set_format:
149 * @self: a #ModestMsgEditWindow
150 * @format: a #ModestMsgEditFormat
152 * set the @format of the edit window message body.
154 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
155 ModestMsgEditFormat format);
158 * modest_msg_edit_window_get_format_state:
159 * @self: a #ModestMsgEditWindow
161 * get the current format state (the format attributes the text user inserts
164 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
166 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
169 * modest_msg_edit_window_set_format_state:
170 * @self: a #ModestMsgEditWindow
171 * @format_state: a #ModestMsgEditWindowFormatState
173 * sets a new format state (the format attributes the text user inserts
176 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
177 const ModestMsgEditFormatState *format_state);
180 * modest_msg_edit_window_select_color:
181 * @self: a #ModestMsgEditWindow
183 * show color selection dialog and update text color
185 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
188 * modest_msg_edit_window_select_background_color:
189 * @self: a #ModestMsgEditWindow
191 * show color selection dialog and update background color
193 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
196 * modest_msg_edit_window_insert_image:
197 * @self: a #ModestMsgEditWindow
199 * show a file selection dialog to insert an image
201 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
204 * modest_msg_edit_window_attach_file:
205 * @self: a #ModestMsgEditWindow
207 * show a file selection dialog to attach a file
209 void modest_msg_edit_window_attach_file (ModestMsgEditWindow *window);
212 * modest_msg_edit_window_remove_attachments:
213 * @self: a #ModestMsgEditWindow
214 * @att_list: a #GList of #TnyMimePart
216 * remove attachments in @att_list, with a confirmation dialog
218 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
222 * modest_msg_edit_window_show_cc:
223 * @window: a #ModestMsgEditWindow
226 * Set the CC field as visible (or not visible) depending on @show
228 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
231 * modest_msg_edit_window_show_bcc:
232 * @window: a #ModestMsgEditWindow
235 * Set the BCC field as visible (or not visible) depending on @show
237 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
240 * modest_msg_edit_window_toggle_fullscreen:
241 * @window: a #ModestMsgEditWindow
243 * toggles the current fullscreen status
245 void modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
248 * modest_msg_edit_window_set_priority_flags:
249 * @window: a #ModestMsgEditWindow
250 * @priority_flags: a #TnyHeaderFlags with priority information
252 * Updates the icon and priority flag to send.
254 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
255 TnyHeaderFlags priority_flags);
258 * modest_msg_edit_window_set_file_format:
259 * @window: a #ModestMsgEditWindow
260 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
262 * Changes the current file format.
264 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
268 * modest_msg_edit_window_select_font:
269 * @window: a #ModestMsgEditWindow
271 * Show the dialog to select the editor font and update the
272 * used font in the editor.
274 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
277 * modest_msg_edit_window_undo:
278 * @window: a #ModestMsgEditWindow
280 * Undoes the last operation.
282 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
285 * modest_msg_edit_window_select_contacts:
286 * @window: a #ModestMsgEditWindow
288 * Shows the dialog to add contacts to the currently focused recipient list,
289 * or to To: recipient if no recipient list is focused.
291 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
294 * modest_msg_edit_window_check_names:
295 * @window: a #ModestMsgEditWindow
297 * Validates all the recipients, and shows (if required) dialogs for adding contacts
298 * or fixing problems in specific fields.
300 * Returns: %TRUE if all fields were validated, %FALSE otherwise
302 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window);
306 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */