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 <tny-folder.h>
  35 #ifdef MODEST_TOOLKIT_HILDON2
  36 #include <modest-hildon2-window.h>
  37 #endif
  38 #include <widgets/modest-window.h>
  39 #include <widgets/modest-header-view.h>
  40 #include <gtk/gtktreemodel.h>
  41 #include <gtk/gtkenums.h>
  42
  43 G_BEGIN_DECLS
  44
  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))
  52
  53
  54 typedef struct {
  55 #ifdef MODEST_TOOLKIT_HILDON2
  56         ModestHildon2Window parent;
  57 #else
  58         ModestWindow parent;
  59 #endif
  60 } ModestMsgViewWindow;
  61
  62 typedef struct {
  63 #ifdef MODEST_TOOLKIT_HILDON2
  64         ModestHildon2WindowClass parent_class;
  65 #else
  66         ModestWindowClass parent_class;
  67 #endif
  68
  69         void (*msg_changed) (ModestMsgViewWindow *self,
  70                              GtkTreeModel *model,
  71                              GtkTreeRowReference *row_reference,
  72                              gpointer user_data);
  73
  74         gboolean (*scroll_child) (ModestMsgViewWindow *self,
  75                                    GtkScrollType scroll_type,
  76                                    gboolean horizontal,
  77                                    gpointer userdata);
  78 } ModestMsgViewWindowClass;
  79
  80 /**
  81  * modest_msg_view_window_get_type:
  82  *
  83  * get the GType for the #ModestMsgViewWindow class
  84  *
  85  * Returns: a GType for #ModestMsgViewWindow
  86  */
  87 GType        modest_msg_view_window_get_type    (void) G_GNUC_CONST;
  88
  89
  90 /**
  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)
  95  *
  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
 100  *
 101  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 102  */
 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);
 107
 108 /**
 109  * modest_msg_view_window_new_with_header_model:
 110  * @msg: an #TnyMsg instance
 111  * @modest_account_name: the account name
 112  * @mailbox: the mailbox (if any)
 113  * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
 114  * @row_reference: a #GtkTreeRowReference, pointing to the position of @msg in @model.
 115  *
 116  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
 117  * set the proper account when choosing reply/forward from the msg view window.
 118  * This constructor also passes a reference to the @model of the header view
 119  * to allow selecting previous/next messages in the message list when appropriate.
 120  *
 121  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 122  */
 123 ModestWindow*   modest_msg_view_window_new_with_header_model (TnyMsg *msg,
 124                                                               const gchar *modest_account_name,
 125                                                               const gchar *mailbox,
 126                                                               const gchar *msg_uid,
 127                                                               GtkTreeModel *model,
 128                                                               GtkTreeRowReference *row_reference);
 129
 130 /**
 131  * modest_msg_view_window_new_from_header_view:
 132  * @header_view: an #ModestHeaderView instance
 133  * @modest_account_name: the account name
 134  * @mailbox: the mailbox (if any)
 135  * @msg_uid: the initial uid reserved by this window
 136  * @row_reference: a #GtkTreeRowReference, pointing to the selected position @model.
 137  *
 138  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
 139  * set the proper account when choosing reply/forward from the msg view window.
 140  * It's different from new_with_header_model, as it creates the window and then
 141  * loads the message in that window.
 142  *
 143  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 144  */
 145 ModestWindow*   modest_msg_view_window_new_from_header_view (ModestHeaderView *header_view,
 146                                                              const gchar *modest_account_name,
 147                                                              const gchar *mailbox,
 148                                                              const gchar *msg_uid,
 149                                                              GtkTreeRowReference *row_reference);
 150
 151
 152 /**
 153  * modest_msg_view_window_new_for_search_result:
 154  * @msg: an #TnyMsg instance
 155  * @modest_account_name: the account name
 156  *
 157  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
 158  * set the proper account when choosing reply/forward from the msg view window.
 159  * This constructor marks the window as being for a search result, which should
 160  * cause some UI to be disabled, such as the previous/next buttons.
 161  *
 162  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 163  */
 164 ModestWindow *
 165 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
 166                                               const gchar *modest_account_name,
 167                                               const gchar *mailbox,
 168                                               const gchar *msg_uid);
 169
 170 /**
 171  * modest_msg_view_window_get_header:
 172  * @window: an #ModestMsgViewWindow instance
 173  *
 174  * get the message header in this msg view. Header instance is get
 175  * from tree_model of headers list.
 176  *
 177  * Returns: a new #TnyHeader instance, or NULL in case of error
 178  */
 179 TnyHeader*
 180 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
 181
 182 /**
 183  * modest_msg_view_window_get_message:
 184  * @window: an #ModestMsgViewWindow instance
 185  *
 186  * get a new reference to the message in this msg view. The caller
 187  * must free this new reference
 188  *
 189  * Returns: a new #TnyMsg instance, or NULL in case of error
 190  */
 191 TnyMsg*         modest_msg_view_window_get_message     (ModestMsgViewWindow *window);
 192
 193 /**
 194  * modest_msg_view_window_get_message_uid:
 195  * @msg: an #ModestMsgViewWindow instance
 196  *
 197  * gets the unique identifier for the message in this msg view. The
 198  * returned value *must* not be freed
 199  *
 200  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 201  */
 202 const gchar*    modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
 203
 204 /**
 205  * modest_msg_view_window_select_next_message:
 206  * @window: a #ModestMsgViewWindow instance
 207  *
 208  * select the next message obtained from the header view this view
 209  * was called from
 210  *
 211  * Returns: %TRUE if a new message is shown.
 212  */
 213 gboolean        modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
 214
 215 /**
 216  * modest_msg_view_window_select_previous_message:
 217  * @window: a #ModestMsgViewWindow instance
 218  *
 219  * select the previous message obtained from the header view this view
 220  * was called from
 221  *
 222  * Returns: %TRUE if a new message is shown.
 223  */
 224 gboolean        modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
 225
 226 /**
 227  * modest_msg_view_window_view_attachment:
 228  * @window: a #ModestMsgViewWindow
 229  * @mime_part: a #TnyMimePart
 230  *
 231  * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
 232  * If it's a message, it opens it  for viewing. Otherwise it opens a temporary file
 233  * with the contents of the attachment.
 234  */
 235 void            modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
 236                                                         TnyMimePart *mime_part);
 237
 238 /**
 239  * modest_msg_view_window_get_attachments:
 240  * @window: a #ModestMsgViewWindow
 241  *
 242  * Get selected attachments from #ModetMsgView private object.
 243  */
 244 TnyList *         modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
 245
 246 /**
 247  * modest_msg_view_window_save_attachments:
 248  * @window: a #ModestMsgViewWindow
 249  * @mime_parts: a #TnyList of #TnyMimePart
 250  *
 251  * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
 252  * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
 253  */
 254 void            modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
 255                                                          TnyList *mime_parts);
 256
 257 /**
 258  * modest_msg_view_window_remove_attachments:
 259  * @window: a #ModestMsgViewWindow
 260  * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
 261  * purges only selected ones.
 262  *
 263  * Removes selected attachments.
 264  */
 265 void            modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
 266                                                            gboolean get_all);
 267
 268
 269 /**
 270  * modest_msg_view_window_toolbar_on_transfer_mode:
 271  * @window: a #ModestMsgViewWindow
 272  *
 273  * Check if toolbar is in transfer mode, which determines whether a
 274  * transfer operation is being processed.
 275  */
 276 gboolean  modest_msg_view_window_toolbar_on_transfer_mode     (ModestMsgViewWindow *self);
 277
 278
 279 /**
 280  * modest_msg_view_window_last_message_selected:
 281  * @window: a #ModestMsgViewWindow
 282  *
 283  * Check message currently viewed is the last message into folder .
 284 */
 285 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
 286
 287
 288 /**
 289  * modest_msg_view_window_first_message_selected:
 290  * @window: a #ModestMsgViewWindow
 291  *
 292  * Check message currently viewed is the last message into folder .
 293 */
 294 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
 295
 296 /**
 297  * modest_msg_view_window_has_headers_model:
 298  * @window: a #ModestMsgViewWindow
 299  *
 300  * Check if window has been created with a full headers model.
 301 */
 302 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
 303
 304 /**
 305  * modest_msg_view_window_is_search_result:
 306  * @window: a #ModestMsgViewWindow
 307  *
 308  * Check if window has been created to show a search result.
 309  */
 310 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
 311
 312
 313 /**
 314  * modest_msg_view_window_get_folder_type:
 315  * @window: a #ModestMsgViewWindow
 316  *
 317  * Gets folder type of message currently viewed .
 318 */
 319 TnyFolderType
 320 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
 321
 322 /**
 323  * modest_msg_view_window_transfer_mode_enabled:
 324  * @window: a #ModestMsgViewWindow
 325  *
 326  * Determines if some transfer operation is in progress.
 327  *
 328  * Returns: TRUE if transfer mode is enabled, FASE otherwise.
 329 */
 330 gboolean
 331 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
 332
 333 /**
 334  * modest_msg_view_window_add_to_contacts:
 335  * @self: a #ModestMsgViewWindow
 336  *
 337  * activates the add to contacts use case. In Diablo and gnome it gets the
 338  * clipboard selection current value and tries to add it to the addressbook.
 339  * In fremantle, it shows the add to contacts dialog to select the recipient
 340  * to add.
 341  */
 342 void
 343 modest_msg_view_window_add_to_contacts (ModestMsgViewWindow *self);
 344
 345 /**
 346  * modest_msg_view_window_get_msg_view:
 347  * @self: a #ModestMsgViewWindow
 348  *
 349  * Tells that external images should be fetched in this window.
 350  */
 351 void
 352 modest_msg_view_window_fetch_images (ModestMsgViewWindow *self);
 353
 354 /**
 355  * modest_msg_view_window_has_blocked_external_images:
 356  * @self: a #ModestMsgViewWindow
 357  *
 358  * checks if the msg currently shown has blocked external images.
 359  *
 360  * Returns: %TRUE if external images are blocked, %FALSE otherwise
 361  */
 362 gboolean modest_msg_view_window_has_blocked_external_images (ModestMsgViewWindow *self);
 363
 364 G_END_DECLS
 365
 366 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */
 367