WebCore/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 <wtf/Forward.h>
  31 #include <wtf/RefPtr.h>
  32
  33 namespace WebCore {
  34
  35     class Frame;
  36     class KeyboardEvent;
  37     class Node;
  38     class Page;
  39
  40     class FocusController {
  41     public:
  42         FocusController(Page*);
  43
  44         void setFocusedFrame(PassRefPtr<Frame>);
  45         Frame* focusedFrame() const { return m_focusedFrame.get(); }
  46         Frame* focusedOrMainFrame();
  47
  48         bool setInitialFocus(FocusDirection, KeyboardEvent*);
  49         bool advanceFocus(FocusDirection, KeyboardEvent*, bool initialFocus = false);
  50
  51         bool setFocusedNode(Node*, PassRefPtr<Frame>);
  52
  53         void setActive(bool);
  54         bool isActive() const { return m_isActive; }
  55
  56     private:
  57         Page* m_page;
  58         RefPtr<Frame> m_focusedFrame;
  59         bool m_isActive;
  60     };
  61
  62 } // namespace WebCore
  63
  64 #endif // FocusController_h