2007-12-22 Luca Bruno <lethalman88@gmail.com>
[WebKit-https.git] / WebKit / gtk / WebView / 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 "webkitdefines.h"
27
28 G_BEGIN_DECLS
29
30 #define WEBKIT_TYPE_WEB_VIEW            (webkit_web_view_get_type())
31 #define WEBKIT_WEB_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebView))
32 #define WEBKIT_WEB_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
33 #define WEBKIT_IS_WEB_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_VIEW))
34 #define WEBKIT_IS_WEB_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_VIEW))
35 #define WEBKIT_WEB_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
36
37
38 typedef enum {
39     WEBKIT_NAVIGATION_RESPONSE_ACCEPT,
40     WEBKIT_NAVIGATION_RESPONSE_IGNORE,
41     WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD
42 } WebKitNavigationResponse;
43
44 typedef enum
45 {
46     WEBKIT_WEB_VIEW_TARGET_INFO_HTML = - 1,
47     WEBKIT_WEB_VIEW_TARGET_INFO_TEXT = - 2
48 } WebKitWebViewTargetInfo;
49
50 struct _WebKitWebView {
51     GtkContainer parent;
52 };
53
54 struct _WebKitWebViewClass {
55     GtkContainerClass parent;
56
57     /*
58      * default handler/virtual methods
59      * DISCUSS: create_web_view needs a request and should we make this a signal with default handler? this would
60      * require someone doing a g_signal_stop_emission_by_name
61      * WebUIDelegate has nothing for create_frame, WebPolicyDelegate as well...
62      */
63     WebKitWebView*  (*create_web_view)  (WebKitWebView* web_view);
64
65     /*
66      * TODO: FIXME: Create something like WebPolicyDecisionListener_Protocol instead
67      */
68     WebKitNavigationResponse (*navigation_requested) (WebKitWebView* web_view, WebKitWebFrame* frame, WebKitNetworkRequest* request);
69
70     void (*window_object_cleared) (WebKitWebView* web_view, WebKitWebFrame* frame, JSGlobalContextRef context, JSObjectRef window_object);
71     gchar*   (*choose_file) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* old_file);
72     gboolean (*script_alert) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* alert_message);
73     gboolean (*script_confirm) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* confirm_message, gboolean* did_confirm);
74     gboolean (*script_prompt) (WebKitWebView* web_view, WebKitWebFrame* frame, const gchar* message, const gchar* default_value, gchar** value);
75     gboolean (*console_message) (WebKitWebView* web_view, const gchar* message, unsigned int line_number, const gchar* source_id);
76     void (*select_all) (WebKitWebView* web_view);
77     void (*cut_clipboard) (WebKitWebView* web_view);
78     void (*copy_clipboard) (WebKitWebView* web_view);
79     void (*paste_clipboard) (WebKitWebView* web_view);
80
81     /*
82      * internal
83      */
84     void   (*set_scroll_adjustments) (WebKitWebView*, GtkAdjustment*, GtkAdjustment*);
85 };
86
87 WEBKIT_API GType
88 webkit_web_view_get_type (void);
89
90 WEBKIT_API GtkWidget*
91 webkit_web_view_new (void);
92
93 WEBKIT_API gboolean
94 webkit_web_view_can_go_backward (WebKitWebView* web_view);
95
96 WEBKIT_API gboolean
97 webkit_web_view_can_go_forward (WebKitWebView* web_view);
98
99 WEBKIT_API void
100 webkit_web_view_go_backward (WebKitWebView* web_view);
101
102 WEBKIT_API void
103 webkit_web_view_go_forward (WebKitWebView* web_view);
104
105 WEBKIT_API void
106 webkit_web_view_stop_loading (WebKitWebView* web_view);
107
108 WEBKIT_API void
109 webkit_web_view_open (WebKitWebView* web_view, const gchar* uri);
110
111 WEBKIT_API void
112 webkit_web_view_reload (WebKitWebView *web_view);
113
114 WEBKIT_API void
115 webkit_web_view_load_string (WebKitWebView* web_view, const gchar* content, const gchar* content_mime_type, const gchar* content_encoding, const gchar* base_uri);
116
117 WEBKIT_API void
118 webkit_web_view_load_html_string (WebKitWebView* web_view, const gchar* content, const gchar* base_uri);
119
120 WEBKIT_API gboolean
121 webkit_web_view_search_text (WebKitWebView* web_view, const gchar* string, gboolean case_sensitive, gboolean forward, gboolean wrap);
122
123 WEBKIT_API guint
124 webkit_web_view_mark_text_matches (WebKitWebView* web_view, const gchar* string, gboolean case_sensitive, guint limit);
125
126 WEBKIT_API void
127 webkit_web_view_set_highlight_text_matches (WebKitWebView* web_view, gboolean highlight);
128
129 WEBKIT_API void
130 webkit_web_view_unmark_text_matches (WebKitWebView* web_view);
131
132 WEBKIT_API WebKitWebFrame*
133 webkit_web_view_get_main_frame (WebKitWebView* web_view);
134
135 WEBKIT_API void
136 webkit_web_view_execute_script (WebKitWebView* web_view, const gchar* script);
137
138 WEBKIT_API gboolean
139 webkit_web_view_can_cut_clipboard (WebKitWebView* web_view);
140
141 WEBKIT_API gboolean
142 webkit_web_view_can_copy_clipboard (WebKitWebView* web_view);
143
144 WEBKIT_API gboolean
145 webkit_web_view_can_paste_clipboard (WebKitWebView* web_view);
146
147 WEBKIT_API void
148 webkit_web_view_cut_clipboard (WebKitWebView* web_view);
149
150 WEBKIT_API void
151 webkit_web_view_copy_clipboard (WebKitWebView* web_view);
152
153 WEBKIT_API void
154 webkit_web_view_paste_clipboard (WebKitWebView* web_view);
155
156 WEBKIT_API void
157 webkit_web_view_delete_selection (WebKitWebView* web_view);
158
159 WEBKIT_API gboolean
160 webkit_web_view_has_selection (WebKitWebView* web_view);
161
162 WEBKIT_API void
163 webkit_web_view_select_all (WebKitWebView* web_view);
164
165 WEBKIT_API gboolean
166 webkit_web_view_get_editable (WebKitWebView* web_view);
167
168 WEBKIT_API void
169 webkit_web_view_set_editable (WebKitWebView* web_view, gboolean flag);
170
171 WEBKIT_API GtkTargetList*
172 webkit_web_view_get_copy_target_list (WebKitWebView* webView);
173
174 WEBKIT_API GtkTargetList*
175 webkit_web_view_get_paste_target_list (WebKitWebView* webView);
176
177 G_END_DECLS
178
179 #endif