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;
83 const gchar *font_family;
85 GtkJustification justification;
86 } ModestMsgEditFormatState;
90 * modest_msg_edit_window_get_type:
92 * get the GType for the #ModestMsgEditWindow class
94 * Returns: a GType for #ModestMsgEditWindow
96 GType modest_msg_edit_window_get_type (void) G_GNUC_CONST;
100 * modest_msg_edit_window_new:
101 * #msg: a #TnyMsg instance
102 * #account_name: the account this message applies to
104 * instantiates a new #ModestMsgEditWindow widget
106 * Returns: a new #ModestMsgEditWindow, or NULL in case of error
108 ModestWindow* modest_msg_edit_window_new (TnyMsg *msg, const gchar *account_name);
112 * modest_msg_edit_window_get_msg_data:
113 * @self: a #ModestMsgEditWindow
115 * gets the message data already present in the edit message
116 * window. The message data must be freed with
117 * modest_msg_edit_window_free_msg_data
119 * Returns: the message data
121 MsgData * modest_msg_edit_window_get_msg_data (ModestMsgEditWindow *self);
124 * modest_msg_edit_window_free_msg_data:
125 * @self: a #ModestMsgEditWindow
128 * frees the message data passed as argument
130 void modest_msg_edit_window_free_msg_data (ModestMsgEditWindow *self,
134 * modest_msg_edit_window_get_format:
135 * @self: a #ModestMsgEditWindow
137 * obtains the format type of the message body.
139 * Returns: a #ModestMsgEditFormat
141 ModestMsgEditFormat modest_msg_edit_window_get_format (ModestMsgEditWindow *self);
144 * modest_msg_edit_window_set_format:
145 * @self: a #ModestMsgEditWindow
146 * @format: a #ModestMsgEditFormat
148 * set the @format of the edit window message body.
150 void modest_msg_edit_window_set_format (ModestMsgEditWindow *self,
151 ModestMsgEditFormat format);
154 * modest_msg_edit_window_get_format_state:
155 * @self: a #ModestMsgEditWindow
157 * get the current format state (the format attributes the text user inserts
160 * Returns: a #ModestMsgEditFormatState structure that should be freed with g_free().
162 ModestMsgEditFormatState *modest_msg_edit_window_get_format_state (ModestMsgEditWindow *self);
165 * modest_msg_edit_window_set_format_state:
166 * @self: a #ModestMsgEditWindow
167 * @format_state: a #ModestMsgEditWindowFormatState
169 * sets a new format state (the format attributes the text user inserts
172 void modest_msg_edit_window_set_format_state (ModestMsgEditWindow *self,
173 const ModestMsgEditFormatState *format_state);
176 * modest_msg_edit_window_select_color:
177 * @self: a #ModestMsgEditWindow
179 * show color selection dialog and update text color
181 void modest_msg_edit_window_select_color (ModestMsgEditWindow *window);
184 * modest_msg_edit_window_select_background_color:
185 * @self: a #ModestMsgEditWindow
187 * show color selection dialog and update background color
189 void modest_msg_edit_window_select_background_color (ModestMsgEditWindow *window);
192 * modest_msg_edit_window_insert_image:
193 * @self: a #ModestMsgEditWindow
195 * show a file selection dialog to insert an image
197 void modest_msg_edit_window_insert_image (ModestMsgEditWindow *window);
200 * modest_msg_edit_window_show_cc:
201 * @window: a #ModestMsgEditWindow
204 * Set the CC field as visible (or not visible) depending on @show
206 void modest_msg_edit_window_show_cc (ModestMsgEditWindow *window, gboolean show);
209 * modest_msg_edit_window_show_bcc:
210 * @window: a #ModestMsgEditWindow
213 * Set the BCC field as visible (or not visible) depending on @show
215 void modest_msg_edit_window_show_bcc (ModestMsgEditWindow *window, gboolean show);
218 * modest_msg_edit_window_toggle_fullscreen:
219 * @window: a #ModestMsgEditWindow
221 * toggles the current fullscreen status
223 void modest_msg_edit_window_toggle_fullscreen (ModestMsgEditWindow *window);
228 #endif /* __MODEST_MSG_EDIT_WINDOW_H__ */