summaryrefslogtreecommitdiffstats
path: root/ppapi/cpp/mouse_lock.h
diff options
context:
space:
mode:
authoryzshen@chromium.org <yzshen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-10-16 02:26:56 +0000
committeryzshen@chromium.org <yzshen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-10-16 02:26:56 +0000
commit1314f5f673e337ec559c973be90abf5db7ebf17e (patch)
tree4572a46d5c654645facd1595abeff44b7d6fd394 /ppapi/cpp/mouse_lock.h
parent7f26918a79ab8fd9ec095ccece9b3ba3002e6207 (diff)
downloadchromium_src-1314f5f673e337ec559c973be90abf5db7ebf17e.zip
chromium_src-1314f5f673e337ec559c973be90abf5db7ebf17e.tar.gz
chromium_src-1314f5f673e337ec559c973be90abf5db7ebf17e.tar.bz2
Move PPB/PPP_MouseLock out of dev/.
BUG=41781 TEST=None Review URL: http://codereview.chromium.org/8295023 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@105707 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/cpp/mouse_lock.h')
-rw-r--r--ppapi/cpp/mouse_lock.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/ppapi/cpp/mouse_lock.h b/ppapi/cpp/mouse_lock.h
new file mode 100644
index 0000000..b04c07c
--- /dev/null
+++ b/ppapi/cpp/mouse_lock.h
@@ -0,0 +1,56 @@
+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef PPAPI_CPP_MOUSE_LOCK_H_
+#define PPAPI_CPP_MOUSE_LOCK_H_
+
+#include "ppapi/c/pp_stdint.h"
+
+namespace pp {
+
+class CompletionCallback;
+class Instance;
+
+// This class allows you to associate the PPP_MouseLock and PPB_MouseLock
+// C-based interfaces with an object. It associates itself with the given
+// instance, and registers as the global handler for handling the PPP_MouseLock
+// interface that the browser calls.
+//
+// You would typically use this either via inheritance on your instance:
+// class MyInstance : public pp::Instance, public pp::MouseLock {
+// class MyInstance() : pp::MouseLock(this) {
+// }
+// ...
+// };
+//
+// or by composition:
+// class MyMouseLock : public pp::MouseLock {
+// ...
+// };
+//
+// class MyInstance : public pp::Instance {
+// MyInstance() : mouse_lock_(this) {
+// }
+//
+// MyMouseLock mouse_lock_;
+// };
+class MouseLock {
+ public:
+ explicit MouseLock(Instance* instance);
+ virtual ~MouseLock();
+
+ // PPP_MouseLock functions exposed as virtual functions for you to override.
+ virtual void MouseLockLost() = 0;
+
+ // PPB_MouseLock functions for you to call.
+ int32_t LockMouse(const CompletionCallback& cc);
+ void UnlockMouse();
+
+ private:
+ Instance* associated_instance_;
+};
+
+} // namespace pp
+
+#endif // PPAPI_CPP_MOUSE_LOCK_H_