-#ifndef __DALI_TOOLKIT_TEXT_LABEL_H__
-#define __DALI_TOOLKIT_TEXT_LABEL_H__
+#ifndef DALI_TOOLKIT_TEXT_LABEL_H
+#define DALI_TOOLKIT_TEXT_LABEL_H
/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
*
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API TextLabel : public Control
+class DALI_TOOLKIT_API TextLabel : public Control
{
public:
/**
* @brief The line horizontal alignment.
- * @details Name "horizontalAlignment", type Property::STRING
+ * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
* Values "BEGIN", "CENTER", "END", default BEGIN.
+ * @note Return type is Property::STRING
* @SINCE_1_0.0
*/
HORIZONTAL_ALIGNMENT,
/**
* @brief The line vertical alignment.
- * @details Name "verticalAlignment", type Property::STRING.
+ * @details Name "verticalAlignment", type Property::STRING or type VerticalAlignment::Type (Property::INTEGER).
* Values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP.
+ * @note Return type is Property::STRING
* @SINCE_1_0.0
*/
VERTICAL_ALIGNMENT,
UNUSED_PROPERTY_TEXT_COLOR,
/**
- * @DEPRECATED_1_1.37 Use SHADOW instead
- * @brief The drop shadow offset 0 indicates no shadow.
- * @details Name "shadowOffset", type Property::VECTOR2.
+ * @brief This property is removed because it's deprecated.
*/
- SHADOW_OFFSET,
+ RESERVED_PROPERTY_01,
/**
- * @DEPRECATED_1_1.37 Use SHADOW instead
- * @brief The color of a drop shadow.
- * @details Name "shadowColor", type Property::VECTOR4
+ * @brief This property is removed because it's deprecated.
*/
- SHADOW_COLOR,
+ RESERVED_PROPERTY_02,
/**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief The underline enabled flag.
- * @details Name "underlineEnabled", type Property::BOOLEAN.
+ * @brief This property is removed because it's deprecated.
*/
- UNDERLINE_ENABLED,
+ RESERVED_PROPERTY_03,
/**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief The color of the underline.
- * @details Name "underlineColor", type Property::VECTOR4.
+ * @brief This property is removed because it's deprecated.
*/
- UNDERLINE_COLOR,
+ RESERVED_PROPERTY_04,
/**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief Overrides the underline height from font metrics.
- * @details Name "underlineHeight", type Property::FLOAT.
+ * @brief This property is removed because it's deprecated.
*/
- UNDERLINE_HEIGHT,
+ RESERVED_PROPERTY_05,
/**
* @brief Whether the mark-up processing is enabled.
* @details Name "autoScrollGap", type Property::INT.
* @SINCE_1_1.35
* @note Default in style sheet but can be overridden to prevent same text being shown at start and end.
+ * @note Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE).
*/
AUTO_SCROLL_GAP,
/**
* @brief The default underline parameters.
* @details Name "underline", type Property::MAP.
+ *
+ * The underline map contains the following keys:
+ *
+ * | %Property Name | Type | Required | Description |
+ * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
+ * | enable | BOOLEAN | No | True to enable the underline or false to disable (the default value is false) |
+ * | color | VECTOR4 | No | The color of the underline (the default value is Color::BLACK) |
+ * | height | FLOAT | No | The height of the underline (the default value is 0) |
+ *
* @SINCE_1_2.13
*/
UNDERLINE,
/**
* @brief The default shadow parameters.
* @details Name "shadow", type Property::MAP.
+ *
+ * The shadow map contains the following keys:
+ *
+ * | %Property Name | Type | Required | Description |
+ * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
+ * | color | VECTOR4 | No | The color of the shadow (the default value is Color::BLACK) |
+ * | offset | VECTOR2 | No | The offset from the text to draw the shadow in the X and Y axes (the default value is 0 which means no shadow) |
+ * | blurRadius | FLOAT | No | The radius of blur to be applied to the shadow (the default value is 0 which means no blur) |
+ *
* @SINCE_1_2.13
*/
SHADOW,
/**
* @brief The default outline parameters.
* @details Name "outline", type Property::MAP.
+ *
+ * The outline map contains the following keys:
+ *
+ * | %Property Name | Type | Required | Description |
+ * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
+ * | color | VECTOR4 | No | The color of the outline (the default value is Color::WHITE) |
+ * | width | INTEGER | No | The width of the outline (the default value is 0 which means no outline) |
+ *
* @SINCE_1_2.13
*/
OUTLINE,
*/
AUTO_SCROLL_STOP_MODE,
- /*
+ /**
* @brief The line count of text.
* @details name "lineCount", type Property::INTEGER.
* @SINCE_1_2.60
/**
* @brief Line wrap mode when text lines are greater than the layout width.
- * @details Name "lineWrapMode", type Property::STRING.
+ * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
* @SINCE_1_2.60
+ * @note Default is Text::LineWrap::WORD.
+ * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
+ * @see Text::LineWrap
*/
LINE_WRAP_MODE,
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_LABEL_H__
+#endif // DALI_TOOLKIT_TEXT_LABEL_H