Source/WebCore/page/PointerLock.h

   1 /*
   2  * Copyright (C) 2011 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 PointerLock_h
  26 #define PointerLock_h
  27
  28 #if ENABLE(POINTER_LOCK)
  29
  30 #include "DOMWindowProperty.h"
  31 #include "VoidCallback.h"
  32 #include <wtf/PassRefPtr.h>
  33 #include <wtf/RefCounted.h>
  34
  35 namespace WebCore {
  36
  37 class Element;
  38 class Frame;
  39 class PointerLockController;
  40
  41 class PointerLock : public RefCounted<PointerLock>, public DOMWindowProperty {
  42 public:
  43     static PassRefPtr<PointerLock> create(Frame* frame) { return adoptRef(new PointerLock(frame)); }
  44
  45     ~PointerLock();
  46
  47     // DOMWindowProperty Interface
  48     virtual void disconnectFrameForPageCache() OVERRIDE;
  49     virtual void willDestroyGlobalObjectInFrame() OVERRIDE;
  50
  51     void lock(Element* target, PassRefPtr<VoidCallback> successCallback, PassRefPtr<VoidCallback> failureCallback);
  52     void unlock();
  53     bool isLocked();
  54
  55 private:
  56     explicit PointerLock(Frame*);
  57
  58     PointerLockController* m_controller;
  59 };
  60
  61 } // namespace WebCore
  62
  63 #endif // ENABLE(POINTER_LOCK)
  64
  65 #endif // PointerLock_h
  66