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

   1 /* Copyright (c) 2006, 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_H__
  31 #define __MODEST_MSG_VIEW_H__
  32
  33 #include <tny-stream.h>
  34 #include <tny-msg.h>
  35 #include <tny-mime-part.h>
  36 #include <tny-msg-view.h>
  37 #include <widgets/modest-recpt-view.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_MSG_VIEW             (modest_msg_view_get_type())
  43 #define MODEST_MSG_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW,ModestMsgView))
  44 #define MODEST_MSG_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
  45 #define MODEST_IS_MSG_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW))
  46 #define MODEST_IS_MSG_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_VIEW))
  47 #define MODEST_MSG_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
  48
  49 typedef struct _ModestMsgView      ModestMsgView;
  50 typedef struct _ModestMsgViewClass ModestMsgViewClass;
  51
  52 struct _ModestMsgView {
  53         GtkContainer parent;
  54 };
  55
  56 struct _ModestMsgViewClass {
  57         GtkContainerClass parent_class;
  58
  59         void (*set_scroll_adjustments)      (ModestMsgView *msg_view,
  60                                              GtkAdjustment *hadj,
  61                                              GtkAdjustment *vadj);
  62
  63         void (*link_hover)         (ModestMsgView *msgview, const gchar* link,
  64                                     gpointer user_data);
  65         void (*link_clicked)       (ModestMsgView *msgview, const gchar* link,
  66                                     gpointer user_data);
  67         void (*link_contextual)    (ModestMsgView *msgview, const gchar* link,
  68                                     gpointer user_data);
  69         void (*attachment_clicked) (ModestMsgView *msgview, TnyMimePart *mime_part,
  70                                     gpointer user_data);
  71         void (*recpt_activated)    (ModestMsgView *msgview, const gchar *address,
  72                                     gpointer user_data);
  73 };
  74
  75
  76 /**
  77  *
  78  * modest_msg_view_get_type
  79  *
  80  * get the GType for the this class
  81  *
  82  * Returns: the GType for this class
  83  */
  84 GType        modest_msg_view_get_type    (void) G_GNUC_CONST;
  85
  86
  87 /**
  88  * modest_msg_view_new
  89  * @tny_msg: a TnyMsg instance, or NULL
  90  *
  91  * create a new ModestMsgView widget (a GtkScrolledWindow subclass),
  92  * and display the @tny_msg e-mail message in it. If @tny_msg is NULL,
  93  * then a blank page will be displayed
  94  *
  95  * Returns: a new ModestMsgView widget, or NULL if there's an error
  96  */
  97 GtkWidget*   modest_msg_view_new          (TnyMsg *tny_msg);
  98
  99
 100 /**
 101  * modest_msg_view_set_message
 102  * @self: a ModestMsgView instance
 103  * @tny_msg: a TnyMsg instance, or NULL
 104  *
 105  * display the @tny_msg e-mail message. If @tny_msg is NULL,
 106  * then a blank page will be displayed
 107  *  */
 108 void         modest_msg_view_set_message  (ModestMsgView *self, TnyMsg *tny_msg);
 109
 110
 111
 112 /**
 113  * modest_msg_view_set_message
 114  * @self: a ModestMsgView instance
 115  *
 116  * gets a new reference the #TnyMsg of the message view. The caller
 117  * must free the new reference
 118  *
 119  * Returns: the message or NULL
 120  */
 121 TnyMsg*      modest_msg_view_get_message  (ModestMsgView *self);
 122
 123 GtkAdjustment *modest_msg_view_get_vadjustment (ModestMsgView *self);
 124 GtkAdjustment *modest_msg_view_get_hadjustment (ModestMsgView *self);
 125 void modest_msg_view_set_vadjustment (ModestMsgView *self, GtkAdjustment *vadj);
 126 void modest_msg_view_set_hadjustment (ModestMsgView *self, GtkAdjustment *hadj);
 127 void modest_msg_view_set_shadow_type (ModestMsgView *self, GtkShadowType type);
 128 GtkShadowType modest_msg_view_get_shadow_type (ModestMsgView *self);
 129
 130 gboolean modest_msg_view_search (ModestMsgView *self, const gchar *search);
 131 gboolean modest_msg_view_search_next (ModestMsgView *self);
 132 void modest_msg_view_set_zoom (ModestMsgView *self, gdouble zoom);
 133 gdouble modest_msg_view_get_zoom (ModestMsgView *self);
 134 TnyHeaderFlags modest_msg_view_get_priority (ModestMsgView *self);
 135 void modest_msg_view_set_priority (ModestMsgView *self, TnyHeaderFlags flags);
 136 GList *modest_msg_view_get_selected_attachments (ModestMsgView *self);
 137 void modest_msg_view_grab_focus (ModestMsgView *self);
 138 void modest_msg_view_remove_attachment (ModestMsgView *view, TnyMimePart *attachment);
 139
 140
 141 G_END_DECLS
 142
 143 #endif /* __MODEST_MSG_VIEW_H__ */