X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Ftext-controls%2Ftext-label-devel.h;h=0b1627375286e044891f7d026b6f581ba9c4110f;hb=ce96793b0e8a68de6c562c1ad3114145b5223203;hp=c609d34c37e14785e8c27ee8152bc2d32a08abba;hpb=0f2c3c51b43d74f9713c6b9cbaefdaa7f4846b11;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/controls/text-controls/text-label-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-label-devel.h index c609d34..0b16273 100644 --- a/dali-toolkit/devel-api/controls/text-controls/text-label-devel.h +++ b/dali-toolkit/devel-api/controls/text-controls/text-label-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_LABEL_DEVEL_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. @@ -30,111 +30,82 @@ namespace Toolkit namespace DevelTextLabel { -/** - * @brief Enumeration for the start and end property ranges for this control. - * @SINCE_1_0.0 - */ -enum PropertyRange -{ - ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, - ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices -}; - namespace Property { enum Type { - RENDERING_BACKEND = Dali::Toolkit::TextLabel::Property::RENDERING_BACKEND, - TEXT = Dali::Toolkit::TextLabel::Property::TEXT, - FONT_FAMILY = Dali::Toolkit::TextLabel::Property::FONT_FAMILY, - FONT_STYLE = Dali::Toolkit::TextLabel::Property::FONT_STYLE, - POINT_SIZE = Dali::Toolkit::TextLabel::Property::POINT_SIZE, - MULTI_LINE = Dali::Toolkit::TextLabel::Property::MULTI_LINE, - HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, - VERTICAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, - TEXT_COLOR = Dali::Toolkit::TextLabel::Property::TEXT_COLOR, - SHADOW_OFFSET = Dali::Toolkit::TextLabel::Property::SHADOW_OFFSET, - SHADOW_COLOR = Dali::Toolkit::TextLabel::Property::SHADOW_COLOR, - UNDERLINE_ENABLED = Dali::Toolkit::TextLabel::Property::UNDERLINE_ENABLED, - UNDERLINE_COLOR = Dali::Toolkit::TextLabel::Property::UNDERLINE_COLOR, - UNDERLINE_HEIGHT = Dali::Toolkit::TextLabel::Property::UNDERLINE_HEIGHT, - ENABLE_MARKUP = Dali::Toolkit::TextLabel::Property::ENABLE_MARKUP, - ENABLE_AUTO_SCROLL = Dali::Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL, - AUTO_SCROLL_SPEED = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED, - AUTO_SCROLL_LOOP_COUNT = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT, - AUTO_SCROLL_GAP = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_GAP, - LINE_SPACING = Dali::Toolkit::TextLabel::Property::LINE_SPACING, - UNDERLINE = Dali::Toolkit::TextLabel::Property::UNDERLINE, - SHADOW = Dali::Toolkit::TextLabel::Property::SHADOW, - EMBOSS = Dali::Toolkit::TextLabel::Property::EMBOSS, - OUTLINE = Dali::Toolkit::TextLabel::Property::OUTLINE, - - /** - * @brief The size of font in pixels. - * - * Conversion from Point size to Pixel size : - * Pixel size = Point size * DPI / 72 - * @details name "pixelSize", type float - */ - PIXEL_SIZE = OUTLINE + 1, - - /** - * @brief Enable or disable the ellipsis. - * @details name "ellipsis", type bool - */ - ELLIPSIS = OUTLINE + 2, - - /** - * @brief delay starting time of auto scrolling and further loops - * @details name "autoScrollLoopDelay", type float. - */ - AUTO_SCROLL_LOOP_DELAY = OUTLINE + 3, - - /** - * @brief Auto scrolling stop behaviour. - * @details name "autoScrollStopMode", type [Type](@ref Dali::Toolkit::DevelTextLabel::AutoScrollStopMode::Type) (Property::INTEGER) or Property::STRING. - * values FINISH_LOOP, IMMEDIATE, defualt FINISH_LOOP - */ - AUTO_SCROLL_STOP_MODE = OUTLINE + 4, - - /* - * @brief The line count of text. - * @details name "lineCount", type int - * @node this property is read-only. - */ - LINE_COUNT = OUTLINE + 5, - - /** - * @brief line wrap mode when the text lines over layout width. - * @details name "lineWrapMode", type string. - */ - LINE_WRAP_MODE = OUTLINE + 6, - - /* - * @brief Animatable text color - * @details text color property to use if required to animate the text color - */ - TEXT_COLOR_ANIMATABLE = ANIMATABLE_PROPERTY_START_INDEX - + RENDERING_BACKEND = Dali::Toolkit::TextLabel::Property::RENDERING_BACKEND, + TEXT = Dali::Toolkit::TextLabel::Property::TEXT, + FONT_FAMILY = Dali::Toolkit::TextLabel::Property::FONT_FAMILY, + FONT_STYLE = Dali::Toolkit::TextLabel::Property::FONT_STYLE, + POINT_SIZE = Dali::Toolkit::TextLabel::Property::POINT_SIZE, + MULTI_LINE = Dali::Toolkit::TextLabel::Property::MULTI_LINE, + HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, + VERTICAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, + UNUSED_PROPERTY_TEXT_COLOR = Dali::Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR, + SHADOW_OFFSET = Dali::Toolkit::TextLabel::Property::SHADOW_OFFSET, + SHADOW_COLOR = Dali::Toolkit::TextLabel::Property::SHADOW_COLOR, + UNDERLINE_ENABLED = Dali::Toolkit::TextLabel::Property::UNDERLINE_ENABLED, + UNDERLINE_COLOR = Dali::Toolkit::TextLabel::Property::UNDERLINE_COLOR, + UNDERLINE_HEIGHT = Dali::Toolkit::TextLabel::Property::UNDERLINE_HEIGHT, + ENABLE_MARKUP = Dali::Toolkit::TextLabel::Property::ENABLE_MARKUP, + ENABLE_AUTO_SCROLL = Dali::Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL, + AUTO_SCROLL_SPEED = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED, + AUTO_SCROLL_LOOP_COUNT = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT, + AUTO_SCROLL_GAP = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_GAP, + LINE_SPACING = Dali::Toolkit::TextLabel::Property::LINE_SPACING, + UNDERLINE = Dali::Toolkit::TextLabel::Property::UNDERLINE, + SHADOW = Dali::Toolkit::TextLabel::Property::SHADOW, + EMBOSS = Dali::Toolkit::TextLabel::Property::EMBOSS, + OUTLINE = Dali::Toolkit::TextLabel::Property::OUTLINE, + PIXEL_SIZE = Dali::Toolkit::TextLabel::Property::PIXEL_SIZE, + ELLIPSIS = Dali::Toolkit::TextLabel::Property::ELLIPSIS, + AUTO_SCROLL_LOOP_DELAY = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY, + AUTO_SCROLL_STOP_MODE = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE, + LINE_COUNT = Dali::Toolkit::TextLabel::Property::LINE_COUNT, + LINE_WRAP_MODE = Dali::Toolkit::TextLabel::Property::LINE_WRAP_MODE, + + /** + * @brief The direction of the layout. + * @details Name "textDirection", type [Type](@ref Dali::Toolkit::DevelText::TextDirection::Type) (Property::INTEGER), Read/Write + * @note The text direction can be changed only by replacing the text itself. + * @see TextDirection::Type for supported values. + */ + TEXT_DIRECTION, + + /** + * @brief Alignment of text within area of single line + * @details Name "verticalLineAlignment", type [Type](@ref Dali::Toolkit::DevelText::VerticalLineAlignment::Type) (Property::INTEGER), Read/Write + * @note The default value is TOP + * @see VerticalLineAlignment::Type for supported values + */ + VERTICAL_LINE_ALIGNMENT, + + /** + * @brief The default text background parameters. + * @details Name "textBackground", type Property::MAP. + * @note Use "textBackground" as property name to avoid conflict with Control's "background" property + * + * The background map contains the following keys: + * + * | %Property Name | Type | Required | Description | + * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| + * | enable | BOOLEAN | No | True to enable the background or false to disable (the default value is false) | + * | color | VECTOR4 | No | The color of the background (the default value is Color::CYAN) | + */ + BACKGROUND, + + /** + * @brief Ignore spaces after text. + * @details Name "ignoreSpacesAfterText", type (Property::BOLEAN), Read/Write + * @note The default value is true + */ + IGNORE_SPACES_AFTER_TEXT, }; -} // namespace Property -/** -* @brief The type for TextLabel::Property::AUTO_SCROLL_STOP_MODE -*/ -namespace AutoScrollStopMode -{ -/** -* @ref Dali::Toolkit::DevelTextLabel::AutoScrollStopMode -*/ -enum Type -{ - FINISH_LOOP = 0, ///< stop animation after current loop finished. - IMMEDIATE ///< stop animation immediatly and reset position. -}; -} // namespace AutoScrollStopMode +} // namespace Property -} // namespace DevelText +} // namespace DevelTextLabel } // namespace Toolkit