X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-label.h;h=7153d3adbb32705bd8d1db2030aec6ea8d434ef8;hb=cb1a9e02b309e48b8599fa7bb34ab7856fb823e7;hp=7ecb200d7e8f019cba1ea3bfc195694afe55d5b2;hpb=56d412791a44c2a79135d2293c13fddb135c9d54;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 7ecb200..7153d3a 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -31,11 +31,16 @@ 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. + * @SINCE_1_0.0 */ class DALI_IMPORT_API TextLabel : public Control { @@ -43,39 +48,48 @@ public: /** * @brief 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. + * @SINCE_1_0.0 */ struct Property { 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 + RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0 + TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_0.0 + FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0 + FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0 + POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_0.0 + MULTI_LINE, ///< name "multiLine", The single-line or multi-line layout option, type BOOLEAN @SINCE_1_0.0 + HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_0.0 + VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0 + TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_0.0 + SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2 @SINCE_1_0.0 + SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4 @SINCE_1_0.0 + UNDERLINE_ENABLED, ///< name "underlineEnabled", The underline enabled flag, type BOOLEAN @SINCE_1_0.0 + UNDERLINE_COLOR, ///< name "underlineColor", The color of the underline, type VECTOR4 @SINCE_1_0.0 + UNDERLINE_HEIGHT, ///< name "underlineHeight", Overrides the underline height from font metrics, type FLOAT @SINCE_1_0.0 + ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0 + ENABLE_AUTO_SCROLL, ///< name "enableAutoScroll", Whether to start auto text scrolling type BOOLEAN @SINCE_1_1.35 + AUTO_SCROLL_SPEED, ///< name "autoScrollSpeed", Speed at which text should auto scroll type INT @SINCE_1_1.35 + AUTO_SCROLL_LOOP_COUNT, ///< name "autoScrollLoopCount", Number of times the text should scroll (loop) type INT @SINCE_1_1.35 + AUTO_SCROLL_GAP ///< name "autoScrollGap", Gap before text wraps around when scrolling type FLOAT @SINCE_1_1.35 }; }; /** * @brief Create the TextLabel control. * + * @SINCE_1_0.0 * @return A handle to the TextLabel control. */ static TextLabel New(); @@ -83,6 +97,7 @@ public: /** * @brief Create the TextLabel control. * + * @SINCE_1_0.0 * @param[in] text The text to display. * @return A handle to the TextLabel control. */ @@ -90,12 +105,14 @@ public: /** * @brief Creates an empty handle. + * @SINCE_1_0.0 */ TextLabel(); /** * @brief Copy constructor. * + * @SINCE_1_0.0 * @param[in] handle The handle to copy from. */ TextLabel( const TextLabel& handle ); @@ -103,6 +120,7 @@ public: /** * @brief Assignment operator. * + * @SINCE_1_0.0 * @param[in] handle The handle to copy from. * @return A reference to this. */ @@ -112,6 +130,7 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~TextLabel(); @@ -121,6 +140,7 @@ public: * 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 */ @@ -131,6 +151,7 @@ public: // Not intended for application developers /** * @brief Creates a handle using the Toolkit::Internal implementation. * + * @SINCE_1_0.0 * @param[in] implementation The Control implementation. */ DALI_INTERNAL TextLabel( Internal::TextLabel& implementation ); @@ -138,11 +159,15 @@ public: // Not intended for application developers /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * + * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali