ui/base/cursor/cursor.h

// 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 UI_BASE_CURSOR_CURSOR_H_
#define UI_BASE_CURSOR_CURSOR_H_

#include "build/build_config.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/cursor/cursor_type.h"
#include "ui/base/ui_base_export.h"
#include "ui/gfx/geometry/point.h"

#if defined(OS_WIN)
typedef struct HINSTANCE__* HINSTANCE;
typedef struct HICON__* HICON;
typedef HICON HCURSOR;
#endif

namespace ui {

#if defined(OS_WIN)
typedef ::HCURSOR PlatformCursor;
#elif defined(USE_X11)
typedef unsigned long PlatformCursor;
#else
typedef void* PlatformCursor;
#endif

// Ref-counted cursor that supports both default and custom cursors.
class UI_BASE_EXPORT Cursor {
 public:
  Cursor();

  // Implicit constructor.
  Cursor(CursorType type);

  // Allow copy.
  Cursor(const Cursor& cursor);

  ~Cursor();

  void SetPlatformCursor(const PlatformCursor& platform);

  void RefCustomCursor();
  void UnrefCustomCursor();

  CursorType native_type() const { return native_type_; }
  PlatformCursor platform() const { return platform_cursor_; }
  float device_scale_factor() const {
    return device_scale_factor_;
  }
  void set_device_scale_factor(float device_scale_factor) {
    device_scale_factor_ = device_scale_factor;
  }

  SkBitmap GetBitmap() const;
  void set_custom_bitmap(const SkBitmap& bitmap) { custom_bitmap_ = bitmap; }

  gfx::Point GetHotspot() const;
  void set_custom_hotspot(const gfx::Point& hotspot) {
    custom_hotspot_ = hotspot;
  }

  bool operator==(CursorType type) const { return native_type_ == type; }
  bool operator==(const Cursor& cursor) const {
    return native_type_ == cursor.native_type_ &&
           platform_cursor_ == cursor.platform_cursor_ &&
           device_scale_factor_ == cursor.device_scale_factor_ &&
           custom_bitmap_.info() == cursor.custom_bitmap_.info() &&
           custom_bitmap_.rowBytes() == cursor.custom_bitmap_.rowBytes() &&
           custom_bitmap_.getPixels() == cursor.custom_bitmap_.getPixels() &&
           custom_hotspot_ == cursor.custom_hotspot_;
  }
  bool operator!=(CursorType type) const { return native_type_ != type; }
  bool operator!=(const Cursor& cursor) const {
    return native_type_ != cursor.native_type_ ||
           platform_cursor_ != cursor.platform_cursor_ ||
           device_scale_factor_ != cursor.device_scale_factor_ ||
           custom_bitmap_.info() != cursor.custom_bitmap_.info() ||
           custom_bitmap_.rowBytes() != cursor.custom_bitmap_.rowBytes() ||
           custom_bitmap_.getPixels() != cursor.custom_bitmap_.getPixels() ||
           custom_hotspot_ != cursor.custom_hotspot_;
  }

  void operator=(const Cursor& cursor) {
    Assign(cursor);
  }

  // Checks if the data in |rhs| was created from the same input data.
  //
  // This is subtly different from operator==, as we need this to be a
  // lightweight operation instead of performing pixel equality checks on
  // arbitrary sized SkBitmaps. So we check the internal SkBitmap generation
  // IDs, which are per-process, monotonically increasing ids which get changed
  // whenever there's a modification to the pixel data. This means that this
  // method can have false negatives: two SkBitmap instances made with the same
  // input data (but which weren't copied from each other) can have equal pixel
  // data, but different generation ids.
  bool IsSameAs(const Cursor& rhs) const;

 private:
  void Assign(const Cursor& cursor);

#if defined(USE_AURA)
  SkBitmap GetDefaultBitmap() const;
  gfx::Point GetDefaultHotspot() const;
#endif

  // See definitions above.
  CursorType native_type_;

  PlatformCursor platform_cursor_;

  // The device scale factor for the cursor.
  float device_scale_factor_;

  // The bitmap for the cursor. This is only used when it is custom cursor type.
  SkBitmap custom_bitmap_;

  // The hotspot for the cursor. This is only used when it is custom cursor
  // type.
  gfx::Point custom_hotspot_;
};

}  // namespace ui

#endif  // UI_BASE_CURSOR_CURSOR_H_