Home | History | Annotate | Download | only in page
      1 /*
      2  * Copyright (C) 2012 Google 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 INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     23  */
     24 
     25 #ifndef PointerLockController_h
     26 #define PointerLockController_h
     27 
     28 #include "wtf/RefPtr.h"
     29 #include "wtf/text/AtomicString.h"
     30 
     31 namespace WebCore {
     32 
     33 class Element;
     34 class Document;
     35 class Page;
     36 class PlatformMouseEvent;
     37 class VoidCallback;
     38 
     39 class PointerLockController {
     40     WTF_MAKE_NONCOPYABLE(PointerLockController);
     41     WTF_MAKE_FAST_ALLOCATED;
     42 public:
     43     static PassOwnPtr<PointerLockController> create(Page*);
     44 
     45     void requestPointerLock(Element* target);
     46     void requestPointerUnlock();
     47     void elementRemoved(Element*);
     48     void documentDetached(Document*);
     49     bool lockPending() const;
     50     Element* element() const;
     51 
     52     void didAcquirePointerLock();
     53     void didNotAcquirePointerLock();
     54     void didLosePointerLock();
     55     void dispatchLockedMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType);
     56 
     57 private:
     58     explicit PointerLockController(Page*);
     59     void clearElement();
     60     void enqueueEvent(const AtomicString& type, Element*);
     61     void enqueueEvent(const AtomicString& type, Document*);
     62     Page* m_page;
     63     bool m_lockPending;
     64     RefPtr<Element> m_element;
     65     RefPtr<Document> m_documentOfRemovedElementWhileWaitingForUnlock;
     66 };
     67 
     68 } // namespace WebCore
     69 
     70 #endif // PointerLockController_h
     71