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_other_body:
 110  * @msg: an #TnyMsg instance
 111  * @modest_account_name: the account name
 112  * @mailbox: the mailbox (if any)
 113  *
 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
 118  *
 119  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 120  */
 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);
 126
 127 /**
 128  * modest_msg_view_window_is_other_body:
 129  * @self: a #ModestMsgViewWindow
 130  *
 131  * tells if the view window is showing other body
 132  *
 133  * Returns: %TRUE if showing "not first body"
 134  */
 135 gboolean modest_msg_view_window_is_other_body (ModestMsgViewWindow *self);
 136
 137 /**
 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.
 144  *
 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.
 149  *
 150  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 151  */
 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,
 156                                                               GtkTreeModel *model,
 157                                                               GtkTreeRowReference *row_reference);
 158
 159 /**
 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.
 166  *
 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.
 171  *
 172  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 173  */
 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);
 179
 180
 181 /**
 182  * modest_msg_view_window_new_for_search_result:
 183  * @msg: an #TnyMsg instance
 184  * @modest_account_name: the account name
 185  *
 186  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
 187  * set the proper account when choosing reply/forward from the msg view window.
 188  * This constructor marks the window as being for a search result, which should
 189  * cause some UI to be disabled, such as the previous/next buttons.
 190  *
 191  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
 192  */
 193 ModestWindow *
 194 modest_msg_view_window_new_for_search_result (TnyMsg *msg,
 195                                               const gchar *modest_account_name,
 196                                               const gchar *mailbox,
 197                                               const gchar *msg_uid);
 198
 199 /**
 200  * modest_msg_view_window_get_header:
 201  * @window: an #ModestMsgViewWindow instance
 202  *
 203  * get the message header in this msg view. Header instance is get
 204  * from tree_model of headers list.
 205  *
 206  * Returns: a new #TnyHeader instance, or NULL in case of error
 207  */
 208 TnyHeader*
 209 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
 210
 211 /**
 212  * modest_msg_view_window_get_message:
 213  * @window: an #ModestMsgViewWindow instance
 214  *
 215  * get a new reference to the message in this msg view. The caller
 216  * must free this new reference
 217  *
 218  * Returns: a new #TnyMsg instance, or NULL in case of error
 219  */
 220 TnyMsg*         modest_msg_view_window_get_message     (ModestMsgViewWindow *window);
 221
 222 /**
 223  * modest_msg_view_window_get_message_uid:
 224  * @msg: an #ModestMsgViewWindow instance
 225  *
 226  * gets the unique identifier for the message in this msg view. The
 227  * returned value *must* not be freed
 228  *
 229  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 230  */
 231 const gchar*    modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
 232
 233 /**
 234  * modest_msg_view_window_select_next_message:
 235  * @window: a #ModestMsgViewWindow instance
 236  *
 237  * select the next message obtained from the header view this view
 238  * was called from
 239  *
 240  * Returns: %TRUE if a new message is shown.
 241  */
 242 gboolean        modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
 243
 244 /**
 245  * modest_msg_view_window_select_previous_message:
 246  * @window: a #ModestMsgViewWindow instance
 247  *
 248  * select the previous message obtained from the header view this view
 249  * was called from
 250  *
 251  * Returns: %TRUE if a new message is shown.
 252  */
 253 gboolean        modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
 254
 255 /**
 256  * modest_msg_view_window_view_attachment:
 257  * @window: a #ModestMsgViewWindow
 258  * @mime_part: a #TnyMimePart
 259  *
 260  * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
 261  * If it's a message, it opens it  for viewing. Otherwise it opens a temporary file
 262  * with the contents of the attachment.
 263  */
 264 void            modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
 265                                                         TnyMimePart *mime_part);
 266
 267 /**
 268  * modest_msg_view_window_get_attachments:
 269  * @window: a #ModestMsgViewWindow
 270  *
 271  * Get selected attachments from #ModetMsgView private object.
 272  */
 273 TnyList *         modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
 274
 275 /**
 276  * modest_msg_view_window_save_attachments:
 277  * @window: a #ModestMsgViewWindow
 278  * @mime_parts: a #TnyList of #TnyMimePart
 279  *
 280  * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
 281  * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
 282  */
 283 void            modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
 284                                                          TnyList *mime_parts);
 285
 286 /**
 287  * modest_msg_view_window_remove_attachments:
 288  * @window: a #ModestMsgViewWindow
 289  * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
 290  * purges only selected ones.
 291  *
 292  * Removes selected attachments.
 293  */
 294 void            modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
 295                                                            gboolean get_all);
 296
 297
 298 /**
 299  * modest_msg_view_window_toolbar_on_transfer_mode:
 300  * @window: a #ModestMsgViewWindow
 301  *
 302  * Check if toolbar is in transfer mode, which determines whether a
 303  * transfer operation is being processed.
 304  */
 305 gboolean  modest_msg_view_window_toolbar_on_transfer_mode     (ModestMsgViewWindow *self);
 306
 307
 308 /**
 309  * modest_msg_view_window_last_message_selected:
 310  * @window: a #ModestMsgViewWindow
 311  *
 312  * Check message currently viewed is the last message into folder .
 313 */
 314 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
 315
 316
 317 /**
 318  * modest_msg_view_window_first_message_selected:
 319  * @window: a #ModestMsgViewWindow
 320  *
 321  * Check message currently viewed is the last message into folder .
 322 */
 323 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
 324
 325 /**
 326  * modest_msg_view_window_has_headers_model:
 327  * @window: a #ModestMsgViewWindow
 328  *
 329  * Check if window has been created with a full headers model.
 330 */
 331 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
 332
 333 /**
 334  * modest_msg_view_window_is_search_result:
 335  * @window: a #ModestMsgViewWindow
 336  *
 337  * Check if window has been created to show a search result.
 338  */
 339 gboolean modest_msg_view_window_is_search_result (ModestMsgViewWindow *window);
 340
 341
 342 /**
 343  * modest_msg_view_window_get_folder_type:
 344  * @window: a #ModestMsgViewWindow
 345  *
 346  * Gets folder type of message currently viewed .
 347 */
 348 TnyFolderType
 349 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
 350
 351 /**
 352  * modest_msg_view_window_transfer_mode_enabled:
 353  * @window: a #ModestMsgViewWindow
 354  *
 355  * Determines if some transfer operation is in progress.
 356  *
 357  * Returns: TRUE if transfer mode is enabled, FASE otherwise.
 358 */
 359 gboolean
 360 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
 361
 362 /**
 363  * modest_msg_view_window_add_to_contacts:
 364  * @self: a #ModestMsgViewWindow
 365  *
 366  * activates the add to contacts use case. In Diablo and gnome it gets the
 367  * clipboard selection current value and tries to add it to the addressbook.
 368  * In fremantle, it shows the add to contacts dialog to select the recipient
 369  * to add.
 370  */
 371 void
 372 modest_msg_view_window_add_to_contacts (ModestMsgViewWindow *self);
 373
 374 /**
 375  * modest_msg_view_window_get_msg_view:
 376  * @self: a #ModestMsgViewWindow
 377  *
 378  * Tells that external images should be fetched in this window.
 379  */
 380 void
 381 modest_msg_view_window_fetch_images (ModestMsgViewWindow *self);
 382
 383 /**
 384  * modest_msg_view_window_has_blocked_external_images:
 385  * @self: a #ModestMsgViewWindow
 386  *
 387  * checks if the msg currently shown has blocked external images.
 388  *
 389  * Returns: %TRUE if external images are blocked, %FALSE otherwise
 390  */
 391 gboolean modest_msg_view_window_has_blocked_external_images (ModestMsgViewWindow *self);
 392
 393 /**
 394  * modest_msg_view_window_reload:
 395  * @self: a #ModestMsgViewWindow
 396  *
 397  * Reloads currently loaded message. This is intended to show the message in case it
 398  * has some update on the previously visible result.
 399  */
 400 void modest_msg_view_window_reload (ModestMsgViewWindow *self);
 401
 402 G_END_DECLS
 403
 404 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */
 405