Use modern construct 'using' instead of typedef.
[platform/core/uifw/dali-core.git] / dali / integration-api / events / multi-point-event-integ.h
index b5dd601..14007a8 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTEGRATION_MULTI_POINT_EVENT_H__
-#define __DALI_INTEGRATION_MULTI_POINT_EVENT_H__
+#ifndef DALI_INTEGRATION_MULTI_POINT_EVENT_H
+#define DALI_INTEGRATION_MULTI_POINT_EVENT_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 // INTERNAL INCLUDES
 #include <dali/public-api/common/vector-wrapper.h>
 #include <dali/integration-api/events/event.h>
-#include <dali/public-api/events/touch-point.h>
+#include <dali/integration-api/events/point.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 namespace Integration
 {
+using PointContainer              = std::vector<Point>;             ///< Container of points
+using PointContainerIterator      = PointContainer::iterator;       ///< Iterator for Dali::Integration::PointContainer
+using PointContainerConstIterator = PointContainer::const_iterator; ///< Const iterator for Dali::Integration::PointContainer
 
 /**
  * An instance of this structure should be used by the adaptor to send a multi-point event to Dali core.
@@ -35,7 +38,7 @@ namespace Integration
  * This class can contain one or multiple touch points. It also contains the time at which the
  * event occurred.
  */
-struct MultiPointEvent : public Event
+struct DALI_CORE_API MultiPointEvent : public Event
 {
   // Construction & Destruction
 
@@ -55,47 +58,51 @@ protected:
    * Constructor
    * @param[in]  time  The time the event occurred.
    */
-  MultiPointEvent(Type eventType, unsigned long time);
+  MultiPointEvent(Type eventType, uint32_t time);
 
 public:
+
   // Data
 
   /**
-   * @copydoc Dali::MultiPointEvent::points
+   * @brief A series of points
    */
-  std::vector<TouchPoint> points;
+  PointContainer points;
 
   /**
-   * @copydoc Dali::MultiPointEvent::time
+   * @brief The time
    */
-  unsigned long time;
+  uint32_t time;
 
   // Convenience Methods
 
   /**
-   * Adds a point to the MultiPointEvent.
+   * @brief Adds a point to the MultiPointEvent.
    * @param[in]  point  The point to add.
    */
-  void AddPoint(const TouchPoint& point);
+  void AddPoint( const Point& point );
 
   /**
-   * @copydoc Dali::MultiPointEvent::GetPoint()
+   * @brief Retrieves the Point at position point.
+   * @return The Point at position point.
    */
-  TouchPoint& GetPoint(unsigned int point);
+  Point& GetPoint( uint32_t point );
 
   /**
-   * @copydoc Dali::MultiPointEvent::GetPoint()
+   * @brief Retrieves a const ref of the Point at position point.
+   * @return The const ref of the Point at position point.
    */
-  const TouchPoint& GetPoint(unsigned int point) const;
+  const Point& GetPoint( uint32_t point ) const;
 
   /**
-   * @copydoc Dali::MultiPointEvent::GetPointCount() const
+   * @brief The total number of Points in this TouchEvent.
+   * @return The point count.
    */
-  unsigned int GetPointCount() const;
+  uint32_t GetPointCount() const;
 };
 
 } // namespace Integration
 
 } // namespace Dali
 
-#endif // __DALI_INTEGRATION_MULTI_POINT_EVENT_H__
+#endif // DALI_INTEGRATION_MULTI_POINT_EVENT_H