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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
|
/*
* Copyright (C) 2014 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 "WebKitNavigationAction.h"
#include "WebKitNavigationActionPrivate.h"
#include "WebKitPrivate.h"
#include "WebKitURIRequestPrivate.h"
using namespace WebKit;
/**
* WebKitNavigationAction:
*
* Provides details about interaction resulting in a resource load.
*/
G_DEFINE_BOXED_TYPE(WebKitNavigationAction, webkit_navigation_action, webkit_navigation_action_copy, webkit_navigation_action_free)
WebKitNavigationAction* webkitNavigationActionCreate(Ref<API::NavigationAction>&& action)
{
WebKitNavigationAction* navigation = static_cast<WebKitNavigationAction*>(fastZeroedMalloc(sizeof(WebKitNavigationAction)));
new (navigation) WebKitNavigationAction(WTFMove(action));
return navigation;
}
/**
* webkit_navigation_action_copy:
* @navigation: a #WebKitNavigationAction
*
* Make a copy of @navigation.
*
* Returns: (transfer full): A copy of passed in #WebKitNavigationAction
*
* Since: 2.6
*/
WebKitNavigationAction* webkit_navigation_action_copy(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, nullptr);
WebKitNavigationAction* copy = static_cast<WebKitNavigationAction*>(fastZeroedMalloc(sizeof(WebKitNavigationAction)));
new (copy) WebKitNavigationAction(navigation);
return copy;
}
/**
* webkit_navigation_action_free:
* @navigation: a #WebKitNavigationAction
*
* Free the #WebKitNavigationAction
*
* Since: 2.6
*/
void webkit_navigation_action_free(WebKitNavigationAction* navigation)
{
g_return_if_fail(navigation);
navigation->~WebKitNavigationAction();
fastFree(navigation);
}
/**
* webkit_navigation_action_get_navigation_type:
* @navigation: a #WebKitNavigationAction
*
* Return the type of action that triggered the navigation.
*
* Returns: a #WebKitNavigationType
*
* Since: 2.6
*/
WebKitNavigationType webkit_navigation_action_get_navigation_type(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, WEBKIT_NAVIGATION_TYPE_OTHER);
return toWebKitNavigationType(navigation->action->navigationType());
}
/**
* webkit_navigation_action_get_mouse_button:
* @navigation: a #WebKitNavigationAction
*
* Return the number of the mouse button that triggered the navigation.
*
* Return the number of the mouse button that triggered the navigation, or 0 if
* the navigation was not started by a mouse event.
*
* Returns: the mouse button number or 0
*
* Since: 2.6
*/
unsigned webkit_navigation_action_get_mouse_button(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, 0);
return toWebKitMouseButton(navigation->action->mouseButton());
}
/**
* webkit_navigation_action_get_modifiers:
* @navigation: a #WebKitNavigationAction
*
* Return the modifier keys.
*
* Return a bitmask of #GdkModifierType values describing the modifier keys that were in effect
* when the navigation was requested
*
* Returns: the modifier keys
*
* Since: 2.6
*/
unsigned webkit_navigation_action_get_modifiers(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, 0);
return toPlatformModifiers(navigation->action->modifiers());
}
/**
* webkit_navigation_action_get_request:
* @navigation: a #WebKitNavigationAction
*
* Return the #WebKitURIRequest associated with the navigation action.
*
* Modifications to the returned object are <emphasis>not</emphasis> taken
* into account when the request is sent over the network, and is intended
* only to aid in evaluating whether a navigation action should be taken or
* not. To modify requests before they are sent over the network the
* #WebKitPage::send-request signal can be used instead.
*
* Returns: (transfer none): a #WebKitURIRequest
*
* Since: 2.6
*/
WebKitURIRequest* webkit_navigation_action_get_request(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, nullptr);
if (!navigation->request)
navigation->request = adoptGRef(webkitURIRequestCreateForResourceRequest(navigation->action->request()));
return navigation->request.get();
}
/**
* webkit_navigation_action_is_user_gesture:
* @navigation: a #WebKitNavigationAction
*
* Return whether the navigation was triggered by a user gesture like a mouse click.
*
* Returns: whether navigation action is a user gesture
*
* Since: 2.6
*/
gboolean webkit_navigation_action_is_user_gesture(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, FALSE);
return navigation->action->isProcessingUserGesture();
}
/**
* webkit_navigation_action_is_redirect:
* @navigation: a #WebKitNavigationAction
*
* Returns whether the @navigation was redirected.
*
* Returns: %TRUE if the original navigation was redirected, %FALSE otherwise.
*
* Since: 2.20
*/
gboolean webkit_navigation_action_is_redirect(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, FALSE);
return navigation->action->isRedirect();
}
/**
* webkit_navigation_action_get_frame_name:
* @navigation: a #WebKitNavigationAction
*
* Gets the @navigation target frame name. For example if navigation was triggered by clicking a
* link with a target attribute equal to "_blank", this will return the value of that attribute.
* In all other cases this function will return %NULL.
*
* Returns: (nullable): The name of the new frame this navigation action targets or %NULL
*
* Since: 2.40
*/
const char* webkit_navigation_action_get_frame_name(WebKitNavigationAction* navigation)
{
g_return_val_if_fail(navigation, nullptr);
if (!navigation->frameName) {
if (auto targetFrameName = navigation->action->targetFrameName(); !!targetFrameName)
navigation->frameName = targetFrameName.utf8();
else
navigation->frameName = CString();
}
return navigation->frameName->data();
}
|