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 <tny-folder.h>
35 #ifdef MODEST_TOOLKIT_HILDON2
36 #include <modest-hildon2-window.h>
38 #include <widgets/modest-window.h>
39 #include <widgets/modest-header-view.h>
40 #include <gtk/gtktreemodel.h>
41 #include <gtk/gtkenums.h>
45 /* convenience macros */
46 #define MODEST_TYPE_MSG_VIEW_WINDOW (modest_msg_view_window_get_type())
47 #define MODEST_MSG_VIEW_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW_WINDOW,ModestMsgViewWindow))
48 #define MODEST_MSG_VIEW_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_VIEW_WINDOW,ModestWindow))
49 #define MODEST_IS_MSG_VIEW_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW_WINDOW))
50 #define MODEST_IS_MSG_VIEW_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_VIEW_WINDOW))
51 #define MODEST_MSG_VIEW_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_VIEW_WINDOW,ModestMsgVIewWindowClass))
55 #ifdef MODEST_TOOLKIT_HILDON2
56 ModestHildon2Window parent;
60 } ModestMsgViewWindow;
63 #ifdef MODEST_TOOLKIT_HILDON2
64 ModestHildon2WindowClass parent_class;
66 ModestWindowClass parent_class;
69 void (*msg_changed) (ModestMsgViewWindow *self,
71 GtkTreeRowReference *row_reference,
74 gboolean (*scroll_child) (ModestMsgViewWindow *self,
75 GtkScrollType scroll_type,
78 } ModestMsgViewWindowClass;
81 * modest_msg_view_window_get_type:
83 * get the GType for the #ModestMsgViewWindow class
85 * Returns: a GType for #ModestMsgViewWindow
87 GType modest_msg_view_window_get_type (void) G_GNUC_CONST;
91 * modest_msg_view_window_new_for_attachment:
92 * @msg: an #TnyMsg instance
93 * @modest_account_name: the account name
94 * @mailbox: the mailbox (if any)
96 * instantiates a new #ModestMsgViewWindow widget to view a message that is an
97 * attachment in another message.
98 * The account name is used to
99 * set the proper account when choosing reply/forward from the msg view window
101 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
103 ModestWindow* modest_msg_view_window_new_for_attachment (TnyMsg *msg,
104 const gchar *modest_account_name,
105 const gchar *mailbox,
106 const gchar *msg_uid);
109 * modest_msg_view_window_new_with_other_body:
110 * @msg: an #TnyMsg instance
111 * @modest_account_name: the account name
112 * @mailbox: the mailbox (if any)
114 * instantiates a new #ModestMsgViewWindow widget to view a message that is a different body
115 * in another message.
116 * The account name is used to
117 * set the proper account when choosing reply/forward from the msg view window
119 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
121 ModestWindow* modest_msg_view_window_new_with_other_body (TnyMsg *msg,
122 TnyMimePart *other_body,
123 const gchar *modest_account_name,
124 const gchar *mailbox,
125 const gchar *msg_uid);
128 * modest_msg_view_window_is_other_body:
129 * @self: a #ModestMsgViewWindow
131 * tells if the view window is showing other body
133 * Returns: %TRUE if showing "not first body"
135 gboolean modest_msg_view_window_is_other_body (ModestMsgViewWindow *self);
138 * modest_msg_view_window_new_with_header_model:
139 * @msg: an #TnyMsg instance
140 * @modest_account_name: the account name
141 * @mailbox: the mailbox (if any)
142 * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
143 * @row_reference: a #GtkTreeRowReference, pointing to the position of @msg in @model.
145 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
146 * set the proper account when choosing reply/forward from the msg view window.
147 * This constructor also passes a reference to the @model of the header view
148 * to allow selecting previous/next messages in the message list when appropriate.
150 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
152 ModestWindow* modest_msg_view_window_new_with_header_model (TnyMsg *msg,
153 const gchar *modest_account_name,
154 const gchar *mailbox,
155 const gchar *msg_uid,
157 GtkTreeRowReference *row_reference);
160 * modest_msg_view_window_new_from_header_view:
161 * @header_view: an #ModestHeaderView instance
162 * @modest_account_name: the account name
163 * @mailbox: the mailbox (if any)
164 * @msg_uid: the initial uid reserved by this window
165 * @row_reference: a #GtkTreeRowReference, pointing to the selected position @model.
167 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
168 * set the proper account when choosing reply/forward from the msg view window.
169 * It's different from new_with_header_model, as it creates the window and then
170 * loads the message in that window.
172 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
174 ModestWindow* modest_msg_view_window_new_from_header_view (ModestHeaderView *header_view,
175 const gchar *modest_account_name,
176 const gchar *mailbox,
177 const gchar *msg_uid,
178 GtkTreeRowReference *row_reference);
182 * modest_msg_view_window_new_from_uid:
185 modest_msg_view_window_new_from_uid (const gchar *modest_account_name,
186 const gchar *mailbox,
187 const gchar *msg_uid);
190 * modest_msg_view_window_new_for_search_result:
191 * @msg: an #TnyMsg instance
192 * @modest_account_name: the account name
194 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
195 * set the proper account when choosing reply/forward from the msg view window.
196 * This constructor marks the window as being for a search result, which should
197 * cause some UI to be disabled, such as the previous/next buttons.
199 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
202 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
203 const gchar *modest_account_name,
204 const gchar *mailbox,
205 const gchar *msg_uid);
208 * modest_msg_view_window_get_header:
209 * @window: an #ModestMsgViewWindow instance
211 * get the message header in this msg view. Header instance is get
212 * from tree_model of headers list.
214 * Returns: a new #TnyHeader instance, or NULL in case of error
217 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
220 * modest_msg_view_window_get_message:
221 * @window: an #ModestMsgViewWindow instance
223 * get a new reference to the message in this msg view. The caller
224 * must free this new reference
226 * Returns: a new #TnyMsg instance, or NULL in case of error
228 TnyMsg* modest_msg_view_window_get_message (ModestMsgViewWindow *window);
231 * modest_msg_view_window_get_message_uid:
232 * @msg: an #ModestMsgViewWindow instance
234 * gets the unique identifier for the message in this msg view. The
235 * returned value *must* not be freed
237 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
239 const gchar* modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
242 * modest_msg_view_window_select_next_message:
243 * @window: a #ModestMsgViewWindow instance
245 * select the next message obtained from the header view this view
248 * Returns: %TRUE if a new message is shown.
250 gboolean modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
253 * modest_msg_view_window_select_previous_message:
254 * @window: a #ModestMsgViewWindow instance
256 * select the previous message obtained from the header view this view
259 * Returns: %TRUE if a new message is shown.
261 gboolean modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
264 * modest_msg_view_window_view_attachment:
265 * @window: a #ModestMsgViewWindow
266 * @mime_part: a #TnyMimePart
268 * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
269 * If it's a message, it opens it for viewing. Otherwise it opens a temporary file
270 * with the contents of the attachment.
272 void modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
273 TnyMimePart *mime_part);
276 * modest_msg_view_window_get_attachments:
277 * @window: a #ModestMsgViewWindow
279 * Get selected attachments from #ModetMsgView private object.
281 TnyList * modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
284 * modest_msg_view_window_save_attachments:
285 * @window: a #ModestMsgViewWindow
286 * @mime_parts: a #TnyList of #TnyMimePart
288 * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
289 * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
291 void modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
292 TnyList *mime_parts);
295 * modest_msg_view_window_remove_attachments:
296 * @window: a #ModestMsgViewWindow
297 * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
298 * purges only selected ones.
300 * Removes selected attachments.
302 void modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
307 * modest_msg_view_window_toolbar_on_transfer_mode:
308 * @window: a #ModestMsgViewWindow
310 * Check if toolbar is in transfer mode, which determines whether a
311 * transfer operation is being processed.
313 gboolean modest_msg_view_window_toolbar_on_transfer_mode (ModestMsgViewWindow *self);
317 * modest_msg_view_window_last_message_selected:
318 * @window: a #ModestMsgViewWindow
320 * Check message currently viewed is the last message into folder .
322 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
326 * modest_msg_view_window_first_message_selected:
327 * @window: a #ModestMsgViewWindow
329 * Check message currently viewed is the last message into folder .
331 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
334 * modest_msg_view_window_has_headers_model:
335 * @window: a #ModestMsgViewWindow
337 * Check if window has been created with a full headers model.
339 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
342 * modest_msg_view_window_is_search_result:
343 * @window: a #ModestMsgViewWindow
345 * Check if window has been created to show a search result.
347 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
351 * modest_msg_view_window_get_folder_type:
352 * @window: a #ModestMsgViewWindow
354 * Gets folder type of message currently viewed .
357 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
360 * modest_msg_view_window_transfer_mode_enabled:
361 * @window: a #ModestMsgViewWindow
363 * Determines if some transfer operation is in progress.
365 * Returns: TRUE if transfer mode is enabled, FASE otherwise.
368 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
371 * modest_msg_view_window_add_to_contacts:
372 * @self: a #ModestMsgViewWindow
374 * activates the add to contacts use case. In Diablo and gnome it gets the
375 * clipboard selection current value and tries to add it to the addressbook.
376 * In fremantle, it shows the add to contacts dialog to select the recipient
380 modest_msg_view_window_add_to_contacts (ModestMsgViewWindow *self);
383 * modest_msg_view_window_get_msg_view:
384 * @self: a #ModestMsgViewWindow
386 * Tells that external images should be fetched in this window.
389 modest_msg_view_window_fetch_images (ModestMsgViewWindow *self);
392 * modest_msg_view_window_has_blocked_external_images:
393 * @self: a #ModestMsgViewWindow
395 * checks if the msg currently shown has blocked external images.
397 * Returns: %TRUE if external images are blocked, %FALSE otherwise
399 gboolean modest_msg_view_window_has_blocked_external_images (ModestMsgViewWindow *self);
402 * modest_msg_view_window_reload:
403 * @self: a #ModestMsgViewWindow
405 * Reloads currently loaded message. This is intended to show the message in case it
406 * has some update on the previously visible result.
408 void modest_msg_view_window_reload (ModestMsgViewWindow *self);
412 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */