gesture_input_event_samsung.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Samsung Electronics, Visual Display Division.
 * All Rights Reserved.
 *
 * @author  Pawel Panek <p.panek@samsung.com>
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the Chromium-LICENSE file.
 */

#ifndef PPAPI_CPP_SAMSUNG_GESTURE_INPUT_EVENT_SAMSUNG_H_
#define PPAPI_CPP_SAMSUNG_GESTURE_INPUT_EVENT_SAMSUNG_H_

#include "ppapi/c/samsung/ppb_gesture_input_event_samsung.h"
#include "ppapi/cpp/input_event.h"

/// @file
/// This file defines the API used to handle gesture input events.

namespace pp {

class GestureInputEventSamsung : public InputEvent {
public:
  /// Constructs an is_null() gesture input event object.
  GestureInputEventSamsung();

  /// This constructor constructs a gesture input event object from the
  /// provided generic input event. If the given event is itself
  /// is_null() or is not a gesture input event, the gesture object will be
  /// is_null().
  ///
  /// @param[in] event A generic input event.
  explicit GestureInputEventSamsung(const InputEvent& event);

  /// Constructs a gesture input even from the given parameters.
  ///
  /// @param[in] instance The instance for which this event occured.
  ///
  /// @param[in] type 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 occured.
  ///
  /// @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.
  GestureInputEventSamsung(const InstanceHandle& instance,
                           PP_InputEvent_Type type,
                           PP_TimeTicks time_stamp,
                           uint32_t modifiers,
                           PP_Gesture_Type gesture_type);

  /// GetGestureType() returns the type of generated 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() const;
};

}  // namespace pp

#endif  // PPAPI_CPP_SAMSUNG_GESTURE_INPUT_EVENT_SAMSUNG_H_