From: dongsug.song Date: Fri, 17 Mar 2017 08:13:06 +0000 (+0900) Subject: API reference commenting task X-Git-Tag: preview1-00180^2~353 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4209dbda7325e0b43e7cbbf1ab5b62de93beb7bf;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git API reference commenting task Signed-off-by: dongsug.song Change-Id: Icbaea37dbb11b28a17c7e87b53131c9806570237 --- diff --git a/src/Tizen.NUI/src/public/Actor.cs b/src/Tizen.NUI/src/public/Actor.cs index d688e65..51f57c4 100755 --- a/src/Tizen.NUI/src/public/Actor.cs +++ b/src/Tizen.NUI/src/public/Actor.cs @@ -1,28 +1,21 @@ -/** Copyright (c) 2017 Samsung Electronics Co., Ltd. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -* -*/ -// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed + namespace Tizen.NUI { @@ -30,6 +23,10 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; + /// + /// Actor is the primary object with which Dali applications interact. + /// UI controls can be built by combining multiple actors. + /// public class Actor : Handle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -49,6 +46,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make Actor instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -87,6 +87,10 @@ namespace Tizen.NUI return (IntPtr)swigCPtr; } + /// + /// Retrieve the position of the Actor. + /// The coordinates are relative to the Actor's parent. + /// public Position CurrentPosition { get @@ -94,6 +98,11 @@ namespace Tizen.NUI return GetCurrentPosition(); } } + + /// + /// Retrieve the size of the Actor. + /// The coordinates are relative to the Actor's parent. + /// public Size CurrentSize { get @@ -102,6 +111,9 @@ namespace Tizen.NUI } } + /// + /// Retrieves the actor's parent. + /// public Actor Parent { get @@ -110,6 +122,9 @@ namespace Tizen.NUI } } + /// + /// Retrieves and sets the actor's opacity. + /// public float Opacity { get @@ -124,6 +139,9 @@ namespace Tizen.NUI } } + /// + /// Retrieves screen postion of actor's + /// public Vector2 ScreenPosition { get @@ -134,6 +152,12 @@ 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. + /// public bool PositionUsesAnchorPoint { get @@ -148,6 +172,10 @@ 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. + /// public bool IsOnStage { get @@ -156,6 +184,9 @@ namespace Tizen.NUI } } + /// + /// Gets depth in the hierarchy for the actor. + /// public int HierarchyDepth { get @@ -164,6 +195,12 @@ 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. + /// public int SiblingOrder { get @@ -178,6 +215,12 @@ 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. + /// public Size2D Size2D { get @@ -192,6 +235,11 @@ 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. + /// public Position2D Position2D { get @@ -206,47 +254,93 @@ 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. + /// public void Show() { SetVisible(true); } + /// + /// Sets the visibility flag of an actor as false to be hidden. + /// public void Hide() { SetVisible(false); } + /// + /// 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() { NDalicPINVOKE.Raise(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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() { NDalicPINVOKE.Lower(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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() { NDalicPINVOKE.RaiseToTop(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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() { NDalicPINVOKE.LowerToBottom(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { NDalicPINVOKE.RaiseAbove(swigCPtr, Actor.getCPtr(target)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { NDalicPINVOKE.RaiseAbove(swigCPtr, Actor.getCPtr(target)); @@ -359,11 +453,22 @@ namespace Tizen.NUI } + /// + /// Creates an initialized Actor. + /// public Actor() : this(NDalicPINVOKE.Actor_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// 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 public new static Actor DownCast(BaseHandle handle) { Actor ret = new Actor(NDalicPINVOKE.Actor_DownCast(BaseHandle.getCPtr(handle)), true); @@ -431,12 +536,24 @@ namespace Tizen.NUI return ret; } + /// + /// 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) { NDalicPINVOKE.Actor_Add(swigCPtr, Actor.getCPtr(child)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { NDalicPINVOKE.Actor_Remove(swigCPtr, Actor.getCPtr(child)); @@ -449,6 +566,11 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the number of children held by the actor. + /// Precondition : The Actor has been initialized. + /// + /// The number of children public uint GetChildCount() { uint ret = NDalicPINVOKE.Actor_GetChildCount(swigCPtr); @@ -456,6 +578,12 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public Actor GetChildAt(uint index) { Actor ret = new Actor(NDalicPINVOKE.Actor_GetChildAt(swigCPtr, index), true); @@ -463,6 +591,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public Actor FindChildByName(string actorName) { Actor ret = new Actor(NDalicPINVOKE.Actor_FindChildByName(swigCPtr, actorName), true); @@ -548,6 +683,11 @@ namespace Tizen.NUI return ret; } + /// + /// 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() { Vector3 ret = new Vector3(NDalicPINVOKE.Actor_GetNaturalSize(swigCPtr), true); @@ -837,6 +977,16 @@ namespace Tizen.NUI return ret; } + /// + /// 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 + /// The screen X-coordinate + /// The screen Y-coordinate + /// True if the conversion succeeded public bool ScreenToLocal(out float localX, out float localY, float screenX, float screenY) { bool ret = NDalicPINVOKE.Actor_ScreenToLocal(swigCPtr, out localX, out localY, screenX, screenY); @@ -896,6 +1046,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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) { NDalicPINVOKE.Actor_SetSizeModeFactor(swigCPtr, Vector3.getCPtr(factor)); @@ -909,6 +1066,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public float GetHeightForWidth(float width) { float ret = NDalicPINVOKE.Actor_GetHeightForWidth(swigCPtr, width); @@ -916,6 +1080,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public float GetWidthForHeight(float height) { float ret = NDalicPINVOKE.Actor_GetWidthForHeight(swigCPtr, height); @@ -930,12 +1101,20 @@ namespace Tizen.NUI return ret; } + /// + /// Sets the padding for use in layout. + /// + /// padding Padding for the actor public void SetPadding(PaddingType padding) { NDalicPINVOKE.Actor_SetPadding(swigCPtr, PaddingType.getCPtr(padding)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Returns the value of the padding. + /// + /// The returned padding data public void GetPadding(PaddingType paddingOut) { NDalicPINVOKE.Actor_GetPadding(swigCPtr, PaddingType.getCPtr(paddingOut)); @@ -1057,6 +1236,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 { get @@ -1071,6 +1257,14 @@ 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. + /// Precondition : The Actor has been initialized. + /// public Position AnchorPoint { get @@ -1084,6 +1278,13 @@ namespace Tizen.NUI SetProperty(Actor.Property.ANCHOR_POINT, new Tizen.NUI.PropertyValue(value)); } } + + + /// + /// 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 { get @@ -1097,6 +1298,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the size width of an actor. + /// public float SizeWidth { get @@ -1110,6 +1315,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SIZE_WIDTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the size height of an actor. + /// public float SizeHeight { get @@ -1123,6 +1332,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SIZE_HEIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the size depth of an actor. + /// public float SizeDepth { get @@ -1136,6 +1349,12 @@ namespace Tizen.NUI SetProperty(Actor.Property.SIZE_DEPTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// 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 { get @@ -1149,6 +1368,11 @@ namespace Tizen.NUI SetProperty(Actor.Property.POSITION, new Tizen.NUI.PropertyValue(value)); } } + + + /// + /// Gets/Sets the position x of the Actor. + /// public float PositionX { get @@ -1162,6 +1386,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.POSITION_X, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the position y of the Actor. + /// public float PositionY { get @@ -1175,6 +1403,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.POSITION_Y, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the position z of the Actor. + /// public float PositionZ { get @@ -1188,6 +1420,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.POSITION_Z, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the world position of the Actor. + /// public Vector3 WorldPosition { get @@ -1198,6 +1434,11 @@ 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. + /// public Rotation Orientation { get @@ -1211,6 +1452,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.ORIENTATION, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the world orientation of the Actor. + /// public Rotation WorldOrientation { get @@ -1220,6 +1465,11 @@ namespace Tizen.NUI return temp; } } + + /// + /// Gets/Sets the scale factor applied to an actor. + /// Note : This is an asynchronous method. + /// public Vector3 Scale { get @@ -1233,6 +1483,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SCALE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the scale x factor applied to an actor. + /// public float ScaleX { get @@ -1246,6 +1500,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SCALE_X, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the scale y factor applied to an actor. + /// public float ScaleY { get @@ -1259,6 +1517,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SCALE_Y, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the scale z factor applied to an actor. + /// public float ScaleZ { get @@ -1272,6 +1534,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SCALE_Z, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets the world scale of Actor. + /// public Vector3 WorldScale { get @@ -1281,6 +1547,12 @@ namespace Tizen.NUI return temp; } } + + /// + /// 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 { get @@ -1296,6 +1568,12 @@ namespace Tizen.NUI } */ } + + /// + /// Gets/Sets the actor's mix color; this is an RGBA value. + /// The final color of the actor depends on its color mode. + /// Note : This is an asynchronous method. + /// public Color MixColor { get @@ -1309,6 +1587,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the actor's mix color red. + /// public float ColorRed { get @@ -1322,6 +1604,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.COLOR_RED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the actor's mix color green. + /// public float ColorGreen { get @@ -1335,6 +1621,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.COLOR_GREEN, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the actor's mix color blue + /// public float ColorBlue { get @@ -1348,6 +1638,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.COLOR_BLUE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the actor's mix color alpha. + /// public float ColorAlpha { get @@ -1361,6 +1655,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.COLOR_ALPHA, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets the actor's world color. + /// public Color WorldColor { get @@ -1371,6 +1669,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the Actor's name. + /// public string Name { get @@ -1384,6 +1685,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.NAME, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the status of whether an actor should emit touch or hover signals. + /// public bool Sensitive { get @@ -1397,6 +1702,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.SENSITIVE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the status of whether the actor should receive a notification when touch or hover motion events leave the boundary of the actor. + /// public bool LeaveRequired { get @@ -1410,6 +1719,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.LEAVE_REQUIRED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the status of whether a child actor inherits it's parent's orientation. + /// public bool InheritOrientation { get @@ -1423,6 +1736,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.INHERIT_ORIENTATION, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the status of whether a child actor inherits it's parent's scale. + /// public bool InheritScale { get @@ -1437,6 +1754,11 @@ 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. + /// public ColorMode ColorMode { get @@ -1457,7 +1779,7 @@ namespace Tizen.NUI case "USE_OWN_MULTIPLY_PARENT_ALPHA": return ColorMode.UseOwnMultiplyParentAlpha; default: - return ColorMode.UseOwnColor; + return ColorMode.UseOwnMultiplyParentAlpha; } } set @@ -1466,6 +1788,15 @@ 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. + /// public DrawModeType DrawMode { get @@ -1492,6 +1823,12 @@ namespace Tizen.NUI SetProperty(Actor.Property.DRAW_MODE, new Tizen.NUI.PropertyValue((int)value)); } } + + /// + /// 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 { get @@ -1506,6 +1843,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the width resize policy to be used for the given dimension(s). + /// public ResizePolicyType WidthResizePolicy { get @@ -1543,6 +1883,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the height resize policy to be used for the given dimension(s). + /// public ResizePolicyType HeightResizePolicy { get @@ -1580,6 +1923,10 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the policy to use when setting size with size negotiation. + /// Defaults to SizeScalePolicyType.UseSizeSet. + /// public SizeScalePolicyType SizeScalePolicy { get @@ -1607,6 +1954,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the status of whether the width size is dependent on height size. + /// public bool WidthDependentOnHeight { get @@ -1620,6 +1970,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.WIDTH_FOR_HEIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the status of whether the height size is dependent on width size. + /// public bool HeightDependentOnWidth { get @@ -1633,6 +1987,10 @@ namespace Tizen.NUI SetProperty(Actor.Property.HEIGHT_FOR_WIDTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the padding for use in layout. + /// public Vector4 Padding { get @@ -1647,6 +2005,10 @@ namespace Tizen.NUI } } + + /// + /// Gets/Sets the minimum size an actor can be assigned in size negotiation. + /// public Size2D MinimumSize { get @@ -1661,6 +2023,10 @@ namespace Tizen.NUI } } + + /// + /// Gets/Sets the maximum size an actor can be assigned in size negotiation. + /// public Size2D MaximumSize { get @@ -1674,6 +2040,12 @@ namespace Tizen.NUI SetProperty(Actor.Property.MAXIMUM_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// 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 { get @@ -1688,6 +2060,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets clipping behavior(mode) of it's children + /// public ClippingModeType ClippingMode { get @@ -1715,6 +2090,13 @@ 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. + /// public enum ColorMode { UseOwnColor, @@ -1723,18 +2105,29 @@ namespace Tizen.NUI UseOwnMultiplyParentAlpha } + /// + /// This specifies the dimesion of width or heigh for size negotiation. + /// public enum DimensionType { Width = 0x1, Height = 0x2, AllDimensions = 0x3 } + + /// + /// This specifies draw mode types + /// public enum DrawModeType { Normal = 0, Overlay2D = 1, Stencil = 3 } + + /// + /// This specifies resize policy types + /// public enum ResizePolicyType { Fixed, @@ -1746,12 +2139,20 @@ namespace Tizen.NUI DimensionDependency, UseAssignedSize } + + /// + /// This specifies size scale policy types + /// public enum SizeScalePolicyType { UseSizeSet, FitWithAspectRatio, FillWithAspectRatio } + + /// + /// This specifies clipping mode types + /// public enum ClippingModeType { Disabled, diff --git a/src/Tizen.NUI/src/public/AlphaFunction.cs b/src/Tizen.NUI/src/public/AlphaFunction.cs index 5019f91..4f7ff1c 100755 --- a/src/Tizen.NUI/src/public/AlphaFunction.cs +++ b/src/Tizen.NUI/src/public/AlphaFunction.cs @@ -1,16 +1,29 @@ -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed namespace Tizen.NUI { + /// + /// 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. + /// public class AlphaFunction : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -32,6 +45,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make AlphaFunction instance be disposed. + /// public virtual void Dispose() { if (!Stage.IsInstalled()) @@ -55,17 +71,30 @@ namespace Tizen.NUI } } - + /// + /// 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) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Default constructor. + /// Creates an alpha function object with the default built-in alpha function. + /// public AlphaFunction() : this(NDalicPINVOKE.new_AlphaFunction__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -76,11 +105,23 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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 public AlphaFunction(Vector2 controlPoint0, Vector2 controlPoint1) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_3(Vector2.getCPtr(controlPoint0), Vector2.getCPtr(controlPoint1)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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 public void GetBezierControlPoints(out Vector2 controlPoint0, out Vector2 controlPoint1) { Vector4 ret = new Vector4(NDalicPINVOKE.AlphaFunction_GetBezierControlPoints(swigCPtr), true); @@ -98,6 +139,11 @@ namespace Tizen.NUI return ret; } + /// + /// 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() { AlphaFunction.BuiltinFunctions ret = (AlphaFunction.BuiltinFunctions)NDalicPINVOKE.AlphaFunction_GetBuiltinFunction(swigCPtr); @@ -105,6 +151,10 @@ namespace Tizen.NUI return ret; } + /// + /// Returns the functioning mode of the alpha function + /// + /// The functioning mode of the alpha function public AlphaFunction.Modes GetMode() { AlphaFunction.Modes ret = (AlphaFunction.Modes)NDalicPINVOKE.AlphaFunction_GetMode(swigCPtr); @@ -112,6 +162,9 @@ namespace Tizen.NUI return ret; } + /// + /// This specifies the various types of BuiltinFunctions + /// public enum BuiltinFunctions { Default, @@ -131,6 +184,9 @@ namespace Tizen.NUI Count } + /// + /// This specifies which mode is set for AlphaFuction + /// public enum Modes { CustomFunction = 1, diff --git a/src/Tizen.NUI/src/public/Animation.cs b/src/Tizen.NUI/src/public/Animation.cs index 888e9f0..ddfac76 100755 --- a/src/Tizen.NUI/src/public/Animation.cs +++ b/src/Tizen.NUI/src/public/Animation.cs @@ -1,28 +1,20 @@ -/** Copyright (c) 2017 Samsung Electronics Co., Ltd. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -* -*/ -// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed namespace Tizen.NUI { @@ -30,6 +22,13 @@ namespace Tizen.NUI using System; 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. + /// public class Animation : BaseHandle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -49,6 +48,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make Animation instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -73,19 +75,14 @@ namespace Tizen.NUI } } - - - /** - * @brief Create an initialized Animation. - * - * The animation will not loop. - * The default end action is "Bake". - * The default Alpha function is linear. - * @since 1.0.0 - * @param [in] durationmSeconds The duration in milli seconds (int). - * @return A handle to a newly allocated Dali resource. - * @pre 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) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -148,6 +145,10 @@ namespace Tizen.NUI return (int)(sec * 1000); } + + /// + /// Gets/Sets the duration of animation + /// public int Duration { set @@ -160,6 +161,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the default alpha function for an animation. + /// public AlphaFunction DefaultAlphaFunction { set @@ -173,6 +177,9 @@ namespace Tizen.NUI } } + /// + /// Queries the state of the animation. + /// public States State { get @@ -181,6 +188,14 @@ 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. + /// public int LoopCount { set @@ -194,6 +209,11 @@ 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(). + /// public bool Looping { set @@ -207,6 +227,12 @@ 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 + /// public EndActions EndAction { set @@ -219,6 +245,11 @@ namespace Tizen.NUI } } + + /// + /// Stops the animation. + /// + /// end action can be set public void Stop(EndActions action = EndActions.Cancel) { SetEndAction(action); @@ -226,6 +257,10 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets the current loop count. + /// A value 0 to CurrentLoop indicating the current loop count when looping. + /// public int CurrentLoop { get @@ -234,6 +269,11 @@ 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. + /// public EndActions DisconnectAction { set @@ -249,6 +289,13 @@ 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. + /// public float CurrentProgress { set @@ -264,6 +311,12 @@ 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. + /// public float SpeedFactor { set @@ -279,6 +332,11 @@ namespace Tizen.NUI } } + /// + /// 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. + /// public Vector2 PlayRange { set @@ -294,7 +352,15 @@ 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. + /// + /// The target object to animate + /// The target property to animate + /// The property value will change by this amount + /// The alpha function to apply public void AnimateBy(Actor target, string property, object relativeValue, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -319,6 +385,17 @@ 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. + /// + /// The target object to animate + /// The target property to animate + /// The property value will change by this amount + /// Start time of animation + /// End time of animation + /// The alpha function to apply public void AnimateBy(Actor target, string property, object relativeValue, int startTime, int endTime, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -345,6 +422,15 @@ 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. + /// + /// The target object to animate + /// The target property to animate + /// The destination value + /// The alpha function to apply public void AnimateTo(Actor target, string property, object destinationValue, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -369,6 +455,18 @@ 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. + /// + /// The target object to animate + /// The target property to animate + /// The destination value + /// The alpha function to apply + /// Start time of animation + /// End time of animation + /// public void AnimateTo(Actor target, string property, object destinationValue, int startTime, int endTime, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -395,6 +493,14 @@ namespace Tizen.NUI } } + /// + /// Animates a property between keyframes. + /// + /// The target object to animate + /// The target property to animate + /// The set of time/value pairs between which to animate + /// The method used to interpolate between values + /// The alpha function to apply public void AnimateBetween(Actor target, string property, KeyFrames keyFrames, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -417,6 +523,17 @@ namespace Tizen.NUI } } + + /// + /// Animates a property between keyframes. + /// + /// The target object to animate + /// The target property to animate + /// The set of time/value pairs between which to animate + /// Start time of animation + /// End time of animation + /// The method used to interpolate between values + /// The alpha function to apply public void AnimateBetween(Actor target, string property, KeyFrames keyFrames, int startTime, int endTime, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -440,6 +557,15 @@ 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. + /// + /// The actor to animate + /// It defines position and orientation + /// The vector (in local space coordinate system) that will be oriented with the path's tangent direction + /// The alpha function to apply public void AnimatePath(Actor actor, Path path, Vector3 forward, AlphaFunction alphaFunction = null) { if (alphaFunction == null) @@ -452,6 +578,17 @@ 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. + /// + /// The actor to animate + /// It defines position and orientation + /// The vector (in local space coordinate system) that will be oriented with the path's tangent direction + /// Start time of animation + /// End time of animation + /// The alpha function to apply public void AnimatePath(Actor actor, Path path, Vector3 forward, int startTime, int endTime, AlphaFunction alphaFunction = null) { TimePeriod time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime)); @@ -465,7 +602,12 @@ namespace Tizen.NUI } } - + /// + /// 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) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -476,6 +618,14 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// 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 public static Animation DownCast(BaseHandle handle) { Animation ret = new Animation(NDalicPINVOKE.Animation_DownCast(BaseHandle.getCPtr(handle)), true); @@ -619,18 +769,30 @@ namespace Tizen.NUI return ret; } + /// + /// Play the animation. + /// public void Play() { NDalicPINVOKE.Animation_Play(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { NDalicPINVOKE.Animation_PlayFrom(swigCPtr, progress); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Pauses the animation. + /// public void Pause() { NDalicPINVOKE.Animation_Pause(swigCPtr); @@ -644,12 +806,19 @@ namespace Tizen.NUI return ret; } + /// + /// Stops the animation. + /// public void Stop() { NDalicPINVOKE.Animation_Stop(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Clears the animation. + /// This disconnects any objects that were being animated, effectively stopping the animation. + /// public void Clear() { NDalicPINVOKE.Animation_Clear(swigCPtr); @@ -795,6 +964,12 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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 { Cancel, @@ -802,12 +977,21 @@ namespace Tizen.NUI StopFinal } + /// + /// 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 { Linear, Cubic } + /// + /// 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 { Stopped, diff --git a/src/Tizen.NUI/src/public/Button.cs b/src/Tizen.NUI/src/public/Button.cs index 19061d3..d0be34a 100755 --- a/src/Tizen.NUI/src/public/Button.cs +++ b/src/Tizen.NUI/src/public/Button.cs @@ -1,12 +1,20 @@ -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed namespace Tizen.NUI { @@ -14,7 +22,19 @@ namespace Tizen.NUI using System; 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. + /// public class Button : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -34,6 +54,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make Button instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -226,6 +249,9 @@ namespace Tizen.NUI return ret; } + /// + /// Gets/Sets the unselected button foreground/icon visual + /// public Tizen.NUI.PropertyMap UnselectedVisual { get @@ -240,6 +266,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the selected button foreground/icon visual + /// public Tizen.NUI.PropertyMap SelectedVisual { get @@ -254,6 +283,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the disabled selected state foreground/icon button visual + /// public Tizen.NUI.PropertyMap DisabledSelectedVisual { get @@ -268,6 +300,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the disabled unselected state foreground/icon visual + /// public Tizen.NUI.PropertyMap DisabledUnselectedVisual { get @@ -282,6 +317,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the disabled in the unselected state background, button visual + /// public Tizen.NUI.PropertyMap UnselectedBackgroundVisual { get @@ -296,6 +334,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the selected background button visual + /// public Tizen.NUI.PropertyMap SelectedBackgroundVisual { get @@ -310,6 +351,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the disabled while unselected background button visual + /// public Tizen.NUI.PropertyMap DisabledUnselectedBackgroundVisual { get @@ -324,6 +368,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the disabled while selected background button visual + /// public Tizen.NUI.PropertyMap DisabledSelectedBackgroundVisual { get @@ -338,6 +385,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the position of the the label in relation to the foreground/icon if both present + /// public string LabelRelativeAlignment { get @@ -352,6 +402,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the padding around the text + /// public Vector4 LabelPadding { get @@ -366,6 +419,9 @@ namespace Tizen.NUI } } + /// + /// Gets/Sets the padding around the foreground visual + /// public Vector4 VisualPadding { get @@ -451,6 +507,10 @@ namespace Tizen.NUI } + /// + /// Creates an uninitialized Button. + /// Only derived versions can be instantiated. + /// public Button() : this(NDalicPINVOKE.new_Button__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -468,6 +528,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public new static Button DownCast(BaseHandle handle) { Button ret = new Button(NDalicPINVOKE.Button_DownCast(BaseHandle.getCPtr(handle)), true); @@ -517,6 +584,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves button's animation time. + /// + /// public float GetAnimationTime() { float ret = NDalicPINVOKE.Button_GetAnimationTime(swigCPtr); @@ -597,6 +668,9 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// Gets/Sets the button as disabled. + /// public bool Disabled { get @@ -610,6 +684,10 @@ namespace Tizen.NUI SetProperty(Button.Property.DISABLED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// If the autorepeating property is set to true then the togglable property is set to false + /// public bool AutoRepeating { get @@ -623,6 +701,10 @@ namespace Tizen.NUI SetProperty(Button.Property.AUTO_REPEATING, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// By default this value is set to 0.15 seconds. + /// public float InitialAutoRepeatingDelay { get @@ -636,6 +718,10 @@ namespace Tizen.NUI SetProperty(Button.Property.INITIAL_AUTO_REPEATING_DELAY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// default this value is set to 0.05 seconds + /// public float NextAutoRepeatingDelay { get @@ -649,6 +735,10 @@ namespace Tizen.NUI SetProperty(Button.Property.NEXT_AUTO_REPEATING_DELAY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// If the togglable property is set to true, then the autorepeating property is set to false. + /// public bool Togglable { get @@ -662,6 +752,10 @@ namespace Tizen.NUI SetProperty(Button.Property.TOGGLABLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// /Gets/Sets the togglable button as either selected or unselected, togglable property must be set to true. + /// public bool Selected { get @@ -675,6 +769,10 @@ namespace Tizen.NUI SetProperty(Button.Property.SELECTED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the unselected button foreground image + /// public Tizen.NUI.PropertyMap UnselectedStateImage { get @@ -688,6 +786,10 @@ namespace Tizen.NUI SetProperty(Button.Property.UNSELECTED_STATE_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the selected button foreground image + /// public Tizen.NUI.PropertyMap SelectedStateImage { get @@ -701,6 +803,10 @@ namespace Tizen.NUI SetProperty(Button.Property.SELECTED_STATE_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the disabled whilst unselected foreground button visual + /// public Tizen.NUI.PropertyMap DisabledStateImage { get @@ -714,6 +820,10 @@ namespace Tizen.NUI SetProperty(Button.Property.DISABLED_STATE_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets unselected color + /// public Color UnselectedColor { get @@ -727,6 +837,10 @@ namespace Tizen.NUI SetProperty(Button.Property.UNSELECTED_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets selected color + /// public Color SelectedColor { get @@ -740,6 +854,10 @@ namespace Tizen.NUI SetProperty(Button.Property.SELECTED_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets label + /// public Tizen.NUI.PropertyMap Label { get @@ -753,6 +871,10 @@ namespace Tizen.NUI SetProperty(Button.Property.LABEL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets text of label + /// public string LabelText { get diff --git a/src/Tizen.NUI/src/public/CameraActor.cs b/src/Tizen.NUI/src/public/CameraActor.cs index b488335..c405f7b 100755 --- a/src/Tizen.NUI/src/public/CameraActor.cs +++ b/src/Tizen.NUI/src/public/CameraActor.cs @@ -1,32 +1,38 @@ -/** Copyright (c) 2017 Samsung Electronics Co., Ltd. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -* -*/ -// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed namespace Tizen.NUI { + /// + /// 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. + /// /// public class CameraActor : Actor { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -46,6 +52,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// To make CameraActor instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -131,16 +140,33 @@ namespace Tizen.NUI } + /// + /// Creates an initialized CameraActor handle. + /// public CameraActor() : this(NDalicPINVOKE.CameraActor_New__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// 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) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// 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 public new static CameraActor DownCast(BaseHandle handle) { CameraActor ret = new CameraActor(NDalicPINVOKE.CameraActor_DownCast(BaseHandle.getCPtr(handle)), true); @@ -282,6 +308,9 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets/Sets the camera type. The default type is FreeLook + /// public string Type { get @@ -295,6 +324,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.TYPE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the projection mode. + /// public string ProjectionMode { get @@ -308,6 +341,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.PROJECTION_MODE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the field of view. + /// public float FieldOfView { get @@ -321,6 +358,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.FIELD_OF_VIEW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the aspect ratio of the camera. + /// public float AspectRatio { get @@ -334,6 +375,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.ASPECT_RATIO, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets near plane distance + /// public float NearPlaneDistance { get @@ -347,6 +392,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.NEAR_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets far plane distance + /// public float FarPlaneDistance { get @@ -360,6 +409,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.FAR_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets left plane distance + /// public float LeftPlaneDistance { get @@ -373,6 +426,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.LEFT_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets right plane distance + /// public float RightPlaneDistance { get @@ -386,6 +443,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.RIGHT_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets top plane distance + /// public float TopPlaneDistance { get @@ -399,6 +460,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.TOP_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets bottom plane distance + /// public float BottomPlaneDistance { get @@ -412,6 +477,10 @@ namespace Tizen.NUI SetProperty(CameraActor.Property.BOTTOM_PLANE_DISTANCE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Gets/Sets the target position of the camera. + /// public Position TargetPosition { get @@ -444,6 +513,10 @@ namespace Tizen.NUI return temp; } } + + /// + /// Requests for an inversion on the Y axis on the projection calculation. + /// public bool InvertYAxis { get @@ -460,12 +533,22 @@ 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 + /// public enum CameraType { FreeLook, LookAtTarget } + /// + /// 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 { PerspectiveProjection, diff --git a/src/Tizen.NUI/src/public/CheckBoxButton.cs b/src/Tizen.NUI/src/public/CheckBoxButton.cs index 7d0367a..9ea9bd4 100755 --- a/src/Tizen.NUI/src/public/CheckBoxButton.cs +++ b/src/Tizen.NUI/src/public/CheckBoxButton.cs @@ -1,32 +1,33 @@ -/** Copyright (c) 2017 Samsung Electronics Co., Ltd. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -* -*/ -// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts -//------------------------------------------------------------------------------ -// +// Copyright (c) 2017 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. // -// This file was automatically generated by SWIG (http://www.swig.org). -// Version 3.0.9 // -// Do not make changes to this file unless you know what you are doing--modify -// the SWIG interface file instead. -//------------------------------------------------------------------------------ +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed 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. + /// /// public class CheckBoxButton : Button { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -46,6 +47,10 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + + /// + /// To make CheckBoxButton instance be disposed. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -70,7 +75,9 @@ namespace Tizen.NUI } } - + /// + /// Creates an initialized CheckBoxButton + /// public CheckBoxButton() : this(NDalicPINVOKE.CheckBoxButton_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); diff --git a/src/Tizen.NUI/src/public/Color.cs b/src/Tizen.NUI/src/public/Color.cs index 4119b9e..e9fe9da 100755 --- a/src/Tizen.NUI/src/public/Color.cs +++ b/src/Tizen.NUI/src/public/Color.cs @@ -20,9 +20,6 @@ namespace Tizen.NUI using System; - /// - /// Color Class - /// public class Color : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -68,65 +65,42 @@ namespace Tizen.NUI } - /// - /// Addition operator. - /// public static Color operator +(Color arg1, Color arg2) { return arg1.Add(arg2); } - /// - /// Subtraction operator. - /// public static Color operator -(Color arg1, Color arg2) { return arg1.Subtract(arg2); } - /// - /// Subtraction operator, void - /// public static Color operator -(Color arg1) { return arg1.Subtract(); } - /// - /// Multiplication operator. - /// public static Color operator *(Color arg1, Color arg2) { return arg1.Multiply(arg2); } - /// - /// Multiplication operator, using float. - /// public static Color operator *(Color arg1, float arg2) { return arg1.Multiply(arg2); } - /// - /// Division operator. - /// public static Color operator /(Color arg1, Color arg2) { return arg1.Divide(arg2); } - /// - /// Division operator, using float. - /// public static Color operator /(Color arg1, float arg2) { return arg1.Divide(arg2); } - /// - /// Array subscript operator. - /// + public float this[uint index] { get @@ -135,9 +109,6 @@ namespace Tizen.NUI } } - /// - /// GetColorFromPtr - /// public static Color GetColorFromPtr(global::System.IntPtr cPtr) { Color ret = new Color(cPtr, false); @@ -146,40 +117,21 @@ namespace Tizen.NUI } - /// - /// Constructor. - /// public Color() : this(NDalicPINVOKE.new_Vector4__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// - /// Constructor. - /// - /// The red component - /// The green component - /// The blue component - /// The alpha component public Color(float r, float g, float b, float a) : this(NDalicPINVOKE.new_Vector4__SWIG_1(r, g, b, a), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// - /// Constructor. - /// - /// The array public Color(float[] array) : this(NDalicPINVOKE.new_Vector4__SWIG_2(array), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// - /// Add Color. - /// - /// A reference to the copied handle - /// A reference to this private Color Add(Color rhs) { Color ret = new Color(NDalicPINVOKE.Vector4_Add(swigCPtr, Color.getCPtr(rhs)), true); @@ -187,11 +139,6 @@ namespace Tizen.NUI return ret; } - /// - /// Add assignment operator. - /// - /// A reference to the copied handle - /// A reference to this private Color AddAssign(Vector4 rhs) { Color ret = new Color(NDalicPINVOKE.Vector4_AddAssign(swigCPtr, Color.getCPtr(rhs)), false); @@ -276,11 +223,6 @@ namespace Tizen.NUI return ret; } - /// - /// Assignment operator. - /// - /// A reference to the copied handle - /// A reference to this public bool EqualTo(Color rhs) { bool ret = NDalicPINVOKE.Vector4_EqualTo(swigCPtr, Color.getCPtr(rhs)); @@ -291,11 +233,6 @@ namespace Tizen.NUI return ret; } - /// - /// Assignment operator. - /// - /// A reference to the copied handle - /// A reference to this public bool NotEqualTo(Color rhs) { bool ret = NDalicPINVOKE.Vector4_NotEqualTo(swigCPtr, Color.getCPtr(rhs)); @@ -311,9 +248,6 @@ namespace Tizen.NUI return ret; } - /// - /// The red component - /// public float R { set @@ -329,9 +263,6 @@ namespace Tizen.NUI } } - /// - /// The Green Component. - /// public float G { set @@ -347,9 +278,6 @@ namespace Tizen.NUI } } - /// - /// The Blue Component. - /// public float B { set @@ -365,9 +293,6 @@ namespace Tizen.NUI } } - /// - /// The Alpha Component. - /// public float A { set @@ -383,9 +308,6 @@ namespace Tizen.NUI } } - /// - /// The Black Color. - /// public static Color Black { get @@ -397,9 +319,6 @@ namespace Tizen.NUI } } - /// - /// The White Color. - /// public static Color White { get @@ -411,9 +330,6 @@ namespace Tizen.NUI } } - /// - /// The Red Color. - /// public static Color Red { get @@ -425,9 +341,6 @@ namespace Tizen.NUI } } - /// - /// The Green Color. - /// public static Color Green { get @@ -439,9 +352,6 @@ namespace Tizen.NUI } } - /// - /// The Blue Color. - /// public static Color Blue { get @@ -453,9 +363,6 @@ namespace Tizen.NUI } } - /// - /// The Yellow Color. - /// public static Color Yellow { get @@ -467,9 +374,6 @@ namespace Tizen.NUI } } - /// - /// The Magenta Color. - /// public static Color Magenta { get @@ -481,9 +385,6 @@ namespace Tizen.NUI } } - /// - /// The Cyan Color. - /// public static Color Cyan { get @@ -495,9 +396,6 @@ namespace Tizen.NUI } } - /// - /// The Transparent Color. - /// public static Color Transparent { get diff --git a/src/Tizen.NUI/src/public/CustomView.cs b/src/Tizen.NUI/src/public/CustomView.cs index 393b5fb..3a85b1f 100755 --- a/src/Tizen.NUI/src/public/CustomView.cs +++ b/src/Tizen.NUI/src/public/CustomView.cs @@ -842,9 +842,6 @@ namespace Tizen.NUI { } } - /// - /// Enumeration for CustomViewBehaviour - /// public enum CustomViewBehaviour { ViewBehaviourDefault = 0, diff --git a/src/Tizen.NUI/src/public/CustomView/Spin.cs b/src/Tizen.NUI/src/public/CustomView/Spin.cs index 1f25abf..ae473ac 100755 --- a/src/Tizen.NUI/src/public/CustomView/Spin.cs +++ b/src/Tizen.NUI/src/public/CustomView/Spin.cs @@ -1,19 +1,20 @@ -/* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - */ +// Copyright (c) 2017 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +// This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts +// Some have been manually changed using System; using System.Runtime.InteropServices; @@ -23,6 +24,9 @@ using Tizen.NUI; namespace Tizen.NUI { + /// + ///Spin CustomView class + /// public class Spin : CustomView { private VisualBase _arrowVisual; @@ -60,6 +64,11 @@ namespace Tizen.NUI } + /// + /// 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() { // Initialize the propertiesControl @@ -96,18 +105,33 @@ namespace Tizen.NUI _textField.FocusLost += TextFieldKeyInputFocusLost; } + /// + /// Override method of GetNaturalSize() for CustomView class. + /// Return the natural size of the actor. + /// + /// Natural size of this Spin itself public override Size GetNaturalSize() { return new Size(150.0f, 150.0f, 0.0f); } + /// + /// 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 public void TextFieldKeyInputFocusGained(object source, EventArgs e) { - // Make sure when the current spin that takes input focus also takes the keyboard focus - // For example, when you tap the spin directly FocusManager.Instance.SetCurrentFocusView(_textField); } + /// + /// Event handler when the TextField in Spin looses it's Key focus + /// + /// + /// public void TextFieldKeyInputFocusLost(object source, EventArgs e) { int previousValue = _currentValue; @@ -129,6 +153,15 @@ namespace Tizen.NUI this.Value = _currentValue; } + /// + /// Override method of GetNextKeyboardFocusableActor() for CustomView class. + /// Gets the next key focusable actor 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 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 override Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, View.FocusDirection direction, bool loopEnabled) { // Respond to Up/Down keys to change the value while keeping the current spin focused @@ -153,7 +186,9 @@ namespace Tizen.NUI return nextFocusedActor; } - + /// + /// Value to be set in Spin + /// [ScriptableProperty()] public int Value { @@ -181,6 +216,10 @@ namespace Tizen.NUI _textField.Text = _currentValue.ToString(); } } + + /// + /// Minimum Value of Spin Value + /// // MinValue property of type int: [ScriptableProperty()] public int MinValue @@ -195,6 +234,9 @@ namespace Tizen.NUI } } + /// + /// Maximum Value of Spin Value + /// // MaxValue property of type int: [ScriptableProperty()] public int MaxValue @@ -209,6 +251,9 @@ namespace Tizen.NUI } } + /// + /// Increasing, decresing step of Spin Value when Up or Down key is pressed + /// // Step property of type int: [ScriptableProperty()] public int Step @@ -223,6 +268,9 @@ namespace Tizen.NUI } } + /// + /// Wrapping enabled status + /// // WrappingEnabled property of type bool: [ScriptableProperty()] public bool WrappingEnabled @@ -237,6 +285,9 @@ namespace Tizen.NUI } } + /// + /// Text point size of Spin Value + /// // TextPointSize property of type int: [ScriptableProperty()] public int TextPointSize @@ -252,6 +303,9 @@ namespace Tizen.NUI } } + /// + /// The color of Spin Value + /// // TextColor property of type Color: [ScriptableProperty()] public Color TextColor @@ -269,6 +323,9 @@ namespace Tizen.NUI } } + /// + /// Maximum text lengh of Spin Value + /// // MaxTextLength property of type int: [ScriptableProperty()] public int MaxTextLength @@ -284,6 +341,9 @@ namespace Tizen.NUI } } + /// + /// Reference of TextField of Spin + /// public TextField SpinText { get @@ -296,6 +356,9 @@ namespace Tizen.NUI } } + /// + /// Show indicator image, for example Up/Down Arrow image. + /// // Indicator property of type string: public string IndicatorImage { diff --git a/src/Tizen.NUI/src/public/CustomView/VisualView.cs b/src/Tizen.NUI/src/public/CustomView/VisualView.cs index 152fe08..8381435 100755 --- a/src/Tizen.NUI/src/public/CustomView/VisualView.cs +++ b/src/Tizen.NUI/src/public/CustomView/VisualView.cs @@ -145,6 +145,15 @@ namespace Tizen.NUI _visualDictionary.Clear(); } + /// + /// 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. public override void OnRelayout(Vector2 size, RelayoutContainer container) { foreach (var item in _visualDictionary)