aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-web-view-preview.h
blob: 00239fea1df2dcd328e58f922e79bbaa7526a3e3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
 * e-web-view-preview.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 widget for previews before import.
 * It contains a GtkTreeView at the top and an EWebView at the bottom.
 * The tree view is not shown initially, it should be forced with
 * e_web_view_preview_show_tree_view().
 *
 * The internal default EWebView can be accessed by e_web_view_preview_get_preview()
 * and it should be updated for each change of the selected item in the tree
 * view, when it's shown.
 *
 * Updating an EWebView content through helper functions of an EWebViewPreview
 * begins with call of e_web_view_preview_begin_update(), which starts an empty
 * page construction, which is finished by e_web_view_preview_end_update(),
 * and the content of the EWebView is updated.
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef E_WEB_VIEW_PREVIEW_H
#define E_WEB_VIEW_PREVIEW_H

#include <e-util/e-web-view.h>

/* Standard GObject macros */
#define E_TYPE_WEB_VIEW_PREVIEW \
    (e_web_view_preview_get_type ())
#define E_WEB_VIEW_PREVIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_WEB_VIEW_PREVIEW, EWebViewPreview))
#define E_WEB_VIEW_PREVIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_WEB_VIEW_PREVIEW, EWebViewPreviewClass))
#define E_IS_WEB_VIEW_PREVIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_WEB_VIEW_PREVIEW))
#define E_IS_WEB_VIEW_PREVIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_WEB_VIEW_PREVIEW))
#define E_WEB_VIEW_PREVIEW_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_WEB_VIEW_PREVIEW, EWebViewPreviewClass))

G_BEGIN_DECLS

typedef struct _EWebViewPreview EWebViewPreview;
typedef struct _EWebViewPreviewClass EWebViewPreviewClass;
typedef struct _EWebViewPreviewPrivate EWebViewPreviewPrivate;

struct _EWebViewPreview {
    GtkVPaned parent;
    EWebViewPreviewPrivate *priv;
};

struct _EWebViewPreviewClass {
    GtkVPanedClass parent_class;
};

GType       e_web_view_preview_get_type (void) G_GNUC_CONST;
GtkWidget * e_web_view_preview_new      (void);
GtkTreeView *   e_web_view_preview_get_tree_view
                        (EWebViewPreview *preview);
GtkWidget * e_web_view_preview_get_preview  (EWebViewPreview *preview);
void        e_web_view_preview_set_preview  (EWebViewPreview *preview,
                         GtkWidget *preview_widget);
void        e_web_view_preview_show_tree_view
                        (EWebViewPreview *preview);
void        e_web_view_preview_hide_tree_view
                        (EWebViewPreview *preview);
gboolean    e_web_view_preview_get_escape_values
                        (EWebViewPreview *preview);
void        e_web_view_preview_set_escape_values
                        (EWebViewPreview *preview,
                         gboolean escape);
void        e_web_view_preview_begin_update (EWebViewPreview *preview);
void        e_web_view_preview_end_update   (EWebViewPreview *preview);
void        e_web_view_preview_add_header   (EWebViewPreview *preview,
                         gint index,
                         const gchar *header);
void        e_web_view_preview_add_text (EWebViewPreview *preview,
                         const gchar *text);
void        e_web_view_preview_add_raw_html (EWebViewPreview *preview,
                         const gchar *raw_html);
void        e_web_view_preview_add_separator
                        (EWebViewPreview *preview);
void        e_web_view_preview_add_empty_line
                        (EWebViewPreview *preview);
void        e_web_view_preview_add_section  (EWebViewPreview *preview,
                         const gchar *section,
                         const gchar *value);

G_END_DECLS

#endif /* E_WEB_VIEW_PREVIEW_H */