From ac42c7be22937b1ce9bc13326b1f376e36a5b762 Mon Sep 17 00:00:00 2001 From: "taeyoon0.lee" Date: Fri, 17 Mar 2017 16:28:51 +0900 Subject: [PATCH] Added/Modified comments for API reference of part4 Change-Id: Ice8e0cb4680a8d4c0397fbe0de28b64e960e764a --- src/Tizen.NUI/src/public/Size.cs | 49 ++++++++++- src/Tizen.NUI/src/public/Size2D.cs | 46 ++++++++++- src/Tizen.NUI/src/public/Slider.cs | 37 ++++++++- src/Tizen.NUI/src/public/Stage.cs | 34 +++++--- src/Tizen.NUI/src/public/StyleManager.cs | 10 +++ src/Tizen.NUI/src/public/TableView.cs | 115 ++++++++++++++++++++------ src/Tizen.NUI/src/public/TapGesture.cs | 19 +++-- src/Tizen.NUI/src/public/TextEditor.cs | 4 +- src/Tizen.NUI/src/public/TextField.cs | 4 +- src/Tizen.NUI/src/public/TextLabel.cs | 138 +++++++++++++++++++++++++++++++ 10 files changed, 400 insertions(+), 56 deletions(-) diff --git a/src/Tizen.NUI/src/public/Size.cs b/src/Tizen.NUI/src/public/Size.cs index 2d0ea5c..68a217e 100755 --- a/src/Tizen.NUI/src/public/Size.cs +++ b/src/Tizen.NUI/src/public/Size.cs @@ -43,6 +43,7 @@ namespace Tizen.NUI } /// + /// Dispose /// public virtual void Dispose() { @@ -67,26 +68,33 @@ namespace Tizen.NUI } } - /// - /// Addition operator. + /// Addition operator for A+B /// + /// Size, A + /// Size to assign, B + /// A Size containing the result of the addition public static Size operator +(Size arg1, Size arg2) { return arg1.Add(arg2); } /// - /// Subtraction operator. + /// Subtraction operator for A-B /// + /// Size, A + /// Size to subtract, B + /// A Size containing the result of the subtraction public static Size operator -(Size arg1, Size arg2) { return arg1.Subtract(arg2); } /// - /// + /// Unary negation operator. /// + /// Size for unary negation + /// A Size containg the negation public static Size operator -(Size arg1) { return arg1.Subtract(); @@ -95,6 +103,9 @@ namespace Tizen.NUI /// /// Multiplication operator. /// + /// Size for multiplication + /// The Size to multipl + /// A Size containing the result of the multiplication public static Size operator *(Size arg1, Size arg2) { return arg1.Multiply(arg2); @@ -103,6 +114,9 @@ namespace Tizen.NUI /// /// Multiplication operator. /// + /// Size for multiplication + /// The float value to scale the Size + /// A Size containing the result of the scaling public static Size operator *(Size arg1, float arg2) { return arg1.Multiply(arg2); @@ -111,6 +125,9 @@ namespace Tizen.NUI /// /// Division operator. /// + /// Size for division + /// The Size to divide + /// A Size containing the result of the division> public static Size operator /(Size arg1, Size arg2) { return arg1.Divide(arg2); @@ -119,6 +136,9 @@ namespace Tizen.NUI /// /// Division operator. /// + /// Size for division + /// The float value to scale the Size by + /// A Size containing the result of the scaling public static Size operator /(Size arg1, float arg2) { return arg1.Divide(arg2); @@ -127,6 +147,8 @@ namespace Tizen.NUI /// /// Array subscript operator. /// + /// Subscript index + /// The float at the given index public float this[uint index] { get @@ -136,7 +158,10 @@ namespace Tizen.NUI } /// + /// Get Size from pointer. /// + /// Pointer of the Size + /// Size public static Size GetSizeFromPtr(global::System.IntPtr cPtr) { Size ret = new Size(cPtr, false); @@ -155,6 +180,9 @@ namespace Tizen.NUI /// /// Constructor. /// + /// x (or width) component + /// y (or height) component + /// z (or depth) component 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(); @@ -163,12 +191,14 @@ namespace Tizen.NUI /// /// Constructor. /// + /// Size2D with x (width) and y (height) public Size(Size2D size2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Size2D.getCPtr(size2d)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// + /// Zero constant, (0.0f, 0.0f, 0.0f). /// public static Size Zero { @@ -241,6 +271,8 @@ namespace Tizen.NUI /// Check equality. /// Utilizes appropriate machine epsilon values. /// + /// The Size to test against + /// True if the Sizes are equal public bool EqualTo(Size rhs) { bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Size.getCPtr(rhs)); @@ -252,6 +284,8 @@ namespace Tizen.NUI /// Check inequality. /// Utilizes appropriate machine epsilon values. /// + /// The Size to test against + /// True if the Sizes are not equal public bool NotEqualTo(Size rhs) { bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Size.getCPtr(rhs)); @@ -260,6 +294,7 @@ namespace Tizen.NUI } /// + /// Width property for width component of Siz /// public float Width { @@ -277,6 +312,7 @@ namespace Tizen.NUI } /// + /// Height property for height component of Size /// public float Height { @@ -294,6 +330,7 @@ namespace Tizen.NUI } /// + /// Depth property for depth component of Size /// public float Depth { @@ -311,14 +348,18 @@ namespace Tizen.NUI } /// + /// Type cast operator, Size to Vector3. /// + /// Object of Size type public static implicit operator Vector3(Size size) { return new Vector3(size.Width, size.Height, size.Depth); } /// + /// Type cast operator, Vector3 to Size type. /// + /// Object of Vector3 type 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 2dedff9..d93f352 100755 --- a/src/Tizen.NUI/src/public/Size2D.cs +++ b/src/Tizen.NUI/src/public/Size2D.cs @@ -43,6 +43,7 @@ namespace Tizen.NUI } /// + /// Dispose /// public virtual void Dispose() { @@ -68,23 +69,32 @@ namespace Tizen.NUI } /// - /// Addition operator. + /// Addition operator for A+B /// + /// Size, A + /// Size to assign, B + /// A Size containing the result of the addition public static Size2D operator +(Size2D arg1, Size2D arg2) { return arg1.Add(arg2); } /// - /// Subtraction operator. + /// Subtraction operator for A-B /// + /// Size, A + /// Size to subtract, B + /// A Size containing the result of the subtraction public static Size2D operator -(Size2D arg1, Size2D arg2) { return arg1.Subtract(arg2); } /// + /// Unary negation operator. /// + /// Size for unary negation + /// A Size containg the negation public static Size2D operator -(Size2D arg1) { return arg1.Subtract(); @@ -93,6 +103,9 @@ namespace Tizen.NUI /// /// Multiplication operator. /// + /// Size for multiplication + /// The Size to multipl + /// A Size containing the result of the multiplication public static Size2D operator *(Size2D arg1, Size2D arg2) { return arg1.Multiply(arg2); @@ -101,6 +114,10 @@ namespace Tizen.NUI /// /// Multiplication operator. /// + /// Size for multiplication + /// The int value to scale the Size + /// A Size containing the result of the scaling + public static Size2D operator *(Size2D arg1, int arg2) { return arg1.Multiply(arg2); @@ -109,6 +126,9 @@ namespace Tizen.NUI /// /// Division operator. /// + /// Size for division + /// The Size to divide + /// A Size containing the result of the division> public static Size2D operator /(Size2D arg1, Size2D arg2) { return arg1.Divide(arg2); @@ -117,6 +137,9 @@ namespace Tizen.NUI /// /// Division operator. /// + /// Size for division + /// The int value to scale the Size by + /// A Size containing the result of the scaling public static Size2D operator /(Size2D arg1, int arg2) { return arg1.Divide(arg2); @@ -125,6 +148,8 @@ namespace Tizen.NUI /// /// Array subscript operator. /// + /// Subscript index + /// The float at the given index public float this[uint index] { get @@ -134,6 +159,10 @@ namespace Tizen.NUI } /// + /// Get Size from pointer. + /// + /// Pointer of the Size + /// Size public static Size2D GetSize2DFromPtr(global::System.IntPtr cPtr) { Size2D ret = new Size2D(cPtr, false); @@ -152,6 +181,8 @@ namespace Tizen.NUI /// /// Constructor. /// + /// x (or width) component + /// y (or height) component 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(); @@ -160,6 +191,7 @@ namespace Tizen.NUI /// /// Constructor. /// + /// Size with x (width), y (height), and z (depth) public Size2D(Size size) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Size.getCPtr(size)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -220,6 +252,8 @@ namespace Tizen.NUI /// Check equality. /// Utilizes appropriate machine epsilon values. /// + /// The Size to test against + /// True if the Sizes are equal public bool EqualTo(Size2D rhs) { bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, Size2D.getCPtr(rhs)); @@ -231,6 +265,8 @@ namespace Tizen.NUI /// Check inequality. /// Utilizes appropriate machine epsilon values. /// + /// The Size to test against + /// True if the Sizes are not equal public bool NotEqualTo(Size2D rhs) { bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, Size2D.getCPtr(rhs)); @@ -246,6 +282,7 @@ namespace Tizen.NUI } /// + /// Property for width component of Size /// public int Width { @@ -263,6 +300,7 @@ namespace Tizen.NUI } /// + /// Property for height component of Size /// public int Height { @@ -280,14 +318,18 @@ namespace Tizen.NUI } /// + /// Type cast operator, Size2D to Vector2. /// + /// Object of Size2D type public static implicit operator Vector2(Size2D size) { return new Vector2((float)size.Width, (float)size.Height); } /// + /// Type cast operator, Vector2 to Size2D type. /// + /// Object of Vector2 type 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 356a01a..5a9d145 100755 --- a/src/Tizen.NUI/src/public/Slider.cs +++ b/src/Tizen.NUI/src/public/Slider.cs @@ -52,6 +52,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -79,13 +82,16 @@ namespace Tizen.NUI /// - /// Emitted when the slider value changes. + /// Value changed event arguments. /// public class ValueChangedEventArgs : EventArgs { private Slider _slider; private float _slideValue; + /// + /// Slider. + /// public Slider Slider { get @@ -98,6 +104,9 @@ namespace Tizen.NUI } } + /// + /// Slider value. + /// public float SlideValue { get @@ -112,13 +121,16 @@ namespace Tizen.NUI } /// - /// Emitted when the sliding is finished. + /// Sliding finished event arguments. /// public class SlidingFinishedEventArgs : EventArgs { private Slider _slider; private float _slideValue; + /// + /// Slider. + /// public Slider Slider { get @@ -131,6 +143,9 @@ namespace Tizen.NUI } } + /// + /// Slider value. + /// public float SlideValue { get @@ -145,13 +160,16 @@ namespace Tizen.NUI } /// - /// Emitted when the slider handle reaches a mark. + /// Mark reached event arguments. /// public class MarkReachedEventArgs : EventArgs { private Slider _slider; private int _slideValue; + /// + /// Slider. + /// public Slider Slider { get @@ -164,6 +182,9 @@ namespace Tizen.NUI } } + /// + /// Slider value. + /// public int SlideValue { get @@ -194,6 +215,7 @@ namespace Tizen.NUI private MarkReachedCallbackDelegate _sliderMarkReachedCallbackDelegate; /// + /// Event emitted when the slider value changes. /// public event EventHandlerWithReturnType ValueChanged { @@ -234,6 +256,7 @@ namespace Tizen.NUI } /// + /// Event emitted when the sliding is finished. /// public event EventHandlerWithReturnType SlidingFinished { @@ -274,6 +297,7 @@ namespace Tizen.NUI } /// + /// Event emitted when the slider handle reaches a mark. /// public event EventHandlerWithReturnType MarkReached { @@ -314,7 +338,10 @@ namespace Tizen.NUI } /// + /// Get Slider from the pointer. /// + /// The pointer of Slider + /// Object of Slider type public static Slider GetSliderFromPtr(global::System.IntPtr cPtr) { Slider ret = new Slider(cPtr, false); @@ -384,7 +411,7 @@ namespace Tizen.NUI } /// - /// Creates an empty Slider handle. + /// Creates the Slider control. /// public Slider() : this(NDalicPINVOKE.Slider_New(), true) { @@ -408,6 +435,8 @@ namespace Tizen.NUI /// If handle points to a Slider, the downcast produces valid handle. /// If not, the returned handle is left uninitialized. /// + /// Handle to an object + /// Handle to a Slider or an uninitialized handle public new static Slider DownCast(BaseHandle handle) { Slider ret = new Slider(NDalicPINVOKE.Slider_DownCast(BaseHandle.getCPtr(handle)), true); diff --git a/src/Tizen.NUI/src/public/Stage.cs b/src/Tizen.NUI/src/public/Stage.cs index b0d5320..727c724 100755 --- a/src/Tizen.NUI/src/public/Stage.cs +++ b/src/Tizen.NUI/src/public/Stage.cs @@ -43,6 +43,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose. + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -68,14 +71,14 @@ namespace Tizen.NUI } /// - /// Touch event argument + /// Touch event argument. /// public class TouchEventArgs : EventArgs { private Touch _touch; /// - /// Touch + /// Touch. /// public Touch Touch { @@ -136,14 +139,14 @@ namespace Tizen.NUI } /// - /// Wheel event arguments + /// Wheel event arguments. /// public class WheelEventArgs : EventArgs { private Wheel _wheel; /// - /// Wheel + /// Wheel. /// public Wheel Wheel { @@ -162,7 +165,7 @@ namespace Tizen.NUI private EventCallbackDelegateType1 _stageWheelCallbackDelegate; /// - /// This is emitted when wheel event is received. + /// Event emitted when wheel event is received. /// public event EventHandler Wheel { @@ -227,7 +230,7 @@ namespace Tizen.NUI private EventCallbackDelegateType1 _stageKeyCallbackDelegate; /// - /// This is emitted when key event is received. + /// Event emitted when key event is received. /// public event EventHandler Key { @@ -405,7 +408,7 @@ namespace Tizen.NUI } /// - /// Size. + /// Stage size property (read-only). /// public Size2D Size { @@ -417,7 +420,7 @@ namespace Tizen.NUI } /// - /// Background color. + /// Background color property. /// public Color BackgroundColor { @@ -433,7 +436,8 @@ namespace Tizen.NUI } /// - /// Dpi. + /// Dpi property (read-only). + /// Retrieves the DPI of the display device to which the stage is connected. /// public Vector2 Dpi { @@ -444,7 +448,8 @@ namespace Tizen.NUI } /// - /// Layer count. + /// Layer count property (read-only). + /// Queries the number of on-stage layers. /// public uint LayerCount { @@ -457,7 +462,8 @@ namespace Tizen.NUI private static readonly Stage instance = Stage.GetCurrent(); /// - /// Stage instance. + /// Stage instance property (read-only). + /// Gets the current Stage. /// public static Stage Instance { @@ -470,6 +476,7 @@ namespace Tizen.NUI /// /// Get default ( root ) layer. /// + /// The root layer public Layer GetDefaultLayer() { return this.GetRootLayer(); @@ -478,6 +485,7 @@ namespace Tizen.NUI /// /// Add layer to the Stage. /// + /// Layer to add public void AddLayer(Layer layer) { this.Add((Actor)layer); @@ -486,6 +494,7 @@ namespace Tizen.NUI /// /// Remove layer from the Stage. /// + /// Layer to remove public void RemoveLayer(Layer layer) { this.Remove((Actor)layer); @@ -580,6 +589,8 @@ namespace Tizen.NUI /// /// Retrieves the layer at a specified depth. /// + /// The depth + /// The layer found at the given depth public Layer GetLayer(uint depth) { Layer ret = new Layer(NDalicPINVOKE.Stage_GetLayer(swigCPtr, depth), true); @@ -624,6 +635,7 @@ namespace Tizen.NUI /// /// Keep rendering for at least the given amount of time. /// + /// Time to keep rendering, 0 means render at least one more frame 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 c75cf18..17ac80e 100755 --- a/src/Tizen.NUI/src/public/StyleManager.cs +++ b/src/Tizen.NUI/src/public/StyleManager.cs @@ -181,6 +181,7 @@ namespace Tizen.NUI /// /// Gets the singleton of StyleManager object. /// + /// A handle to the StyleManager control public static StyleManager Get() { StyleManager ret = new StyleManager(NDalicPINVOKE.StyleManager_Get(), true); @@ -195,6 +196,7 @@ namespace Tizen.NUI /// application uses, then the default Toolkit theme will be used /// instead for those controls. /// + /// A relative path is specified for style theme public void ApplyTheme(string themeFile) { NDalicPINVOKE.StyleManager_ApplyTheme(swigCPtr, themeFile); @@ -213,6 +215,8 @@ namespace Tizen.NUI /// /// Sets a constant for use when building styles. /// + /// The key of the constant + /// The value of the constant public void SetStyleConstant(string key, PropertyValue value) { NDalicPINVOKE.StyleManager_SetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(value)); @@ -222,6 +226,9 @@ namespace Tizen.NUI /// /// Returns the style constant set for a specific key. /// + /// The key of the constant + /// The value of the constant if it exists + /// public bool GetStyleConstant(string key, PropertyValue valueOut) { bool ret = NDalicPINVOKE.StyleManager_GetStyleConstant(swigCPtr, key, PropertyValue.getCPtr(valueOut)); @@ -232,6 +239,9 @@ namespace Tizen.NUI /// /// Applies the specified style to the control. /// + /// The control to which to apply the style + /// The name of the JSON style file to apply + /// The name of the style within the JSON file to apply public void ApplyStyle(View control, string jsonFileName, string styleName) { NDalicPINVOKE.StyleManager_ApplyStyle(swigCPtr, View.getCPtr(control), jsonFileName, styleName); diff --git a/src/Tizen.NUI/src/public/TableView.cs b/src/Tizen.NUI/src/public/TableView.cs index 3774169..a82bb9e 100755 --- a/src/Tizen.NUI/src/public/TableView.cs +++ b/src/Tizen.NUI/src/public/TableView.cs @@ -26,6 +26,7 @@ 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. @@ -51,9 +52,6 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } - /// - /// Dispose. - /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -182,7 +180,7 @@ namespace Tizen.NUI } /// - /// Class to specify layout position for child actor. + /// Class to specify layout position for child view. /// public class CellPosition : global::System.IDisposable { @@ -205,9 +203,6 @@ namespace Tizen.NUI Dispose(); } - /// - /// Dispose - /// public virtual void Dispose() { lock (this) @@ -228,37 +223,47 @@ namespace Tizen.NUI /// /// Constructor. /// + /// The row index initialized + /// The column index initialized + /// The row span initialized + /// The column span initialized 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. + /// Constructor to initialise values to defaults for convenience. /// + /// The row index initialized + /// The column index initialized + /// The row span initialized 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. + /// Constructor to initialise values to defaults for convenience. /// + /// The row index initialized + /// The column index initialized 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. + /// Constructor to initialise values to defaults for convenience. /// + /// The row index initialized 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. + /// Default constructor /// public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true) { @@ -266,7 +271,7 @@ namespace Tizen.NUI } /// - /// Row index. + /// Index of row /// public uint rowIndex { @@ -284,7 +289,7 @@ namespace Tizen.NUI } /// - /// Column index. + /// Index of column /// public uint columnIndex { @@ -302,7 +307,7 @@ namespace Tizen.NUI } /// - /// Row span. + /// Span of row /// public uint rowSpan { @@ -320,7 +325,7 @@ namespace Tizen.NUI } /// - /// Column span. + /// Span of column /// public uint columnSpan { @@ -340,8 +345,10 @@ namespace Tizen.NUI } /// - /// Creates the TableView control. + /// Creates the TableView view. /// + /// initialRows for the table + /// initialColumns for the table public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -351,6 +358,7 @@ namespace Tizen.NUI /// /// Copy constructor. Creates another handle that points to the same real object. /// + /// Handle to copy from public TableView(TableView handle) : this(NDalicPINVOKE.new_TableView__SWIG_1(TableView.getCPtr(handle)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -359,6 +367,8 @@ namespace Tizen.NUI /// /// Changes this handle to point to another real object. /// + /// Handle to an object + /// A reference to this public TableView Assign(TableView handle) { TableView ret = new TableView(NDalicPINVOKE.TableView_Assign(swigCPtr, TableView.getCPtr(handle)), false); @@ -368,7 +378,11 @@ namespace Tizen.NUI /// /// Downcasts a handle to TableView handle. + /// If handle points to a TableView, the downcast produces valid handle. + /// If not, the returned handle is left uninitialized. /// + /// Handle to an object + /// Handle to a TableView or an uninitialized handle public new static TableView DownCast(BaseHandle handle) { TableView ret = new TableView(NDalicPINVOKE.TableView_DownCast(BaseHandle.getCPtr(handle)), true); @@ -378,7 +392,11 @@ namespace Tizen.NUI /// /// Adds a child to the table. + /// If the row or column index is outside the table, the table gets resized bigger. /// + /// The child to add + /// The position for the child + /// Tue if the addition succeeded and false if the cell is already occupied public bool AddChild(Actor child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_AddChild(swigCPtr, Actor.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -389,6 +407,8 @@ namespace Tizen.NUI /// /// Returns a child from the given layout position. /// + /// The position in the table + /// Child that was in the cell or an uninitialized handle public Actor GetChildAt(TableView.CellPosition position) { Actor ret = new Actor(NDalicPINVOKE.TableView_GetChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true); @@ -399,6 +419,8 @@ namespace Tizen.NUI /// /// Removes a child from the given layout position. /// + /// The position for the child to remove + /// Child that was removed or an uninitialized handle public Actor RemoveChildAt(TableView.CellPosition position) { Actor ret = new Actor(NDalicPINVOKE.TableView_RemoveChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true); @@ -409,6 +431,9 @@ namespace Tizen.NUI /// /// Finds the child's layout position. /// + /// The child to search for + /// The position for the child + /// true if the child was included in this TableView public bool FindChildPosition(Actor child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_FindChildPosition(swigCPtr, Actor.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -419,6 +444,7 @@ namespace Tizen.NUI /// /// Inserts a new row to given index. /// + /// The rowIndex of the new row public void InsertRow(uint rowIndex) { NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex); @@ -427,7 +453,9 @@ namespace Tizen.NUI /// /// Deletes a row from the given index. + /// Removed elements are deleted. /// + /// The rowIndex of the row to delete public void DeleteRow(uint rowIndex) { NDalicPINVOKE.TableView_DeleteRow__SWIG_0(swigCPtr, rowIndex); @@ -443,6 +471,7 @@ namespace Tizen.NUI /// /// Inserts a new column to the given index. /// + /// The columnIndex of the new column public void InsertColumn(uint columnIndex) { NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex); @@ -451,7 +480,9 @@ namespace Tizen.NUI /// /// Deletes a column from the given index. + /// Removed elements are deleted. /// + /// The columnIndex of the column to delete public void DeleteColumn(uint columnIndex) { NDalicPINVOKE.TableView_DeleteColumn__SWIG_0(swigCPtr, columnIndex); @@ -467,6 +498,8 @@ namespace Tizen.NUI /// /// Resizes the TableView. /// + /// The rows for the table + /// The columns for the table public void Resize(uint rows, uint columns) { NDalicPINVOKE.TableView_Resize__SWIG_0(swigCPtr, rows, columns); @@ -482,6 +515,7 @@ namespace Tizen.NUI /// /// Sets horizontal and vertical padding between cells. /// + /// Width and height public void SetCellPadding(Size2D padding) { NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding)); @@ -491,6 +525,7 @@ namespace Tizen.NUI /// /// Gets the current padding as width and height. /// + /// The current padding as width and height public Vector2 GetCellPadding() { Vector2 ret = new Vector2(NDalicPINVOKE.TableView_GetCellPadding(swigCPtr), true); @@ -501,6 +536,7 @@ namespace Tizen.NUI /// /// Specifies this row as fitting its height to its children. /// + /// The row to set public void SetFitHeight(uint rowIndex) { NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex); @@ -510,6 +546,8 @@ namespace Tizen.NUI /// /// Checks if the row is a fit row. /// + /// The row to check + /// true if the row is fit public bool IsFitHeight(uint rowIndex) { bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex); @@ -520,6 +558,7 @@ namespace Tizen.NUI /// /// Specifies this column as fitting its width to its children. /// + /// The column to set public void SetFitWidth(uint columnIndex) { NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex); @@ -529,6 +568,8 @@ namespace Tizen.NUI /// /// Checks if the column is a fit column. /// + /// The column to check + /// true if the column is fit public bool IsFitWidth(uint columnIndex) { bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex); @@ -538,7 +579,10 @@ namespace Tizen.NUI /// /// Sets a row to have fixed height. + /// Setting a fixed height of 0 has no effect. /// + /// The rowIndex for row with fixed height + /// The height in world coordinate units public void SetFixedHeight(uint rowIndex, float height) { NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height); @@ -548,6 +592,8 @@ namespace Tizen.NUI /// /// Gets a row's fixed height. /// + /// The row index with fixed height + /// height The height in world coordinate units public float GetFixedHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex); @@ -560,6 +606,8 @@ namespace Tizen.NUI /// the remainder of the table height after subtracting Padding and Fixed height rows. /// Setting a relative height of 0 has no effect. /// + /// The rowIndex for row with relative height + /// The height percentage between 0.0f and 1.0f public void SetRelativeHeight(uint rowIndex, float heightPercentage) { NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage); @@ -569,6 +617,8 @@ namespace Tizen.NUI /// /// Gets a row's relative height. /// + /// The row index with relative height + /// Height in percentage units, between 0.0f and 1.0f public float GetRelativeHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex); @@ -578,7 +628,10 @@ namespace Tizen.NUI /// /// Sets a column to have fixed width. + /// Setting a fixed width of 0 has no effect. /// + /// The columnIndex for column with fixed width + /// The width in world coordinate units public void SetFixedWidth(uint columnIndex, float width) { NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width); @@ -588,6 +641,8 @@ namespace Tizen.NUI /// /// Gets a column's fixed width. /// + /// The column index with fixed width + /// Width in world coordinate units public float GetFixedWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex); @@ -600,6 +655,8 @@ namespace Tizen.NUI /// the remainder of table width after subtracting Padding and Fixed width columns. /// Setting a relative width of 0 has no effect. /// + /// The columnIndex for column with fixed width + /// The widthPercentage between 0.0f and 1.0f public void SetRelativeWidth(uint columnIndex, float widthPercentage) { NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage); @@ -609,6 +666,8 @@ namespace Tizen.NUI /// /// Gets a column's relative width. /// + /// The column index with relative width + /// Width in percentage units, between 0.0f and 1.0f public float GetRelativeWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex); @@ -619,6 +678,7 @@ namespace Tizen.NUI /// /// Gets the amount of rows in the table. /// + /// The amount of rows in the table public uint GetRows() { uint ret = NDalicPINVOKE.TableView_GetRows(swigCPtr); @@ -629,6 +689,7 @@ namespace Tizen.NUI /// /// Gets the amount of columns in the table. /// + /// The amount of columns in the table public uint GetColumns() { uint ret = NDalicPINVOKE.TableView_GetColumns(swigCPtr); @@ -638,7 +699,11 @@ namespace Tizen.NUI /// /// Sets the alignment on a cell. + /// Cells without calling this function have the default values of LEFT and TOP respectively. /// + /// The cell to set alignment on + /// The horizontal alignment + /// The vertical alignment public void SetCellAlignment(TableView.CellPosition position, HorizontalAlignmentType horizontal, VerticalAlignmentType vertical) { NDalicPINVOKE.TableView_SetCellAlignment(swigCPtr, TableView.CellPosition.getCPtr(position), (int)horizontal, (int)vertical); @@ -654,7 +719,7 @@ namespace Tizen.NUI } /// - /// Layout policy. + /// Enumeration for describing how the size of a row / column has been set. /// public enum LayoutPolicy { @@ -665,7 +730,7 @@ namespace Tizen.NUI } /// - /// Rows property. + /// the amount of rows in the table. /// public int Rows { @@ -680,9 +745,8 @@ namespace Tizen.NUI SetProperty(TableView.Property.ROWS, new Tizen.NUI.PropertyValue(value)); } } - /// - /// Columns property. + /// the amount of columns in the table. /// public int Columns { @@ -697,9 +761,8 @@ namespace Tizen.NUI SetProperty(TableView.Property.COLUMNS, new Tizen.NUI.PropertyValue(value)); } } - /// - /// Cell padding property. + /// padding between cells. /// public Vector2 CellPadding { @@ -716,7 +779,7 @@ namespace Tizen.NUI } /// - /// Layout rows property. + /// The number of layout rows /// public PropertyMap LayoutRows { @@ -733,7 +796,7 @@ namespace Tizen.NUI } /// - /// Layout columns property. + /// The number of layout columns /// public PropertyMap LayoutColumns { @@ -752,7 +815,7 @@ namespace Tizen.NUI } /// - /// HorizontalAlignmentType. + /// Enumeration for horizontal alignment types. /// public enum HorizontalAlignmentType { @@ -762,7 +825,7 @@ namespace Tizen.NUI } /// - /// VerticalAlignmentType. + /// Enumeration for vertical alignment types. /// public enum VerticalAlignmentType { diff --git a/src/Tizen.NUI/src/public/TapGesture.cs b/src/Tizen.NUI/src/public/TapGesture.cs index 670918b..f30d45c 100755 --- a/src/Tizen.NUI/src/public/TapGesture.cs +++ b/src/Tizen.NUI/src/public/TapGesture.cs @@ -62,8 +62,10 @@ namespace Tizen.NUI /// - /// Get TapGesture from Ptr. + /// Get TapGesture from the pointer. /// + /// The pointer to cast + /// TapGesture object public static TapGesture GetTapGestureFromPtr(global::System.IntPtr cPtr) { TapGesture ret = new TapGesture(cPtr, false); @@ -72,7 +74,7 @@ namespace Tizen.NUI } /// - /// NumberOfTaps. + /// Number of taps property (read-only). /// public uint NumberOfTaps { @@ -83,7 +85,7 @@ namespace Tizen.NUI } /// - /// NumberOfTouches. + /// Number of touches property (read-only). /// public uint NumberOfTouches { @@ -94,7 +96,7 @@ namespace Tizen.NUI } /// - /// ScreenPoint. + /// Screen point property (read-only). /// public Vector2 ScreenPoint { @@ -105,7 +107,7 @@ namespace Tizen.NUI } /// - /// LocalPoint. + /// Local point property (read-only). /// public Vector2 LocalPoint { @@ -116,7 +118,7 @@ namespace Tizen.NUI } /// - /// Default constructor. + /// Creates a TapGesture. /// public TapGesture() : this(NDalicPINVOKE.new_TapGesture__SWIG_0(), true) { @@ -126,14 +128,17 @@ namespace Tizen.NUI /// /// Copy constructor. /// + /// TapGesture to copy public TapGesture(TapGesture rhs) : this(NDalicPINVOKE.new_TapGesture__SWIG_1(TapGesture.getCPtr(rhs)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// - /// Assignment. + /// Assignment /// + /// A reference to the copied handle + /// A reference to this 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 1d77139..ceb83b1 100755 --- a/src/Tizen.NUI/src/public/TextEditor.cs +++ b/src/Tizen.NUI/src/public/TextEditor.cs @@ -303,7 +303,7 @@ namespace Tizen.NUI } /// - /// Creates an empty handle. + /// Creates the TextEditor control. /// public TextEditor() : this(NDalicPINVOKE.TextEditor_New(), true) { @@ -325,6 +325,8 @@ namespace Tizen.NUI /// /// Downcasts a handle to TextEditor. /// + /// Handle to an object + /// Handle to a TextEditor or an empty handle public new static TextEditor DownCast(BaseHandle handle) { TextEditor ret = new TextEditor(NDalicPINVOKE.TextEditor_DownCast(BaseHandle.getCPtr(handle)), true); diff --git a/src/Tizen.NUI/src/public/TextField.cs b/src/Tizen.NUI/src/public/TextField.cs index a8d3a15..a81f554 100755 --- a/src/Tizen.NUI/src/public/TextField.cs +++ b/src/Tizen.NUI/src/public/TextField.cs @@ -374,7 +374,7 @@ namespace Tizen.NUI } /// - /// Creates an empty handle. + /// Creates the TextField control. /// public TextField() : this(NDalicPINVOKE.TextField_New(), true) { @@ -396,6 +396,8 @@ namespace Tizen.NUI /// /// Downcasts a handle to TextField. /// + /// Handle to an object + /// Handle to a TextField or an empty handle public new static TextField DownCast(BaseHandle handle) { TextField ret = new TextField(NDalicPINVOKE.TextField_DownCast(BaseHandle.getCPtr(handle)), true); diff --git a/src/Tizen.NUI/src/public/TextLabel.cs b/src/Tizen.NUI/src/public/TextLabel.cs index 3c6fb19..fc58862 100755 --- a/src/Tizen.NUI/src/public/TextLabel.cs +++ b/src/Tizen.NUI/src/public/TextLabel.cs @@ -27,6 +27,10 @@ namespace Tizen.NUI { + /// + /// A control which renders a short text string. + /// Text labels are lightweight, non-editable and do not respond to user input. + /// public class TextLabel : View { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -46,6 +50,9 @@ namespace Tizen.NUI DisposeQueue.Instance.Add(this); } + /// + /// Dispose + /// public override void Dispose() { if (!Stage.IsInstalled()) @@ -141,11 +148,19 @@ namespace Tizen.NUI } + /// + /// Creates the TextLabel control. + /// public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// Creates the TextLabel control. + /// + /// The text to display public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -163,6 +178,10 @@ namespace Tizen.NUI return ret; } + /// + /// Downcasts a handle to TextLabel. + /// + /// Handle to an object public new static TextLabel DownCast(BaseHandle handle) { TextLabel ret = new TextLabel(NDalicPINVOKE.TextLabel_DownCast(BaseHandle.getCPtr(handle)), true); @@ -176,6 +195,10 @@ namespace Tizen.NUI PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000 } + /// + /// RenderingBackend property + /// The type of rendering e.g. bitmap-based. + /// public int RenderingBackend { get @@ -189,6 +212,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.RENDERING_BACKEND, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Text property + /// The text to display in UTF-8 format. + /// public string Text { get @@ -202,6 +230,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// FontFamily property + /// The requested font family to use. + /// public string FontFamily { get @@ -215,6 +248,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// FontStyle property + /// The requested font style to use. + /// public PropertyMap FontStyle { get @@ -228,6 +266,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// PointSize property + /// The size of font in points. + /// public float PointSize { get @@ -241,6 +284,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// MultiLine property + /// The single-line or multi-line layout option. + /// public bool MultiLine { get @@ -254,6 +302,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// HorizontalAlignment property + /// The line horizontal alignment. + /// public string HorizontalAlignment { get @@ -267,6 +320,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// VerticalAlignment property + /// The line vertical alignment. + /// public string VerticalAlignment { get @@ -280,6 +338,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// TextColor property + /// The color of the text. + /// public Color TextColor { get @@ -293,6 +356,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ShadowOffset property + /// The drop shadow offset 0 indicates no shadow. + /// public Vector2 ShadowOffset { get @@ -306,6 +374,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// ShadowColor property + /// The color of a drop shadow. + /// public Vector4 ShadowColor { get @@ -319,6 +392,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// UnderlineEnabled property + /// The underline enabled flag. + /// public bool UnderlineEnabled { get @@ -332,6 +410,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// UnderlineColor property + /// Overrides the underline height from font metrics. + /// public Vector4 UnderlineColor { get @@ -345,6 +428,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// UnderlineHeight property + /// Overrides the underline height from font metrics. + /// public float UnderlineHeight { get @@ -358,6 +446,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableMarkup property + /// Whether the mark-up processing is enabled. + /// public bool EnableMarkup { get @@ -371,6 +464,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// EnableAutoScroll property + /// Starts or stops auto scrolling. + /// public bool EnableAutoScroll { get @@ -384,6 +482,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// AutoScrollSpeed property + /// Sets the speed of scrolling in pixels per second. + /// public int AutoScrollSpeed { get @@ -397,6 +500,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// AutoScrollLoopCount property + /// Number of complete loops when scrolling enabled. + /// public int AutoScrollLoopCount { get @@ -410,6 +518,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// AutoScrollGap property + /// Gap before scrolling wraps. + /// public float AutoScrollGap { get @@ -423,6 +536,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// LineSpacing property + /// The default extra space between lines in points. + /// public float LineSpacing { get @@ -436,6 +554,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Underline property + /// The default underline parameters. + /// public PropertyMap Underline { get @@ -449,6 +572,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Shadow property + /// The default shadow parameters. + /// public PropertyMap Shadow { get @@ -462,6 +590,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Emboss property + /// The default emboss parameters. + /// public PropertyMap Emboss { get @@ -475,6 +608,11 @@ namespace Tizen.NUI SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value)); } } + + /// + /// Outline property + /// The default outline parameters. + /// public PropertyMap Outline { get -- 2.7.4