dali-toolkit/public-api/controls/text-controls/text-label.h

   1 #ifndef DALI_TOOLKIT_TEXT_LABEL_H
   2 #define DALI_TOOLKIT_TEXT_LABEL_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextLabel;
  33 }
  34 /**
  35  * @addtogroup dali_toolkit_controls_text_controls
  36  * @{
  37  */
  38
  39 /**
  40  * @brief A control which renders a short text string.
  41  *
  42  * Text labels are lightweight, non-editable and do not respond to user input.
  43  *
  44  * @section TextLabelProperties Properties
  45  * |%Property enum                    |String name          |Type            |Writable|Animatable|
  46  * |----------------------------------|---------------------|----------------|--------|----------|
  47  * | Property::RENDERING_BACKEND      | renderingBackend    |  INTEGER       | O      | X        |
  48  * | Property::TEXT                   | text                |  STRING        | O      | X        |
  49  * | Property::FONT_FAMILY            | fontFamily          |  STRING        | O      | X        |
  50  * | Property::FONT_STYLE             | fontStyle           |  STRING or MAP | O      | X        |
  51  * | Property::POINT_SIZE             | pointSize           |  FLOAT         | O      | X        |
  52  * | Property::MULTI_LINE             | multiLine           |  BOOLEAN       | O      | X        |
  53  * | Property::HORIZONTAL_ALIGNMENT   | horizontalAlignment |  STRING        | O      | X        |
  54  * | Property::VERTICAL_ALIGNMENT     | verticalAlignment   |  STRING        | O      | X        |
  55  * | Property::TEXT_COLOR             | textColor           |  VECTOR4       | O      | X        |
  56  * | Property::ENABLE_MARKUP          | enableMarkup        |  BOOLEAN       | O      | X        |
  57  * | Property::ENABLE_AUTO_SCROLL     | enableAutoScroll    |  BOOLEAN       | O      | X        |
  58  * | Property::AUTO_SCROLL_SPEED      | autoScrollSpeed     |  INTEGER       | O      | X        |
  59  * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount |  INTEGER       | O      | X        |
  60  * | Property::AUTO_SCROLL_GAP        | autoScrollGap       |  INTEGER       | O      | X        |
  61  * | Property::SHADOW                 | shadow              |  STRING or MAP | O      | X        |
  62  * | Property::UNDERLINE              | underline           |  STRING or MAP | O      | X        |
  63  *
  64  * @SINCE_1_0.0
  65  */
  66 class DALI_TOOLKIT_API TextLabel : public Control
  67 {
  68 public:
  69
  70   /**
  71    * @brief Enumeration for the start and end property ranges for this control.
  72    * @SINCE_1_0.0
  73    */
  74   enum PropertyRange
  75   {
  76     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
  77     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000,             ///< Reserve property indices @SINCE_1_0.0
  78
  79     ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_2.60
  80     ANIMATABLE_PROPERTY_END_INDEX =   ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_2.60
  81   };
  82
  83   /**
  84    * @brief Enumeration for the instance of properties belonging to the TextLabel class.
  85    * @SINCE_1_0.0
  86    */
  87   struct Property
  88   {
  89     /**
  90      * @brief Enumeration for the instance of properties belonging to the TextLabel class.
  91      * @SINCE_1_0.0
  92      */
  93     enum
  94     {
  95       ///////////////////////////////////////////////////////////////////////////////
  96       // Event side (non-animatable) properties
  97       ///////////////////////////////////////////////////////////////////////////////
  98
  99       /**
 100        * @DEPRECATED_1_2.53 No longer be supported and will be ignored.
 101        * @brief The type of rendering e.g. bitmap-based.
 102        * @details Name "renderingBackend", type Property::INT.
 103        * @SINCE_1_0.0
 104        */
 105       RENDERING_BACKEND = PROPERTY_START_INDEX,
 106
 107       /**
 108        * @brief The text to display in UTF-8 format.
 109        * @details Name "text", type Property::STRING.
 110        * @SINCE_1_0.0
 111        */
 112       TEXT,
 113
 114       /**
 115        * @brief The requested font family to use.
 116        * @details Name "fontFamily", type Property::STRING.
 117        * @SINCE_1_0.0
 118        */
 119       FONT_FAMILY,
 120
 121       /**
 122        * @brief The requested font style to use.
 123        * @details Name "fontStyle", type Property::STRING or Property::MAP.
 124        * @SINCE_1_2.13
 125        */
 126       FONT_STYLE,
 127
 128       /**
 129        * @brief The size of font in points.
 130        * @details Name "pointSize", type Property::FLOAT.
 131        *          Conversion from Pixel size to Point size:
 132        *           Point size = Pixel size * 72 / DPI
 133        * @SINCE_1_0.0
 134        */
 135       POINT_SIZE,
 136
 137       /**
 138        * @brief The single-line or multi-line layout option.
 139        * @details Name "multiLine", type Property::BOOLEAN.
 140        * @SINCE_1_0.0
 141        * @note Default is false.
 142        */
 143       MULTI_LINE,
 144
 145       /**
 146        * @brief The line horizontal alignment.
 147        * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
 148        *          Values "BEGIN", "CENTER", "END", default BEGIN.
 149        * @note Return type is Property::STRING
 150        * @SINCE_1_0.0
 151        */
 152       HORIZONTAL_ALIGNMENT,
 153
 154       /**
 155        * @brief The line vertical alignment.
 156        * @details Name "verticalAlignment", type Property::STRING or type VerticalAlignment::Type (Property::INTEGER).
 157        *          Values "TOP",   "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP.
 158        * @note Return type is Property::STRING
 159        * @SINCE_1_0.0
 160        */
 161       VERTICAL_ALIGNMENT,
 162
 163       /**
 164        * @brief Whether the mark-up processing is enabled.
 165        * @details Name "enableMarkup", type Property::BOOLEAN.
 166        * @SINCE_1_0.0
 167        * @note Default is false.
 168        */
 169       ENABLE_MARKUP,
 170
 171       /**
 172        * @brief Starts or stops auto scrolling.
 173        * @details Name "enableAutoScroll", type Property::BOOLEAN.
 174        * @SINCE_1_1.35
 175        * @note Default is false.
 176        */
 177       ENABLE_AUTO_SCROLL,
 178
 179       /**
 180        * @brief Sets the speed of scrolling in pixels per second.
 181        * @details Name "autoScrollSpeed", type Property::INT.
 182        * @SINCE_1_1.35
 183        * @note Default in style sheet.
 184        */
 185       AUTO_SCROLL_SPEED,
 186
 187       /**
 188        * @brief Number of complete loops when scrolling enabled.
 189        * @details Name "autoScrollLoopCount", type Property::INT.
 190        * @SINCE_1_1.35
 191        * @note Default in style sheet.
 192        */
 193       AUTO_SCROLL_LOOP_COUNT,
 194
 195       /**
 196        * @brief Gap before scrolling wraps.
 197        * @details Name "autoScrollGap", type Property::INT.
 198        * @SINCE_1_1.35
 199        * @note Default in style sheet but can be overridden to prevent same text being shown at start and end.
 200        * @note Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE).
 201        */
 202       AUTO_SCROLL_GAP,
 203
 204       /**
 205        * @brief The default extra space between lines in points.
 206        * @details Name "lineSpacing", type Property::FLOAT.
 207        * @SINCE_1_1.37
 208        */
 209       LINE_SPACING,
 210
 211       /**
 212        * @brief The default underline parameters.
 213        * @details Name "underline", type Property::MAP.
 214        *
 215        * The underline map contains the following keys:
 216        *
 217        * | %Property Name       | Type     | Required | Description                                                                                                        |
 218        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 219        * | enable               | BOOLEAN  | No       | True to enable the underline or false to disable (the default value is false)                                      |
 220        * | color                | VECTOR4  | No       | The color of the underline (the default value is Color::BLACK)                                                     |
 221        * | height               | FLOAT    | No       | The height of the underline (the default value is 0)                                                               |
 222        *
 223        * @SINCE_1_2.13
 224        */
 225       UNDERLINE,
 226
 227       /**
 228        * @brief The default shadow parameters.
 229        * @details Name "shadow", type Property::MAP.
 230        *
 231        * The shadow map contains the following keys:
 232        *
 233        * | %Property Name       | Type     | Required | Description                                                                                                        |
 234        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 235        * | color                | VECTOR4  | No       | The color of the shadow (the default value is Color::BLACK)                                                        |
 236        * | 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)     |
 237        * | blurRadius           | FLOAT    | No       | The radius of blur to be applied to the shadow (the default value is 0 which means no blur)                        |
 238        *
 239        * @SINCE_1_2.13
 240        */
 241       SHADOW,
 242
 243       /**
 244        * @brief The default emboss parameters.
 245        * @details Name "emboss", type Property::MAP.
 246        * @SINCE_1_2.13
 247        */
 248       EMBOSS,
 249
 250       /**
 251        * @brief The default outline parameters.
 252        * @details Name "outline", type Property::MAP.
 253        *
 254        * The outline map contains the following keys:
 255        *
 256        * | %Property Name       | Type     | Required | Description                                                                                                        |
 257        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 258        * | color                | VECTOR4  | No       | The color of the outline (the default value is Color::WHITE)                                                       |
 259        * | width                | INTEGER  | No       | The width of the outline (the default value is 0 which means no outline)                                           |
 260        *
 261        * @SINCE_1_2.13
 262        */
 263       OUTLINE,
 264
 265       /**
 266        * @brief The size of font in pixels.
 267        * @details Name "pixelSize", type Property::FLOAT.
 268        *          Conversion from Point size to Pixel size:
 269        *            Pixel size = Point size * DPI / 72
 270        * @SINCE_1_2.60
 271        */
 272       PIXEL_SIZE,
 273
 274       /**
 275        * @brief Whether we should show the ellipsis if required.
 276        * @details Name "ellipsis", type Property::BOOLEAN.
 277        * @SINCE_1_2.60
 278        */
 279       ELLIPSIS,
 280
 281       /**
 282        * @brief The amount of time to delay the starting time of auto scrolling and further loops.
 283        * @details Name "autoScrollLoopDelay", type Property::FLOAT.
 284        * @SINCE_1_2.60
 285        */
 286       AUTO_SCROLL_LOOP_DELAY,
 287
 288       /**
 289        * @brief The auto scrolling stop behaviour.
 290        * @details Name "autoScrollStopMode", type AutoScrollStopMode::Type (Property::INTEGER) or Property::STRING.
 291        * @SINCE_1_2.60
 292        * @note Default is AutoScrollStopMode::FINISH_LOOP.
 293        * @see AutoScrollStopMode::Type
 294        */
 295       AUTO_SCROLL_STOP_MODE,
 296
 297       /**
 298        * @brief The line count of text.
 299        * @details name "lineCount", type Property::INTEGER.
 300        * @SINCE_1_2.60
 301        * @note This property is read-only.
 302        */
 303       LINE_COUNT,
 304
 305       /**
 306        * @brief Line wrap mode when text lines are greater than the layout width.
 307        * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
 308        * @SINCE_1_2.60
 309        * @note Default is Text::LineWrap::WORD.
 310        * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
 311        * @see Text::LineWrap
 312        */
 313       LINE_WRAP_MODE,
 314
 315       ///////////////////////////////////////////////////////////////////////////////
 316       // Animatable Properties
 317       ///////////////////////////////////////////////////////////////////////////////
 318
 319       /**
 320        * @brief The color of the text.
 321        * @details Name "textColor", type Property::VECTOR4.
 322        * @SINCE_1_2.60
 323        */
 324       TEXT_COLOR = ANIMATABLE_PROPERTY_START_INDEX,
 325
 326       /**
 327        * @brief The red component of the text color.
 328        * @details Name "textColorRed", type Property::FLOAT.
 329        * @SINCE_1_2.60
 330        * @see TEXT_COLOR
 331        */
 332       TEXT_COLOR_RED,
 333
 334       /**
 335        * @brief The green component of the text color.
 336        * @details Name "textColorGreen", type Property::FLOAT.
 337        * @SINCE_1_2.60
 338        * @see TEXT_COLOR
 339        */
 340       TEXT_COLOR_GREEN,
 341
 342       /**
 343        * @brief The blue component of the text color.
 344        * @details Name "textColorBlue", type Property::FLOAT.
 345        * @SINCE_1_2.60
 346        * @see TEXT_COLOR
 347        */
 348       TEXT_COLOR_BLUE,
 349
 350       /**
 351        * @brief The alpha component of the text color.
 352        * @details Name "textColorAlpha", type Property::FLOAT.
 353        * @SINCE_1_2.60
 354        * @see TEXT_COLOR
 355        */
 356       TEXT_COLOR_ALPHA,
 357     };
 358   };
 359
 360   /**
 361    * @brief The enumerations used for auto scroll stop mode.
 362    * @SINCE_1_2.60
 363    * @see Property::AUTO_SCROLL_STOP_MODE.
 364    */
 365   struct AutoScrollStopMode
 366   {
 367     /**
 368      * @brief The enumerations used for auto scroll stop mode.
 369      * @SINCE_1_2.60
 370      * @see Property::AUTO_SCROLL_STOP_MODE.
 371      */
 372     enum Type
 373     {
 374       FINISH_LOOP = 0,  ///< Stop animation after current loop finishes. @SINCE_1_2.60
 375       IMMEDIATE         ///< Stop animation immediately and reset position. @SINCE_1_2.60
 376     };
 377   };
 378
 379   /**
 380    * @brief Creates the TextLabel control.
 381    *
 382    * @SINCE_1_0.0
 383    * @return A handle to the TextLabel control
 384    */
 385   static TextLabel New();
 386
 387   /**
 388    * @brief Creates the TextLabel control.
 389    *
 390    * @SINCE_1_0.0
 391    * @param[in] text The text to display
 392    * @return A handle to the TextLabel control
 393    */
 394   static TextLabel New( const std::string& text );
 395
 396   /**
 397    * @brief Creates an empty handle.
 398    * @SINCE_1_0.0
 399    */
 400   TextLabel();
 401
 402   /**
 403    * @brief Copy constructor.
 404    *
 405    * @SINCE_1_0.0
 406    * @param[in] handle The handle to copy from
 407    */
 408   TextLabel( const TextLabel& handle );
 409
 410   /**
 411    * @brief Assignment operator.
 412    *
 413    * @SINCE_1_0.0
 414    * @param[in] handle The handle to copy from
 415    * @return A reference to this
 416    */
 417   TextLabel& operator=( const TextLabel& handle );
 418
 419   /**
 420    * @brief Destructor.
 421    *
 422    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 423    * @SINCE_1_0.0
 424    */
 425   ~TextLabel();
 426
 427   /**
 428    * @brief Downcasts a handle to TextLabel.
 429    *
 430    * If the BaseHandle points is a TextLabel, the downcast returns a valid handle.
 431    * If not, the returned handle is left empty.
 432    *
 433    * @SINCE_1_0.0
 434    * @param[in] handle Handle to an object
 435    * @return Handle to a TextLabel or an empty handle
 436    */
 437   static TextLabel DownCast( BaseHandle handle );
 438
 439 public: // Not intended for application developers
 440
 441   /// @cond internal
 442   /**
 443    * @brief Creates a handle using the Toolkit::Internal implementation.
 444    *
 445    * @SINCE_1_0.0
 446    * @param[in] implementation The Control implementation
 447    */
 448   DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
 449
 450   /**
 451    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 452    *
 453    * @SINCE_1_0.0
 454    * @param[in] internal A pointer to the internal CustomActor
 455    */
 456   explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
 457   /// @endcond
 458 };
 459
 460 /**
 461  * @}
 462  */
 463 } // namespace Toolkit
 464
 465 } // namespace Dali
 466
 467 #endif // DALI_TOOLKIT_TEXT_LABEL_H