From: Feng Jin Date: Fri, 7 Apr 2017 19:40:43 +0000 (+0800) Subject: Add some comments into NUI. X-Git-Tag: accepted/tizen/unified/20170410.160126~4 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F19%2F123919%2F3;p=platform%2Fcore%2Fcsapi%2Fnui.git Add some comments into NUI. Change-Id: Ia98b64de29dae7d916a8eeb8e08f86f7538ba9b7 Signed-off-by: Feng Jin --- diff --git a/Tizen.NUI/src/public/Actor.cs b/Tizen.NUI/src/public/Actor.cs index 6f238b5..c93e093 100755 --- a/Tizen.NUI/src/public/Actor.cs +++ b/Tizen.NUI/src/public/Actor.cs @@ -24,8 +24,8 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// Actor is the primary object with which Dali applications interact. - /// UI controls can be built by combining multiple actors. + /// Actor is the primary object with which Dali applications interact.
+ /// UI controls can be built by combining multiple actors.
/// public class Actor : Handle { @@ -86,8 +86,8 @@ namespace Tizen.NUI } /// - /// Retrieve the position of the Actor. - /// The coordinates are relative to the Actor's parent. + /// Retrieve the position of the Actor.
+ /// The coordinates are relative to the Actor's parent.
/// public Position CurrentPosition { @@ -98,8 +98,8 @@ namespace Tizen.NUI } /// - /// Retrieve the size of the Actor. - /// The coordinates are relative to the Actor's parent. + /// Retrieve the size of the Actor.
+ /// The coordinates are relative to the Actor's parent.
/// public Size CurrentSize { @@ -110,7 +110,7 @@ namespace Tizen.NUI } /// - /// Retrieves the actor's parent. + /// Retrieves the actor's parent.
/// public Actor Parent { @@ -121,7 +121,7 @@ namespace Tizen.NUI } /// - /// Retrieves and sets the actor's opacity. + /// Retrieves and sets the actor's opacity.
/// public float Opacity { @@ -138,7 +138,7 @@ namespace Tizen.NUI } /// - /// Retrieves screen postion of actor's + /// Retrieves screen postion of actor's.
/// public Vector2 ScreenPosition { @@ -151,10 +151,10 @@ namespace Tizen.NUI } /// - /// Determines whether the anchor point should be used to determine the position of the actor. - /// This is true by default. - /// Note: If false, then the top-left of the actor is used for the position. - /// Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position. + /// Determines whether the anchor point should be used to determine the position of the actor.
+ /// This is true by default.
+ /// Note: If false, then the top-left of the actor is used for the position.
+ /// Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position.
/// protected bool PositionUsesAnchorPoint { @@ -171,8 +171,8 @@ namespace Tizen.NUI } /// - /// Queries whether the actor is connected to the Stage. - /// When an actor is connected, it will be directly or indirectly parented to the root Actor. + /// Queries whether the actor is connected to the Stage.
+ /// When an actor is connected, it will be directly or indirectly parented to the root Actor.
/// public bool IsOnStage { @@ -194,10 +194,10 @@ namespace Tizen.NUI } /// - /// Sets the sibling order of the actor so depth position can be defined within the same parent. - /// Note The initial value is 0. - /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order. - /// The values set by this Property will likely change. + /// Sets the sibling order of the actor so depth position can be defined within the same parent.
+ /// Note The initial value is 0.
+ /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order.
+ /// The values set by this Property will likely change.
/// public int SiblingOrder { @@ -214,10 +214,10 @@ namespace Tizen.NUI } /// - /// Sets the size of an actor for Width and Height. - /// Geometry can be scaled to fit within this area. - /// This does not interfere with the actors scale factor. - /// The actors default depth is the minimum of Width & Height. + /// Sets the size of an actor for Width and Height.
+ /// Geometry can be scaled to fit within this area.
+ /// This does not interfere with the actors scale factor.
+ /// The actors default depth is the minimum of Width & Height.
/// public Size2D Size2D { @@ -234,9 +234,9 @@ namespace Tizen.NUI } /// - /// Sets the position of the Actor for X and Y. - /// By default, sets the position vector between the parent origin and anchor point(default). - /// If Position inheritance if disabled, sets the world position. + /// Sets the position of the Actor for X and Y.
+ /// By default, sets the position vector between the parent origin and anchor point(default).
+ /// If Position inheritance if disabled, sets the world position.
/// public Position2D Position2D { @@ -253,10 +253,10 @@ namespace Tizen.NUI } /// - /// Sets the visibility flag of an actor as true to be shown. - /// Note This is an asynchronous method; the value written may not match a value subsequently read with Visible. - /// If an actor's visibility flag is set to false, then the actor and its children will not be rendered. - /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true. + /// Sets the visibility flag of an actor as true to be shown.
+ /// Note This is an asynchronous method; the value written may not match a value subsequently read with Visible.
+ /// If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
+ /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true.
/// public void Show() { @@ -272,11 +272,11 @@ namespace Tizen.NUI } /// - /// Raise actor above the next highest level of actor(s). - /// Note Sibling order of actors within the parent will be updated automatically. - /// Initially actors added to a parent will have the same sibling order and shown in relation to insertion order. - /// Raising this actor above actors with the same sibling order as each other will raise this actor above them. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Raise actor above the next highest level of actor(s).
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Initially actors added to a parent will have the same sibling order and shown in relation to insertion order.
+ /// Raising this actor above actors with the same sibling order as each other will raise this actor above them.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// public void Raise() { @@ -285,10 +285,10 @@ namespace Tizen.NUI } /// - /// Lower the actor to underneath the level below actor(s). - /// Note Sibling order of actors within the parent will be updated automatically. - /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Lower the actor to underneath the level below actor(s).
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// public void Lower() { @@ -297,9 +297,9 @@ namespace Tizen.NUI } /// - /// Raise actor above all other actors. - /// Note Sibling order of actors within the parent will be updated automatically. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Raise actor above all other actors.
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// public void RaiseToTop() { @@ -308,9 +308,9 @@ namespace Tizen.NUI } /// - /// Lower actor to the bottom of all actors. - /// Note Sibling order of actors within the parent will be updated automatically. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Lower actor to the bottom of all actors.
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// public void LowerToBottom() { @@ -319,11 +319,11 @@ namespace Tizen.NUI } /// - /// Raise the actor to above the target actor. - /// Note Sibling order of actors within the parent will be updated automatically. - /// Actors on the level above the target actor will still be shown above this actor. - /// Raising this actor above actors with the same sibling order as each other will raise this actor above them. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Raise the actor to above the target actor.
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Actors on the level above the target actor will still be shown above this actor.
+ /// Raising this actor above actors with the same sibling order as each other will raise this actor above them.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// /// Will be raised above this actor public void RaiseAbove(Actor target) @@ -333,10 +333,10 @@ namespace Tizen.NUI } /// - /// Lower the actor to below the target actor. - /// Note Sibling order of actors within the parent will be updated automatically. - /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them. - /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// Lower the actor to below the target actor.
+ /// Note Sibling order of actors within the parent will be updated automatically.
+ /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
+ /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
/// /// Will be lowered below this actor public void LowerBelow(Actor target) @@ -461,9 +461,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to Actor handle. - /// If handle points to an Actor object, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. * + /// Downcasts a handle to Actor handle.
+ /// If handle points to an Actor object, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// handle to An object /// handle to a Actor object or an uninitialized handle @@ -535,10 +535,10 @@ namespace Tizen.NUI } /// - /// Adds a child Actor to this Actor. - /// Precondition : This Actor(the parent) has been initialized. The child actor has been initialized. The child actor is not the same as the parent actor. - /// PostCondition : The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. - /// Note : If the child already has a parent, it will be removed from old parent and reparented to this actor. This may change child's position, color, scale etc as it now inherits them from this actor. + /// Adds a child Actor to this Actor.
+ /// Precondition : This Actor(the parent) has been initialized. The child actor has been initialized. The child actor is not the same as the parent actor.
+ /// PostCondition : The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.
+ /// Note : If the child already has a parent, it will be removed from old parent and reparented to this actor. This may change child's position, color, scale etc as it now inherits them from this actor.
/// /// The child public void Add(Actor child) @@ -548,8 +548,8 @@ namespace Tizen.NUI } /// - /// Removes a child Actor from this Actor. If the actor was not a child of this actor, this is a no-op. - /// Precondition : This Actor(the parent) has been initialized. The child actor is not the same as the parent actor. + /// Removes a child Actor from this Actor. If the actor was not a child of this actor, this is a no-op.
+ /// Precondition : This Actor(the parent) has been initialized. The child actor is not the same as the parent actor.
/// /// The child public void Remove(Actor child) @@ -565,8 +565,8 @@ namespace Tizen.NUI } /// - /// Retrieves the number of children held by the actor. - /// Precondition : The Actor has been initialized. + /// Retrieves the number of children held by the actor.
+ /// Precondition : The Actor has been initialized.
/// /// The number of children public uint GetChildCount() @@ -577,8 +577,8 @@ namespace Tizen.NUI } /// - /// Retrieve and child actor by index. - /// Precondition : The Actor has been initialized. + /// Retrieve and child actor by index.
+ /// Precondition : The Actor has been initialized.
/// /// The index of the child to retrieve /// The actor for the given index or empty handle if children not initialized @@ -590,9 +590,9 @@ namespace Tizen.NUI } /// - /// Search through this actor's hierarchy for an actor with the given name. - /// The actor itself is also considered in the search. - ///Precondition : The Actor has been initialized. + /// Search through this actor's hierarchy for an actor with the given name.
+ /// The actor itself is also considered in the search.
+ ///Precondition : The Actor has been initialized.
/// /// The name of the actor to find /// A handle to the actor if found, or an empty handle if not @@ -682,8 +682,8 @@ namespace Tizen.NUI } /// - /// Returns the natural size of the actor. - /// Deriving classes stipulate the natural size and by default an actor has a ZERO natural size. + /// Returns the natural size of the actor.
+ /// Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
/// /// The actor's natural size public Vector3 GetNaturalSize() @@ -976,9 +976,9 @@ namespace Tizen.NUI } /// - /// Converts screen coordinates into the actor's coordinate system using the default camera. - /// Precondition : The Actor has been initialized. - /// Note : The actor coordinates are relative to the top-left(0.0, 0.0, 0.5) + /// Converts screen coordinates into the actor's coordinate system using the default camera.
+ /// Precondition : The Actor has been initialized.
+ /// Note : The actor coordinates are relative to the top-left(0.0, 0.0, 0.5).
/// /// On return, the X-coordinate relative to the actor /// On return, the Y-coordinate relative to the actor @@ -1045,10 +1045,10 @@ namespace Tizen.NUI } /// - /// Sets the relative to parent size factor of the actor. - /// This factor is only used when ResizePolicy is set to either - /// This actor's size is set to the actor's size multiplied by or added to this factor, depending on ResizePolicy - /// Precondition : The Actor has been initialized. + /// Sets the relative to parent size factor of the actor.
+ /// This factor is only used when ResizePolicy is set to either.
+ /// This actor's size is set to the actor's size multiplied by or added to this factor, depending on ResizePolicy.
+ /// Precondition : The Actor has been initialized.
/// /// A Vector3 representing the relative factor to be applied to each axis public void SetSizeModeFactor(Vector3 factor) @@ -1065,9 +1065,9 @@ namespace Tizen.NUI } /// - /// Calculates the height of the actor given a width. - /// The natural size is used for default calculation. - /// size 0 is treated as aspect ratio 1:1. + /// Calculates the height of the actor given a width.
+ /// The natural size is used for default calculation.
+ /// size 0 is treated as aspect ratio 1:1.
/// /// Width to use /// the height based on the width @@ -1079,9 +1079,9 @@ namespace Tizen.NUI } /// - /// Calculates the width of the actor given a height. - /// The natural size is used for default calculation. - /// size 0 is treated as aspect ratio 1:1. + /// Calculates the width of the actor given a height.
+ /// The natural size is used for default calculation.
+ /// size 0 is treated as aspect ratio 1:1.
/// /// Height to use /// the width based on the height @@ -1100,7 +1100,7 @@ namespace Tizen.NUI } /// - /// Sets the padding for use in layout. + /// Sets the padding for use in layout.
/// /// padding Padding for the actor public void SetPadding(PaddingType padding) @@ -1110,7 +1110,7 @@ namespace Tizen.NUI } /// - /// Returns the value of the padding. + /// Returns the value of the padding.
/// /// The returned padding data public void GetPadding(PaddingType paddingOut) @@ -1235,11 +1235,11 @@ namespace Tizen.NUI } /// - /// Gets/Sets the origin of an actor, within its parent's area. - /// This is expressed in unit coordinates, such that(0.0, 0.0, 0.5) is the top-left corner of the parent, and(1.0, 1.0, 0.5) is the bottom-right corner. - /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5). - /// An actor's position is the distance between this origin, and the actor's anchor-point. - /// Precondition : The Actor has been initialized. + /// Gets/Sets the origin of an actor, within its parent's area.
+ /// This is expressed in unit coordinates, such that(0.0, 0.0, 0.5) is the top-left corner of the parent, and(1.0, 1.0, 0.5) is the bottom-right corner.
+ /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).
+ /// An actor's position is the distance between this origin, and the actor's anchor-point.
+ /// Precondition : The Actor has been initialized.
/// public Position ParentOrigin { @@ -1256,11 +1256,11 @@ namespace Tizen.NUI } /// - /// Gets/Sets the anchor-point of an actor. - /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the actor, and(1.0, 1.0, 0.5) is the bottom-right corner. - /// The default anchor point is AnchorPoint.Center (0.5, 0.5, 0.5). - /// An actor position is the distance between its parent-origin and this anchor-point. - /// An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point. + /// Gets/Sets the anchor-point of an actor.
+ /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the actor, and(1.0, 1.0, 0.5) is the bottom-right corner.
+ /// The default anchor point is AnchorPoint.Center (0.5, 0.5, 0.5).
+ /// An actor position is the distance between its parent-origin and this anchor-point.
+ /// An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
/// Precondition : The Actor has been initialized. /// public Position AnchorPoint @@ -1279,9 +1279,9 @@ namespace Tizen.NUI /// - /// Gets/Sets the size of an actor. - /// Geometry can be scaled to fit within this area. - /// This does not interfere with the actors scale factor. + /// Gets/Sets the size of an actor.
+ /// Geometry can be scaled to fit within this area.
+ /// This does not interfere with the actors scale factor.
/// public Size Size { @@ -1349,9 +1349,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the position of the Actor. - /// By default, sets the position vector between the parent origin and anchor point(default). - /// If Position inheritance if disabled, sets the world position. + /// Gets/Sets the position of the Actor.
+ /// By default, sets the position vector between the parent origin and anchor point(default).
+ /// If Position inheritance if disabled, sets the world position.
/// public Position Position { @@ -1433,9 +1433,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the orientation of the Actor. - /// An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point. - /// Note: This is an asynchronous method. + /// Gets/Sets the orientation of the Actor.
+ /// An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
+ /// Note: This is an asynchronous method.
/// public Rotation Orientation { @@ -1452,7 +1452,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the world orientation of the Actor. + /// Gets/Sets the world orientation of the Actor.
/// public Rotation WorldOrientation { @@ -1465,8 +1465,8 @@ namespace Tizen.NUI } /// - /// Gets/Sets the scale factor applied to an actor. - /// Note : This is an asynchronous method. + /// Gets/Sets the scale factor applied to an actor.
+ /// Note : This is an asynchronous method.
/// public Vector3 Scale { @@ -1547,9 +1547,9 @@ namespace Tizen.NUI } /// - /// Retrieves the visibility flag of an actor. - /// Note : If an actor is not visible, then the actor and its children will not be rendered. - /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true. + /// Retrieves the visibility flag of an actor.
+ /// Note : If an actor is not visible, then the actor and its children will not be rendered.
+ /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true.
/// public bool Visible { @@ -1750,9 +1750,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the actor's color mode. - /// This specifies whether the Actor uses its own color, or inherits its parent color. - /// The default is UseOwnMultiplyParentAlpha. + /// Gets/Sets the actor's color mode.
+ /// This specifies whether the Actor uses its own color, or inherits its parent color.
+ /// The default is UseOwnMultiplyParentAlpha.
/// public ColorMode ColorMode { @@ -1785,12 +1785,12 @@ namespace Tizen.NUI /// - /// Gets/Sets the status of how the actor and its children should be drawn. - /// Not all actors are renderable, but DrawMode can be inherited from any actor. - /// If an object is in a 3D layer, it will be depth-tested against other objects in the world i.e. it may be obscured if other objects are in front. - /// If DrawMode.Overlay2D is used, the actor and its children will be drawn as a 2D overlay. - /// Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer. - /// For overlay actors, the drawing order is with respect to tree levels of Actors, and depth-testing will not be used. + /// Gets/Sets the status of how the actor and its children should be drawn.
+ /// Not all actors are renderable, but DrawMode can be inherited from any actor.
+ /// If an object is in a 3D layer, it will be depth-tested against other objects in the world i.e. it may be obscured if other objects are in front.
+ /// If DrawMode.Overlay2D is used, the actor and its children will be drawn as a 2D overlay.
+ /// Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
+ /// For overlay actors, the drawing order is with respect to tree levels of Actors, and depth-testing will not be used.
/// public DrawModeType DrawMode { @@ -1820,9 +1820,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the relative to parent size factor of the actor. - /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent. - /// This actor's size is set to the actor's size multiplied by or added to this factor, depending on ResizePolicyType. + /// Gets/Sets the relative to parent size factor of the actor.
+ /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.
+ /// This actor's size is set to the actor's size multiplied by or added to this factor, depending on ResizePolicyType.
/// public Vector3 SizeModeFactor { @@ -1919,8 +1919,8 @@ namespace Tizen.NUI } /// - /// Gets/Sets the policy to use when setting size with size negotiation. - /// Defaults to SizeScalePolicyType.UseSizeSet. + /// Gets/Sets the policy to use when setting size with size negotiation.
+ /// Defaults to SizeScalePolicyType.UseSizeSet.
/// public SizeScalePolicyType SizeScalePolicy { @@ -2061,9 +2061,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets whether a child actor inherits it's parent's position. - /// Default is to inherit. - /// Switching this off means that using Position sets the actor's world position, i.e. translates from the world origin(0,0,0) to the anchor point of the actor. + /// Gets/Sets whether a child actor inherits it's parent's position.
+ /// Default is to inherit.
+ /// Switching this off means that using Position sets the actor's world position, i.e. translates from the world origin(0,0,0) to the anchor point of the actor.
/// public bool InheritPosition { @@ -2080,7 +2080,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets clipping behavior(mode) of it's children + /// Gets/Sets clipping behavior(mode) of it's children. /// public ClippingModeType ClippingMode { @@ -2110,11 +2110,11 @@ namespace Tizen.NUI } /// - /// This specifies whether the Actor uses its own color, or inherits - /// ColorMode.UseOwnColor : Actor will use its own color - /// ColorMode.UseParentColor : Actor will use its parent color - /// ColorMode.UseOwnMultiplyParentColor : Actor will blend its color with its parents color. - /// ColorMode.UseOwnMultiplyParentAlpha : Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default. + /// This specifies whether the Actor uses its own color, or inherits.
+ /// ColorMode.UseOwnColor : Actor will use its own color.
+ /// ColorMode.UseParentColor : Actor will use its parent color.
+ /// ColorMode.UseOwnMultiplyParentColor : Actor will blend its color with its parents color.
+ /// ColorMode.UseOwnMultiplyParentAlpha : Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default.
/// public enum ColorMode { diff --git a/Tizen.NUI/src/public/AlphaFunction.cs b/Tizen.NUI/src/public/AlphaFunction.cs index 4f7ff1c..342a3ad 100755 --- a/Tizen.NUI/src/public/AlphaFunction.cs +++ b/Tizen.NUI/src/public/AlphaFunction.cs @@ -20,7 +20,7 @@ namespace Tizen.NUI { /// - /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time. + /// Alpha functions are used in animations to specify the rate of change of the animation parameter over time.
/// Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of /// the animation before computing the final animation value. /// @@ -72,8 +72,8 @@ namespace Tizen.NUI } /// - /// Constructor. - /// Creates an alpha function object with user defined alpha function. + /// Constructor.
+ /// Creates an alpha function object with user defined alpha function.
/// /// User defined fuction. It must be a method formatted as float alphafunction(float progress) public AlphaFunction(System.Delegate func) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_2(SWIGTYPE_p_f_float__float.getCPtr(new SWIGTYPE_p_f_float__float(System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(func), true))), true) @@ -82,8 +82,8 @@ namespace Tizen.NUI } /// - /// Default constructor. - /// Creates an alpha function object with the default built-in alpha function. + /// Default constructor.
+ /// Creates an alpha function object with the default built-in alpha function.
/// public AlphaFunction() : this(NDalicPINVOKE.new_AlphaFunction__SWIG_0(), true) { @@ -91,8 +91,8 @@ namespace Tizen.NUI } /// - /// Constructor. - /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor. + /// Constructor.
+ /// Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.
/// /// One of the built-in alpha functions public AlphaFunction(AlphaFunction.BuiltinFunctions function) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_1((int)function), true) @@ -106,9 +106,9 @@ namespace Tizen.NUI } /// - /// Constructor. - /// Creates a bezier alpha function.The bezier will have the first point at(0,0) and the end point at(1,1). - /// Note : The x components of the control points will be clamped to the range[0, 1] to prevent non monotonic curves. + /// Constructor.
+ /// Creates a bezier alpha function.The bezier will have the first point at(0,0) and the end point at(1,1).
+ /// Note : The x components of the control points will be clamped to the range[0, 1] to prevent non monotonic curves.
/// /// A Vector2 which will be used as the first control point of the curve /// A Vector2 which will be used as the second control point of the curve @@ -118,7 +118,7 @@ namespace Tizen.NUI } /// - /// Retrives the control points of the alpha function. + /// Retrives the control points of the alpha function.
/// /// A Vector2 which is used as the first control point of the curve /// A Vector2 which is used as the second control point of the curve @@ -140,8 +140,8 @@ namespace Tizen.NUI } /// - /// Returns the built-in function used by the alpha function. - /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT + /// Returns the built-in function used by the alpha function.
+ /// In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.
/// /// One of the built-in alpha functions. public AlphaFunction.BuiltinFunctions GetBuiltinFunction() diff --git a/Tizen.NUI/src/public/Animation.cs b/Tizen.NUI/src/public/Animation.cs index 7cbcb66..5ecaf1e 100755 --- a/Tizen.NUI/src/public/Animation.cs +++ b/Tizen.NUI/src/public/Animation.cs @@ -23,11 +23,11 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// Animation can be used to animate the properties of any number of objects, typically Actors. - /// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed. - /// This is typically done in the object destructor, and requires either the Animation handle to be stored. - /// The overall animation time is superseded by the values given in the Duration property used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods. - /// If any of the individual calls to those functions exceeds the overall animation time(Duration), then the overall animation time is automatically extended. + /// Animation can be used to animate the properties of any number of objects, typically Actors.
+ /// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.
+ /// This is typically done in the object destructor, and requires either the Animation handle to be stored.
+ /// The overall animation time is superseded by the values given in the Duration property used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
+ /// If any of the individual calls to those functions exceeds the overall animation time(Duration), then the overall animation time is automatically extended.
/// public class Animation : BaseHandle { @@ -76,11 +76,11 @@ namespace Tizen.NUI } /// - /// Create an initialized Animation. - /// The animation will not loop. - /// The default end action is "Cancel". - /// The default Alpha function is linear. - /// Precodition : DurationmSeconds must be greater than zero. + /// Create an initialized Animation.
+ /// The animation will not loop.
+ /// The default end action is "Cancel".
+ /// The default Alpha function is linear.
+ /// Precodition : DurationmSeconds must be greater than zero.
/// /// The duration in milli seconds (int). public Animation(int durationMilliSeconds) : this(NDalicPINVOKE.Animation_New((float)durationMilliSeconds / 1000.0f), true) @@ -93,7 +93,7 @@ namespace Tizen.NUI private delegate void AnimationFinishedEventCallbackType(IntPtr data); private event EventHandler _animationFinishedEventHandler; /** - * @brief Event for Finished signal which can be used to subscribe/unsubscribe the event handler + * @brief Event for Finished signal which can be used to subscribe/unsubscribe the event handler. * Finished signal is emitted when an Animation's animations have finished. */ public event EventHandler Finished @@ -163,7 +163,7 @@ namespace Tizen.NUI /// - /// Gets/Sets the duration of animation + /// Gets/Sets the duration of animation. /// public int Duration { @@ -205,12 +205,11 @@ namespace Tizen.NUI } /// - /// Set : Enables looping for 'count' repeats. A zero is the same as Looping = true; i.e.repeat forever. - /// If Play() Stop() or 'count' loops is reached, the loop counter will reset. - /// Setting this parameter does not cause the animation to Play(). - /// - /// Get : Gets the loop count. A zero is the same as Looping = true; ie repeat forever. - /// The loop count is initially 1 for play once. + /// Set : Enables looping for 'count' repeats. A zero is the same as Looping = true; i.e.repeat forever.
+ /// If Play() Stop() or 'count' loops is reached, the loop counter will reset.
+ /// Setting this parameter does not cause the animation to Play().
+ /// Get : Gets the loop count. A zero is the same as Looping = true; ie repeat forever.
+ /// The loop count is initially 1 for play once.
/// public int LoopCount { @@ -226,9 +225,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the status of whether the animation will loop. - /// This property resets the loop count and should not be used with LoopCount property. - /// Setting this parameter does not cause the animation to Play(). + /// Gets/Sets the status of whether the animation will loop.
+ /// This property resets the loop count and should not be used with LoopCount property.
+ /// Setting this parameter does not cause the animation to Play().
/// public bool Looping { @@ -245,9 +244,9 @@ namespace Tizen.NUI /// - /// Gets/Sets the end action of the animation. - /// This action is performed when the animation ends or if it is stopped. - /// Default end action is Cancel + /// Gets/Sets the end action of the animation.
+ /// This action is performed when the animation ends or if it is stopped.
+ /// Default end action is Cancel.
/// public EndActions EndAction { @@ -274,8 +273,8 @@ namespace Tizen.NUI } /// - /// Gets the current loop count. - /// A value 0 to CurrentLoop indicating the current loop count when looping. + /// Gets the current loop count.
+ /// A value 0 to CurrentLoop indicating the current loop count when looping.
/// public int CurrentLoop { @@ -286,9 +285,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the disconnect action. - /// If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed. - /// Default action is to Cancel. + /// Gets/Sets the disconnect action.
+ /// If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.
+ /// Default action is to Cancel.
/// public EndActions DisconnectAction { @@ -307,10 +306,10 @@ namespace Tizen.NUI /// - /// Gets/Sets the progress of the animation. - /// The animation will play(or continue playing) from this point. - /// The progress must be in the 0-1 interval or in the play range interval if defined - /// otherwise, it will be ignored. + /// Gets/Sets the progress of the animation.
+ /// The animation will play(or continue playing) from this point.
+ /// The progress must be in the 0-1 interval or in the play range interval if defined.
+ /// otherwise, it will be ignored.
/// public float CurrentProgress { @@ -328,10 +327,10 @@ namespace Tizen.NUI } /// - /// Gets/Sets Specifies a speed factor for the animation. - /// The speed factor is a multiplier of the normal velocity of the animation. - /// Values between[0, 1] will slow down the animation and values above one will speed up the animation. - /// It is also possible to specify a negative multiplier to play the animation in reverse. + /// Gets/Sets Specifies a speed factor for the animation.
+ /// The speed factor is a multiplier of the normal velocity of the animation.
+ /// Values between[0, 1] will slow down the animation and values above one will speed up the animation.
+ /// It is also possible to specify a negative multiplier to play the animation in reverse.
/// public float SpeedFactor { @@ -349,9 +348,9 @@ namespace Tizen.NUI } /// - /// Gets/Sets the playing range. + /// Gets/Sets the playing range.
/// Animation will play between the values specified. Both values(range.x and range.y ) should be between 0-1, - /// otherwise they will be ignored.If the range provided is not in proper order(minimum, maximum ), it will be reordered. + /// otherwise they will be ignored.If the range provided is not in proper order(minimum, maximum ), it will be reordered.
/// public Vector2 PlayRange { @@ -369,9 +368,9 @@ namespace Tizen.NUI } /// - /// Animates a property value by a relative amount. - /// The default alpha function will be used. - /// The effect will start & end when the animation begins & ends. + /// Animates a property value by a relative amount.
+ /// The default alpha function will be used.
+ /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -402,9 +401,9 @@ namespace Tizen.NUI } /// - /// Animates a property value by a relative amount. - /// The default alpha function will be used. - /// The effect will start & end when the animation begins & ends. + /// Animates a property value by a relative amount.
+ /// The default alpha function will be used.
+ /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -439,9 +438,9 @@ namespace Tizen.NUI } /// - /// Animates a property to a destination value. - /// The default alpha function will be used. - /// The effect will start & end when the animation begins & ends. + /// Animates a property to a destination value.
+ /// The default alpha function will be used.
+ /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -472,9 +471,9 @@ namespace Tizen.NUI } /// - /// Animates a property to a destination value. - /// The default alpha function will be used. - /// The effect will start & end when the animation begins & ends. + /// Animates a property to a destination value.
+ /// The default alpha function will be used.
+ /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -574,9 +573,9 @@ namespace Tizen.NUI } /// - /// Animates an actor's position and orientation through a predefined path. - /// The actor will rotate to orient the supplied forward vector with the path's tangent. - /// If forward is the zero vector then no rotation will happen. + /// Animates an actor's position and orientation through a predefined path.
+ /// The actor will rotate to orient the supplied forward vector with the path's tangent.
+ /// If forward is the zero vector then no rotation will happen.
/// /// The actor to animate /// It defines position and orientation @@ -595,9 +594,9 @@ namespace Tizen.NUI } /// - /// Animates an actor's position and orientation through a predefined path. - /// The actor will rotate to orient the supplied forward vector with the path's tangent. - /// If forward is the zero vector then no rotation will happen. + /// Animates an actor's position and orientation through a predefined path.
+ /// The actor will rotate to orient the supplied forward vector with the path's tangent.
+ /// If forward is the zero vector then no rotation will happen.
/// /// The actor to animate /// It defines position and orientation @@ -619,10 +618,10 @@ namespace Tizen.NUI } /// - /// Creates an initialized Animation. - /// The animation will not loop. - /// The default end action is "Cancel". - /// The default alpha function is linear. + /// Creates an initialized Animation.
+ /// The animation will not loop.
+ /// The default end action is "Cancel".
+ /// The default alpha function is linear.
/// public Animation() : this(NDalicPINVOKE.Animation_New(0.0f), true) { @@ -636,9 +635,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to Animation handle. - /// If handle points to an Animation object, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to Animation handle.
+ /// If handle points to an Animation object, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// Handle to an Animation object or an uninitialized handle @@ -795,9 +794,9 @@ namespace Tizen.NUI } /// - /// Plays the animation from a given point. - /// The progress must be in the 0-1 interval or in the play range interval if defined - /// otherwise, it will be ignored. + /// Plays the animation from a given point.
+ /// The progress must be in the 0-1 interval or in the play range interval if defined, + /// otherwise, it will be ignored.
/// /// A value between [0,1], or between the play range if specified, from where the animation should start playing public void PlayFrom(float progress) @@ -832,8 +831,8 @@ namespace Tizen.NUI } /// - /// Clears the animation. - /// This disconnects any objects that were being animated, effectively stopping the animation. + /// Clears the animation.
+ /// This disconnects any objects that were being animated, effectively stopping the animation.
/// public void Clear() { @@ -981,10 +980,10 @@ namespace Tizen.NUI } /// - /// Enumeration for what to do when the animation ends, is stopped, or is destroyed. - /// Cancel : When the animation ends, the animated property values are saved. - /// Discard : When the animation ends, the animated property values are forgotten. - /// StopFinal : If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel. + /// Enumeration for what to do when the animation ends, is stopped, or is destroyed.
+ /// Cancel : When the animation ends, the animated property values are saved.
+ /// Discard : When the animation ends, the animated property values are forgotten.
+ /// StopFinal : If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel.
/// public enum EndActions { @@ -994,9 +993,9 @@ namespace Tizen.NUI } /// - /// Enumeration for what interpolation method to use on key-frame animations. - /// Linear : Values in between key frames are interpolated using a linear polynomial. (Default) - /// Cubic : Values in between key frames are interpolated using a cubic polynomial. + /// Enumeration for what interpolation method to use on key-frame animations.
+ /// Linear : Values in between key frames are interpolated using a linear polynomial. (Default).
+ /// Cubic : Values in between key frames are interpolated using a cubic polynomial.
/// public enum Interpolation { @@ -1005,8 +1004,8 @@ namespace Tizen.NUI } /// - /// Enumeration for what state the animation is in. - /// Note: Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle. + /// Enumeration for what state the animation is in.
+ /// Note: Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle.
/// public enum States { diff --git a/Tizen.NUI/src/public/Button.cs b/Tizen.NUI/src/public/Button.cs index e771933..0964c4a 100755 --- a/Tizen.NUI/src/public/Button.cs +++ b/Tizen.NUI/src/public/Button.cs @@ -23,17 +23,17 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// Button is a base class for different kinds of buttons. - /// This class provides the disabled property and the clicked signal. - /// A Clicked event handler is emitted when the button is touched and the touch point doesn't leave the boundary of the button. - /// When the disabled property is set to true, no signal is emitted. - /// 'Visual' describes not just traditional images like png, bmp but refers to whatever is used to show the button, it could be a color, gradient or some other kind of renderer. - /// The button's appearance can be modified by setting properties for the various visuals/images. - /// It is not mandatory to set all visuals. A button could be defined only by setting its background visual or by setting its background and selected visuals. - /// The button visual is shown over the background visual. - /// When pressed the unselected visuals are replaced by the selected visual. - /// The text label is always placed on the top of all images. - /// When the button is disabled, background, button and selected visuals are replaced by their disabled visuals. + /// Button is a base class for different kinds of buttons.
+ /// This class provides the disabled property and the clicked signal.
+ /// A Clicked event handler is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
+ /// When the disabled property is set to true, no signal is emitted.
+ /// 'Visual' describes not just traditional images like png, bmp but refers to whatever is used to show the button, it could be a color, gradient or some other kind of renderer.
+ /// The button's appearance can be modified by setting properties for the various visuals/images.
+ /// It is not mandatory to set all visuals. A button could be defined only by setting its background visual or by setting its background and selected visuals.
+ /// The button visual is shown over the background visual.
+ /// When pressed the unselected visuals are replaced by the selected visual.
+ /// The text label is always placed on the top of all images.
+ /// When the button is disabled, background, button and selected visuals are replaced by their disabled visuals.
/// public class Button : View { @@ -87,6 +87,9 @@ namespace Tizen.NUI private delegate bool ClickedCallbackType(global::System.IntPtr data); private ClickedCallbackType _clickedCallback; + /// + /// Clicked will be triggered when the button is touched and the touch point doesn't leave the boundary of the button. + /// public event EventHandlerWithReturnType Clicked { add @@ -128,6 +131,9 @@ namespace Tizen.NUI private delegate bool PressedCallbackType(global::System.IntPtr data); private PressedCallbackType _pressedCallback; + /// + /// Pressed will be triggered when the button is touched. + /// public event EventHandlerWithReturnType Pressed { add @@ -168,6 +174,9 @@ namespace Tizen.NUI private delegate bool ReleasedCallbackType(global::System.IntPtr data); private ReleasedCallbackType _releasedCallback; + /// + /// Released will be triggered when the button is touched and the touch point leaves the boundary of the button. + /// public event EventHandlerWithReturnType Released { add @@ -207,6 +216,9 @@ namespace Tizen.NUI private delegate bool StateChangedCallback(global::System.IntPtr data); private StateChangedCallback _stateChangedCallback; + /// + /// StateChanged will be triggered when the button's state is changed. + /// public event EventHandlerWithReturnType StateChanged { add @@ -508,8 +520,8 @@ namespace Tizen.NUI } /// - /// Creates an uninitialized Button. - /// Only derived versions can be instantiated. + /// Creates an uninitialized Button.
+ /// Only derived versions can be instantiated.
/// public Button() : this(NDalicPINVOKE.new_Button__SWIG_0(), true) { @@ -529,9 +541,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to Button handle. - /// If handle points to a Button, the downcast produces valid handle. - /// If not the returned handle is left uninitialized. + /// Downcasts a handle to Button handle.
+ /// If handle points to a Button, the downcast produces valid handle.
+ /// If not the returned handle is left uninitialized.
/// /// Handle to an object /// A handle to a Button or an uninitialized handle @@ -686,7 +698,7 @@ namespace Tizen.NUI } /// - /// If the autorepeating property is set to true then the togglable property is set to false + /// If the autorepeating property is set to true then the togglable property is set to false. /// public bool AutoRepeating { @@ -720,7 +732,7 @@ namespace Tizen.NUI } /// - /// default this value is set to 0.05 seconds + /// default this value is set to 0.05 seconds. /// public float NextAutoRepeatingDelay { @@ -771,7 +783,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the unselected button foreground image + /// Gets/Sets the unselected button foreground image. /// public Tizen.NUI.PropertyMap UnselectedStateImage { @@ -788,7 +800,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the selected button foreground image + /// Gets/Sets the selected button foreground image. /// public Tizen.NUI.PropertyMap SelectedStateImage { @@ -805,7 +817,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the disabled whilst unselected foreground button visual + /// Gets/Sets the disabled whilst unselected foreground button visual. /// public Tizen.NUI.PropertyMap DisabledStateImage { @@ -822,7 +834,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets unselected color + /// Gets/Sets unselected color. /// public Color UnselectedColor { @@ -839,7 +851,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets selected color + /// Gets/Sets selected color. /// public Color SelectedColor { @@ -856,7 +868,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets label + /// Gets/Sets label. /// public Tizen.NUI.PropertyMap Label { @@ -873,7 +885,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets text of label + /// Gets/Sets text of label. /// public string LabelText { diff --git a/Tizen.NUI/src/public/CameraActor.cs b/Tizen.NUI/src/public/CameraActor.cs index cb64371..57f1af9 100755 --- a/Tizen.NUI/src/public/CameraActor.cs +++ b/Tizen.NUI/src/public/CameraActor.cs @@ -20,19 +20,19 @@ namespace Tizen.NUI { /// - /// This class will be deprecated. - /// CameraActor controls a camera. - /// Allows the developer to use actor semantics to control a camera. - /// NUI has a concept of a camera to display its virtual 3D world to a 2D screen. - /// There are 2 ways of using the camera in NUI: + /// This class will be deprecated.
+ /// CameraActor controls a camera.
+ /// Allows the developer to use actor semantics to control a camera.
+ /// NUI has a concept of a camera to display its virtual 3D world to a 2D screen.
+ /// There are 2 ways of using the camera in NUI:
/// - For 2D applications, you do not need to care about the camera at all. The default camera is already best suited for 2D applications - /// (configured to have the origin of the coordinate system at the top-left corner of the screen, and unit 1 as 1 pixel of the screen). This is a typical way. - /// - For 3D applications, you can change the view by manipulating the camera.You can translate or rotate the camera in this case. - /// Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera. - /// There are two types of camera actor, FreeLook and LookAtTarget By default, the camera actor will be FreeLook. - /// - A FreeLook camera uses actor's orientation to control where the camera is looking. - /// If no additional rotations are specified, the camera looks in the negative Z direction. - /// - For LookAtTarget, the actor's orientation is ignored, instead the camera looks at TargetPosition in world coordinates. + /// (configured to have the origin of the coordinate system at the top-left corner of the screen, and unit 1 as 1 pixel of the screen). This is a typical way.
+ /// - For 3D applications, you can change the view by manipulating the camera.You can translate or rotate the camera in this case.
+ /// Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera.
+ /// There are two types of camera actor, FreeLook and LookAtTarget By default, the camera actor will be FreeLook.
+ /// - A FreeLook camera uses actor's orientation to control where the camera is looking.
+ /// If no additional rotations are specified, the camera looks in the negative Z direction.
+ /// - For LookAtTarget, the actor's orientation is ignored, instead the camera looks at TargetPosition in world coordinates.
/// /// public class CameraActor : Actor { @@ -151,8 +151,8 @@ namespace Tizen.NUI } /// - /// Creates a CameraActor object. - /// Sets the default camera perspective projection for the given canvas size + /// Creates a CameraActor object.
+ /// Sets the default camera perspective projection for the given canvas size.
/// /// The canvas size public CameraActor(Size2D size) : this(NDalicPINVOKE.CameraActor_New__SWIG_1(Size2D.getCPtr(size)), true) @@ -162,9 +162,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to CameraActor handle. - /// If handle points to a CameraActor, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to CameraActor handle.
+ /// If handle points to a CameraActor, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// to An object /// Handle to a CameraActor or an uninitialized handle @@ -378,7 +378,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets near plane distance + /// Gets/Sets near plane distance. /// public float NearPlaneDistance { @@ -395,7 +395,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets far plane distance + /// Gets/Sets far plane distance. /// public float FarPlaneDistance { @@ -412,7 +412,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets left plane distance + /// Gets/Sets left plane distance. /// public float LeftPlaneDistance { @@ -429,7 +429,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets right plane distance + /// Gets/Sets right plane distance. /// public float RightPlaneDistance { @@ -446,7 +446,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets top plane distance + /// Gets/Sets top plane distance. /// public float TopPlaneDistance { @@ -463,7 +463,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets bottom plane distance + /// Gets/Sets bottom plane distance. /// public float BottomPlaneDistance { @@ -535,9 +535,9 @@ namespace Tizen.NUI } /// - /// Enumeration for type determination of how camera operates. - /// FreeLook : Camera orientation is taken from CameraActor - /// LookAtTarget : Camera is oriented to always look at a target + /// Enumeration for type determination of how camera operates.
+ /// FreeLook : Camera orientation is taken from CameraActor.
+ /// LookAtTarget : Camera is oriented to always look at a target.
/// public enum CameraType { @@ -546,9 +546,9 @@ namespace Tizen.NUI } /// - /// Enumeration for projection modes. - /// PerspectiveProjection : Distance causes foreshortening; objects further from the camera appear smaller - /// OrthographicProjection : Relative distance from the camera does not affect the size of objects + /// Enumeration for projection modes.
+ /// PerspectiveProjection : Distance causes foreshortening; objects further from the camera appear smaller.
+ /// OrthographicProjection : Relative distance from the camera does not affect the size of objects.
/// public enum ProjectionMode { diff --git a/Tizen.NUI/src/public/CheckBoxButton.cs b/Tizen.NUI/src/public/CheckBoxButton.cs index 9ea9bd4..09bab6a 100755 --- a/Tizen.NUI/src/public/CheckBoxButton.cs +++ b/Tizen.NUI/src/public/CheckBoxButton.cs @@ -20,13 +20,13 @@ namespace Tizen.NUI { /// - /// CheckBoxButton provides a check box button which user can check or uncheck. - /// By default, a CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected. - /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, - /// Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage. - /// When the button is not disabled, if it's not selected it only shows the background image. - /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image). - /// When the button is disabled, background image and selected image are replaced by disabled images. + /// CheckBoxButton provides a check box button which user can check or uncheck.
+ /// By default, a CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected.
+ /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, + /// Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage.
+ /// When the button is not disabled, if it's not selected it only shows the background image.
+ /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image).
+ /// When the button is disabled, background image and selected image are replaced by disabled images.
/// /// public class CheckBoxButton : Button { diff --git a/Tizen.NUI/src/public/Color.cs b/Tizen.NUI/src/public/Color.cs index 9b19875..38100f3 100755 --- a/Tizen.NUI/src/public/Color.cs +++ b/Tizen.NUI/src/public/Color.cs @@ -22,7 +22,7 @@ namespace Tizen.NUI using System; /// - /// Color class + /// Color class. /// public class Color : global::System.IDisposable { @@ -289,7 +289,7 @@ namespace Tizen.NUI } /// - /// red component + /// red component. /// public float R { @@ -307,7 +307,7 @@ namespace Tizen.NUI } /// - /// green component + /// green component. /// public float G { @@ -325,7 +325,7 @@ namespace Tizen.NUI } /// - /// blue component + /// blue component. /// public float B { @@ -343,7 +343,7 @@ namespace Tizen.NUI } /// - /// alpha component + /// alpha component. /// public float A { @@ -361,7 +361,7 @@ namespace Tizen.NUI } /// - /// Get black colored Color class + /// Get black colored Color class. /// public static Color Black { @@ -375,7 +375,7 @@ namespace Tizen.NUI } /// - /// Get white colored Color class + /// Get white colored Color class. /// public static Color White { @@ -389,7 +389,7 @@ namespace Tizen.NUI } /// - /// Get red colored Color class + /// Get red colored Color class. /// public static Color Red { @@ -403,7 +403,7 @@ namespace Tizen.NUI } /// - /// Get green colored Color class + /// Get green colored Color class. /// public static Color Green { @@ -417,7 +417,7 @@ namespace Tizen.NUI } /// - /// Get blue colored Color class + /// Get blue colored Color class. /// public static Color Blue { @@ -431,7 +431,7 @@ namespace Tizen.NUI } /// - /// Get yellow colored Color class + /// Get yellow colored Color class. /// public static Color Yellow { @@ -445,7 +445,7 @@ namespace Tizen.NUI } /// - /// Get magenta colored Color class + /// Get magenta colored Color class. /// public static Color Magenta { @@ -459,7 +459,7 @@ namespace Tizen.NUI } /// - /// Get cyan colored Color class + /// Get cyan colored Color class. /// public static Color Cyan { @@ -473,7 +473,7 @@ namespace Tizen.NUI } /// - /// Get transparent colored Color class + /// Get transparent colored Color class. /// public static Color Transparent { diff --git a/Tizen.NUI/src/public/CustomView.cs b/Tizen.NUI/src/public/CustomView.cs index 2e31f85..f5b11f6 100755 --- a/Tizen.NUI/src/public/CustomView.cs +++ b/Tizen.NUI/src/public/CustomView.cs @@ -85,27 +85,21 @@ namespace Tizen.NUI viewWrapperImpl.SetBackground(map); } - /** - * @brief Allows deriving classes to enable any of the gesture detectors that are available. - * - * Gesture detection can be enabled one at a time or in bitwise format as shown: - * @code - * EnableGestureDetection(Gesture.Type.Pinch | Gesture.Type.Tap | Gesture.Type.Pan)); - * @endcode - * @param[in] type The gesture type(s) to enable. - */ + /// + /// Allows deriving classes to enable any of the gesture detectors that are available.
+ /// Gesture detection can be enabled one at a time or in bitwise format.
+ /// + /// The gesture type(s) to enable public void EnableGestureDetection(Gesture.GestureType type) { viewWrapperImpl.EnableGestureDetection(type); } - /** - * @brief Allows deriving classes to disable any of the gesture detectors. - * - * Like EnableGestureDetection, this can also be called using bitwise or. - * @param[in] type The gesture type(s) to disable. - * @see EnableGetureDetection - */ + /// + /// Allows deriving classes to disable any of the gesture detectors.
+ /// Like EnableGestureDetection, this can also be called using bitwise or one at a time.
+ /// + /// The gesture type(s) to disable internal void DisableGestureDetection(Gesture.GestureType type) { viewWrapperImpl.DisableGestureDetection(type); @@ -113,8 +107,8 @@ namespace Tizen.NUI /// /// 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. + /// (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 @@ -134,12 +128,10 @@ namespace Tizen.NUI viewWrapperImpl.SetKeyboardNavigationSupport(isSupported); } - - /** - * @brief Gets whether this control supports two dimensional keyboard navigation. - * - * @return true if this control supports two dimensional keyboard navigation. - */ + /// + /// Gets whether this control supports two dimensional keyboard navigation. + /// + /// true if this control supports two dimensional keyboard navigation internal bool IsKeyboardNavigationSupported() { return viewWrapperImpl.IsKeyboardNavigationSupported(); @@ -162,32 +154,27 @@ namespace Tizen.NUI } } - /** - * @brief Sets whether this control is a focus group for keyboard navigation. - * - * (i.e. the scope of keyboard focus movement - * can be limitied to its child actors). The control is not a focus group by default. - * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. - */ + /// + /// Sets whether this control is a focus group for keyboard navigation. + /// (i.e. the scope of keyboard focus movement can be limitied to its child actors). The control is not a focus group by default. + /// + /// Whether this control is set as a focus group for keyboard navigation internal void SetAsKeyboardFocusGroup(bool isFocusGroup) { viewWrapperImpl.SetAsFocusGroup(isFocusGroup); } - /** - * @brief Gets whether this control is a focus group for keyboard navigation. - * - * @return true if this control is set as a focus group for keyboard navigation. - */ + /// + /// Gets whether this control is a focus group for keyboard navigation. + /// internal bool IsKeyboardFocusGroup() { return viewWrapperImpl.IsFocusGroup(); } - /** - * @brief Called by the AccessibilityManager to activate the Control. - * @SINCE_1_0.0 - */ + /// + /// Called by the AccessibilityManager to activate the Control. + /// internal void AccessibilityActivate() { viewWrapperImpl.AccessibilityActivate(); @@ -211,628 +198,511 @@ namespace Tizen.NUI return viewWrapperImpl.EmitKeyEventSignal(key); } - /** - * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene). - * - * This method can also be called from a derived class every time it needs a different size. - * At the end of event processing, the relayout process starts and - * all controls which requested Relayout will have their sizes (re)negotiated. - * - * @note RelayoutRequest() can be called multiple times; the size negotiation is still - * only performed once, i.e. there is no need to keep track of this in the calling side. - */ + /// + /// Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
+ /// This method can also be called from a derived class every time it needs a different size.
+ /// At the end of event processing, the relayout process starts and all controls which requested Relayout will have their sizes (re)negotiated.
+ /// It can be called multiple times; the size negotiation is still only performed once, i.e. there is no need to keep track of this in the calling side.
+ /// protected void RelayoutRequest() { viewWrapperImpl.RelayoutRequest(); } - /** - * @brief Provides the Actor implementation of GetHeightForWidth. - * @param width Width to use. - * @return The height based on the width. - */ + /// + /// Provides the Actor implementation of GetHeightForWidth. + /// + /// Width to use + /// The height based on the width protected float GetHeightForWidthBase(float width) { return viewWrapperImpl.GetHeightForWidthBase(width); } - /** - * @brief Provides the Actor implementation of GetWidthForHeight. - * @param height Height to use. - * @return The width based on the height. - */ + /// + /// Provides the Actor implementation of GetWidthForHeight. + /// + /// Height to use + /// The width based on the height protected float GetWidthForHeightBase(float height) { return viewWrapperImpl.GetWidthForHeightBase(height); } - /** - * @brief Calculate the size for a child using the base actor object. - * - * @param[in] child The child actor to calculate the size for - * @param[in] dimension The dimension to calculate the size for. E.g. width or height - * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found. - */ + /// + /// Calculate the size for a child using the base actor object. + /// + /// The child actor to calculate the size for + /// The dimension to calculate the size for. E.g. width or height + /// Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found protected float CalculateChildSizeBase(Actor child, DimensionType dimension) { return viewWrapperImpl.CalculateChildSizeBase(child, dimension); } - /** - * @brief Determine if this actor is dependent on it's children for relayout from the base class. - * - * @param dimension The dimension(s) to check for - * @return Return if the actor is dependent on it's children. - */ + /// + /// Determine if this actor is dependent on it's children for relayout from the base class. + /// + /// The dimension(s) to check for + /// Return if the actor is dependent on it's children protected bool RelayoutDependentOnChildrenBase(DimensionType dimension) { return viewWrapperImpl.RelayoutDependentOnChildrenBase(dimension); } - /** - * @brief Determine if this actor is dependent on it's children for relayout from the base class. - * - * @param dimension The dimension(s) to check for - * @return Return if the actor is dependent on it's children. - */ + /// + /// Determine if this actor is dependent on it's children for relayout from the base class. + /// + /// Return if the actor is dependent on it's children protected bool RelayoutDependentOnChildrenBase() { return viewWrapperImpl.RelayoutDependentOnChildrenBase(); } - /** - * @brief Register a visual by Property Index, linking an Actor to visual when required. - * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. - * No parenting is done during registration, this should be done by derived class. - * - * @param[in] index The Property index of the visual, used to reference visual - * @param[in] visual The visual to register - * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. - * Use below API with enabled set to false if derived class wishes to control when visual is staged. - */ + /// + /// Register a visual by Property Index, linking an Actor to visual when required.
+ /// In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
+ /// No parenting is done during registration, this should be done by derived class.
+ /// + /// The Property index of the visual, used to reference visual + /// The visual to register protected void RegisterVisual(int index, VisualBase visual) { viewWrapperImpl.RegisterVisual(index, visual); } - /** - * @brief Register a visual by Property Index, linking an Actor to visual when required. - * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. - * If enabled is false then the visual is not set on stage until enabled by the derived class. - * @see EnableVisual - * - * @param[in] index The Property index of the visual, used to reference visual - * @param[in] visual The visual to register - * @param[in] enabled false if derived class wants to control when visual is set on stage. - * - */ + /// + /// Register a visual by Property Index, linking an Actor to visual when required.
+ /// In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
+ /// If enabled is false then the visual is not set on stage until enabled by the derived class.
+ /// + /// The Property index of the visual, used to reference visual + /// The visual to register + /// false if derived class wants to control when visual is set on stage protected void RegisterVisual(int index, VisualBase visual, bool enabled) { viewWrapperImpl.RegisterVisual(index, visual, enabled); } - /** - * @brief Erase the entry matching the given index from the list of registered visuals - * @param[in] index The Property index of the visual, used to reference visual - * - */ + /// + /// Erase the entry matching the given index from the list of registered visuals. + /// + /// The Property index of the visual, used to reference visual protected void UnregisterVisual(int index) { viewWrapperImpl.UnregisterVisual(index); } - /** - * @brief Retrieve the visual associated with the given property index. - * - * @param[in] index The Property index of the visual. - * @return The registered visual if exist, otherwise empty handle. - * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count. - */ + /// + /// Retrieve the visual associated with the given property index.
+ /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
+ /// + /// The Property index of the visual, used to reference visual + /// The registered visual if exist, otherwise empty handle protected VisualBase GetVisual(int index) { return viewWrapperImpl.GetVisual(index); } - /** - * @brief Sets the given visual to be displayed or not when parent staged. - * - * @param[in] index The Property index of the visual - * @param[in] enable flag to set enabled or disabled. - */ + /// + /// Sets the given visual to be displayed or not when parent staged.
+ /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
+ /// + /// The Property index of the visual, used to reference visual + /// flag to set enabled or disabled protected void EnableVisual(int index, bool enable) { viewWrapperImpl.EnableVisual(index, enable); } - /** - * @brief Queries if the given visual is to be displayed when parent staged. - * - * @param[in] index The Property index of the visual - * @return bool whether visual is enabled or not - */ + /// + /// Queries if the given visual is to be displayed when parent staged.
+ /// For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
+ /// + /// The Property index of the visual + /// Whether visual is enabled or not protected bool IsVisualEnabled(int index) { return viewWrapperImpl.IsVisualEnabled(index); } - /** - * @brief Create a transition effect on the control. - * - * @param[in] transitionData The transition data describing the effect to create - * @return A handle to an animation defined with the given effect, or an empty - * handle if no properties match. - */ + /// + /// Create a transition effect on the control. + /// + /// transitionData The transition data describing the effect to create + /// A handle to an animation defined with the given effect, or an empty handle if no properties match protected Animation CreateTransition(TransitionData transitionData) { return viewWrapperImpl.CreateTransition(transitionData); } - /** - * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal - * - * Should be called last by the control after it acts on the Input Focus change. - * - * @param[in] focusGained True if gained, False if lost - */ + /// + /// Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
+ /// Should be called last by the control after it acts on the Input Focus change.
+ /// + /// focusGained True if gained, False if lost protected void EmitFocusSignal(bool focusGained) { viewWrapperImpl.EmitFocusSignal(focusGained); } - /** - * @brief This method is called after the Control has been initialized. - * - * Derived classes should do any second phase initialization by overriding this method. - */ + /// + /// This method is called after the Control has been initialized.
+ /// Derived classes should do any second phase initialization by overriding this method.
+ /// public virtual void OnInitialize() { } - /** - * @brief Called after the actor has been connected to the stage. - * - * When an actor is connected, it will be directly or indirectly parented to the root Actor. - * @param[in] depth The depth in the hierarchy for the actor - * - * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected. - * When the parent of a set of actors is connected to the stage, then all of the children - * will received this callback. - * For the following actor tree, the callback order will be A, B, D, E, C, and finally F. - * - * @code - * - * A (parent) - * / \ - * B C - * / \ \ - * D E F - * - * @endcode - * @param[in] depth The depth in the hierarchy for the actor - */ + /// + /// Called after the actor has been connected to the stage.
+ /// When an actor is connected, it will be directly or indirectly parented to the root Actor.
+ /// The root Actor is provided automatically by Tizen.NUI.Stage, and is always considered to be connected.
+ /// When the parent of a set of actors is connected to the stage, then all of the children will received this callback.
+ /// + /// The depth in the hierarchy for the actor public virtual void OnStageConnection(int depth) { } - /** - * @brief Called after the actor has been disconnected from Stage. - * - * If an actor is disconnected it either has no parent, or is parented to a disconnected actor. - * - * @note When the parent of a set of actors is disconnected to the stage, then all of the children - * will received this callback, starting with the leaf actors. - * For the following actor tree, the callback order will be D, E, B, F, C, and finally A. - * - * @code - * - * A (parent) - * / \ - * B C - * / \ \ - * D E F - * - * @endcode - */ + /// + /// Called after the actor has been disconnected from Stage.
+ /// If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
+ /// When the parent of a set of actors is disconnected to the stage, then all of the children will received this callback, starting with the leaf actors.
+ /// public virtual void OnStageDisconnection() { } - /** - * @brief Called after a child has been added to the owning actor. - * - * @param[in] child The child which has been added - */ + /// + /// Called after a child has been added to the owning actor. + /// + /// The child which has been added public virtual void OnChildAdd(Actor actor) { } - /** - * @brief Called after the owning actor has attempted to remove a child( regardless of whether it succeeded or not ). - * - * @param[in] child The child being removed - */ + /// + /// Called after the owning actor has attempted to remove a child( regardless of whether it succeeded or not ). + /// + /// The child being removed public virtual void OnChildRemove(Actor actor) { } - /** - * @brief Called when the owning actor property is set. - * - * @param[in] index The Property index that was set - * @param[in] propertyValue The value to set - */ + /// + /// Called when the owning actor property is set. + /// + /// The Property index that was set + /// The value to set public virtual void OnPropertySet(int index, Tizen.NUI.PropertyValue propertyValue) { } - /** - * @brief Called when the owning actor's size is set e.g. using Actor::SetSize(). - * - * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor.GetTargetSize. - */ + /// + /// Called when the owning actor's size is set e.g. using Actor.SetSize(). + /// + /// The target size. Note that this target size may not match the size returned via Actor.GetTargetSize public virtual void OnSizeSet(Vector3 targetSize) { } - /** - * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ). - * - * @param[in] animation The object which is animating the owning actor. - * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor.GetTargetSize. - */ + /// + /// Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ). + /// + /// The object which is animating the owning actor + /// The target size. Note that this target size may not match the size returned via @ref Actor.GetTargetSize public virtual void OnSizeAnimation(Animation animation, Vector3 targetSize) { } - /** - * @DEPRECATED_1_1.37 Connect to TouchSignal() instead. - * - * @brief Called after a touch-event is received by the owning actor. - * - * @param[in] touch The touch event - * @return True if the event should be consumed. - * @note CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour). - */ + /// + /// Called after a touch-event is received by the owning actor.
+ /// CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).
+ /// + /// The touch event + /// True if the event should be consumed public virtual bool OnTouch(Touch touch) { return false; // Do not consume } - /** - * @brief Called after a hover-event is received by the owning actor. - * - * @param[in] hover The hover event - * @return True if the hover event should be consumed. - * @note CustomViewBehaviour.REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour). - */ + /// + /// Called after a hover-event is received by the owning actor.
+ /// CustomViewBehaviour.REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).
+ /// + /// The hover event + /// True if the hover event should be consumed public virtual bool OnHover(Hover hover) { return false; // Do not consume } - /** - * @brief Called after a key-event is received by the actor that has had its focus set. - * - * @param[in] key the Key Event - * @return True if the event should be consumed. - */ + /// + /// Called after a key-event is received by the actor that has had its focus set. + /// + /// The key event + /// True if the key event should be consumed public virtual bool OnKey(Key key) { return false; // Do not consume } - /** - * @brief Called after a wheel-event is received by the owning actor. - * - * @param[in] wheel The wheel event - * @return True if the event should be consumed. - * @note CustomViewBehaviour.REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour). - */ + /// + /// Called after a wheel-event is received by the owning actor.
+ /// CustomViewBehaviour.REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).
+ /// + /// The wheel event + /// True if the wheel event should be consumed public virtual bool OnWheel(Wheel wheel) { return false; // Do not consume } - /** - * @brief Called after the size negotiation has been finished for this control. - * - * The control is expected to assign this given size to itself/its children. - * - * Should be overridden by derived classes if they need to layout - * actors differently after certain operations like add or remove - * actors, resize or after changing specific properties. - * - * @param[in] size The allocated size. - * @param[in,out] container The control should add actors to this container that it is not able - * to allocate a size for. - * @note As this function is called from inside the size negotiation algorithm, you cannot - * call RequestRelayout (the call would just be ignored). - */ + /// + /// Called after the size negotiation has been finished for this control.
+ /// The control is expected to assign this given size to itself/its children.
+ /// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties.
+ /// As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).
+ /// + /// The allocated size + /// The control should add actors to this container that it is not able to allocate a size for public virtual void OnRelayout(Vector2 size, RelayoutContainer container) { } - /** - * @brief Notification for deriving classes - * - * @param[in] policy The policy being set - * @param[in] dimension The dimension the policy is being set for - */ + /// + /// Notification for deriving classes. + /// + /// policy The policy being set + /// dimension The dimension the policy is being set for public virtual void OnSetResizePolicy(ResizePolicyType policy, DimensionType dimension) { } - /** - * @brief Return the natural size of the actor. - * - * @return The actor's natural size - */ + /// + /// Return the natural size of the actor. + /// + /// The actor's natural size public virtual Size GetNaturalSize() { return new Size(0.0f, 0.0f, 0.0f); } - /** - * @brief Calculate the size for a child. - * - * @param[in] child The child actor to calculate the size for - * @param[in] dimension The dimension to calculate the size for. E.g. width or height. - * @return Return the calculated size for the given dimension. - */ + /// + /// Calculate the size for a child. + /// + /// The child actor to calculate the size for + /// The dimension to calculate the size for. E.g. width or height + /// Return the calculated size for the given dimension public virtual float CalculateChildSize(Actor child, DimensionType dimension) { return viewWrapperImpl.CalculateChildSizeBase(child, dimension); } - /** - * @brief This method is called during size negotiation when a height is required for a given width. - * - * Derived classes should override this if they wish to customize the height returned. - * - * @param width Width to use. - * @return The height based on the width. - */ + /// + /// This method is called during size negotiation when a height is required for a given width.
+ /// Derived classes should override this if they wish to customize the height returned.
+ /// + /// Width to use + /// The height based on the width public virtual float GetHeightForWidth(float width) { return viewWrapperImpl.GetHeightForWidthBase(width); } - /** - * @brief This method is called during size negotiation when a width is required for a given height. - * - * Derived classes should override this if they wish to customize the width returned. - * - * @param height Height to use. - * @return The width based on the width. - */ + /// + /// This method is called during size negotiation when a width is required for a given height.
+ /// Derived classes should override this if they wish to customize the width returned.
+ /// + /// Height to use + /// The width based on the width public virtual float GetWidthForHeight(float height) { return viewWrapperImpl.GetWidthForHeightBase(height); } - /** - * @brief Determine if this actor is dependent on it's children for relayout. - * - * @param dimension The dimension(s) to check for - * @return Return if the actor is dependent on it's children. - */ + /// + /// Determine if this actor is dependent on it's children for relayout. + /// + /// The dimension(s) to check for + /// Return if the actor is dependent on it's children public virtual bool RelayoutDependentOnChildren(DimensionType dimension) { return viewWrapperImpl.RelayoutDependentOnChildrenBase(dimension); } - /** - * @brief Determine if this actor is dependent on it's children for relayout from the base class. - * - * @return Return if the actor is dependent on it's children. - */ + /// + /// Determine if this actor is dependent on it's children for relayout from the base class. + /// + /// Return true if the actor is dependent on it's children public virtual bool RelayoutDependentOnChildren() { return viewWrapperImpl.RelayoutDependentOnChildrenBase(); } - /** - * @brief Virtual method to notify deriving classes that relayout dependencies have been - * met and the size for this object is about to be calculated for the given dimension - * - * @param dimension The dimension that is about to be calculated - */ + /// + /// Virtual method to notify deriving classes that relayout dependencies have been + /// met and the size for this object is about to be calculated for the given dimension. + /// + /// The dimension that is about to be calculated public virtual void OnCalculateRelayoutSize(DimensionType dimension) { } - /** - * @brief Virtual method to notify deriving classes that the size for a dimension - * has just been negotiated - * - * @param[in] size The new size for the given dimension - * @param[in] dimension The dimension that was just negotiated - */ + /// + /// Virtual method to notify deriving classes that the size for a dimension has just been negotiated. + /// + /// The new size for the given dimension + /// The dimension that was just negotiated public virtual void OnLayoutNegotiated(float size, DimensionType dimension) { } - /** - * @brief This method should be overridden by deriving classes requiring notifications when the style changes. - * - * @param[in] styleManager The StyleManager object. - * @param[in] change Information denoting what has changed. - */ + /// + /// This method should be overridden by deriving classes requiring notifications when the style changes. + /// + /// The StyleManager object + /// Information denoting what has changed public virtual void OnStyleChange(StyleManager styleManager, StyleChangeType change) { } - /** - * @brief This method is called when the control is accessibility activated. - * - * Derived classes should override this to perform custom accessibility activation. - * @return true if this control can perform accessibility activation. - */ + /// + /// This method is called when the control is accessibility activated.
+ /// Derived classes should override this to perform custom accessibility activation.
+ /// + /// true if this control can perform accessibility activation internal virtual bool OnAccessibilityActivated() { return false; } - /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * pan gesture. - * - * @param[in] gesture The pan gesture. - * @return true if the pan gesture has been consumed by this control - */ + /// + /// This method should be overridden by deriving classes when they wish to respond the accessibility. + /// + /// The pan gesture + /// true if the pan gesture has been consumed by this control internal virtual bool OnAccessibilityPan(PanGesture gestures) { return false; } - /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * touch event. - * - * @param[in] touch The touch event. - * @return true if the touch event has been consumed by this control - */ + /// + /// This method should be overridden by deriving classes when they wish to respond the accessibility + /// + /// The touch gesture + /// true if the touch event has been consumed by this control internal virtual bool OnAccessibilityTouch(Touch touch) { return false; } - /** - * @brief This method should be overridden by deriving classes when they wish to respond - * the accessibility up and down action (i.e. value change of slider control). - * - * @param[in] isIncrease Whether the value should be increased or decreased - * @return true if the value changed action has been consumed by this control - */ + /// + /// This method should be overridden by deriving classes when they wish to respond the accessibility up and down action (i.e. value change of slider control). + /// + /// isIncrease Whether the value should be increased or decreased + /// true if the value changed action has been consumed by this control internal virtual bool OnAccessibilityValueChange(bool isIncrease) { return false; } - /** - * @brief This method should be overridden by deriving classes when they wish to respond - * the accessibility zoom action. - * - * @return true if the zoom action has been consumed by this control - */ + /// + /// This method should be overridden by deriving classes when they wish to respond the accessibility zoom action. + /// + /// true if the zoom action has been consumed by this control internal virtual bool OnAccessibilityZoom() { return false; } - /** - * @brief This method should be overridden by deriving classes when they wish to respond - * the accessibility zoom action. - * - * @return true if the zoom action has been consumed by this control - */ + /// + /// Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when focus is gained. + /// public virtual void OnFocusGained() { } - /** - * @brief Called when the control loses key input focus. - * - * Should be overridden by derived classes if they need to customize what happens when focus is lost. - */ + /// + /// Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when focus is lost. + /// public virtual void OnFocusLost() { } - /** - * @brief Gets the next keyboard focusable actor in this control towards the given direction. - * - * A control needs to override this function in order to support two dimensional keyboard navigation. - * @param[in] currentFocusedActor The current focused actor. - * @param[in] direction The direction to move the focus towards. - * @param[in] loopEnabled Whether the focus movement should be looped within the control. - * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused. - */ + /// + /// Gets the next keyboard focusable actor in this control towards the given direction.
+ /// A control needs to override this function in order to support two dimensional keyboard navigation.
+ /// + /// The current focused actor + /// The direction to move the focus towards + /// Whether the focus movement should be looped within the control + /// the next keyboard focusable actor in this control or an empty handle if no actor can be focused public virtual View GetNextFocusableView(View currentFocusedView, View.FocusDirection direction, bool loopEnabled) { return new View(); } - /** - * @brief Informs this control that its chosen focusable actor will be focused. - * - * This allows the application to preform any actions if wishes - * before the focus is actually moved to the chosen actor. - * - * @param[in] commitedFocusableActor The commited focusable actor. - */ + /// + /// Informs this control that its chosen focusable actor will be focused.
+ /// This allows the application to preform any actions if wishes before the focus is actually moved to the chosen actor.
+ /// + /// The commited focused actor public virtual void OnFocusChangeCommitted(View commitedFocusableView) { } - /** - * @brief This method is called when the control has enter pressed on it. - * - * Derived classes should override this to perform custom actions. - * @return true if this control supported this action. - */ + /// + /// This method is called when the control has enter pressed on it.
+ /// Derived classes should override this to perform custom actions.
+ /// + /// true if this control supported this action public virtual bool OnKeyboardEnter() { return false; } - /** - * @brief Called whenever a pinch gesture is detected on this control. - * - * This can be overridden by deriving classes when pinch detection - * is enabled. The default behaviour is to scale the control by the - * pinch scale. - * - * @param[in] pinch The pinch gesture. - * @note If overridden, then the default behaviour will not occur. - * @note Pinch detection should be enabled via EnableGestureDetection(). - * @see EnableGestureDetection - */ + /// + /// Called whenever a pinch gesture is detected on this control.
+ /// This can be overridden by deriving classes when pinch detection is enabled. The default behaviour is to scale the control by the pinch scale.
+ /// If overridden, then the default behaviour will not occur.
+ /// Pinch detection should be enabled via EnableGestureDetection().
+ /// + /// pinch tap gesture internal virtual void OnPinch(PinchGesture pinch) { } - /** - * @brief Called whenever a pan gesture is detected on this control. - * - * This should be overridden by deriving classes when pan detection - * is enabled. - * - * @param[in] pan The pan gesture. - * @note There is no default behaviour with panning. - * @note Pan detection should be enabled via EnableGestureDetection(). - * @see EnableGestureDetection - */ + /// + /// Called whenever a pan gesture is detected on this control.
+ /// This should be overridden by deriving classes when pan detection is enabled.
+ /// There is no default behaviour with panning.
+ /// Pan detection should be enabled via EnableGestureDetection().
+ /// + /// The pan gesture public virtual void OnPan(PanGesture pan) { } - /** - * @brief Called whenever a tap gesture is detected on this control. - * - * This should be overridden by deriving classes when tap detection - * is enabled. - * - * @param[in] tap The tap gesture. - * @note There is no default behaviour with a tap. - * @note Tap detection should be enabled via EnableGestureDetection(). - * @see EnableGestureDetection - */ + /// + /// Called whenever a tap gesture is detected on this control.
+ /// This should be overridden by deriving classes when tap detection is enabled.
+ /// There is no default behaviour with a tap.
+ /// Tap detection should be enabled via EnableGestureDetection().
+ /// + /// The tap gesture public virtual void OnTap(TapGesture tap) { } - /** - * @brief Called whenever a long press gesture is detected on this control. - * - * This should be overridden by deriving classes when long press - * detection is enabled. - * - * @param[in] longPress The long press gesture. - * @note There is no default behaviour associated with a long press. - * @note Long press detection should be enabled via EnableGestureDetection(). - * @see EnableGestureDetection - */ + /// + /// Called whenever a long press gesture is detected on this control.
+ /// This should be overridden by deriving classes when long press detection is enabled.
+ /// There is no default behaviour associated with a long press.
+ /// Long press detection should be enabled via EnableGestureDetection().
+ /// + /// The long press gesture internal virtual void OnLongPress(LongPressGesture longPress) { } @@ -845,6 +715,10 @@ namespace Tizen.NUI { } } + + /// + /// This specifies ccustomView behaviour types. + /// public enum CustomViewBehaviour { ViewBehaviourDefault = 0, diff --git a/Tizen.NUI/src/public/CustomView/Spin.cs b/Tizen.NUI/src/public/CustomView/Spin.cs index d85478e..4fe2bcd 100755 --- a/Tizen.NUI/src/public/CustomView/Spin.cs +++ b/Tizen.NUI/src/public/CustomView/Spin.cs @@ -61,14 +61,17 @@ namespace Tizen.NUI ViewRegistry.Instance.Register(CreateInstance, typeof(Spin)); } + /// + /// Creates an initialized Spin. + /// public Spin() : base(typeof(Spin).Name, CustomViewBehaviour.RequiresKeyboardNavigationSupport) { } /// - /// Override method of OnInitialize() for CustomView class. - /// This method is called after the Control has been initialized. - /// Derived classes should do any second phase initialization by overriding this method. + /// Override method of OnInitialize() for CustomView class.
+ /// This method is called after the Control has been initialized.
+ /// Derived classes should do any second phase initialization by overriding this method.
/// public override void OnInitialize() { @@ -107,8 +110,8 @@ namespace Tizen.NUI } /// - /// Override method of GetNaturalSize() for CustomView class. - /// Return the natural size of the actor. + /// Override method of GetNaturalSize() for CustomView class.
+ /// Return the natural size of the actor.
/// /// Natural size of this Spin itself public override Size GetNaturalSize() @@ -117,9 +120,9 @@ namespace Tizen.NUI } /// - /// Event handler when the TextField in Spin gets the Key focus - /// Make sure when the current spin that takes input focus also takes the keyboard focus - /// For example, when you tap the spin directly + /// Event handler when the TextField in Spin gets the Key focus.
+ /// Make sure when the current spin that takes input focus also takes the keyboard focus.
+ /// For example, when you tap the spin directly.
/// /// Sender of this event /// Event arguments @@ -155,9 +158,9 @@ namespace Tizen.NUI } /// - /// Override method of GetNextKeyboardFocusableView() for CustomView class. - /// Gets the next key focusable view in this View towards the given direction. - /// A View needs to override this function in order to support two dimensional key navigation. + /// Override method of GetNextKeyboardFocusableView() for CustomView class.
+ /// Gets the next key focusable view in this View towards the given direction.
+ /// A View needs to override this function in order to support two dimensional key navigation.
/// /// The current focused view /// The direction to move the focus towards @@ -188,7 +191,7 @@ namespace Tizen.NUI } /// - /// Value to be set in Spin + /// Value to be set in Spin. /// [ScriptableProperty()] public int Value @@ -219,7 +222,7 @@ namespace Tizen.NUI } /// - /// Minimum Value of Spin Value + /// Minimum Value of Spin Value. /// // MinValue property of type int: [ScriptableProperty()] @@ -236,7 +239,7 @@ namespace Tizen.NUI } /// - /// Maximum Value of Spin Value + /// Maximum Value of Spin Value. /// // MaxValue property of type int: [ScriptableProperty()] @@ -253,7 +256,7 @@ namespace Tizen.NUI } /// - /// Increasing, decresing step of Spin Value when Up or Down key is pressed + /// Increasing, decresing step of Spin Value when Up or Down key is pressed. /// // Step property of type int: [ScriptableProperty()] @@ -270,7 +273,7 @@ namespace Tizen.NUI } /// - /// Wrapping enabled status + /// Wrapping enabled status. /// // WrappingEnabled property of type bool: [ScriptableProperty()] @@ -287,7 +290,7 @@ namespace Tizen.NUI } /// - /// Text point size of Spin Value + /// Text point size of Spin Value. /// // TextPointSize property of type int: [ScriptableProperty()] @@ -305,7 +308,7 @@ namespace Tizen.NUI } /// - /// The color of Spin Value + /// The color of Spin Value. /// // TextColor property of type Color: [ScriptableProperty()] @@ -325,7 +328,7 @@ namespace Tizen.NUI } /// - /// Maximum text lengh of Spin Value + /// Maximum text lengh of Spin Value. /// // MaxTextLength property of type int: [ScriptableProperty()] @@ -343,7 +346,7 @@ namespace Tizen.NUI } /// - /// Reference of TextField of Spin + /// Reference of TextField of Spin. /// public TextField SpinText { diff --git a/Tizen.NUI/src/public/CustomView/VisualView.cs b/Tizen.NUI/src/public/CustomView/VisualView.cs index f5cf172..fb971d9 100755 --- a/Tizen.NUI/src/public/CustomView/VisualView.cs +++ b/Tizen.NUI/src/public/CustomView/VisualView.cs @@ -21,17 +21,17 @@ namespace Tizen.NUI using System.Linq; /// - /// A visual view control for user add any visual to it. - /// Example: - /// VisualView _visualView = new VisualView(); - /// ImageVisualMap imageVisualMap1 = new ImageVisualMap(); - /// imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg"; - /// imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f ); - /// imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f ); - /// imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f ); - /// imageVisualMap1.Origin = AlignType.TOP_BEGIN; - /// imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN; - /// _visualView.AddVisual("imageVisual1", imageVisualMap1); + /// A visual view control for user add any visual to it.
+ /// Example:
+ /// VisualView _visualView = new VisualView();
+ /// ImageVisualMap imageVisualMap1 = new ImageVisualMap();
+ /// imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg";
+ /// imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f );
+ /// imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f );
+ /// imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f );
+ /// imageVisualMap1.Origin = AlignType.TOP_BEGIN;
+ /// imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN;
+ /// _visualView.AddVisual("imageVisual1", imageVisualMap1);
/// public class VisualView : CustomView { @@ -134,9 +134,9 @@ namespace Tizen.NUI public int NumberOfVisuals { get - { - return _visualDictionary.Count; - } + { + return _visualDictionary.Count; + } } @@ -149,11 +149,11 @@ namespace Tizen.NUI } /// - /// Override method of OnRelayout() for CustomView class. - /// Called after the size negotiation has been finished for this control. - /// The control is expected to assign this given size to itself/its children. - /// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties. - /// Note! As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored) + /// Override method of OnRelayout() for CustomView class.
+ /// Called after the size negotiation has been finished for this control.
+ /// The control is expected to assign this given size to itself/its children.
+ /// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties.
+ /// Note! As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).
/// /// The allocated size /// The control should add actors to this container that it is not able to allocate a size for. diff --git a/Tizen.NUI/src/public/Degree.cs b/Tizen.NUI/src/public/Degree.cs index 184c062..ba254e5 100755 --- a/Tizen.NUI/src/public/Degree.cs +++ b/Tizen.NUI/src/public/Degree.cs @@ -12,8 +12,8 @@ namespace Tizen.NUI { /// - /// An angle in degrees. - /// This reduces ambiguity when using methods which accept angles in degrees or radians. + /// An angle in degrees.
+ /// This reduces ambiguity when using methods which accept angles in degrees or radians.
/// public class Degree : global::System.IDisposable { diff --git a/Tizen.NUI/src/public/FlexContainer.cs b/Tizen.NUI/src/public/FlexContainer.cs index 54f451d..4c22b38 100755 --- a/Tizen.NUI/src/public/FlexContainer.cs +++ b/Tizen.NUI/src/public/FlexContainer.cs @@ -26,7 +26,12 @@ namespace Tizen.NUI { - + /// + /// FlexContainer implements a subset of the flexbox spec (defined by W3C):https://www.w3.org/TR/css3-flexbox/
+ /// It aims at providing a more efficient way to lay out, align and distribute space among items in the container, even when their size is unknown or dynamic.
+ /// FlexContainer has the ability to alter the width and height of its children (i.e. flex items) to fill the available space in the best possible way on different screen sizes.
+ /// FlexContainer can expand items to fill available free space, or shrink them to prevent overflow.
+ /// public class FlexContainer : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; diff --git a/Tizen.NUI/src/public/FocusManager.cs b/Tizen.NUI/src/public/FocusManager.cs index fd5f9ff..09b7bc5 100755 --- a/Tizen.NUI/src/public/FocusManager.cs +++ b/Tizen.NUI/src/public/FocusManager.cs @@ -24,9 +24,9 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain. - /// It provides functionality of setting the focus and moving the focus in four directions(i.e.Left, Right, Up and Down). - /// It also draws a highlight for the focused View and sends a event when the focus is changed. + /// Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain.
+ /// It provides functionality of setting the focus and moving the focus in four directions(i.e.Left, Right, Up and Down).
+ /// It also draws a highlight for the focused View and sends a event when the focus is changed.
/// public class FocusManager : BaseHandle { @@ -127,6 +127,13 @@ namespace Tizen.NUI internal delegate IntPtr PreFocusChangeEventCallback(IntPtr current, IntPtr proposed, View.FocusDirection direction); private PreFocusChangeEventCallback _preFocusChangeCallback; + /// + /// PreFocusChange will be triggered before the focus is going to be changed.
+ /// FocusManager makes the best guess for which actor to focus towards the given direction, but applications might want to change that.
+ /// By connecting with this event, they can check the proposed actor to focus and return a different actor if they wish.
+ /// This event is only triggered when the navigation key is pressed and KeyboardFocusManager tries to move the focus automatically.
+ /// It won't be emitted for focus movement by calling SetCurrentFocusView directly.
+ /// public event EventHandlerWithReturnType PreFocusChange { add @@ -190,7 +197,7 @@ namespace Tizen.NUI } /// - ///Event arguments that passed via FocusChanged signal + ///Event arguments that passed via FocusChanged signal. /// public class FocusChangedEventArgs : EventArgs { @@ -227,6 +234,9 @@ namespace Tizen.NUI internal delegate void FocusChangedEventCallback(IntPtr current, IntPtr next); private FocusChangedEventCallback _focusChangedEventCallback; + /// + /// FocusGroupChanged will be triggered after the current focused actor has been changed. + /// public event EventHandler FocusChanged { add @@ -263,7 +273,7 @@ namespace Tizen.NUI } /// - ///Event arguments that passed via FocusGroupChanged signal + ///Event arguments that passed via FocusGroupChanged signal. /// public class FocusGroupChangedEventArgs : EventArgs { @@ -300,6 +310,11 @@ namespace Tizen.NUI private delegate void FocusGroupChangedEventCallback(IntPtr current, bool forwardDirection); private FocusGroupChangedEventCallback _focusGroupChangedEventCallback; + /// + /// FocusGroupChanged will be triggered when the focus group has been changed.
+ /// If the current focus group has a parent layout control, FocusManager will make the best guess for the next focus group to move the focus to in the given direction (forward or backward).
+ /// If not, the application has to set the new focus.
+ /// public event EventHandler FocusGroupChanged { add @@ -360,6 +375,9 @@ namespace Tizen.NUI private delegate void FocusedViewEnterKeyEventCallback(IntPtr view); private FocusedViewEnterKeyEventCallback _focusedViewEnterKeyEventCallback; + /// + /// FocusedViewEnterKeyPressed will be triggered when the current focused actor has the enter key pressed on it. + /// public event EventHandler FocusedViewEnterKeyPressed { add @@ -408,9 +426,9 @@ namespace Tizen.NUI } /// - /// Moves the keyboard focus to the given View. - /// Only one View can be focused at the same time. - /// The View must be in the stage already and keyboard focusable. + /// Moves the keyboard focus to the given View.
+ /// Only one View can be focused at the same time.
+ /// The View must be in the stage already and keyboard focusable.
/// /// The View to be focused /// Whether the focus is successful or not @@ -445,8 +463,8 @@ namespace Tizen.NUI } /// - /// Clears the focus from the current focused actor if any, so that no actor is focused in the focus chain. - /// It will emit FocusChanged event without current focused View. + /// Clears the focus from the current focused actor if any, so that no actor is focused in the focus chain.
+ /// It will emit FocusChanged event without current focused View.
/// public void ClearFocus() { @@ -455,8 +473,8 @@ namespace Tizen.NUI } /// - /// Sets/Gets the status of whether the focus movement should be looped within the same focus group. - /// The focus movement is not looped by default. + /// Sets/Gets the status of whether the focus movement should be looped within the same focus group.
+ /// The focus movement is not looped by default.
/// public bool FocusGroupLoop { @@ -484,8 +502,8 @@ namespace Tizen.NUI } /// - /// Sets whether an View is a focus group that can limit the scope of focus movement to its child actors in the focus chain. - /// Layout controls set themselves as focus groups by default. + /// Sets whether an View is a focus group that can limit the scope of focus movement to its child actors in the focus chain.
+ /// Layout controls set themselves as focus groups by default.
/// /// The View to be set as a focus group /// Whether to set the View as a focus group or not @@ -520,8 +538,8 @@ namespace Tizen.NUI } /// - /// Sets/Gets the focus indicator View. - /// This will replace the default focus indicator view in FocusManager and will be added to the focused view as a highlight. + /// Sets/Gets the focus indicator View.
+ /// This will replace the default focus indicator view in FocusManager and will be added to the focused view as a highlight.
/// public View FocusIndicator { @@ -548,6 +566,10 @@ namespace Tizen.NUI return ret; } + /// + /// Provide the implementation of custom Focus algorithm interface to allow the app define the focus logic.
+ /// + /// The user's implementation of ICustomFocusAlgorithm public void SetCustomAlgorithm(ICustomFocusAlgorithm arg0) { _customAlgorithmInterfaceWrapper = new CustomAlgorithmInterfaceWrapper(); @@ -598,6 +620,13 @@ namespace Tizen.NUI } } + /// + /// ICustomFocusAlgorithm is used to provide custom keyboard focus algorithm for retrieving the next focusable actor.
+ /// The application can implement the interface and override the keyboard focus behaviour.
+ /// If focus is changing within a layout container, then the layout container is queried first to provide the next focusable actor.
+ /// If this does not provide a valid actor, then the Keyboard FocusManager will check focusable properties to determine next focusable actor.
+ /// If focusable properties are not set, then the Keyboard FocusManager calls the GetNextFocusableActor() method of this interface.
+ /// public interface ICustomFocusAlgorithm { View GetNextFocusableActor(View current, View proposed, View.FocusDirection direction); diff --git a/Tizen.NUI/src/public/Gesture.cs b/Tizen.NUI/src/public/Gesture.cs index e618442..97fbcf0 100755 --- a/Tizen.NUI/src/public/Gesture.cs +++ b/Tizen.NUI/src/public/Gesture.cs @@ -12,9 +12,9 @@ namespace Tizen.NUI { /// - /// Base structure for different gestures that an application can receive. + /// 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). + /// in a particular order or within a certain time frame (e.g pinch).
/// public class Gesture : global::System.IDisposable { diff --git a/Tizen.NUI/src/public/Hover.cs b/Tizen.NUI/src/public/Hover.cs index ba47a69..4ccdafa 100755 --- a/Tizen.NUI/src/public/Hover.cs +++ b/Tizen.NUI/src/public/Hover.cs @@ -12,9 +12,9 @@ namespace Tizen.NUI { /// - /// Hover events are a collection of points at a specific moment in time. + /// 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. + /// hovered or the points where a hover has stopped.
/// public class Hover : global::System.IDisposable { @@ -80,9 +80,9 @@ namespace Tizen.NUI } /// - /// Returns the ID of the device used for the Point specified. + /// 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. + /// point. This is returned by this method.
/// /// The point required /// The Device ID of this poin diff --git a/Tizen.NUI/src/public/ImageView.cs b/Tizen.NUI/src/public/ImageView.cs index 64c5aaa..9730128 100755 --- a/Tizen.NUI/src/public/ImageView.cs +++ b/Tizen.NUI/src/public/ImageView.cs @@ -28,8 +28,8 @@ 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. + /// 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 { @@ -134,8 +134,8 @@ namespace Tizen.NUI } /// - /// Creates an initialized ImageView from an URL to an image resource. - /// If the string is empty, ImageView will not display anything. + /// 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) @@ -159,9 +159,9 @@ namespace Tizen.NUI 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. + /// 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 @@ -172,8 +172,8 @@ namespace Tizen.NUI return ret; } /// - /// Sets this ImageView from the given URL. - /// If the URL is empty, ImageView will not display anything. + /// 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) @@ -227,8 +227,8 @@ namespace Tizen.NUI } } /// - /// ImageView PreMultipliedAlpha, type Boolean - /// Image must be initialized. + /// ImageView PreMultipliedAlpha, type Boolean.
+ /// Image must be initialized.
/// public bool PreMultipliedAlpha { @@ -244,8 +244,8 @@ namespace Tizen.NUI } } /// - /// 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]. + /// 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 { diff --git a/Tizen.NUI/src/public/KeyFrames.cs b/Tizen.NUI/src/public/KeyFrames.cs index 0c1d63a..7fd8194 100755 --- a/Tizen.NUI/src/public/KeyFrames.cs +++ b/Tizen.NUI/src/public/KeyFrames.cs @@ -28,8 +28,8 @@ 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. + /// 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 { @@ -108,9 +108,9 @@ namespace Tizen.NUI } /// - /// 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. + /// 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 diff --git a/Tizen.NUI/src/public/Layer.cs b/Tizen.NUI/src/public/Layer.cs index f5a323a..203bb94 100755 --- a/Tizen.NUI/src/public/Layer.cs +++ b/Tizen.NUI/src/public/Layer.cs @@ -132,9 +132,9 @@ namespace Tizen.NUI } /// - /// 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. + /// 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 @@ -158,8 +158,8 @@ namespace Tizen.NUI } /// - /// Queries the depth of the layer. - /// 0 is the bottom most layer, higher number is on top. + /// Queries the depth of the layer.
+ /// 0 is the bottom most layer, higher number is on top.
/// public uint Depth { @@ -225,8 +225,8 @@ namespace Tizen.NUI } /// - /// Moves the layer directly above the given layer. - /// After the call, this layers depth will be immediately above target. + /// 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) @@ -236,8 +236,8 @@ namespace Tizen.NUI } /// - /// Moves the layer directly below the given layer - /// After the call, this layers depth will be immediately below target. + /// 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) @@ -279,9 +279,9 @@ namespace Tizen.NUI } /// - /// Sets the clipping box of a layer, in window coordinates. + /// 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. + /// enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
/// /// The clipping box public void SetClippingBox(Rectangle box) diff --git a/Tizen.NUI/src/public/LongPressGesture.cs b/Tizen.NUI/src/public/LongPressGesture.cs index b69a996..9729581 100755 --- a/Tizen.NUI/src/public/LongPressGesture.cs +++ b/Tizen.NUI/src/public/LongPressGesture.cs @@ -12,8 +12,8 @@ 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. + /// 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 { @@ -68,7 +68,7 @@ namespace Tizen.NUI /// /// 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. + /// on the screen to generate the long press gesture.
/// public uint NumberOfTouches { @@ -79,8 +79,8 @@ 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. + /// 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 { @@ -91,8 +91,8 @@ 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. + /// 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 { diff --git a/Tizen.NUI/src/public/NUIApplication.cs b/Tizen.NUI/src/public/NUIApplication.cs index 0ea4cde..e2e80a8 100755 --- a/Tizen.NUI/src/public/NUIApplication.cs +++ b/Tizen.NUI/src/public/NUIApplication.cs @@ -106,8 +106,8 @@ namespace Tizen.NUI } /// - /// Overrides this method if want to handle behavior before calling OnCreate(). - /// stage property is initialized in this overrided method. + /// Overrides this method if want to handle behavior before calling OnCreate().
+ /// stage property is initialized in this overrided method.
/// protected override void OnPreCreate() { @@ -232,6 +232,9 @@ namespace Tizen.NUI Transparent = 1 } + /// + /// Get the window instance. + /// public Window Window { get diff --git a/Tizen.NUI/src/public/PanGesture.cs b/Tizen.NUI/src/public/PanGesture.cs index 97ea9cd..1da2516 100755 --- a/Tizen.NUI/src/public/PanGesture.cs +++ b/Tizen.NUI/src/public/PanGesture.cs @@ -12,13 +12,13 @@ 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. + /// 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 { @@ -72,10 +72,10 @@ 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. + /// 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 { @@ -87,9 +87,9 @@ 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. + /// 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 { @@ -111,11 +111,11 @@ 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. + /// 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 { @@ -127,10 +127,10 @@ 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. + /// 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 { @@ -312,8 +312,8 @@ namespace Tizen.NUI } /// - /// Returns the speed at which the user is moving their fingers. - /// This is the pixel movement per millisecond. + /// 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() @@ -325,8 +325,8 @@ namespace Tizen.NUI /// /// 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. + /// 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() @@ -337,8 +337,8 @@ namespace Tizen.NUI } /// - /// Returns the speed at which the user is moving their fingers relative to screen coordinates. - /// This is the pixel movement per millisecond. + /// 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() @@ -351,8 +351,8 @@ namespace Tizen.NUI /// /// 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. + /// 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() diff --git a/Tizen.NUI/src/public/Path.cs b/Tizen.NUI/src/public/Path.cs index 04aa017..63237f9 100755 --- a/Tizen.NUI/src/public/Path.cs +++ b/Tizen.NUI/src/public/Path.cs @@ -28,8 +28,8 @@ namespace Tizen.NUI { /// - /// A 3D parametric curve. - /// Paths can be used to animate position and orientation of actors. + /// A 3D parametric curve.
+ /// Paths can be used to animate position and orientation of actors.
/// public class Path : Handle { @@ -132,9 +132,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to Path handle. - /// If handle points to a Path object, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to Path handle.
+ /// If handle points to a Path object, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object public new static Path DownCast(BaseHandle handle) @@ -177,12 +177,12 @@ namespace Tizen.NUI } /// - /// Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment. - /// The generating algorithm is as follows: - /// For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1]. - /// Calculate the tangent vector by taking the normal of this bisector. - /// The in control point is the length of the preceding segment back along this bisector multiplied by the curvature. - /// The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature. + /// Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.
+ /// The generating algorithm is as follows:
+ /// For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].
+ /// Calculate the tangent vector by taking the normal of this bisector.
+ /// The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.
+ /// The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.
/// /// The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to 0.5 result in a smooth curve, positive values between 0.5 and 1 result in looped curves where the loops are not distinct (i.e. the curve appears to be non-continuous), positive values higher than 1 result in looped curves public void GenerateControlPoints(float curvature) diff --git a/Tizen.NUI/src/public/PinchGesture.cs b/Tizen.NUI/src/public/PinchGesture.cs index b0b361c..caf5556 100755 --- a/Tizen.NUI/src/public/PinchGesture.cs +++ b/Tizen.NUI/src/public/PinchGesture.cs @@ -12,8 +12,8 @@ namespace Tizen.NUI { /// - /// A PinchGesture is emitted when the user moves two fingers towards or away from each other. - /// A pinch gesture will continue to be sent to the actor under the center point of the pinch until the pinch ends. + /// A PinchGesture is emitted when the user moves two fingers towards or away from each other.
+ /// A pinch gesture will continue to be sent to the actor under the center point of the pinch until the pinch ends.
/// public class PinchGesture : Gesture { @@ -67,10 +67,10 @@ namespace Tizen.NUI } /// - /// The scale factor from the start of the pinch gesture till the latest pinch gesture. + /// The scale factor from the start of the pinch gesture till the latest pinch gesture.
/// If the user is moving their fingers away from each other, then /// this value increases. Conversely, if the user is moving their - /// fingers towards each other, this value will decrease. + /// fingers towards each other, this value will decrease.
/// public float Scale { @@ -81,8 +81,8 @@ namespace Tizen.NUI } /// - /// The speed at which the user is moving their fingers. - /// This is the pixel movement per second. + /// The speed at which the user is moving their fingers.
+ /// This is the pixel movement per second.
/// public float Speed { diff --git a/Tizen.NUI/src/public/Popup.cs b/Tizen.NUI/src/public/Popup.cs index 99c4cb2..f9f3c4e 100755 --- a/Tizen.NUI/src/public/Popup.cs +++ b/Tizen.NUI/src/public/Popup.cs @@ -408,9 +408,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to Popup handle. - /// If handle points to a Popup, the downcast produces valid handle. - /// If not the returned handle is left uninitialized. + /// Downcasts a handle to Popup handle.
+ /// If handle points to a Popup, the downcast produces valid handle.
+ /// If not the returned handle is left uninitialized.
/// /// Handle to an object /// handle to a Popup or an uninitialized handle @@ -473,20 +473,20 @@ namespace Tizen.NUI } /// - /// Sets the display state of Popup. - /// There are 4 total display states. - /// Only 2 can be set, but all four can be read for better inspection of the current popup state. - /// - /// The other two states are getable, but not setable and are there for consistency. - /// - /// | Value | Setting the state | Getting the state | - /// |----------|--------------------------------|--------------------------------| - /// | SHOWN | Show the popup | The popup is fully shown | - /// | HIDDEN | Hide the popup | The popup is fully hidden | - /// | SHOWING | | The popup is transitioning in | - /// | HIDING | | The popup is transitioning out | - /// - /// All 4 state changes cause notifications via 4 respective signals that can be connected to. + /// Sets the display state of Popup.
+ /// There are 4 total display states.
+ /// Only 2 can be set, but all four can be read for better inspection of the current popup state.
+ ///
+ /// The other two states are getable, but not setable and are there for consistency.
+ ///
+ /// | Value | Setting the state | Getting the state |
+ /// |----------|--------------------------------|--------------------------------|
+ /// | SHOWN | Show the popup | The popup is fully shown |
+ /// | HIDDEN | Hide the popup | The popup is fully hidden |
+ /// | SHOWING | | The popup is transitioning in |
+ /// | HIDING | | The popup is transitioning out |
+ ///
+ /// All 4 state changes cause notifications via 4 respective signals that can be connected to.
/// /// The desired display state to change to public void SetDisplayState(Popup.DisplayStateType displayState) @@ -555,8 +555,8 @@ namespace Tizen.NUI } /// - /// The animation mode within popup. - /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties. + /// The animation mode within popup.
+ /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties.
/// public enum AnimationModeType { @@ -567,9 +567,9 @@ namespace Tizen.NUI } /// - /// Types of contextual layout. - /// The Popup is positioned adjacent to it's parent in the direction specified by this mode. - /// NON_CONTEXTUAL disables any contextual positioning. + /// Types of contextual layout.
+ /// The Popup is positioned adjacent to it's parent in the direction specified by this mode.
+ /// NON_CONTEXTUAL disables any contextual positioning.
/// public enum ContextualModeType { @@ -581,7 +581,7 @@ namespace Tizen.NUI } /// - /// Popup title + /// Popup title. /// public PropertyMap Title { @@ -597,7 +597,7 @@ namespace Tizen.NUI } } /// - /// Popup content + /// Popup content. /// public PropertyMap Content { @@ -613,7 +613,7 @@ namespace Tizen.NUI } } /// - /// Popup footer + /// Popup footer. /// public PropertyMap Footer { @@ -629,7 +629,7 @@ namespace Tizen.NUI } } /// - /// Popup display state + /// Popup display state. /// public string DisplayState { @@ -645,7 +645,7 @@ namespace Tizen.NUI } } /// - /// Touch transparent + /// Touch transparent. /// public bool TouchTransparent { @@ -661,7 +661,7 @@ namespace Tizen.NUI } } /// - /// Popup tail visibility + /// Popup tail visibility. /// public bool TailVisibility { @@ -677,7 +677,7 @@ namespace Tizen.NUI } } /// - /// Popup tail position + /// Popup tail position. /// public Vector3 TailPosition { @@ -693,7 +693,7 @@ namespace Tizen.NUI } } /// - /// Contextual mode + /// Contextual mode. /// public string ContextualMode { @@ -709,7 +709,7 @@ namespace Tizen.NUI } } /// - /// Animation duration + /// Animation duration. /// public float AnimationDuration { @@ -725,7 +725,7 @@ namespace Tizen.NUI } } /// - /// Animation mode + /// Animation mode. /// public string AnimationMode { @@ -741,7 +741,7 @@ namespace Tizen.NUI } } /// - /// Entry animation + /// Entry animation. /// public PropertyMap EntryAnimation { @@ -757,7 +757,7 @@ namespace Tizen.NUI } } /// - /// Exit animation + /// Exit animation. /// public PropertyMap ExitAnimation { @@ -773,7 +773,7 @@ namespace Tizen.NUI } } /// - /// Auto hide delay + /// Auto hide delay. /// public int AutoHideDelay { @@ -789,7 +789,7 @@ namespace Tizen.NUI } } /// - /// Backing enabled + /// Backing enabled. /// public bool BackingEnabled { @@ -805,7 +805,7 @@ namespace Tizen.NUI } } /// - /// Backing color + /// Backing color. /// public Vector4 BackingColor { @@ -821,7 +821,7 @@ namespace Tizen.NUI } } /// - /// Background image + /// Background image. /// public string PopupBackgroundImage { @@ -837,7 +837,7 @@ namespace Tizen.NUI } } /// - /// Background border + /// Background border. /// public Rectangle PopupBackgroundBorder { @@ -853,7 +853,7 @@ namespace Tizen.NUI } } /// - /// Tail up image + /// Tail up image. /// public string TailUpImage { @@ -869,7 +869,7 @@ namespace Tizen.NUI } } /// - /// Tail down image + /// Tail down image. /// public string TailDownImage { @@ -885,7 +885,7 @@ namespace Tizen.NUI } } /// - /// Tail left image + /// Tail left image. /// public string TailLeftImage { @@ -901,7 +901,7 @@ namespace Tizen.NUI } } /// - /// Tail right image + /// Tail right image. /// public string TailRightImage { diff --git a/Tizen.NUI/src/public/Position.cs b/Tizen.NUI/src/public/Position.cs index 3aa8a4e..24e9160 100755 --- a/Tizen.NUI/src/public/Position.cs +++ b/Tizen.NUI/src/public/Position.cs @@ -808,6 +808,7 @@ namespace Tizen.NUI } /// + /// Convert a position instance to a vector3 instance. /// public static implicit operator Vector3(Position Position) { @@ -815,6 +816,7 @@ namespace Tizen.NUI } /// + /// Convert a vector3 instance to a position instance. /// public static implicit operator Position(Vector3 vec) { @@ -823,6 +825,9 @@ namespace Tizen.NUI } + /// + /// ParentOrigin constants. + /// public struct ParentOrigin { public static readonly float Top = Position.ParentOriginTop; @@ -840,6 +845,10 @@ namespace Tizen.NUI public static readonly Position BottomCenter = Position.ParentOriginBottomCenter; public static readonly Position BottomRight = Position.ParentOriginBottomRight; } + + /// + /// AnchorPoint constants. + /// public struct AnchorPoint { public static readonly float Top = Position.AnchorPointTop; @@ -857,6 +866,10 @@ namespace Tizen.NUI public static readonly Position BottomCenter = Position.AnchorPointBottomCenter; public static readonly Position BottomRight = Position.AnchorPointBottomRight; } + + /// + /// PositionAxis constants. + /// public struct PositionAxis { public static readonly Position X = Position.XAxis; diff --git a/Tizen.NUI/src/public/Position2D.cs b/Tizen.NUI/src/public/Position2D.cs index 86ee0a6..009f669 100755 --- a/Tizen.NUI/src/public/Position2D.cs +++ b/Tizen.NUI/src/public/Position2D.cs @@ -17,6 +17,9 @@ namespace Tizen.NUI { +/// +/// Position2D is a two dimensional vector. +/// public class Position2D : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; protected bool swigCMemOwn; @@ -52,35 +55,80 @@ public class Position2D : global::System.IDisposable { } } - + /// + /// Addition operator. + /// + /// Vector to add + /// Vector to add + /// A vector containing the result of the addition public static Position2D operator+(Position2D arg1, Position2D arg2) { return arg1.Add(arg2); } + /// + /// Subtraction operator. + /// + /// Vector to subtract + /// Vector to subtract + /// A vector containing the result of the subtraction public static Position2D operator-(Position2D arg1, Position2D arg2) { return arg1.Subtract(arg2); } + /// + /// Unary negation operator. + /// + /// Vector to netate + /// A vector containing the negation public static Position2D operator-(Position2D arg1) { return arg1.Subtract(); } + /// + /// Multiplication operator. + /// + /// Vector to multiply + /// Vector to multiply + /// A vector containing the result of the multiplication public static Position2D operator*(Position2D arg1, Position2D arg2) { return arg1.Multiply(arg2); } + /// + /// Multiplication operator. + /// + /// Vector to multiply + /// The int value to scale the vector + /// A vector containing the result of the multiplication public static Position2D operator*(Position2D arg1, int arg2) { return arg1.Multiply(arg2); } + /// + /// Division operator. + /// + /// Vector to divide + /// Vector to divide + /// A vector containing the result of the division public static Position2D operator/(Position2D arg1, Position2D arg2) { return arg1.Divide(arg2); } + /// + /// Division operator. + /// + /// Vector to divide + /// The int value to scale the vector by + /// A vector containing the result of the division public static Position2D operator/(Position2D arg1, int arg2) { return arg1.Divide(arg2); } + /// + /// Const array subscript operator overload. Should be 0, or 1. + /// + /// Subscript index + /// The float at the given index public float this[uint index] { get @@ -95,15 +143,26 @@ public class Position2D : global::System.IDisposable { return ret; } - + /// + /// Constructor + /// public Position2D() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor + /// + /// x component + /// y component public Position2D(int x, int y) : this(NDalicPINVOKE.new_Vector2__SWIG_1((float)x, (float)y), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor + /// + /// Position to create this vector from public Position2D(Position position) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Position.getCPtr(position)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } @@ -152,12 +211,22 @@ public class Position2D : global::System.IDisposable { return ret; } + /// + /// Compare if rhs is equal to. + /// + /// The vector to compare + /// Returns true if the two vectors are equal, otherwise false public bool EqualTo(Position2D rhs) { bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, Position2D.getCPtr(rhs)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } + /// + /// Compare if rhs is not equal to. + /// + /// The vector to compare + /// Returns true if the two vectors are not equal, otherwise false public bool NotEqualTo(Position2D rhs) { bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, Position2D.getCPtr(rhs)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -170,7 +239,9 @@ public class Position2D : global::System.IDisposable { return ret; } - + /// + /// x component. + /// public int X { set { NDalicPINVOKE.Vector2_X_set(swigCPtr, (float)value); @@ -183,6 +254,9 @@ public class Position2D : global::System.IDisposable { } } + /// + /// y component. + /// public int Y { set { NDalicPINVOKE.Vector2_Y_set(swigCPtr, (float)value); @@ -195,11 +269,17 @@ public class Position2D : global::System.IDisposable { } } + /// + /// Convert a position2D instance to a vector2 instance. + /// public static implicit operator Vector2(Position2D position2d) { return new Vector2((float)position2d.X, (float)position2d.Y); } + /// + /// Convert a vector2 instance to a position2D instance. + /// public static implicit operator Position2D(Vector2 vec) { return new Position2D((int)vec.X, (int)vec.Y); diff --git a/Tizen.NUI/src/public/ProgressBar.cs b/Tizen.NUI/src/public/ProgressBar.cs index 63f4964..316f746 100755 --- a/Tizen.NUI/src/public/ProgressBar.cs +++ b/Tizen.NUI/src/public/ProgressBar.cs @@ -53,6 +53,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make ProgressBar instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -257,9 +260,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to ProgressBar handle. - /// If handle points to a ProgressBar, the downcast produces valid handle. - /// If not the returned handle is left uninitialized. + /// Downcasts a handle to ProgressBar handle.
+ /// If handle points to a ProgressBar, the downcast produces valid handle.
+ /// If not the returned handle is left uninitialized.
/// /// Handle to an object /// handle to a ProgressBar or an uninitialized handle @@ -284,10 +287,10 @@ namespace Tizen.NUI } /// - /// The progress value of progress bar, progress runs form 0 to 1. - /// If Value is set to 0, progress bar will be set to beginning. - /// If Value is set to 1, progress bar will be set to end. - /// Any Value outside of the range is ignored. + /// The progress value of progress bar, progress runs form 0 to 1.
+ /// If Value is set to 0, progress bar will be set to beginning.
+ /// If Value is set to 1, progress bar will be set to end.
+ /// Any Value outside of the range is ignored.
/// public float ProgressValue { @@ -303,11 +306,11 @@ namespace Tizen.NUI } } /// - /// The secondary progress value of progress bar, secondary progress runs form 0 to 1. - /// Optional. If not supplied, the default is 0. - /// If Value is set to 0, progress bar will be set secondary progress to beginning. - /// If Value is set to 1, progress bar will be set secondary progress to end. - /// Any Value outside of the range is ignored. + /// The secondary progress value of progress bar, secondary progress runs form 0 to 1.
+ /// Optional. If not supplied, the default is 0.
+ /// If Value is set to 0, progress bar will be set secondary progress to beginning.
+ /// If Value is set to 1, progress bar will be set secondary progress to end.
+ /// Any Value outside of the range is ignored.
/// public float SecondaryProgressValue { @@ -339,8 +342,8 @@ namespace Tizen.NUI } } /// - /// The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL. - /// Optional. If not supplied, the default track visual will be shown. + /// The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.
+ /// Optional. If not supplied, the default track visual will be shown.
/// public Tizen.NUI.PropertyMap TrackVisual { @@ -356,8 +359,8 @@ namespace Tizen.NUI } } /// - /// The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE. - /// Optional. If not supplied, the default progress visual will be shown. + /// The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.
+ /// Optional. If not supplied, the default progress visual will be shown.
/// public Tizen.NUI.PropertyMap ProgressVisual { @@ -373,8 +376,8 @@ namespace Tizen.NUI } } /// - /// The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE. - /// Optional. If not supplied, the secondary progress visual will not be shown. + /// The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.
+ /// Optional. If not supplied, the secondary progress visual will not be shown.
/// public Tizen.NUI.PropertyMap SecondaryProgressVisual { @@ -390,8 +393,8 @@ namespace Tizen.NUI } } /// - /// The indeterminate visual of progress bar. - /// Optional. If not supplied, the default inditerminate visual will be shown. + /// The indeterminate visual of progress bar.
+ /// Optional. If not supplied, the default inditerminate visual will be shown.
/// public Tizen.NUI.PropertyMap IndeterminateVisual { @@ -407,8 +410,8 @@ namespace Tizen.NUI } } /// - /// The transition data for indeterminate visual animation. - /// Optional. If not supplied, default animation will be played. + /// The transition data for indeterminate visual animation.
+ /// Optional. If not supplied, default animation will be played.
/// public Tizen.NUI.PropertyArray IndeterminateVisualAnimation { diff --git a/Tizen.NUI/src/public/Property.cs b/Tizen.NUI/src/public/Property.cs index abf111c..38931eb 100755 --- a/Tizen.NUI/src/public/Property.cs +++ b/Tizen.NUI/src/public/Property.cs @@ -86,21 +86,45 @@ namespace Tizen.NUI } } + /// + /// Constructor. Create a Property instance. + /// + /// A valid handle to the target object + /// The index of a property public Property(Handle arg0, int propertyIndex) : this(NDalicPINVOKE.new_Property__SWIG_0(Handle.getCPtr(arg0), propertyIndex), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. Create a Property instance. + /// + /// A valid handle to the target object + /// The index of a property + /// Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1) public Property(Handle arg0, int propertyIndex, int componentIndex) : this(NDalicPINVOKE.new_Property__SWIG_1(Handle.getCPtr(arg0), propertyIndex, componentIndex), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. Create a Property instance.
+ /// This performs a property index query and is therefore slower than constructing a Property directly with the index.
+ /// + /// A valid handle to the target object + /// The property name public Property(Handle arg0, string propertyName) : this(NDalicPINVOKE.new_Property__SWIG_2(Handle.getCPtr(arg0), propertyName), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. Create a Property instance.
+ /// This performs a property index query and is therefore slower than constructing a Property directly with the index.
+ /// + /// A valid handle to the target object + /// The property name + /// Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1) public Property(Handle arg0, string propertyName, int componentIndex) : this(NDalicPINVOKE.new_Property__SWIG_3(Handle.getCPtr(arg0), propertyName, componentIndex), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -121,6 +145,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the index of the property. + /// public int propertyIndex { set @@ -136,6 +163,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the componentIndex of the property. + /// public int componentIndex { set @@ -590,8 +620,8 @@ namespace Tizen.NUI } /// - /// Operator to access the element with the specified string key. - /// If an element with the key does not exist, then it is created. + /// Operator to access the element with the specified string key.
+ /// If an element with the key does not exist, then it is created.
/// /// The key whose value to access /// A value for the element with the specified key @@ -604,8 +634,8 @@ namespace Tizen.NUI } /// - /// Operator to access the element with the specified index key. - /// If an element with the key does not exist, then it is created. + /// Operator to access the element with the specified index key.
+ /// If an element with the key does not exist, then it is created.
/// /// The key whose value to access /// A value for the element with the specified key @@ -657,8 +687,8 @@ namespace Tizen.NUI } /// - /// Inserts the key-value pair in the Map, with the key type as string. - /// Does not check for duplicates. + /// Inserts the key-value pair in the Map, with the key type as string.
+ /// Does not check for duplicates.
/// /// The key to insert /// The value to insert @@ -669,8 +699,8 @@ namespace Tizen.NUI } /// - /// Inserts the key-value pair in the Map, with the key type as index. - /// Does not check for duplicates. + /// Inserts the key-value pair in the Map, with the key type as index.
+ /// Does not check for duplicates.
/// /// The key to insert /// The value to insert @@ -681,8 +711,8 @@ namespace Tizen.NUI } /// - /// Inserts the key-value pair in the Map, with the key type as string. - /// Does not check for duplicates. + /// Inserts the key-value pair in the Map, with the key type as string.
+ /// Does not check for duplicates.
/// /// The key to insert /// The value to insert @@ -695,8 +725,8 @@ namespace Tizen.NUI } /// - /// Inserts the key-value pair in the Map, with the key type as string. - /// Does not check for duplicates. + /// Inserts the key-value pair in the Map, with the key type as string.
+ /// Does not check for duplicates.
/// /// The key to insert /// The value to insert @@ -829,8 +859,8 @@ namespace Tizen.NUI } /// - /// Merges values from the map 'from' to the current. - /// Any values in 'from' will overwrite the values in the current map. + /// Merges values from the map 'from' to the current.
+ /// Any values in 'from' will overwrite the values in the current map.
/// /// The map to merge from public void Merge(PropertyMap from) @@ -921,7 +951,7 @@ namespace Tizen.NUI /// /// Extension to property value class that allows us to create a - /// PropertyValue from a C# object, e.g. int, float, string + /// PropertyValue from a C# object, e.g. int, float, string.
/// /// An object to create /// The created value @@ -1440,6 +1470,9 @@ namespace Tizen.NUI } + /// + /// This specifies all the property types. + /// public enum PropertyType { None, @@ -1458,6 +1491,9 @@ namespace Tizen.NUI Map } + /// + /// This specifies the property access mode types. + /// public enum PropertyAccessMode { ReadOnly, diff --git a/Tizen.NUI/src/public/PushButton.cs b/Tizen.NUI/src/public/PushButton.cs index ca01c05..4a22ce2 100755 --- a/Tizen.NUI/src/public/PushButton.cs +++ b/Tizen.NUI/src/public/PushButton.cs @@ -49,6 +49,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make PushButton instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -146,9 +149,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to PushButton handle. - /// If handle points to a PushButton, the downcast produces valid handle. - /// If not the returned handle is left uninitialized. + /// Downcasts a handle to PushButton handle.
+ /// If handle points to a PushButton, the downcast produces valid handle.
+ /// If not the returned handle is left uninitialized.
/// /// Handle to an object /// handle to a PushButton or an uninitialized handle diff --git a/Tizen.NUI/src/public/RadioButton.cs b/Tizen.NUI/src/public/RadioButton.cs index 48527dc..27af97e 100755 --- a/Tizen.NUI/src/public/RadioButton.cs +++ b/Tizen.NUI/src/public/RadioButton.cs @@ -28,17 +28,17 @@ namespace Tizen.NUI { /// - /// A RadioButton provides a radio button which two states \e selected or \e unselected. - /// Radio buttons are designed to select one of many option at the same time. - /// RadioButton can change its current state using Selected. - /// - /// RadioButtons can be grouped. - /// Two or more RadioButtons are in one group when they have this same parent. - /// In each groups only one RadioButton can be \e selected at a given time. - /// So when RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected. - /// When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected. - /// - /// A StateChanged Event is emitted when the RadioButton change its state to \e selected or \e unselected. + /// A RadioButton provides a radio button which two states \e selected or \e unselected.
+ /// Radio buttons are designed to select one of many option at the same time.
+ /// RadioButton can change its current state using Selected.
+ ///
+ /// RadioButtons can be grouped.
+ /// Two or more RadioButtons are in one group when they have this same parent.
+ /// In each groups only one RadioButton can be \e selected at a given time.
+ /// So when RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.
+ /// When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.
+ ///
+ /// A StateChanged Event is emitted when the RadioButton change its state to \e selected or \e unselected.
/// public class RadioButton : Button { @@ -59,6 +59,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make RadioButton instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) diff --git a/Tizen.NUI/src/public/Rectangle.cs b/Tizen.NUI/src/public/Rectangle.cs index e81eb40..5216099 100755 --- a/Tizen.NUI/src/public/Rectangle.cs +++ b/Tizen.NUI/src/public/Rectangle.cs @@ -58,6 +58,13 @@ namespace Tizen.NUI } } + /// + /// Constructor + /// + /// position in x coordinate + /// position in y coordinate + /// Width of the rectangle + /// Height of the rectangle public Rectangle(float x, float y, float width, float height) : this( (int)x, (int)y, (int)width, (int)height ) { } diff --git a/Tizen.NUI/src/public/Rotation.cs b/Tizen.NUI/src/public/Rotation.cs index b42ab5b..5236f5d 100755 --- a/Tizen.NUI/src/public/Rotation.cs +++ b/Tizen.NUI/src/public/Rotation.cs @@ -35,6 +35,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make Rotation instance be disposed. + /// public virtual void Dispose() { if (!Stage.IsInstalled()) diff --git a/Tizen.NUI/src/public/ScrollBar.cs b/Tizen.NUI/src/public/ScrollBar.cs index cb8aed6..fb93738 100755 --- a/Tizen.NUI/src/public/ScrollBar.cs +++ b/Tizen.NUI/src/public/ScrollBar.cs @@ -32,7 +32,7 @@ namespace Tizen.NUI /// /// ScrollBar is a UI component that can be linked to the scrollable objects - /// indicating the current scroll position of the scrollable object. + /// indicating the current scroll position of the scrollable object.
/// public class ScrollBar : View { @@ -53,6 +53,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make ScrollBar instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -276,9 +279,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to ScrollBar handle. - /// If handle points to a ScrollBar, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to ScrollBar handle.
+ /// If handle points to a ScrollBar, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// Handle to a ScrollBar or an uninitialized handle diff --git a/Tizen.NUI/src/public/Size.cs b/Tizen.NUI/src/public/Size.cs index 395302d..4c717eb 100755 --- a/Tizen.NUI/src/public/Size.cs +++ b/Tizen.NUI/src/public/Size.cs @@ -263,8 +263,8 @@ namespace Tizen.NUI } /// - /// Check equality. - /// Utilizes appropriate machine epsilon values. + /// Check equality.
+ /// Utilizes appropriate machine epsilon values.
/// /// The Size to test against /// True if the Sizes are equal @@ -276,8 +276,8 @@ namespace Tizen.NUI } /// - /// Check inequality. - /// Utilizes appropriate machine epsilon values. + /// Check inequality.
+ /// Utilizes appropriate machine epsilon values.
/// /// The Size to test against /// True if the Sizes are not equal diff --git a/Tizen.NUI/src/public/Size2D.cs b/Tizen.NUI/src/public/Size2D.cs index abb45eb..1ae26fd 100755 --- a/Tizen.NUI/src/public/Size2D.cs +++ b/Tizen.NUI/src/public/Size2D.cs @@ -249,8 +249,8 @@ namespace Tizen.NUI } /// - /// Check equality. - /// Utilizes appropriate machine epsilon values. + /// Check equality.
+ /// Utilizes appropriate machine epsilon values.
/// /// The Size to test against /// True if the Sizes are equal @@ -262,8 +262,8 @@ namespace Tizen.NUI } /// - /// Check inequality. - /// Utilizes appropriate machine epsilon values. + /// Check inequality.
+ /// Utilizes appropriate machine epsilon values.
/// /// The Size to test against /// True if the Sizes are not equal diff --git a/Tizen.NUI/src/public/Slider.cs b/Tizen.NUI/src/public/Slider.cs index 31ea4ee..6d7144f 100755 --- a/Tizen.NUI/src/public/Slider.cs +++ b/Tizen.NUI/src/public/Slider.cs @@ -431,9 +431,9 @@ namespace Tizen.NUI } /// - /// Downcasts an Object handle to Slider. - /// If handle points to a Slider, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts an Object handle to Slider.
+ /// If handle points to a Slider, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// Handle to a Slider or an uninitialized handle diff --git a/Tizen.NUI/src/public/Stage.cs b/Tizen.NUI/src/public/Stage.cs index 6e9e69d..83caf58 100755 --- a/Tizen.NUI/src/public/Stage.cs +++ b/Tizen.NUI/src/public/Stage.cs @@ -15,14 +15,14 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// The Stage is a top-level object used for displaying a tree of Actors. - /// Stage is a top-level object that represents the entire screen. + /// The Stage is a top-level object used for displaying a tree of Actors.
+ /// Stage is a top-level object that represents the entire screen.
/// It is used for displaying a hierarchy of actors managed by the scene graph structure, /// which means an actor inherits a position relative to its parent, - /// and can be moved in relation to this point. + /// and can be moved in relation to this point.
/// The stage instance is a singleton object (the only instance of its class during the - /// lifetime of the program). You can get it using a static function. - /// To display the contents of an actor, it must be added to a stage. + /// lifetime of the program). You can get it using a static function.
+ /// To display the contents of an actor, it must be added to a stage.
/// public class Stage : BaseHandle { @@ -97,10 +97,10 @@ namespace Tizen.NUI private EventCallbackDelegateType1 _stageTouchCallbackDelegate; /// - /// This is emitted when the screen is touched and when the touch ends. + /// This is emitted when the screen is touched and when the touch ends.
/// If there are multiple touch points, then this will be emitted when the first touch occurs and - /// then when the last finger is lifted. - /// An interrupted event will also be emitted (if it occurs). + /// then when the last finger is lifted.
+ /// An interrupted event will also be emitted (if it occurs).
/// public event EventHandler Touch { @@ -436,8 +436,8 @@ namespace Tizen.NUI } /// - /// Dpi property (read-only). - /// Retrieves the DPI of the display device to which the stage is connected. + /// Dpi property (read-only).
+ /// Retrieves the DPI of the display device to which the stage is connected.
/// public Vector2 Dpi { @@ -448,8 +448,8 @@ namespace Tizen.NUI } /// - /// Layer count property (read-only). - /// Queries the number of on-stage layers. + /// Layer count property (read-only).
+ /// Queries the number of on-stage layers.
/// public uint LayerCount { @@ -462,8 +462,8 @@ namespace Tizen.NUI private static readonly Stage instance = Stage.GetCurrent(); /// - /// Stage instance property (read-only). - /// Gets the current Stage. + /// Stage instance property (read-only).
+ /// Gets the current Stage.
/// public static Stage Instance { diff --git a/Tizen.NUI/src/public/StyleManager.cs b/Tizen.NUI/src/public/StyleManager.cs index 68fcb9b..c1f77bd 100755 --- a/Tizen.NUI/src/public/StyleManager.cs +++ b/Tizen.NUI/src/public/StyleManager.cs @@ -16,16 +16,16 @@ namespace Tizen.NUI /// /// StyleManager informs applications of system theme change, - /// and supports application theme change at runtime. - /// Applies various styles to Controls using the properties system. + /// and supports application theme change at runtime.
+ /// Applies various styles to Controls using the properties system.
/// On theme change, it automatically updates all controls, then raises - /// a event to inform the application. - /// + /// a event to inform the application.
+ ///
/// If the application wants to customize the theme, RequestThemeChange - /// needs to be called. + /// needs to be called.
/// It provides the path to the application resource root folder, /// from there the filename can an be specified along with - /// any sub folders, e.g Images, Models etc. + /// any sub folders, e.g Images, Models etc.
/// public class StyleManager : BaseHandle { @@ -98,7 +98,7 @@ namespace Tizen.NUI /// /// StyleChange - contains Style change information (default font changed or - /// default font size changed or theme has changed) + /// default font size changed or theme has changed).
/// public StyleChangeType StyleChange { @@ -121,9 +121,9 @@ namespace Tizen.NUI /// /// Event for StyleChanged signal which can be used to subscribe/unsubscribe the - /// event handler provided by the user. + /// event handler provided by the user.
/// StyleChanged signal is is emitted after the style (e.g. theme/font change) has changed - /// and the controls have been informed. + /// and the controls have been informed.
/// public event EventHandler StyleChanged { @@ -170,8 +170,8 @@ namespace Tizen.NUI } /// - /// Creates a StyleManager handle. - /// this can be initialized with StyleManager::Get(). + /// Creates a StyleManager handle.
+ /// this can be initialized with StyleManager::Get().
/// public StyleManager() : this(NDalicPINVOKE.new_StyleManager(), true) { @@ -190,11 +190,11 @@ namespace Tizen.NUI } /// - /// Applies a new theme to the application. - /// This will be merged on top of the default Toolkit theme. + /// Applies a new theme to the application.
+ /// This will be merged on top of the default Toolkit theme.
/// If the application theme file doesn't style all controls that the /// application uses, then the default Toolkit theme will be used - /// instead for those controls. + /// instead for those controls.
/// /// A relative path is specified for style theme public void ApplyTheme(string themeFile) diff --git a/Tizen.NUI/src/public/TableView.cs b/Tizen.NUI/src/public/TableView.cs index a82bb9e..39b484e 100755 --- a/Tizen.NUI/src/public/TableView.cs +++ b/Tizen.NUI/src/public/TableView.cs @@ -28,10 +28,10 @@ namespace Tizen.NUI { /// - /// TableView is a layout container for aligning child actors in a grid like layout. - /// TableView constrains the x and y position and width and height of the child actors. + /// TableView is a layout container for aligning child actors in a grid like layout.
+ /// TableView constrains the x and y position and width and height of the child actors.
/// z position and depth are left intact so that 3D model actors can also be laid out - /// in a grid without loosing their depth scaling. + /// in a grid without loosing their depth scaling.
/// public class TableView : View { @@ -377,9 +377,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to TableView handle. - /// If handle points to a TableView, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to TableView handle.
+ /// If handle points to a TableView, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// Handle to a TableView or an uninitialized handle @@ -391,8 +391,8 @@ namespace Tizen.NUI } /// - /// Adds a child to the table. - /// If the row or column index is outside the table, the table gets resized bigger. + /// Adds a child to the table.
+ /// If the row or column index is outside the table, the table gets resized bigger.
/// /// The child to add /// The position for the child @@ -452,8 +452,8 @@ namespace Tizen.NUI } /// - /// Deletes a row from the given index. - /// Removed elements are deleted. + /// Deletes a row from the given index.
+ /// Removed elements are deleted.
/// /// The rowIndex of the row to delete public void DeleteRow(uint rowIndex) @@ -479,8 +479,8 @@ namespace Tizen.NUI } /// - /// Deletes a column from the given index. - /// Removed elements are deleted. + /// Deletes a column from the given index.
+ /// Removed elements are deleted.
/// /// The columnIndex of the column to delete public void DeleteColumn(uint columnIndex) @@ -578,8 +578,8 @@ namespace Tizen.NUI } /// - /// Sets a row to have fixed height. - /// Setting a fixed height of 0 has no effect. + /// Sets a row to have fixed height.
+ /// Setting a fixed height of 0 has no effect.
/// /// The rowIndex for row with fixed height /// The height in world coordinate units @@ -603,8 +603,8 @@ namespace Tizen.NUI /// /// Sets a row to have relative height. Relative height means percentage of - /// the remainder of the table height after subtracting Padding and Fixed height rows. - /// Setting a relative height of 0 has no effect. + /// the remainder of the table height after subtracting Padding and Fixed height rows.
+ /// Setting a relative height of 0 has no effect.
/// /// The rowIndex for row with relative height /// The height percentage between 0.0f and 1.0f @@ -627,8 +627,8 @@ namespace Tizen.NUI } /// - /// Sets a column to have fixed width. - /// Setting a fixed width of 0 has no effect. + /// Sets a column to have fixed width.
+ /// Setting a fixed width of 0 has no effect.
/// /// The columnIndex for column with fixed width /// The width in world coordinate units @@ -652,8 +652,8 @@ namespace Tizen.NUI /// /// Sets a column to have relative width. Relative width means percentage of - /// the remainder of table width after subtracting Padding and Fixed width columns. - /// Setting a relative width of 0 has no effect. + /// the remainder of table width after subtracting Padding and Fixed width columns.
+ /// Setting a relative width of 0 has no effect.
/// /// The columnIndex for column with fixed width /// The widthPercentage between 0.0f and 1.0f @@ -698,8 +698,8 @@ namespace Tizen.NUI } /// - /// Sets the alignment on a cell. - /// Cells without calling this function have the default values of LEFT and TOP respectively. + /// Sets the alignment on a cell.
+ /// Cells without calling this function have the default values of LEFT and TOP respectively.
/// /// The cell to set alignment on /// The horizontal alignment diff --git a/Tizen.NUI/src/public/TextEditor.cs b/Tizen.NUI/src/public/TextEditor.cs index 6161aea..bb48788 100755 --- a/Tizen.NUI/src/public/TextEditor.cs +++ b/Tizen.NUI/src/public/TextEditor.cs @@ -111,7 +111,7 @@ namespace Tizen.NUI /// /// Event for TextChanged signal which can be used to subscribe/unsubscribe the event handler - /// provided by the user. TextChanged signal is emitted when the text changes. + /// provided by the user. TextChanged signal is emitted when the text changes.
/// public event EventHandler TextChanged { diff --git a/Tizen.NUI/src/public/TextLabel.cs b/Tizen.NUI/src/public/TextLabel.cs index 13b94ed..bef9af1 100755 --- a/Tizen.NUI/src/public/TextLabel.cs +++ b/Tizen.NUI/src/public/TextLabel.cs @@ -28,8 +28,8 @@ namespace Tizen.NUI { /// - /// A control which renders a short text string. - /// Text labels are lightweight, non-editable and do not respond to user input. + /// A control which renders a short text string.
+ /// Text labels are lightweight, non-editable and do not respond to user input.
/// public class TextLabel : View { @@ -196,7 +196,7 @@ namespace Tizen.NUI } /// - /// RenderingBackend property + /// RenderingBackend property.
/// The type of rendering e.g. bitmap-based. /// public int RenderingBackend @@ -214,8 +214,8 @@ namespace Tizen.NUI } /// - /// Text property - /// The text to display in UTF-8 format. + /// Text property.
+ /// The text to display in UTF-8 format.
/// public string Text { @@ -232,8 +232,8 @@ namespace Tizen.NUI } /// - /// FontFamily property - /// The requested font family to use. + /// FontFamily property.
+ /// The requested font family to use.
/// public string FontFamily { @@ -250,8 +250,8 @@ namespace Tizen.NUI } /// - /// FontStyle property - /// The requested font style to use. + /// FontStyle property.
+ /// The requested font style to use.
/// public PropertyMap FontStyle { @@ -268,8 +268,8 @@ namespace Tizen.NUI } /// - /// PointSize property - /// The size of font in points. + /// PointSize property.
+ /// The size of font in points.
/// public float PointSize { @@ -286,8 +286,8 @@ namespace Tizen.NUI } /// - /// MultiLine property - /// The single-line or multi-line layout option. + /// MultiLine property.
+ /// The single-line or multi-line layout option.
/// public bool MultiLine { @@ -304,8 +304,8 @@ namespace Tizen.NUI } /// - /// HorizontalAlignment property - /// The line horizontal alignment. + /// HorizontalAlignment property.
+ /// The line horizontal alignment.
/// public string HorizontalAlignment { @@ -322,8 +322,8 @@ namespace Tizen.NUI } /// - /// VerticalAlignment property - /// The line vertical alignment. + /// VerticalAlignment property.
+ /// The line vertical alignment.
/// public string VerticalAlignment { @@ -340,8 +340,8 @@ namespace Tizen.NUI } /// - /// TextColor property - /// The color of the text. + /// TextColor property.
+ /// The color of the text.
/// public Color TextColor { @@ -358,8 +358,8 @@ namespace Tizen.NUI } /// - /// ShadowOffset property - /// The drop shadow offset 0 indicates no shadow. + /// ShadowOffset property.
+ /// The drop shadow offset 0 indicates no shadow.
/// public Vector2 ShadowOffset { @@ -376,8 +376,8 @@ namespace Tizen.NUI } /// - /// ShadowColor property - /// The color of a drop shadow. + /// ShadowColor property.
+ /// The color of a drop shadow.
/// public Vector4 ShadowColor { @@ -394,8 +394,8 @@ namespace Tizen.NUI } /// - /// UnderlineEnabled property - /// The underline enabled flag. + /// UnderlineEnabled property.
+ /// The underline enabled flag.
/// public bool UnderlineEnabled { @@ -412,8 +412,8 @@ namespace Tizen.NUI } /// - /// UnderlineColor property - /// Overrides the underline height from font metrics. + /// UnderlineColor property.
+ /// Overrides the underline height from font metrics.
/// public Vector4 UnderlineColor { @@ -430,8 +430,8 @@ namespace Tizen.NUI } /// - /// UnderlineHeight property - /// Overrides the underline height from font metrics. + /// UnderlineHeight property.
+ /// Overrides the underline height from font metrics.
/// public float UnderlineHeight { @@ -448,8 +448,8 @@ namespace Tizen.NUI } /// - /// EnableMarkup property - /// Whether the mark-up processing is enabled. + /// EnableMarkup property.
+ /// Whether the mark-up processing is enabled.
/// public bool EnableMarkup { @@ -466,8 +466,8 @@ namespace Tizen.NUI } /// - /// EnableAutoScroll property - /// Starts or stops auto scrolling. + /// EnableAutoScroll property.
+ /// Starts or stops auto scrolling.
/// public bool EnableAutoScroll { @@ -484,8 +484,8 @@ namespace Tizen.NUI } /// - /// AutoScrollSpeed property - /// Sets the speed of scrolling in pixels per second. + /// AutoScrollSpeed property.
+ /// Sets the speed of scrolling in pixels per second.
/// public int AutoScrollSpeed { @@ -502,8 +502,8 @@ namespace Tizen.NUI } /// - /// AutoScrollLoopCount property - /// Number of complete loops when scrolling enabled. + /// AutoScrollLoopCount property.
+ /// Number of complete loops when scrolling enabled.
/// public int AutoScrollLoopCount { @@ -520,8 +520,8 @@ namespace Tizen.NUI } /// - /// AutoScrollGap property - /// Gap before scrolling wraps. + /// AutoScrollGap property.
+ /// Gap before scrolling wraps.
/// public float AutoScrollGap { @@ -538,8 +538,8 @@ namespace Tizen.NUI } /// - /// LineSpacing property - /// The default extra space between lines in points. + /// LineSpacing property.
+ /// The default extra space between lines in points.
/// public float LineSpacing { @@ -556,8 +556,8 @@ namespace Tizen.NUI } /// - /// Underline property - /// The default underline parameters. + /// Underline property.
+ /// The default underline parameters.
/// public PropertyMap Underline { @@ -574,8 +574,8 @@ namespace Tizen.NUI } /// - /// Shadow property - /// The default shadow parameters. + /// Shadow property.
+ /// The default shadow parameters.
/// public PropertyMap Shadow { @@ -592,8 +592,8 @@ namespace Tizen.NUI } /// - /// Emboss property - /// The default emboss parameters. + /// Emboss property.
+ /// The default emboss parameters.
/// public string Emboss { @@ -610,8 +610,8 @@ namespace Tizen.NUI } /// - /// Outline property - /// The default outline parameters. + /// Outline property.
+ /// The default outline parameters.
/// public string Outline { diff --git a/Tizen.NUI/src/public/Timer.cs b/Tizen.NUI/src/public/Timer.cs index 89e2869..549ea52 100755 --- a/Tizen.NUI/src/public/Timer.cs +++ b/Tizen.NUI/src/public/Timer.cs @@ -31,14 +31,14 @@ namespace Tizen.NUI using System.Runtime.InteropServices; /// - /// Mechanism to issue simple periodic or one-shot events. + /// Mechanism to issue simple periodic or one-shot events.
/// Timer is provided for application developers to be able to issue /// simple periodic or one-shot events. Please note that timer /// callback functions should return as soon as possible, because they /// block the next SignalTick. Please note that timer signals are not - /// in sync with Dali's render timer. + /// in sync with Dali's render timer.
/// This class is a handle class so it can be stack allocated and used - /// as a member. + /// as a member.
/// public class Timer : BaseHandle { @@ -85,7 +85,7 @@ namespace Tizen.NUI /// - /// Event arguments that passed via Tick event + /// Event arguments that passed via Tick event. /// public class TickEventArgs : EventArgs { @@ -98,8 +98,8 @@ namespace Tizen.NUI /// /// brief Event for Ticked signal which can be used to subscribe/unsubscribe the event handler - /// (in the type of TickEventHandler-DaliEventHandlerWithReturnType) - /// provided by the user. Ticked signal is emitted after specified time interval. + /// (in the type of TickEventHandler-DaliEventHandlerWithReturnType).
+ /// provided by the user. Ticked signal is emitted after specified time interval.
/// public event EventHandlerWithReturnType Tick { @@ -169,8 +169,8 @@ namespace Tizen.NUI } /// - /// Starts timer - /// In case a Timer is already running, its time is reset and timer is restarted. + /// Starts timer.
+ /// In case a Timer is already running, its time is reset and timer is restarted.
/// public void Start() { @@ -188,8 +188,8 @@ namespace Tizen.NUI } /// - /// Sets a new interval on the timer and starts the timer. - /// Cancels the previous timer. + /// Sets a new interval on the timer and starts the timer.
+ /// Cancels the previous timer.
/// /// milliSec Interval in milliseconds internal void SetInterval(uint milliSec) diff --git a/Tizen.NUI/src/public/Touch.cs b/Tizen.NUI/src/public/Touch.cs index 6118a84..c8ae465 100755 --- a/Tizen.NUI/src/public/Touch.cs +++ b/Tizen.NUI/src/public/Touch.cs @@ -11,9 +11,9 @@ namespace Tizen.NUI { /// - /// Touch events are a collection of points at a specific moment in time. + /// Touch events are a collection of points at a specific moment in time.
/// When a multi-touch event occurs, each point represents the points that are currently being - /// touched or the points where a touch has stopped. + /// touched or the points where a touch has stopped.
/// public class Touch : BaseHandle { @@ -67,8 +67,8 @@ namespace Tizen.NUI } /// - /// An uninitialized Touch instance. - /// Calling member functions with an uninitialized Touch handle is not allowed. + /// An uninitialized Touch instance.
+ /// Calling member functions with an uninitialized Touch handle is not allowed.
/// public Touch() : this(NDalicPINVOKE.new_Touch__SWIG_0(), true) { @@ -110,10 +110,10 @@ namespace Tizen.NUI } /// - /// Returns the ID of the device used for the Point specified. + /// 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. - /// If point is greater than GetPointCount() then this method will return -1. + /// point. This is returned by this method.
+ /// If point is greater than GetPointCount() then this method will return -1.
/// /// The point required /// The Device ID of this point @@ -125,8 +125,8 @@ namespace Tizen.NUI } /// - /// Retrieves the State of the point specified. - /// If point is greater than GetPointCount() then this method will return PointState.Finished. + /// Retrieves the State of the point specified.
+ /// If point is greater than GetPointCount() then this method will return PointState.Finished.
/// /// The point required /// The state of the point specified @@ -138,8 +138,8 @@ namespace Tizen.NUI } /// - /// Retrieves the actor that was underneath the point specified. - /// If point is greater than GetPointCount() then this method will return an empty handle. + /// Retrieves the actor that was underneath the point specified.
+ /// If point is greater than GetPointCount() then this method will return an empty handle.
/// /// The point required /// The actor that was underneath the point specified @@ -151,11 +151,11 @@ namespace Tizen.NUI } /// - /// Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified. - /// The top-left of an actor is (0.0, 0.0, 0.5). + /// Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.
+ /// The top-left of an actor is (0.0, 0.0, 0.5).
/// If you require the local coordinates of another actor (e.g the parent of the hit actor), - /// then you should use Actor::ScreenToLocal(). - /// If point is greater than GetPointCount() then this method will return Vector2.Zero. + /// then you should use Actor::ScreenToLocal().
+ /// If point is greater than GetPointCount() then this method will return Vector2.Zero.
/// /// The point required /// The co-ordinates relative to the top-left of the hit-actor of the point specified @@ -167,8 +167,8 @@ namespace Tizen.NUI } /// - /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified. - /// If point is greater than GetPointCount() then this method will return Vector2.Zero. + /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
+ /// If point is greater than GetPointCount() then this method will return Vector2.Zero.
/// /// The point required /// The co-ordinates relative to the top-left of the screen of the point specified @@ -180,9 +180,9 @@ namespace Tizen.NUI } /// - /// Retrieves the radius of the press point. - /// This is the average of both the horizontal and vertical radii of the press point. - /// If point is greater than GetPointCount() then this method will return 0.0f. + /// Retrieves the radius of the press point.
+ /// This is the average of both the horizontal and vertical radii of the press point.
+ /// If point is greater than GetPointCount() then this method will return 0.0f.
/// /// The point required /// The radius of the press point @@ -194,8 +194,8 @@ namespace Tizen.NUI } /// - /// Retrieves BOTH the horizontal and the vertical radii of the press point. - /// If point is greater than GetPointCount() then this method will return Vector2.Zero. + /// Retrieves BOTH the horizontal and the vertical radii of the press point.
+ /// If point is greater than GetPointCount() then this method will return Vector2.Zero.
/// /// The point required /// The horizontal and vertical radii of the press point @@ -207,12 +207,12 @@ namespace Tizen.NUI } /// - /// Retrieves the touch pressure. - /// The pressure range starts at 0.0f. - /// Normal pressure is defined as 1.0f. - /// A value between 0.0f and 1.0f means light pressure has been applied. - /// A value greater than 1.0f means more pressure than normal has been applied. - /// If point is greater than GetPointCount() then this method will return 1.0f. + /// Retrieves the touch pressure.
+ /// The pressure range starts at 0.0f.
+ /// Normal pressure is defined as 1.0f.
+ /// A value between 0.0f and 1.0f means light pressure has been applied.
+ /// A value greater than 1.0f means more pressure than normal has been applied.
+ /// If point is greater than GetPointCount() then this method will return 1.0f.
/// /// point The point required /// The touch pressure diff --git a/Tizen.NUI/src/public/Vector2.cs b/Tizen.NUI/src/public/Vector2.cs index 888130d..27d0fc4 100755 --- a/Tizen.NUI/src/public/Vector2.cs +++ b/Tizen.NUI/src/public/Vector2.cs @@ -428,9 +428,9 @@ namespace Tizen.NUI } /// - /// Returns the length of the vector squared. + /// Returns the length of the vector squared.
/// This is more efficient than Length() for threshold - /// testing as it avoids the use of a square root. + /// testing as it avoids the use of a square root.
/// /// The length of the vector squared public float LengthSquared() diff --git a/Tizen.NUI/src/public/Vector3.cs b/Tizen.NUI/src/public/Vector3.cs index ef7f883..1bc3de0 100755 --- a/Tizen.NUI/src/public/Vector3.cs +++ b/Tizen.NUI/src/public/Vector3.cs @@ -478,9 +478,9 @@ namespace Tizen.NUI } /// - /// Returns the length of the vector squared. + /// Returns the length of the vector squared.
/// This is more efficient than Length() for threshold - /// testing as it avoids the use of a square root. + /// testing as it avoids the use of a square root.
/// /// The length of the vector squared public float LengthSquared() diff --git a/Tizen.NUI/src/public/Vector4.cs b/Tizen.NUI/src/public/Vector4.cs index 491dc51..627e5bd 100755 --- a/Tizen.NUI/src/public/Vector4.cs +++ b/Tizen.NUI/src/public/Vector4.cs @@ -444,9 +444,9 @@ namespace Tizen.NUI } /// - /// Returns the length of the vector squared. + /// Returns the length of the vector squared.
/// This is faster than using Length() when performing - /// threshold checks as it avoids use of the square root. + /// threshold checks as it avoids use of the square root.
/// /// The length of the vector squared public float LengthSquared() @@ -457,8 +457,8 @@ namespace Tizen.NUI } /// - /// Normalizes the vector. - /// Sets the vector to unit length whilst maintaining its direction. + /// Normalizes the vector.
+ /// Sets the vector to unit length whilst maintaining its direction.
/// public void Normalize() { diff --git a/Tizen.NUI/src/public/VideoView.cs b/Tizen.NUI/src/public/VideoView.cs index 74a5678..e295efc 100755 --- a/Tizen.NUI/src/public/VideoView.cs +++ b/Tizen.NUI/src/public/VideoView.cs @@ -108,8 +108,8 @@ namespace Tizen.NUI /// /// Event for Finished signal which can be used to subscribe/unsubscribe the event handler - /// (in the type of FinishedEventHandler-DaliEventHandler) provided by the user. - /// Finished signal is emitted when a video playback have finished. + /// (in the type of FinishedEventHandler-DaliEventHandler) provided by the user.
+ /// Finished signal is emitted when a video playback have finished.
/// public event EventHandler Finished { @@ -215,8 +215,8 @@ namespace Tizen.NUI } /// - /// Creates an initialized VideoView. - /// If the string is empty, VideoView will not display anything. + /// Creates an initialized VideoView.
+ /// If the string is empty, VideoView will not display anything.
/// /// The url of the video resource to display public VideoView(string url) : this(NDalicPINVOKE.VideoView_New__SWIG_1(url), true) @@ -237,9 +237,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to VideoView handle. - /// If handle points to a VideoView, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to VideoView handle.
+ /// If handle points to a VideoView, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// Handle to a VideoView or an uninitialized handle diff --git a/Tizen.NUI/src/public/View.cs b/Tizen.NUI/src/public/View.cs index e877f2e..42bd8da 100755 --- a/Tizen.NUI/src/public/View.cs +++ b/Tizen.NUI/src/public/View.cs @@ -83,10 +83,10 @@ namespace Tizen.NUI private delegate void KeyInputFocusGainedCallbackType(IntPtr control); private KeyInputFocusGainedCallbackType _keyInputFocusGainedCallback; - /** - * @brief Event for KeyInputFocusGained signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. KeyInputFocusGained signal is emitted when the control gets Key Input Focus. - */ + /// + /// Event for KeyInputFocusGained signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// KeyInputFocusGained signal is emitted when the control gets Key Input Focus.
+ /// public event EventHandler FocusGained { add @@ -125,10 +125,10 @@ namespace Tizen.NUI private delegate void KeyInputFocusLostCallbackType(IntPtr control); private KeyInputFocusLostCallbackType _keyInputFocusLostCallback; - /** - * @brief Event for KeyInputFocusLost signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. KeyInputFocusLost signal is emitted when the control loses Key Input Focus. - */ + /// + /// Event for KeyInputFocusLost signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// KeyInputFocusLost signal is emitted when the control loses Key Input Focus.
+ /// public event EventHandler FocusLost { add @@ -161,19 +161,16 @@ namespace Tizen.NUI } } - - /** - * @brief Event arguments that passed via KeyEvent signal - * - */ + /// + /// Event arguments that passed via KeyEvent signal. + /// public class KeyEventArgs : EventArgs { private Key _key; - /** - * @brief KeyEvent - is the keyevent sent to the View. - * - */ + /// + /// Key - is the key sent to the View. + /// public Key Key { get @@ -192,10 +189,10 @@ namespace Tizen.NUI private delegate bool KeyCallbackType(IntPtr control, IntPtr keyEvent); private KeyCallbackType _keyCallback; - /** - * @brief Event for KeyPressed signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. KeyPressed signal is emitted when key event is received. - */ + /// + /// Event for KeyPressed signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// KeyPressed signal is emitted when key event is received.
+ /// public event EventHandlerWithReturnType KeyEvent { add @@ -239,10 +236,10 @@ namespace Tizen.NUI private delegate void OnRelayoutEventCallbackType(IntPtr control); private OnRelayoutEventCallbackType _onRelayoutEventCallback; - /** - * @brief Event for OnRelayout signal which can be used to subscribe/unsubscribe the event handler - * OnRelayout signal is emitted after the size has been set on the view during relayout. - */ + /// + /// Event for OnRelayout signal which can be used to subscribe/unsubscribe the event handler.
+ /// OnRelayout signal is emitted after the size has been set on the view during relayout.
+ /// public event EventHandler OnRelayoutEvent { add @@ -277,19 +274,16 @@ namespace Tizen.NUI } } - - /** - * @brief Event arguments that passed via Touch signal - * - */ + /// + /// Event arguments that passed via Touch signal. + /// public class TouchEventArgs : EventArgs { private Touch _touch; - /** - * @brief TouchData - contains the information of touch points - * - */ + /// + /// Touch - contains the information of touch points + /// public Touch Touch { get @@ -308,10 +302,10 @@ namespace Tizen.NUI private delegate bool TouchDataCallbackType(IntPtr view, IntPtr touchData); private TouchDataCallbackType _touchDataCallback; - /** - * @brief Event for Touched signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. Touched signal is emitted when touch input is received. - */ + /// + /// Event for Touched signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// Touched signal is emitted when touch input is received.
+ /// public event EventHandlerWithReturnType Touched { add @@ -352,18 +346,16 @@ namespace Tizen.NUI } - /** - * @brief Event arguments that passed via Hover signal - * - */ + /// + /// Event arguments that passed via Hover signal. + /// public class HoverEventArgs : EventArgs { private Hover _hover; - /** - * @brief HoverEvent - contains touch points that represent the points - * that are currently being hovered or the points where a hover has stopped - * - */ + + /// + /// Hover - contains touch points that represent the points that are currently being hovered or the points where a hover has stopped. + /// public Hover Hover { get @@ -382,10 +374,10 @@ namespace Tizen.NUI private delegate bool HoverEventCallbackType(IntPtr view, IntPtr hoverEvent); private HoverEventCallbackType _hoverEventCallback; - /** - * @brief Event for Hovered signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. Hovered signal is emitted when hover input is received. - */ + /// + /// Event for Hovered signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// Hovered signal is emitted when hover input is received.
+ /// public event EventHandlerWithReturnType Hovered { add @@ -426,17 +418,16 @@ namespace Tizen.NUI } - /** - * @brief Event arguments that passed via Wheel signal - * - */ + /// + /// Event arguments that passed via Wheel signal. + /// public class WheelEventArgs : EventArgs { private Wheel _wheel; - /** - * @brief WheelEvent - store a wheel rolling type : MOUSE_WHEEL or CUSTOM_WHEEL - * - */ + + /// + /// WheelEvent - store a wheel rolling type : MOUSE_WHEEL or CUSTOM_WHEEL + /// public Wheel Wheel { get @@ -455,10 +446,10 @@ namespace Tizen.NUI private delegate bool WheelEventCallbackType(IntPtr view, IntPtr wheelEvent); private WheelEventCallbackType _wheelEventCallback; - /** - * @brief Event for WheelMoved signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. WheelMoved signal is emitted when wheel event is received. - */ + /// + /// Event for WheelMoved signal which can be used to subscribe/unsubscribe the event handler provided by the user.
+ /// WheelMoved signal is emitted when wheel event is received.
+ /// public event EventHandlerWithReturnType WheelMoved { add @@ -504,10 +495,10 @@ namespace Tizen.NUI private delegate void OnStageEventCallbackType(IntPtr control); private OnStageEventCallbackType _onStageEventCallback; - /** - * @brief Event for OnStage signal which can be used to subscribe/unsubscribe the event handler - * OnStage signal is emitted after the view has been connected to the stage. - */ + /// + /// Event for OnStage signal which can be used to subscribe/unsubscribe the event handler.
+ /// OnStage signal is emitted after the view has been connected to the stage.
+ /// public event EventHandler OnStageEvent { add @@ -547,10 +538,10 @@ namespace Tizen.NUI private delegate void OffStageEventCallbackType(IntPtr control); private OffStageEventCallbackType _offStageEventCallback; - /** - * @brief Event for OffStage signal which can be used to subscribe/unsubscribe the event handler - * OffStage signal is emitted after the view has been disconnected from the stage. - */ + /// + /// Event for OffStage signal which can be used to subscribe/unsubscribe the event handler.
+ /// OffStage signal is emitted after the view has been disconnected from the stage.
+ /// public event EventHandler OffStageEvent { add @@ -690,9 +681,9 @@ namespace Tizen.NUI } /// - /// Downcasts a handle to View handle. - /// If handle points to a View, the downcast produces valid handle. - /// If not, the returned handle is left uninitialized. + /// Downcasts a handle to View handle.
+ /// If handle points to a View, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
/// /// Handle to an object /// A handle to a View or an uninitialized handle @@ -1099,9 +1090,9 @@ namespace Tizen.NUI } /// - /// Child Property of FlexContainer - /// The proportion of the free space in the container the flex item will receive. - /// If all items in the container set this property, their sizes will be proportional to the specified flex factor + /// Child Property of FlexContainer.
+ /// The proportion of the free space in the container the flex item will receive.
+ /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.
/// public float Flex { @@ -1118,8 +1109,8 @@ namespace Tizen.NUI } /// - /// Child Property of FlexContainer - /// The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container + /// Child Property of FlexContainer.
+ /// The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container.
/// public int AlignSelf { @@ -1136,8 +1127,8 @@ namespace Tizen.NUI } /// - /// Child Property of FlexContainer - /// The space around the flex item + /// Child Property of FlexContainer.
+ /// The space around the flex item.
/// public Vector4 FlexMargin { @@ -1239,9 +1230,9 @@ namespace Tizen.NUI } /// - /// The left focusable view. - /// This will return NULL if not set. - /// This will also return NULL if the specified left focusable view is not on stage. + /// The left focusable view.
+ /// This will return NULL if not set.
+ /// This will also return NULL if the specified left focusable view is not on stage.
/// public View LeftFocusableView { @@ -1261,9 +1252,9 @@ namespace Tizen.NUI } /// - /// The right focusable view. - /// This will return NULL if not set. - /// This will also return NULL if the specified right focusable view is not on stage. + /// The right focusable view.
+ /// This will return NULL if not set.
+ /// This will also return NULL if the specified right focusable view is not on stage.
/// public View RightFocusableView { @@ -1283,9 +1274,9 @@ namespace Tizen.NUI } /// - /// The up focusable view. - /// This will return NULL if not set. - /// This will also return NULL if the specified up focusable view is not on stage. + /// The up focusable view.
+ /// This will return NULL if not set.
+ /// This will also return NULL if the specified up focusable view is not on stage.
/// public View UpFocusableView { @@ -1305,9 +1296,9 @@ namespace Tizen.NUI } /// - /// The down focusable view. - /// This will return NULL if not set. - /// This will also return NULL if the specified down focusable view is not on stage. + /// The down focusable view.
+ /// This will return NULL if not set.
+ /// This will also return NULL if the specified down focusable view is not on stage.
/// public View DownFocusableView { diff --git a/Tizen.NUI/src/public/VisualBase.cs b/Tizen.NUI/src/public/VisualBase.cs index 91bb66e..990774f 100755 --- a/Tizen.NUI/src/public/VisualBase.cs +++ b/Tizen.NUI/src/public/VisualBase.cs @@ -12,10 +12,10 @@ namespace Tizen.NUI { /// - /// Sets whether the actor should be focusable by keyboard navigation. - /// Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on-stage. - /// Each visual also responds to actor size and color change, and provides clipping at the renderer level. - /// Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator. + /// Sets whether the actor should be focusable by keyboard navigation.
+ /// Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on-stage.
+ /// Each visual also responds to actor size and color change, and provides clipping at the renderer level.
+ /// Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
/// public class VisualBase : BaseHandle { @@ -138,9 +138,9 @@ namespace Tizen.NUI } /// - /// Return the natural size of the visual. - /// Deriving classes stipulate the natural size and by default a visual has a ZERO natural size. - /// A visual may not actually have a natural size until it has been placed on stage and acquired all it's resources. + /// Return the natural size of the visual.
+ /// Deriving classes stipulate the natural size and by default a visual has a ZERO natural size.
+ /// A visual may not actually have a natural size until it has been placed on stage and acquired all it's resources.
/// /// The visual's natural size public void GetNaturalSize(Size2D naturalSize) diff --git a/Tizen.NUI/src/public/VisualMaps.cs b/Tizen.NUI/src/public/VisualMaps.cs index 54bfd57..393fdd6 100755 --- a/Tizen.NUI/src/public/VisualMaps.cs +++ b/Tizen.NUI/src/public/VisualMaps.cs @@ -40,9 +40,9 @@ namespace Tizen.NUI } /// - /// Get or set size of the visual. + /// Get or set size of the visual.
/// It can be either relative (percentage of the parent) - /// or absolute (in world units). + /// or absolute (in world units).
/// public Vector2 VisualSize { @@ -57,9 +57,9 @@ namespace Tizen.NUI } /// - /// Get or set offset of the visual. + /// Get or set offset of the visual.
/// It can be either relative (percentage of the parent) - /// or absolute (in world units). + /// or absolute (in world units).
/// public Vector2 Offset { @@ -74,10 +74,10 @@ namespace Tizen.NUI } /// - /// Get or set offset policy of the visual. + /// Get or set offset policy of the visual.
/// Indicates which components of the offset are relative - /// (percentage of the parent) or absolute (in world units). - /// 0 indicates the component is relative, and 1 absolute. + /// (percentage of the parent) or absolute (in world units).
+ /// 0 indicates the component is relative, and 1 absolute.
/// public Vector2 OffsetPolicy { @@ -92,10 +92,10 @@ namespace Tizen.NUI } /// - /// Get or set size policy of the visual. + /// Get or set size policy of the visual.
/// Indicates which components of the size are relative - /// (percentage of the parent) or absolute (in world units). - /// 0 indicates the component is relative, and 1 absolute. + /// (percentage of the parent) or absolute (in world units).
+ /// 0 indicates the component is relative, and 1 absolute.
/// public Vector2 SizePolicy { @@ -234,9 +234,9 @@ namespace Tizen.NUI } /// - /// Get or set fitting options, used when resizing images to fit desired dimensions. - /// If not supplied, default is FittingMode::SHRINK_TO_FIT. - /// For Normal Quad images only. + /// Get or set fitting options, used when resizing images to fit desired dimensions.
+ /// If not supplied, default is FittingMode::SHRINK_TO_FIT.
+ /// For Normal Quad images only.
/// public FittingModeType FittingMode { @@ -251,9 +251,9 @@ namespace Tizen.NUI } /// - /// Get or set filtering options, used when resizing images to sample original pixels. - /// If not supplied, default is SamplingMode::BOX. - /// For Normal Quad images only. + /// Get or set filtering options, used when resizing images to sample original pixels.
+ /// If not supplied, default is SamplingMode::BOX.
+ /// For Normal Quad images only.
/// public SamplingModeType SamplingMode { @@ -268,9 +268,9 @@ namespace Tizen.NUI } /// - /// Get or set the desired image width. - /// If not specified, the actual image width is used. - /// For Normal Quad images only. + /// Get or set the desired image width.
+ /// If not specified, the actual image width is used.
+ /// For Normal Quad images only.
/// public int DesiredWidth { @@ -285,9 +285,9 @@ namespace Tizen.NUI } /// - /// Get or set the desired image height. - /// If not specified, the actual image height is used. - /// For Normal Quad images only. + /// Get or set the desired image height.
+ /// If not specified, the actual image height is used.
+ /// For Normal Quad images only.
/// public int DesiredHeight { @@ -302,9 +302,9 @@ namespace Tizen.NUI } /// - /// Get or set whether to load the image synchronously. - /// If not specified, the default is false, i.e. the image is loaded asynchronously. - /// For Normal Quad images only. + /// Get or set whether to load the image synchronously.
+ /// If not specified, the default is false, i.e. the image is loaded asynchronously.
+ /// For Normal Quad images only.
/// public bool SynchronousLoading { @@ -319,9 +319,9 @@ namespace Tizen.NUI } /// - /// Get or set whether to draws the borders only(If true). - /// If not specified, the default is false. - /// For N-Patch images only. + /// Get or set whether to draws the borders only(If true).
+ /// If not specified, the default is false.
+ /// For N-Patch images only.
/// public bool BorderOnly { @@ -336,11 +336,11 @@ namespace Tizen.NUI } /// - /// Get or set the image area to be displayed. - /// It is a rectangular area. - /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively. - /// If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image. - /// For For Normal QUAD image only. + /// Get or set the image area to be displayed.
+ /// It is a rectangular area.
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
+ /// If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image.
+ /// For For Normal QUAD image only.
/// public Vector4 PixelArea { @@ -355,10 +355,10 @@ namespace Tizen.NUI } /// - /// Get or set the wrap mode for u coordinate. - /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0. - /// If not specified, the default is CLAMP. - /// For Normal QUAD image only. + /// Get or set the wrap mode for u coordinate.
+ /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
+ /// If not specified, the default is CLAMP.
+ /// For Normal QUAD image only.
/// public WrapModeType WrapModeU { @@ -373,10 +373,10 @@ namespace Tizen.NUI } /// - /// Get or set the wrap mode for v coordinate. - /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0. - /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively. - /// If not specified, the default is CLAMP. + /// Get or set the wrap mode for v coordinate.
+ /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
+ /// If not specified, the default is CLAMP.
/// For Normal QUAD image only. /// public WrapModeType WrapModeV @@ -515,8 +515,8 @@ namespace Tizen.NUI } /// - /// Get or set the line horizontal alignment. - /// If not specified, the default is BEGIN. + /// Get or set the line horizontal alignment.
+ /// If not specified, the default is BEGIN.
/// public string HorizontalAlignment { @@ -531,8 +531,8 @@ namespace Tizen.NUI } /// - /// Get or set the line vertical alignment. - /// If not specified, the default is TOP. + /// Get or set the line vertical alignment.
+ /// If not specified, the default is TOP.
/// public string VerticalAlignment { @@ -652,8 +652,8 @@ namespace Tizen.NUI } /// - /// Get or set whether anti-aliasing of the border is required. - /// If not supplied, default is false. + /// Get or set whether anti-aliasing of the border is required.
+ /// If not supplied, default is false.
/// public bool AntiAliasing { @@ -733,8 +733,8 @@ namespace Tizen.NUI private GradientVisualSpreadMethodType _spreadMethod = GradientVisualSpreadMethodType.Pad; /// - /// Get or set the start position of a linear gradient. - /// Mandatory for Linear. + /// Get or set the start position of a linear gradient.
+ /// Mandatory for Linear.
/// public Vector2 StartPosition { @@ -749,8 +749,8 @@ namespace Tizen.NUI } /// - /// Get or set the end position of a linear gradient. - /// Mandatory for Linear. + /// Get or set the end position of a linear gradient.
+ /// Mandatory for Linear.
/// public Vector2 EndPosition { @@ -765,8 +765,8 @@ namespace Tizen.NUI } /// - /// Get or set the center point of a radial gradient. - /// Mandatory for Radial. + /// Get or set the center point of a radial gradient.
+ /// Mandatory for Radial.
/// public Vector2 Center { @@ -781,8 +781,8 @@ namespace Tizen.NUI } /// - /// Get or set the size of the radius of a radial gradient. - /// Mandatory for Radial. + /// Get or set the size of the radius of a radial gradient.
+ /// Mandatory for Radial.
/// public float Radius { @@ -797,9 +797,9 @@ namespace Tizen.NUI } /// - /// Get or set all the stop offsets. - /// A PropertyArray of float. - /// If not supplied, default is 0.0f and 1.0f. + /// Get or set all the stop offsets.
+ /// A PropertyArray of float.
+ /// If not supplied, default is 0.0f and 1.0f.
/// public PropertyArray StopOffset { @@ -814,9 +814,9 @@ namespace Tizen.NUI } /// - /// Get or set the color at the stop offsets. - /// A PropertyArray of Color. - /// At least 2 values required to show a gradient. + /// Get or set the color at the stop offsets.
+ /// A PropertyArray of Color.
+ /// At least 2 values required to show a gradient.
/// public PropertyArray StopColor { @@ -831,8 +831,8 @@ namespace Tizen.NUI } /// - /// Get or set defines the coordinate system for certain attributes of the points in a gradient. - /// If not supplied, default is GradientVisualUnitsType.OBJECT_BOUNDING_BOX. + /// Get or set defines the coordinate system for certain attributes of the points in a gradient.
+ /// If not supplied, default is GradientVisualUnitsType.OBJECT_BOUNDING_BOX.
/// public GradientVisualUnitsType Units { @@ -847,8 +847,8 @@ namespace Tizen.NUI } /// - /// Get or set indicates what happens if the gradient starts or ends inside the bounds of the target rectangle. - /// If not supplied, default is GradientVisualSpreadMethodType.PAD. + /// Get or set indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
+ /// If not supplied, default is GradientVisualSpreadMethodType.PAD.
/// public GradientVisualSpreadMethodType SpreadMethod { @@ -919,8 +919,8 @@ namespace Tizen.NUI } /// - /// Get or set the location of the ".mtl" file. - /// If not specified, then a textureless object is assumed. + /// Get or set the location of the ".mtl" file.
+ /// If not specified, then a textureless object is assumed.
/// public string MaterialtURL { @@ -935,8 +935,8 @@ namespace Tizen.NUI } /// - /// Get or set path to the directory the textures (including gloss and normal) are stored in. - /// Mandatory if using material. + /// Get or set path to the directory the textures (including gloss and normal) are stored in.
+ /// Mandatory if using material.
/// public string TexturesPath { @@ -951,9 +951,9 @@ namespace Tizen.NUI } /// - /// Get or set the type of shading mode that the mesh will use. - /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead. - /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TEXTURED_WITH_DETAILED_SPECULAR_LIGHTING first). + /// Get or set the type of shading mode that the mesh will use.
+ /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead.
+ /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TEXTURED_WITH_DETAILED_SPECULAR_LIGHTING first).
/// public MeshVisualShadingModeValue ShadingMode { @@ -968,8 +968,8 @@ namespace Tizen.NUI } /// - /// Get or set whether to use mipmaps for textures or not. - /// If not specified, the default is true. + /// Get or set whether to use mipmaps for textures or not.
+ /// If not specified, the default is true.
/// public bool UseMipmapping { @@ -984,8 +984,8 @@ namespace Tizen.NUI } /// - /// Get or set whether to average normals at each point to smooth textures or not. - /// If not specified, the default is true. + /// Get or set whether to average normals at each point to smooth textures or not.
+ /// If not specified, the default is true.
/// public bool UseSoftNormals { @@ -1000,10 +1000,10 @@ namespace Tizen.NUI } /// - /// Get or set the position, in stage space, of the point light that applies lighting to the model. + /// Get or set the position, in stage space, of the point light that applies lighting to the model.
/// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center, - /// and using all zeroes will place the light at the top left corner. - /// If not specified, the default is an offset outwards from the center of the screen. + /// and using all zeroes will place the light at the top left corner.
+ /// If not specified, the default is an offset outwards from the center of the screen.
/// public Vector3 LightPosition { @@ -1066,8 +1066,8 @@ namespace Tizen.NUI private Vector3 _lightPosition = null; // default ?? center of screen /// - /// Get or set the specific shape to render. - /// If not specified, the default is PrimitiveVisualShapeType.SPHERE. + /// Get or set the specific shape to render.
+ /// If not specified, the default is PrimitiveVisualShapeType.SPHERE.
/// public PrimitiveVisualShapeType Shape { @@ -1082,9 +1082,9 @@ namespace Tizen.NUI } /// - /// Get or set the color of the shape. - /// If not specified, the default is Color(0.5, 0.5, 0.5, 1.0). - /// Applies to ALL shapes. + /// Get or set the color of the shape.
+ /// If not specified, the default is Color(0.5, 0.5, 0.5, 1.0).
+ /// Applies to ALL shapes.
/// public Color MixColor { @@ -1099,10 +1099,10 @@ namespace Tizen.NUI } /// - /// Get or set the number of slices as you go around the shape. - /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object. - /// If not specified, the default is 128. - /// The range is from 1 to 255. + /// Get or set the number of slices as you go around the shape.
+ /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object.
+ /// If not specified, the default is 128.
+ /// The range is from 1 to 255.
/// public int Slices { @@ -1117,10 +1117,10 @@ namespace Tizen.NUI } /// - /// Get or set the number of stacks as you go down the shape. - /// For spheres, 'stacks' determines how many layers there are as you go down the object. - /// If not specified, the default is 128. - /// The range is from 1 to 255. + /// Get or set the number of stacks as you go down the shape.
+ /// For spheres, 'stacks' determines how many layers there are as you go down the object.
+ /// If not specified, the default is 128.
+ /// The range is from 1 to 255.
/// public int Stacks { @@ -1135,10 +1135,10 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of the top circle of a conical frustrum. - /// If not specified, the default is 1.0f. - /// Applies to: - PrimitiveVisualShapeType.CONICAL_FRUSTRUM - /// Only values greater than or equal to 0.0f are accepted. + /// Get or set the scale of the radius of the top circle of a conical frustrum.
+ /// If not specified, the default is 1.0f.
+ /// Applies to: - PrimitiveVisualShapeType.CONICAL_FRUSTRUM
+ /// Only values greater than or equal to 0.0f are accepted.
/// public float ScaleTopRadius { @@ -1153,11 +1153,11 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of the bottom circle of a conical frustrum. - /// If not specified, the default is 1.5f. - /// Applies to: - PrimitiveVisualShapeType.CONICAL_FRUSTRUM - /// - PrimitiveVisualShapeType.CONE - /// Only values greater than or equal to 0.0f are accepted. + /// Get or set the scale of the radius of the bottom circle of a conical frustrum.
+ /// If not specified, the default is 1.5f.
+ /// Applies to: - PrimitiveVisualShapeType.CONICAL_FRUSTRUM
+ /// - PrimitiveVisualShapeType.CONE
+ /// Only values greater than or equal to 0.0f are accepted.
/// public float ScaleBottomRadius { @@ -1172,13 +1172,13 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the height of a conic. - /// If not specified, the default is 3.0f. - /// Applies to: - /// - Shape::CONICAL_FRUSTRUM - /// - Shape::CONE - /// - Shape::CYLINDER - /// Only values greater than or equal to 0.0f are accepted. + /// Get or set the scale of the height of a conic.
+ /// If not specified, the default is 3.0f.
+ /// Applies to:
+ /// - Shape::CONICAL_FRUSTRUM
+ /// - Shape::CONE
+ /// - Shape::CYLINDER
+ /// Only values greater than or equal to 0.0f are accepted.
/// public float ScaleHeight { @@ -1193,11 +1193,11 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of a cylinder. - /// If not specified, the default is 1.0f. - /// Applies to: - /// - Shape::CYLINDER - /// Only values greater than or equal to 0.0f are accepted. + /// Get or set the scale of the radius of a cylinder.
+ /// If not specified, the default is 1.0f.
+ /// Applies to:
+ /// - Shape::CYLINDER
+ /// Only values greater than or equal to 0.0f are accepted.
/// public float ScaleRadius { @@ -1212,13 +1212,13 @@ namespace Tizen.NUI } /// - /// Get or set the dimensions of a cuboid. Scales in the same fashion as a 9-patch image. - /// If not specified, the default is Vector3.One. - /// Applies to: - /// - Shape::CUBE - /// - Shape::OCTAHEDRON - /// - Shape::BEVELLED_CUBE - /// Each vector3 parameter should be greater than or equal to 0.0f. + /// Get or set the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
+ /// If not specified, the default is Vector3.One.
+ /// Applies to:
+ /// - Shape::CUBE
+ /// - Shape::OCTAHEDRON
+ /// - Shape::BEVELLED_CUBE
+ /// Each vector3 parameter should be greater than or equal to 0.0f.
/// public Vector3 ScaleDimensions { @@ -1233,12 +1233,12 @@ namespace Tizen.NUI } /// - /// Get or set determines how bevelled the cuboid should be, based off the smallest dimension. - /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube. - /// If not specified, the default is 0.0f (no bevel). - /// Applies to: - /// - Shape::BEVELLED_CUBE - /// The range is from 0.0f to 1.0f. + /// Get or set determines how bevelled the cuboid should be, based off the smallest dimension.
+ /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.
+ /// If not specified, the default is 0.0f (no bevel).
+ /// Applies to:
+ /// - Shape::BEVELLED_CUBE
+ /// The range is from 0.0f to 1.0f.
/// public float BevelPercentage { @@ -1253,11 +1253,11 @@ namespace Tizen.NUI } /// - /// Get or set defines how smooth the bevelled edges should be. - /// If not specified, the default is 0.0f (sharp edges). - /// Applies to: - /// - Shape::BEVELLED_CUBE - /// The range is from 0.0f to 1.0f. + /// Get or set defines how smooth the bevelled edges should be.
+ /// If not specified, the default is 0.0f (sharp edges).
+ /// Applies to:
+ /// - Shape::BEVELLED_CUBE
+ /// The range is from 0.0f to 1.0f.
/// public float BevelSmoothness { @@ -1272,10 +1272,10 @@ namespace Tizen.NUI } /// - /// Get or set the position, in stage space, of the point light that applies lighting to the model. + /// Get or set the position, in stage space, of the point light that applies lighting to the model.
/// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center, - /// and using all zeroes will place the light at the top left corner. - /// If not specified, the default is an offset outwards from the center of the screen. + /// and using all zeroes will place the light at the top left corner.
+ /// If not specified, the default is an offset outwards from the center of the screen.
/// Applies to ALL shapes. /// public Vector3 LightPosition @@ -1342,9 +1342,9 @@ namespace Tizen.NUI } /// - /// Get or set whether to draws the borders only(If true). - /// If not specified, the default is false. - /// For N-Patch images only. + /// Get or set whether to draws the borders only(If true).
+ /// If not specified, the default is false.
+ /// For N-Patch images only.
/// public bool BorderOnly { @@ -1387,7 +1387,9 @@ namespace Tizen.NUI } - + /// + /// This specifies wrap mode types + /// public enum WrapModeType { Default = 0, @@ -1396,12 +1398,19 @@ namespace Tizen.NUI MirroredRepeat } + /// + /// This specifies all kind os types of coordinate system for certain attributes of the points in a gradient. + /// public enum GradientVisualUnitsType { ObjectBoundingBox, UserSpace } + /// + /// This specifies SpreadMethod types.
+ /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.
+ /// public enum GradientVisualSpreadMethodType { Pad, @@ -1409,6 +1418,9 @@ namespace Tizen.NUI Repeat } + /// + /// This specifies shading mode types. + /// public enum MeshVisualShadingModeValue { TexturelessWithDiffuseLighting, @@ -1416,6 +1428,9 @@ namespace Tizen.NUI TexturedWithDetailedSpecularLighting } + /// + /// This specifies shape types. + /// public enum PrimitiveVisualShapeType { Sphere, @@ -1427,6 +1442,11 @@ namespace Tizen.NUI BevelledCube } + /// + /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.
+ /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.
+ /// All fitting modes preserve the aspect ratio of the image contents.
+ /// public enum FittingModeType { ShrinkToFit, @@ -1435,6 +1455,12 @@ namespace Tizen.NUI FitHeight } + /// + /// This specifies sampling mode types. Filtering options, used when resizing images to sample original pixels.
+ /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during a scaling.
+ /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and FittingMode, + /// but all other filter modes do if the desired dimensions are `<=` the raw dimensions of the input image file.
+ /// public enum SamplingModeType { Box, @@ -1446,12 +1472,18 @@ namespace Tizen.NUI DontCare } + /// + /// This specifies policy types that could be used by the transform for the offset or size. + /// public enum VisualTransformPolicyType { Relative = 0, Absolute = 1 } + /// + /// This specifies align types. + /// public enum AlignType { TopBegin = 0, @@ -1465,6 +1497,9 @@ namespace Tizen.NUI BottomEnd } + /// + /// This specifies all the transform property types. + /// public enum VisualTransformPropertyType { Offset, @@ -1475,6 +1510,9 @@ namespace Tizen.NUI SizePolicy } + /// + /// This specifies visual types. + /// public struct Visual { public enum Type @@ -1490,6 +1528,9 @@ namespace Tizen.NUI NPatch } + /// + /// This specifies visual properties. + /// public struct Property { public static readonly int Type = NDalic.VISUAL_PROPERTY_TYPE; @@ -1499,6 +1540,9 @@ namespace Tizen.NUI public static readonly int MixColor = NDalic.VISUAL_PROPERTY_MIX_COLOR; } + /// + /// This specifies shader properties. + /// public struct ShaderProperty { public static readonly int VertexShader = NDalic.VISUAL_SHADER_VERTEX; @@ -1509,6 +1553,9 @@ namespace Tizen.NUI } } + /// + /// This specifies properties of BorderVisual. + /// public struct BorderVisualProperty { public static readonly int Color = NDalic.BORDER_VISUAL_COLOR; @@ -1516,11 +1563,17 @@ namespace Tizen.NUI public static readonly int AntiAliasing = NDalic.BORDER_VISUAL_ANTI_ALIASING; } + /// + /// This specifies properties of ColorVisual. + /// public struct ColorVisualProperty { public static readonly int MixColor = NDalic.COLOR_VISUAL_MIX_COLOR; } + /// + /// This specifies properties of GradientVisual. + /// public struct GradientVisualProperty { public static readonly int StartPosition = NDalic.GRADIENT_VISUAL_START_POSITION; @@ -1533,6 +1586,9 @@ namespace Tizen.NUI public static readonly int SpreadMethod = NDalic.GRADIENT_VISUAL_SPREAD_METHOD; } + /// + /// This specifies properties of ImageVisual. + /// public struct ImageVisualProperty { public static readonly int URL = NDalic.IMAGE_VISUAL_URL; @@ -1547,6 +1603,9 @@ namespace Tizen.NUI public static readonly int WrapModeV = NDalic.IMAGE_VISUAL_WRAP_MODE_V; } + /// + /// This specifies properties of MeshVisual. + /// public struct MeshVisualProperty { public static readonly int ObjectURL = NDalic.MESH_VISUAL_OBJECT_URL; @@ -1558,6 +1617,9 @@ namespace Tizen.NUI public static readonly int LightPosition = NDalic.MESH_VISUAL_LIGHT_POSITION; } + /// + /// This specifies properties of PrimitiveVisual. + /// public struct PrimitiveVisualProperty { public static readonly int Shape = NDalic.PRIMITIVE_VISUAL_SHAPE; @@ -1574,6 +1636,9 @@ namespace Tizen.NUI public static readonly int LightPosition = NDalic.PRIMITIVE_VISUAL_LIGHT_POSITION; } + /// + /// This specifies properties of TextVisual. + /// public struct TextVisualProperty { public static readonly int Text = NDalic.TEXT_VISUAL_TEXT; @@ -1586,7 +1651,11 @@ namespace Tizen.NUI public static readonly int TextColor = NDalic.TEXT_VISUAL_TEXT_COLOR; public static readonly int EnableMarkup = NDalic.TEXT_VISUAL_ENABLE_MARKUP; } - public struct NpatchImageVisualProperty + + /// + /// This specifies properties of NpatchImageVisual. + /// + public struct NpatchImageVisualProperty { public static readonly int URL = NDalic.IMAGE_VISUAL_URL; public static readonly int FittingMode = NDalic.IMAGE_VISUAL_FITTING_MODE; diff --git a/Tizen.NUI/src/public/Wheel.cs b/Tizen.NUI/src/public/Wheel.cs index 280956f..8ee1324 100755 --- a/Tizen.NUI/src/public/Wheel.cs +++ b/Tizen.NUI/src/public/Wheel.cs @@ -13,13 +13,13 @@ namespace Tizen.NUI /// /// 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. - /// + /// processing of the wheel rolling and passing to other libraries like Toolkit.
+ ///
/// 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. - /// - /// 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. - /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the stage. + /// supplied to check if they have been pressed when the wheel is being rolled.
+ ///
+ /// 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.
+ /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the stage.
/// public class Wheel : global::System.IDisposable { diff --git a/Tizen.NUI/src/public/Window.cs b/Tizen.NUI/src/public/Window.cs index 7d7ad51..2322e1d 100755 --- a/Tizen.NUI/src/public/Window.cs +++ b/Tizen.NUI/src/public/Window.cs @@ -32,8 +32,8 @@ namespace Tizen.NUI /// - /// The window class is used internally for drawing. - /// A Window has an orientation and indicator properties. + /// The window class is used internally for drawing.
+ /// A Window has an orientation and indicator properties.
/// public class Window : BaseHandle { @@ -54,6 +54,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make Window instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -78,31 +81,45 @@ namespace Tizen.NUI } } - + /// + /// Sets the focus acceptable flag of an window as true. + /// public void SetAcceptFocus(bool accept) { NDalicPINVOKE.SetAcceptFocus(swigCPtr, accept); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves whether the window is focus acceptable or not. + /// public bool IsFocusAcceptable() { return NDalicPINVOKE.IsFocusAcceptable(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Shows the window if it is hidden. + /// public void Show() { NDalicPINVOKE.Show(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Hides the window if it is showing. + /// public void Hide() { NDalicPINVOKE.Hide(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves whether the window is visible or not. + /// public void IsVisible() { NDalicPINVOKE.IsVisible(swigCPtr); @@ -247,8 +264,8 @@ namespace Tizen.NUI } /// - /// This sets the orientation of indicator bar. - /// It does not implicitly show the indicator if it is currently hidden. + /// This sets the orientation of indicator bar.
+ /// It does not implicitly show the indicator if it is currently hidden.
/// /// The orientation internal void RotateIndicator(Window.WindowOrientation orientation)