webkit_get_default_session ()

SoupSession *
webkit_get_default_session (void);

Retrieves the default SoupSession used by all web views. Note that the session features are added by WebKit on demand, so if you insert your own SoupCookieJar before any network traffic occurs, WebKit will use it instead of the default.

Since: 1.1.1

webkit_get_default_web_database_quota ()

guint64
webkit_get_default_web_database_quota (void);

Returns the default quota for Web Database databases. By default this value is 5MB.

Since: 1.1.14

webkit_get_web_database_directory_path ()

const gchar *
webkit_get_web_database_directory_path
                               (void);

Returns the current path to the directory WebKit will write Web Database and Indexed Database databases. By default this path will be in the user data directory.

Since: 1.1.14

webkit_get_web_plugin_database ()

WebKitWebPluginDatabase *
webkit_get_web_plugin_database (void);

Returns the current WebKitWebPluginDatabase with information about all the plugins WebKit knows about in this instance.

Since: 1.3.8

webkit_remove_all_web_databases ()

void
webkit_remove_all_web_databases (void);

Removes all web databases from the current database directory path.

Since: 1.1.14

webkit_set_default_web_database_quota ()

void
webkit_set_default_web_database_quota (guint64 defaultQuota);

Sets the default quota for Web Database databases.

Since: 1.1.14

webkit_set_web_database_directory_path ()

void
webkit_set_web_database_directory_path
                               (const gchar *path);

Sets the current path to the directory WebKit will write Web Database and Indexed Database databases.

Since: 1.1.14

webkit_get_favicon_database ()

WebKitFaviconDatabase *
webkit_get_favicon_database (void);

Returns the WebKitFaviconDatabase providing access to website icons.

Since: 1.8

webkit_get_icon_database ()

WebKitIconDatabase *
webkit_get_icon_database (void);

Returns the WebKitIconDatabase providing access to website icons.

Since: 1.3.13

webkit_get_text_checker ()

GObject *
webkit_get_text_checker (void);

Since: 1.5.1

webkit_set_text_checker ()

void
webkit_set_text_checker (GObject *checker);

Sets checker as the spell checker to be used by WebKit. The API accepts GObject since in the future we might accept objects implementing multiple interfaces (for example, spell checking and grammar checking).

Since: 1.5.1

webkit_application_cache_get_database_directory_path ()

const gchar *
webkit_application_cache_get_database_directory_path
                               (void);

Returns the path to the directory WebKit will write web application cache databases to. By default this path is set to $XDG_CACHE_HOME/webkitgtk/applications and cannot be modified.

Since: 1.3.13

webkit_application_cache_get_maximum_size ()

unsigned long long
webkit_application_cache_get_maximum_size
                               (void);

Returns the maximum size of the cache storage. By default it is set to UINT_MAX i.e. no quota.

Since: 1.3.13

webkit_application_cache_set_maximum_size ()

void
webkit_application_cache_set_maximum_size
                               (unsigned long long  size);

Sets new application cache maximum storage size. Changing the application cache storage size will clear the cache and rebuild cache storage.

Since: 1.3.13

webkit_get_cache_model ()

WebKitCacheModel
webkit_get_cache_model (void);

Returns the current cache model. For more information about this value check the documentation of the function webkit_set_cache_model().

Since: 1.1.18

webkit_set_cache_model ()

void
webkit_set_cache_model (WebKitCacheModel cache_model);

Specifies a usage model for WebViews, which WebKit will use to determine its caching behavior. All web views follow the cache model. This cache model determines the RAM and disk space to use for caching previously viewed content .

Research indicates that users tend to browse within clusters of documents that hold resources in common, and to revisit previously visited documents. WebKit and the frameworks below it include built-in caches that take advantage of these patterns, substantially improving document load speed in browsing situations. The WebKit cache model controls the behaviors of all of these caches, including various WebCore caches.

Browsers can improve document load speed substantially by specifying WEBKIT_CACHE_MODEL_WEB_BROWSER. Applications without a browsing interface can reduce memory usage substantially by specifying WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER. Default value is WEBKIT_CACHE_MODEL_WEB_BROWSER.

Since: 1.1.18

webkit_context_menu_item_get_action ()

WebKitContextMenuAction
webkit_context_menu_item_get_action (GtkMenuItem *item);

Returns the WebKitContextMenuAction of the given item . This function can be used to determine the items present in the default context menu. In order to inspect the default context menu, you should connect to “context-menu” signal.

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

static gboolean context_menu_cb (WebKitWebView       *webView,
                                 GtkWidget           *default_menu,
                                 WebKitHitTestResult *hit_test_result,
                                 gboolean             triggered_with_keyboard,
                                 gpointer             user_data)
{
    GList *items = gtk_container_get_children (GTK_CONTAINER (default_menu));
    GList *l;
    GtkAction *action;
    GtkWidget *sub_menu;

    for (l = items; l; l = g_list_next (l)) {
        GtkMenuItem *item = (GtkMenuItem *)l->data;

        if (GTK_IS_SEPARATOR_MENU_ITEM (item)) {
            /* It's  separator, do nothing */
            continue;
        }

        switch (webkit_context_menu_item_get_action (item)) {
        case WEBKIT_CONTEXT_MENU_ACTION_NO_ACTION:
            /* No action for this item */
            break;
        /* Don't allow to ope links from context menu */
        case WEBKIT_CONTEXT_MENU_ACTION_OPEN_LINK:
        case WEBKIT_CONTEXT_MENU_ACTION_OPEN_LINK_IN_NEW_WINDOW:
            action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (item));
            gtk_action_set_sensitive (action, FALSE);
            break;
        default:
            break;
        }

        sub_menu = gtk_menu_item_get_submenu (item);
        if (sub_menu) {
            GtkWidget *menu_item;

            /* Add custom action to submenu */
            action = gtk_action_new ("CustomItemName", "Custom Action", NULL, NULL);
            g_signal_connect (action, "activate", G_CALLBACK (custom_menu_item_activated), NULL);

            menu_item = gtk_action_create_menu_item (action);
            g_object_unref (action);
            gtk_menu_shell_append (GTK_MENU_SHELL (sub_menu), menu_item);
            gtk_widget_show (menu_item);
        }
    }

    g_list_free(items);
}

Note that you can get the GtkAction of any item in the default context menu with gtk_activatable_get_related_action().

Since: 1.10

webkit_set_security_policy_for_uri_scheme ()

void
webkit_set_security_policy_for_uri_scheme
                               (const gchar *scheme,
                                WebKitSecurityPolicy policy);

Set the security policy for the given URI scheme.

Since: 2.0

webkit_get_security_policy_for_uri_scheme ()

WebKitSecurityPolicy
webkit_get_security_policy_for_uri_scheme
                               (const gchar *scheme);

Get the security policy for the given URI scheme.

Since: 2.0

enum WebKitCacheModel

Enum values used for determining the webview cache model.

enum WebKitContextMenuAction

Enum values used to denote actions of items in the default context menu.

Since: 1.10

enum WebKitSecurityPolicy

Flags used to represent the security policy of a URI scheme.

Since: 2.0