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         /* insert signal callback declarations, eg. */
  55         /* void (* my_event) (ModestEditMsgWindow* obj); */
  56 } ModestMsgViewWindowClass;
  57
  58 /**
  59  * modest_msg_view_window_get_type:
  60  *
  61  * get the GType for the #ModestMsgViewWindow class
  62  *
  63  * Returns: a GType for #ModestMsgViewWindow
  64  */
  65 GType        modest_msg_view_window_get_type    (void) G_GNUC_CONST;
  66
  67
  68 /**
  69  * modest_msg_view_window_new:
  70  * @msg: an #TnyMsg instance
  71  * @account: the account name
  72  *
  73  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
  74  * set the proper account when choosing reply/forward from the msg view window
  75  *
  76  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
  77  */
  78 ModestWindow*   modest_msg_view_window_new         (TnyMsg *msg,
  79                                                     const gchar *account,
  80                                                     const gchar *msg_uid);
  81
  82 /**
  83  * modest_msg_view_window_new_with_header_model:
  84  * @msg: an #TnyMsg instance
  85  * @account: the account name
  86  * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
  87  * @iter: a #GtkTreeIter, pointing to the position of @msg in @model.
  88  *
  89  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
  90  * set the proper account when choosing reply/forward from the msg view window.
  91  * This constructor also passes a reference to the @model of the header view
  92  * to allow selecting previous/next messages.
  93  *
  94  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
  95  */
  96 ModestWindow*   modest_msg_view_window_new_with_header_model (TnyMsg *msg,
  97                                                               const gchar *account,
  98                                                               const gchar *msg_uid,
  99                                                               GtkTreeModel *model,
 100                                                               GtkTreeRowReference *row_reference);
 101
 102
 103 /**
 104  * modest_msg_view_window_get_header:
 105  * @window: an #ModestMsgViewWindow instance
 106  *
 107  * get the message header in this msg view. Header instance is get
 108  * from tree_model of headers list.
 109  *
 110  * Returns: a new #TnyHeader instance, or NULL in case of error
 111  */
 112 TnyHeader*
 113 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
 114
 115 /**
 116  * modest_msg_view_window_get_message:
 117  * @window: an #ModestMsgViewWindow instance
 118  *
 119  * get a new reference to the message in this msg view. The caller
 120  * must free this new reference
 121  *
 122  * Returns: a new #TnyMsg instance, or NULL in case of error
 123  */
 124 TnyMsg*         modest_msg_view_window_get_message     (ModestMsgViewWindow *window);
 125
 126 /**
 127  * modest_msg_view_window_get_message_uid:
 128  * @msg: an #ModestMsgViewWindow instance
 129  *
 130  * gets the unique identifier for the message in this msg view. The
 131  * returned value *must* not be freed
 132  *
 133  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 134  */
 135 const gchar*    modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
 136
 137 /**
 138  * modest_msg_view_window_select_first_message:
 139  * @window: a #ModestMsgViewWindow instance
 140  *
 141  * select the first message obtained from the header view this view
 142  * was called from
 143  *
 144  * Returns: %TRUE if a new message is shown.
 145  */
 146 gboolean        modest_msg_view_window_select_first_message (ModestMsgViewWindow *window);
 147
 148 /**
 149  * modest_msg_view_window_select_next_message:
 150  * @window: a #ModestMsgViewWindow instance
 151  *
 152  * select the next message obtained from the header view this view
 153  * was called from
 154  *
 155  * Returns: %TRUE if a new message is shown.
 156  */
 157 gboolean        modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
 158
 159 /**
 160  * modest_msg_view_window_select_previous_message:
 161  * @window: a #ModestMsgViewWindow instance
 162  *
 163  * select the previous 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_previous_message (ModestMsgViewWindow *window);
 169
 170 /**
 171  * modest_msg_view_window_toggle_fullscreen:
 172  * @window: a #ModestMsgViewWindow
 173  *
 174  * toggles the current fullscreen status
 175  */
 176 void            modest_msg_view_window_toggle_fullscreen (ModestMsgViewWindow *window);
 177
 178 /**
 179  * modest_msg_view_window_view_attachment:
 180  * @window: a #ModestMsgViewWindow
 181  * @mime_part: a #TnyMimePart
 182  *
 183  * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
 184  * If it's a message, it opens it  for viewing. Otherwise it opens a temporary file
 185  * with the contents of the attachment.
 186  */
 187 void            modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
 188                                                         TnyMimePart *mime_part);
 189
 190 /**
 191  * modest_msg_view_window_get_attachments:
 192  * @window: a #ModestMsgViewWindow
 193  *
 194  * Get selected attachments from #ModetMsgView private object.
 195  */
 196 GList *         modest_msg_view_window_get_attachments (ModestMsgViewWindow *win);
 197
 198 /**
 199  * modest_msg_view_window_save_attachments:
 200  * @window: a #ModestMsgViewWindow
 201  * @mime_parts: a #GList of #TnyMimePart
 202  *
 203  * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
 204  * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
 205  */
 206 void            modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
 207                                                          GList *mime_parts);
 208
 209 /**
 210  * modest_msg_view_window_remove_attachments:
 211  * @window: a #ModestMsgViewWindow
 212  * @get_all: a #gboolean. If %TRUE, purges all attachmnents, if %FALSE,
 213  * purges only selected ones.
 214  *
 215  * Removes selected attachments.
 216  */
 217 void            modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
 218                                                            gboolean get_all);
 219
 220
 221 /**
 222  * modest_msg_view_window_toolbar_on_transfer_mode:
 223  * @window: a #ModestMsgViewWindow
 224  *
 225  * Check if toolbar is in transfer mode, which determines whether a
 226  * transfer operation is being processed.
 227  */
 228 gboolean  modest_msg_view_window_toolbar_on_transfer_mode     (ModestMsgViewWindow *self);
 229
 230
 231 /**
 232  * modest_msg_view_window_last_message_selected:
 233  * @window: a #ModestMsgViewWindow
 234  *
 235  * Check message currently viewed is the last message into folder .
 236 */
 237 gboolean modest_msg_view_window_last_message_selected (ModestMsgViewWindow *window);
 238
 239
 240 /**
 241  * modest_msg_view_window_first_message_selected:
 242  * @window: a #ModestMsgViewWindow
 243  *
 244  * Check message currently viewed is the last message into folder .
 245 */
 246 gboolean modest_msg_view_window_first_message_selected (ModestMsgViewWindow *window);
 247
 248 /**
 249  * modest_msg_view_window_has_headers_model:
 250  * @window: a #ModestMsgViewWindow
 251  *
 252  * Check if window has been created with a full headers model.
 253 */
 254 gboolean modest_msg_view_window_has_headers_model (ModestMsgViewWindow *window);
 255
 256 /**
 257  * modest_msg_view_window_get_folder_type:
 258  * @window: a #ModestMsgViewWindow
 259  *
 260  * Gets folder type of message currently viewed .
 261 */
 262 TnyFolderType
 263 modest_msg_view_window_get_folder_type (ModestMsgViewWindow *window);
 264
 265 /**
 266  * modest_msg_view_window_transfer_mode_enabled:
 267  * @window: a #ModestMsgViewWindow
 268  *
 269  * Determines if some transfer operation is in progress.
 270  *
 271  * Returns: TRUE if transfer mode is enabled, FASE otherwise.
 272 */
 273 gboolean
 274 modest_msg_view_window_transfer_mode_enabled (ModestMsgViewWindow *self);
 275
 276 G_END_DECLS
 277
 278 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */
 279