Add comments for API reference of part 4
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / TableView.cs
index 73b7321..3774169 100755 (executable)
 
 namespace Tizen.NUI
 {
-
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class TableView : View
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
@@ -46,6 +51,9 @@ namespace Tizen.NUI
             DisposeQueue.Instance.Add(this);
         }
 
+        /// <summary>
+        /// Dispose.
+        /// <summary>
         public override void Dispose()
         {
             if (!Stage.IsInstalled())
@@ -173,6 +181,9 @@ namespace Tizen.NUI
 
         }
 
+        /// <summary>
+        /// Class to specify layout position for child actor.
+        /// </summary>
         public class CellPosition : global::System.IDisposable
         {
             private global::System.Runtime.InteropServices.HandleRef swigCPtr;
@@ -194,6 +205,9 @@ namespace Tizen.NUI
                 Dispose();
             }
 
+            /// <summary>
+            /// Dispose
+            /// </summary>
             public virtual void Dispose()
             {
                 lock (this)
@@ -211,31 +225,49 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Constructor.
+            /// </summary>
             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();
             }
 
+            /// <summary>
+            /// Constructor.
+            /// </summary>
             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();
             }
 
+            /// <summary>
+            /// Constructor.
+            /// </summary>
             public CellPosition(uint rowIndex, uint columnIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_2(rowIndex, columnIndex), true)
             {
                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
             }
 
+            /// <summary>
+            /// Constructor.
+            /// </summary>
             public CellPosition(uint rowIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_3(rowIndex), true)
             {
                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
             }
 
+            /// <summary>
+            /// Constructor to initialise values to defaults for convenience.
+            /// </summary>
             public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true)
             {
                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
             }
 
