X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-label.h;h=c0010f454c3ae15eb847ac5bd16359facd4c29e7;hb=refs%2Fchanges%2F99%2F195799%2F5;hp=0de1b0170d07424752f419e21cbb9f8e34be2e0f;hpb=5adddaee3a851bef26ccbd4fd23cbff951222079;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/text-controls/text-label.h b/dali-toolkit/public-api/controls/text-controls/text-label.h index 0de1b01..c0010f4 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_TEXT_LABEL_H__ /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -63,7 +63,7 @@ class TextLabel; * * @SINCE_1_0.0 */ -class DALI_IMPORT_API TextLabel : public Control +class DALI_TOOLKIT_API TextLabel : public Control { public: @@ -144,16 +144,18 @@ public: /** * @brief The line horizontal alignment. - * @details Name "horizontalAlignment", type Property::STRING + * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER) * Values "BEGIN", "CENTER", "END", default BEGIN. + * @note Return type is Property::STRING * @SINCE_1_0.0 */ HORIZONTAL_ALIGNMENT, /** * @brief The line vertical alignment. - * @details Name "verticalAlignment", type Property::STRING. + * @details Name "verticalAlignment", type Property::STRING or type VerticalAlignment::Type (Property::INTEGER). * Values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP. + * @note Return type is Property::STRING * @SINCE_1_0.0 */ VERTICAL_ALIGNMENT, @@ -167,41 +169,6 @@ public: UNUSED_PROPERTY_TEXT_COLOR, /** - * @DEPRECATED_1_1.37 Use SHADOW instead - * @brief The drop shadow offset 0 indicates no shadow. - * @details Name "shadowOffset", type Property::VECTOR2. - */ - SHADOW_OFFSET, - - /** - * @DEPRECATED_1_1.37 Use SHADOW instead - * @brief The color of a drop shadow. - * @details Name "shadowColor", type Property::VECTOR4 - */ - SHADOW_COLOR, - - /** - * @DEPRECATED_1_1.37 Use UNDERLINE instead - * @brief The underline enabled flag. - * @details Name "underlineEnabled", type Property::BOOLEAN. - */ - UNDERLINE_ENABLED, - - /** - * @DEPRECATED_1_1.37 Use UNDERLINE instead - * @brief The color of the underline. - * @details Name "underlineColor", type Property::VECTOR4. - */ - UNDERLINE_COLOR, - - /** - * @DEPRECATED_1_1.37 Use UNDERLINE instead - * @brief Overrides the underline height from font metrics. - * @details Name "underlineHeight", type Property::FLOAT. - */ - UNDERLINE_HEIGHT, - - /** * @brief Whether the mark-up processing is enabled. * @details Name "enableMarkup", type Property::BOOLEAN. * @SINCE_1_0.0 @@ -238,6 +205,7 @@ public: * @details Name "autoScrollGap", type Property::INT. * @SINCE_1_1.35 * @note Default in style sheet but can be overridden to prevent same text being shown at start and end. + * @note Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE). */ AUTO_SCROLL_GAP, @@ -251,6 +219,15 @@ public: /** * @brief The default underline parameters. * @details Name "underline", type Property::MAP. + * + * The underline map contains the following keys: + * + * | %Property Name | Type | Required | Description | + * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| + * | enable | BOOLEAN | No | True to enable the underline or false to disable (the default value is false) | + * | color | VECTOR4 | No | The color of the underline (the default value is Color::BLACK) | + * | height | FLOAT | No | The height of the underline (the default value is 0) | + * * @SINCE_1_2.13 */ UNDERLINE, @@ -258,6 +235,15 @@ public: /** * @brief The default shadow parameters. * @details Name "shadow", type Property::MAP. + * + * The shadow map contains the following keys: + * + * | %Property Name | Type | Required | Description | + * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| + * | color | VECTOR4 | No | The color of the shadow (the default value is Color::BLACK) | + * | offset | VECTOR2 | No | The offset from the text to draw the shadow in the X and Y axes (the default value is 0 which means no shadow) | + * | blurRadius | FLOAT | No | The radius of blur to be applied to the shadow (the default value is 0 which means no blur) | + * * @SINCE_1_2.13 */ SHADOW, @@ -272,6 +258,14 @@ public: /** * @brief The default outline parameters. * @details Name "outline", type Property::MAP. + * + * The outline map contains the following keys: + * + * | %Property Name | Type | Required | Description | + * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| + * | color | VECTOR4 | No | The color of the outline (the default value is Color::WHITE) | + * | width | INTEGER | No | The width of the outline (the default value is 0 which means no outline) | + * * @SINCE_1_2.13 */ OUTLINE, @@ -308,7 +302,7 @@ public: */ AUTO_SCROLL_STOP_MODE, - /* + /** * @brief The line count of text. * @details name "lineCount", type Property::INTEGER. * @SINCE_1_2.60 @@ -318,8 +312,11 @@ public: /** * @brief Line wrap mode when text lines are greater than the layout width. - * @details Name "lineWrapMode", type Property::STRING. + * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING. * @SINCE_1_2.60 + * @note Default is Text::LineWrap::WORD. + * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER). + * @see Text::LineWrap */ LINE_WRAP_MODE,