code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/page/FocusController.h

   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 "LayoutTypes.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 Element;
  39 class Frame;
  40 class IntRect;
  41 class KeyboardEvent;
  42 class Node;
  43 class Page;
  44 class TreeScope;
  45
  46 class FocusController {
  47     WTF_MAKE_NONCOPYABLE(FocusController); WTF_MAKE_FAST_ALLOCATED;
  48 public:
  49     FocusController(Page*);
  50
  51     void setFocusedFrame(PassRefPtr<Frame>);
  52     Frame* focusedFrame() const { return m_focusedFrame.get(); }
  53     Frame* focusedOrMainFrame() const;
  54
  55     bool setInitialFocus(FocusDirection, KeyboardEvent*);
  56     bool advanceFocus(FocusDirection, KeyboardEvent*, bool initialFocus = false);
  57
  58     bool setFocusedNode(Node*, PassRefPtr<Frame>);
  59
  60     void setActive(bool);
  61     bool isActive() const { return m_isActive; }
  62
  63     void setFocused(bool);
  64     bool isFocused() const { return m_isFocused; }
  65
  66     bool transferFocusToElementInShadowRoot(Element* shadowHost, bool restorePreviousSelection);
  67
  68 private:
  69     bool advanceFocusDirectionally(FocusDirection, KeyboardEvent*);
  70     bool advanceFocusInDocumentOrder(FocusDirection, KeyboardEvent*, bool initialFocus);
  71
  72     Node* findFocusableNodeAcrossTreeScope(FocusDirection, TreeScope* startScope, Node* start, KeyboardEvent*);
  73     Node* findFocusableNodeDecendingDownIntoFrameDocumentOrShadowRoot(FocusDirection, Node*, KeyboardEvent*);
  74
  75     // Searches through the given tree scope, starting from start node, for the next/previous selectable element that comes after/before start node.
  76     // The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab indexes
  77     // first (from lowest to highest), and then elements without tab indexes (in document order).
  78     //
  79     // @param start The node from which to start searching. The node after this will be focused. May be null.
  80     //
  81     // @return The focus node that comes after/before start node.
  82     //
  83     // See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
  84     inline Node* findFocusableNode(FocusDirection, TreeScope*, Node* start, KeyboardEvent*);
  85
  86     Node* nextFocusableNode(TreeScope*, Node* start, KeyboardEvent*);
  87     Node* previousFocusableNode(TreeScope*, Node* start, KeyboardEvent*);
  88
  89     bool advanceFocusDirectionallyInContainer(Node* container, const LayoutRect& startingRect, FocusDirection, KeyboardEvent*);
  90     void findFocusCandidateInContainer(Node* container, const LayoutRect& startingRect, FocusDirection, KeyboardEvent*, FocusCandidate& closest);
  91
  92     Page* m_page;
  93     RefPtr<Frame> m_focusedFrame;
  94     bool m_isActive;
  95     bool m_isFocused;
  96     bool m_isChangingFocusedFrame;
  97
  98 };
  99
 100 } // namespace WebCore
 101
 102 #endif // FocusController_h