OLD | NEW |
1 /* Copyright (c) 2010 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2010 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_C_DEV_PPB_SCROLLBAR_DEV_H_ | 5 #ifndef PPAPI_C_DEV_PPB_SCROLLBAR_DEV_H_ |
6 #define PPAPI_C_DEV_PPB_SCROLLBAR_DEV_H_ | 6 #define PPAPI_C_DEV_PPB_SCROLLBAR_DEV_H_ |
7 | 7 |
8 #include "ppapi/c/pp_bool.h" | 8 #include "ppapi/c/pp_bool.h" |
9 #include "ppapi/c/pp_instance.h" | 9 #include "ppapi/c/pp_instance.h" |
10 #include "ppapi/c/pp_macros.h" | 10 #include "ppapi/c/pp_macros.h" |
11 #include "ppapi/c/pp_resource.h" | 11 #include "ppapi/c/pp_resource.h" |
12 #include "ppapi/c/pp_stdint.h" | 12 #include "ppapi/c/pp_stdint.h" |
13 | 13 |
14 struct PP_Rect; | 14 struct PP_Rect; |
15 | 15 |
16 typedef enum { | 16 typedef enum { |
17 PP_SCROLLBY_PIXEL = 0, | 17 PP_SCROLLBY_PIXEL = 0, |
18 PP_SCROLLBY_LINE = 1, | 18 PP_SCROLLBY_LINE = 1, |
19 PP_SCROLLBY_PAGE = 2, | 19 PP_SCROLLBY_PAGE = 2, |
20 PP_SCROLLBY_DOCUMENT = 3 | 20 PP_SCROLLBY_DOCUMENT = 3 |
21 } PP_ScrollBy_Dev; | 21 } PP_ScrollBy_Dev; |
22 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_ScrollBy_Dev, 4); | 22 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_ScrollBy_Dev, 4); |
23 | 23 |
24 #define PPB_SCROLLBAR_DEV_INTERFACE_0_3 "PPB_Scrollbar(Dev);0.3" | 24 #define PPB_SCROLLBAR_DEV_INTERFACE_0_5 "PPB_Scrollbar(Dev);0.5" |
25 #define PPB_SCROLLBAR_DEV_INTERFACE_0_4 "PPB_Scrollbar(Dev);0.4" | 25 #define PPB_SCROLLBAR_DEV_INTERFACE PPB_SCROLLBAR_DEV_INTERFACE_0_5 |
26 #define PPB_SCROLLBAR_DEV_INTERFACE PPB_SCROLLBAR_DEV_INTERFACE_0_4 | |
27 | 26 |
28 // The interface for a scrollbar. A scrollbar is a widget, so the functions | 27 // The interface for a scrollbar. A scrollbar is a widget, so the functions |
29 // in PPB_Widget can also be used with scrollbar objects. | 28 // in PPB_Widget can also be used with scrollbar objects. |
30 struct PPB_Scrollbar_0_4_Dev { | 29 struct PPB_Scrollbar_Dev { |
31 // Create a new scrollbar. Returns 0 if the instance is invalid. | 30 // Create a new scrollbar. Returns 0 if the instance is invalid. |
32 PP_Resource (*Create)(PP_Instance instance, | 31 PP_Resource (*Create)(PP_Instance instance, |
| 32 PP_Instance scrollbar_group, |
33 PP_Bool vertical); | 33 PP_Bool vertical); |
34 | 34 |
35 // Returns PP_TRUE if the given resource is a Scrollbar. Returns PP_FALSE if | 35 // Returns PP_TRUE if the given resource is a Scrollbar. Returns PP_FALSE if |
36 // the resource is invalid or some type other than a scrollbar. | 36 // the resource is invalid or some type other than a scrollbar. |
37 PP_Bool (*IsScrollbar)(PP_Resource resource); | 37 PP_Bool (*IsScrollbar)(PP_Resource resource); |
38 | 38 |
39 // Gets the thickness of a scrollbar. | 39 // Gets the thickness of a scrollbar. |
40 uint32_t (*GetThickness)(PP_Resource resource); | 40 uint32_t (*GetThickness)(PP_Resource resource); |
41 | 41 |
| 42 // Returns PP_TRUE if the system scrollbar style is an overlap scrollbar. |
| 43 PP_Bool (*IsOverlay)(PP_Resource scrollbar); |
| 44 |
42 // Get/set the value of the scrollbar. | 45 // Get/set the value of the scrollbar. |
43 uint32_t (*GetValue)(PP_Resource scrollbar); | 46 uint32_t (*GetValue)(PP_Resource scrollbar); |
44 | 47 |
45 void (*SetValue)(PP_Resource scrollbar, | 48 void (*SetValue)(PP_Resource scrollbar, |
46 uint32_t value); | 49 uint32_t value); |
47 | 50 |
48 // Set the document size (i.e. total length of the region that's being | 51 // Set the document size (i.e. total length of the region that's being |
49 // scrolled). | 52 // scrolled). |
50 void (*SetDocumentSize)(PP_Resource scrollbar, | 53 void (*SetDocumentSize)(PP_Resource scrollbar, |
51 uint32_t size); | 54 uint32_t size); |
52 | 55 |
53 // Updates the tickmarks. Only valid for vertical scrollbars. "tick_marks" | 56 // Updates the tickmarks. Only valid for vertical scrollbars. "tick_marks" |
54 // contains "count" PP_Rect objects. | 57 // contains "count" PP_Rect objects. |
55 void (*SetTickMarks)(PP_Resource scrollbar, | 58 void (*SetTickMarks)(PP_Resource scrollbar, |
56 const struct PP_Rect* tick_marks, | 59 const struct PP_Rect* tick_marks, |
57 uint32_t count); | 60 uint32_t count); |
58 | 61 |
59 // Scroll by "multiplier" pixels/lines/pages units. Positive values are | 62 // Scroll by "multiplier" pixels/lines/pages units. Positive values are |
60 // forward and negative are backward. If "unit" is document then any positive | 63 // forward and negative are backward. If "unit" is document then any positive |
61 // value goes to the end while any negative value goes to the beginning. | 64 // value goes to the end while any negative value goes to the beginning. |
62 void (*ScrollBy)(PP_Resource scrollbar, | 65 void (*ScrollBy)(PP_Resource scrollbar, |
63 PP_ScrollBy_Dev unit, | 66 PP_ScrollBy_Dev unit, |
64 int32_t multiplier); | 67 int32_t multiplier); |
65 }; | 68 }; |
66 | 69 |
67 // Old version with no resource argument to GetThickness. | |
68 struct PPB_Scrollbar_0_3_Dev { | |
69 PP_Resource (*Create)(PP_Instance instance, | |
70 PP_Bool vertical); | |
71 PP_Bool (*IsScrollbar)(PP_Resource resource); | |
72 uint32_t (*GetThickness)(); | |
73 uint32_t (*GetValue)(PP_Resource scrollbar); | |
74 void (*SetValue)(PP_Resource scrollbar, | |
75 uint32_t value); | |
76 void (*SetDocumentSize)(PP_Resource scrollbar, | |
77 uint32_t size); | |
78 void (*SetTickMarks)(PP_Resource scrollbar, | |
79 const struct PP_Rect* tick_marks, | |
80 uint32_t count); | |
81 void (*ScrollBy)(PP_Resource scrollbar, | |
82 PP_ScrollBy_Dev unit, | |
83 int32_t multiplier); | |
84 }; | |
85 | |
86 typedef struct PPB_Scrollbar_0_4_Dev PPB_Scrollbar_Dev; | |
87 | |
88 #endif /* PPAPI_C_DEV_PPB_SCROLLBAR_DEV_H_ */ | 70 #endif /* PPAPI_C_DEV_PPB_SCROLLBAR_DEV_H_ */ |
89 | 71 |
OLD | NEW |