Release 4.0.0-preview1-00301

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Gesture.cs

diff --git a/src/Tizen.NUI/src/public/Gesture.cs b/src/Tizen.NUI/src/public/Gesture.cs
index dffb5e2..eceb770 100755 (executable)
--- a/src/Tizen.NUI/src/public/Gesture.cs
+++ b/src/Tizen.NUI/src/public/Gesture.cs
@@ -1,30 +1,34 @@
-/** 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>
-    /// Base structure for different gestures that an application can receive.<br>
+    /// Base structure for different gestures that an application can receive.<br />
     /// A Gesture is an event that is produced from a combination of several touch events
-    /// in a particular order or within a certain time frame (for example, pinch).<br>
+    /// in a particular order or within a certain time frame (for example, pinch).<br />
     /// </summary>
     public class Gesture : global::System.IDisposable
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+        /// <summary>
+        /// swigCMemOwn.
+        /// </summary>
         protected bool swigCMemOwn;
 
         internal Gesture(global::System.IntPtr cPtr, bool cMemoryOwn)
@@ -40,9 +44,15 @@ namespace Tizen.NUI
 
         //A Flag to check who called Dispose(). (By User or DisposeQueue)
         private bool isDisposeQueued = false;
-        //A Flat to check if it is already disposed.
+        /// <summary>
+        /// A Flat to check if it is already disposed.
+        /// </summary>
         protected bool disposed = false;
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         ~Gesture()
         {
             if(!isDisposeQueued)
@@ -75,6 +85,10 @@ namespace Tizen.NUI
             }
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -203,9 +217,25 @@ namespace Tizen.NUI
         /// <since_tizen> 3 </since_tizen>
         public enum GestureType
         {
+            /// <summary>
+            /// When two touch points move away or towards each other.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Pinch = 1 << 0,
+            /// <summary>
+            /// When the user drags their finger(s) in a particular direction.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Pan = 1 << 1,
+            /// <summary>
+            /// When the user taps the screen.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Tap = 1 << 2,
+            /// <summary>
+            ///  When the user continues to touch the same area on the screen for the device configured time.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             LongPress = 1 << 3
         }
 
@@ -215,11 +245,35 @@ namespace Tizen.NUI
         /// <since_tizen> 3 </since_tizen>
         public enum StateType
         {
+            /// <summary>
+            /// There is no state associated with this gesture.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Clear,
+            /// <summary>
+            /// The touched points on the screen have moved enough to be considered a gesture.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Started,
+            /// <summary>
+            /// The gesture is continuing.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Continuing,
+            /// <summary>
+            /// The user has lifted a finger or touched an additional point on the screen.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Finished,
+            /// <summary>
+            /// The gesture has been cancelled.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Cancelled,
+            /// <summary>
+            ///  A gesture is possible.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Possible
         }