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=592cfeddaa40bce633832b3a0c9e94541c07248b;hp=00398b3ebf2c9e0cf62bd4db32e7f74904d804fa;hb=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;hpb=0f334da9864bfa409a54c6b52ec99904eb483dc4 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 00398b3..592cfed 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,6 +31,10 @@ namespace Internal DALI_INTERNAL { class TextLabel; } +/** + * @addtogroup dali-toolkit-controls-text-controls + * @{ + */ /** * @brief A control which renders a short text string. @@ -42,23 +45,55 @@ class DALI_IMPORT_API TextLabel : public Control { public: - // Property indices - static const Property::Index PROPERTY_RENDERING_BACKEND; ///< name "rendering-backend", type INT - static const Property::Index PROPERTY_TEXT; ///< name "text", type STRING - static const Property::Index PROPERTY_MULTI_LINE; ///< name "multi-line", type BOOLEAN + /** + * @brief The start and end property ranges for this control. + */ + enum PropertyRange + { + PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices + }; - // 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. + */ + 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 + UNDERLINE_HEIGHT ///< name "underline-height", Overrides the underline height from font metrics, type FLOAT + }; + }; /** - * Create the TextLabel control. + * @brief Create the TextLabel control. + * * @return A handle to the TextLabel control. */ static TextLabel New(); /** + * @brief Create the TextLabel control. + * + * @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. */ TextLabel(); @@ -113,6 +148,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali