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=e3f17b7e0d0df5efc304fe5f1e95449db720a181;hp=3e8ce7da6703eb87aa698ce07c027d79b18b9b67;hb=c46d8cb79f848d9e1fda57a46a987aadea57a7cd;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded 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 3e8ce7d..e3f17b7 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -69,11 +69,11 @@ class TableView; * * @code * "name":"gallery1", - * "type":"ImageActor", + * "type":"ImageView", * "image": { - * "filename": "{DALI_IMAGE_DIR}gallery-small-1.jpg" + * "url": "{DALI_IMAGE_DIR}gallery-small-1.jpg" * }, - * "customProperties": { + * "properties": { * "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 @@ -94,7 +94,10 @@ public: enum PropertyRange { PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0 - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0 + + CHILD_PROPERTY_START_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.36 + CHILD_PROPERTY_END_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve child property indices @SINCE_1_1.36 }; /** @@ -136,6 +139,22 @@ public: }; /** + * @brief An enumeration of child properties belonging to the TableView class. + * @SINCE_1_1.36 + */ + struct ChildProperty + { + enum + { + CELL_INDEX = CHILD_PROPERTY_START_INDEX, ///< name "cellIndex", The top-left cell this child occupies, if not set, the first available cell is used, type VECTOR2 @SINCE_1_1.36 + ROW_SPAN, ///< name "rowSpan", The number of rows this child occupies, if not set, default value is 1, type FLOAT @SINCE_1_1.36 + COLUMN_SPAN, ///< name "columnSpan", The number of columns this child occupies, if not set, default value is 1, type FLOAT @SINCE_1_1.36 + CELL_HORIZONTAL_ALIGNMENT, ///< name "cellHorizontalAlignment", The horizontal alignment of this child inside the cells, if not set, default value is 'left', type STRING @SINCE_1_1.36 + CELL_VERTICAL_ALIGNMENT ///< name "cellVerticalAlignment", The vertical alignment of this child inside the cells, if not set, default value is 'top', type STRING @SINCE_1_1.36 + }; + }; + + /** * @brief Describes how the size of a row / column been set * @SINCE_1_0.0 */ @@ -207,7 +226,9 @@ public: static TableView New( unsigned int initialRows, unsigned int initialColumns ); /** - * @brief Downcast an Object handle to TableView. If handle points to a TableView the + * @brief Downcast a handle to TableView handle. + * + * If handle points to a TableView the * downcast produces valid handle. If not the returned handle is left uninitialized. * @SINCE_1_0.0 * @param[in] handle Handle to an object @@ -228,20 +249,20 @@ public: /** * @brief Returns a child from the given layout position - * Note! if there is no child in this position this method returns an uninitialized - * Actor handle * @SINCE_1_0.0 * @param[in] position in the table * @return child that was in the cell or an uninitialized handle + * @note If there is no child in this position this method returns an uninitialized. + * Actor handle */ Actor GetChildAt( CellPosition position ); /** * @brief Removes a child from the given layout position - * Note! if there is no child in this position this method does nothing * @SINCE_1_0.0 * @param[in] position for the child to remove * @return child that was removed or an uninitialized handle + * @note If there is no child in this position this method does nothing. */ Actor RemoveChildAt( CellPosition position ); @@ -301,24 +322,26 @@ public: void DeleteColumn( unsigned int columnIndex, std::vector& removed ); /** - * @brief Resize the TableView. Note! if the new size is smaller than old, - * superfluous actors get removed. If you want to relayout removed children, - * use the variant that returns the removed Actors and reinsert them into the table - * If an actor spans to a removed row or column it gets removed from the table + * @brief Resize the TableView. * @SINCE_1_0.0 * @param[in] rows for the table * @param[in] columns for the table + * @note If the new size is smaller than old, + * superfluous actors get removed. If you want to relayout removed children, + * use the variant that returns the removed Actors and reinsert them into the table. + * If an actor spans to a removed row or column it gets removed from the table. */ void Resize( unsigned int rows, unsigned int columns ); /** - * @brief Resize the TableView. Note! if the new size is smaller than old, - * superfluous actors get removed. - * If an actor spans to a removed row or column it gets removed from the table + * @brief Resize the TableView. * @SINCE_1_0.0 * @param[in] rows for the table * @param[in] columns for the table * @param[out] removed actor handles + * @note If the new size is smaller than old, + * superfluous actors get removed. + * If an actor spans to a removed row or column it gets removed from the table. */ void Resize( unsigned int rows, unsigned int columns, std::vector& removed ); @@ -330,6 +353,7 @@ public: void SetCellPadding( Size padding ); /** + * @brief Get the current padding as width and height. * @SINCE_1_0.0 * @return the current padding as width and height */ @@ -381,10 +405,10 @@ public: /** * @brief Gets a row's fixed height. - * Note! The returned value is valid if it has been set before. * @SINCE_1_0.0 * @return height in world coordinate units. * @pre The row rowIndex must exist. + * @note The returned value is valid if it has been set before. */ float GetFixedHeight( unsigned int rowIndex ) const; @@ -401,10 +425,10 @@ public: /** * @brief Gets a row's relative height. - * Note! The returned value is valid if it has been set before. * @SINCE_1_0.0 * @return height in percentage units, between 0.0f and 1.0f. * @pre The row rowIndex must exist. + * @note The returned value is valid if it has been set before. */ float GetRelativeHeight( unsigned int rowIndex ) const; @@ -420,10 +444,10 @@ public: /** * @brief Gets a column's fixed width. - * Note! The returned value is valid if it has been set before. * @SINCE_1_0.0 * @return width in world coordinate units. * @pre The column columnIndex must exist. + * @note The returned value is valid if it has been set before. */ float GetFixedWidth( unsigned int columnIndex ) const; @@ -440,20 +464,22 @@ public: /** * @brief Gets a column's relative width. - * Note! The returned value is valid if it has been set before. * @SINCE_1_0.0 * @return width in percentage units, between 0.0f and 1.0f. * @pre The column columnIndex must exist. + * @note The returned value is valid if it has been set before. */ float GetRelativeWidth( unsigned int columnIndex ) const; /** + * @brief Gets the amount of rows in the table. * @SINCE_1_0.0 * @return the amount of rows in the table */ unsigned int GetRows(); /** + * @brief Gets the amount of columns in the table. * @SINCE_1_0.0 * @return the amount of columns in the table */