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 "core/page/FocusDirection.h" 30 #include "core/platform/graphics/LayoutRect.h" 31 #include "wtf/Forward.h" 32 #include "wtf/Noncopyable.h" 33 #include "wtf/RefPtr.h" 34 35 namespace WebCore { 36 37 struct FocusCandidate; 38 class Document; 39 class Element; 40 class Frame; 41 class HTMLFrameOwnerElement; 42 class IntRect; 43 class KeyboardEvent; 44 class Node; 45 class Page; 46 class TreeScope; 47 48 class FocusNavigationScope { 49 public: 50 Node* rootNode() const; 51 Element* owner() const; 52 static FocusNavigationScope focusNavigationScopeOf(Node*); 53 static FocusNavigationScope focusNavigationScopeOwnedByShadowHost(Node*); 54 static FocusNavigationScope focusNavigationScopeOwnedByIFrame(HTMLFrameOwnerElement*); 55 56 private: 57 explicit FocusNavigationScope(TreeScope*); 58 TreeScope* m_rootTreeScope; 59 }; 60 61 class FocusController { 62 WTF_MAKE_NONCOPYABLE(FocusController); WTF_MAKE_FAST_ALLOCATED; 63 public: 64 static PassOwnPtr<FocusController> create(Page*); 65 66 void setFocusedFrame(PassRefPtr<Frame>); 67 Frame* focusedFrame() const { return m_focusedFrame.get(); } 68 Frame* focusedOrMainFrame() const; 69 70 bool setInitialFocus(FocusDirection); 71 bool advanceFocus(FocusDirection direction) { return advanceFocus(direction, false); } 72 73 bool setFocusedElement(Element*, PassRefPtr<Frame>, FocusDirection = FocusDirectionNone); 74 75 void setActive(bool); 76 bool isActive() const { return m_isActive; } 77 78 void setFocused(bool); 79 bool isFocused() const { return m_isFocused; } 80 81 void setContainingWindowIsVisible(bool); 82 bool containingWindowIsVisible() const { return m_containingWindowIsVisible; } 83 84 private: 85 explicit FocusController(Page*); 86 87 bool advanceFocus(FocusDirection, bool initialFocus); 88 bool advanceFocusDirectionally(FocusDirection); 89 bool advanceFocusInDocumentOrder(FocusDirection, bool initialFocus); 90 91 Node* findFocusableNodeAcrossFocusScope(FocusDirection, FocusNavigationScope startScope, Node* start); 92 Node* findFocusableNodeRecursively(FocusDirection, FocusNavigationScope, Node* start); 93 Node* findFocusableNodeDecendingDownIntoFrameDocument(FocusDirection, Node*); 94 95 // Searches through the given tree scope, starting from start node, for the next/previous selectable element that comes after/before start node. 96 // The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab indexes 97 // first (from lowest to highest), and then elements without tab indexes (in document order). 98 // 99 // @param start The node from which to start searching. The node after this will be focused. May be null. 100 // 101 // @return The focus node that comes after/before start node. 102 // 103 // See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1 104 inline Node* findFocusableNode(FocusDirection, FocusNavigationScope, Node* start); 105 106 Node* nextFocusableNode(FocusNavigationScope, Node* start); 107 Node* previousFocusableNode(FocusNavigationScope, Node* start); 108 109 Node* findNodeWithExactTabIndex(Node* start, int tabIndex, FocusDirection); 110 111 bool advanceFocusDirectionallyInContainer(Node* container, const LayoutRect& startingRect, FocusDirection); 112 void findFocusCandidateInContainer(Node* container, const LayoutRect& startingRect, FocusDirection, FocusCandidate& closest); 113 114 Page* m_page; 115 RefPtr<Frame> m_focusedFrame; 116 bool m_isActive; 117 bool m_isFocused; 118 bool m_isChangingFocusedFrame; 119 bool m_containingWindowIsVisible; 120 121 }; 122 123 } // namespace WebCore 124 125 #endif // FocusController_h 126