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
95 * instantiates a new #ModestMsgViewWindow widget to view a message that is an
96 * attachment in another message.
97 * The account name is used to
98 * set the proper account when choosing reply/forward from the msg view window
100 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
102 ModestWindow* modest_msg_view_window_new_for_attachment (TnyMsg *msg,
103 const gchar *modest_account_name,
104 const gchar *msg_uid);
107 * modest_msg_view_window_new_with_header_model:
108 * @msg: an #TnyMsg instance
109 * @modest_account_name: the account name
110 * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
111 * @row_reference: a #GtkTreeRowReference, pointing to the position of @msg in @model.
113 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
114 * set the proper account when choosing reply/forward from the msg view window.
115 * This constructor also passes a reference to the @model of the header view
116 * to allow selecting previous/next messages in the message list when appropriate.
118 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
120 ModestWindow* modest_msg_view_window_new_with_header_model (TnyMsg *msg,
121 const gchar *modest_account_name,
122 const gchar *msg_uid,
124 GtkTreeRowReference *row_reference);
127 * modest_msg_view_window_new_from_header_view:
128 * @header_view: an #ModestHeaderView instance
129 * @modest_account_name: the account name
130 * @msg_uid: the initial uid reserved by this window
131 * @row_reference: a #GtkTreeRowReference, pointing to the selected position @model.
133 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
134 * set the proper account when choosing reply/forward from the msg view window.
135 * It's different from new_with_header_model, as it creates the window and then
136 * loads the message in that window.
138 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
140 ModestWindow* modest_msg_view_window_new_from_header_view (ModestHeaderView *header_view,
141 const gchar *modest_account_name,
142 const gchar *msg_uid,
143 GtkTreeRowReference *row_reference);
147 * modest_msg_view_window_new_for_search_result:
148 * @msg: an #TnyMsg instance
149 * @modest_account_name: the account name
151 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
152 * set the proper account when choosing reply/forward from the msg view window.
153 * This constructor marks the window as being for a search result, which should
154 * cause some UI to be disabled, such as the previous/next buttons.
156 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
159 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
160 const gchar *modest_account_name,
161 const gchar *msg_uid);
164 * modest_msg_view_window_get_header:
165 * @window: an #ModestMsgViewWindow instance
167 * get the message header in this msg view. Header instance is get
168 * from tree_model of headers list.
170 * Returns: a new #TnyHeader instance, or NULL in case of error
173 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
176 * modest_msg_view_window_get_message:
177 * @window: an #ModestMsgViewWindow instance
179 * get a new reference to the message in this msg view. The caller
180 * must free this new reference
182 * Returns: a new #TnyMsg instance, or NULL in case of error
184 TnyMsg* modest_msg_view_window_get_message (ModestMsgViewWindow *window);
187 * modest_msg_view_window_get_message_uid:
188 * @msg: an #ModestMsgViewWindow instance
190 * gets the unique identifier for the message in this msg view. The
191 * returned value *must* not be freed
193 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
195 const gchar* modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
198 * modest_msg_view_window_select_next_message:
199 * @window: a #ModestMsgViewWindow instance
201 * select the next message obtained from the header view this view
204 * Returns: %TRUE if a new message is shown.
206 gboolean modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
209 * modest_msg_view_window_select_previous_message:
210 * @window: a #ModestMsgViewWindow instance
212 * select the previous message obtained from the header view this view
215 * Returns: %TRUE if a new message is shown.
217 gboolean modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
220 * modest_msg_view_window_view_attachment:
221 * @window: a #ModestMsgViewWindow
222 * @mime_part: a #TnyMimePart
224 * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
225 * If it's a message, it opens it for viewing. Otherwise it opens a temporary file
226 * with the contents of the attachment.
228 void modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
229 TnyMimePart *mime_part);
232 * modest_msg_view_window_get_attachments:
233 * @window: a #ModestMsgViewWindow
235 * Get selected attachments from #ModetMsgView private object.
237 TnyList * modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
240 * modest_msg_view_window_save_attachments:
241 * @window: a #ModestMsgViewWindow
242 * @mime_parts: a #TnyList of #TnyMimePart
244 * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
245 * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
247 void modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
248 TnyList *mime_parts);
251 * modest_msg_view_window_remove_attachments:
252 * @window: a #ModestMsgViewWindow
253 * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
254 * purges only selected ones.
256 * Removes selected attachments.
258 void modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
263 * modest_msg_view_window_toolbar_on_transfer_mode:
264 * @window: a #ModestMsgViewWindow
266 * Check if toolbar is in transfer mode, which determines whether a
267 * transfer operation is being processed.
269 gboolean modest_msg_view_window_toolbar_on_transfer_mode (ModestMsgViewWindow *self);
273 * modest_msg_view_window_last_message_selected:
274 * @window: a #ModestMsgViewWindow
276 * Check message currently viewed is the last message into folder .
278 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
282 * modest_msg_view_window_first_message_selected:
283 * @window: a #ModestMsgViewWindow
285 * Check message currently viewed is the last message into folder .
287 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
290 * modest_msg_view_window_has_headers_model:
291 * @window: a #ModestMsgViewWindow
293 * Check if window has been created with a full headers model.
295 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
298 * modest_msg_view_window_is_search_result:
299 * @window: a #ModestMsgViewWindow
301 * Check if window has been created to show a search result.
303 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
307 * modest_msg_view_window_get_folder_type:
308 * @window: a #ModestMsgViewWindow
310 * Gets folder type of message currently viewed .
313 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
316 * modest_msg_view_window_transfer_mode_enabled:
317 * @window: a #ModestMsgViewWindow
319 * Determines if some transfer operation is in progress.
321 * Returns: TRUE if transfer mode is enabled, FASE otherwise.
324 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
327 * modest_msg_view_window_add_to_contacts:
328 * @self: a #ModestMsgViewWindow
330 * activates the add to contacts use case. In Diablo and gnome it gets the
331 * clipboard selection current value and tries to add it to the addressbook.
332 * In fremantle, it shows the add to contacts dialog to select the recipient
336 modest_msg_view_window_add_to_contacts (ModestMsgViewWindow *self);
340 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */