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

   1 #ifndef DALI_TOOLKIT_TEXT_LABEL_DEVEL_H
   2 #define DALI_TOOLKIT_TEXT_LABEL_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2018 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/text-controls/text-label.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelTextLabel
  31 {
  32
  33 namespace Property
  34 {
  35   enum Type
  36   {
  37     RENDERING_BACKEND = Dali::Toolkit::TextLabel::Property::RENDERING_BACKEND,
  38     TEXT = Dali::Toolkit::TextLabel::Property::TEXT,
  39     FONT_FAMILY = Dali::Toolkit::TextLabel::Property::FONT_FAMILY,
  40     FONT_STYLE = Dali::Toolkit::TextLabel::Property::FONT_STYLE,
  41     POINT_SIZE = Dali::Toolkit::TextLabel::Property::POINT_SIZE,
  42     MULTI_LINE = Dali::Toolkit::TextLabel::Property::MULTI_LINE,
  43     HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT,
  44     VERTICAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT,
  45     UNUSED_PROPERTY_TEXT_COLOR = Dali::Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR,
  46     ENABLE_MARKUP = Dali::Toolkit::TextLabel::Property::ENABLE_MARKUP,
  47     ENABLE_AUTO_SCROLL = Dali::Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL,
  48     AUTO_SCROLL_SPEED = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED,
  49     AUTO_SCROLL_LOOP_COUNT = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT,
  50     AUTO_SCROLL_GAP = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_GAP,
  51     LINE_SPACING = Dali::Toolkit::TextLabel::Property::LINE_SPACING,
  52     UNDERLINE = Dali::Toolkit::TextLabel::Property::UNDERLINE,
  53     SHADOW = Dali::Toolkit::TextLabel::Property::SHADOW,
  54     EMBOSS = Dali::Toolkit::TextLabel::Property::EMBOSS,
  55     OUTLINE = Dali::Toolkit::TextLabel::Property::OUTLINE,
  56     PIXEL_SIZE = Dali::Toolkit::TextLabel::Property::PIXEL_SIZE,
  57     ELLIPSIS = Dali::Toolkit::TextLabel::Property::ELLIPSIS,
  58     AUTO_SCROLL_LOOP_DELAY = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY,
  59     AUTO_SCROLL_STOP_MODE = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE,
  60     LINE_COUNT = Dali::Toolkit::TextLabel::Property::LINE_COUNT,
  61     LINE_WRAP_MODE = Dali::Toolkit::TextLabel::Property::LINE_WRAP_MODE,
  62
  63     /**
  64      * @brief The direction of the layout.
  65      * @details Name "textDirection", type [Type](@ref Dali::Toolkit::DevelText::TextDirection::Type) (Property::INTEGER), Read/Write
  66      * @note The text direction can be changed only by replacing the text itself.
  67      * @see TextDirection::Type for supported values.
  68      */
  69     TEXT_DIRECTION,
  70
  71     /**
  72      * @brief Alignment of text within area of single line
  73      * @details Name "verticalLineAlignment", type [Type](@ref Dali::Toolkit::DevelText::VerticalLineAlignment::Type) (Property::INTEGER), Read/Write
  74      * @note The default value is TOP
  75      * @see VerticalLineAlignment::Type for supported values
  76      */
  77     VERTICAL_LINE_ALIGNMENT,
  78
  79     /**
  80      * @brief The default text background parameters.
  81      * @details Name "textBackground", type Property::MAP.
  82      * @note Use "textBackground" as property name to avoid conflict with Control's "background" property
  83      *
  84      * The background map contains the following keys:
  85      *
  86      * | %Property Name       | Type     | Required | Description                                                                                                        |
  87      * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
  88      * | enable               | BOOLEAN  | No       | True to enable the background or false to disable (the default value is false)                                     |
  89      * | color                | VECTOR4  | No       | The color of the background (the default value is Color::CYAN)                                                     |
  90      */
  91     BACKGROUND,
  92
  93     /**
  94      * @brief Ignore spaces after text.
  95      * @details Name "ignoreSpacesAfterText", type (Property::BOLEAN), Read/Write
  96      * @note The default value is true
  97      */
  98     IGNORE_SPACES_AFTER_TEXT,
  99
 100     /**
 101      * @brief Modifies the default text alignment to match the direction of the system language.
 102      * @details Name "matchSystemLanguageDirection", type (Property::BOLEAN), Read/Write
 103      * @note The default value is false
 104      *
 105      * If MATCH_SYSTEM_LANGUAGE_DIRECTION property set true, the default text alignment to match the direction of the system language.
 106      *
 107      * ex) Current system language direction LTR.
 108      *     TextLabel::New("Hello world \n  ﻡﺮﺤﺑﺍ. ");
 109      *     TextLabel::Property::HORIZONTAL_ALIGNMENT, "END"
 110      *
 111      * | TextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION                 |
 112      * |-----------------------------------------------------------------------
 113      * |        false (default)            |                true              |
 114      * |-----------------------------------|----------------------------------|
 115      * |                     Hello world   |                  Hello world     |
 116      * |   ﻡﺮﺤﺑﺍ.                          |                      ﻡﺮﺤﺑﺍ.      |
 117      *
 118      */
 119     MATCH_SYSTEM_LANGUAGE_DIRECTION,
 120   };
 121
 122 } // namespace Property
 123
 124 } // namespace DevelTextLabel
 125
 126 } // namespace Toolkit
 127
 128 } // namespace Dali
 129
 130 #endif // DALI_TOOLKIT_TEXT_LABEL_DEVEL_H