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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* Copyright (C) 2022 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "WebKitWebView.h"
#include <gtk/gtk.h>
#if !USE(GTK4)
/**
* WebKitWebsiteDataTypes:
* @WEBKIT_WEBSITE_DATA_MEMORY_CACHE: Memory cache.
* @WEBKIT_WEBSITE_DATA_DISK_CACHE: HTTP disk cache.
* @WEBKIT_WEBSITE_DATA_OFFLINE_APPLICATION_CACHE: Offline web application cache.
* @WEBKIT_WEBSITE_DATA_SESSION_STORAGE: Session storage data.
* @WEBKIT_WEBSITE_DATA_LOCAL_STORAGE: Local storage data.
* @WEBKIT_WEBSITE_DATA_WEBSQL_DATABASES: WebSQL databases. Deprecated 2.24
* @WEBKIT_WEBSITE_DATA_INDEXEDDB_DATABASES: IndexedDB databases.
* @WEBKIT_WEBSITE_DATA_PLUGIN_DATA: Plugins data. Deprecated 2.32
* @WEBKIT_WEBSITE_DATA_COOKIES: Cookies.
* @WEBKIT_WEBSITE_DATA_DEVICE_ID_HASH_SALT: Hash salt used to generate the device ids used by webpages. Since 2.24
* @WEBKIT_WEBSITE_DATA_HSTS_CACHE: HSTS cache. Since 2.26
* @WEBKIT_WEBSITE_DATA_ITP: Intelligent Tracking Prevention data. Since 2.30.
* @WEBKIT_WEBSITE_DATA_SERVICE_WORKER_REGISTRATIONS: Service worker registrations. Since 2.30
* @WEBKIT_WEBSITE_DATA_DOM_CACHE: DOM (CacheStorage) cache. Since 2.30
* @WEBKIT_WEBSITE_DATA_ALL: All types.
*
* Enum values with flags representing types of Website data.
*
* Since: 2.16
*/
guint createContextMenuSignal(WebKitWebViewClass* webViewClass)
{
/**
* WebKitWebView::context-menu:
* @web_view: the #WebKitWebView on which the signal is emitted
* @context_menu: the proposed #WebKitContextMenu
* @event: the #GdkEvent that triggered the context menu. Deprecated 2.40.
* @hit_test_result: a #WebKitHitTestResult
*
* Emitted when a context menu is about to be displayed to give the application
* a chance to customize the proposed menu, prevent the menu from being displayed,
* or build its own context menu.
* <itemizedlist>
* <listitem><para>
* To customize the proposed menu you can use webkit_context_menu_prepend(),
* webkit_context_menu_append() or webkit_context_menu_insert() to add new
* #WebKitContextMenuItem<!-- -->s to @context_menu, webkit_context_menu_move_item()
* to reorder existing items, or webkit_context_menu_remove() to remove an
* existing item. The signal handler should return %FALSE, and the menu represented
* by @context_menu will be shown.
* </para></listitem>
* <listitem><para>
* To prevent the menu from being displayed you can just connect to this signal
* and return %TRUE so that the proposed menu will not be shown.
* </para></listitem>
* <listitem><para>
* To build your own menu, you can remove all items from the proposed menu with
* webkit_context_menu_remove_all(), add your own items and return %FALSE so
* that the menu will be shown. You can also ignore the proposed #WebKitContextMenu,
* build your own #GtkMenu and return %TRUE to prevent the proposed menu from being shown.
* </para></listitem>
* <listitem><para>
* If you just want the default menu to be shown always, simply don't connect to this
* signal because showing the proposed context menu is the default behaviour.
* </para></listitem>
* </itemizedlist>
*
* The @event parameter is now deprecated. Use webkit_context_menu_get_event() to get the
* #GdkEvent that triggered the context menu.
*
* If the signal handler returns %FALSE the context menu represented by @context_menu
* will be shown, if it return %TRUE the context menu will not be shown.
*
* The proposed #WebKitContextMenu passed in @context_menu argument is only valid
* during the signal emission.
*
* Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
return g_signal_new(
"context-menu",
G_TYPE_FROM_CLASS(webViewClass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET(WebKitWebViewClass, context_menu),
g_signal_accumulator_true_handled, nullptr,
g_cclosure_marshal_generic,
G_TYPE_BOOLEAN,
3,
WEBKIT_TYPE_CONTEXT_MENU,
GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE,
WEBKIT_TYPE_HIT_TEST_RESULT);
}
guint createShowOptionMenuSignal(WebKitWebViewClass* webViewClass)
{
/**
* WebKitWebView::show-option-menu:
* @web_view: the #WebKitWebView on which the signal is emitted
* @menu: the #WebKitOptionMenu
* @event: the #GdkEvent that triggered the menu, or %NULL. Deprecated 2.40
* @rectangle: the option element area
*
* This signal is emitted when a select element in @web_view needs to display a
* dropdown menu. This signal can be used to show a custom menu, using @menu to get
* the details of all items that should be displayed. The area of the element in the
* #WebKitWebView is given as @rectangle parameter, it can be used to position the
* menu. If this was triggered by a user interaction, like a mouse click,
* @event parameter provides the #GdkEvent.
* To handle this signal asynchronously you should keep a ref of the @menu.
*
* The @event parameter is now deprecated. Use webkit_option_menu_get_event() to get the
* #GdkEvent that triggered the dropdown menu.
*
* The default signal handler will pop up a #GtkMenu.
*
* Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*
* Since: 2.18
*/
return g_signal_new(
"show-option-menu",
G_TYPE_FROM_CLASS(webViewClass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET(WebKitWebViewClass, show_option_menu),
g_signal_accumulator_true_handled, nullptr,
g_cclosure_marshal_generic,
G_TYPE_BOOLEAN, 3,
WEBKIT_TYPE_OPTION_MENU,
GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE,
GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
}
/**
* webkit_web_view_set_background_color:
* @web_view: a #WebKitWebView
* @rgba: a #GdkRGBA
*
* Sets the color that will be used to draw the @web_view background.
*
* Sets the color that will be used to draw the @web_view background before
* the actual contents are rendered. Note that if the web page loaded in @web_view
* specifies a background color, it will take precedence over the @rgba color.
* By default the @web_view background color is opaque white.
* Note that the parent window must have a RGBA visual and
* #GtkWidget:app-paintable property set to %TRUE for backgrounds colors to work.
*
* ```c
* static void browser_window_set_background_color (BrowserWindow *window,
* const GdkRGBA *rgba)
* {
* WebKitWebView *web_view;
* GdkScreen *screen = gtk_window_get_screen (GTK_WINDOW (window));
* GdkVisual *rgba_visual = gdk_screen_get_rgba_visual (screen);
*
* if (!rgba_visual)
* return;
*
* gtk_widget_set_visual (GTK_WIDGET (window), rgba_visual);
* gtk_widget_set_app_paintable (GTK_WIDGET (window), TRUE);
*
* web_view = browser_window_get_web_view (window);
* webkit_web_view_set_background_color (web_view, rgba);
* }
* ```
*
* Since: 2.8
*/
#endif
|
