summaryrefslogtreecommitdiffstats
path: root/content/renderer/mouse_lock_dispatcher.h
diff options
context:
space:
mode:
authorscheib@chromium.org <scheib@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-01-27 07:33:11 +0000
committerscheib@chromium.org <scheib@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-01-27 07:33:11 +0000
commit217690df70c213c482039242dd935786c37dcd3c (patch)
tree8d0a579099bf69e51866cffb682c28ba44330b4f /content/renderer/mouse_lock_dispatcher.h
parent15f08dde26dbb02c8e4441492ab967cb48fcd4e4 (diff)
downloadchromium_src-217690df70c213c482039242dd935786c37dcd3c.zip
chromium_src-217690df70c213c482039242dd935786c37dcd3c.tar.gz
chromium_src-217690df70c213c482039242dd935786c37dcd3c.tar.bz2
Mouse Lock is currently supported in Pepper, but not yet supported from WebKit.
Move the render thread logic for managing the mouse lock state out of the pepper_plugin_delegate_impl, and into a higher level dispatcher for render_view_impl. Handle mouse lock / pointer lock requests from both pepper and webkit (WebKit API not yet landed, small TODOs left in this code to enable once that lands). BUG=109957 TEST=Pepper examples/mouse_lock and NaCl mouse lock examples still work. Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=119206 Review URL: http://codereview.chromium.org/8970016 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@119406 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'content/renderer/mouse_lock_dispatcher.h')
-rw-r--r--content/renderer/mouse_lock_dispatcher.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/content/renderer/mouse_lock_dispatcher.h b/content/renderer/mouse_lock_dispatcher.h
new file mode 100644
index 0000000..8035d09
--- /dev/null
+++ b/content/renderer/mouse_lock_dispatcher.h
@@ -0,0 +1,87 @@
+// Copyright (c) 2012 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 CONTENT_RENDERER_MOUSE_LOCK_DISPATCHER_H_
+#define CONTENT_RENDERER_MOUSE_LOCK_DISPATCHER_H_
+#pragma once
+
+#include "base/basictypes.h"
+#include "content/public/renderer/render_view_observer.h"
+
+class RenderViewImpl;
+
+namespace WebKit {
+class WebMouseEvent;
+class WebWidget;
+} // namespace WebKit
+
+namespace webkit{
+namespace ppapi {
+class PluginInstance;
+} // namespace ppapi
+} // namespace webkit
+
+// MouseLockDispatcher is owned by RenderViewImpl.
+class CONTENT_EXPORT MouseLockDispatcher : public content::RenderViewObserver {
+ public:
+ explicit MouseLockDispatcher(RenderViewImpl* render_view_impl);
+ virtual ~MouseLockDispatcher();
+
+ class LockTarget {
+ public:
+ virtual ~LockTarget() {}
+ // A mouse lock request was pending and this reports success or failure.
+ virtual void OnLockMouseACK(bool succeeded) = 0;
+ // A mouse lock was in place, but has been lost.
+ virtual void OnMouseLockLost() = 0;
+ // A mouse lock is enabled and mouse events are being delievered.
+ virtual bool HandleMouseLockedInputEvent(
+ const WebKit::WebMouseEvent& event) = 0;
+ };
+
+ // Locks the mouse to the |target|. If true is returned, an asynchronous
+ // response to target->OnLockMouseACK() will follow.
+ bool LockMouse(LockTarget* target);
+ // Request to unlock the mouse. An asynchronous response to
+ // target->OnMouseLockLost() will follow.
+ void UnlockMouse(LockTarget* target);
+ // Clears out the reference to the |target| because it has or is being
+ // destroyed. Unlocks if locked. The pointer will not be accessed.
+ void OnLockTargetDestroyed(LockTarget* target);
+ bool IsMouseLockedTo(LockTarget* target);
+
+ // Allow lock target to consumed a mouse event, if it does return true.
+ bool WillHandleMouseEvent(const WebKit::WebMouseEvent& event);
+
+ private:
+ // RenderView::Observer implementation.
+ virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
+
+ // IPC handlers.
+ void OnLockMouseACK(bool succeeded);
+ void OnMouseLockLost();
+
+ bool MouseLockedOrPendingAction() const {
+ return mouse_locked_ || pending_lock_request_ || pending_unlock_request_;
+ }
+
+ RenderViewImpl* render_view_impl_;
+
+ bool mouse_locked_;
+ // If both |pending_lock_request_| and |pending_unlock_request_| are true,
+ // it means a lock request was sent before an unlock request and we haven't
+ // received responses for them. The logic in LockMouse() makes sure that a
+ // lock request won't be sent when there is a pending unlock request.
+ bool pending_lock_request_;
+ bool pending_unlock_request_;
+
+ // |target_| is the pending or current owner of mouse lock. We retain a non
+ // owning reference here that must be cleared by |OnLockTargetDestroyed|
+ // when it is destroyed.
+ LockTarget* target_;
+
+ DISALLOW_COPY_AND_ASSIGN(MouseLockDispatcher);
+};
+
+#endif // CONTENT_RENDERER_MOUSE_LOCK_DISPATCHER_H_