SpatialNavigation.h [plain text]
#ifndef SpatialNavigation_h
#define SpatialNavigation_h
#include "FocusDirection.h"
#include "HTMLFrameOwnerElement.h"
#include "IntRect.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*);
enum RectsAlignment {
None = 0,
Partial,
Full
};
struct FocusCandidate {
FocusCandidate()
: visibleNode(0)
, focusableNode(0)
, enclosingScrollableBox(0)
, distance(maxDistance())
, parentDistance(maxDistance())
, alignment(None)
, parentAlignment(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; }
Node* visibleNode;
Node* focusableNode;
Node* enclosingScrollableBox;
long long distance;
long long parentDistance;
RectsAlignment alignment;
RectsAlignment parentAlignment;
IntRect 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*);
IntRect nodeRectInAbsoluteCoordinates(Node*, bool ignoreBorder = false);
IntRect frameRectInAbsoluteCoordinates(Frame*);
IntRect virtualRectForDirection(FocusDirection, const IntRect& startingRect, int width = 0);
IntRect virtualRectForAreaElementAndDirection(HTMLAreaElement*, FocusDirection);
HTMLFrameOwnerElement* frameOwnerElement(FocusCandidate&);
}
#endif // SpatialNavigation_h