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
|
/*
* Copyright (C) 2012 Intel Corporation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file ewk_navigation_policy_decision.h
* @brief Describes the Ewk navigation policy decision API.
*/
#ifndef ewk_navigation_policy_decision_h
#define ewk_navigation_policy_decision_h
#include "ewk_url_request.h"
#include <Eina.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Creates a type name for Ewk_Navigation_Policy_Decision */
typedef struct Ewk_Navigation_Policy_Decision Ewk_Navigation_Policy_Decision;
/// Enum containing navigation types
typedef enum {
EWK_NAVIGATION_TYPE_LINK_ACTIVATED,
EWK_NAVIGATION_TYPE_FORM_SUBMITTED,
EWK_NAVIGATION_TYPE_BACK_FORWARD,
EWK_NAVIGATION_TYPE_RELOAD,
EWK_NAVIGATION_TYPE_FORM_RESUBMITTED,
EWK_NAVIGATION_TYPE_OTHER
} Ewk_Navigation_Type;
/// Enum containing button types
typedef enum {
EVENT_MOUSE_BUTTON_NONE = -1,
EVENT_MOUSE_BUTTON_LEFT = 0,
EVENT_MOUSE_BUTTON_MIDDLE = 1,
EVENT_MOUSE_BUTTON_RIGHT = 2
} Event_Mouse_Button;
typedef enum {
EVENT_MODIFIER_KEY_SHIFT = 1 << 0,
EVENT_MODIFIER_KEY_CTRL = 1 << 1,
EVENT_MODIFIER_KEY_ALT = 1 << 2,
EVENT_MODIFIER_KEY_META = 1 << 3
} Event_Modifier_Keys;
/**
* Increases the reference count of the given object.
*
* @param decision the policy decision object to increase the reference count
*
* @return a pointer to the object on success, @c NULL otherwise.
*/
EAPI Ewk_Navigation_Policy_Decision *ewk_navigation_policy_decision_ref(Ewk_Navigation_Policy_Decision *decision);
/**
* Decreases the reference count of the given object, possibly freeing it.
*
* When the reference count reaches 0, the object is freed.
*
* @param decision the policy decision object to decrease the reference count
*/
EAPI void ewk_navigation_policy_decision_unref(Ewk_Navigation_Policy_Decision *decision);
/**
* Query type for this navigation policy decision.
*
* @param decision navigation policy decision object to query.
*
* @return the type of navigation.
*/
EAPI Ewk_Navigation_Type ewk_navigation_policy_navigation_type_get(const Ewk_Navigation_Policy_Decision *decision);
/**
* Query mouse button for this navigation policy decision.
*
* @param decision navigation policy decision object to query.
*
* @return the mouse button clicked to trigger the navigation.
*/
EAPI Event_Mouse_Button ewk_navigation_policy_mouse_button_get(const Ewk_Navigation_Policy_Decision *decision);
/**
* Query modifier keys for this navigation policy decision.
*
* @param decision navigation policy decision object to query.
*
* @return the modifier keys used when triggering the navigation.
*/
EAPI Event_Modifier_Keys ewk_navigation_policy_modifiers_get(const Ewk_Navigation_Policy_Decision *decision);
/**
* Query frame name for this navigation policy decision.
*
* The frame name is non-null for new window policy decisions only.
*
* @param decision navigation policy decision object to query.
*
* @return the frame name pointer, that may be @c NULL. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup().
*/
EAPI const char *ewk_navigation_policy_frame_name_get(const Ewk_Navigation_Policy_Decision *decision);
/**
* Query URL request for this navigation policy decision.
*
* @param decision navigation policy decision object to query.
*
* @return The URL request pointer or @c NULL in case of error.
*/
EAPI Ewk_Url_Request *ewk_navigation_policy_request_get(const Ewk_Navigation_Policy_Decision *decision);
/**
* Accepts the navigation request.
*
* The navigation will be accepted by default.
*
* @param decision navigation policy decision object to query.
*/
EAPI void ewk_navigation_policy_decision_accept(Ewk_Navigation_Policy_Decision *decision);
/**
* Rejects the navigation request.
*
* @param decision navigation policy decision object to query.
*/
EAPI void ewk_navigation_policy_decision_reject(Ewk_Navigation_Policy_Decision *decision);
/**
* Triggers a download instead of navigating to the url.
*
* @param decision navigation policy decision object to query.
*/
EAPI void ewk_navigation_policy_decision_download(Ewk_Navigation_Policy_Decision *decision);
#ifdef __cplusplus
}
#endif
#endif // ewk_navigation_policy_decision_h
|
