816b5e2a0ecc1d635a46176225f6666f3b4a7868
[WebKit-https.git] / WebKit / gtk / webkit / webkitwebview.h
1 /*
2  * Copyright (C) 2007 Holger Hans Peter Freyther
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef WEBKIT_WEB_VIEW_H
21 #define WEBKIT_WEB_VIEW_H
22
23 #include <gtk/gtk.h>
24 #include <JavaScriptCore/JSBase.h>
25
26 #include <webkit/webkitdefines.h>
27 #include <webkit/webkitwebbackforwardlist.h>
28 #include <webkit/webkitwebhistoryitem.h>
29 #include <webkit/webkitwebsettings.h>
30
31 G_BEGIN_DECLS
32
33 #define WEBKIT_TYPE_WEB_VIEW            (webkit_web_view_get_type())
34 #define WEBKIT_WEB_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebView))
35 #define WEBKIT_WEB_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
36 #define WEBKIT_IS_WEB_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_VIEW))
37 #define WEBKIT_IS_WEB_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_VIEW))
38 #define WEBKIT_WEB_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
39
40 typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
41
42 typedef enum {
43     WEBKIT_NAVIGATION_RESPONSE_ACCEPT,
44     WEBKIT_NAVIGATION_RESPONSE_IGNORE,
45     WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD
46 } WebKitNavigationResponse;
47
48 typedef enum
49 {
50     WEBKIT_WEB_VIEW_TARGET_INFO_HTML = - 1,
51     WEBKIT_WEB_VIEW_TARGET_INFO_TEXT = - 2
52 } WebKitWebViewTargetInfo;
53
54 struct _WebKitWebView {
55     GtkContainer parent_instance;
56
57     WebKitWebViewPrivate* priv;
58 };
59
60 struct _WebKitWebViewClass {
61     GtkContainerClass parent_class;
62
63     /*
64      * default handler/virtual methods
65      * DISCUSS: create_web_view needs a request and should we make this a signal with default handler? this would
66      * require someone doing a g_signal_stop_emission_by_name
67      * WebUIDelegate has nothing for create_frame, WebPolicyDelegate as well...
68      */
69     WebKitWebView*  (*create_web_view)  (WebKitWebView* web_view);
70
71     /*
72      * TODO: FIXME: Create something like WebPolicyDecisionListener_Protocol instead
73      */
74     WebKitNavigationResponse (*navigation_requested) (WebKitWebView* web_view, WebKitWebFrame* frame, WebKitNetworkRequest* request);
75
76     void (*window_object_cleared) (WebKitWebView* web_view, WebKitWebFrame* frame, JSGlobalContextRef context, JSObjectRef window_object);
77     gchar*   (*choose_file) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* old_file);
78     gboolean (*script_alert) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* alert_message);
79     gboolean (*script_confirm) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* confirm_message, gboolean* did_confirm);
80     gboolean (*script_prompt) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* message, const gchar* default_value, gchar** value);
81     gboolean (*console_message) (WebKitWebView* web_view, const gchar* message, unsigned int line_number, const gchar* source_id);
82     void (*select_all) (WebKitWebView* web_view);
83     void (*cut_clipboard) (WebKitWebView* web_view);
84     void (*copy_clipboard) (WebKitWebView* web_view);
85     void (*paste_clipboard) (WebKitWebView* web_view);
86
87     /*
88      * internal
89      */
90     void   (*set_scroll_adjustments) (WebKitWebView*, GtkAdjustment*, GtkAdjustment*);
91 };
92
93 WEBKIT_API GType
94 webkit_web_view_get_type (void);
95
96 WEBKIT_API GtkWidget*
97 webkit_web_view_new (void);
98
99 WEBKIT_API void
100 webkit_web_view_set_maintains_back_forward_list (WebKitWebView* web_view, gboolean flag);
101
102 WEBKIT_API WebKitWebBackForwardList*
103 webkit_web_view_get_back_forward_list (WebKitWebView* web_view);
104
105 WEBKIT_API gboolean
106 webkit_web_view_go_to_back_forward_item (WebKitWebView *web_view, WebKitWebHistoryItem* item);
107
108 WEBKIT_API gboolean
109 webkit_web_view_can_go_back (WebKitWebView* web_view);
110
111 WEBKIT_API gboolean
112 webkit_web_view_can_go_back_or_forward (WebKitWebView* web_view, gint steps);
113
114 WEBKIT_API gboolean
115 webkit_web_view_can_go_forward (WebKitWebView* web_view);
116
117 WEBKIT_API void
118 webkit_web_view_go_back (WebKitWebView* web_view);
119
120 WEBKIT_API void
121 webkit_web_view_go_back_or_forward (WebKitWebView* web_view, gint steps);
122
123 WEBKIT_API void
124 webkit_web_view_go_forward (WebKitWebView* web_view);
125
126 WEBKIT_API void
127 webkit_web_view_stop_loading (WebKitWebView* web_view);
128
129 WEBKIT_API void
130 webkit_web_view_open (WebKitWebView* web_view, const gchar* uri);
131
132 WEBKIT_API void
133 webkit_web_view_reload (WebKitWebView *web_view);
134
135 WEBKIT_API void
136 webkit_web_view_load_string (WebKitWebView* web_view, const gchar* content, const gchar* content_mime_type, const gchar* content_encoding, const gchar* base_uri);
137
138 WEBKIT_API void
139 webkit_web_view_load_html_string (WebKitWebView* web_view, const gchar* content, const gchar* base_uri);
140
141 WEBKIT_API gboolean
142 webkit_web_view_search_text (WebKitWebView* web_view, const gchar* string, gboolean case_sensitive, gboolean forward, gboolean wrap);
143
144 WEBKIT_API guint
145 webkit_web_view_mark_text_matches (WebKitWebView* web_view, const gchar* string, gboolean case_sensitive, guint limit);
146
147 WEBKIT_API void
148 webkit_web_view_set_highlight_text_matches (WebKitWebView* web_view, gboolean highlight);
149
150 WEBKIT_API void
151 webkit_web_view_unmark_text_matches (WebKitWebView* web_view);
152
153 WEBKIT_API WebKitWebFrame*
154 webkit_web_view_get_main_frame (WebKitWebView* web_view);
155
156 WEBKIT_API void
157 webkit_web_view_execute_script (WebKitWebView* web_view, const gchar* script);
158
159 WEBKIT_API gboolean
160 webkit_web_view_can_cut_clipboard (WebKitWebView* web_view);
161
162 WEBKIT_API gboolean
163 webkit_web_view_can_copy_clipboard (WebKitWebView* web_view);
164
165 WEBKIT_API gboolean
166 webkit_web_view_can_paste_clipboard (WebKitWebView* web_view);
167
168 WEBKIT_API void
169 webkit_web_view_cut_clipboard (WebKitWebView* web_view);
170
171 WEBKIT_API void
172 webkit_web_view_copy_clipboard (WebKitWebView* web_view);
173
174 WEBKIT_API void
175 webkit_web_view_paste_clipboard (WebKitWebView* web_view);
176
177 WEBKIT_API void
178 webkit_web_view_delete_selection (WebKitWebView* web_view);
179
180 WEBKIT_API gboolean
181 webkit_web_view_has_selection (WebKitWebView* web_view);
182
183 WEBKIT_API void
184 webkit_web_view_select_all (WebKitWebView* web_view);
185
186 WEBKIT_API gboolean
187 webkit_web_view_get_editable (WebKitWebView* web_view);
188
189 WEBKIT_API void
190 webkit_web_view_set_editable (WebKitWebView* web_view, gboolean flag);
191
192 WEBKIT_API GtkTargetList*
193 webkit_web_view_get_copy_target_list (WebKitWebView* web_view);
194
195 WEBKIT_API GtkTargetList*
196 webkit_web_view_get_paste_target_list (WebKitWebView* web_view);
197
198 WEBKIT_API void
199 webkit_web_view_set_settings (WebKitWebView* web_view, WebKitWebSettings* settings);
200
201 WEBKIT_API WebKitWebSettings*
202 webkit_web_view_get_settings (WebKitWebView* web_view);
203
204 WEBKIT_OBSOLETE_API gboolean
205 webkit_web_view_can_go_backward (WebKitWebView* web_view);
206
207 WEBKIT_OBSOLETE_API void
208 webkit_web_view_go_backward (WebKitWebView* web_view);
209
210 G_END_DECLS
211
212 #endif