blob: 01e15a6679eb1725a1992fe3e1f6748eaa92e40b [file] [log] [blame]
// Copyright (c) 2013 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 <memory>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/observer_list.h"
#include "ui/aura/client/cursor_client.h"
#include "ui/base/cursor/cursor.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/wm/core/native_cursor_manager_delegate.h"
#include "ui/wm/wm_export.h"
namespace ui {
class KeyEvent;
namespace wm {
namespace internal {
class CursorState;
class NativeCursorManager;
// This class receives requests to change cursor properties, as well as
// requests to queue any further changes until a later time. It sends changes
// to the NativeCursorManager, which communicates back to us when these changes
// were made through the NativeCursorManagerDelegate interface.
class WM_EXPORT CursorManager : public aura::client::CursorClient,
public NativeCursorManagerDelegate {
explicit CursorManager(std::unique_ptr<NativeCursorManager> delegate);
~CursorManager() override;
// Resets the last visibility state, etc. Currently only called by tests.
static void ResetCursorVisibilityStateForTest();
// Overridden from aura::client::CursorClient:
void SetCursor(gfx::NativeCursor) override;
gfx::NativeCursor GetCursor() const override;
void ShowCursor() override;
void HideCursor() override;
bool IsCursorVisible() const override;
void SetCursorSet(ui::CursorSetType cursor_set) override;
ui::CursorSetType GetCursorSet() const override;
void EnableMouseEvents() override;
void DisableMouseEvents() override;
bool IsMouseEventsEnabled() const override;
void SetDisplay(const display::Display& display) override;
void LockCursor() override;
void UnlockCursor() override;
bool IsCursorLocked() const override;
void AddObserver(aura::client::CursorClientObserver* observer) override;
void RemoveObserver(aura::client::CursorClientObserver* observer) override;
bool ShouldHideCursorOnKeyEvent(const ui::KeyEvent& event) const override;
// Overridden from NativeCursorManagerDelegate:
void CommitCursor(gfx::NativeCursor cursor) override;
void CommitVisibility(bool visible) override;
void CommitCursorSet(ui::CursorSetType cursor_set) override;
void CommitMouseEventsEnabled(bool enabled) override;
std::unique_ptr<NativeCursorManager> delegate_;
// Number of times LockCursor() has been invoked without a corresponding
// UnlockCursor().
int cursor_lock_count_;
// The current state of the cursor.
std::unique_ptr<internal::CursorState> current_state_;
// The cursor state to restore when the cursor is unlocked.
std::unique_ptr<internal::CursorState> state_on_unlock_;
base::ObserverList<aura::client::CursorClientObserver> observers_;
// This flag holds the cursor visibility state for the duration of the
// process. Defaults to true. This flag helps ensure that when a
// CursorManager instance is created it gets populated with the correct
// cursor visibility state.
static bool last_cursor_visibility_state_;
} // namespace wm