ppb_gesture_input_event_samsung.h

Go to the documentation of this file.

/* Copyright (c) 2015 Samsung Electronics. All rights reserved.
 */

/* From samsung/ppb_gesture_input_event_samsung.idl,
 *   modified Thu Mar  5 09:49:54 2015.
 */

#ifndef PPAPI_C_SAMSUNG_PPB_GESTURE_INPUT_EVENT_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_GESTURE_INPUT_EVENT_SAMSUNG_H_

#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_time.h"
#include "ppapi/c/ppb_input_event.h"

#define PPB_GESTUREINPUTEVENT_SAMSUNG_INTERFACE_0_1 \
    "PPB_GestureInputEvent_Samsung;0.1"
#define PPB_GESTUREINPUTEVENT_SAMSUNG_INTERFACE \
    PPB_GESTUREINPUTEVENT_SAMSUNG_INTERFACE_0_1

/**
 * @file
 * This file defines the <code>PPB_GestureInputEvent_Samsung</code> interface.
 */


/**
 * @addtogroup Enums
 * @{
 */
/**
 * Hand gesture types.
 */
typedef enum {
  PP_GESTURETYPE_INVALID = 0,
  PP_GESTURETYPE_ZOOM = 1,
  PP_GESTURETYPE_ROTATE = 2,
  PP_GESTURETYPE_THUMB_UP = 3,
  PP_GESTURETYPE_SLAP_LEFT = 4,
  PP_GESTURETYPE_SLAP_RIGHT = 5,
  PP_GESTURETYPE_SLAP_UP = 6,
  PP_GESTURETYPE_SLAP_DOWN = 7,
  PP_GESTURETYPE_CIRCLE = 8,
  PP_GESTURETYPE_GRAB = 9,
  PP_GESTURETYPE_GRAB_MOVE = 10,
  PP_GESTURETYPE_UNGRAB = 11,
  PP_GESTURETYPE_MOVE = 12,
  PP_GESTURETYPE_SECONDARY_DETECT = 13,
  PP_GESTURETYPE_SECONDARY_LOST = 14,
  PP_GESTURETYPE_THUMB_UP_CANCEL = 15,
  PP_GESTURETYPE_PRIMARY_HAND_LOST = 16,
  PP_GESTURETYPE_SECOND_HAND_MOVE = 17,
  PP_GESTURETYPE_SECOND_HAND_GRAB_MOVE = 18,
  PP_GESTURETYPE_SECOND_HAND_GRAB = 19,
  PP_GESTURETYPE_SECOND_HAND_UNGRAB = 20
} PP_Gesture_Type;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Gesture_Type, 4);
/**
 * @}
 */

/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * The <code>PPB_GestureInputEvent_Samsung</code> interface allows handling
    gesture events.
 */
struct PPB_GestureInputEvent_Samsung_0_1 {
  /**
   * Creates a hand gesture input event. Normally
   * you will get a hand gesture 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 gesture 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] gesture_type A <code>PP_Hand_Gesture_Type</code> identifying
    gesture.
   *
   * @return A <code>PP_Resource</code> corresponding to a hand gesture
   * input event if successful, 0 if failed.
   */
  PP_Resource (*Create)(PP_Instance instance,
                        PP_InputEvent_Type type,
                        PP_TimeTicks time_stamp,
                        uint32_t modifiers,
                        PP_Gesture_Type gesture_type);
  /**
   * Determines if the given resource is a gesture event.
   *
   * @param[in] resource A <code>PP_Resource</code> containing a resource.
   *
   * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the given
   * resource is a gesture event, otherwise <code>PP_FALSE</code>.
   */
  PP_Bool (*IsGestureInputEvent)(PP_Resource resource);
  /**
   * GetGestureType() returns the type of generated gesture event.
   *
   * @param[in] gesture_event A <code>PP_Resource</code> corresponding to a
   * gesture event.
   *
   * @return The gesture type associated with event. This
   * value will be <code>PP_GESTURETYPE_INVALID</code>
   * for all non-gesture events.
   */
  PP_Gesture_Type (*GetGestureType)(PP_Resource gesture_event);
};

typedef struct PPB_GestureInputEvent_Samsung_0_1 PPB_GestureInputEvent_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_GESTURE_INPUT_EVENT_SAMSUNG_H_ */