blob: a835fdd5abf7bc5dc0b21c4be5ceaa4d451e89c3 [file] [log] [blame]
// Copyright (c) 2017 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.
#include <map>
#include "content/common/content_export.h"
#include "content/common/cursors/webcursor.h"
namespace content {
class RenderWidgetHostViewBase;
// CursorManager coordinates mouse cursors for multiple RenderWidgetHostViews
// on a single page. It is owned by the top-level RenderWidgetHostView and
// calls back to its DisplayCursor method when the cursor needs to change,
// either because the mouse moved over a different view or because a cursor
// update was received for the current view.
class CONTENT_EXPORT CursorManager {
class TooltipObserver {
virtual ~TooltipObserver() {}
virtual void OnSetTooltipTextForView(
const RenderWidgetHostViewBase* view,
const base::string16& tooltip_text) = 0;
CursorManager(RenderWidgetHostViewBase* root);
// Called for any RenderWidgetHostView that received an UpdateCursor message
// from its renderer process.
void UpdateCursor(RenderWidgetHostViewBase*, const WebCursor&);
// Called when the mouse moves over a different RenderWidgetHostView.
void UpdateViewUnderCursor(RenderWidgetHostViewBase*);
// Accepts TooltipText updates from views, but only updates what's displayed
// if the requesting view is currently under the mouse cursor.
void SetTooltipTextForView(const RenderWidgetHostViewBase* view,
const base::string16& tooltip_text);
// Notification of a RenderWidgetHostView being destroyed, so that its
// cursor map entry can be removed if it has one. If it is the current
// view_under_cursor_, then the root_view_'s cursor will be displayed.
void ViewBeingDestroyed(RenderWidgetHostViewBase*);
// Accessor for browser tests, enabling verification of the cursor_map_.
// Returns false if the provided View is not in the map, and outputs
// the cursor otherwise.
bool GetCursorForTesting(RenderWidgetHostViewBase*, WebCursor&);
void SetTooltipObserverForTesting(TooltipObserver* observer);
// Stores the last received cursor from each RenderWidgetHostView.
std::map<RenderWidgetHostViewBase*, WebCursor> cursor_map_;
// The view currently underneath the cursor, which corresponds to the cursor
// currently displayed.
RenderWidgetHostViewBase* view_under_cursor_;
// The root view is the target for DisplayCursor calls whenever the active
// cursor needs to change.
RenderWidgetHostViewBase* root_view_;
TooltipObserver* tooltip_observer_for_testing_;
} // namespace content