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=e1f69c01098b685d65d6f025345cf99c474d8ef9;hpb=297b1b9a9b6ed72fe98d5afb018ff4d1c951ce7d;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 e1f69c0..7153d3a 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -20,7 +20,6 @@ // INTERNAL INCLUDES #include -#include namespace Dali { @@ -32,40 +31,88 @@ 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 { public: - // Property indices - static const Dali::Property::Index PROPERTY_RENDERING_BACKEND; ///< name "rendering-backend", type INT - static const Dali::Property::Index PROPERTY_TEXT; ///< name "text", type STRING - static const Dali::Property::Index PROPERTY_MULTI_LINE; ///< name "multi-line", type BOOLEAN + /** + * @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, ///< @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0 + }; - // Property names - static const std::string RENDERING_BACKEND_PROPERTY_NAME; ///< Property, name "rendering-backend", type INT - static const std::string TEXT_PROPERTY_NAME; ///< Property, name "text", type STRING - static const std::string MULTI_LINE_PROPERTY_NAME; ///< Property, name "multi-line", type BOOLEAN + /** + * @brief An enumeration of properties belonging to the TextLabel class. + * @SINCE_1_0.0 + */ + struct Property + { + enum + { + 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 + }; + }; /** - * Create the TextLabel control. + * @brief Create the TextLabel control. + * + * @SINCE_1_0.0 * @return A handle to the TextLabel control. */ static TextLabel New(); /** + * @brief Create 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. * + * @SINCE_1_0.0 * @param[in] handle The handle to copy from. */ TextLabel( const TextLabel& handle ); @@ -73,6 +120,7 @@ public: /** * @brief Assignment operator. * + * @SINCE_1_0.0 * @param[in] handle The handle to copy from. * @return A reference to this. */ @@ -82,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(); @@ -91,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 */ @@ -101,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 ); @@ -108,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