Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(613)

Side by Side Diff: ppapi/cpp/mouse_cursor.h

Issue 13220002: [PPAPI] Fix a bunch of spelling mistakes (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « ppapi/cpp/module.h ('k') | ppapi/cpp/point.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef PPAPI_CPP_MOUSE_CURSOR_H_ 5 #ifndef PPAPI_CPP_MOUSE_CURSOR_H_
6 #define PPAPI_CPP_MOUSE_CURSOR_H_ 6 #define PPAPI_CPP_MOUSE_CURSOR_H_
7 7
8 #include "ppapi/c/ppb_mouse_cursor.h" 8 #include "ppapi/c/ppb_mouse_cursor.h"
9 #include "ppapi/cpp/image_data.h" 9 #include "ppapi/cpp/image_data.h"
10 #include "ppapi/cpp/instance_handle.h" 10 #include "ppapi/cpp/instance_handle.h"
11 #include "ppapi/cpp/point.h" 11 #include "ppapi/cpp/point.h"
12 12
13 namespace pp { 13 namespace pp {
14 14
15 class MouseCursor { 15 class MouseCursor {
16 public: 16 public:
17 /// Sets the given mouse cursor. The mouse cursor will be in effect whenever 17 /// Sets the given mouse cursor. The mouse cursor will be in effect whenever
18 /// the mouse is over the given instance until it is set again by another 18 /// the mouse is over the given instance until it is set again by another
19 /// call. Note that you can hide the mouse cursor by setting it to the 19 /// call. Note that you can hide the mouse cursor by setting it to the
20 /// <code>PP_MOUSECURSOR_TYPE_NONE</code> type. 20 /// <code>PP_MOUSECURSOR_TYPE_NONE</code> type.
21 /// 21 ///
22 /// This function allows setting both system defined mouse cursors and 22 /// This function allows setting both system defined mouse cursors and
23 /// custom cursors. To set a system-defined cursor, pass the type you want 23 /// custom cursors. To set a system-defined cursor, pass the type you want
24 /// and set the custom image to a default-constructor ImageData object. 24 /// and set the custom image to a default-constructor ImageData object.
25 /// To set a custom cursor, set the type to 25 /// To set a custom cursor, set the type to
26 /// <code>PP_MOUSECURSOR_TYPE_CUSTOM</code> and specify your image and hot 26 /// <code>PP_MOUSECURSOR_TYPE_CUSTOM</code> and specify your image and hot
27 /// spot. 27 /// spot.
28 /// 28 ///
29 /// @param[in] instance A handle indentifying the instance that the mouse 29 /// @param[in] instance A handle identifying the instance that the mouse
30 /// cursor will affect. 30 /// cursor will affect.
31 /// 31 ///
32 /// @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type 32 /// @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type
33 /// of mouse cursor to show. See <code>ppapi/c/ppb_mouse_cursor.h</code>. 33 /// of mouse cursor to show. See <code>ppapi/c/ppb_mouse_cursor.h</code>.
34 /// 34 ///
35 /// @param[in] image A <code>ImageData</code> object identifying the 35 /// @param[in] image A <code>ImageData</code> object identifying the
36 /// custom image to set when the type is 36 /// custom image to set when the type is
37 /// <code>PP_MOUSECURSOR_TYPE_CUSTOM</code>. The image must be less than 32 37 /// <code>PP_MOUSECURSOR_TYPE_CUSTOM</code>. The image must be less than 32
38 /// pixels in each direction and must be of the system's native image format. 38 /// pixels in each direction and must be of the system's native image format.
39 /// When you are specifying a predefined cursor, this parameter should be a 39 /// When you are specifying a predefined cursor, this parameter should be a
40 /// default-constructed ImageData. 40 /// default-constructed ImageData.
41 /// 41 ///
42 /// @param[in] hot_spot When setting a custom cursor, this idenfifies the 42 /// @param[in] hot_spot When setting a custom cursor, this identifies the
43 /// pixel position within the given image of the "hot spot" of the cursor. 43 /// pixel position within the given image of the "hot spot" of the cursor.
44 /// When specifying a stock cursor, this parameter is ignored. 44 /// When specifying a stock cursor, this parameter is ignored.
45 /// 45 ///
46 /// @return true on success, or false if the instance or cursor type 46 /// @return true on success, or false if the instance or cursor type
47 /// was invalid or if the image was too large. 47 /// was invalid or if the image was too large.
48 static bool SetCursor(const InstanceHandle& instance, 48 static bool SetCursor(const InstanceHandle& instance,
49 PP_MouseCursor_Type type, 49 PP_MouseCursor_Type type,
50 const ImageData& image = ImageData(), 50 const ImageData& image = ImageData(),
51 const Point& hot_spot = Point(0, 0)); 51 const Point& hot_spot = Point(0, 0));
52 }; 52 };
53 53
54 } // namespace pp 54 } // namespace pp
55 55
56 #endif // PPAPI_CPP_MOUSE_CURSOR_H_ 56 #endif // PPAPI_CPP_MOUSE_CURSOR_H_
OLDNEW
« no previous file with comments | « ppapi/cpp/module.h ('k') | ppapi/cpp/point.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698