aboutsummaryrefslogblamecommitdiffstats
path: root/widgets/misc/e-web-view.h
blob: f7ffefe9354c0339fae5f127fdb79eecf2ebfd42 (plain) (tree)






































































                                                                             




                                                                    

                                                                           

                     


                                                                     



















                                                                              
                                                                     







                                                                                


                                                                     








                                                                           


                                                                            


                                                                        

                                                                     





                                                                           






                                                                           
                                                                     
                                                                     
                                                                     
                                                                     

                                                                     

                                                                     


                                                                     













                                                                              
/*
 * e-web-view.h
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

/* This is intended to serve as a common base class for all HTML viewing
 * needs in Evolution.  Currently based on GtkHTML, the idea is to wrap
 * the GtkHTML API enough that we no longer have to make direct calls to
 * it.  This should help smooth the transition to WebKit/GTK+.
 *
 * This class handles basic tasks like mouse hovers over links, clicked
 * links, and servicing URI requests asynchronously via GIO. */

#ifndef E_WEB_VIEW_H
#define E_WEB_VIEW_H

#include <gtkhtml/gtkhtml.h>

/* Standard GObject macros */
#define E_TYPE_WEB_VIEW \
    (e_web_view_get_type ())
#define E_WEB_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_WEB_VIEW, EWebView))
#define E_WEB_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_WEB_VIEW, EWebViewClass))
#define E_IS_WEB_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_WEB_VIEW))
#define E_IS_WEB_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_WEB_VIEW))
#define E_WEB_VIEW_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_WEB_VIEW, EWebViewClass))

G_BEGIN_DECLS

typedef struct _EWebView EWebView;
typedef struct _EWebViewClass EWebViewClass;
typedef struct _EWebViewPrivate EWebViewPrivate;

struct _EWebView {
    GtkHTML parent;
    EWebViewPrivate *priv;
};

struct _EWebViewClass {
    GtkHTMLClass parent_class;

    /* Methods */
    gchar *     (*extract_uri)      (EWebView *web_view,
                         GdkEventButton *event,
                         GtkHTML *frame);
    void        (*hovering_over_link)   (EWebView *web_view,
                         const gchar *title,
                         const gchar *uri);
    void        (*link_clicked)     (EWebView *web_view,
                         const gchar *uri);
    void        (*load_string)      (EWebView *web_view,
                         const gchar *load_string);

    /* Signals */
    void        (*copy_clipboard)   (EWebView *web_view);
    void        (*cut_clipboard)    (EWebView *web_view);
    void        (*paste_clipboard)  (EWebView *web_view);
    gboolean    (*popup_event)      (EWebView *web_view,
                         GdkEventButton *event,
                         const gchar *uri);
    void        (*status_message)   (EWebView *web_view,
                         const gchar *status_message);
    void        (*stop_loading)     (EWebView *web_view);
    void        (*update_actions)   (EWebView *web_view);
};

GType       e_web_view_get_type     (void);
GtkWidget * e_web_view_new          (void);
void        e_web_view_clear        (EWebView *web_view);
void        e_web_view_load_string      (EWebView *web_view,
                         const gchar *string);
gboolean    e_web_view_get_animate      (EWebView *web_view);
void        e_web_view_set_animate      (EWebView *web_view,
                         gboolean animate);
gboolean    e_web_view_get_caret_mode   (EWebView *web_view);
void        e_web_view_set_caret_mode   (EWebView *web_view,
                         gboolean caret_mode);
GtkTargetList * e_web_view_get_copy_target_list (EWebView *web_view);
gboolean    e_web_view_get_disable_printing (EWebView *web_view);
void        e_web_view_set_disable_printing (EWebView *web_view,
                         gboolean disable_printing);
gboolean    e_web_view_get_disable_save_to_disk
                        (EWebView *web_view);
void        e_web_view_set_disable_save_to_disk
                        (EWebView *web_view,
                         gboolean disable_save_to_disk);
gboolean    e_web_view_get_editable     (EWebView *web_view);
void        e_web_view_set_editable     (EWebView *web_view,
                         gboolean editable);
gboolean    e_web_view_get_inline_spelling  (EWebView *web_view);
void        e_web_view_set_inline_spelling  (EWebView *web_view,
                         gboolean inline_spelling);
gboolean    e_web_view_get_magic_links  (EWebView *web_view);
void        e_web_view_set_magic_links  (EWebView *web_view,
                         gboolean magic_links);
gboolean    e_web_view_get_magic_smileys    (EWebView *web_view);
void        e_web_view_set_magic_smileys    (EWebView *web_view,
                         gboolean magic_smileys);
const gchar *   e_web_view_get_selected_uri (EWebView *web_view);
void        e_web_view_set_selected_uri (EWebView *web_view,
                         const gchar *selected_uri);
GtkAction * e_web_view_get_open_proxy   (EWebView *web_view);
void        e_web_view_set_open_proxy   (EWebView *web_view,
                         GtkAction *open_proxy);
GtkTargetList * e_web_view_get_paste_target_list
                        (EWebView *web_view);
GtkAction * e_web_view_get_print_proxy  (EWebView *web_view);
void        e_web_view_set_print_proxy  (EWebView *web_view,
                         GtkAction *print_proxy);
GtkAction * e_web_view_get_save_as_proxy    (EWebView *web_view);
void        e_web_view_set_save_as_proxy    (EWebView *web_view,
                         GtkAction *save_as_proxy);
GtkAction * e_web_view_get_action       (EWebView *web_view,
                         const gchar *action_name);
GtkActionGroup *e_web_view_get_action_group (EWebView *web_view,
                         const gchar *group_name);
gchar *     e_web_view_extract_uri      (EWebView *web_view,
                         GdkEventButton *event,
                         GtkHTML *frame);
void        e_web_view_copy_clipboard   (EWebView *web_view);
void        e_web_view_cut_clipboard    (EWebView *web_view);
gboolean    e_web_view_is_selection_active  (EWebView *web_view);
void        e_web_view_paste_clipboard  (EWebView *web_view);
gboolean    e_web_view_scroll_forward   (EWebView *web_view);
gboolean    e_web_view_scroll_backward  (EWebView *web_view);
void        e_web_view_select_all       (EWebView *web_view);
void        e_web_view_unselect_all     (EWebView *web_view);
void        e_web_view_zoom_100     (EWebView *web_view);
void        e_web_view_zoom_in      (EWebView *web_view);
void        e_web_view_zoom_out     (EWebView *web_view);
GtkUIManager *  e_web_view_get_ui_manager   (EWebView *web_view);
GtkWidget * e_web_view_get_popup_menu   (EWebView *web_view);
void        e_web_view_show_popup_menu  (EWebView *web_view,
                         GdkEventButton *event,
                         GtkMenuPositionFunc func,
                         gpointer user_data);
void        e_web_view_status_message   (EWebView *web_view,
                         const gchar *status_message);
void        e_web_view_stop_loading     (EWebView *web_view);
void        e_web_view_update_actions   (EWebView *web_view);

G_END_DECLS

#endif /* E_WEB_VIEW_H */