1/*
2 * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef FocusController_h
27#define FocusController_h
28
29#include "FocusDirection.h"
30#include "SpatialNavigation.h"
31#include <wtf/Forward.h>
32#include <wtf/Noncopyable.h>
33#include <wtf/RefPtr.h>
34
35namespace WebCore {
36
37class Document;
38class Frame;
39class KeyboardEvent;
40class Node;
41class Page;
42
43class FocusController {
44    WTF_MAKE_NONCOPYABLE(FocusController); WTF_MAKE_FAST_ALLOCATED;
45public:
46    FocusController(Page*);
47
48    void setFocusedFrame(PassRefPtr<Frame>);
49    Frame* focusedFrame() const { return m_focusedFrame.get(); }
50    Frame* focusedOrMainFrame() const;
51
52    bool setInitialFocus(FocusDirection, KeyboardEvent*);
53    bool advanceFocus(FocusDirection, KeyboardEvent*, bool initialFocus = false);
54
55    bool setFocusedNode(Node*, PassRefPtr<Frame>);
56
57    void setActive(bool);
58    bool isActive() const { return m_isActive; }
59
60    void setFocused(bool);
61    bool isFocused() const { return m_isFocused; }
62
63private:
64    bool advanceFocusDirectionally(FocusDirection, KeyboardEvent*);
65    bool advanceFocusInDocumentOrder(FocusDirection, KeyboardEvent*, bool initialFocus);
66
67    bool advanceFocusDirectionallyInContainer(Node* container, const IntRect& startingRect, FocusDirection, KeyboardEvent*);
68    void findFocusCandidateInContainer(Node* container, const IntRect& startingRect, FocusDirection, KeyboardEvent*, FocusCandidate& closest);
69
70    Page* m_page;
71    RefPtr<Frame> m_focusedFrame;
72    bool m_isActive;
73    bool m_isFocused;
74    bool m_isChangingFocusedFrame;
75};
76
77} // namespace WebCore
78
79#endif // FocusController_h
80