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        * @DEPRECATED_1_2.60 Use the new enum value of TEXT_COLOR instead.
 165        * @brief The color of the text.
 166        * @details Name "unusedPropertyTextColor", type Property::VECTOR4.
 167        * @SINCE_1_0.0
 168        */
 169       UNUSED_PROPERTY_TEXT_COLOR,
 170
 171       /**
 172        * @brief This property is removed because it's deprecated.
 173        */
 174       RESERVED_PROPERTY_01,
 175
 176       /**
 177        * @brief This property is removed because it's deprecated.
 178        */
 179       RESERVED_PROPERTY_02,
 180
 181       /**
 182        * @brief This property is removed because it's deprecated.
 183        */
 184       RESERVED_PROPERTY_03,
 185
 186       /**
 187        * @brief This property is removed because it's deprecated.
 188        */
 189       RESERVED_PROPERTY_04,
 190
 191       /**
 192        * @brief This property is removed because it's deprecated.
 193        */
 194       RESERVED_PROPERTY_05,
 195
 196       /**
 197        * @brief Whether the mark-up processing is enabled.
 198        * @details Name "enableMarkup", type Property::BOOLEAN.
 199        * @SINCE_1_0.0
 200        * @note Default is false.
 201        */
 202       ENABLE_MARKUP,
 203
 204       /**
 205        * @brief Starts or stops auto scrolling.
 206        * @details Name "enableAutoScroll", type Property::BOOLEAN.
 207        * @SINCE_1_1.35
 208        * @note Default is false.
 209        */
 210       ENABLE_AUTO_SCROLL,
 211
 212       /**
 213        * @brief Sets the speed of scrolling in pixels per second.
 214        * @details Name "autoScrollSpeed", type Property::INT.
 215        * @SINCE_1_1.35
 216        * @note Default in style sheet.
 217        */
 218       AUTO_SCROLL_SPEED,
 219
 220       /**
 221        * @brief Number of complete loops when scrolling enabled.
 222        * @details Name "autoScrollLoopCount", type Property::INT.
 223        * @SINCE_1_1.35
 224        * @note Default in style sheet.
 225        */
 226       AUTO_SCROLL_LOOP_COUNT,
 227
 228       /**
 229        * @brief Gap before scrolling wraps.
 230        * @details Name "autoScrollGap", type Property::INT.
 231        * @SINCE_1_1.35
 232        * @note Default in style sheet but can be overridden to prevent same text being shown at start and end.
 233        * @note Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE).
 234        */
 235       AUTO_SCROLL_GAP,
 236
 237       /**
 238        * @brief The default extra space between lines in points.
 239        * @details Name "lineSpacing", type Property::FLOAT.
 240        * @SINCE_1_1.37
 241        */
 242       LINE_SPACING,
 243
 244       /**
 245        * @brief The default underline parameters.
 246        * @details Name "underline", type Property::MAP.
 247        *
 248        * The underline map contains the following keys:
 249        *
 250        * | %Property Name       | Type     | Required | Description                                                                                                        |
 251        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 252        * | enable               | BOOLEAN  | No       | True to enable the underline or false to disable (the default value is false)                                      |
 253        * | color                | VECTOR4  | No       | The color of the underline (the default value is Color::BLACK)                                                     |
 254        * | height               | FLOAT    | No       | The height of the underline (the default value is 0)                                                               |
 255        *
 256        * @SINCE_1_2.13
 257        */
 258       UNDERLINE,
 259
 260       /**
 261        * @brief The default shadow parameters.
 262        * @details Name "shadow", type Property::MAP.
 263        *
 264        * The shadow map contains the following keys:
 265        *
 266        * | %Property Name       | Type     | Required | Description                                                                                                        |
 267        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 268        * | color                | VECTOR4  | No       | The color of the shadow (the default value is Color::BLACK)                                                        |
 269        * | 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)     |
 270        * | blurRadius           | FLOAT    | No       | The radius of blur to be applied to the shadow (the default value is 0 which means no blur)                        |
 271        *
 272        * @SINCE_1_2.13
 273        */
 274       SHADOW,
 275
 276       /**
 277        * @brief The default emboss parameters.
 278        * @details Name "emboss", type Property::MAP.
 279        * @SINCE_1_2.13
 280        */
 281       EMBOSS,
 282
 283       /**
 284        * @brief The default outline parameters.
 285        * @details Name "outline", type Property::MAP.
 286        *
 287        * The outline map contains the following keys:
 288        *
 289        * | %Property Name       | Type     | Required | Description                                                                                                        |
 290        * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
 291        * | color                | VECTOR4  | No       | The color of the outline (the default value is Color::WHITE)                                                       |
 292        * | width                | INTEGER  | No       | The width of the outline (the default value is 0 which means no outline)                                           |
 293        *
 294        * @SINCE_1_2.13
 295        */
 296       OUTLINE,
 297
 298       /**
 299        * @brief The size of font in pixels.
 300        * @details Name "pixelSize", type Property::FLOAT.
 301        *          Conversion from Point size to Pixel size:
 302        *            Pixel size = Point size * DPI / 72
 303        * @SINCE_1_2.60
 304        */
 305       PIXEL_SIZE,
 306
 307       /**
 308        * @brief Whether we should show the ellipsis if required.
 309        * @details Name "ellipsis", type Property::BOOLEAN.
 310        * @SINCE_1_2.60
 311        */
 312       ELLIPSIS,
 313
 314       /**
 315        * @brief The amount of time to delay the starting time of auto scrolling and further loops.
 316        * @details Name "autoScrollLoopDelay", type Property::FLOAT.
 317        * @SINCE_1_2.60
 318        */
 319       AUTO_SCROLL_LOOP_DELAY,
 320
 321       /**
 322        * @brief The auto scrolling stop behaviour.
 323        * @details Name "autoScrollStopMode", type AutoScrollStopMode::Type (Property::INTEGER) or Property::STRING.
 324        * @SINCE_1_2.60
 325        * @note Default is AutoScrollStopMode::FINISH_LOOP.
 326        * @see AutoScrollStopMode::Type
 327        */
 328       AUTO_SCROLL_STOP_MODE,
 329
 330       /**
 331        * @brief The line count of text.
 332        * @details name "lineCount", type Property::INTEGER.
 333        * @SINCE_1_2.60
 334        * @note This property is read-only.
 335        */
 336       LINE_COUNT,
 337
 338       /**
 339        * @brief Line wrap mode when text lines are greater than the layout width.
 340        * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
 341        * @SINCE_1_2.60
 342        * @note Default is Text::LineWrap::WORD.
 343        * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
 344        * @see Text::LineWrap
 345        */
 346       LINE_WRAP_MODE,
 347
 348       ///////////////////////////////////////////////////////////////////////////////
 349       // Animatable Properties
 350       ///////////////////////////////////////////////////////////////////////////////
 351
 352       /**
 353        * @brief The color of the text.
 354        * @details Name "textColor", type Property::VECTOR4.
 355        * @SINCE_1_2.60
 356        */
 357       TEXT_COLOR = ANIMATABLE_PROPERTY_START_INDEX,
 358
 359       /**
 360        * @brief The red component of the text color.
 361        * @details Name "textColorRed", type Property::FLOAT.
 362        * @SINCE_1_2.60
 363        * @see TEXT_COLOR
 364        */
 365       TEXT_COLOR_RED,
 366
 367       /**
 368        * @brief The green component of the text color.
 369        * @details Name "textColorGreen", type Property::FLOAT.
 370        * @SINCE_1_2.60
 371        * @see TEXT_COLOR
 372        */
 373       TEXT_COLOR_GREEN,
 374
 375       /**
 376        * @brief The blue component of the text color.
 377        * @details Name "textColorBlue", type Property::FLOAT.
 378        * @SINCE_1_2.60
 379        * @see TEXT_COLOR
 380        */
 381       TEXT_COLOR_BLUE,
 382
 383       /**
 384        * @brief The alpha component of the text color.
 385        * @details Name "textColorAlpha", type Property::FLOAT.
 386        * @SINCE_1_2.60
 387        * @see TEXT_COLOR
 388        */
 389       TEXT_COLOR_ALPHA,
 390     };
 391   };
 392
 393   /**
 394    * @brief The enumerations used for auto scroll stop mode.
 395    * @SINCE_1_2.60
 396    * @see Property::AUTO_SCROLL_STOP_MODE.
 397    */
 398   struct AutoScrollStopMode
 399   {
 400     /**
 401      * @brief The enumerations used for auto scroll stop mode.
 402      * @SINCE_1_2.60
 403      * @see Property::AUTO_SCROLL_STOP_MODE.
 404      */
 405     enum Type
 406     {
 407       FINISH_LOOP = 0,  ///< Stop animation after current loop finishes. @SINCE_1_2.60
 408       IMMEDIATE         ///< Stop animation immediately and reset position. @SINCE_1_2.60
 409     };
 410   };
 411
 412   /**
 413    * @brief Creates the TextLabel control.
 414    *
 415    * @SINCE_1_0.0
 416    * @return A handle to the TextLabel control
 417    */
 418   static TextLabel New();
 419
 420   /**
 421    * @brief Creates the TextLabel control.
 422    *
 423    * @SINCE_1_0.0
 424    * @param[in] text The text to display
 425    * @return A handle to the TextLabel control
 426    */
 427   static TextLabel New( const std::string& text );
 428
 429   /**
 430    * @brief Creates an empty handle.
 431    * @SINCE_1_0.0
 432    */
 433   TextLabel();
 434
 435   /**
 436    * @brief Copy constructor.
 437    *
 438    * @SINCE_1_0.0
 439    * @param[in] handle The handle to copy from
 440    */
 441   TextLabel( const TextLabel& handle );
 442
 443   /**
 444    * @brief Assignment operator.
 445    *
 446    * @SINCE_1_0.0
 447    * @param[in] handle The handle to copy from
 448    * @return A reference to this
 449    */
 450   TextLabel& operator=( const TextLabel& handle );
 451
 452   /**
 453    * @brief Destructor.
 454    *
 455    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 456    * @SINCE_1_0.0
 457    */
 458   ~TextLabel();
 459
 460   /**
 461    * @brief Downcasts a handle to TextLabel.
 462    *
 463    * If the BaseHandle points is a TextLabel, the downcast returns a valid handle.
 464    * If not, the returned handle is left empty.
 465    *
 466    * @SINCE_1_0.0
 467    * @param[in] handle Handle to an object
 468    * @return Handle to a TextLabel or an empty handle
 469    */
 470   static TextLabel DownCast( BaseHandle handle );
 471
 472 public: // Not intended for application developers
 473
 474   /// @cond internal
 475   /**
 476    * @brief Creates a handle using the Toolkit::Internal implementation.
 477    *
 478    * @SINCE_1_0.0
 479    * @param[in] implementation The Control implementation
 480    */
 481   DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
 482
 483   /**
 484    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 485    *
 486    * @SINCE_1_0.0
 487    * @param[in] internal A pointer to the internal CustomActor
 488    */
 489   explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
 490   /// @endcond
 491 };
 492
 493 /**
 494  * @}
 495  */
 496 } // namespace Toolkit
 497
 498 } // namespace Dali
 499
 500 #endif // DALI_TOOLKIT_TEXT_LABEL_H