Add movement information to PPB_MouseInputEvent.

ppapi/c/ppb_input_event.h

 /* Copyright (c) 2011 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.
  */
 
 /* From ppb_input_event.idl modified Wed Aug 17 11:16:34 2011. */
 
 #ifndef PPAPI_C_PPB_INPUT_EVENT_H_
 #define PPAPI_C_PPB_INPUT_EVENT_H_
 
 #include "ppapi/c/pp_bool.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/c/pp_macros.h"
 #include "ppapi/c/pp_point.h"
 #include "ppapi/c/pp_resource.h"
 #include "ppapi/c/pp_stdint.h"
 #include "ppapi/c/pp_time.h"
 #include "ppapi/c/pp_var.h"
 
 #define PPB_INPUT_EVENT_INTERFACE_1_0 "PPB_InputEvent;1.0"
 #define PPB_INPUT_EVENT_INTERFACE PPB_INPUT_EVENT_INTERFACE_1_0
 
 #define PPB_MOUSE_INPUT_EVENT_INTERFACE_1_0 "PPB_MouseInputEvent;1.0"
-#define PPB_MOUSE_INPUT_EVENT_INTERFACE PPB_MOUSE_INPUT_EVENT_INTERFACE_1_0
+#define PPB_MOUSE_INPUT_EVENT_INTERFACE_1_1 "PPB_MouseInputEvent;1.1"

[brettw, 2011/08/24 20:55:09]

What are we doing with the IDL for this? I don't see any IDL changes.

+#define PPB_MOUSE_INPUT_EVENT_INTERFACE PPB_MOUSE_INPUT_EVENT_INTERFACE_1_1
 
 #define PPB_WHEEL_INPUT_EVENT_INTERFACE_1_0 "PPB_WheelInputEvent;1.0"
 #define PPB_WHEEL_INPUT_EVENT_INTERFACE PPB_WHEEL_INPUT_EVENT_INTERFACE_1_0
 
 #define PPB_KEYBOARD_INPUT_EVENT_INTERFACE_1_0 "PPB_KeyboardInputEvent;1.0"
 #define PPB_KEYBOARD_INPUT_EVENT_INTERFACE \
     PPB_KEYBOARD_INPUT_EVENT_INTERFACE_1_0
 
 /**
  * @file
@@ skipping 342 matching lines @@
    * @return The modifiers associated with the event, or 0 if the given
    * resource is not a valid event resource.
    */
   uint32_t (*GetModifiers)(PP_Resource event);
 };
 
 /**
  * The <code>PPB_MouseInputEvent</code> interface contains pointers to several
  * functions related to mouse input events.
  */
-struct PPB_MouseInputEvent {
+struct PPB_MouseInputEvent_1_0 {
   /**
    * Create() creates a mouse input event with the given parameters. Normally

[brettw, 2011/08/24 22:47:49]

Lets remove the comments from the functions in the 1_0 interface struct so it's
just all the functions smooshed together. I'm worried about somebody updating
the documentation and being confused or updating only one place.

[yzshen1, 2011/08/24 23:22:01]

Done.

    * you will get a mouse event passed through the
    * <code>HandleInputEvent</code> and will not need to create them, but some
    * applications may want to create their own for internal use. The type must
    * be one of the mouse event types.
    *
    * @param[in] instance The instance for which this event occurred.
    *
    * @param[in] type A <code>PP_InputEvent_Type</code> identifying the type of
    * input event.
    *
@@ skipping 50 matching lines @@
    * left of the instance receiving the event. These values can be negative for
    * mouse drags. The return value will be (0, 0) for non-mouse events.
    */
   struct PP_Point (*GetPosition)(PP_Resource mouse_event);
   /**
    * TODO(brettw) figure out exactly what this means.
    */
   int32_t (*GetClickCount)(PP_Resource mouse_event);
 };
 
+struct PPB_MouseInputEvent {

[brettw, 2011/08/24 20:55:09]

Since we're updating the interface, can you email pepper-dev and point to the
additions?

+  /**
+   * Create() creates a mouse input event with the given parameters. Normally
+   * you will get a mouse event passed through the
+   * <code>HandleInputEvent</code> and will not need to create them, but some
+   * applications may want to create their own for internal use. The type must
+   * be one of the mouse event types.
+   *
+   * @param[in] instance The instance for which this event occurred.
+   *
+   * @param[in] type A <code>PP_InputEvent_Type</code> identifying the type of
+   * input event.
+   *
+   * @param[in] time_stamp A <code>PP_TimeTicks</code> indicating the time
+   * when the event occurred.
+   *
+   * @param[in] modifiers A bit field combination of the
+   * <code>PP_InputEvent_Modifier</code> flags.
+   *
+   * @param[in] mouse_button The button that changed for mouse down or up
+   * events. This value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for
+   * mouse move, enter, and leave events.
+   *
+   * @param[in] mouse_position A <code>Point</code> containing the x and y
+   * position of the mouse when the event occurred.
+   *
+   * @param[in] mouse_movement The change in position of the mouse.
+   *
+   * @return A <code>PP_Resource</code> containing the new mouse input event.
+   */
+  PP_Resource (*Create)(PP_Instance instance,
+                        PP_InputEvent_Type type,
+                        PP_TimeTicks time_stamp,
+                        uint32_t modifiers,
+                        PP_InputEvent_MouseButton mouse_button,
+                        const struct PP_Point* mouse_position,
+                        int32_t click_count,
+                        const struct PP_Point* mouse_movement);
+  /**
+   * IsMouseInputEvent() determines if a resource is a mouse event.
+   *
+   * @param[in] resource A <code>PP_Resource</code> containing the event.
+   *
+   * @return <code>PP_TRUE</code> if the given resource is a valid mouse input
+   * event, otherwise <code>PP_FALSE</code>.
+   */
+  PP_Bool (*IsMouseInputEvent)(PP_Resource resource);
+  /**
+   * GetButton() returns the mouse button that generated a mouse down or up
+   * event.
+   *
+   * @param[in] mouse_event A <code>PP_Resource</code> containing the mouse
+   * event.
+   *
+   * @return The mouse button associated with mouse down and up events. This
+   * value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move,
+   * enter, and leave events, and for all non-mouse events.
+   */
+  PP_InputEvent_MouseButton (*GetButton)(PP_Resource mouse_event);
+  /**
+   * GetPosition() returns the pixel location of a mouse input event. When
+   * the cursor lock is enabled, it returns the center of the associated plugin
+   * instance.
+   *
+   * @param[in] mouse_event A <code>PP_Resource</code> containing the mouse
+   * event.
+   *
+   * @return The point associated with the mouse event, relative to the upper-
+   * left of the instance receiving the event. These values can be negative for
+   * mouse drags. The return value will be (0, 0) for non-mouse events.
+   */
+  struct PP_Point (*GetPosition)(PP_Resource mouse_event);
+  /**
+   * TODO(brettw) figure out exactly what this means.
+   */
+  int32_t (*GetClickCount)(PP_Resource mouse_event);
+  /**
+   * Returns the change in position of the mouse. When the cursor lock is
+   * enabled, although the mouse position doesn't actually change, this function
+   * continues to provide movement information as when the cursor is unlocked.
+   *
+   * @return The change in position of the mouse, relative to the previous
+   * position.
+   */
+  struct PP_Point (*GetMovement)(PP_Resource mouse_event);
+};
+
 /**
  * The <code>PPB_WheelIputEvent</code> interface contains pointers to several
  * functions related to wheel input events.
  */
 struct PPB_WheelInputEvent {
   /**
    * Create() creates a wheel input event with the given parameters. Normally
    * you will get a wheel event passed through the
    * <code>HandleInputEvent</code> and will not need to create them, but some
    * applications may want to create their own for internal use.
@@ skipping 162 matching lines @@
    * undefined var.
    */
   struct PP_Var (*GetCharacterText)(PP_Resource character_event);
 };
 /**
  * @}
  */
 
 #endif  /* PPAPI_C_PPB_INPUT_EVENT_H_ */