Release 4.0.0-preview1-00235
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Wheel.cs
index 23c8a65..286580a 100755 (executable)
@@ -19,7 +19,7 @@ namespace Tizen.NUI
 
     /// <summary>
     /// The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.<br>
-    /// There is a key modifier which relates to keys like alt, shift and control functions are supplied to check if they have been pressed when the wheel is being rolled.<br>
+    /// There is a key modifier which relates to keys like Alt, Shift, and Ctrl functions are supplied to check if they have been pressed when the wheel is being rolled.<br>
     /// We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.<br>
     /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.<br>
     /// </summary>
@@ -111,7 +111,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The type of the wheel event
+        /// The type of the wheel event.
         /// </summary>
         public Wheel.WheelType Type
         {
@@ -122,7 +122,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// he direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
+        /// The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
         /// </summary>
         public int Direction
         {
@@ -133,7 +133,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Modifier keys pressed during the event (such as shift, alt and control)
+        /// Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
         /// </summary>
         public uint Modifiers
         {
@@ -144,7 +144,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The co-ordinates of the cursor relative to the top-left of the screen
+        /// The coordinates of the cursor relative to the top-left of the screen.
         /// </summary>
         public Vector2 Point
         {
@@ -155,7 +155,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
+        /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
         /// </summary>
         public int Z
         {
@@ -166,7 +166,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The time the wheel is being rolled
+        /// The time the wheel is being rolled.
         /// </summary>
         public uint TimeStamp
         {
@@ -177,7 +177,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Default constructor.
+        /// The default constructor.
         /// </summary>
         public Wheel() : this(NDalicPINVOKE.new_Wheel__SWIG_0(), true)
         {
@@ -185,23 +185,23 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Constructor.
+        /// The constructor.
         /// </summary>
-        /// <param name="type">The type of the wheel event</param>
-        /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)</param>
-        /// <param name="modifiers">Modifier keys pressed during the event (such as shift, alt and control)</param>
-        /// <param name="point">The co-ordinates of the cursor relative to the top-left of the screen</param>
-        /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)</param>
-        /// <param name="timeStamp">The time the wheel is being rolled</param>
+        /// <param name="type">The type of the wheel event.</param>
+        /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).</param>
+        /// <param name="modifiers">Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).</param>
+        /// <param name="point">The coordinates of the cursor relative to the top-left of the screen.</param>
+        /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).</param>
+        /// <param name="timeStamp">The time the wheel is being rolled.</param>
         public Wheel(Wheel.WheelType type, int direction, uint modifiers, Vector2 point, int z, uint timeStamp) : this(NDalicPINVOKE.new_Wheel__SWIG_1((int)type, direction, modifiers, Vector2.getCPtr(point), z, timeStamp), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
         /// <summary>
-        /// Checks to see if Shift key modifier has been supplied.
+        /// Checks to see if the Shift key modifier has been supplied.
         /// </summary>
-        /// <returns>True if shift modifier</returns>
+        /// <returns>True if Shift modifier.</returns>
         public bool IsShiftModifier()
         {
             bool ret = NDalicPINVOKE.Wheel_IsShiftModifier(swigCPtr);
@@ -212,7 +212,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Checks to see if Ctrl (control) key modifier has been supplied.
         /// </summary>
-        /// <returns>True if ctrl modifier</returns>
+        /// <returns>True if Ctrl modifier.</returns>
         public bool IsCtrlModifier()
         {
             bool ret = NDalicPINVOKE.Wheel_IsCtrlModifier(swigCPtr);
@@ -223,7 +223,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Checks to see if Alt key modifier has been supplied.
         /// </summary>
-        /// <returns>True if alt modifier</returns>
+        /// <returns>True if Alt modifier.</returns>
         public bool IsAltModifier()
         {
             bool ret = NDalicPINVOKE.Wheel_IsAltModifier(swigCPtr);
@@ -323,7 +323,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The type of the wheel event
+        /// The type of the wheel event.
         /// </summary>
         public enum WheelType
         {