-#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) 2020 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.
* @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 |
*
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API TextLabel : public Control
+class DALI_TOOLKIT_API TextLabel : public Control
{
public:
///////////////////////////////////////////////////////////////////////////////
/**
- * @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 Property::INT.
- * @SINCE_1_0.0
- */
- RENDERING_BACKEND = PROPERTY_START_INDEX,
-
- /**
* @brief The text to display in UTF-8 format.
* @details Name "text", type Property::STRING.
* @SINCE_1_0.0
*/
- TEXT,
+ TEXT = PROPERTY_START_INDEX,
/**
* @brief The requested font family to use.
VERTICAL_ALIGNMENT,
/**
- * @DEPRECATED_1_2.60 Use the new enum value of TEXT_COLOR instead.
- * @brief The color of the text.
- * @details Name "unusedPropertyTextColor", type Property::VECTOR4.
- * @SINCE_1_0.0
- */
- 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.
- */
- SHADOW_OFFSET,
-
- /**
- * @DEPRECATED_1_1.37 Use SHADOW instead
- * @brief The color of a drop shadow.
- * @details Name "shadowColor", type Property::VECTOR4
- */
- SHADOW_COLOR,
-
- /**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief The underline enabled flag.
- * @details Name "underlineEnabled", type Property::BOOLEAN.
- */
- UNDERLINE_ENABLED,
-
- /**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief The color of the underline.
- * @details Name "underlineColor", type Property::VECTOR4.
- */
- UNDERLINE_COLOR,
-
- /**
- * @DEPRECATED_1_1.37 Use UNDERLINE instead
- * @brief Overrides the underline height from font metrics.
- * @details Name "underlineHeight", type Property::FLOAT.
- */
- UNDERLINE_HEIGHT,
-
- /**
* @brief Whether the mark-up processing is enabled.
* @details Name "enableMarkup", type Property::BOOLEAN.
* @SINCE_1_0.0
/**
* @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
TextLabel( const TextLabel& handle );
/**
+ * @brief Move constructor
+ * @SINCE_1_9.23
+ *
+ * @param[in] rhs A reference to the moved handle
+ */
+ TextLabel( TextLabel&& rhs );
+
+ /**
* @brief Assignment operator.
*
* @SINCE_1_0.0
TextLabel& operator=( const TextLabel& handle );
/**
+ * @brief Move assignment
+ * @SINCE_1_9.23
+ *
+ * @param[in] rhs A reference to the moved handle
+ * @return A reference to this
+ */
+ TextLabel& operator=( TextLabel&& rhs );
+
+ /**
* @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_LABEL_H__
+#endif // DALI_TOOLKIT_TEXT_LABEL_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff