summaryrefslogtreecommitdiffstats
path: root/webkit/glue/webcursor.h
blob: fd693f86fe582abe5d63db7fb708fcb562a21ba5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef WEBCURSOR_H__
#define WEBCURSOR_H__

#include "skia/include/SkBitmap.h"

// This class provides the functionality of a generic cursor type. The intent
// is to stay away from platform specific code here. We do have win32 specific
// functionality to retreive a HCURSOR from a cursor type. 
// TODO(iyengar) : Win32 specific functionality needs to be taken out of this 
// object
class WebCursor 
{
public:
  // Supported cursor types.
  enum Type {
    ARROW,
    IBEAM,
    WAIT,
    CROSS,
    UPARROW,
    SIZE,
    ICON,
    SIZENWSE,
    SIZENESW,
    SIZEWE,
    SIZENS,
    SIZEALL,
    NO,
    HAND,
    APPSTARTING,
    HELP,
    ALIAS,
    CELL,
    COLRESIZE,
    COPYCUR,
    ROWRESIZE,
    VERTICALTEXT,
    ZOOMIN,
    ZOOMOUT,
    CUSTOM
  };

  WebCursor();
  WebCursor(Type cursor_type);
  WebCursor(const SkBitmap* bitmap, int hotspot_x, int hotspot_y);
  ~WebCursor();

  WebCursor(const WebCursor& other);
  WebCursor& operator = (const WebCursor&);

  Type type() const { return type_; };
  int hotspot_x() const { return hotspot_x_; }
  int hotspot_y() const { return hotspot_y_; }
  const SkBitmap& bitmap() const { return bitmap_; }

  void set_type(Type cursor_type) {
    type_ = cursor_type;
  }

  void set_bitmap(const SkBitmap& bitmap) {
    bitmap_ = bitmap;
  }

  void set_hotspot(int hotspot_x, int hotspot_y) {
    hotspot_x_ = hotspot_x;
    hotspot_y_ = hotspot_x;
  }

  // Returns the cursor handle. If the cursor type is a win32 or safari
  // cursor, we use LoadCursor to load the cursor. 
  // Returns NULL on error. 
  HCURSOR GetCursor(HINSTANCE module_handle) const;
  // If the underlying cursor type is a custom cursor, this function converts
  // the SkBitmap to a cursor and returns the same. The responsiblity of
  // freeing the cursor handle lies with the caller.
  // Returns NULL on error.
  HCURSOR GetCustomCursor() const;
  // Returns true if the passed in SkBitmap is the same as the the 
  // current SkBitmap. We use memcmp to compare the two bitmaps.
  bool IsSameBitmap(const SkBitmap& bitmap) const;

  // Returns true if the current cursor object contains the same
  // cursor as the cursor object passed in. If the current cursor
  // is a custom cursor, we also compare the bitmaps to verify
  // whether they are equal.
  bool IsEqual(const WebCursor& other) const;
  
protected:
  Type type_;
  int hotspot_x_;
  int hotspot_y_;
  SkBitmap bitmap_;
};

#endif  // WEBCURSOR_H__