Pointer Lock handles disconnected DOM elements
[WebKit-https.git] / Source / WebCore / page / PointerLockController.h
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 #if ENABLE(POINTER_LOCK)
29
30 #include <wtf/RefPtr.h>
31 #include <wtf/text/AtomicString.h>
32
33 namespace WebCore {
34
35 class Element;
36 class Document;
37 class Page;
38 class PlatformMouseEvent;
39 class VoidCallback;
40
41 class PointerLockController {
42     WTF_MAKE_NONCOPYABLE(PointerLockController);
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     static PassOwnPtr<PointerLockController> create(Page*);
46
47     void requestPointerLock(Element* target, PassRefPtr<VoidCallback> successCallback, PassRefPtr<VoidCallback> failureCallback);
48     void requestPointerUnlock();
49     void elementRemoved(Element*);
50     void documentDetached(Document*);
51     bool isLocked(); // FIXME: Rename to isClientLocked and move to private when removing old API. (https://bugs.webkit.org/show_bug.cgi?id=84402)
52     Element* element() const;
53
54     void didAcquirePointerLock();
55     void didNotAcquirePointerLock();
56     void didLosePointerLock(bool sendChangeEvent = true); // FIXME: Remove sendChangeEvent parameter when removing old API. (https://bugs.webkit.org/show_bug.cgi?id=84402)
57     void dispatchLockedMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType);
58
59 private:
60     explicit PointerLockController(Page*);
61     void enqueueEvent(const AtomicString& type, Element*);
62     void enqueueEvent(const AtomicString& type, Document*);
63     Page* m_page;
64     RefPtr<Element> m_element;
65     RefPtr<Document> m_documentOfRemovedElementWhileWaitingForUnlock;
66
67     // FIXME: Remove callback usage. (https://bugs.webkit.org/show_bug.cgi?id=84402)
68     RefPtr<VoidCallback> m_successCallback;
69     RefPtr<VoidCallback> m_failureCallback;
70 };
71
72 } // namespace WebCore
73
74 #endif // ENABLE(POINTER_LOCK)
75
76 #endif // PointerLockController_h