Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / PanGesture.cs
index aac9b00..8e92e3d 100755 (executable)
@@ -1,30 +1,31 @@
-/** Copyright (c) 2017 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.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 namespace Tizen.NUI
 {
 
     /// <summary>
-    /// A PanGesture is emitted when the user moves one or more fingers in a particular direction.<br>
-    /// A pan gesture will end in the following ways:<br>
-    /// - User releases the primary finger (the first touch).<br>
-    /// - User has more fingers on the screen than the maximum specified.<br>
-    /// - User has less fingers on the screen than the minimum specified.<br>
-    /// - Cancelled by the system.<br>
-    /// A pan gesture will continue to be sent to the actor under than initial pan until it ends.<br>
+    /// A PanGesture is emitted when the user moves one or more fingers in a particular direction.<br />
+    /// A pan gesture will end in the following ways:<br />
+    /// - User releases the primary finger (the first touch).<br />
+    /// - User has more fingers on the screen than the maximum specified.<br />
+    /// - User has less fingers on the screen than the minimum specified.<br />
+    /// - Cancelled by the system.<br />
+    /// A pan gesture will continue to be sent to the actor under than initial pan until it ends.<br />
     /// </summary>
     public class PanGesture : Gesture
     {
@@ -40,6 +41,10 @@ namespace Tizen.NUI
             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if(disposed)
@@ -80,10 +85,10 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The velocity at which the user is moving their fingers.<br>
-        /// This is represented as a Vector2 and is the pixel movement per millisecond.<br>
-        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
-        /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br>
+        /// The velocity at which the user is moving their fingers.<br />
+        /// This is represented as a Vector2 and is the pixel movement per millisecond.<br />
+        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+        /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public Vector2 Velocity
@@ -96,9 +101,9 @@ namespace Tizen.NUI
 
         /// <summary>
         /// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
-        /// if the gesture has just started, then the amount panned since the user touched the screen.<br>
-        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
-        /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br>
+        /// if the gesture has just started, then the amount panned since the user touched the screen.<br />
+        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+        /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public Vector2 Displacement
@@ -122,11 +127,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The velocity at which the user is moving their fingers.<br>
-        /// This is represented as a Vector2 and is the pixel movement per millisecond.<br>
-        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
-        /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br>
-        /// This value represents the screen coordinates.<br>
+        /// The velocity at which the user is moving their fingers.<br />
+        /// This is represented as a Vector2 and is the pixel movement per millisecond.<br />
+        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+        /// A positive y value shows that the user is panning downwards, a negative y values means upwards.<br />
+        /// This value represents the screen coordinates.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public Vector2 ScreenVelocity
@@ -139,10 +144,10 @@ namespace Tizen.NUI
 
         /// <summary>
         /// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
-        /// if the gesture has just started, then the amount panned since the user touched the screen.<br>
-        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br>
-        /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br>
-        /// This value is in screen coordinates.<br>
+        /// if the gesture has just started, then the amount panned since the user touched the screen.<br />
+        /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.<br />
+        /// A positive y value shows that the user is panning downwards, a negative y value means upwards.<br />
+        /// This value is in screen coordinates.<br />
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public Vector2 ScreenDisplacement
@@ -308,8 +313,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Returns the speed at which the user is moving their fingers.<br>
-        /// This is the pixel movement per millisecond.<br>
+        /// Returns the speed at which the user is moving their fingers.<br />
+        /// This is the pixel movement per millisecond.<br />
         /// </summary>
         /// <returns>The speed of the pan (in pixels per millisecond).</returns>
         /// <since_tizen> 3 </since_tizen>
@@ -322,8 +327,8 @@ namespace Tizen.NUI
 
         /// <summary>
         /// Returns the distance the user has panned (dragged) since the last pan gesture or,
-        /// if the gesture has just started, then the distance moved since the user touched the screen.<br>
-        /// This is always a positive value.<br>
+        /// if the gesture has just started, then the distance moved since the user touched the screen.<br />
+        /// This is always a positive value.<br />
         /// </summary>
         /// <returns>The distance, as a float, a user's finger has panned.</returns>
         /// <since_tizen> 3 </since_tizen>
@@ -335,8 +340,8 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Returns the speed at which the user is moving their fingers relative to screen coordinates.<br>
-        /// This is the pixel movement per millisecond.<br>
+        /// Returns the speed at which the user is moving their fingers relative to screen coordinates.<br />
+        /// This is the pixel movement per millisecond.<br />
         /// </summary>
         /// <returns>The speed of the pan (in pixels per millisecond).</returns>
         /// <since_tizen> 3 </since_tizen>
@@ -350,8 +355,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Returns the distance the user has panned (dragged) since the last pan gesture in screen
         /// coordinates or, if the gesture has just started, then the distance in screen coordinates moved
-        /// since the user touched the screen.<br>
-        /// This is always a positive value.<br>
+        /// since the user touched the screen.<br />
+        /// This is always a positive value.<br />
         /// </summary>
         /// <returns>The distance, as a float, a user's finger has panned.</returns>
         /// <since_tizen> 3 </since_tizen>