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_for_attachment:
73 * @msg: an #TnyMsg instance
74 * @modest_account_name: the account name
76 * instantiates a new #ModestMsgViewWindow widget to view a message that is an
77 * attachment in another message.
78 * The account name is used to
79 * set the proper account when choosing reply/forward from the msg view window
81 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
83 ModestWindow* modest_msg_view_window_new_for_attachment (TnyMsg *msg,
84 const gchar *modest_account_name,
85 const gchar *msg_uid);
88 * modest_msg_view_window_new_with_header_model:
89 * @msg: an #TnyMsg instance
90 * @modest_account_name: the account name
91 * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
92 * @row_reference: a #GtkTreeRowReference, pointing to the position of @msg in @model.
94 * instantiates a new #ModestMsgViewWindow widget. The account name is used to
95 * set the proper account when choosing reply/forward from the msg view window.
96 * This constructor also passes a reference to the @model of the header view
97 * to allow selecting previous/next messages in the message list when appropriate.
99 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
101 ModestWindow* modest_msg_view_window_new_with_header_model (TnyMsg *msg,
102 const gchar *modest_account_name,
103 const gchar *msg_uid,
105 GtkTreeRowReference *row_reference);
109 * modest_msg_view_window_new_for_search_result:
110 * @msg: an #TnyMsg instance
111 * @modest_account_name: the account name
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 marks the window as being for a search result, which should
116 * cause some UI to be disabled, such as the previous/next buttons.
118 * Returns: a new #ModestMsgViewWindow, or NULL in case of error
121 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
122 const gchar *modest_account_name,
123 const gchar *msg_uid);
126 * modest_msg_view_window_get_header:
127 * @window: an #ModestMsgViewWindow instance
129 * get the message header in this msg view. Header instance is get
130 * from tree_model of headers list.
132 * Returns: a new #TnyHeader instance, or NULL in case of error
135 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
138 * modest_msg_view_window_get_message:
139 * @window: an #ModestMsgViewWindow instance
141 * get a new reference to the message in this msg view. The caller
142 * must free this new reference
144 * Returns: a new #TnyMsg instance, or NULL in case of error
146 TnyMsg* modest_msg_view_window_get_message (ModestMsgViewWindow *window);
149 * modest_msg_view_window_get_message_uid:
150 * @msg: an #ModestMsgViewWindow instance
152 * gets the unique identifier for the message in this msg view. The
153 * returned value *must* not be freed
155 * Returns: the id of the #TnyMsg being shown, or NULL in case of error
157 const gchar* modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
160 * modest_msg_view_window_select_first_message:
161 * @window: a #ModestMsgViewWindow instance
163 * select the first message obtained from the header view this view
166 * Returns: %TRUE if a new message is shown.
168 gboolean modest_msg_view_window_select_first_message (ModestMsgViewWindow *window);
171 * modest_msg_view_window_select_next_message:
172 * @window: a #ModestMsgViewWindow instance
174 * select the next message obtained from the header view this view
177 * Returns: %TRUE if a new message is shown.
179 gboolean modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
182 * modest_msg_view_window_select_previous_message:
183 * @window: a #ModestMsgViewWindow instance
185 * select the previous message obtained from the header view this view
188 * Returns: %TRUE if a new message is shown.
190 gboolean modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
193 * modest_msg_view_window_view_attachment:
194 * @window: a #ModestMsgViewWindow
195 * @mime_part: a #TnyMimePart
197 * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
198 * If it's a message, it opens it for viewing. Otherwise it opens a temporary file
199 * with the contents of the attachment.
201 void modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
202 TnyMimePart *mime_part);
205 * modest_msg_view_window_get_attachments:
206 * @window: a #ModestMsgViewWindow
208 * Get selected attachments from #ModetMsgView private object.
210 GList * modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
213 * modest_msg_view_window_save_attachments:
214 * @window: a #ModestMsgViewWindow
215 * @mime_parts: a #GList of #TnyMimePart
217 * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
218 * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
220 void modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
224 * modest_msg_view_window_remove_attachments:
225 * @window: a #ModestMsgViewWindow
226 * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
227 * purges only selected ones.
229 * Removes selected attachments.
231 void modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
236 * modest_msg_view_window_toolbar_on_transfer_mode:
237 * @window: a #ModestMsgViewWindow
239 * Check if toolbar is in transfer mode, which determines whether a
240 * transfer operation is being processed.
242 gboolean modest_msg_view_window_toolbar_on_transfer_mode (ModestMsgViewWindow *self);
246 * modest_msg_view_window_last_message_selected:
247 * @window: a #ModestMsgViewWindow
249 * Check message currently viewed is the last message into folder .
251 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
255 * modest_msg_view_window_first_message_selected:
256 * @window: a #ModestMsgViewWindow
258 * Check message currently viewed is the last message into folder .
260 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
263 * modest_msg_view_window_has_headers_model:
264 * @window: a #ModestMsgViewWindow
266 * Check if window has been created with a full headers model.
268 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
271 * modest_msg_view_window_is_search_result:
272 * @window: a #ModestMsgViewWindow
274 * Check if window has been created to show a search result.
276 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
280 * modest_msg_view_window_get_folder_type:
281 * @window: a #ModestMsgViewWindow
283 * Gets folder type of message currently viewed .
286 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
289 * modest_msg_view_window_transfer_mode_enabled:
290 * @window: a #ModestMsgViewWindow
292 * Determines if some transfer operation is in progress.
294 * Returns: TRUE if transfer mode is enabled, FASE otherwise.
297 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
301 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */