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, const gchar *account);
  79
  80 /**
  81  * modest_msg_view_window_new_with_header_model:
  82  * @msg: an #TnyMsg instance
  83  * @account: the account name
  84  * @model: a #GtkTreeModel, with the format used by #ModestHeaderView
  85  * @iter: a #GtkTreeIter, pointing to the position of @msg in @model.
  86  *
  87  * instantiates a new #ModestMsgViewWindow widget. The account name is used to
  88  * set the proper account when choosing reply/forward from the msg view window.
  89  * This constructor also passes a reference to the @model of the header view
  90  * to allow selecting previous/next messages.
  91  *
  92  * Returns: a new #ModestMsgViewWindow, or NULL in case of error
  93  */
  94 ModestWindow*   modest_msg_view_window_new_with_header_model (TnyMsg *msg,
  95                                                               const gchar *account,
  96                                                               GtkTreeModel *model,
  97                                                               GtkTreeRowReference *row_reference);
  98
  99
 100 /**
 101  * modest_msg_view_window_get_header:
 102  * @window: an #ModestMsgViewWindow instance
 103  *
 104  * get the message header in this msg view. Header instance is get
 105  * from tree_model of headers list.
 106  *
 107  * Returns: a new #TnyHeader instance, or NULL in case of error
 108  */
 109 TnyHeader*
 110 modest_msg_view_window_get_header (ModestMsgViewWindow *self);
 111
 112 /**
 113  * modest_msg_view_window_get_message:
 114  * @window: an #ModestMsgViewWindow instance
 115  *
 116  * get a new reference to the message in this msg view. The caller
 117  * must free this new reference
 118  *
 119  * Returns: a new #TnyMsg instance, or NULL in case of error
 120  */
 121 TnyMsg*         modest_msg_view_window_get_message     (ModestMsgViewWindow *window);
 122
 123 /**
 124  * modest_msg_view_window_get_message_uid:
 125  * @msg: an #ModestMsgViewWindow instance
 126  *
 127  * gets the unique identifier for the message in this msg view. The
 128  * returned value *must* not be freed
 129  *
 130  * Returns: the id of the #TnyMsg being shown, or NULL in case of error
 131  */
 132 const gchar*    modest_msg_view_window_get_message_uid (ModestMsgViewWindow *window);
 133
 134 /**
 135  * modest_msg_view_window_select_first_message:
 136  * @window: a #ModestMsgViewWindow instance
 137  *
 138  * select the first message obtained from the header view this view
 139  * was called from
 140  *
 141  * Returns: %TRUE if a new message is shown.
 142  */
 143 gboolean        modest_msg_view_window_select_first_message (ModestMsgViewWindow *window);
 144
 145 /**
 146  * modest_msg_view_window_select_next_message:
 147  * @window: a #ModestMsgViewWindow instance
 148  *
 149  * select the next message obtained from the header view this view
 150  * was called from
 151  *
 152  * Returns: %TRUE if a new message is shown.
 153  */
 154 gboolean        modest_msg_view_window_select_next_message (ModestMsgViewWindow *window);
 155
 156 /**
 157  * modest_msg_view_window_select_previous_message:
 158  * @window: a #ModestMsgViewWindow instance
 159  *
 160  * select the previous message obtained from the header view this view
 161  * was called from
 162  *
 163  * Returns: %TRUE if a new message is shown.
 164  */
 165 gboolean        modest_msg_view_window_select_previous_message (ModestMsgViewWindow *window);
 166
 167 /**
 168  * modest_msg_view_window_toggle_fullscreen:
 169  * @window: a #ModestMsgViewWindow
 170  *
 171  * toggles the current fullscreen status
 172  */
 173 void            modest_msg_view_window_toggle_fullscreen (ModestMsgViewWindow *window);
 174
 175 /**
 176  * modest_msg_view_window_view_attachment:
 177  * @window: a #ModestMsgViewWindow
 178  * @mime_part: a #TnyMimePart
 179  *
 180  * Opens @mime_part, or the currently selected attachment if @mime_part is %NULL.
 181  * If it's a message, it opens it  for viewing. Otherwise it opens a temporary file
 182  * with the contents of the attachment.
 183  */
 184 void            modest_msg_view_window_view_attachment (ModestMsgViewWindow *window,
 185                                                         TnyMimePart *mime_part);
 186
 187 /**
 188  * modest_msg_view_window_save_attachments:
 189  * @window: a #ModestMsgViewWindow
 190  * @mime_parts: a #GList of #TnyMimePart
 191  *
 192  * Save the #TnyMimePart attachments in @mime_parts, or currently selected attachments
 193  * if @mime_parts is %NULL, offering a dialog to the user to choose the location.
 194  */
 195 void            modest_msg_view_window_save_attachments (ModestMsgViewWindow *window,
 196                                                          GList *mime_parts);
 197
 198 /**
 199  * modest_msg_view_window_remove_attachments:
 200  * @window: a #ModestMsgViewWindow
 201  * @mime_parts: a #GList of #TnyMimePart
 202  *
 203  * Removes the attachments in @mime_parts, or currently selected attachments
 204  * if @mime_parts is %NULL, from local storage.
 205  */
 206 void            modest_msg_view_window_remove_attachments (ModestMsgViewWindow *window,
 207                                                            GList *mime_parts);
 208
 209 G_END_DECLS
 210
 211 #endif /* __MODEST_MSG_VIEW_WINDOW_H__ */
 212