From 5499bd5142ce18db667f206b998e601d9babc918 Mon Sep 17 00:00:00 2001 From: "taeyoon0.lee" Date: Thu, 16 Mar 2017 00:47:25 +0900 Subject: [PATCH] Add comments for API reference of part 4 Change-Id: I8972312de522dbc9fe1e01f8c48636b99877fc7a --- src/Tizen.NUI/src/public/Size.cs | 64 ++++++++- src/Tizen.NUI/src/public/Size2D.cs | 57 +++++++- src/Tizen.NUI/src/public/Slider.cs | 89 ++++++++++++- src/Tizen.NUI/src/public/Stage.cs | 138 +++++++++---------- src/Tizen.NUI/src/public/StyleManager.cs | 85 ++++++++---- src/Tizen.NUI/src/public/TableView.cs | 168 ++++++++++++++++++++++- src/Tizen.NUI/src/public/TapGesture.cs | 30 +++++ src/Tizen.NUI/src/public/TextEditor.cs | 196 +++++++++++++++++++++++++-- src/Tizen.NUI/src/public/TextField.cs | 220 ++++++++++++++++++++++++++++++- 9 files changed, 928 insertions(+), 119 deletions(-) diff --git a/src/Tizen.NUI/src/public/Size.cs b/src/Tizen.NUI/src/public/Size.cs index 7853ed1..2d0ea5c 100755 --- a/src/Tizen.NUI/src/public/Size.cs +++ b/src/Tizen.NUI/src/public/Size.cs @@ -18,6 +18,9 @@ namespace Tizen.NUI { + /// + /// Three dimensional size + /// public class Size : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -39,6 +42,8 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// public virtual void Dispose() { if (!Stage.IsInstalled()) @@ -63,41 +68,65 @@ namespace Tizen.NUI } + /// + /// Addition operator. + /// public static Size operator +(Size arg1, Size arg2) { return arg1.Add(arg2); } + /// + /// Subtraction operator. + /// public static Size operator -(Size arg1, Size arg2) { return arg1.Subtract(arg2); } + /// + /// + /// public static Size operator -(Size arg1) { return arg1.Subtract(); } + /// + /// Multiplication operator. + /// public static Size operator *(Size arg1, Size arg2) { return arg1.Multiply(arg2); } + /// + /// Multiplication operator. + /// public static Size operator *(Size arg1, float arg2) { return arg1.Multiply(arg2); } + /// + /// Division operator. + /// public static Size operator /(Size arg1, Size arg2) { return arg1.Divide(arg2); } + /// + /// Division operator. + /// public static Size operator /(Size arg1, float arg2) { return arg1.Divide(arg2); } + /// + /// Array subscript operator. + /// public float this[uint index] { get @@ -106,6 +135,8 @@ namespace Tizen.NUI } } + /// + /// public static Size GetSizeFromPtr(global::System.IntPtr cPtr) { Size ret = new Size(cPtr, false); @@ -113,23 +144,32 @@ namespace Tizen.NUI return ret; } - + /// + /// Constructor. + /// public Size() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public Size(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. + /// public Size(Size2D size2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Size2D.getCPtr(size2d)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - + /// + /// public static Size Zero { get @@ -197,6 +237,10 @@ namespace Tizen.NUI return ret; } + /// + /// Check equality. + /// Utilizes appropriate machine epsilon values. + /// public bool EqualTo(Size rhs) { bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Size.getCPtr(rhs)); @@ -204,6 +248,10 @@ namespace Tizen.NUI return ret; } + /// + /// Check inequality. + /// Utilizes appropriate machine epsilon values. + /// public bool NotEqualTo(Size rhs) { bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Size.getCPtr(rhs)); @@ -211,7 +259,8 @@ namespace Tizen.NUI return ret; } - + /// + /// public float Width { set @@ -227,6 +276,8 @@ namespace Tizen.NUI } } + /// + /// public float Height { set @@ -242,6 +293,8 @@ namespace Tizen.NUI } } + /// + /// public float Depth { set @@ -257,12 +310,15 @@ namespace Tizen.NUI } } - + /// + /// public static implicit operator Vector3(Size size) { return new Vector3(size.Width, size.Height, size.Depth); } + /// + /// public static implicit operator Size(Vector3 vec) { return new Size(vec.Width, vec.Height, vec.Depth); diff --git a/src/Tizen.NUI/src/public/Size2D.cs b/src/Tizen.NUI/src/public/Size2D.cs index a042de1..2dedff9 100755 --- a/src/Tizen.NUI/src/public/Size2D.cs +++ b/src/Tizen.NUI/src/public/Size2D.cs @@ -18,6 +18,9 @@ namespace Tizen.NUI { + /// + /// A two dimensional size + /// public class Size2D : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -39,6 +42,8 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// public virtual void Dispose() { if (!Stage.IsInstalled()) @@ -62,42 +67,64 @@ namespace Tizen.NUI } } - + /// + /// Addition operator. + /// public static Size2D operator +(Size2D arg1, Size2D arg2) { return arg1.Add(arg2); } + /// + /// Subtraction operator. + /// public static Size2D operator -(Size2D arg1, Size2D arg2) { return arg1.Subtract(arg2); } + /// + /// public static Size2D operator -(Size2D arg1) { return arg1.Subtract(); } + /// + /// Multiplication operator. + /// public static Size2D operator *(Size2D arg1, Size2D arg2) { return arg1.Multiply(arg2); } + /// + /// Multiplication operator. + /// public static Size2D operator *(Size2D arg1, int arg2) { return arg1.Multiply(arg2); } + /// + /// Division operator. + /// public static Size2D operator /(Size2D arg1, Size2D arg2) { return arg1.Divide(arg2); } + /// + /// Division operator. + /// public static Size2D operator /(Size2D arg1, int arg2) { return arg1.Divide(arg2); } + /// + /// Array subscript operator. + /// public float this[uint index] { get @@ -106,6 +133,7 @@ namespace Tizen.NUI } } + /// public static Size2D GetSize2DFromPtr(global::System.IntPtr cPtr) { Size2D ret = new Size2D(cPtr, false); @@ -113,17 +141,25 @@ namespace Tizen.NUI return ret; } - + /// + /// Constructor. + /// public Size2D() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public Size2D(int x, int y) : this(NDalicPINVOKE.new_Vector2__SWIG_1((float)x, (float)y), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public Size2D(Size size) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Size.getCPtr(size)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -180,6 +216,10 @@ namespace Tizen.NUI return ret; } + /// + /// Check equality. + /// Utilizes appropriate machine epsilon values. + /// public bool EqualTo(Size2D rhs) { bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, Size2D.getCPtr(rhs)); @@ -187,6 +227,10 @@ namespace Tizen.NUI return ret; } + /// + /// Check inequality. + /// Utilizes appropriate machine epsilon values. + /// public bool NotEqualTo(Size2D rhs) { bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, Size2D.getCPtr(rhs)); @@ -201,7 +245,8 @@ namespace Tizen.NUI return ret; } - + /// + /// public int Width { set @@ -217,6 +262,8 @@ namespace Tizen.NUI } } + /// + /// public int Height { set @@ -232,11 +279,15 @@ namespace Tizen.NUI } } + /// + /// public static implicit operator Vector2(Size2D size) { return new Vector2((float)size.Width, (float)size.Height); } + /// + /// public static implicit operator Size2D(Vector2 vec) { return new Size2D((int)vec.X, (int)vec.Y); diff --git a/src/Tizen.NUI/src/public/Slider.cs b/src/Tizen.NUI/src/public/Slider.cs index 700c53e..356a01a 100755 --- a/src/Tizen.NUI/src/public/Slider.cs +++ b/src/Tizen.NUI/src/public/Slider.cs @@ -30,7 +30,9 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; - + /// + /// Slider is a control to enable sliding an indicator between two values. + /// public class Slider : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -76,6 +78,9 @@ namespace Tizen.NUI + /// + /// Emitted when the slider value changes. + /// public class ValueChangedEventArgs : EventArgs { private Slider _slider; @@ -106,6 +111,9 @@ namespace Tizen.NUI } } + /// + /// Emitted when the sliding is finished. + /// public class SlidingFinishedEventArgs : EventArgs { private Slider _slider; @@ -136,6 +144,9 @@ namespace Tizen.NUI } } + /// + /// Emitted when the slider handle reaches a mark. + /// public class MarkReachedEventArgs : EventArgs { private Slider _slider; @@ -182,6 +193,8 @@ namespace Tizen.NUI private EventHandlerWithReturnType _sliderMarkReachedEventHandler; private MarkReachedCallbackDelegate _sliderMarkReachedCallbackDelegate; + /// + /// public event EventHandlerWithReturnType ValueChanged { add @@ -220,6 +233,8 @@ namespace Tizen.NUI return false; } + /// + /// public event EventHandlerWithReturnType SlidingFinished { add @@ -258,6 +273,8 @@ namespace Tizen.NUI return false; } + /// + /// public event EventHandlerWithReturnType MarkReached { add @@ -296,6 +313,8 @@ namespace Tizen.NUI return false; } + /// + /// public static Slider GetSliderFromPtr(global::System.IntPtr cPtr) { Slider ret = new Slider(cPtr, false); @@ -303,7 +322,6 @@ namespace Tizen.NUI return ret; } - internal class Property : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -365,6 +383,9 @@ namespace Tizen.NUI } + /// + /// Creates an empty Slider handle. + /// public Slider() : this(NDalicPINVOKE.Slider_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -382,6 +403,11 @@ namespace Tizen.NUI return ret; } + /// + /// Downcasts an Object handle to Slider. + /// If handle points to a Slider, the downcast produces valid handle. + /// If not, the returned handle is left uninitialized. + /// public new static Slider DownCast(BaseHandle handle) { Slider ret = new Slider(NDalicPINVOKE.Slider_DownCast(BaseHandle.getCPtr(handle)), true); @@ -416,6 +442,9 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// Lower bound property + /// public float LowerBound { get @@ -429,6 +458,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.LOWER_BOUND, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Upper bound property + /// public float UpperBound { get @@ -442,6 +475,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.UPPER_BOUND, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Value property + /// public float Value { get @@ -455,6 +492,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.VALUE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Track visual property + /// public PropertyMap TrackVisual { get @@ -468,6 +509,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.TRACK_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Handle visual property + /// public PropertyMap HandleVisual { get @@ -481,6 +526,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.HANDLE_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Progress visual property + /// public PropertyMap ProgressVisual { get @@ -494,6 +543,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Popup visual property + /// public PropertyMap PopupVisual { get @@ -507,6 +560,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.POPUP_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Popup arrow visual property + /// public PropertyMap PopupArrowVisual { get @@ -520,6 +577,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.POPUP_ARROW_VISUAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Disable color property + /// public Vector4 DisabledColor { get @@ -533,6 +594,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.DISABLED_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Value presicion property + /// public int ValuePrecision { get @@ -546,6 +611,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.VALUE_PRECISION, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Show popup property + /// public bool ShowPopup { get @@ -559,6 +628,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.SHOW_POPUP, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Show value property + /// public bool ShowValue { get @@ -572,6 +645,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.SHOW_VALUE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Marks property + /// public Tizen.NUI.PropertyArray Marks { get @@ -585,6 +662,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.MARKS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Snap to marks property + /// public bool SnapToMarks { get @@ -598,6 +679,10 @@ namespace Tizen.NUI SetProperty(Slider.Property.SNAP_TO_MARKS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Mark tolerance property + /// public float MarkTolerance { get diff --git a/src/Tizen.NUI/src/public/Stage.cs b/src/Tizen.NUI/src/public/Stage.cs index 008efcb..b0d5320 100755 --- a/src/Tizen.NUI/src/public/Stage.cs +++ b/src/Tizen.NUI/src/public/Stage.cs @@ -14,7 +14,16 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; - + /// + /// The Stage is a top-level object used for displaying a tree of Actors. + /// Stage is a top-level object that represents the entire screen. + /// It is used for displaying a hierarchy of actors managed by the scene graph structure, + /// which means an actor inherits a position relative to its parent, + /// and can be moved in relation to this point. + /// The stage instance is a singleton object (the only instance of its class during the + /// lifetime of the program). You can get it using a static function. + /// To display the contents of an actor, it must be added to a stage. + /// public class Stage : BaseHandle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -58,21 +67,16 @@ namespace Tizen.NUI } } - - - - /** - * @brief Event arguments that passed via Touch signal - * - */ + /// + /// Touch event argument + /// public class TouchEventArgs : EventArgs { private Touch _touch; - /** - * @brief Touch - contains the information of touch points - * - */ + /// + /// Touch + /// public Touch Touch { get @@ -89,12 +93,12 @@ namespace Tizen.NUI private event EventHandler _stageTouchHandler; private EventCallbackDelegateType1 _stageTouchCallbackDelegate; - /** - * @brief Event for TouchEvent signal which can be used to subscribe/unsubscribe the event handler - * TouchEvent signal is emitted when the screen is touched and when the touch ends - * (i.e. the down & up touch events only). - * - */ + /// + /// This is emitted when the screen is touched and when the touch ends. + /// If there are multiple touch points, then this will be emitted when the first touch occurs and + /// then when the last finger is lifted. + /// An interrupted event will also be emitted (if it occurs). + /// public event EventHandler Touch { add @@ -131,18 +135,16 @@ namespace Tizen.NUI } } - /** - * @brief Wheel arguments that passed via Wheel signal - * - */ + /// + /// Wheel event arguments + /// public class WheelEventArgs : EventArgs { private Wheel _wheel; - /** - * @brief Wheel - store a wheel rolling type MOUSE_WHEEL or CUSTOM_WHEEL - * - */ + /// + /// Wheel + /// public Wheel Wheel { get @@ -159,11 +161,9 @@ namespace Tizen.NUI private event EventHandler _stageWheelHandler; private EventCallbackDelegateType1 _stageWheelCallbackDelegate; - /** - * @brief Event for Wheel signal which can be used to subscribe/unsubscribe the event handler - * Wheel signal is emitted is emitted when wheel event is received. - * - */ + /// + /// This is emitted when wheel event is received. + /// public event EventHandler Wheel { add @@ -200,18 +200,16 @@ namespace Tizen.NUI } } - /** - * @brief Event arguments that passed via Key signal - * - */ + /// + /// Key event arguments. + /// public class KeyEventArgs : EventArgs { private Key _key; - /** - * @brief Key - is the keyevent sent to Stage. - * - */ + /// + /// Key + /// public Key Key { get @@ -228,11 +226,9 @@ namespace Tizen.NUI private event EventHandler _stageKeyHandler; private EventCallbackDelegateType1 _stageKeyCallbackDelegate; - /** - * @brief Event for Key signal which can be used to subscribe/unsubscribe the event handler - * Key signal is emitted is emitted when key event is received. - * - */ + /// + /// This is emitted when key event is received. + /// public event EventHandler Key { add @@ -275,11 +271,6 @@ namespace Tizen.NUI private event EventHandler _stageEventProcessingFinishedEventHandler; private EventCallbackDelegateType0 _stageEventProcessingFinishedEventCallbackDelegate; - /** - * @brief Event for EventProcessingFinished signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. EventProcessingFinished signal is emitted just after the event processing is finished. - * - */ internal event EventHandler EventProcessingFinished { add @@ -315,11 +306,6 @@ namespace Tizen.NUI private EventHandler _stageContextLostEventHandler; private EventCallbackDelegateType0 _stageContextLostEventCallbackDelegate; - /** - * @brief Event for ContextLost signal which can be used to subscribe/unsubscribe the event handler - * ContextLost signal is emitted when the GL context is lost (Platform specific behaviour). - * - */ internal event EventHandler ContextLost { add @@ -354,12 +340,6 @@ namespace Tizen.NUI private EventHandler _stageContextRegainedEventHandler; private EventCallbackDelegateType0 _stageContextRegainedEventCallbackDelegate; - /** - * @brief Event for ContextRegained signal which can be used to subscribe/unsubscribe the event handler - * provided by the user. ContextRegained signal is emitted when the GL context is regained (Platform specific - * behaviour). - * - */ internal event EventHandler ContextRegained { add @@ -394,11 +374,6 @@ namespace Tizen.NUI private EventHandler _stageSceneCreatedEventHandler; private EventCallbackDelegateType0 _stageSceneCreatedEventCallbackDelegate; - /** - * @brief Event for SceneCreated signal which can be used to subscribe/unsubscribe the event handler - * SceneCreated signal is emitted after the initial scene is created. - * - */ internal event EventHandler SceneCreated { add @@ -429,7 +404,9 @@ namespace Tizen.NUI } } - + /// + /// Size. + /// public Size2D Size { get @@ -439,6 +416,9 @@ namespace Tizen.NUI } } + /// + /// Background color. + /// public Color BackgroundColor { set @@ -452,6 +432,9 @@ namespace Tizen.NUI } } + /// + /// Dpi. + /// public Vector2 Dpi { get @@ -460,6 +443,9 @@ namespace Tizen.NUI } } + /// + /// Layer count. + /// public uint LayerCount { get @@ -470,6 +456,9 @@ namespace Tizen.NUI private static readonly Stage instance = Stage.GetCurrent(); + /// + /// Stage instance. + /// public static Stage Instance { get @@ -478,23 +467,30 @@ namespace Tizen.NUI } } + /// + /// Get default ( root ) layer. + /// public Layer GetDefaultLayer() { return this.GetRootLayer(); } + /// + /// Add layer to the Stage. + /// public void AddLayer(Layer layer) { this.Add((Actor)layer); } + /// + /// Remove layer from the Stage. + /// public void RemoveLayer(Layer layer) { this.Remove((Actor)layer); } - - internal static Vector4 DEFAULT_BACKGROUND_COLOR { get @@ -581,6 +577,9 @@ namespace Tizen.NUI return ret; } + /// + /// Retrieves the layer at a specified depth. + /// public Layer GetLayer(uint depth) { Layer ret = new Layer(NDalicPINVOKE.Stage_GetLayer(swigCPtr, depth), true); @@ -622,6 +621,9 @@ namespace Tizen.NUI return ret; } + /// + /// Keep rendering for at least the given amount of time. + /// public void KeepRendering(float durationSeconds) { NDalicPINVOKE.Stage_KeepRendering(swigCPtr, durationSeconds); diff --git a/src/Tizen.NUI/src/public/StyleManager.cs b/src/Tizen.NUI/src/public/StyleManager.cs index dd98681..c75cf18 100755 --- a/src/Tizen.NUI/src/public/StyleManager.cs +++ b/src/Tizen.NUI/src/public/StyleManager.cs @@ -14,6 +14,19 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; + /// + /// StyleManager informs applications of system theme change, + /// and supports application theme change at runtime. + /// Applies various styles to Controls using the properties system. + /// On theme change, it automatically updates all controls, then raises + /// a event to inform the application. + /// + /// If the application wants to customize the theme, RequestThemeChange + /// needs to be called. + /// It provides the path to the application resource root folder, + /// from there the filename can an be specified along with + /// any sub folders, e.g Images, Models etc. + /// public class StyleManager : BaseHandle { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -33,6 +46,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -57,23 +73,17 @@ namespace Tizen.NUI } } - - - - /** - * @brief Event arguments that passed via StyleChanged signal - * - */ + /// + /// Style changed event arguments + /// public class StyleChangedEventArgs : EventArgs { private StyleManager _styleManager; private StyleChangeType _styleChange; - /** - * @brief StyleManager - is the StyleManager that informs applications of system theme change, - * and supports application theme change at runtime. - * - */ + /// + /// StyleManager. + /// public StyleManager StyleManager { get @@ -86,11 +96,10 @@ namespace Tizen.NUI } } - /** - * @brief StyleChange - contains Style change information (default font changed or - * default font size changed or theme has changed) - * - */ + /// + /// StyleChange - contains Style change information (default font changed or + /// default font size changed or theme has changed) + /// public StyleChangeType StyleChange { get @@ -110,12 +119,12 @@ namespace Tizen.NUI private EventHandler _styleManagerStyleChangedEventHandler; private StyleChangedCallbackDelegate _styleManagerStyleChangedCallbackDelegate; - /** - * @brief Event for StyleChanged signal which can be used to subscribe/unsubscribe the - * event handler (in the type of StyleChangedEventHandler-DaliEventHandler) - * provided by the user. StyleChanged signal is is emitted after the style (e.g. theme/font change) has changed - * and the controls have been informed. - */ + /// + /// Event for StyleChanged signal which can be used to subscribe/unsubscribe the + /// event handler provided by the user. + /// StyleChanged signal is is emitted after the style (e.g. theme/font change) has changed + /// and the controls have been informed. + /// public event EventHandler StyleChanged { add @@ -160,12 +169,18 @@ namespace Tizen.NUI return ret; } - + /// + /// Creates a StyleManager handle. + /// this can be initialized with StyleManager::Get(). + /// public StyleManager() : this(NDalicPINVOKE.new_StyleManager(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets the singleton of StyleManager object. + /// public static StyleManager Get() { StyleManager ret = new StyleManager(NDalicPINVOKE.StyleManager_Get(), true); @@ -173,24 +188,40 @@ namespace Tizen.NUI return ret; } + /// + /// Applies a new theme to the application. + /// This will be merged on top of the default Toolkit theme. + /// If the application theme file doesn't style all controls that the + /// application uses, then the default Toolkit theme will be used + /// instead for those controls. + /// public void ApplyTheme(string themeFile) { NDalicPINVOKE.StyleManager_ApplyTheme(swigCPtr, themeFile); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Applies the default Toolkit theme. + /// public void ApplyDefaultTheme() { NDalicPINVOKE.StyleManager_ApplyDefaultTheme(swigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Sets a constant for use when building styles. + /// public void SetStyleConstant(string key, PropertyValue value) { NDalicPINVOKE.StyleManager_SetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Returns the style constant set for a specific key. + /// public bool GetStyleConstant(string key, PropertyValue valueOut) { bool ret = NDalicPINVOKE.StyleManager_GetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(valueOut)); @@ -198,6 +229,9 @@ namespace Tizen.NUI return ret; } + /// + /// Applies the specified style to the control. + /// public void ApplyStyle(View control, string jsonFileName, string styleName) { NDalicPINVOKE.StyleManager_ApplyStyle(swigCPtr, View.getCPtr(control), jsonFileName, styleName); @@ -213,6 +247,9 @@ namespace Tizen.NUI } + /// + /// Types of style change. + /// public enum StyleChangeType { DefaultFontChange, diff --git a/src/Tizen.NUI/src/public/TableView.cs b/src/Tizen.NUI/src/public/TableView.cs index 73b7321..3774169 100755 --- a/src/Tizen.NUI/src/public/TableView.cs +++ b/src/Tizen.NUI/src/public/TableView.cs @@ -26,7 +26,12 @@ namespace Tizen.NUI { - + /// + /// TableView is a layout container for aligning child actors in a grid like layout. + /// TableView constrains the x and y position and width and height of the child actors. + /// z position and depth are left intact so that 3D model actors can also be laid out + /// in a grid without loosing their depth scaling. + /// public class TableView : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -46,6 +51,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -173,6 +181,9 @@ namespace Tizen.NUI } + /// + /// Class to specify layout position for child actor. + /// public class CellPosition : global::System.IDisposable { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -194,6 +205,9 @@ namespace Tizen.NUI Dispose(); } + /// + /// Dispose + /// public virtual void Dispose() { lock (this) @@ -211,31 +225,49 @@ namespace Tizen.NUI } } + /// + /// Constructor. + /// public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan, uint columnSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_0(rowIndex, columnIndex, rowSpan, columnSpan), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_1(rowIndex, columnIndex, rowSpan), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public CellPosition(uint rowIndex, uint columnIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_2(rowIndex, columnIndex), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor. + /// public CellPosition(uint rowIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_3(rowIndex), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Constructor to initialise values to defaults for convenience. + /// public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Row index. + /// public uint rowIndex { set @@ -251,6 +283,9 @@ namespace Tizen.NUI } } + /// + /// Column index. + /// public uint columnIndex { set @@ -266,6 +301,9 @@ namespace Tizen.NUI } } + /// + /// Row span. + /// public uint rowSpan { set @@ -281,6 +319,9 @@ namespace Tizen.NUI } } + /// + /// Column span. + /// public uint columnSpan { set @@ -298,16 +339,26 @@ namespace Tizen.NUI } + /// + /// Creates the TableView control. + /// public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// Copy constructor. Creates another handle that points to the same real object. + /// public TableView(TableView handle) : this(NDalicPINVOKE.new_TableView__SWIG_1(TableView.getCPtr(handle)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Changes this handle to point to another real object. + /// public TableView Assign(TableView handle) { TableView ret = new TableView(NDalicPINVOKE.TableView_Assign(swigCPtr, TableView.getCPtr(handle)), false); @@ -315,6 +366,9 @@ namespace Tizen.NUI return ret; } + /// + /// Downcasts a handle to TableView handle. + /// public new static TableView DownCast(BaseHandle handle) { TableView ret = new TableView(NDalicPINVOKE.TableView_DownCast(BaseHandle.getCPtr(handle)), true); @@ -322,6 +376,9 @@ namespace Tizen.NUI return ret; } + /// + /// Adds a child to the table. + /// public bool AddChild(Actor child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_AddChild(swigCPtr, Actor.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -329,6 +386,9 @@ namespace Tizen.NUI return ret; } + /// + /// Returns a child from the given layout position. + /// public Actor GetChildAt(TableView.CellPosition position) { Actor ret = new Actor(NDalicPINVOKE.TableView_GetChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true); @@ -336,6 +396,9 @@ namespace Tizen.NUI return ret; } + /// + /// Removes a child from the given layout position. + /// public Actor RemoveChildAt(TableView.CellPosition position) { Actor ret = new Actor(NDalicPINVOKE.TableView_RemoveChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true); @@ -343,6 +406,9 @@ namespace Tizen.NUI return ret; } + /// + /// Finds the child's layout position. + /// public bool FindChildPosition(Actor child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_FindChildPosition(swigCPtr, Actor.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -350,12 +416,18 @@ namespace Tizen.NUI return ret; } + /// + /// Inserts a new row to given index. + /// public void InsertRow(uint rowIndex) { NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Deletes a row from the given index. + /// public void DeleteRow(uint rowIndex) { NDalicPINVOKE.TableView_DeleteRow__SWIG_0(swigCPtr, rowIndex); @@ -368,12 +440,18 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Inserts a new column to the given index. + /// public void InsertColumn(uint columnIndex) { NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Deletes a column from the given index. + /// public void DeleteColumn(uint columnIndex) { NDalicPINVOKE.TableView_DeleteColumn__SWIG_0(swigCPtr, columnIndex); @@ -386,6 +464,9 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Resizes the TableView. + /// public void Resize(uint rows, uint columns) { NDalicPINVOKE.TableView_Resize__SWIG_0(swigCPtr, rows, columns); @@ -398,12 +479,18 @@ namespace Tizen.NUI if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Sets horizontal and vertical padding between cells. + /// public void SetCellPadding(Size2D padding) { NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets the current padding as width and height. + /// public Vector2 GetCellPadding() { Vector2 ret = new Vector2(NDalicPINVOKE.TableView_GetCellPadding(swigCPtr), true); @@ -411,12 +498,18 @@ namespace Tizen.NUI return ret; } + /// + /// Specifies this row as fitting its height to its children. + /// public void SetFitHeight(uint rowIndex) { NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Checks if the row is a fit row. + /// public bool IsFitHeight(uint rowIndex) { bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex); @@ -424,12 +517,18 @@ namespace Tizen.NUI return ret; } + /// + /// Specifies this column as fitting its width to its children. + /// public void SetFitWidth(uint columnIndex) { NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Checks if the column is a fit column. + /// public bool IsFitWidth(uint columnIndex) { bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex); @@ -437,12 +536,18 @@ namespace Tizen.NUI return ret; } + /// + /// Sets a row to have fixed height. + /// public void SetFixedHeight(uint rowIndex, float height) { NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets a row's fixed height. + /// public float GetFixedHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex); @@ -450,12 +555,20 @@ namespace Tizen.NUI return ret; } + /// + /// Sets a row to have relative height. Relative height means percentage of + /// the remainder of the table height after subtracting Padding and Fixed height rows. + /// Setting a relative height of 0 has no effect. + /// public void SetRelativeHeight(uint rowIndex, float heightPercentage) { NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets a row's relative height. + /// public float GetRelativeHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex); @@ -463,12 +576,18 @@ namespace Tizen.NUI return ret; } + /// + /// Sets a column to have fixed width. + /// public void SetFixedWidth(uint columnIndex, float width) { NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets a column's fixed width. + /// public float GetFixedWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex); @@ -476,12 +595,20 @@ namespace Tizen.NUI return ret; } + /// + /// Sets a column to have relative width. Relative width means percentage of + /// the remainder of table width after subtracting Padding and Fixed width columns. + /// Setting a relative width of 0 has no effect. + /// public void SetRelativeWidth(uint columnIndex, float widthPercentage) { NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Gets a column's relative width. + /// public float GetRelativeWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex); @@ -489,6 +616,9 @@ namespace Tizen.NUI return ret; } + /// + /// Gets the amount of rows in the table. + /// public uint GetRows() { uint ret = NDalicPINVOKE.TableView_GetRows(swigCPtr); @@ -496,6 +626,9 @@ namespace Tizen.NUI return ret; } + /// + /// Gets the amount of columns in the table. + /// public uint GetColumns() { uint ret = NDalicPINVOKE.TableView_GetColumns(swigCPtr); @@ -503,6 +636,9 @@ namespace Tizen.NUI return ret; } + /// + /// Sets the alignment on a cell. + /// public void SetCellAlignment(TableView.CellPosition position, HorizontalAlignmentType horizontal, VerticalAlignmentType vertical) { NDalicPINVOKE.TableView_SetCellAlignment(swigCPtr, TableView.CellPosition.getCPtr(position), (int)horizontal, (int)vertical); @@ -517,6 +653,9 @@ namespace Tizen.NUI CHILD_PROPERTY_END_INDEX = PropertyRanges.CHILD_PROPERTY_REGISTRATION_START_INDEX + 1000 } + /// + /// Layout policy. + /// public enum LayoutPolicy { Fixed, @@ -525,6 +664,9 @@ namespace Tizen.NUI Fit } + /// + /// Rows property. + /// public int Rows { get @@ -538,6 +680,10 @@ namespace Tizen.NUI SetProperty(TableView.Property.ROWS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Columns property. + /// public int Columns { get @@ -551,6 +697,10 @@ namespace Tizen.NUI SetProperty(TableView.Property.COLUMNS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Cell padding property. + /// public Vector2 CellPadding { get @@ -564,6 +714,10 @@ namespace Tizen.NUI SetProperty(TableView.Property.CELL_PADDING, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Layout rows property. + /// public PropertyMap LayoutRows { get @@ -577,6 +731,10 @@ namespace Tizen.NUI SetProperty(TableView.Property.LAYOUT_ROWS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Layout columns property. + /// public PropertyMap LayoutColumns { get @@ -592,12 +750,20 @@ namespace Tizen.NUI } } + + /// + /// HorizontalAlignmentType. + /// public enum HorizontalAlignmentType { Left, Center, Right } + + /// + /// VerticalAlignmentType. + /// public enum VerticalAlignmentType { Top, diff --git a/src/Tizen.NUI/src/public/TapGesture.cs b/src/Tizen.NUI/src/public/TapGesture.cs index 00011cf..670918b 100755 --- a/src/Tizen.NUI/src/public/TapGesture.cs +++ b/src/Tizen.NUI/src/public/TapGesture.cs @@ -11,6 +11,9 @@ namespace Tizen.NUI { + /// + /// A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times. + /// public class TapGesture : Gesture { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -30,6 +33,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -55,6 +61,9 @@ namespace Tizen.NUI } + /// + /// Get TapGesture from Ptr. + /// public static TapGesture GetTapGestureFromPtr(global::System.IntPtr cPtr) { TapGesture ret = new TapGesture(cPtr, false); @@ -62,6 +71,9 @@ namespace Tizen.NUI return ret; } + /// + /// NumberOfTaps. + /// public uint NumberOfTaps { get @@ -70,6 +82,9 @@ namespace Tizen.NUI } } + /// + /// NumberOfTouches. + /// public uint NumberOfTouches { get @@ -78,6 +93,9 @@ namespace Tizen.NUI } } + /// + /// ScreenPoint. + /// public Vector2 ScreenPoint { get @@ -86,6 +104,9 @@ namespace Tizen.NUI } } + /// + /// LocalPoint. + /// public Vector2 LocalPoint { get @@ -94,16 +115,25 @@ namespace Tizen.NUI } } + /// + /// Default constructor. + /// public TapGesture() : this(NDalicPINVOKE.new_TapGesture__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Copy constructor. + /// public TapGesture(TapGesture rhs) : this(NDalicPINVOKE.new_TapGesture__SWIG_1(TapGesture.getCPtr(rhs)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Assignment. + /// public TapGesture Assign(TapGesture rhs) { TapGesture ret = new TapGesture(NDalicPINVOKE.TapGesture_Assign(swigCPtr, TapGesture.getCPtr(rhs)), false); diff --git a/src/Tizen.NUI/src/public/TextEditor.cs b/src/Tizen.NUI/src/public/TextEditor.cs index f4ff655..1d77139 100755 --- a/src/Tizen.NUI/src/public/TextEditor.cs +++ b/src/Tizen.NUI/src/public/TextEditor.cs @@ -30,7 +30,9 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; - + /// + /// A control which provides a multi-line editable text editor. + /// public class TextEditor : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -50,6 +52,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -76,17 +81,16 @@ namespace Tizen.NUI - /** - * @brief Event arguments that passed via TextChanged signal - * - */ + /// + /// Event arguments that passed via TextChanged signal. + /// public class TextChangedEventArgs : EventArgs { private TextEditor _textEditor; - /** - * @brief TextEditor - is the texteditor control which has the text contents changed. - * - */ + + /// + /// TextEditor - is the texteditor control which has the text contents changed. + /// public TextEditor TextEditor { get @@ -105,11 +109,10 @@ namespace Tizen.NUI private EventHandler _textEditorTextChangedEventHandler; private TextChangedCallbackDelegate _textEditorTextChangedCallbackDelegate; - /** - * @brief Event for TextChanged signal which can be used to subscribe/unsubscribe the event handler - * (in the type of TextChangedEventHandler-DaliEventHandler) - * provided by the user. TextChanged signal is emitted when the text changes. - */ + /// + /// Event for TextChanged signal which can be used to subscribe/unsubscribe the event handler + /// provided by the user. TextChanged signal is emitted when the text changes. + /// public event EventHandler TextChanged { add @@ -299,6 +302,9 @@ namespace Tizen.NUI } + /// + /// Creates an empty handle. + /// public TextEditor() : this(NDalicPINVOKE.TextEditor_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -316,6 +322,9 @@ namespace Tizen.NUI return ret; } + /// + /// Downcasts a handle to TextEditor. + /// public new static TextEditor DownCast(BaseHandle handle) { TextEditor ret = new TextEditor(NDalicPINVOKE.TextEditor_DownCast(BaseHandle.getCPtr(handle)), true); @@ -343,6 +352,9 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// Rendering backend property + /// public int RenderingBackend { get @@ -356,6 +368,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.RENDERING_BACKEND, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Text property. + /// public string Text { get @@ -369,6 +385,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.TEXT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Text color property. + /// public Vector4 TextColor { get @@ -382,6 +402,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Font family property. + /// public string FontFamily { get @@ -395,6 +419,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Font style property. + /// public PropertyMap FontStyle { get @@ -408,6 +436,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Point size property. + /// public float PointSize { get @@ -421,6 +453,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Horizontal alignment property. + /// public string HorizontalAlignment { get @@ -434,6 +470,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Scroll threshold property. + /// public float ScrollThreshold { get @@ -447,6 +487,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SCROLL_THRESHOLD, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Scroll speed property. + /// public float ScrollSpeed { get @@ -460,6 +504,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SCROLL_SPEED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Primary cursor color property. + /// public Vector4 PrimaryCursorColor { get @@ -473,6 +521,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.PRIMARY_CURSOR_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SecondaryCursorColor property. + /// public Vector4 SecondaryCursorColor { get @@ -486,6 +538,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SECONDARY_CURSOR_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableCursorBlink property. + /// public bool EnableCursorBlink { get @@ -499,6 +555,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.ENABLE_CURSOR_BLINK, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorBlinkInterval property. + /// public float CursorBlinkInterval { get @@ -512,6 +572,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.CURSOR_BLINK_INTERVAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorBlinkDuration property. + /// public float CursorBlinkDuration { get @@ -525,6 +589,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.CURSOR_BLINK_DURATION, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorWidth property. + /// public int CursorWidth { get @@ -538,6 +606,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.CURSOR_WIDTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// GrabHandleImage property. + /// public string GrabHandleImage { get @@ -551,6 +623,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.GRAB_HANDLE_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// GrabHandlePressedImage property. + /// public string GrabHandlePressedImage { get @@ -564,6 +640,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.GRAB_HANDLE_PRESSED_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleImageLeft property. + /// public PropertyMap SelectionHandleImageLeft { get @@ -577,6 +657,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleImageRight property. + /// public PropertyMap SelectionHandleImageRight { get @@ -590,6 +674,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandlePressedImageLeft property. + /// public PropertyMap SelectionHandlePressedImageLeft { get @@ -603,6 +691,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_PRESSED_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandlePressedImageRight property. + /// public PropertyMap SelectionHandlePressedImageRight { get @@ -616,6 +708,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleMarkerImageLeft property. + /// public PropertyMap SelectionHandleMarkerImageLeft { get @@ -629,6 +725,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_MARKER_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleMarkerImageRight property. + /// public PropertyMap SelectionHandleMarkerImageRight { get @@ -642,6 +742,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HANDLE_MARKER_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHighlightColor property. + /// public Vector4 SelectionHighlightColor { get @@ -655,6 +759,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SELECTION_HIGHLIGHT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// DecorationBoundingBox property. + /// public Rectangle DecorationBoundingBox { get @@ -668,6 +776,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.DECORATION_BOUNDING_BOX, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableMarkup property. + /// public bool EnableMarkup { get @@ -681,6 +793,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputColor property. + /// public Vector4 InputColor { get @@ -694,6 +810,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputFontFamily property. + /// public string InputFontFamily { get @@ -707,6 +827,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_FONT_FAMILY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputFontStyle property. + /// public PropertyMap InputFontStyle { get @@ -720,6 +844,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_FONT_STYLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputPointSize property. + /// public float InputPointSize { get @@ -733,6 +861,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_POINT_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// LineSpacing property. + /// public float LineSpacing { get @@ -746,6 +878,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputLineSpacing property. + /// public float InputLineSpacing { get @@ -759,6 +895,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_LINE_SPACING, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Underline property. + /// public PropertyMap Underline { get @@ -772,6 +912,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputUnderline property. + /// public PropertyMap InputUnderline { get @@ -785,6 +929,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_UNDERLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Shadow property. + /// public PropertyMap Shadow { get @@ -798,6 +946,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.SHADOW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputShadow property. + /// public PropertyMap InputShadow { get @@ -811,6 +963,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_SHADOW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Emboss property. + /// public PropertyMap Emboss { get @@ -824,6 +980,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.EMBOSS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputEmboss property. + /// public PropertyMap InputEmboss { get @@ -837,6 +997,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.INPUT_EMBOSS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Outline property. + /// public PropertyMap Outline { get @@ -850,6 +1014,10 @@ namespace Tizen.NUI SetProperty(TextEditor.Property.OUTLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputOutline property. + /// public PropertyMap InputOutline { get diff --git a/src/Tizen.NUI/src/public/TextField.cs b/src/Tizen.NUI/src/public/TextField.cs index e0a75bb..a8d3a15 100755 --- a/src/Tizen.NUI/src/public/TextField.cs +++ b/src/Tizen.NUI/src/public/TextField.cs @@ -30,7 +30,9 @@ namespace Tizen.NUI using System; using System.Runtime.InteropServices; - + /// + /// A control which provides a single-line editable text field. + /// public class TextField : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -50,6 +52,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -74,12 +79,16 @@ namespace Tizen.NUI } } - - + /// + /// Text changed event arguments. + /// public class TextChangedEventArgs : EventArgs { private TextField _textField; + /// + /// TextField. + /// public TextField TextField { get @@ -93,10 +102,16 @@ namespace Tizen.NUI } } + /// + /// MaxLengthReached event arguments. + /// public class MaxLengthReachedEventArgs : EventArgs { private TextField _textField; + /// + /// TextField. + /// public TextField TextField { get @@ -121,6 +136,9 @@ namespace Tizen.NUI private EventHandler _textFieldMaxLengthReachedEventHandler; private MaxLengthReachedCallbackDelegate _textFieldMaxLengthReachedCallbackDelegate; + /// + /// TextChanged event. + /// public event EventHandler TextChanged { add @@ -157,6 +175,9 @@ namespace Tizen.NUI } + /// + /// MaxLengthReached event. + /// public event EventHandler MaxLengthReached { add @@ -352,6 +373,9 @@ namespace Tizen.NUI } + /// + /// Creates an empty handle. + /// public TextField() : this(NDalicPINVOKE.TextField_New(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -369,6 +393,9 @@ namespace Tizen.NUI return ret; } + /// + /// Downcasts a handle to TextField. + /// public new static TextField DownCast(BaseHandle handle) { TextField ret = new TextField(NDalicPINVOKE.TextField_DownCast(BaseHandle.getCPtr(handle)), true); @@ -409,6 +436,9 @@ namespace Tizen.NUI ExceedPolicyClip } + /// + /// RenderingBackend property. + /// public int RenderingBackend { get @@ -422,6 +452,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.RENDERING_BACKEND, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Text property. + /// public string Text { get @@ -435,6 +469,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.TEXT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PlaceholderText property. + /// public string PlaceholderText { get @@ -448,6 +486,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.PLACEHOLDER_TEXT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PlaceholderTextFocused property. + /// public string PlaceholderTextFocused { get @@ -461,6 +503,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.PLACEHOLDER_TEXT_FOCUSED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// FontFamily property. + /// public string FontFamily { get @@ -474,6 +520,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// FontStyle property. + /// public PropertyMap FontStyle { get @@ -487,6 +537,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PointSize property. + /// public float PointSize { get @@ -500,6 +554,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// MaxLength property. + /// public int MaxLength { get @@ -513,6 +571,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.MAX_LENGTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ExceedPolicy property. + /// public int ExceedPolicy { get @@ -526,6 +588,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.EXCEED_POLICY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// HorizontalAlignment property. + /// public string HorizontalAlignment { get @@ -539,6 +605,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// VerticalAlignment property. + /// public string VerticalAlignment { get @@ -552,6 +622,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// TextColor property. + /// public Color TextColor { get @@ -565,6 +639,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PlaceholderTextColor property. + /// public Vector4 PlaceholderTextColor { get @@ -578,6 +656,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.PLACEHOLDER_TEXT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ShadowOffset property. + /// public Vector2 ShadowOffset { get @@ -591,6 +673,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ShadowColor property. + /// public Vector4 ShadowColor { get @@ -604,6 +690,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PrimaryCursorColor property. + /// public Vector4 PrimaryCursorColor { get @@ -617,6 +707,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.PRIMARY_CURSOR_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SecondaryCursorColor property. + /// public Vector4 SecondaryCursorColor { get @@ -630,6 +724,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SECONDARY_CURSOR_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableCursorBlink property. + /// public bool EnableCursorBlink { get @@ -643,6 +741,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.ENABLE_CURSOR_BLINK, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorBlinkInterval property. + /// public float CursorBlinkInterval { get @@ -656,6 +758,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.CURSOR_BLINK_INTERVAL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorBlinkDuration property. + /// public float CursorBlinkDuration { get @@ -669,6 +775,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.CURSOR_BLINK_DURATION, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// CursorWidth property. + /// public int CursorWidth { get @@ -682,6 +792,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.CURSOR_WIDTH, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// GrabHandleImage property. + /// public string GrabHandleImage { get @@ -695,6 +809,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.GRAB_HANDLE_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// GrabHandlePressedImage property. + /// public string GrabHandlePressedImage { get @@ -708,6 +826,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.GRAB_HANDLE_PRESSED_IMAGE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ScrollThreshold property. + /// public float ScrollThreshold { get @@ -721,6 +843,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SCROLL_THRESHOLD, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ScrollSpeed property. + /// public float ScrollSpeed { get @@ -734,6 +860,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SCROLL_SPEED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleImageLeft property. + /// public PropertyMap SelectionHandleImageLeft { get @@ -747,6 +877,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleImageRight property. + /// public PropertyMap SelectionHandleImageRight { get @@ -760,6 +894,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandlePressedImageLeft property. + /// public PropertyMap SelectionHandlePressedImageLeft { get @@ -773,6 +911,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_PRESSED_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandlePressedImageRight property. + /// public PropertyMap SelectionHandlePressedImageRight { get @@ -786,6 +928,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleMarkerImageLeft property. + /// public PropertyMap SelectionHandleMarkerImageLeft { get @@ -799,6 +945,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_MARKER_IMAGE_LEFT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHandleMarkerImageRight property. + /// public PropertyMap SelectionHandleMarkerImageRight { get @@ -812,6 +962,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HANDLE_MARKER_IMAGE_RIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// SelectionHighlightColor property. + /// public Vector4 SelectionHighlightColor { get @@ -825,6 +979,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SELECTION_HIGHLIGHT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// DecorationBoundingBox property. + /// public Rectangle DecorationBoundingBox { get @@ -838,6 +996,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.DECORATION_BOUNDING_BOX, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputMethodSettings property. + /// public PropertyMap InputMethodSettings { get @@ -851,6 +1013,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_METHOD_SETTINGS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputColor property. + /// public Vector4 InputColor { get @@ -864,6 +1030,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableMarkup property. + /// public bool EnableMarkup { get @@ -877,6 +1047,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputFontFamily property. + /// public string InputFontFamily { get @@ -890,6 +1064,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_FONT_FAMILY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputFontStyle property. + /// public PropertyMap InputFontStyle { get @@ -903,6 +1081,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_FONT_STYLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputPointSize property. + /// public float InputPointSize { get @@ -916,6 +1098,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_POINT_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Underline property. + /// public PropertyMap Underline { get @@ -929,6 +1115,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputUnderline property. + /// public PropertyMap InputUnderline { get @@ -942,6 +1132,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_UNDERLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Shadow property. + /// public PropertyMap Shadow { get @@ -955,6 +1149,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.SHADOW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputShadow property. + /// public PropertyMap InputShadow { get @@ -968,6 +1166,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_SHADOW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Emboss property. + /// public PropertyMap Emboss { get @@ -981,6 +1183,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.EMBOSS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputEmboss property. + /// public PropertyMap InputEmboss { get @@ -994,6 +1200,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.INPUT_EMBOSS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Outline property. + /// public PropertyMap Outline { get @@ -1007,6 +1217,10 @@ namespace Tizen.NUI SetProperty(TextField.Property.OUTLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// InputOutline property. + /// public PropertyMap InputOutline { get -- 2.7.4