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_VIEW_WINDOW_H__
31 #define __MODEST_MSG_VIEW_WINDOW_H__
34 #include <widgets/modest-window.h>
35 #include <gtk/gtktreemodel.h>
39 /* convenience macros */
40 #define MODEST_TYPE_MSG_VIEW_WINDOW (modest_msg_view_window_get_type())
41 #define MODEST_MSG_VIEW_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW_WINDOW,ModestMsgViewWindow))
42 #define MODEST_MSG_VIEW_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_VIEW_WINDOW,ModestWindow))
43 #define MODEST_IS_MSG_VIEW_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW_WINDOW))
44 #define MODEST_IS_MSG_VIEW_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_VIEW_WINDOW))
45 #define MODEST_MSG_VIEW_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_VIEW_WINDOW,ModestMsgVIewWindowClass))
50 } ModestMsgViewWindow;
53 ModestWindowClass parent_class;
55 void (*msg_changed) (ModestMsgViewWindow *self,
57 GtkTreeRowReference *row_reference,
59 } ModestMsgViewWindowClass;
62 * modest_msg_view_window_get_type:
64 * get the GType for the #ModestMsgViewWindow class
66 * Returns: a GType for #ModestMsgViewWindow
68 GType modest_msg_view_window_get_type (void) G_GNUC_CONST;
72 * modest_msg_view_window_new:
73 * @msg: an #TnyMsg instance
74 * @modest_account_name: the account name
76 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
77 * set the proper account when choosing reply/forward from the msg view window
79 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
81 ModestWindow* modest_msg_view_window_new (TnyMsg *msg,
82 const gchar *modest_account_name,
83 const gchar *msg_uid);
86 * modest_msg_view_window_new_with_header_model:
87 * @msg: an #TnyMsg instance
88 * @account: the account name
89 * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
90 * @iter: a #GtkTreeIter, pointing to the position of @msg in @model.
92 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
93 * set the proper account when choosing reply/forward from the msg view window.
94 * This constructor also passes a reference to the @model of the header view
95 * to allow selecting previous/next messages.
97 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
99 ModestWindow* modest_msg_view_window_new_with_header_model (TnyMsg *msg,
100 const gchar *modest_account_name,
101 const gchar *msg_uid,
103 GtkTreeRowReference *row_reference);
107 * modest_msg_view_window_get_header:
108 * @window: an #ModestMsgViewWindow instance
110 * get the message header in this msg view. Header instance is get
111 * from tree_model of headers list.
113 * Returns: a new #TnyHeader instance, or NULL in case of error
116 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
119 * modest_msg_view_window_get_message:
120 * @window: an #ModestMsgViewWindow instance
122 * get a new reference to the message in this msg view. The caller
123 * must free this new reference
125 * Returns: a new #TnyMsg instance, or NULL in case of error
127 TnyMsg* modest_msg_view_window_get_message (ModestMsgViewWindow *window);
130 * modest_msg_view_window_get_message_uid:
131 * @msg: an #ModestMsgViewWindow instance
133 * gets the unique identifier for the message in this msg view. The
134 * returned value *must* not be freed
136 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
138 const gchar* modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
141 * modest_msg_view_window_select_first_message:
142 * @window: a #ModestMsgViewWindow instance
144 * select the first message obtained from the header view this view
147 * Returns: %TRUE if a new message is shown.
149 gboolean modest_msg_view_window_select_first_message (ModestMsgViewWindow *window);
152 * modest_msg_view_window_select_next_message:
153 * @window: a #ModestMsgViewWindow instance
155 * select the next message obtained from the header view this view
158 * Returns: %TRUE if a new message is shown.
160 gboolean modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
163 * modest_msg_view_window_select_previous_message:
164 * @window: a #ModestMsgViewWindow instance
166 * select the previous message obtained from the header view this view
169 * Returns: %TRUE if a new message is shown.
171 gboolean modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
174 * modest_msg_view_window_toggle_fullscreen:
175 * @window: a #ModestMsgViewWindow
177 * toggles the current fullscreen status
179 void modest_msg_view_window_toggle_fullscreen (ModestMsgViewWindow *window);
182 * modest_msg_view_window_view_attachment:
183 * @window: a #ModestMsgViewWindow
184 * @mime_part: a #TnyMimePart
186 * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
187 * If it's a message, it opens it for viewing. Otherwise it opens a temporary file
188 * with the contents of the attachment.
190 void modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
191 TnyMimePart *mime_part);
194 * modest_msg_view_window_get_attachments:
195 * @window: a #ModestMsgViewWindow
197 * Get selected attachments from #ModetMsgView private object.
199 GList * modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
202 * modest_msg_view_window_save_attachments:
203 * @window: a #ModestMsgViewWindow
204 * @mime_parts: a #GList of #TnyMimePart
206 * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
207 * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
209 void modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
213 * modest_msg_view_window_remove_attachments:
214 * @window: a #ModestMsgViewWindow
215 * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
216 * purges only selected ones.
218 * Removes selected attachments.
220 void modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
225 * modest_msg_view_window_toolbar_on_transfer_mode:
226 * @window: a #ModestMsgViewWindow
228 * Check if toolbar is in transfer mode, which determines whether a
229 * transfer operation is being processed.
231 gboolean modest_msg_view_window_toolbar_on_transfer_mode (ModestMsgViewWindow *self);
235 * modest_msg_view_window_last_message_selected:
236 * @window: a #ModestMsgViewWindow
238 * Check message currently viewed is the last message into folder .
240 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
244 * modest_msg_view_window_first_message_selected:
245 * @window: a #ModestMsgViewWindow
247 * Check message currently viewed is the last message into folder .
249 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
252 * modest_msg_view_window_has_headers_model:
253 * @window: a #ModestMsgViewWindow
255 * Check if window has been created with a full headers model.
257 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
260 * modest_msg_view_window_get_folder_type:
261 * @window: a #ModestMsgViewWindow
263 * Gets folder type of message currently viewed .
266 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
269 * modest_msg_view_window_transfer_mode_enabled:
270 * @window: a #ModestMsgViewWindow
272 * Determines if some transfer operation is in progress.
274 * Returns: TRUE if transfer mode is enabled, FASE otherwise.
277 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
281 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */