git.maemo.org Git - modest/blob - src/widgets/modest-gtkhtml-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_GTKHTML_MSG_VIEW_H__
  31 #define __MODEST_GTKHTML_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-zoomable.h>
  38 #include <widgets/modest-isearch-view.h>
  39 #include <widgets/modest-mime-part-view.h>
  40 #include <widgets/modest-msg-view.h>
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_GTKHTML_MSG_VIEW             (modest_gtkhtml_msg_view_get_type())
  46 #define MODEST_GTKHTML_MSG_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_GTKHTML_MSG_VIEW,ModestGtkhtmlMsgView))
  47 #define MODEST_GTKHTML_MSG_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_GTKHTML_MSG_VIEW,ModestGtkhtmlMsgViewClass))
  48 #define MODEST_IS_GTKHTML_MSG_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_GTKHTML_MSG_VIEW))
  49 #define MODEST_IS_GTKHTML_MSG_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_GTKHTML_MSG_VIEW))
  50 #define MODEST_GTKHTML_MSG_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_GTKHTML_MSG_VIEW,ModestGtkhtmlMsgViewClass))
  51
  52 typedef struct _ModestGtkhtmlMsgView      ModestGtkhtmlMsgView;
  53 typedef struct _ModestGtkhtmlMsgViewClass ModestGtkhtmlMsgViewClass;
  54
  55 struct _ModestGtkhtmlMsgView {
  56         GtkContainer parent;
  57 };
  58
  59 struct _ModestGtkhtmlMsgViewClass {
  60         GtkContainerClass parent_class;
  61
  62         /* TnyHeaderView interface */
  63         void (*set_header_func) (TnyHeaderView *self, TnyHeader *header);
  64         void (*clear_header_func) (TnyHeaderView *self);
  65         /* TnyMimePartView interface */
  66         TnyMimePart* (*get_part_func) (TnyMimePartView *self);
  67         void (*set_part_func) (TnyMimePartView *self, TnyMimePart *part);
  68         /* ModestMimePartView interface methods */
  69         gboolean (*is_empty_func) (ModestMimePartView *self);
  70         /* TnyMsgView interface */
  71         TnyMsg* (*get_msg_func) (TnyMsgView *self);
  72         void (*set_msg_func) (TnyMsgView *self, TnyMsg *msg);
  73         void (*set_unavailable_func) (TnyMsgView *self);
  74         void (*clear_func) (TnyMsgView *self);
  75         TnyMimePartView* (*create_mime_part_view_for_func) (TnyMsgView *self, TnyMimePart *part);
  76         TnyMsgView* (*create_new_inline_viewer_func) (TnyMsgView *self);
  77         /* ModestZoomable interface */
  78         gdouble (*get_zoom_func) (ModestZoomable *self);
  79         void (*set_zoom_func) (ModestZoomable *self, gdouble value);
  80         gboolean (*zoom_minus_func) (ModestZoomable *self);
  81         gboolean (*zoom_plus_func) (ModestZoomable *self);
  82         /* ModestISearchView interface methods */
  83         gboolean (*search_func)             (ModestISearchView *self, const gchar *string);
  84         gboolean (*search_next_func)        (ModestISearchView *self);
  85         /* ModestMsgView interface methods */
  86         GtkAdjustment* (*get_vadjustment_func) (ModestMsgView *self);
  87         GtkAdjustment* (*get_hadjustment_func) (ModestMsgView *self);
  88         void (*set_vadjustment_func) (ModestMsgView *self, GtkAdjustment *vadj);
  89         void (*set_hadjustment_func) (ModestMsgView *self, GtkAdjustment *vadj);
  90         void (*set_shadow_type_func) (ModestMsgView *self, GtkShadowType type);
  91         GtkShadowType (*get_shadow_type_func) (ModestMsgView *self);
  92         TnyHeaderFlags (*get_priority_func) (ModestMsgView *self);
  93         void (*set_priority_func) (ModestMsgView *self, TnyHeaderFlags flags);
  94         TnyList * (*get_selected_attachments_func) (ModestMsgView *self);
  95         TnyList * (*get_attachments_func) (ModestMsgView *self);
  96         void (*grab_focus_func) (ModestMsgView *self);
  97         void (*remove_attachment_func) (ModestMsgView *view, TnyMimePart *attachment);
  98         void (*request_fetch_images_func) (ModestMsgView *view);
  99         gboolean (*has_blocked_external_images_func) (ModestMsgView *view);
 100
 101         void (*set_scroll_adjustments) (ModestGtkhtmlMsgView *msg_view, GtkAdjustment *hadj, GtkAdjustment *vadj);
 102 };
 103
 104
 105 /**
 106  * modest_gtkhtml_msg_view_get_type:
 107  *
 108  * get the GType for the this class
 109  *
 110  * Returns: the GType for this class
 111  */
 112 GType        modest_gtkhtml_msg_view_get_type    (void) G_GNUC_CONST;
 113
 114
 115 /**
 116  * modest_gtkhtml_msg_view_new
 117  * @tny_msg: a TnyMsg instance, or NULL
 118  *
 119  * create a new ModestGtkhtmlMsgView widget,
 120  * and display the @tny_msg e-mail message in it. If @tny_msg is NULL,
 121  * then a blank page will be displayed
 122  *
 123  * Returns: a new ModestGtkhtmlMsgView widget, or NULL if there's an error
 124  */
 125 GtkWidget*   modest_gtkhtml_msg_view_new          (TnyMsg *tny_msg);
 126
 127 G_END_DECLS
 128
 129 #endif /* __MODEST_GTKHTML_MSG_VIEW_H__ */