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=fb7dd53046c78b8f81c8150f8a4ff42533da2a94;hp=3f199a5c4d745b77242a57e989647de1c4d11986;hb=fcc87538717836a4f9d9ca9ec7dfc242f5aa8431;hpb=1844e9a1b878629f4987aea536660e3a70962c8c 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 3f199a5..fb7dd53 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -128,6 +128,11 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the TableView class. + * + * @SINCE_1_0.0 + */ enum { ROWS = PROPERTY_START_INDEX, ///< name "rows", type unsigned int @SINCE_1_0.0 @@ -144,6 +149,10 @@ public: */ struct ChildProperty { + /** + * @brief An enumeration of child properties belonging to the TableView class. + * @SINCE_1_1.36 + */ 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 @@ -175,6 +184,10 @@ public: /** * @brief Constructor to initialise values to defaults for convenience * @SINCE_1_0.0 + * @param[in] rowIndex The row index initialized + * @param[in] columnIndex The column index initialized + * @param[in] rowSpan The row span initialized + * @param[in] columnSpan The column span initialized */ CellPosition( unsigned int rowIndex = 0, unsigned int columnIndex = 0, unsigned int rowSpan = 1, unsigned int columnSpan = 1 ) @@ -198,13 +211,15 @@ public: /** * @brief Copy constructor. Creates another handle that points to the same real object * @SINCE_1_0.0 - * @param handle to copy from + * @param[in] handle to copy from */ TableView( const TableView& handle ); /** * @brief Assignment operator. Changes this handle to point to another real object * @SINCE_1_0.0 + * @param[in] handle Handle to an object + * @return A reference to this */ TableView& operator=( const TableView& handle ); @@ -368,7 +383,7 @@ public: void SetFitHeight( unsigned int rowIndex ); /** - * @brief Is the row a fit row + * @brief Check if the row is a fit row. * * @SINCE_1_0.0 * @param[in] rowIndex The row to check @@ -385,7 +400,7 @@ public: void SetFitWidth( unsigned int columnIndex ); /** - * @brief Is the column a fit column + * @brief Check if the column is a fit column. * * @SINCE_1_0.0 * @param[in] columnIndex The column to check @@ -406,6 +421,7 @@ public: /** * @brief Gets a row's fixed height. * @SINCE_1_0.0 + * @param[in] rowIndex The row index with fixed height * @return height in world coordinate units. * @pre The row rowIndex must exist. * @note The returned value is valid if it has been set before. @@ -426,6 +442,7 @@ public: /** * @brief Gets a row's relative height. * @SINCE_1_0.0 + * @param[in] rowIndex The row index with relative height * @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. @@ -445,6 +462,7 @@ public: /** * @brief Gets a column's fixed width. * @SINCE_1_0.0 + * @param[in] columnIndex The column index with fixed width * @return width in world coordinate units. * @pre The column columnIndex must exist. * @note The returned value is valid if it has been set before. @@ -465,6 +483,7 @@ public: /** * @brief Gets a column's relative width. * @SINCE_1_0.0 + * @param[in] columnIndex The column index with relative width * @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. @@ -499,6 +518,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -512,6 +532,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**