From 069f2c8c2a3c6f75a213052fd09f8c5042a22ddf Mon Sep 17 00:00:00 2001 From: "dongsug.song" Date: Thu, 16 Mar 2017 13:33:40 +0900 Subject: [PATCH] Add comments by Ms.Seoyeon Kim Signed-off-by: dongsug.song Change-Id: I6781ba22767cb144106c302498a9683a0bab0009 --- Tizen.NUI/src/public/CustomView.cs | 48 +++++++++--------- Tizen.NUI/src/public/Degree.cs | 15 ++++++ Tizen.NUI/src/public/FlexContainer.cs | 11 +++++ Tizen.NUI/src/public/Gesture.cs | 29 +++++++++++ Tizen.NUI/src/public/Hover.cs | 46 ++++++++++++++++++ Tizen.NUI/src/public/ImageView.cs | 38 +++++++++++++++ Tizen.NUI/src/public/Key.cs | 45 +++++++++++++++++ Tizen.NUI/src/public/KeyFrames.cs | 41 +++++++++++++++- Tizen.NUI/src/public/Layer.cs | 61 +++++++++++++++++++++++ Tizen.NUI/src/public/LongPressGesture.cs | 29 +++++++++++ Tizen.NUI/src/public/PanGesture.cs | 83 ++++++++++++++++++++++++++++++++ 11 files changed, 422 insertions(+), 24 deletions(-) diff --git a/Tizen.NUI/src/public/CustomView.cs b/Tizen.NUI/src/public/CustomView.cs index 303ac18..3a85b1f 100755 --- a/Tizen.NUI/src/public/CustomView.cs +++ b/Tizen.NUI/src/public/CustomView.cs @@ -17,6 +17,9 @@ namespace Tizen.NUI { + /// + /// CustomView provides some common functionality required by all views. + /// public class CustomView : ViewWrapper { public CustomView(string typeName, CustomViewBehaviour behaviour) : base(typeName, new ViewWrapperImpl(behaviour)) @@ -70,11 +73,10 @@ namespace Tizen.NUI SetStyleName(this.GetType().Name); } - /** - * @brief Set the background with a property map. - * - * @param[in] map The background property map. - */ + /// + /// Set the background with a property map. + /// + /// The background property map public void SetBackground(Tizen.NUI.PropertyMap map) { viewWrapperImpl.SetBackground(map); @@ -106,15 +108,12 @@ namespace Tizen.NUI viewWrapperImpl.DisableGestureDetection(type); } - /** - * @brief Sets whether this control supports two dimensional - * keyboard navigation (i.e. whether it knows how to handle the - * keyboard focus movement between its child actors). - * - * The control doesn't support it by default. - * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. - */ - + /// + /// Sets whether this control supports two dimensional keyboard navigation + /// (i.e. whether it knows how to handle the keyboard focus movement between its child actors). + /// The control doesn't support it by default. + /// + /// Whether this control supports two dimensional keyboard navigation. public bool FocusNavigationSupport { get @@ -144,6 +143,10 @@ namespace Tizen.NUI } + /// + /// Sets or Gets whether this control is a focus group for keyboard navigation. + /// + /// true if this control is set as a focus group for keyboard navigation public bool FocusGroup { get @@ -187,20 +190,19 @@ namespace Tizen.NUI viewWrapperImpl.AccessibilityActivate(); } - /** - * @brief Called by the KeyboardFocusManager. - */ + /// + /// Called by the KeyboardFocusManager. + /// public void KeyboardEnter() { viewWrapperImpl.KeyboardEnter(); } - /** - * @brief Called by the KeyInputFocusManager to emit key event signals. - * - * @param[in] key The key event. - * @return True if the event was consumed. - */ + /// + /// Called by the KeyInputFocusManager to emit key event signals. + /// + /// The key event + /// True if the event was consumed public bool EmitKeyEventSignal(Key key) { return viewWrapperImpl.EmitKeyEventSignal(key); diff --git a/Tizen.NUI/src/public/Degree.cs b/Tizen.NUI/src/public/Degree.cs index fc8175a..184c062 100755 --- a/Tizen.NUI/src/public/Degree.cs +++ b/Tizen.NUI/src/public/Degree.cs @@ -11,6 +11,10 @@ namespace Tizen.NUI { + /// + /// An angle in degrees. + /// This reduces ambiguity when using methods which accept angles in degrees or radians. + /// public class Degree : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -56,16 +60,27 @@ namespace Tizen.NUI } + /// + /// Constructor. + /// public Degree() : this(NDalicPINVOKE.new_Degree__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an angle in degrees. + /// + /// The initial value in degrees public Degree(float value) : this(NDalicPINVOKE.new_Degree__SWIG_1(value), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an angle in degrees from a Radian. + /// + /// The initial value in Radians public Degree(Radian value) : this(NDalicPINVOKE.new_Degree__SWIG_2(Radian.getCPtr(value)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); diff --git a/Tizen.NUI/src/public/FlexContainer.cs b/Tizen.NUI/src/public/FlexContainer.cs index a5df86d..54f451d 100755 --- a/Tizen.NUI/src/public/FlexContainer.cs +++ b/Tizen.NUI/src/public/FlexContainer.cs @@ -123,6 +123,9 @@ namespace Tizen.NUI } + /// + /// Enumeration for the instance of child properties belonging to the FlexContainer class. + /// public class ChildProperty : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -172,6 +175,10 @@ namespace Tizen.NUI } + /// + /// Creates a FlexContainer handle. + /// Calling member functions with an uninitialized handle is not allowed. + /// public FlexContainer() : this(NDalicPINVOKE.FlexContainer_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -208,6 +215,10 @@ namespace Tizen.NUI RowReverse } + /// + /// Enumeration for the primary direction in which content is ordered in the flex container + /// and on which sides the ?œstart??and ?œend??are. + /// public enum ContentDirectionType { Inherit, diff --git a/Tizen.NUI/src/public/Gesture.cs b/Tizen.NUI/src/public/Gesture.cs index 6437d1c..e618442 100755 --- a/Tizen.NUI/src/public/Gesture.cs +++ b/Tizen.NUI/src/public/Gesture.cs @@ -11,6 +11,11 @@ namespace Tizen.NUI { + /// + /// Base structure for different gestures that an application can receive. + /// 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 (e.g pinch). + /// public class Gesture : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -56,6 +61,9 @@ namespace Tizen.NUI } + /// + /// The gesture type. + /// public Gesture.GestureType Type { get @@ -64,6 +72,9 @@ namespace Tizen.NUI } } + /// + /// The gesture state. + /// public Gesture.StateType State { get @@ -72,6 +83,9 @@ namespace Tizen.NUI } } + /// + /// The time the gesture took place. + /// public uint Time { get @@ -80,11 +94,20 @@ namespace Tizen.NUI } } + /// + /// Copy constructor. + /// + /// A reference to the copied handle public Gesture(Gesture rhs) : this(NDalicPINVOKE.new_Gesture(Gesture.getCPtr(rhs)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Assignment operator. + /// + /// A reference to the copied handle + /// A reference to this public Gesture Assign(Gesture rhs) { Gesture ret = new Gesture(NDalicPINVOKE.Gesture_Assign(swigCPtr, Gesture.getCPtr(rhs)), false); @@ -137,6 +160,9 @@ namespace Tizen.NUI } } + /// + /// Enumeration for type of gesture + /// public enum GestureType { Pinch = 1 << 0, @@ -145,6 +171,9 @@ namespace Tizen.NUI LongPress = 1 << 3 } + /// + /// Enumeration for state of the gesture. + /// public enum StateType { Clear, diff --git a/Tizen.NUI/src/public/Hover.cs b/Tizen.NUI/src/public/Hover.cs index 387ff57..ba47a69 100755 --- a/Tizen.NUI/src/public/Hover.cs +++ b/Tizen.NUI/src/public/Hover.cs @@ -11,6 +11,11 @@ namespace Tizen.NUI { + /// + /// Hover events are a collection of points at a specific moment in time. + /// When a multi event occurs, each point represents the points that are currently being + /// hovered or the points where a hover has stopped. + /// public class Hover : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -63,6 +68,9 @@ namespace Tizen.NUI return ret; } + /// + /// The time (in ms) that the hover event occurred. + /// public uint Time { get @@ -71,6 +79,13 @@ namespace Tizen.NUI } } + /// + /// Returns the ID of the device used for the Point specified. + /// Each point has a unique device ID which specifies the device used for that + /// point. This is returned by this method. + /// + /// The point required + /// The Device ID of this poin public int GetDeviceId(uint point) { if (point < points.Count) @@ -80,6 +95,11 @@ namespace Tizen.NUI return -1; } + /// + /// Retrieves the State of the point specified. + /// + /// The point required + /// The state of the point specified public PointStateType GetState(uint point) { if (point < points.Count) @@ -89,6 +109,11 @@ namespace Tizen.NUI return PointStateType.Finished; } + /// + /// Retrieves the actor that was underneath the point specified. + /// + /// The point required + /// The actor that was underneath the point specified public Actor GetHitActor(uint point) { if (point < points.Count) @@ -104,6 +129,11 @@ namespace Tizen.NUI } } + /// + /// Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified. + /// + /// The point required + /// The co-ordinates relative to the top-left of the hit-actor of the point specified public Vector2 GetLocalPosition(uint point) { if (point < points.Count) @@ -113,6 +143,11 @@ namespace Tizen.NUI return new Vector2(0.0f, 0.0f); } + /// + /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified. + /// + /// The point required + /// The co-ordinates relative to the top-left of the screen of the point specified public Vector2 GetScreenPosition(uint point) { if (point < points.Count) @@ -122,11 +157,18 @@ namespace Tizen.NUI return new Vector2(0.0f, 0.0f); } + /// + /// Default constructor. + /// public Hover() : this(NDalicPINVOKE.new_Hover__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// + /// The time the event occurred public Hover(uint time) : this(NDalicPINVOKE.new_Hover__SWIG_1(time), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -163,6 +205,10 @@ namespace Tizen.NUI } } + /// + /// Returns the total number of points. + /// + /// Total number of Points public uint GetPointCount() { uint ret = NDalicPINVOKE.Hover_GetPointCount(swigCPtr); diff --git a/Tizen.NUI/src/public/ImageView.cs b/Tizen.NUI/src/public/ImageView.cs index c099417..64c5aaa 100755 --- a/Tizen.NUI/src/public/ImageView.cs +++ b/Tizen.NUI/src/public/ImageView.cs @@ -27,6 +27,10 @@ namespace Tizen.NUI { + /// + /// ImageView is a class for displaying an image resource. + /// An instance of ImageView can be created using a URL or an Image instance. + /// public class ImageView : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -121,11 +125,19 @@ namespace Tizen.NUI } + /// + /// Creates an initialized ImageView. + /// public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an initialized ImageView from an URL to an image resource. + /// If the string is empty, ImageView will not display anything. + /// + /// The url of the image resource to display public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -146,12 +158,24 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } + /// + /// Downcasts a handle to ImageView handle. + /// If handle points to a ImageView, the downcast produces valid handle. + /// If not, the returned handle is left uninitialized. + /// + /// Handle to an object + /// Handle to a ImageView or an uninitialized handle public new static ImageView DownCast(BaseHandle handle) { ImageView ret = new ImageView(NDalicPINVOKE.ImageView_DownCast(BaseHandle.getCPtr(handle)), true); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } + /// + /// Sets this ImageView from the given URL. + /// If the URL is empty, ImageView will not display anything. + /// + /// The URL to the image resource to display public void SetImage(string url) { NDalicPINVOKE.ImageView_SetImage__SWIG_1(swigCPtr, url); @@ -170,6 +194,9 @@ namespace Tizen.NUI ANIMATABLE_PROPERTY_END_INDEX = PropertyRanges.ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 } + /// + /// ImageView ResourceUrl, type string + /// public string ResourceUrl { get @@ -183,6 +210,9 @@ namespace Tizen.NUI SetProperty(ImageView.Property.RESOURCE_URL, new Tizen.NUI.PropertyValue(value)); } } + /// + /// ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise + /// public PropertyMap ImageMap { get @@ -196,6 +226,10 @@ namespace Tizen.NUI SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// ImageView PreMultipliedAlpha, type Boolean + /// Image must be initialized. + /// public bool PreMultipliedAlpha { get @@ -209,6 +243,10 @@ namespace Tizen.NUI SetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value)); } } + /// + /// ImageView PixelArea, type Vector4 (Animatable property) + /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. + /// public Vector4 PixelArea { get diff --git a/Tizen.NUI/src/public/Key.cs b/Tizen.NUI/src/public/Key.cs index da716a5..9e71aeb 100755 --- a/Tizen.NUI/src/public/Key.cs +++ b/Tizen.NUI/src/public/Key.cs @@ -11,6 +11,9 @@ namespace Tizen.NUI { + /// + /// The key structure is used to store a key press. + /// public class Key : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -63,6 +66,9 @@ namespace Tizen.NUI return ret; } + /// + /// Name given to the key pressed + /// public string KeyPressedName { get @@ -81,6 +87,9 @@ namespace Tizen.NUI } */ + /// + /// Keycode for the key pressed. + /// public int KeyCode { get @@ -89,6 +98,9 @@ namespace Tizen.NUI } } + /// + /// Special keys like shift, alt and control which modify the next key pressed. + /// public int KeyModifier { get @@ -97,6 +109,9 @@ namespace Tizen.NUI } } + /// + /// The time (in ms) that the key event occurred. + /// public uint Time { get @@ -105,6 +120,9 @@ namespace Tizen.NUI } } + /// + /// State of the key event. + /// public Key.StateType State { get @@ -113,16 +131,32 @@ namespace Tizen.NUI } } + /// + /// Default Constructor. + /// public Key() : this(NDalicPINVOKE.new_Key__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// + /// The name of the key pressed or command from the IMF, if later then the some following parameters will be needed + /// A string of input characters or key pressed + /// The unique key code for the key pressed + /// The key modifier for special keys like shift and alt + /// The time (in ms) that the key event occurred + /// The state of the key event public Key(string keyName, string keyString, int keyCode, int keyModifier, uint timeStamp, Key.StateType keyState) : this(NDalicPINVOKE.new_Key__SWIG_1(keyName, keyString, keyCode, keyModifier, timeStamp, (int)keyState), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Checks to see if Shift key modifier has been supplied. + /// + /// True if shift modifier public bool IsShiftModifier() { bool ret = NDalicPINVOKE.Key_IsShiftModifier(swigCPtr); @@ -130,6 +164,10 @@ namespace Tizen.NUI return ret; } + /// + /// Checks to see if Ctrl (control) key modifier has been supplied. + /// + /// True if ctrl modifier public bool IsCtrlModifier() { bool ret = NDalicPINVOKE.Key_IsCtrlModifier(swigCPtr); @@ -137,6 +175,10 @@ namespace Tizen.NUI return ret; } + /// + /// Checks to see if Alt key modifier has been supplied. + /// + /// True if alt modifier public bool IsAltModifier() { bool ret = NDalicPINVOKE.Key_IsAltModifier(swigCPtr); @@ -234,6 +276,9 @@ namespace Tizen.NUI } } + /// + /// Enumeration for specifying the state of the key event. + /// public enum StateType { Down, diff --git a/Tizen.NUI/src/public/KeyFrames.cs b/Tizen.NUI/src/public/KeyFrames.cs index c270306..0c1d63a 100755 --- a/Tizen.NUI/src/public/KeyFrames.cs +++ b/Tizen.NUI/src/public/KeyFrames.cs @@ -27,6 +27,10 @@ namespace Tizen.NUI { + /// + /// A set of key frames for a property that can be animated using Dali Animation. + /// This allows the generation of key frame objects from individual Property::Values. + /// public class KeyFrames : BaseHandle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -72,24 +76,44 @@ namespace Tizen.NUI + /// + /// Adds a key frame. + /// + /// A progress value between 0.0 and 1.0 + /// A value public void Add(float progress, object value) { dynamic obj = value; Add(progress, new PropertyValue(obj)); } + /// + /// Adds a key frame. + /// + /// A progress value between 0.0 and 1.0 + /// A value + /// The alpha function used to blend to the next keyframe public void Add(float progress, object value, AlphaFunction alpha) { dynamic obj = value; Add(progress, new PropertyValue(obj), alpha); } - + /// + /// Creates an initialized KeyFrames handle. + /// public KeyFrames() : this(NDalicPINVOKE.KeyFrames_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Downcasts a handle to KeyFrames handle. + /// If handle points to a KeyFrames object, the downcast produces valid handle. + /// If not, the returned handle is left uninitialized. + /// + /// Handle to an object + /// Handle to a KeyFrames object or an uninitialized handle public static KeyFrames DownCast(BaseHandle handle) { KeyFrames ret = new KeyFrames(NDalicPINVOKE.KeyFrames_DownCast(BaseHandle.getCPtr(handle)), true); @@ -109,6 +133,10 @@ namespace Tizen.NUI return ret; } + /// + /// Gets the type of the key frame. + /// + /// The key frame property type public PropertyType GetType() { PropertyType ret = (PropertyType)NDalicPINVOKE.KeyFrames_GetType(swigCPtr); @@ -116,12 +144,23 @@ namespace Tizen.NUI return ret; } + /// + /// Adds a key frame. + /// + /// A progress value between 0.0 and 1.0 + /// A value public void Add(float progress, PropertyValue value) { NDalicPINVOKE.KeyFrames_Add__SWIG_0(swigCPtr, progress, PropertyValue.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Adds a key frame. + /// + /// A progress value between 0.0 and 1.0 + /// A value + /// The alpha function used to blend to the next keyframe public void Add(float progress, PropertyValue value, AlphaFunction alpha) { NDalicPINVOKE.KeyFrames_Add__SWIG_1(swigCPtr, progress, PropertyValue.getCPtr(value), AlphaFunction.getCPtr(alpha)); diff --git a/Tizen.NUI/src/public/Layer.cs b/Tizen.NUI/src/public/Layer.cs index 77a23f8..f5a323a 100755 --- a/Tizen.NUI/src/public/Layer.cs +++ b/Tizen.NUI/src/public/Layer.cs @@ -27,6 +27,9 @@ namespace Tizen.NUI { + /// + /// Layers provide a mechanism for overlaying groups of actors on top of each other. + /// public class Layer : Actor { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -120,11 +123,21 @@ namespace Tizen.NUI } + /// + /// Creates a Layer object. + /// public Layer() : this(NDalicPINVOKE.Layer_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Downcasts a handle to Layer handle. + /// If handle points to a Layer, the downcast produces valid handle. + /// If not, the returned handle is left uninitialized. + /// + /// Handle to an object + /// Handle to a Layer or an uninitialized handle public new static Layer DownCast(BaseHandle handle) { Layer ret = new Layer(NDalicPINVOKE.Layer_DownCast(BaseHandle.getCPtr(handle)), true); @@ -144,6 +157,10 @@ namespace Tizen.NUI return ret; } + /// + /// Queries the depth of the layer. + /// 0 is the bottom most layer, higher number is on top. + /// public uint Depth { get @@ -159,12 +176,18 @@ namespace Tizen.NUI return ret; } + /// + /// Increments the depth of the layer. + /// public void Raise() { NDalicPINVOKE.Layer_Raise(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Decrements the depth of the layer. + /// public void Lower() { NDalicPINVOKE.Layer_Lower(swigCPtr); @@ -183,24 +206,40 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Raises the layer to the top. + /// public void RaiseToTop() { NDalicPINVOKE.Layer_RaiseToTop(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Lowers the layer to the bottom. + /// public void LowerToBottom() { NDalicPINVOKE.Layer_LowerToBottom(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Moves the layer directly above the given layer. + /// After the call, this layers depth will be immediately above target. + /// + /// Layer to get on top of public void MoveAbove(Layer target) { NDalicPINVOKE.Layer_MoveAbove(swigCPtr, Layer.getCPtr(target)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Moves the layer directly below the given layer + /// After the call, this layers depth will be immediately below target. + /// + /// Layer to get below of public void MoveBelow(Layer target) { NDalicPINVOKE.Layer_MoveBelow(swigCPtr, Layer.getCPtr(target)); @@ -239,12 +278,22 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Sets the clipping box of a layer, in window coordinates. + /// The contents of the layer will not be visible outside this box, when clipping is + /// enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped. + /// + /// The clipping box public void SetClippingBox(Rectangle box) { NDalicPINVOKE.Layer_SetClippingBox__SWIG_1(swigCPtr, Rectangle.getCPtr(box)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the clipping box of a layer in window coordinates. + /// + /// The clipping box public Rectangle GetClippingBox() { Rectangle ret = new Rectangle(NDalicPINVOKE.Layer_GetClippingBox(swigCPtr), true); @@ -297,6 +346,9 @@ namespace Tizen.NUI return ret; } + /// + /// Enumeration for the behavior of the layer. + /// public enum LayerBehavior { Layer2D, @@ -309,6 +361,9 @@ namespace Tizen.NUI TREE_DEPTH_MULTIPLIER = 10000 } + /// + /// Layer ClippingEnable, type bool + /// public bool ClippingEnable { get @@ -322,6 +377,9 @@ namespace Tizen.NUI SetProperty(Layer.Property.CLIPPING_ENABLE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Layer ClippingBox, type Rectangle + /// public Rectangle ClippingBox { get @@ -335,6 +393,9 @@ namespace Tizen.NUI SetProperty(Layer.Property.CLIPPING_BOX, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Layer Behavior, type String(Layer.LayerBehavior) + /// public Layer.LayerBehavior Behavior { get diff --git a/Tizen.NUI/src/public/LongPressGesture.cs b/Tizen.NUI/src/public/LongPressGesture.cs index ac613a8..678d03b 100755 --- a/Tizen.NUI/src/public/LongPressGesture.cs +++ b/Tizen.NUI/src/public/LongPressGesture.cs @@ -11,6 +11,10 @@ namespace Tizen.NUI { + /// + /// A LongPressGesture is emitted when the user holds the screen with the stated number of fingers. + /// Long press gesture finishes when all touches have been released. + /// public class LongPressGesture : Gesture { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -62,6 +66,10 @@ namespace Tizen.NUI return ret; } + /// + /// The number of touch points in this long press gesture, i.e. the number of fingers the user had + /// on the screen to generate the long press gesture. + /// public uint NumberOfTouches { get @@ -70,6 +78,10 @@ namespace Tizen.NUI } } + /// + /// This is the point, in screen coordinates, where the long press occurred. + /// If a multi-touch long press, then this is the centroid of all the touch points. + /// public Vector2 ScreenPoint { get @@ -78,6 +90,10 @@ namespace Tizen.NUI } } + /// + /// This is the point, in local actor coordinates, where the long press occurred. + /// If a multi-touch long press, then this is the centroid of all the touch points. + /// public Vector2 LocalPoint { get @@ -86,16 +102,29 @@ namespace Tizen.NUI } } + /// + /// Constructor. + /// + /// The state of the gesture public LongPressGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_LongPressGesture__SWIG_0((int)state), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Copy constructor. + /// + /// A reference to the copied handle public LongPressGesture(LongPressGesture rhs) : this(NDalicPINVOKE.new_LongPressGesture__SWIG_1(LongPressGesture.getCPtr(rhs)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Assignment operator. + /// + /// A reference to the copied handle + /// A reference to this public LongPressGesture Assign(LongPressGesture rhs) { LongPressGesture ret = new LongPressGesture(NDalicPINVOKE.LongPressGesture_Assign(swigCPtr, LongPressGesture.getCPtr(rhs)), false); diff --git a/Tizen.NUI/src/public/PanGesture.cs b/Tizen.NUI/src/public/PanGesture.cs index 34f6648..4a7e6f7 100755 --- a/Tizen.NUI/src/public/PanGesture.cs +++ b/Tizen.NUI/src/public/PanGesture.cs @@ -11,6 +11,15 @@ namespace Tizen.NUI { + /// + /// A PanGesture is emitted when the user moves one or more fingers in a particular direction. + /// A pan gesture will end in the following ways: + /// - User releases the primary finger (the first touch). + /// - User has more fingers on the screen than the maximum specified. + /// - User has less fingers on the screen than the minimum specified. + /// - Cancelled by the system. + /// A pan gesture will continue to be sent to the actor under than initial pan until it ends. + /// public class PanGesture : Gesture { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -62,6 +71,12 @@ namespace Tizen.NUI return ret; } + /// + /// The velocity at which the user is moving their fingers. + /// This is represented as a Vector2 and is the pixel movement per millisecond. + /// A positive x value shows that the user is panning to the right, a negative x value means the opposite. + /// A positive y value shows that the user is panning downwards, a negative y values means upwards. + /// public Vector2 Velocity { get @@ -70,6 +85,12 @@ namespace Tizen.NUI } } + /// + /// 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. + /// A positive x value shows that the user is panning to the right, a negative x value means the opposite. + /// A positive y value shows that the user is panning downwards, a negative y value means upwards. + /// public Vector2 Displacement { get @@ -78,6 +99,9 @@ namespace Tizen.NUI } } + /// + /// This current touch position of the primary touch point in local actor coordinates. + /// public Vector2 Position { get @@ -86,6 +110,13 @@ namespace Tizen.NUI } } + /// + /// The velocity at which the user is moving their fingers. + /// This is represented as a Vector2 and is the pixel movement per millisecond. + /// A positive x value shows that the user is panning to the right, a negative x value means the opposite. + /// A positive y value shows that the user is panning downwards, a negative y values means upwards. + /// This value represents the screen coordinates. + /// public Vector2 ScreenVelocity { get @@ -94,6 +125,13 @@ namespace Tizen.NUI } } + /// + /// 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. + /// A positive x value shows that the user is panning to the right, a negative x value means the opposite. + /// A positive y value shows that the user is panning downwards, a negative y value means upwards. + /// This value is in screen coordinates. + /// public Vector2 ScreenDisplacement { get @@ -102,6 +140,9 @@ namespace Tizen.NUI } } + /// + /// This current touch position of the primary touch point in screen coordinates. + /// public Vector2 ScreenPosition { get @@ -110,6 +151,9 @@ namespace Tizen.NUI } } + /// + /// The total number of fingers touching the screen in a pan gesture. + /// public uint NumberOfTouches { get @@ -118,21 +162,37 @@ namespace Tizen.NUI } } + /// + /// Default Constructor. + /// public PanGesture() : this(NDalicPINVOKE.new_PanGesture__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// + /// The state of the gesture public PanGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_PanGesture__SWIG_1((int)state), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Copy constructor. + /// + /// A reference to the copied handle public PanGesture(PanGesture rhs) : this(NDalicPINVOKE.new_PanGesture__SWIG_2(PanGesture.getCPtr(rhs)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Assignment operator. + /// + /// A reference to the copied handle + /// A reference to this public PanGesture Assign(PanGesture rhs) { PanGesture ret = new PanGesture(NDalicPINVOKE.PanGesture_Assign(swigCPtr, PanGesture.getCPtr(rhs)), false); @@ -251,6 +311,11 @@ namespace Tizen.NUI } } + /// + /// Returns the speed at which the user is moving their fingers. + /// This is the pixel movement per millisecond. + /// + /// The speed of the pan (in pixels per millisecond) public float GetSpeed() { float ret = NDalicPINVOKE.PanGesture_GetSpeed(swigCPtr); @@ -258,6 +323,12 @@ namespace Tizen.NUI return ret; } + /// + /// This 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. + /// This is always a positive value. + /// + /// The distance, as a float, a user's finger has panned public float GetDistance() { float ret = NDalicPINVOKE.PanGesture_GetDistance(swigCPtr); @@ -265,6 +336,11 @@ namespace Tizen.NUI return ret; } + /// + /// Returns the speed at which the user is moving their fingers relative to screen coordinates. + /// This is the pixel movement per millisecond. + /// + /// The speed of the pan (in pixels per millisecond) public float GetScreenSpeed() { float ret = NDalicPINVOKE.PanGesture_GetScreenSpeed(swigCPtr); @@ -272,6 +348,13 @@ namespace Tizen.NUI return ret; } + /// + /// This 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. + /// This is always a positive value. + /// + /// The distance, as a float, a user's finger has panned public float GetScreenDistance() { float ret = NDalicPINVOKE.PanGesture_GetScreenDistance(swigCPtr); -- 2.7.4