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 gchar *from, *to, *cc, *bcc, *subject, *plain_body, *html_body;
76 TnyHeaderFlags priority_flags;
84 const gchar *font_family;
86 GtkJustification justification;
87 } ModestMsgEditFormatState;
91 * modest_msg_edit_window_get_type:
93 * get the GType for the #ModestMsgEditWindow class
95 * Returns: a GType for #ModestMsgEditWindow
97 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
101 * modest_msg_edit_window_new:
102 * #msg: a #TnyMsg instance
103 * #account_name: the account this message applies to
105 * instantiates a new #ModestMsgEditWindow widget
107 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
109 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg, const gchar *account_name);
113 * modest_msg_edit_window_get_msg_data:
114 * @self: a #ModestMsgEditWindow
116 * gets the message data already present in the edit message
117 * window. The message data must be freed with
118 * modest_msg_edit_window_free_msg_data
120 * Returns: the message data
122 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
125 * modest_msg_edit_window_free_msg_data:
126 * @self: a #ModestMsgEditWindow
129 * frees the message data passed as argument
131 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
135 * modest_msg_edit_window_get_format:
136 * @self: a #ModestMsgEditWindow
138 * obtains the format type of the message body.
140 * Returns: a #ModestMsgEditFormat
142 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
145 * modest_msg_edit_window_set_format:
146 * @self: a #ModestMsgEditWindow
147 * @format: a #ModestMsgEditFormat
149 * set the @format of the edit window message body.
151 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
152 ModestMsgEditFormat format);
155 * modest_msg_edit_window_get_format_state:
156 * @self: a #ModestMsgEditWindow
158 * get the current format state (the format attributes the text user inserts
161 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
163 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
166 * modest_msg_edit_window_set_format_state:
167 * @self: a #ModestMsgEditWindow
168 * @format_state: a #ModestMsgEditWindowFormatState
170 * sets a new format state (the format attributes the text user inserts
173 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
174 const ModestMsgEditFormatState *format_state);
177 * modest_msg_edit_window_select_color:
178 * @self: a #ModestMsgEditWindow
180 * show color selection dialog and update text color
182 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
185 * modest_msg_edit_window_select_background_color:
186 * @self: a #ModestMsgEditWindow
188 * show color selection dialog and update background color
190 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
193 * modest_msg_edit_window_insert_image:
194 * @self: a #ModestMsgEditWindow
196 * show a file selection dialog to insert an image
198 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
201 * modest_msg_edit_window_attach_file:
202 * @self: a #ModestMsgEditWindow
204 * show a file selection dialog to attach a file
206 void modest_msg_edit_window_attach_file (ModestMsgEditWindow *window);
209 * modest_msg_edit_window_remove_attachments:
210 * @self: a #ModestMsgEditWindow
211 * @att_list: a #GList of #TnyMimePart
213 * remove attachments in @att_list, with a confirmation dialog
215 void modest_msg_edit_window_remove_attachments (ModestMsgEditWindow *window,
219 * modest_msg_edit_window_show_cc:
220 * @window: a #ModestMsgEditWindow
223 * Set the CC field as visible (or not visible) depending on @show
225 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
228 * modest_msg_edit_window_show_bcc:
229 * @window: a #ModestMsgEditWindow
232 * Set the BCC field as visible (or not visible) depending on @show
234 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
237 * modest_msg_edit_window_toggle_fullscreen:
238 * @window: a #ModestMsgEditWindow
240 * toggles the current fullscreen status
242 void modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
245 * modest_msg_edit_window_set_priority_flags:
246 * @window: a #ModestMsgEditWindow
247 * @priority_flags: a #TnyHeaderFlags with priority information
249 * Updates the icon and priority flag to send.
251 void modest_msg_edit_window_set_priority_flags (ModestMsgEditWindow *window,
252 TnyHeaderFlags priority_flags);
255 * modest_msg_edit_window_set_file_format:
256 * @window: a #ModestMsgEditWindow
257 * @file_format: %MODEST_FILE_FORMAT_PLAIN_TEXT or %MODEST_FILE_FORMAT_FORMATTED_TEXT
259 * Changes the current file format.
261 void modest_msg_edit_window_set_file_format (ModestMsgEditWindow *window,
265 * modest_msg_edit_window_select_font:
266 * @window: a #ModestMsgEditWindow
268 * Show the dialog to select the editor font and update the
269 * used font in the editor.
271 void modest_msg_edit_window_select_font (ModestMsgEditWindow *window);
274 * modest_msg_edit_window_undo:
275 * @window: a #ModestMsgEditWindow
277 * Undoes the last operation.
279 void modest_msg_edit_window_undo (ModestMsgEditWindow *window);
282 * modest_msg_edit_window_select_contacts:
283 * @window: a #ModestMsgEditWindow
285 * Shows the dialog to add contacts to the currently focused recipient list,
286 * or to To: recipient if no recipient list is focused.
288 void modest_msg_edit_window_select_contacts (ModestMsgEditWindow *window);
291 * modest_msg_edit_window_check_names:
292 * @window: a #ModestMsgEditWindow
294 * Validates all the recipients, and shows (if required) dialogs for adding contacts
295 * or fixing problems in specific fields.
297 * Returns: %TRUE if all fields were validated, %FALSE otherwise
299 gboolean modest_msg_edit_window_check_names (ModestMsgEditWindow *window);
303 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */