X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftable-view%2Ftable-view.h;h=1774f604151b34c10bd369a3ea596fe3e79d76ed;hp=fb59939f73b81a60a41c4455eeaaf42891aea35f;hb=f3da11c2818c6d17706fbb2417f21b602b3190f5;hpb=d7638de1a66bed4868e8a9fb2f4d3c03f4ce27f8 diff --git a/dali-toolkit/public-api/controls/table-view/table-view.h b/dali-toolkit/public-api/controls/table-view/table-view.h index fb59939..1774f60 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -35,42 +35,50 @@ namespace Internal DALI_INTERNAL { class TableView; } +/** + * @addtogroup dali_toolkit_controls_table_view + * @{ + */ /** - * TableView is a layout container for aligning child actors in a grid like layout. + * @brief 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. * * @nosubgrouping - * - * Per-child Custom properties for script supporting. + *

Per-child Custom properties for script supporting:

* * When an actor is add to the tableView through Actor::Add() instead of TableView::AddChild, - * the following custom properties of the actor are checked to decide the actor position inside the table + * the following custom properties of the actor are checked to decide the actor position inside the table. * * These properties are registered dynamically to the child and is non-animatable. * - * | %Property Name | Type | - * |---------------------------|--------------------| - * | cell-index | Vector2 | - * | row-span | float | // type float (Currently builder is unable to differentiate integer and float from Json string) - * | column-span | float | // type float (Currently builder is unable to differentiate integer and float from Json string) - * | cell-horizontal-alignment | string | // available values: left, center, right - * | cell-vertical-alignment | string | // available values: top, center, bottom + * | %Property Name | Type | + * |-------------------------|-------------| + * | cellIndex | Vector2 | + * | rowSpan | float | + * | columnSpan | float | + * | cellHorizontalAlignment | string | + * | cellVerticalAlignment | string | + * + * The row-span or column span has integer value, but its type is float here due to the limitation of the builder's ability to differentiate integer and float from Json string. + * The available values for cellHorizontalAlignment are: left, center, right. + * The available values for cellVerticalAlignment are: top, center, bottom. * * @code - * "name":"gallery-1", + * "name":"gallery1", * "type":"ImageActor", * "image": { * "filename": "{DALI_IMAGE_DIR}gallery-small-1.jpg" * }, - * "custom-properties": { - * "cell-index":[1,1], // property to specify the top-left cell this child occupies, if not set, the first available cell is used - * "row-span":3, // property to specify how many rows this child occupies, if not set, default value is 1 - * "column-span": 2, // property to specify how many columns this child occupies, if nor set, default value is 1 - * "cell-horizontal-alignment": "left", // property to specify how to align horizontally inside the cells, if not set, default value is 'left' - * "cell-vertical-alignment": "center" // property to specify how to align vertically inside the cells, if not set, default value is 'top' + * "customProperties": { + * "cellIndex":[1,1], // property to specify the top-left cell this child occupies, if not set, the first available cell is used + * "rowSpan":3, // property to specify how many rows this child occupies, if not set, default value is 1 + * "columnSpan": 2, // property to specify how many columns this child occupies, if nor set, default value is 1 + * "cellHorizontalAlignment": "left", // property to specify how to align horizontally inside the cells, if not set, default value is 'left' + * "cellVerticalAlignment": "center" // property to specify how to align vertically inside the cells, if not set, default value is 'top' * } * @endcode */ @@ -93,7 +101,7 @@ public: * LayoutRows: set the height of the rows. * It has the format as follows in script: * @code - * "layout-rows": + * "layoutRows": { "0": { "policy": "fixed", "value": 40 }, //@see SetFixedHight "2": { "policy": "relative", "value": 0.33 }, //@see SetRelativeHeight @@ -104,7 +112,7 @@ public: * LayoutColumns: set the height of the rows. * It has the format as follows in script: * @code - * "layout-columns": + * "layoutColumns": { "0": { "policy": "fixed", "value": 40 }, //@see SetFixedWidth "1": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its width is decided by the children in this column @@ -118,9 +126,9 @@ public: { ROWS = PROPERTY_START_INDEX, ///< name "rows", type unsigned int COLUMNS, ///< name "columns", type unsigned int - CELL_PADDING, ///< name "cell-padding", type Vector2 - LAYOUT_ROWS, ///< name "layout-rows", type Map - LAYOUT_COLUMNS, ///< name "layout-columns", type Map + CELL_PADDING, ///< name "cellPadding", type Vector2 + LAYOUT_ROWS, ///< name "layoutRows", type Map + LAYOUT_COLUMNS, ///< name "layoutColumns", type Map }; }; @@ -131,7 +139,7 @@ public: { FIXED, ///< Fixed with the given value. RELATIVE, ///< Calculated as percentage of the remainder after subtracting Padding and Fixed height/width - FILL, ///< Default policy, get the remainder of the 100% (after subtracting Padding, Fixed and Relative height/ width) divided evenly between 'fill' rows/columns + FILL, ///< Default policy, get the remainder of the 100% (after subtracting Fixed, Fit and Relative height/ width) divided evenly between 'fill' rows/columns FIT ///< Fit around its children. }; @@ -437,6 +445,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali