X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Ftext-controls%2Ftext-label-devel.h;h=dfcd279226e894be1924329e1ff4ac585c4df43d;hb=f5e86ed8fd10a19aaeac4be8703887ffa24fcf7f;hp=40c6c70a5e2d97f06093923ec0619f95ceb94c53;hpb=0e07671d24b10bd49423ec6ce22817000bb18336;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 40c6c70..dfcd279 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 @@ -30,59 +30,127 @@ 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. - * @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, + /////////////////////////////////////////////////////////////////////////////// + // Event side (non-animatable) properties + /////////////////////////////////////////////////////////////////////////////// + + 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. + * @details Name "pixelSize", type Property::FLOAT. + * Conversion from Point size to Pixel size: + * Pixel size = Point size * DPI / 72 + */ + PIXEL_SIZE = OUTLINE + 1, + + /** + * @brief Enable or disable the ellipsis. + * @details Name "ellipsis", type Property::BOOLEAN. + */ + ELLIPSIS = OUTLINE + 2, + + /** + * @brief delay starting time of auto scrolling and further loops + * @details Name "autoScrollLoopDelay", type Property::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, default 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 Property::STRING. + */ + LINE_WRAP_MODE = OUTLINE + 6, + + /////////////////////////////////////////////////////////////////////////////// + // Animatable Properties + /////////////////////////////////////////////////////////////////////////////// + + /* + * @brief Animatable text color. + * @details Name "textColorAnimatable", type Property::VECTOR4. + * Text color property to use if required to animate the text color. + */ + TEXT_COLOR_ANIMATABLE = ANIMATABLE_PROPERTY_START_INDEX, + + /** + * @brief The red component of the text color. + * @details Name "textColorRed", type Property::FLOAT. + * @see TEXT_COLOR_ANIMATABLE + */ + TEXT_COLOR_RED = ANIMATABLE_PROPERTY_START_INDEX + 1, + + /** + * @brief The green component of the text color. + * @details Name "textColorGreen", type Property::FLOAT. + * @see TEXT_COLOR_ANIMATABLE + */ + TEXT_COLOR_GREEN = ANIMATABLE_PROPERTY_START_INDEX + 2, + + /** + * @brief The blue component of the text color. + * @details Name "textColorBlue", type Property::FLOAT. + * @see TEXT_COLOR_ANIMATABLE + */ + TEXT_COLOR_BLUE = ANIMATABLE_PROPERTY_START_INDEX + 3, + + /** + * @brief The alpha component of the text color. + * @details Name "textColorAlpha", type Property::FLOAT. + * @see TEXT_COLOR_ANIMATABLE + */ + TEXT_COLOR_ALPHA = ANIMATABLE_PROPERTY_START_INDEX + 4, }; } // namespace Property