#include <ppb_input_event.h>

Collaboration diagram for PPB_WheelInputEvent_1_0:

Public Attributes
PP_Resource(*	Create )(PP_Instance instance, PP_TimeTicks time_stamp, uint32_t modifiers, const struct PP_FloatPoint wheel_delta, const struct PP_FloatPoint wheel_ticks, PP_Bool scroll_by_page)

PP_Bool(*	IsWheelInputEvent )(PP_Resource resource)

struct PP_FloatPoint(*	GetDelta )(PP_Resource wheel_event)

struct PP_FloatPoint(*	GetTicks )(PP_Resource wheel_event)

PP_Bool(*	GetScrollByPage )(PP_Resource wheel_event)

Detailed Description

The PPB_WheelIputEvent interface contains pointers to several functions related to wheel input events.

Definition at line 587 of file ppb_input_event.h.

Member Data Documentation

PP_Resource(* PPB_WheelInputEvent_1_0::Create)(PP_Instance instance, PP_TimeTicks time_stamp, uint32_t modifiers, const struct PP_FloatPoint *wheel_delta, const struct PP_FloatPoint *wheel_ticks, PP_Bool scroll_by_page)

Create() creates a wheel input event with the given parameters. Normally you will get a wheel event passed through the HandleInputEvent and will not need to create them, but some applications may want to create their own for internal use.

Parameters

[in]	instance	The instance for which this event occurred.
[in]	time_stamp	A `PP_TimeTicks` indicating the time when the event occurred.
[in]	modifiers	A bit field combination of the `PP_InputEvent_Modifier` flags.
[in]	wheel_delta	The scroll wheel's horizontal and vertical scroll amounts.
[in]	wheel_ticks	The number of "clicks" of the scroll wheel that have produced the event.
[in]	scroll_by_page	When true, the user is requesting to scroll by pages. When false, the user is requesting to scroll by lines.

Returns: A PP_Resource containing the new wheel input event.

Definition at line 613 of file ppb_input_event.h.

struct PP_FloatPoint(* PPB_WheelInputEvent_1_0::GetDelta)(PP_Resource wheel_event)

GetDelta() returns the amount vertically and horizontally the user has requested to scroll by with their mouse wheel. A scroll down or to the right (where the content moves up or left) is represented as positive values, and a scroll up or to the left (where the content moves down or right) is represented as negative values.

This amount is system dependent and will take into account the user's preferred scroll sensitivity and potentially also nonlinear acceleration based on the speed of the scrolling.

Devices will be of varying resolution. Some mice with large detents will only generate integer scroll amounts. But fractional values are also possible, for example, on some trackpads and newer mice that don't have "clicks".

Parameters

[in] wheel_event A PP_Resource corresponding to a wheel event.

Returns: The vertical and horizontal scroll values. The units are either in pixels (when scroll_by_page is false) or pages (when scroll_by_page is true). For example, y = -3 means scroll up 3 pixels when scroll_by_page is false, and scroll up 3 pages when scroll_by_page is true.

Definition at line 653 of file ppb_input_event.h.

PP_Bool(* PPB_WheelInputEvent_1_0::GetScrollByPage)(PP_Resource wheel_event)

GetScrollByPage() indicates if the scroll delta x/y indicates pages or lines to scroll by.

Parameters

[in] wheel_event A PP_Resource corresponding to a wheel event.

Returns: PP_TRUE if the event is a wheel event and the user is scrolling by pages. PP_FALSE if not or if the resource is not a wheel event.

Definition at line 688 of file ppb_input_event.h.

struct PP_FloatPoint(* PPB_WheelInputEvent_1_0::GetTicks)(PP_Resource wheel_event)

GetTicks() returns the number of "clicks" of the scroll wheel that have produced the event. The value may have system-specific acceleration applied to it, depending on the device. The positive and negative meanings are the same as for GetDelta().

If you are scrolling, you probably want to use the delta values. These tick events can be useful if you aren't doing actual scrolling and don't want or pixel values. An example may be cycling between different items in a game.

Parameters

[in] wheel_event A PP_Resource corresponding to a wheel event.

Returns: The number of "clicks" of the scroll wheel. You may receive fractional values for the wheel ticks if the mouse wheel is high resolution or doesn't have "clicks". If your program wants discrete events (as in the "picking items" example) you should accumulate fractional click values from multiple messages until the total value reaches positive or negative one. This should represent a similar amount of scrolling as for a mouse that has a discrete mouse wheel.

Definition at line 676 of file ppb_input_event.h.

PP_Bool(* PPB_WheelInputEvent_1_0::IsWheelInputEvent)(PP_Resource resource)

IsWheelInputEvent() determines if a resource is a wheel event.

Parameters

[in] wheel_event A PP_Resource corresponding to an event.

Returns: PP_TRUE if the given resource is a valid wheel input event.

Definition at line 628 of file ppb_input_event.h.

The documentation for this struct was generated from the following file:

ppb_input_event.h

Public Attributes

Detailed Description

Member Data Documentation