+            /// <summary>
+            /// Row index.
+            /// </summary>
             public uint rowIndex
             {
                 set
@@ -251,6 +283,9 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Column index.
+            /// </summary>
             public uint columnIndex
             {
                 set
@@ -266,6 +301,9 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Row span.
+            /// </summary>
             public uint rowSpan
             {
                 set
@@ -281,6 +319,9 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Column span.
+            /// </summary>
             public uint columnSpan
             {
                 set
@@ -298,16 +339,26 @@ namespace Tizen.NUI
 
         }
 
+        /// <summary>
+        /// Creates the TableView control.
+        /// </summary>
         public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 
         }
+
+        /// <summary>
+        /// Copy constructor. Creates another handle that points to the same real object.
+        /// </summary>
         public TableView(TableView handle) : this(NDalicPINVOKE.new_TableView__SWIG_1(TableView.getCPtr(handle)), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Changes this handle to point to another real object.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Downcasts a handle to TableView handle.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Adds a child to the table.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Returns a child from the given layout position.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Removes a child from the given layout position.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Finds the child's layout position.
+        /// </summary>
         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;
         }
 
+        /// <summary>
+        /// Inserts a new row to given index.
+        /// </summary>
         public void InsertRow(uint rowIndex)
         {
             NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Deletes a row from the given index.
+        /// </summary>
         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();
         }
 
+        /// <summary>
+        /// Inserts a new column to the given index.
+        /// </summary>
         public void InsertColumn(uint columnIndex)
         {
             NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Deletes a column from the given index.
+        /// </summary>
         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();
         }
 
+        /// <summary>
+        /// Resizes the TableView.
+        /// </summary>
         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();
         }
 
+        /// <summary>
+        /// Sets horizontal and vertical padding between cells.
+        /// </summary>
         public void SetCellPadding(Size2D padding)
         {
             NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding));
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Gets the current padding as width and height.
+        /// </summary>
         public Vector2 GetCellPadding()
         {
             Vector2 ret = new Vector2(NDalicPINVOKE.TableView_GetCellPadding(swigCPtr), true);
@@ -411,12 +498,18 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Specifies this row as fitting its height to its children.
+        /// </summary>
         public void SetFitHeight(uint rowIndex)
         {
             NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Checks if the row is a fit row.
+        /// </summary>
         public bool IsFitHeight(uint rowIndex)
         {
             bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex);
@@ -424,12 +517,18 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Specifies this column as fitting its width to its children.
+        /// </summary>
         public void SetFitWidth(uint columnIndex)
         {
             NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Checks if the column is a fit column.
+        /// </summary>
         public bool IsFitWidth(uint columnIndex)
         {
             bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex);
@@ -437,12 +536,18 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Sets a row to have fixed height.
+        /// </summary>
         public void SetFixedHeight(uint rowIndex, float height)
         {
             NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Gets a row's fixed height.
+        /// </summary>
         public float GetFixedHeight(uint rowIndex)
         {
             float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex);
@@ -450,12 +555,20 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// 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.
+        /// </summary>
         public void SetRelativeHeight(uint rowIndex, float heightPercentage)
         {
             NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Gets a row's relative height.
+        /// </summary>
         public float GetRelativeHeight(uint rowIndex)
         {
             float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex);
@@ -463,12 +576,18 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Sets a column to have fixed width.
+        /// </summary>
         public void SetFixedWidth(uint columnIndex, float width)
         {
             NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Gets a column's fixed width.
+        /// </summary>
         public float GetFixedWidth(uint columnIndex)
         {
             float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex);
@@ -476,12 +595,20 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// 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.
+        /// </summary>
         public void SetRelativeWidth(uint columnIndex, float widthPercentage)
         {
             NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// Gets a column's relative width.
+        /// </summary>
         public float GetRelativeWidth(uint columnIndex)
         {
             float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex);
@@ -489,6 +616,9 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Gets the amount of rows in the table.
+        /// </summary>
         public uint GetRows()
         {
             uint ret = NDalicPINVOKE.TableView_GetRows(swigCPtr);
@@ -496,6 +626,9 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Gets the amount of columns in the table.
+        /// </summary>
         public uint GetColumns()
         {
             uint ret = NDalicPINVOKE.TableView_GetColumns(swigCPtr);
@@ -503,6 +636,9 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Sets the alignment on a cell.
+        /// </summary>
         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
         }
 
+        /// <summary>
+        /// Layout policy.
+        /// </summary>
         public enum LayoutPolicy
         {
             Fixed,
@@ -525,6 +664,9 @@ namespace Tizen.NUI
             Fit
         }
 
+        /// <summary>
+        /// Rows property.
+        /// </summary>
         public int Rows
         {
             get
@@ -538,6 +680,10 @@ namespace Tizen.NUI
                 SetProperty(TableView.Property.ROWS, new Tizen.NUI.PropertyValue(value));
             }
         }
+
+        /// <summary>
+        /// Columns property.
+        /// </summary>
         public int Columns
         {
             get
@@ -551,6 +697,10 @@ namespace Tizen.NUI
                 SetProperty(TableView.Property.COLUMNS, new Tizen.NUI.PropertyValue(value));
             }
         }
+
+        /// <summary>
+        /// Cell padding property.
+        /// </summary>
         public Vector2 CellPadding
         {
             get
@@ -564,6 +714,10 @@ namespace Tizen.NUI
                 SetProperty(TableView.Property.CELL_PADDING, new Tizen.NUI.PropertyValue(value));
             }
         }
+
+        /// <summary>
+        /// Layout rows property.
+        /// </summary>
         public PropertyMap LayoutRows
         {
             get
@@ -577,6 +731,10 @@ namespace Tizen.NUI
                 SetProperty(TableView.Property.LAYOUT_ROWS, new Tizen.NUI.PropertyValue(value));
             }
         }
+
+        /// <summary>
+        /// Layout columns property.
+        /// </summary>
         public PropertyMap LayoutColumns
         {
             get
@@ -592,12 +750,20 @@ namespace Tizen.NUI
         }
 
     }
+
+    /// <summary>
+    /// HorizontalAlignmentType.
+    /// </summary>
     public enum HorizontalAlignmentType
     {
         Left,
         Center,
         Right
     }
+
+    /// <summary>
+    /// VerticalAlignmentType.
+    /// </summary>
     public enum VerticalAlignmentType
     {
         Top,