1/*
2 * Copyright (C) 2007 Holger Hans Peter Freyther
3 * Copyright (C) 2007, 2008 Alp Toker <alp@atoker.com>
4 * Copyright (C) 2008 Collabora Ltd.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public License
17 * along with this library; see the file COPYING.LIB.  If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef webkitwebview_h
23#define webkitwebview_h
24
25#include <gtk/gtk.h>
26#include <libsoup/soup.h>
27#include <JavaScriptCore/JSBase.h>
28
29#include <webkit/webkitdefines.h>
30#include <webkit/webkitwebbackforwardlist.h>
31#include <webkit/webkitwebframe.h>
32#include <webkit/webkitwebhistoryitem.h>
33#include <webkit/webkitwebsettings.h>
34
35G_BEGIN_DECLS
36
37#define WEBKIT_TYPE_WEB_VIEW            (webkit_web_view_get_type())
38#define WEBKIT_WEB_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebView))
39#define WEBKIT_WEB_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
40#define WEBKIT_IS_WEB_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_VIEW))
41#define WEBKIT_IS_WEB_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_VIEW))
42#define WEBKIT_WEB_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
43
44typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
45
46typedef enum {
47    WEBKIT_NAVIGATION_RESPONSE_ACCEPT,
48    WEBKIT_NAVIGATION_RESPONSE_IGNORE,
49    WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD
50} WebKitNavigationResponse;
51
52typedef enum {
53    WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER = 1,
54    WEBKIT_CACHE_MODEL_WEB_BROWSER
55} WebKitCacheModel;
56
57typedef enum
58{
59    WEBKIT_WEB_VIEW_TARGET_INFO_HTML,
60    WEBKIT_WEB_VIEW_TARGET_INFO_TEXT,
61    WEBKIT_WEB_VIEW_TARGET_INFO_IMAGE,
62    WEBKIT_WEB_VIEW_TARGET_INFO_URI_LIST,
63    WEBKIT_WEB_VIEW_TARGET_INFO_NETSCAPE_URL
64} WebKitWebViewTargetInfo;
65
66struct _WebKitWebView {
67    GtkContainer parent_instance;
68
69    /*< private >*/
70    WebKitWebViewPrivate *priv;
71};
72
73struct _WebKitWebViewClass {
74    GtkContainerClass parent_class;
75
76    /*< public >*/
77    /*
78     * default handler/virtual methods
79     */
80    WebKitWebView            * (* create_web_view)        (WebKitWebView        *web_view,
81                                                           WebKitWebFrame       *web_frame);
82
83    gboolean                   (* web_view_ready)          (WebKitWebView* web_view);
84
85    gboolean                   (* close_web_view)         (WebKitWebView* web_view);
86
87    WebKitNavigationResponse   (* navigation_requested)   (WebKitWebView        *web_view,
88                                                           WebKitWebFrame       *frame,
89                                                           WebKitNetworkRequest *request);
90    void                       (* window_object_cleared)  (WebKitWebView        *web_view,
91                                                           WebKitWebFrame       *frame,
92                                                           JSGlobalContextRef    context,
93                                                           JSObjectRef           window_object);
94    gchar                    * (* choose_file)            (WebKitWebView        *web_view,
95                                                           WebKitWebFrame       *frame,
96                                                           const gchar          *old_file);
97    gboolean                   (* script_alert)           (WebKitWebView        *web_view,
98                                                           WebKitWebFrame       *frame,
99                                                           const gchar          *alert_message);
100    gboolean                   (* script_confirm)         (WebKitWebView        *web_view,
101                                                           WebKitWebFrame       *frame,
102                                                           const gchar          *confirm_message,
103                                                           gboolean             *did_confirm);
104    gboolean                   (* script_prompt)          (WebKitWebView        *web_view,
105                                                           WebKitWebFrame       *frame,
106                                                           const gchar          *message,
107                                                           const gchar          *default_value,
108                                                           gchar*               *value);
109    gboolean                   (* console_message)        (WebKitWebView        *web_view,
110                                                           const gchar          *message,
111                                                           guint                 line_number,
112                                                           const gchar*          source_id);
113    void                       (* select_all)             (WebKitWebView        *web_view);
114    void                       (* cut_clipboard)          (WebKitWebView        *web_view);
115    void                       (* copy_clipboard)         (WebKitWebView        *web_view);
116    void                       (* paste_clipboard)        (WebKitWebView        *web_view);
117    gboolean                   (* move_cursor)            (WebKitWebView        *web_view,
118                                                           GtkMovementStep       step,
119                                                           gint                  count);
120
121    /*
122     * internal
123     */
124    void                       (* set_scroll_adjustments) (WebKitWebView        *web_view,
125                                                           GtkAdjustment        *hadjustment,
126                                                           GtkAdjustment        *vadjustment);
127
128    void                       (* undo)                   (WebKitWebView        *web_view);
129    void                       (* redo)                   (WebKitWebView        *web_view);
130
131    /* Padding for future expansion */
132    void (*_webkit_reserved0) (void);
133    void (*_webkit_reserved1) (void);
134    void (*_webkit_reserved2) (void);
135    void (*_webkit_reserved3) (void);
136};
137
138WEBKIT_API GType
139webkit_web_view_get_type (void);
140
141WEBKIT_API GtkWidget *
142webkit_web_view_new (void);
143
144WEBKIT_API G_CONST_RETURN gchar *
145webkit_web_view_get_title                       (WebKitWebView        *web_view);
146
147WEBKIT_API G_CONST_RETURN gchar *
148webkit_web_view_get_uri                         (WebKitWebView        *web_view);
149
150WEBKIT_API void
151webkit_web_view_set_maintains_back_forward_list (WebKitWebView        *web_view,
152                                                 gboolean              flag);
153
154WEBKIT_API WebKitWebBackForwardList *
155webkit_web_view_get_back_forward_list           (WebKitWebView        *web_view);
156
157WEBKIT_API gboolean
158webkit_web_view_go_to_back_forward_item         (WebKitWebView        *web_view,
159                                                 WebKitWebHistoryItem *item);
160
161WEBKIT_API gboolean
162webkit_web_view_can_go_back                     (WebKitWebView        *web_view);
163
164WEBKIT_API gboolean
165webkit_web_view_can_go_back_or_forward          (WebKitWebView        *web_view,
166                                                 gint                  steps);
167
168WEBKIT_API gboolean
169webkit_web_view_can_go_forward                  (WebKitWebView        *web_view);
170
171WEBKIT_API void
172webkit_web_view_go_back                         (WebKitWebView        *web_view);
173
174WEBKIT_API void
175webkit_web_view_go_back_or_forward              (WebKitWebView        *web_view,
176                                                 gint                  steps);
177
178WEBKIT_API void
179webkit_web_view_go_forward                      (WebKitWebView        *web_view);
180
181WEBKIT_API void
182webkit_web_view_stop_loading                    (WebKitWebView        *web_view);
183
184WEBKIT_API void
185webkit_web_view_open                            (WebKitWebView        *web_view,
186                                                 const gchar          *uri);
187
188WEBKIT_API void
189webkit_web_view_reload                          (WebKitWebView        *web_view);
190
191WEBKIT_API void
192webkit_web_view_reload_bypass_cache             (WebKitWebView        *web_view);
193
194WEBKIT_API void
195webkit_web_view_load_uri                        (WebKitWebView        *web_view,
196                                                 const gchar          *uri);
197
198WEBKIT_API void
199webkit_web_view_load_string                     (WebKitWebView        *web_view,
200                                                 const gchar          *content,
201                                                 const gchar          *mime_type,
202                                                 const gchar          *encoding,
203                                                 const gchar          *base_uri);
204
205WEBKIT_API void
206webkit_web_view_load_html_string                (WebKitWebView        *web_view,
207                                                 const gchar          *content,
208                                                 const gchar          *base_uri);
209
210WEBKIT_API void
211webkit_web_view_load_request                    (WebKitWebView        *web_view,
212                                                 WebKitNetworkRequest *request);
213
214WEBKIT_API gboolean
215webkit_web_view_search_text                     (WebKitWebView        *web_view,
216                                                 const gchar          *text,
217                                                 gboolean              case_sensitive,
218                                                 gboolean              forward,
219                                                 gboolean              wrap);
220
221WEBKIT_API guint
222webkit_web_view_mark_text_matches               (WebKitWebView        *web_view,
223                                                 const gchar          *string,
224                                                 gboolean              case_sensitive,
225                                                 guint                 limit);
226
227WEBKIT_API void
228webkit_web_view_set_highlight_text_matches      (WebKitWebView        *web_view,
229                                                 gboolean              highlight);
230
231WEBKIT_API void
232webkit_web_view_unmark_text_matches             (WebKitWebView        *web_view);
233
234WEBKIT_API WebKitWebFrame *
235webkit_web_view_get_main_frame                  (WebKitWebView        *web_view);
236
237WEBKIT_API WebKitWebFrame *
238webkit_web_view_get_focused_frame               (WebKitWebView        *web_view);
239
240WEBKIT_API void
241webkit_web_view_execute_script                  (WebKitWebView        *web_view,
242                                                 const gchar          *script);
243
244WEBKIT_API gboolean
245webkit_web_view_can_cut_clipboard               (WebKitWebView        *web_view);
246
247WEBKIT_API gboolean
248webkit_web_view_can_copy_clipboard              (WebKitWebView        *web_view);
249
250WEBKIT_API gboolean
251webkit_web_view_can_paste_clipboard             (WebKitWebView        *web_view);
252
253WEBKIT_API void
254webkit_web_view_cut_clipboard                   (WebKitWebView        *web_view);
255
256WEBKIT_API void
257webkit_web_view_copy_clipboard                  (WebKitWebView        *web_view);
258
259WEBKIT_API void
260webkit_web_view_paste_clipboard                 (WebKitWebView        *web_view);
261
262WEBKIT_API void
263webkit_web_view_delete_selection                (WebKitWebView        *web_view);
264
265WEBKIT_API gboolean
266webkit_web_view_has_selection                   (WebKitWebView        *web_view);
267
268WEBKIT_API void
269webkit_web_view_select_all                      (WebKitWebView        *web_view);
270
271WEBKIT_API gboolean
272webkit_web_view_get_editable                    (WebKitWebView        *web_view);
273
274WEBKIT_API void
275webkit_web_view_set_editable                    (WebKitWebView        *web_view,
276                                                 gboolean              flag);
277
278WEBKIT_API GtkTargetList *
279webkit_web_view_get_copy_target_list            (WebKitWebView        *web_view);
280
281WEBKIT_API GtkTargetList *
282webkit_web_view_get_paste_target_list           (WebKitWebView        *web_view);
283
284WEBKIT_API void
285webkit_web_view_set_settings                    (WebKitWebView        *web_view,
286                                                 WebKitWebSettings    *settings);
287
288WEBKIT_API WebKitWebSettings *
289webkit_web_view_get_settings                    (WebKitWebView        *web_view);
290
291WEBKIT_API WebKitWebInspector *
292webkit_web_view_get_inspector                   (WebKitWebView        *web_view);
293
294WEBKIT_API WebKitWebWindowFeatures*
295webkit_web_view_get_window_features             (WebKitWebView        *web_view);
296
297WEBKIT_API gboolean
298webkit_web_view_can_show_mime_type              (WebKitWebView        *web_view,
299                                                 const gchar          *mime_type);
300
301WEBKIT_API gboolean
302webkit_web_view_get_transparent                 (WebKitWebView        *web_view);
303
304WEBKIT_API void
305webkit_web_view_set_transparent                 (WebKitWebView        *web_view,
306                                                 gboolean              flag);
307
308WEBKIT_API gfloat
309webkit_web_view_get_zoom_level                  (WebKitWebView        *web_view);
310
311WEBKIT_API void
312webkit_web_view_set_zoom_level                  (WebKitWebView        *web_view,
313                                                 gfloat                zoom_level);
314
315WEBKIT_API void
316webkit_web_view_zoom_in                         (WebKitWebView        *web_view);
317
318WEBKIT_API void
319webkit_web_view_zoom_out                        (WebKitWebView        *web_view);
320
321WEBKIT_API gboolean
322webkit_web_view_get_full_content_zoom           (WebKitWebView        *web_view);
323
324WEBKIT_API void
325webkit_web_view_set_full_content_zoom           (WebKitWebView        *web_view,
326                                                 gboolean              full_content_zoom);
327
328WEBKIT_API SoupSession*
329webkit_get_default_session                      (void);
330
331WEBKIT_API const gchar*
332webkit_web_view_get_encoding                    (WebKitWebView        * webView);
333
334WEBKIT_API void
335webkit_web_view_set_custom_encoding             (WebKitWebView        * webView,
336                                                 const gchar          * encoding);
337
338WEBKIT_API const char*
339webkit_web_view_get_custom_encoding             (WebKitWebView        * webView);
340
341WEBKIT_API void
342webkit_web_view_move_cursor                     (WebKitWebView        * webView,
343                                                 GtkMovementStep        step,
344                                                 gint                   count);
345
346WEBKIT_API WebKitLoadStatus
347webkit_web_view_get_load_status                 (WebKitWebView        *web_view);
348
349WEBKIT_API gdouble
350webkit_web_view_get_progress                    (WebKitWebView        *web_view);
351
352WEBKIT_API void
353webkit_web_view_undo                            (WebKitWebView        *webView);
354
355WEBKIT_API gboolean
356webkit_web_view_can_undo                        (WebKitWebView        *webView);
357
358WEBKIT_API void
359webkit_web_view_redo                            (WebKitWebView        *webView);
360
361WEBKIT_API gboolean
362webkit_web_view_can_redo                        (WebKitWebView        *webView);
363
364WEBKIT_API void
365webkit_web_view_set_view_source_mode            (WebKitWebView        *web_view,
366                                                 gboolean             view_source_mode);
367
368WEBKIT_API gboolean
369webkit_web_view_get_view_source_mode            (WebKitWebView        *web_view);
370
371WEBKIT_API WebKitHitTestResult*
372webkit_web_view_get_hit_test_result             (WebKitWebView        *webView,
373                                                 GdkEventButton       *event);
374
375WEBKIT_API G_CONST_RETURN gchar *
376webkit_web_view_get_icon_uri                    (WebKitWebView        *webView);
377
378WEBKIT_API void
379webkit_set_cache_model                          (WebKitCacheModel     cache_model);
380
381WEBKIT_API WebKitCacheModel
382webkit_get_cache_model                          (void);
383
384G_END_DECLS
385
386#endif
387