From: Heeyong Song Date: Fri, 17 Mar 2017 07:13:04 +0000 (+0900) Subject: Add comments for API reference X-Git-Tag: submit/trunk/20170823.075128~91^2~259^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f8cc380bb33caf2507203745f6a55771f94a1ef4;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Add comments for API reference Change Assign() to internal function Change-Id: Ie99a7c54b5c26b287b8cbaf3187f5ae18a5aa9f0 --- diff --git a/src/Tizen.NUI/src/public/Popup.cs b/src/Tizen.NUI/src/public/Popup.cs index 0872655..78953e5 100755 --- a/src/Tizen.NUI/src/public/Popup.cs +++ b/src/Tizen.NUI/src/public/Popup.cs @@ -31,6 +31,9 @@ namespace Tizen.NUI using System.Runtime.InteropServices; + /// + /// The Popup widget provides a configurable pop-up dialog with built-in layout of three main fields. + /// public class Popup : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -76,22 +79,37 @@ namespace Tizen.NUI + /// + /// Event arguments that passed via OutsideTouchedEvent + /// public class OutsideTouchedEventArgs : EventArgs { } + /// + /// Event arguments that passed via ShowingEventArgs + /// public class ShowingEventArgs : EventArgs { } + /// + /// Event arguments that passed via ShownEventArgs + /// public class ShownEventArgs : EventArgs { } + /// + /// Event arguments that passed via HidingEventArgs + /// public class HidingEventArgs : EventArgs { } + /// + /// Event arguments that passed via HiddenEventArgs + /// public class HiddenEventArgs : EventArgs { } @@ -121,6 +139,9 @@ namespace Tizen.NUI private EventHandler _popUpHiddenEventHandler; private HiddenEventCallbackDelegate _popUpHiddenEventCallbackDelegate; + /// + /// Event is sent when user has touched outside of the Dialog. + /// public event EventHandler OutsideTouched { add @@ -154,6 +175,9 @@ namespace Tizen.NUI } } + /// + /// Event is sent when the Popup is starting to be shown. + /// public event EventHandler Showing { add @@ -188,6 +212,9 @@ namespace Tizen.NUI } + /// + /// Event is sent when the Popup has been fully displayed. + /// public event EventHandler Shown { add @@ -221,6 +248,9 @@ namespace Tizen.NUI } } + /// + /// Event is sent when the Popup is starting to be hidden. + /// public event EventHandler Hiding { add @@ -254,6 +284,9 @@ namespace Tizen.NUI } } + /// + /// Event is sent when the Popup has been completely hidden. + /// public event EventHandler Hidden { add @@ -354,6 +387,9 @@ namespace Tizen.NUI } + /// + /// Create the Popup. + /// public Popup() : this(NDalicPINVOKE.Popup_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -371,6 +407,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public new static Popup DownCast(BaseHandle handle) { Popup ret = new Popup(NDalicPINVOKE.Popup_DownCast(BaseHandle.getCPtr(handle)), true); @@ -378,6 +421,10 @@ namespace Tizen.NUI return ret; } + /// + /// Sets a title for this Popup. + /// + /// The actor to set a title public void SetTitle(Actor titleActor) { NDalicPINVOKE.Popup_SetTitle(swigCPtr, Actor.getCPtr(titleActor)); @@ -391,6 +438,10 @@ namespace Tizen.NUI return ret; } + /// + /// Sets the content actor. + /// + /// The actor to use public void SetContent(Actor content) { NDalicPINVOKE.Popup_SetContent(swigCPtr, Actor.getCPtr(content)); @@ -404,6 +455,10 @@ namespace Tizen.NUI return ret; } + /// + /// Sets the actor to use for a footer in this Popup. + /// + /// The footer actor to be added to this Popup public void SetFooter(Actor footer) { NDalicPINVOKE.Popup_SetFooter(swigCPtr, Actor.getCPtr(footer)); @@ -417,6 +472,23 @@ namespace Tizen.NUI return ret; } + /// + /// 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) { NDalicPINVOKE.Popup_SetDisplayState(swigCPtr, (int)displayState); @@ -471,6 +543,9 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// The display states of the Popup. + /// public enum DisplayStateType { Showing, @@ -479,6 +554,10 @@ namespace Tizen.NUI Hidden } + /// + /// The animation mode within popup. + /// Choose from a predefined mode or "CUSTOM" to use the ANIMATION_IN and ANIMATION_OUT properties. + /// public enum AnimationModeType { None, @@ -487,6 +566,11 @@ namespace Tizen.NUI Custom } + /// + /// 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 { NonContextual, @@ -496,6 +580,9 @@ namespace Tizen.NUI Left } + /// + /// Popup title + /// public PropertyMap Title { get @@ -509,6 +596,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TITLE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Popup content + /// public PropertyMap Content { get @@ -522,6 +612,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.CONTENT, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Popup footer + /// public PropertyMap Footer { get @@ -535,6 +628,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.FOOTER, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Popup display state + /// public string DisplayState { get @@ -548,6 +644,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.DISPLAY_STATE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Touch transparent + /// public bool TouchTransparent { get @@ -561,6 +660,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TOUCH_TRANSPARENT, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Popup tail visibility + /// public bool TailVisibility { get @@ -574,6 +676,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TAIL_VISIBILITY, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Popup tail position + /// public Vector3 TailPosition { get @@ -587,6 +692,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TAIL_POSITION, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Contextual mode + /// public string ContextualMode { get @@ -600,6 +708,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.CONTEXTUAL_MODE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Animation duration + /// public float AnimationDuration { get @@ -613,6 +724,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.ANIMATION_DURATION, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Animation mode + /// public string AnimationMode { get @@ -626,6 +740,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.ANIMATION_MODE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Entry animation + /// public PropertyMap EntryAnimation { get @@ -639,6 +756,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.ENTRY_ANIMATION, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Exit animation + /// public PropertyMap ExitAnimation { get @@ -652,6 +772,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.EXIT_ANIMATION, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Auto hide delay + /// public int AutoHideDelay { get @@ -665,6 +788,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.AUTO_HIDE_DELAY, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Backing enabled + /// public bool BackingEnabled { get @@ -678,6 +804,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.BACKING_ENABLED, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Backing color + /// public Vector4 BackingColor { get @@ -691,6 +820,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.BACKING_COLOR, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Background image + /// public string PopupBackgroundImage { get @@ -704,6 +836,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.POPUP_BACKGROUND_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Background border + /// public Rectangle PopupBackgroundBorder { get @@ -717,6 +852,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.POPUP_BACKGROUND_BORDER, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Tail up image + /// public string TailUpImage { get @@ -730,6 +868,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TAIL_UP_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Tail down image + /// public string TailDownImage { get @@ -743,6 +884,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TAIL_DOWN_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Tail left image + /// public string TailLeftImage { get @@ -756,6 +900,9 @@ namespace Tizen.NUI SetProperty(Popup.Property.TAIL_LEFT_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Tail right image + /// public string TailRightImage { get diff --git a/src/Tizen.NUI/src/public/Position.cs b/src/Tizen.NUI/src/public/Position.cs index eda18d6..641f00b 100755 --- a/src/Tizen.NUI/src/public/Position.cs +++ b/src/Tizen.NUI/src/public/Position.cs @@ -17,6 +17,9 @@ namespace Tizen.NUI { +/// +/// Position is a three dimensional vector. +/// public class Position : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; protected bool swigCMemOwn; @@ -53,35 +56,81 @@ public class Position : global::System.IDisposable { } + /// + /// Addition operator. + /// + /// Vector to add + /// Vector to add + /// A vector containing the result of the addition public static Position operator+(Position arg1, Position arg2) { return arg1.Add(arg2); } + /// + /// Subtraction operator. + /// + /// Vector to subtract + /// Vector to subtract + /// A vector containing the result of the subtraction public static Position operator-(Position arg1, Position arg2) { return arg1.Subtract(arg2); } + /// + /// Unary negation operator. + /// + /// Vector to netate + /// A vector containg the negation public static Position operator-(Position arg1) { return arg1.Subtract(); } + /// + /// Multiplication operator. + /// + /// The vector to multiply + /// The vector to multiply + /// A vector containing the result of the multiplication public static Position operator*(Position arg1, Position arg2) { return arg1.Multiply(arg2); } + /// + /// Multiplication operator. + /// + /// The vector to multiply + /// The float value to scale the vector + /// A vector containing the result of the scaling public static Position operator*(Position arg1, float arg2) { return arg1.Multiply(arg2); } + /// + /// Division operator. + /// + /// The vector to divide + /// The vector to divide + /// A vector containing the result of the division public static Position operator/(Position arg1, Position arg2) { return arg1.Divide(arg2); } + /// + /// Division operator. + /// + /// The vector to divide + /// The float value to scale the vector by + /// A vector containing the result of the scaling public static Position operator/(Position arg1, float arg2) { return arg1.Divide(arg2); } + /// + /// Const array subscript operator overload. Should be 0, 1 or 2. + /// + /// Subscript index + /// The float at the given index public float this[uint index] { get @@ -90,6 +139,8 @@ public class Position : global::System.IDisposable { } } + /// + /// public static Position GetPositionFromPtr(global::System.IntPtr cPtr) { Position ret = new Position(cPtr, false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -97,14 +148,27 @@ public class Position : global::System.IDisposable { } + /// + /// Constructor + /// public Position() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor + /// + /// x component + /// y component + /// z component public Position(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor + /// + /// Position2D to create this vector from public Position(Position2D position2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Position2D.getCPtr(position2d)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } @@ -159,12 +223,22 @@ public class Position : 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(Position rhs) { bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Position.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(Position rhs) { bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Position.getCPtr(rhs)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -172,6 +246,9 @@ public class Position : global::System.IDisposable { } + /// + /// x component + /// public float X { set { NDalicPINVOKE.Vector3_X_set(swigCPtr, value); @@ -184,6 +261,9 @@ public class Position : global::System.IDisposable { } } + /// + /// y component + /// public float Y { set { NDalicPINVOKE.Vector3_Y_set(swigCPtr, value); @@ -196,6 +276,9 @@ public class Position : global::System.IDisposable { } } + /// + /// z component + /// public float Z { set { NDalicPINVOKE.Vector3_Z_set(swigCPtr, value); @@ -208,16 +291,22 @@ public class Position : global::System.IDisposable { } } - public static float ParentOriginTop - { - get - { - float ret = NDalicPINVOKE.ParentOriginTop_get(); - if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); - return ret; - } - } + /// + /// ParentOrigin constants. It's 0.0. + /// + public static float ParentOriginTop + { + get + { + float ret = NDalicPINVOKE.ParentOriginTop_get(); + if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); + return ret; + } + } + /// + /// ParentOrigin constants. It's 1.0. + /// public static float ParentOriginBottom { get @@ -228,6 +317,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants. It's 0.0. + /// public static float ParentOriginLeft { get @@ -238,6 +330,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants. It's 1.0. + /// public static float ParentOriginRight { get @@ -248,6 +343,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants. It's 0.5. + /// public static float ParentOriginMiddle { get @@ -258,6 +356,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.0, 0.0, 0.5 + /// public static Position ParentOriginTopLeft { get @@ -269,6 +370,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.5, 0.0, 0.5 + /// public static Position ParentOriginTopCenter { get @@ -280,6 +384,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 1.0, 0.0, 0.5 + /// public static Position ParentOriginTopRight { get @@ -291,6 +398,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.0, 0.5, 0.5 + /// public static Position ParentOriginCenterLeft { get @@ -302,6 +412,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.0, 0.5, 0.5 + /// public static Position ParentOriginCenter { get @@ -313,6 +426,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 1.0, 0.5, 0.5 + /// public static Position ParentOriginCenterRight { get @@ -324,6 +440,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.0f, 1.0f, 0.5f + /// public static Position ParentOriginBottomLeft { get @@ -335,6 +454,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 0.5, 1.0, 0.5 + /// public static Position ParentOriginBottomCenter { get @@ -346,6 +468,9 @@ public class Position : global::System.IDisposable { } } + /// + /// ParentOrigin constants: 1.0, 1.0, 0.5 + /// public static Position ParentOriginBottomRight { get @@ -357,6 +482,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0 + /// public static float AnchorPointTop { get @@ -367,6 +495,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 1.0 + /// public static float AnchorPointBottom { get @@ -377,6 +508,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0 + /// public static float AnchorPointLeft { get @@ -387,6 +521,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 1.0 + /// public static float AnchorPointRight { get @@ -397,6 +534,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0 + /// public static float AnchorPointMiddle { get @@ -407,6 +547,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0, 0.0, 0.5 + /// public static Position AnchorPointTopLeft { get @@ -418,6 +561,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.5, 0.0, 0.5 + /// public static Position AnchorPointTopCenter { get @@ -429,6 +575,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 1.0, 0.0, 0.5 + /// public static Position AnchorPointTopRight { get @@ -440,6 +589,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0, 0.5, 0.5 + /// public static Position AnchorPointCenterLeft { get @@ -451,6 +603,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.5, 0.5, 0.5 + /// public static Position AnchorPointCenter { get @@ -462,6 +617,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 1.0, 0.5, 0.5 + /// public static Position AnchorPointCenterRight { get @@ -473,6 +631,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.0, 1.0, 0.5 + /// public static Position AnchorPointBottomLeft { get @@ -484,6 +645,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 0.5, 1.0, 0.5 + /// public static Position AnchorPointBottomCenter { get @@ -495,6 +659,9 @@ public class Position : global::System.IDisposable { } } + /// + /// AnchorPoint constants: 1.0, 1.0, 0.5 + /// public static Position AnchorPointBottomRight { get @@ -506,6 +673,9 @@ public class Position : global::System.IDisposable { } } + /// + /// Constant ( 1.0f, 1.0f, 1.0f ) + /// public static Position One { get { global::System.IntPtr cPtr = NDalicPINVOKE.Vector3_ONE_get(); @@ -569,6 +739,9 @@ public class Position : global::System.IDisposable { } } + /// + /// Constant ( 0.0f, 0.0f, 0.0f ) + /// public static Position Zero { get { global::System.IntPtr cPtr = NDalicPINVOKE.Vector3_ZERO_get(); @@ -578,11 +751,15 @@ public class Position : global::System.IDisposable { } } + /// + /// public static implicit operator Vector3(Position Position) { return new Vector3(Position.X, Position.Y, Position.Z); } + /// + /// public static implicit operator Position(Vector3 vec) { return new Position(vec.X, vec.Y, vec.Z); diff --git a/src/Tizen.NUI/src/public/ProgressBar.cs b/src/Tizen.NUI/src/public/ProgressBar.cs index a92b7e4..2417bdf 100755 --- a/src/Tizen.NUI/src/public/ProgressBar.cs +++ b/src/Tizen.NUI/src/public/ProgressBar.cs @@ -31,6 +31,9 @@ namespace Tizen.NUI using System.Runtime.InteropServices; + /// + /// ProgressBar is a control to give the user an indication of the progress of an operation. + /// public class ProgressBar : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -76,6 +79,9 @@ namespace Tizen.NUI + /// + /// Event arguments that passed via ValueChangedEventArgs + /// public class ValueChangedEventArgs : EventArgs { private ProgressBar _progressBar; @@ -125,6 +131,9 @@ namespace Tizen.NUI private EventHandler _progressBarValueChangedEventHandler; private ValueChangedCallbackDelegate _progressBarValueChangedCallbackDelegate; + /// + /// Event is sent when the ProgressBar value changes. + /// public event EventHandler ValueChanged { add @@ -162,6 +171,8 @@ namespace Tizen.NUI } } + /// + /// public static ProgressBar GetProgressBarFromPtr(global::System.IntPtr cPtr) { ProgressBar ret = new ProgressBar(cPtr, false); @@ -225,6 +236,9 @@ namespace Tizen.NUI } + /// + /// Creates the ProgressBar. + /// public ProgressBar() : this(NDalicPINVOKE.ProgressBar_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -242,6 +256,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public new static ProgressBar DownCast(BaseHandle handle) { ProgressBar ret = new ProgressBar(NDalicPINVOKE.ProgressBar_DownCast(BaseHandle.getCPtr(handle)), true); @@ -262,6 +283,12 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// 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 { get @@ -275,6 +302,13 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.PROGRESS_VALUE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// 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 { get @@ -288,6 +322,9 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VALUE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Sets the progress-bar as \e indeterminate state. + /// public bool Indeterminate { get @@ -301,6 +338,10 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.INDETERMINATE, new Tizen.NUI.PropertyValue(value)); } } + /// + /// 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 { get @@ -314,6 +355,10 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.TRACK_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + /// + /// 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 { get @@ -327,6 +372,10 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + /// + /// 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 { get @@ -340,6 +389,10 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + /// + /// The indeterminate visual of progress bar. + /// Optional. If not supplied, the default inditerminate visual will be shown. + /// public Tizen.NUI.PropertyMap IndeterminateVisual { get @@ -353,6 +406,10 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.INDETERMINATE_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + /// + /// The transition data for indeterminate visual animation. + /// Optional. If not supplied, default animation will be played. + /// public Tizen.NUI.PropertyArray IndeterminateVisualAnimation { get @@ -366,6 +423,9 @@ namespace Tizen.NUI SetProperty(ProgressBar.Property.INDETERMINATE_VISUAL_ANIMATION, new Tizen.NUI.PropertyValue(value)); } } + /// + /// The Label visual of progress bar. + /// public Tizen.NUI.PropertyMap LabelVisual { get diff --git a/src/Tizen.NUI/src/public/Property.cs b/src/Tizen.NUI/src/public/Property.cs index 2749edb..abf111c 100755 --- a/src/Tizen.NUI/src/public/Property.cs +++ b/src/Tizen.NUI/src/public/Property.cs @@ -153,6 +153,9 @@ namespace Tizen.NUI } + /// + /// A Array of property values. + /// public class PropertyArray : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -191,6 +194,11 @@ namespace Tizen.NUI } } + /// + /// Operator to access an element. + /// + /// The element index to access. No bounds checking is performed + /// The a reference to the element public PropertyValue this[uint index] { get @@ -199,6 +207,9 @@ namespace Tizen.NUI } } + /// + /// Constructor + /// public PropertyArray() : this(NDalicPINVOKE.new_Property_Array__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -209,6 +220,10 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the number of elements in the array. + /// + /// The number of elements in the array public uint Size() { uint ret = NDalicPINVOKE.Property_Array_Size(swigCPtr); @@ -216,6 +231,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the number of elements in the array. + /// + /// The number of elements in the array public uint Count() { uint ret = NDalicPINVOKE.Property_Array_Count(swigCPtr); @@ -223,6 +242,10 @@ namespace Tizen.NUI return ret; } + /// + /// Returns whether the array is empty. + /// + /// Return true if empty, false otherwise public bool Empty() { bool ret = NDalicPINVOKE.Property_Array_Empty(swigCPtr); @@ -230,24 +253,39 @@ namespace Tizen.NUI return ret; } + /// + /// Clears the array. + /// public void Clear() { NDalicPINVOKE.Property_Array_Clear(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Increases the capacity of the array. + /// + /// The size to reserve public void Reserve(uint size) { NDalicPINVOKE.Property_Array_Reserve(swigCPtr, size); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Resizes to size. + /// + /// The size to resize public void Resize(uint size) { NDalicPINVOKE.Property_Array_Resize(swigCPtr, size); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the capacity of the array. + /// + /// The allocated capacity of the array public uint Capacity() { uint ret = NDalicPINVOKE.Property_Array_Capacity(swigCPtr); @@ -255,12 +293,20 @@ namespace Tizen.NUI return ret; } + /// + /// Adds an element to the array. + /// + /// The value to add to the end of the array public void PushBack(PropertyValue value) { NDalicPINVOKE.Property_Array_PushBack(swigCPtr, PropertyValue.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Add an element to the array. + /// + /// The value to add to the end of the array public PropertyArray Add(PropertyValue value) { PropertyArray ret = new PropertyArray(NDalicPINVOKE.Property_Array_Add(swigCPtr, PropertyValue.getCPtr(value)), false); @@ -268,6 +314,11 @@ namespace Tizen.NUI return ret; } + /// + /// Access an element. + /// + /// The element index to access. No bounds checking is performed + /// The a reference to the element public PropertyValue GetElementAt(uint index) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Array_GetElementAt__SWIG_0(swigCPtr, index), false); @@ -275,6 +326,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the value of elements in the array. + /// + /// The element index to retrieve. + /// The a reference to the element public PropertyValue ValueOfIndex(uint index) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Array_ValueOfIndex__SWIG_0(swigCPtr, index), false); @@ -282,7 +338,12 @@ namespace Tizen.NUI return ret; } - public PropertyArray Assign(PropertyArray other) + /// + /// Copy the array. + /// + /// The array to copy from + /// The copied array + internal PropertyArray Assign(PropertyArray other) { PropertyArray ret = new PropertyArray(NDalicPINVOKE.Property_Array_Assign(swigCPtr, PropertyArray.getCPtr(other)), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -291,6 +352,9 @@ namespace Tizen.NUI } + /// + /// A key type which can be either a std::string or a Property::Index + /// public class PropertyKey : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -329,6 +393,9 @@ namespace Tizen.NUI } } + /// + /// The type of the key + /// public PropertyKey.Type type { set @@ -344,6 +411,9 @@ namespace Tizen.NUI } } + /// + /// The index key. + /// public int indexKey { set @@ -359,6 +429,9 @@ namespace Tizen.NUI } } + /// + /// The string key. + /// public string stringKey { set @@ -374,16 +447,29 @@ namespace Tizen.NUI } } + /// + /// Constructor + /// + /// The string key public PropertyKey(string key) : this(NDalicPINVOKE.new_Property_Key__SWIG_0(key), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor + /// + /// The index key public PropertyKey(int key) : this(NDalicPINVOKE.new_Property_Key__SWIG_1(key), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Compare if rhs is equal to + /// + /// A string key to compare against + /// Returns true if the key compares, or false if it isn't equal or of the wrong type public bool EqualTo(string rhs) { bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_0(swigCPtr, rhs); @@ -391,6 +477,11 @@ namespace Tizen.NUI return ret; } + /// + /// Compare if rhs is equal to + /// + /// A index key to compare against + /// Returns true if the key compares, or false if it isn't equal or of the wrong type public bool EqualTo(int rhs) { bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_1(swigCPtr, rhs); @@ -398,6 +489,11 @@ namespace Tizen.NUI return ret; } + /// + /// Compare if rhs is equal to + /// + /// A key to compare against + /// Returns true if the keys are of the same type and have the same value public bool EqualTo(PropertyKey rhs) { bool ret = NDalicPINVOKE.Property_Key_EqualTo__SWIG_2(swigCPtr, PropertyKey.getCPtr(rhs)); @@ -405,6 +501,11 @@ namespace Tizen.NUI return ret; } + /// + /// Compare if rhs is not equal to + /// + /// An index key to compare against. + /// Returns true if the key is not equal or not a string key public bool NotEqualTo(string rhs) { bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_0(swigCPtr, rhs); @@ -412,6 +513,11 @@ namespace Tizen.NUI return ret; } + /// + /// Compare if rhs is not equal to + /// + /// An index key to compare against. + /// Returns true if the key is not equal, or not an index key public bool NotEqualTo(int rhs) { bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_1(swigCPtr, rhs); @@ -419,6 +525,11 @@ namespace Tizen.NUI return ret; } + /// + /// Compare if rhs is not equal to + /// + /// A key to compare against. + /// Returns true if the keys are not of the same type or are not equal public bool NotEqualTo(PropertyKey rhs) { bool ret = NDalicPINVOKE.Property_Key_NotEqualTo__SWIG_2(swigCPtr, PropertyKey.getCPtr(rhs)); @@ -426,6 +537,9 @@ namespace Tizen.NUI return ret; } + /// + /// The type of key + /// public enum Type { Index, @@ -434,6 +548,9 @@ namespace Tizen.NUI } + /// + /// A Map of property values, the key type could be String or Property::Index. + /// public class PropertyMap : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -472,6 +589,12 @@ 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. + /// + /// The key whose value to access + /// A value for the element with the specified key public PropertyValue this[string key] { get @@ -480,6 +603,12 @@ 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. + /// + /// The key whose value to access + /// A value for the element with the specified key public PropertyValue this[int key] { get @@ -488,16 +617,27 @@ namespace Tizen.NUI } } + /// + /// Constructor + /// public PropertyMap() : this(NDalicPINVOKE.new_Property_Map__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Copy Constructor + /// + /// The Map to copy from public PropertyMap(PropertyMap other) : this(NDalicPINVOKE.new_Property_Map__SWIG_1(PropertyMap.getCPtr(other)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the number of elements in the map. + /// + /// The number of elements in the map public uint Count() { uint ret = NDalicPINVOKE.Property_Map_Count(swigCPtr); @@ -505,6 +645,10 @@ namespace Tizen.NUI return ret; } + /// + /// Returns whether the map is empty. + /// + /// Returns true if empty, false otherwise public bool Empty() { bool ret = NDalicPINVOKE.Property_Map_Empty(swigCPtr); @@ -512,18 +656,37 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public void Insert(string key, PropertyValue value) { NDalicPINVOKE.Property_Map_Insert__SWIG_0(swigCPtr, key, PropertyValue.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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 public void Insert(int key, PropertyValue value) { NDalicPINVOKE.Property_Map_Insert__SWIG_2(swigCPtr, key, PropertyValue.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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 + /// Returns a reference to this object public PropertyMap Add(string key, PropertyValue value) { PropertyMap ret = new PropertyMap(NDalicPINVOKE.Property_Map_Add__SWIG_0(swigCPtr, key, PropertyValue.getCPtr(value)), false); @@ -531,6 +694,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 + /// Returns a reference to this object public PropertyMap Add(int key, PropertyValue value) { PropertyMap ret = new PropertyMap(NDalicPINVOKE.Property_Map_Add__SWIG_2(swigCPtr, key, PropertyValue.getCPtr(value)), false); @@ -538,6 +708,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the value at the specified position. + /// + /// The specified position + /// A reference to the value at the specified position public PropertyValue GetValue(uint position) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_GetValue(swigCPtr, position), false); @@ -545,6 +720,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the key at the specified position. + /// + /// The specified position + /// A reference to the key at the specified position public string GetKey(uint position) { string ret = NDalicPINVOKE.Property_Map_GetKey(swigCPtr, position); @@ -552,6 +732,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieve the key at the specified position. + /// + /// The specified position + /// A copy of the key at the specified position public PropertyKey GetKeyAt(uint position) { PropertyKey ret = new PropertyKey(NDalicPINVOKE.Property_Map_GetKeyAt(swigCPtr, position), true); @@ -566,6 +751,11 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the value for the specified key if it exists. + /// + /// The key to find + /// The value if it exists, an empty object otherwise public PropertyValue Find(string key) { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_0(swigCPtr, key); @@ -574,6 +764,11 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the value for the specified key if it exists. + /// + /// The key to find + /// The value if it exists, an empty object otherwise public PropertyValue Find(int key) { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_2(swigCPtr, key); @@ -582,6 +777,12 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the value for the specified keys if either exist. + /// + /// The index key to find + /// The string key to find + /// The value if it exists, an empty object otherwise public PropertyValue Find(int indexKey, string stringKey) { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_3(swigCPtr, indexKey, stringKey); @@ -590,6 +791,12 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the value for the specified key if it exists and its type is type. + /// + /// The key to find + /// The type to check + /// The value if it exists, an empty value otherwise public PropertyValue Find(string key, PropertyType type) { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_4(swigCPtr, key, (int)type); @@ -598,6 +805,12 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the value for the specified key if it exists and its type is type. + /// + /// The key to find + /// The type to check + /// The value if it exists, an empty value otherwise public PropertyValue Find(int key, PropertyType type) { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Map_Find__SWIG_5(swigCPtr, key, (int)type); @@ -606,18 +819,31 @@ namespace Tizen.NUI return ret; } + /// + /// Clears the map. + /// public void Clear() { NDalicPINVOKE.Property_Map_Clear(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// 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) { NDalicPINVOKE.Property_Map_Merge(swigCPtr, PropertyMap.getCPtr(from)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves the element with the specified string key. + /// + /// The key whose value to retrieve + /// The value for the element with the specified key public PropertyValue ValueOfIndex(string key) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_ValueOfIndex__SWIG_0(swigCPtr, key), false); @@ -625,6 +851,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the element with the specified index key. + /// + /// The key whose value to retrieve + /// The value for the element with the specified key public PropertyValue ValueOfIndex(int key) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Map_ValueOfIndex__SWIG_2(swigCPtr, key), false); @@ -632,7 +863,12 @@ namespace Tizen.NUI return ret; } - public PropertyMap Assign(PropertyMap other) + /// + /// Copy the map. + /// + /// The map to copy from + /// The copied map + internal PropertyMap Assign(PropertyMap other) { PropertyMap ret = new PropertyMap(NDalicPINVOKE.Property_Map_Assign(swigCPtr, PropertyMap.getCPtr(other)), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -641,6 +877,9 @@ namespace Tizen.NUI } + /// + /// A value-type representing a property value. + /// public class PropertyValue : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -680,8 +919,12 @@ namespace Tizen.NUI } - // Extension to property value class that allows us to create a - // PropertyValue from a C# object, e.g. int, float, string + /// + /// Extension to property value class that allows us to create a + /// PropertyValue from a C# object, e.g. int, float, string + /// + /// An object to create + /// The created value static public PropertyValue CreateFromObject(System.Object obj) { System.Type type = obj.GetType(); @@ -752,32 +995,56 @@ namespace Tizen.NUI } + /// + /// Creates a Size2D property value. + /// + /// A Size2D values public PropertyValue(Size2D vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Size2D.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Size property value. + /// + /// A Size values public PropertyValue(Size vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Size.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Position2D property value. + /// + /// A Position2D values public PropertyValue(Position2D vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Position2D.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Position property value. + /// + /// A Position values public PropertyValue(Position vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Position.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Color property value. + /// + /// A Color values public PropertyValue(Color vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_6(Color.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Retrieves a Size2D value. + /// + /// On return, a Size2D value public bool Get(Size2D vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Size2D.getCPtr(vectorValue)); @@ -785,6 +1052,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a Size2D value. + /// + /// On return, a Size2D value public bool Get(Size vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Size.getCPtr(vectorValue)); @@ -792,6 +1063,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a Position2D value. + /// + /// On return, a Position2D value public bool Get(Position2D vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Position2D.getCPtr(vectorValue)); @@ -799,6 +1074,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a Position value. + /// + /// On return, a Position value public bool Get(Position vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Position.getCPtr(vectorValue)); @@ -806,6 +1085,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a Color value. + /// + /// On return, a Color value public bool Get(Color vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_7(swigCPtr, Color.getCPtr(vectorValue)); @@ -815,36 +1098,63 @@ namespace Tizen.NUI + /// + /// Default constructor. + /// public PropertyValue() : this(NDalicPINVOKE.new_Property_Value__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a boolean property value. + /// + /// A boolean value public PropertyValue(bool boolValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_1(boolValue), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an integer property value. + /// + /// An integer value public PropertyValue(int integerValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_2(integerValue), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a float property value. + /// + /// A floating-point value public PropertyValue(float floatValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_3(floatValue), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Vector2 property value. + /// + /// A vector of 2 floating-point values public PropertyValue(Vector2 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_4(Vector2.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Vector3 property value. + /// + /// A vector of 3 floating-point values public PropertyValue(Vector3 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_5(Vector3.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Vector4 property value. + /// + /// A vector of 4 floating-point values public PropertyValue(Vector4 vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_6(Vector4.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -860,6 +1170,10 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Rectangle property value. + /// + /// A Rectangle values public PropertyValue(Rectangle vectorValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_9(Rectangle.getCPtr(vectorValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -870,43 +1184,76 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a Rotation property value. + /// + /// A Rotation values public PropertyValue(Rotation quaternion) : this(NDalicPINVOKE.new_Property_Value__SWIG_11(Rotation.getCPtr(quaternion)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a string property value. + /// + /// A string public PropertyValue(string stringValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_12(stringValue), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an array property value. + /// + /// An array public PropertyValue(PropertyArray arrayValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_14(PropertyArray.getCPtr(arrayValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a map property value. + /// + /// An array public PropertyValue(PropertyMap mapValue) : this(NDalicPINVOKE.new_Property_Value__SWIG_15(PropertyMap.getCPtr(mapValue)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a PropertyType value. + /// + /// A PropertyType values public PropertyValue(PropertyType type) : this(NDalicPINVOKE.new_Property_Value__SWIG_16((int)type), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates a PropertyValue value. + /// + /// A PropertyValue values public PropertyValue(PropertyValue value) : this(NDalicPINVOKE.new_Property_Value__SWIG_17(PropertyValue.getCPtr(value)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - public PropertyValue Assign(PropertyValue value) + /// + /// Copy the value. + /// + /// The value to copy from + /// The copied value + internal PropertyValue Assign(PropertyValue value) { PropertyValue ret = new PropertyValue(NDalicPINVOKE.Property_Value_Assign(swigCPtr, PropertyValue.getCPtr(value)), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } + /// + /// Queries the type of this property value. + /// + /// The type ID public PropertyType GetType() { PropertyType ret = (PropertyType)NDalicPINVOKE.Property_Value_GetType(swigCPtr); @@ -914,6 +1261,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a boolean value. + /// + /// On return, a boolean value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(ref bool boolValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_1(swigCPtr, ref boolValue); @@ -921,6 +1273,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a floating-point value. + /// + /// On return, a floating-point value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(ref float floatValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_2(swigCPtr, ref floatValue); @@ -928,6 +1285,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a integer value. + /// + /// On return, a integer value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(ref int integerValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_3(swigCPtr, ref integerValue); @@ -935,6 +1297,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves an integer rectangle. + /// + /// On return, an integer rectangle + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(Rectangle rect) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_4(swigCPtr, Rectangle.getCPtr(rect)); @@ -942,6 +1309,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a vector value. + /// + /// On return, a vector value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(Vector2 vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_5(swigCPtr, Vector2.getCPtr(vectorValue)); @@ -949,6 +1321,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a vector value. + /// + /// On return, a vector value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(Vector3 vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_6(swigCPtr, Vector3.getCPtr(vectorValue)); @@ -956,6 +1333,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a vector value. + /// + /// On return, a vector value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(Vector4 vectorValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_7(swigCPtr, Vector4.getCPtr(vectorValue)); @@ -984,6 +1366,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a Rotation value. + /// + /// On return, a Rotation value + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(Rotation quaternionValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_11(swigCPtr, Rotation.getCPtr(quaternionValue)); @@ -991,6 +1378,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves a string property value. + /// + /// On return, a string + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(out string stringValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_12(swigCPtr, out stringValue); @@ -998,6 +1390,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves an array property value. + /// + /// On return, the array as a vector Property Values + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(PropertyArray arrayValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_13(swigCPtr, PropertyArray.getCPtr(arrayValue)); @@ -1005,6 +1402,11 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves an map property value. + /// + /// On return, the map as vector of string and Property Value pairs + /// Returns true if the value is successfully retrieved, false if the type is not convertible public bool Get(PropertyMap mapValue) { bool ret = NDalicPINVOKE.Property_Value_Get__SWIG_14(swigCPtr, PropertyMap.getCPtr(mapValue)); @@ -1012,6 +1414,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the Array API of the Property::Value without copying the contents of the map. + /// + /// The Array API of the Property::Value or NULL if not a Property::Array public PropertyArray GetArray() { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Value_GetArray(swigCPtr); @@ -1020,6 +1426,10 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the Map API of the Property::Value without copying the contents of the map. + /// + /// The Map API of the Property::Value or NULL if not a Property::Map public PropertyMap GetMap() { global::System.IntPtr cPtr = NDalicPINVOKE.Property_Value_GetMap(swigCPtr); diff --git a/src/Tizen.NUI/src/public/PushButton.cs b/src/Tizen.NUI/src/public/PushButton.cs index aa78346..ca01c05 100755 --- a/src/Tizen.NUI/src/public/PushButton.cs +++ b/src/Tizen.NUI/src/public/PushButton.cs @@ -27,6 +27,9 @@ namespace Tizen.NUI { + /// + /// A PushButton changes its appearance when is pressed and returns to its original when is released. + /// public class PushButton : Button { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -122,6 +125,9 @@ namespace Tizen.NUI } + /// + /// Creates the PushButton. + /// public PushButton() : this(NDalicPINVOKE.PushButton_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -139,6 +145,13 @@ namespace Tizen.NUI return ret; } + /// + /// 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 public new static PushButton DownCast(BaseHandle handle) { PushButton ret = new PushButton(NDalicPINVOKE.PushButton_DownCast(BaseHandle.getCPtr(handle)), true); @@ -206,6 +219,9 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// Sets the unselected button image. + /// public string UnselectedIcon { set @@ -213,6 +229,9 @@ namespace Tizen.NUI SetProperty(PushButton.Property.UNSELECTED_ICON, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Sets the selected button image. + /// public string SelectedIcon { set @@ -220,6 +239,9 @@ namespace Tizen.NUI SetProperty(PushButton.Property.SELECTED_ICON, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Sets the icon alignment. + /// public string IconAlignment { get @@ -233,6 +255,9 @@ namespace Tizen.NUI SetProperty(PushButton.Property.ICON_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + /// + /// Sets the label padding value. + /// public Vector4 LabelPadding { get @@ -247,6 +272,9 @@ namespace Tizen.NUI } } + /// + /// Sets the icon padding value. + /// public string IconPadding { get diff --git a/src/Tizen.NUI/src/public/Radian.cs b/src/Tizen.NUI/src/public/Radian.cs index acbf511..4282a39 100755 --- a/src/Tizen.NUI/src/public/Radian.cs +++ b/src/Tizen.NUI/src/public/Radian.cs @@ -11,6 +11,9 @@ namespace Tizen.NUI { + /// + /// An angle in radians. + /// public class Radian : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -56,35 +59,60 @@ namespace Tizen.NUI } + /// + /// Default constructor, initializes to 0. + /// public Radian() : this(NDalicPINVOKE.new_Radian__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an angle in radians. + /// + /// The initial value in radians public Radian(float value) : this(NDalicPINVOKE.new_Radian__SWIG_1(value), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Creates an angle in radians from an angle in degrees. + /// + /// The initial value in degrees public Radian(Degree degree) : this(NDalicPINVOKE.new_Radian__SWIG_2(Degree.getCPtr(degree)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - public Radian Assign(float value) + /// + /// Assigns an angle from a float value. + /// + /// Float value in radians + /// A reference to this + internal Radian Assign(float value) { Radian ret = new Radian(NDalicPINVOKE.Radian_Assign__SWIG_0(swigCPtr, value), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } - public Radian Assign(Degree degree) + /// + /// Assigns an angle from a Degree value. + /// + /// The value in degrees + /// A reference to this + internal Radian Assign(Degree degree) { Radian ret = new Radian(NDalicPINVOKE.Radian_Assign__SWIG_1(swigCPtr, Degree.getCPtr(degree)), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } + /// + /// Conversion to float. + /// + /// The float value of this Radian public float ConvertToFloat() { float ret = NDalicPINVOKE.Radian_ConvertToFloat(swigCPtr); @@ -92,6 +120,9 @@ namespace Tizen.NUI return ret; } + /// + /// The value in radians + /// public float radian { set