X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-label.h;h=df0abce62d686e6f83f05654a9d2c927a2cd1069;hp=7ecb200d7e8f019cba1ea3bfc195694afe55d5b2;hb=3a23cbcd64ab5780928e4a141e497242c9989110;hpb=56d412791a44c2a79135d2293c13fddb135c9d54 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 7ecb200..df0abce 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) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -31,118 +31,322 @@ namespace Internal DALI_INTERNAL { class TextLabel; } +/** + * @addtogroup dali_toolkit_controls_text_controls + * @{ + */ /** * @brief A control which renders a short text string. * * Text labels are lightweight, non-editable and do not respond to user input. + * + * @section TextLabelProperties Properties + * |%Property enum |String name |Type |Writable|Animatable| + * |----------------------------------|---------------------|----------------|--------|----------| + * | Property::RENDERING_BACKEND | renderingBackend | INTEGER | O | X | + * | Property::TEXT | text | STRING | O | X | + * | Property::FONT_FAMILY | fontFamily | STRING | O | X | + * | Property::FONT_STYLE | fontStyle | STRING or MAP | O | X | + * | Property::POINT_SIZE | pointSize | FLOAT | O | X | + * | Property::MULTI_LINE | multiLine | BOOLEAN | O | X | + * | Property::HORIZONTAL_ALIGNMENT | horizontalAlignment | STRING | O | X | + * | Property::VERTICAL_ALIGNMENT | verticalAlignment | STRING | O | X | + * | Property::TEXT_COLOR | textColor | VECTOR4 | O | X | + * | Property::ENABLE_MARKUP | enableMarkup | BOOLEAN | O | X | + * | Property::ENABLE_AUTO_SCROLL | enableAutoScroll | BOOLEAN | O | X | + * | Property::AUTO_SCROLL_SPEED | autoScrollSpeed | INTEGER | O | X | + * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount | INTEGER | O | X | + * | Property::AUTO_SCROLL_GAP | autoScrollGap | INTEGER | O | X | + * | Property::SHADOW | shadow | STRING or MAP | O | X | + * | Property::UNDERLINE | underline | STRING or MAP | O | X | + * + * @SINCE_1_0.0 */ class DALI_IMPORT_API TextLabel : public Control { public: /** - * @brief The start and end property ranges for this control. + * @brief Enumeration for the start and end property ranges for this control. + * @SINCE_1_0.0 */ enum PropertyRange { - PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices + 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 }; /** - * @brief An enumeration of properties belonging to the TextLabel class. + * @brief Enumeration for the instance of properties belonging to the TextLabel class. + * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the TextLabel class. + * @SINCE_1_0.0 + */ enum { - RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend", The type or rendering e.g. bitmap-based, type INT - TEXT, ///< name "text", The text to display in UTF-8 format, type STRING - FONT_FAMILY, ///< name "font-family", The requested font family, type STRING - FONT_STYLE, ///< name "font-style", The requested font style e.g. Regular/Italic, type STRING - POINT_SIZE, ///< name "point-size", The size of font in points, type FLOAT - MULTI_LINE, ///< name "multi-line", The single-line or multi-line layout option, type BOOLEAN - HORIZONTAL_ALIGNMENT, ///< name "horizontal-alignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" - VERTICAL_ALIGNMENT, ///< name "vertical-alignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" - TEXT_COLOR, ///< name "text-color", The text color, type VECTOR4 - SHADOW_OFFSET, ///< name "shadow-offset", The drop shadow offset 0 indicates no shadow, type VECTOR2 - SHADOW_COLOR, ///< name "shadow-color", The color of a drop shadow, type VECTOR4 - UNDERLINE_ENABLED, ///< name "underline-enabled", The underline enabled flag type BOOLEAN - UNDERLINE_COLOR, ///< name "underline-color", The color of the underline type VECTOR4 + /** + * DEPRECATED_1_2.53 No longer be supported and will be ignored. + * @brief The type of rendering e.g. bitmap-based. + * @details name "renderingBackend", type INT, default RENDERING_SHARED_ATLAS. + * @SINCE_1_0.0 + */ + RENDERING_BACKEND = PROPERTY_START_INDEX, + + /** + * @brief The text to display in UTF-8 format. + * @details name "text", type STRING. + * @SINCE_1_0.0 + */ + TEXT, + + /** + * @brief The requested font family to use. + * @details name "fontFamily", type STRING. + * @SINCE_1_0.0 + */ + FONT_FAMILY, + + /** + * @brief The requested font style to use. + * @details name "fontStyle", type STRING or MAP. + * @SINCE_1_2.13 + */ + FONT_STYLE, + + /** + * @brief The size of font in points. + * + * Conversion from Pixel size to Point size : + * Point size = Pixel size * 72 / DPI + * @details name "pointSize", type FLOAT. + * @SINCE_1_0.0 + */ + POINT_SIZE, + + /** + * @brief The single-line or multi-line layout option. + * @details name "multiLine", type BOOLEAN, default false. + * @SINCE_1_0.0 + */ + MULTI_LINE, + + /** + * @brief The line horizontal alignment. + * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN. + * @SINCE_1_0.0 + */ + HORIZONTAL_ALIGNMENT, + + /** + * @brief The line vertical alignment. + * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP. + * @SINCE_1_0.0 + */ + VERTICAL_ALIGNMENT, + + /** + * @brief The color of the text. + * @details name "textColor", type VECTOR4. + * @SINCE_1_0.0 + */ + TEXT_COLOR, + + /** + * @DEPRECATED_1_1.37 Use SHADOW instead + * @brief The drop shadow offset 0 indicates no shadow. + * @details name "shadowOffset", type VECTOR2. + */ + SHADOW_OFFSET, + + /** + * @DEPRECATED_1_1.37 Use SHADOW instead + * @brief The color of a drop shadow. + * @details name "shadowColor", type VECTOR4 + */ + SHADOW_COLOR, + + /** + * @DEPRECATED_1_1.37 Use UNDERLINE instead + * @brief The underline enabled flag. + * @details name "underlineEnabled", type BOOLEAN. + */ + UNDERLINE_ENABLED, + + /** + * @DEPRECATED_1_1.37 Use UNDERLINE instead + * @brief The color of the underline. + * @details name "underlineColor", type VECTOR4. + */ + UNDERLINE_COLOR, + + /** + * @DEPRECATED_1_1.37 Use UNDERLINE instead + * @brief Overrides the underline height from font metrics. + * @details name "underlineHeight", type FLOAT. + */ + UNDERLINE_HEIGHT, + + /** + * @brief Whether the mark-up processing is enabled. + * @details name "enableMarkup", type BOOLEAN. + * @SINCE_1_0.0 + */ + ENABLE_MARKUP, + + /** + * @brief Starts or stops auto scrolling. + * @details name "enableAutoScroll", type BOOLEAN, default is false. + * @SINCE_1_1.35 + */ + ENABLE_AUTO_SCROLL, + + /** + * @brief Sets the speed of scrolling in pixels per second. + * @details name "autoScrollSpeed", type INT, default in style sheet. + * @SINCE_1_1.35 + */ + AUTO_SCROLL_SPEED, + + /** + * @brief Number of complete loops when scrolling enabled. + * @details name "autoScrollLoopCount", type INT, default in style sheet. + * @SINCE_1_1.35 + */ + AUTO_SCROLL_LOOP_COUNT, + + /** + * @brief Gap before scrolling wraps. + * @details name "autoScrollGap", type INT, default in style sheet but can be overridden to prevent same text being shown at start and end. + * @SINCE_1_1.35 + */ + AUTO_SCROLL_GAP, + + /** + * @brief The default extra space between lines in points. + * @details name "lineSpacing", type FLOAT. + * @SINCE_1_1.37 + */ + LINE_SPACING, + + /** + * @brief The default underline parameters. + * @details name "underline", type MAP. + * @SINCE_1_2.13 + */ + UNDERLINE, + + /** + * @brief The default shadow parameters. + * @details name "shadow", type MAP. + * @SINCE_1_2.13 + */ + SHADOW, + + /** + * @brief The default emboss parameters. + * @details name "emboss", type MAP. + * @SINCE_1_2.13 + */ + EMBOSS, + + /** + * @brief The default outline parameters. + * @details name "outline", type MAP. + * @SINCE_1_2.13 + */ + OUTLINE, }; }; /** - * @brief Create the TextLabel control. + * @brief Creates the TextLabel control. * - * @return A handle to the TextLabel control. + * @SINCE_1_0.0 + * @return A handle to the TextLabel control */ static TextLabel New(); /** - * @brief Create the TextLabel control. + * @brief Creates the TextLabel control. * - * @param[in] text The text to display. - * @return A handle to the TextLabel control. + * @SINCE_1_0.0 + * @param[in] text The text to display + * @return A handle to the TextLabel control */ static TextLabel New( const std::string& text ); /** * @brief Creates an empty handle. + * @SINCE_1_0.0 */ TextLabel(); /** * @brief Copy constructor. * - * @param[in] handle The handle to copy from. + * @SINCE_1_0.0 + * @param[in] handle The handle to copy from */ TextLabel( const TextLabel& handle ); /** * @brief Assignment operator. * - * @param[in] handle The handle to copy from. - * @return A reference to this. + * @SINCE_1_0.0 + * @param[in] handle The handle to copy from + * @return A reference to this */ TextLabel& operator=( const TextLabel& handle ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~TextLabel(); /** - * @brief Downcast a handle to TextLabel. + * @brief Downcasts a handle to TextLabel. * - * If the BaseHandle points is a TextLabel the downcast returns a valid handle. - * If not the returned handle is left empty. + * If the BaseHandle points is a TextLabel, the downcast returns a valid handle. + * If not, the returned handle is left empty. * + * @SINCE_1_0.0 * @param[in] handle Handle to an object - * @return handle to a TextLabel or an empty handle + * @return Handle to a TextLabel or an empty handle */ static TextLabel DownCast( BaseHandle handle ); public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * - * @param[in] implementation The Control implementation. + * @SINCE_1_0.0 + * @param[in] implementation The Control implementation */ DALI_INTERNAL TextLabel( Internal::TextLabel& implementation ); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * - * @param[in] internal A pointer to the internal CustomActor. + * @SINCE_1_0.0 + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali