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 #include <widgets/modest-zoomable.h>
  39
  40 G_BEGIN_DECLS
  41
  42 /* convenience macros */
  43 #define MODEST_TYPE_MSG_VIEW             (modest_msg_view_get_type())
  44 #define MODEST_MSG_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW,ModestMsgView))
  45 #define MODEST_MSG_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
  46 #define MODEST_IS_MSG_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW))
  47 #define MODEST_IS_MSG_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_VIEW))
  48 #define MODEST_MSG_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
  49
  50 typedef struct _ModestMsgView      ModestMsgView;
  51 typedef struct _ModestMsgViewClass ModestMsgViewClass;
  52
  53 struct _ModestMsgView {
  54         GtkContainer parent;
  55 };
  56
  57 struct _ModestMsgViewClass {
  58         GtkContainerClass parent_class;
  59
  60         /* TnyMimePartView interface */
  61         TnyMimePart* (*get_part_func) (TnyMimePartView *self);
  62         void (*set_part_func) (TnyMimePartView *self, TnyMimePart *part);
  63         /* TnyMsgView interface */
  64         TnyMsg* (*get_msg_func) (TnyMsgView *self);
  65         void (*set_msg_func) (TnyMsgView *self, TnyMsg *msg);
  66         void (*set_unavailable_func) (TnyMsgView *self);
  67         void (*clear_func) (TnyMsgView *self);
  68         TnyMimePartView* (*create_mime_part_view_for_func) (TnyMsgView *self, TnyMimePart *part);
  69         TnyMsgView* (*create_new_inline_viewer_func) (TnyMsgView *self);
  70         /* ModestZoomable interface */
  71         gdouble (*get_zoom_func) (ModestZoomable *self);
  72         void (*set_zoom_func) (ModestZoomable *self, gdouble value);
  73         gboolean (*zoom_minus_func) (ModestZoomable *self);
  74         gboolean (*zoom_plus_func) (ModestZoomable *self);
  75
  76         /* signals */
  77         void (*set_scroll_adjustments)      (ModestMsgView *msg_view,
  78                                              GtkAdjustment *hadj,
  79                                              GtkAdjustment *vadj);
  80
  81         void (*link_hover)         (ModestMsgView *msgview, const gchar* link,
  82                                     gpointer user_data);
  83         void (*link_clicked)       (ModestMsgView *msgview, const gchar* link,
  84                                     gpointer user_data);
  85         void (*link_contextual)    (ModestMsgView *msgview, const gchar* link,
  86                                     gpointer user_data);
  87         void (*attachment_clicked) (ModestMsgView *msgview, TnyMimePart *mime_part,
  88                                     gpointer user_data);
  89         void (*recpt_activated)    (ModestMsgView *msgview, const gchar *address,
  90                                     gpointer user_data);
  91 };
  92
  93
  94 /**
  95  *
  96  * modest_msg_view_get_type
  97  *
  98  * get the GType for the this class
  99  *
 100  * Returns: the GType for this class
 101  */
 102 GType        modest_msg_view_get_type    (void) G_GNUC_CONST;
 103
 104
 105 /**
 106  * modest_msg_view_new
 107  * @tny_msg: a TnyMsg instance, or NULL
 108  *
 109  * create a new ModestMsgView widget (a GtkScrolledWindow subclass),
 110  * and display the @tny_msg e-mail message in it. If @tny_msg is NULL,
 111  * then a blank page will be displayed
 112  *
 113  * Returns: a new ModestMsgView widget, or NULL if there's an error
 114  */
 115 GtkWidget*   modest_msg_view_new          (TnyMsg *tny_msg);
 116
 117
 118
 119 /**
 120  * modest_msg_view_get_message_is_empty
 121  * @self: a ModestMsgView instance
 122  *
 123  * Returns whether the message contains any visbible (searchable) text.
 124  * For instance, this will return FALSE if the message contains only markup.
 125  *
 126  * Returns: TRUE if the message contains visible text.
 127  */
 128 gboolean modest_msg_view_get_message_is_empty (ModestMsgView *self);
 129
 130 GtkAdjustment *modest_msg_view_get_vadjustment (ModestMsgView *self);
 131 GtkAdjustment *modest_msg_view_get_hadjustment (ModestMsgView *self);
 132 void modest_msg_view_set_vadjustment (ModestMsgView *self, GtkAdjustment *vadj);
 133 void modest_msg_view_set_hadjustment (ModestMsgView *self, GtkAdjustment *hadj);
 134 void modest_msg_view_set_shadow_type (ModestMsgView *self, GtkShadowType type);
 135 GtkShadowType modest_msg_view_get_shadow_type (ModestMsgView *self);
 136
 137 gboolean modest_msg_view_search (ModestMsgView *self, const gchar *search);
 138 gboolean modest_msg_view_search_next (ModestMsgView *self);
 139 TnyHeaderFlags modest_msg_view_get_priority (ModestMsgView *self);
 140 void modest_msg_view_set_priority (ModestMsgView *self, TnyHeaderFlags flags);
 141 GList *modest_msg_view_get_selected_attachments (ModestMsgView *self);
 142 GList *modest_msg_view_get_attachments (ModestMsgView *self);
 143 void modest_msg_view_grab_focus (ModestMsgView *self);
 144 void modest_msg_view_remove_attachment (ModestMsgView *view, TnyMimePart *attachment);
 145
 146
 147 G_END_DECLS
 148
 149 #endif /* __MODEST_MSG_VIEW_H__ */