git.maemo.org Git - modest/blob - src/widgets/modest-msg-view-window.h

   1 /* Copyright (c) 2006,2007 Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 #ifndef __MODEST_MSG_VIEW_WINDOW_H__
  31 #define __MODEST_MSG_VIEW_WINDOW_H__
  32
  33 #include <tny-msg.h>
  34 #include <widgets/modest-window.h>
  35 #include <gtk/gtktreemodel.h>
  36
  37 G_BEGIN_DECLS
  38
  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))
  46
  47
  48 typedef struct {
  49          ModestWindow parent;
  50 } ModestMsgViewWindow;
  51
  52 typedef struct {
  53         ModestWindowClass parent_class;
  54
  55         void (*msg_changed) (ModestMsgViewWindow *self,
  56                              GtkTreeModel *model,
  57                              GtkTreeRowReference *row_reference,
  58                              gpointer user_data);
  59 } ModestMsgViewWindowClass;
  60
  61 /**
  62  * modest_msg_view_window_get_type:
  63  *
  64  * get the GType for the #ModestMsgViewWindow class
  65  *
  66  * Returns: a GType for #ModestMsgViewWindow
  67  */
  68 GType        modest_msg_view_window_get_type    (void) G_GNUC_CONST;
  69
  70
  71 /**
  72  * modest_msg_view_window_new_for_attachment:
  73  * @msg: an #TnyMsg instance
  74  * @modest_account_name: the account name
  75  *
  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
  80  *
  81  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
  82  */
  83 ModestWindow*   modest_msg_view_window_new_for_attachment         (TnyMsg *msg,
  84                                                     const gchar *modest_account_name,
  85                                                     const gchar *msg_uid);
  86
  87 /**
  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.
  93  *
  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.
  98  *
  99  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 100  */
 101 ModestWindow*   modest_msg_view_window_new_with_header_model (TnyMsg *msg,
 102                                                               const gchar *modest_account_name,
 103                                                               const gchar *msg_uid,
 104                                                               GtkTreeModel *model,
 105                                                               GtkTreeRowReference *row_reference);
 106
 107
 108 /**
 109  * modest_msg_view_window_new_for_search_result:
 110  * @msg: an #TnyMsg instance
 111  * @modest_account_name: the account name
 112  *
 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.
 117  *
 118  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 119  */
 120 ModestWindow *
 121 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
 122                                               const gchar *modest_account_name,
 123                                               const gchar *msg_uid);
 124
 125 /**
 126  * modest_msg_view_window_get_header:
 127  * @window: an #ModestMsgViewWindow instance
 128  *
 129  * get the message header in this msg view. Header instance is get
 130  * from tree_model of headers list.
 131  *
 132  * Returns: a new #TnyHeader instance, or NULL in case of error
 133  */
 134 TnyHeader*
 135 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
 136
 137 /**
 138  * modest_msg_view_window_get_message:
 139  * @window: an #ModestMsgViewWindow instance
 140  *
 141  * get a new reference to the message in this msg view. The caller
 142  * must free this new reference
 143  *
 144  * Returns: a new #TnyMsg instance, or NULL in case of error
 145  */
 146 TnyMsg*         modest_msg_view_window_get_message     (ModestMsgViewWindow *window);
 147
 148 /**
 149  * modest_msg_view_window_get_message_uid:
 150  * @msg: an #ModestMsgViewWindow instance
 151  *
 152  * gets the unique identifier for the message in this msg view. The
 153  * returned value *must* not be freed
 154  *
 155  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 156  */
 157 const gchar*    modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
 158
 159 /**
 160  * modest_msg_view_window_select_first_message:
 161  * @window: a #ModestMsgViewWindow instance
 162  *
 163  * select the first message obtained from the header view this view
 164  * was called from
 165  *
 166  * Returns: %TRUE if a new message is shown.
 167  */
 168 gboolean        modest_msg_view_window_select_first_message (ModestMsgViewWindow *window);
 169
 170 /**
 171  * modest_msg_view_window_select_next_message:
 172  * @window: a #ModestMsgViewWindow instance
 173  *
 174  * select the next message obtained from the header view this view
 175  * was called from
 176  *
 177  * Returns: %TRUE if a new message is shown.
 178  */
 179 gboolean        modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
 180
 181 /**
 182  * modest_msg_view_window_select_previous_message:
 183  * @window: a #ModestMsgViewWindow instance
 184  *
 185  * select the previous message obtained from the header view this view
 186  * was called from
 187  *
 188  * Returns: %TRUE if a new message is shown.
 189  */
 190 gboolean        modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
 191
 192 /**
 193  * modest_msg_view_window_toggle_fullscreen:
 194  * @window: a #ModestMsgViewWindow
 195  *
 196  * toggles the current fullscreen status
 197  */
 198 void            modest_msg_view_window_toggle_fullscreen (ModestMsgViewWindow *window);
 199
 200 /**
 201  * modest_msg_view_window_view_attachment:
 202  * @window: a #ModestMsgViewWindow
 203  * @mime_part: a #TnyMimePart
 204  *
 205  * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
 206  * If it's a message, it opens it  for viewing. Otherwise it opens a temporary file
 207  * with the contents of the attachment.
 208  */
 209 void            modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
 210                                                         TnyMimePart *mime_part);
 211
 212 /**
 213  * modest_msg_view_window_get_attachments:
 214  * @window: a #ModestMsgViewWindow
 215  *
 216  * Get selected attachments from #ModetMsgView private object.
 217  */
 218 GList *         modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
 219
 220 /**
 221  * modest_msg_view_window_save_attachments:
 222  * @window: a #ModestMsgViewWindow
 223  * @mime_parts: a #GList of #TnyMimePart
 224  *
 225  * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
 226  * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
 227  */
 228 void            modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
 229                                                          GList *mime_parts);
 230
 231 /**
 232  * modest_msg_view_window_remove_attachments:
 233  * @window: a #ModestMsgViewWindow
 234  * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
 235  * purges only selected ones.
 236  *
 237  * Removes selected attachments.
 238  */
 239 void            modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
 240                                                            gboolean get_all);
 241
 242
 243 /**
 244  * modest_msg_view_window_toolbar_on_transfer_mode:
 245  * @window: a #ModestMsgViewWindow
 246  *
 247  * Check if toolbar is in transfer mode, which determines whether a
 248  * transfer operation is being processed.
 249  */
 250 gboolean  modest_msg_view_window_toolbar_on_transfer_mode     (ModestMsgViewWindow *self);
 251
 252
 253 /**
 254  * modest_msg_view_window_last_message_selected:
 255  * @window: a #ModestMsgViewWindow
 256  *
 257  * Check message currently viewed is the last message into folder .
 258 */
 259 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
 260
 261
 262 /**
 263  * modest_msg_view_window_first_message_selected:
 264  * @window: a #ModestMsgViewWindow
 265  *
 266  * Check message currently viewed is the last message into folder .
 267 */
 268 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
 269
 270 /**
 271  * modest_msg_view_window_has_headers_model:
 272  * @window: a #ModestMsgViewWindow
 273  *
 274  * Check if window has been created with a full headers model.
 275 */
 276 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
 277
 278 /**
 279  * modest_msg_view_window_is_search_result:
 280  * @window: a #ModestMsgViewWindow
 281  *
 282  * Check if window has been created to show a search result.
 283  */
 284 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
 285
 286
 287 /**
 288  * modest_msg_view_window_get_folder_type:
 289  * @window: a #ModestMsgViewWindow
 290  *
 291  * Gets folder type of message currently viewed .
 292 */
 293 TnyFolderType
 294 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
 295
 296 /**
 297  * modest_msg_view_window_transfer_mode_enabled:
 298  * @window: a #ModestMsgViewWindow
 299  *
 300  * Determines if some transfer operation is in progress.
 301  *
 302  * Returns: TRUE if transfer mode is enabled, FASE otherwise.
 303 */
 304 gboolean
 305 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
 306
 307 G_END_DECLS
 308
 309 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */
 310