X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FBaseComponents%2FTableView.cs;h=0766f75d2651c185d6b6b1c1a43e56cd503e6b01;hb=58eaa603449254d05d07c00671ee77fa96e6e36b;hp=48b57d32c425e8f550e52366afb0ae9ff26e708d;hpb=87e72a859c56cb8732ccd14046cb509759ca9d2f;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/src/Tizen.NUI/src/public/BaseComponents/TableView.cs b/src/Tizen.NUI/src/public/BaseComponents/TableView.cs index 48b57d3..0766f75 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TableView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TableView.cs @@ -21,8 +21,8 @@ namespace Tizen.NUI.BaseComponents /// /// 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 + /// TableView constraints the X and the Y position and the width and the height of the child actors.
+ /// The Z position and depth are left intact so that the 3D model actors can also be laid out /// in a grid without loosing their depth scaling.
///
public class TableView : View @@ -71,7 +71,7 @@ namespace Tizen.NUI.BaseComponents } - internal class Property + internal new class Property { internal static readonly int ROWS = NDalicPINVOKE.TableView_Property_ROWS_get(); internal static readonly int COLUMNS = NDalicPINVOKE.TableView_Property_COLUMNS_get(); @@ -90,7 +90,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Class to specify layout position for child view. + /// Class to specify the layout position for the child view. /// public class CellPosition : global::System.IDisposable { @@ -172,49 +172,49 @@ namespace Tizen.NUI.BaseComponents } /// - /// Constructor. + /// The constructor. /// - /// The row index initialized - /// The column index initialized - /// The row span initialized - /// The column span initialized + /// 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 to initialise values to defaults for convenience. + /// The constructor to initialize values to defaults for convenience. /// - /// The row index initialized - /// The column index initialized - /// The row span initialized + /// 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 to initialise values to defaults for convenience. + /// The constructor to initialize values to defaults for convenience. /// - /// The row index initialized - /// The column index initialized + /// 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 to initialise values to defaults for convenience. + /// The constructor to initialize values to default for convenience. /// - /// The row index initialized + /// 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(); } /// - /// Default constructor + /// The default constructor. /// public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true) { @@ -222,7 +222,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Index of row + /// The index of a row. /// public uint rowIndex { @@ -240,7 +240,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Index of column + /// The index of a column. /// public uint columnIndex { @@ -258,7 +258,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Span of row + /// The span of a row. /// public uint rowSpan { @@ -276,7 +276,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Span of column + /// The span of a column. /// public uint columnSpan { @@ -298,8 +298,8 @@ namespace Tizen.NUI.BaseComponents /// /// Creates the TableView view. /// - /// initialRows for the table - /// initialColumns for the table + /// Initial rows for the table. + /// Initial columns for the table. public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -307,9 +307,9 @@ namespace Tizen.NUI.BaseComponents } /// - /// Copy constructor. Creates another handle that points to the same real object. + /// The Copy constructor. Creates another handle that points to the same real object. /// - /// Handle to copy from + /// 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(); @@ -327,9 +327,9 @@ namespace Tizen.NUI.BaseComponents /// 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 + /// The child to add. + /// The position for the child. + /// True if the addition succeeded, and false if the cell is already occupied. public bool AddChild(View child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_AddChild(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -340,8 +340,8 @@ namespace Tizen.NUI.BaseComponents /// /// Returns a child from the given layout position. /// - /// The position in the table - /// Child that was in the cell or an uninitialized handle + /// The position in the table. + /// Child that was in the cell or an uninitialized handle. public View GetChildAt(TableView.CellPosition position) { IntPtr cPtr = NDalicPINVOKE.TableView_GetChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)); @@ -354,8 +354,8 @@ namespace Tizen.NUI.BaseComponents /// /// Removes a child from the given layout position. /// - /// The position for the child to remove - /// Child that was removed or an uninitialized handle + /// The position for the child to remove. + /// Child that was removed or an uninitialized handle. public View RemoveChildAt(TableView.CellPosition position) { IntPtr cPtr = NDalicPINVOKE.TableView_RemoveChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)); @@ -368,9 +368,9 @@ namespace Tizen.NUI.BaseComponents /// /// 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 + /// The child to search for. + /// The position for the child. + /// True if the child was included in this TableView. public bool FindChildPosition(View child, TableView.CellPosition position) { bool ret = NDalicPINVOKE.TableView_FindChildPosition(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position)); @@ -379,9 +379,9 @@ namespace Tizen.NUI.BaseComponents } /// - /// Inserts a new row to given index. + /// Inserts a new row to the given index. /// - /// The rowIndex of the new row + /// The rowIndex of the new row. public void InsertRow(uint rowIndex) { NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex); @@ -392,7 +392,7 @@ namespace Tizen.NUI.BaseComponents /// Deletes a row from the given index.
/// Removed elements are deleted.
/// - /// The rowIndex of the row to delete + /// The rowIndex of the row to delete. public void DeleteRow(uint rowIndex) { NDalicPINVOKE.TableView_DeleteRow__SWIG_0(swigCPtr, rowIndex); @@ -402,7 +402,7 @@ namespace Tizen.NUI.BaseComponents /// /// Inserts a new column to the given index. /// - /// The columnIndex of the new column + /// The columnIndex of the new column. public void InsertColumn(uint columnIndex) { NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex); @@ -413,7 +413,7 @@ namespace Tizen.NUI.BaseComponents /// Deletes a column from the given index.
/// Removed elements are deleted.
/// - /// The columnIndex of the column to delete + /// The columnIndex of the column to delete. public void DeleteColumn(uint columnIndex) { NDalicPINVOKE.TableView_DeleteColumn__SWIG_0(swigCPtr, columnIndex); @@ -423,8 +423,8 @@ namespace Tizen.NUI.BaseComponents /// /// Resizes the TableView. /// - /// The rows for the table - /// The columns for the table + /// 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); @@ -432,9 +432,9 @@ namespace Tizen.NUI.BaseComponents } /// - /// Sets horizontal and vertical padding between cells. + /// Sets the horizontal and the vertical padding between cells. /// - /// Width and height + /// Width and height. public void SetCellPadding(Size2D padding) { NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding)); @@ -444,7 +444,7 @@ namespace Tizen.NUI.BaseComponents /// /// Gets the current padding as width and height. /// - /// 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); @@ -455,7 +455,7 @@ namespace Tizen.NUI.BaseComponents /// /// Specifies this row as fitting its height to its children. /// - /// The row to set + /// The row to set. public void SetFitHeight(uint rowIndex) { NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex); @@ -465,8 +465,8 @@ namespace Tizen.NUI.BaseComponents /// /// Checks if the row is a fit row. /// - /// The row to check - /// true if the row is fit + /// The row to check. + /// True if the row is fit. public bool IsFitHeight(uint rowIndex) { bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex); @@ -477,7 +477,7 @@ namespace Tizen.NUI.BaseComponents /// /// Specifies this column as fitting its width to its children. /// - /// The column to set + /// The column to set. public void SetFitWidth(uint columnIndex) { NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex); @@ -487,8 +487,8 @@ namespace Tizen.NUI.BaseComponents /// /// Checks if the column is a fit column. /// - /// The column to check - /// true if the column is fit + /// The column to check. + /// True if the column is fit. public bool IsFitWidth(uint columnIndex) { bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex); @@ -497,11 +497,11 @@ namespace Tizen.NUI.BaseComponents } /// - /// Sets a row to have fixed height.
+ /// Sets a row to have a fixed height.
/// Setting a fixed height of 0 has no effect.
///
- /// The rowIndex for row with fixed height - /// The height in world coordinate units + /// The rowIndex for row with a fixed height. + /// The height in world coordinate units. public void SetFixedHeight(uint rowIndex, float height) { NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height); @@ -511,8 +511,8 @@ namespace Tizen.NUI.BaseComponents /// /// Gets a row's fixed height. /// - /// The row index with fixed height - /// height The height in world coordinate units + /// The row index with a fixed height. + /// height The height in world coordinate units. public float GetFixedHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex); @@ -521,12 +521,12 @@ namespace Tizen.NUI.BaseComponents } /// - /// 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.
+ /// Sets a row to have a 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.
///
- /// The rowIndex for row with relative height - /// The height percentage between 0.0f and 1.0f + /// The rowIndex for row with a relative height. + /// The height percentage between 0.0f and 1.0f. public void SetRelativeHeight(uint rowIndex, float heightPercentage) { NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage); @@ -536,8 +536,8 @@ namespace Tizen.NUI.BaseComponents /// /// Gets a row's relative height. /// - /// The row index with relative height - /// Height in percentage units, between 0.0f and 1.0f + /// The row index with a relative height. + /// Height in percentage units, between 0.0f and 1.0f. public float GetRelativeHeight(uint rowIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex); @@ -546,11 +546,11 @@ namespace Tizen.NUI.BaseComponents } /// - /// Sets a column to have fixed width.
+ /// Sets a column to have a fixed width.
/// Setting a fixed width of 0 has no effect.
///
- /// The columnIndex for column with fixed width - /// The width in world coordinate units + /// The columnIndex for column with a fixed width. + /// The width in world coordinate units. public void SetFixedWidth(uint columnIndex, float width) { NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width); @@ -560,8 +560,8 @@ namespace Tizen.NUI.BaseComponents /// /// Gets a column's fixed width. /// - /// The column index with fixed width - /// Width in world coordinate units + /// The column index with a fixed width. + /// Width in world coordinate units. public float GetFixedWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex); @@ -570,12 +570,12 @@ namespace Tizen.NUI.BaseComponents } /// - /// Sets a column to have relative width. Relative width means percentage of - /// the remainder of table width after subtracting Padding and Fixed width columns.
+ /// Sets a column to have a relative width. Relative width means percentage of + /// the remainder of the 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 + /// The columnIndex for column with a fixed width. + /// The widthPercentage between 0.0f and 1.0f. public void SetRelativeWidth(uint columnIndex, float widthPercentage) { NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage); @@ -585,8 +585,8 @@ namespace Tizen.NUI.BaseComponents /// /// Gets a column's relative width. /// - /// The column index with relative width - /// Width in percentage units, between 0.0f and 1.0f + /// The column index with a relative width. + /// Width in percentage units, between 0.0f and 1.0f. public float GetRelativeWidth(uint columnIndex) { float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex); @@ -596,11 +596,11 @@ namespace Tizen.NUI.BaseComponents /// /// Sets the alignment on a cell.
- /// Cells without calling this function have the default values of LEFT and TOP respectively.
+ /// 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 + /// 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); @@ -608,7 +608,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// Enumeration for describing how the size of a row / column has been set. + /// Enumeration for describing how the size of a row or column has been set. /// public enum LayoutPolicy { @@ -619,7 +619,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// the amount of rows in the table. + /// The amount of rows in the table. /// public int Rows { @@ -635,7 +635,7 @@ namespace Tizen.NUI.BaseComponents } } /// - /// the amount of columns in the table. + /// The amount of columns in the table. /// public int Columns { @@ -651,7 +651,7 @@ namespace Tizen.NUI.BaseComponents } } /// - /// padding between cells. + /// Padding between cells. /// public Vector2 CellPadding { @@ -668,7 +668,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// The number of layout rows + /// The number of layout rows. /// public PropertyMap LayoutRows { @@ -685,7 +685,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// The number of layout columns + /// The number of layout columns. /// public PropertyMap LayoutColumns {