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
|
/*
* Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2009 Antonio Gomes <tonikitoo@webkit.org>
*
* 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.
*/
#ifndef SpatialNavigation_h
#define SpatialNavigation_h
#include "FocusDirection.h"
#include "HTMLFrameOwnerElement.h"
#include "LayoutRect.h"
#include "Node.h"
#include <limits>
namespace WebCore {
class Element;
class Frame;
class HTMLAreaElement;
class IntRect;
class RenderObject;
using namespace std;
inline long long maxDistance()
{
return numeric_limits<long long>::max();
}
inline int fudgeFactor()
{
return 2;
}
bool isSpatialNavigationEnabled(const Frame*);
// Spatially speaking, two given elements in a web page can be:
// 1) Fully aligned: There is a full intersection between the rects, either
// vertically or horizontally.
//
// * Horizontally * Vertically
// _
// |_| _ _ _ _ _ _
// |_|...... _ |_|_|_|_|_|_|
// |_| |_| . .
// |_|......|_| OR . .
// |_| |_| . .
// |_|......|_| _ _ _ _
// |_| |_|_|_|_|
//
//
// 2) Partially aligned: There is a partial intersection between the rects, either
// vertically or horizontally.
//
// * Horizontally * Vertically
// _ _ _ _ _ _
// |_| |_|_|_|_|_|
// |_|.... _ OR . .
// |_| |_| . .
// |_|....|_| ._._ _
// |_| |_|_|_|
// |_|
//
// 3) Or, otherwise, not aligned at all.
//
// * Horizontally * Vertically
// _ _ _ _ _
// |_| |_|_|_|_|
// |_| .
// |_| .
// . OR .
// _ . ._ _ _ _ _
// |_| |_|_|_|_|_|
// |_|
// |_|
//
// "Totally Aligned" elements are preferable candidates to move
// focus to over "Partially Aligned" ones, that on its turns are
// more preferable than "Not Aligned".
enum RectsAlignment {
None = 0,
Partial,
Full
};
struct FocusCandidate {
FocusCandidate()
: visibleNode(0)
, focusableNode(0)
, enclosingScrollableBox(0)
, distance(maxDistance())
, alignment(None)
, isOffscreen(true)
, isOffscreenAfterScrolling(true)
{
}
FocusCandidate(Node* n, FocusDirection);
explicit FocusCandidate(HTMLAreaElement* area, FocusDirection);
bool isNull() const { return !visibleNode; }
bool inScrollableContainer() const { return visibleNode && enclosingScrollableBox; }
bool isFrameOwnerElement() const { return visibleNode && visibleNode->isFrameOwnerElement(); }
Document* document() const { return visibleNode ? visibleNode->document() : 0; }
// We handle differently visibleNode and FocusableNode to properly handle the areas of imagemaps,
// where visibleNode would represent the image element and focusableNode would represent the area element.
// In all other cases, visibleNode and focusableNode are one and the same.
Node* visibleNode;
Node* focusableNode;
Node* enclosingScrollableBox;
long long distance;
RectsAlignment alignment;
LayoutRect rect;
bool isOffscreen;
bool isOffscreenAfterScrolling;
};
bool hasOffscreenRect(Node*, FocusDirection direction = FocusDirectionNone);
bool scrollInDirection(Frame*, FocusDirection);
bool scrollInDirection(Node* container, FocusDirection);
bool canScrollInDirection(const Node* container, FocusDirection);
bool canScrollInDirection(const Frame*, FocusDirection);
bool canBeScrolledIntoView(FocusDirection, const FocusCandidate&);
bool areElementsOnSameLine(const FocusCandidate& firstCandidate, const FocusCandidate& secondCandidate);
void distanceDataForNode(FocusDirection, const FocusCandidate& current, FocusCandidate& candidate);
Node* scrollableEnclosingBoxOrParentFrameForNodeInDirection(FocusDirection, Node*);
LayoutRect nodeRectInAbsoluteCoordinates(Node*, bool ignoreBorder = false);
LayoutRect frameRectInAbsoluteCoordinates(Frame*);
LayoutRect virtualRectForDirection(FocusDirection, const LayoutRect& startingRect, LayoutUnit width = 0);
LayoutRect virtualRectForAreaElementAndDirection(HTMLAreaElement*, FocusDirection);
HTMLFrameOwnerElement* frameOwnerElement(FocusCandidate&);
} // namspace WebCore
#endif // SpatialNavigation_h
|
