dali-toolkit/internal/controls/text-controls/text-label-impl.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/controls/text-controls/text-label-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/actors/actor-devel.h>
  23 #include <dali/devel-api/adaptor-framework/image-loading.h>
  24 #include <dali/devel-api/common/stage.h>
  25 #include <dali/devel-api/object/property-helper-devel.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/public-api/common/dali-common.h>
  28 #include <dali/public-api/object/type-registry-helper.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  32 #include <dali-toolkit/devel-api/text/rendering-backend.h>
  33 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  34 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  35 #include <dali-toolkit/internal/text/property-string-parser.h>
  36 #include <dali-toolkit/internal/text/rendering/text-backend.h>
  37 #include <dali-toolkit/internal/text/text-definitions.h>
  38 #include <dali-toolkit/internal/text/text-effects-style.h>
  39 #include <dali-toolkit/internal/text/text-font-style.h>
  40 #include <dali-toolkit/internal/text/text-view.h>
  41 #include <dali-toolkit/public-api/text/text-enumerations.h>
  42
  43 #include <dali-toolkit/devel-api/controls/control-devel.h>
  44 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  45 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  46 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
  47 #include <dali-toolkit/public-api/align-enumerations.h>
  48 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  49 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  50
  51 // DEVEL INCLUDES
  52 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
  53
  54 using namespace Dali::Toolkit::Text;
  55
  56 namespace Dali
  57 {
  58 namespace Toolkit
  59 {
  60 namespace Internal
  61 {
  62 namespace
  63 {
  64 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
  65
  66 /**
  67  * @brief How the text visual should be aligned vertically inside the control.
  68  *
  69  * 0.0f aligns the text to the top, 0.5f aligns the text to the center, 1.0f aligns the text to the bottom.
  70  * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
  71  */
  72 const float VERTICAL_ALIGNMENT_TABLE[Text::VerticalAlignment::BOTTOM + 1] =
  73 {
  74     0.0f, // VerticalAlignment::TOP
  75     0.5f, // VerticalAlignment::CENTER
  76     1.0f  // VerticalAlignment::BOTTOM
  77 };
  78
  79 const char* TEXT_FIT_ENABLE_KEY("enable");
  80 const char* TEXT_FIT_MIN_SIZE_KEY("minSize");
  81 const char* TEXT_FIT_MAX_SIZE_KEY("maxSize");
  82 const char* TEXT_FIT_STEP_SIZE_KEY("stepSize");
  83 const char* TEXT_FIT_FONT_SIZE_KEY("fontSize");
  84 const char* TEXT_FIT_FONT_SIZE_TYPE_KEY("fontSizeType");
  85
  86 #if defined(DEBUG_ENABLED)
  87 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  88 #endif
  89
  90 const Scripting::StringEnum AUTO_SCROLL_STOP_MODE_TABLE[] =
  91 {
  92     {"IMMEDIATE", Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE},
  93     {"FINISH_LOOP", Toolkit::TextLabel::AutoScrollStopMode::FINISH_LOOP},
  94 };
  95 const unsigned int AUTO_SCROLL_STOP_MODE_TABLE_COUNT = sizeof(AUTO_SCROLL_STOP_MODE_TABLE) / sizeof(AUTO_SCROLL_STOP_MODE_TABLE[0]);
  96
  97 // Type registration
  98 BaseHandle Create()
  99 {
 100   return Toolkit::TextLabel::New();
 101 }
 102
 103 // clang-format off
 104 // Setup properties, signals and actions using the type-registry.
 105 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextLabel, Toolkit::Control, Create);
 106
 107 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "text",                         STRING,  TEXT                           )
 108 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "fontFamily",                   STRING,  FONT_FAMILY                    )
 109 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "fontStyle",                    MAP,     FONT_STYLE                     )
 110 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "pointSize",                    FLOAT,   POINT_SIZE                     )
 111 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "multiLine",                    BOOLEAN, MULTI_LINE                     )
 112 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "horizontalAlignment",          STRING,  HORIZONTAL_ALIGNMENT           )
 113 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "verticalAlignment",            STRING,  VERTICAL_ALIGNMENT             )
 114 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "enableMarkup",                 BOOLEAN, ENABLE_MARKUP                  )
 115 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "enableAutoScroll",             BOOLEAN, ENABLE_AUTO_SCROLL             )
 116 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "autoScrollSpeed",              INTEGER, AUTO_SCROLL_SPEED              )
 117 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "autoScrollLoopCount",          INTEGER, AUTO_SCROLL_LOOP_COUNT         )
 118 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "autoScrollGap",                FLOAT,   AUTO_SCROLL_GAP                )
 119 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "lineSpacing",                  FLOAT,   LINE_SPACING                   )
 120 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "underline",                    MAP,     UNDERLINE                      )
 121 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "shadow",                       MAP,     SHADOW                         )
 122 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "emboss",                       MAP,     EMBOSS                         )
 123 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "outline",                      MAP,     OUTLINE                        )
 124 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "pixelSize",                    FLOAT,   PIXEL_SIZE                     )
 125 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "ellipsis",                     BOOLEAN, ELLIPSIS                       )
 126 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "autoScrollLoopDelay",          FLOAT,   AUTO_SCROLL_LOOP_DELAY         )
 127 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "autoScrollStopMode",           STRING,  AUTO_SCROLL_STOP_MODE          )
 128 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit,       TextLabel, "lineCount",                    INTEGER, LINE_COUNT                     )
 129 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextLabel, "lineWrapMode",                 INTEGER, LINE_WRAP_MODE                 )
 130 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextLabel, "textDirection",                INTEGER, TEXT_DIRECTION                 )
 131 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "verticalLineAlignment",        INTEGER, VERTICAL_LINE_ALIGNMENT        )
 132 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "textBackground",               MAP,     BACKGROUND                     )
 133 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "ignoreSpacesAfterText",        BOOLEAN, IGNORE_SPACES_AFTER_TEXT       )
 134 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION)
 135 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "textFit",                      MAP,     TEXT_FIT                       )
 136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "minLineSize",                  FLOAT,   MIN_LINE_SIZE                  )
 137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "renderingBackend",             INTEGER, RENDERING_BACKEND              )
 138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "fontSizeScale",                FLOAT,   FONT_SIZE_SCALE                )
 139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "enableFontSizeScale",          BOOLEAN, ENABLE_FONT_SIZE_SCALE         )
 140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "ellipsisPosition",             INTEGER, ELLIPSIS_POSITION              )
 141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "strikethrough",                MAP,     STRIKETHROUGH                  )
 142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "characterSpacing",             FLOAT,   CHARACTER_SPACING              )
 143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextLabel, "relativeLineSize",             FLOAT,   RELATIVE_LINE_SIZE             )
 144
 145 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, TextLabel, "textColor",      Color::BLACK,     TEXT_COLOR   )
 146 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit,    TextLabel, "textColorRed",   TEXT_COLOR_RED,   TEXT_COLOR, 0)
 147 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit,    TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1)
 148 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit,    TextLabel, "textColorBlue",  TEXT_COLOR_BLUE,  TEXT_COLOR, 2)
 149 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit,    TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3)
 150
 151 DALI_SIGNAL_REGISTRATION(Toolkit, TextLabel, "anchorClicked", SIGNAL_ANCHOR_CLICKED)
 152 DALI_SIGNAL_REGISTRATION(Toolkit, TextLabel, "textFitChanged", SIGNAL_TEXT_FIT_CHANGED)
 153
 154 DALI_TYPE_REGISTRATION_END()
 155 // clang-format on
 156
 157 /// Parses the property map for the TEXT_FIT property
 158 void ParseTextFitProperty(Text::ControllerPtr& controller, const Property::Map* propertiesMap)
 159 {
 160   if(propertiesMap && !propertiesMap->Empty())
 161   {
 162     bool                     enabled      = false;
 163     float                    minSize      = 0.f;
 164     float                    maxSize      = 0.f;
 165     float                    stepSize     = 0.f;
 166     bool                     isMinSizeSet = false, isMaxSizeSet = false, isStepSizeSet = false;
 167     Controller::FontSizeType type = Controller::FontSizeType::POINT_SIZE;
 168
 169     const unsigned int numberOfItems = propertiesMap->Count();
 170
 171     // Parses and applies
 172     for(unsigned int index = 0u; index < numberOfItems; ++index)
 173     {
 174       const KeyValuePair& valueGet = propertiesMap->GetKeyValue(index);
 175
 176       if((Controller::TextFitInfo::Property::TEXT_FIT_ENABLE == valueGet.first.indexKey) || (TEXT_FIT_ENABLE_KEY == valueGet.first.stringKey))
 177       {
 178         /// Enable key.
 179         enabled = valueGet.second.Get<bool>();
 180       }
 181       else if((Controller::TextFitInfo::Property::TEXT_FIT_MIN_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MIN_SIZE_KEY == valueGet.first.stringKey))
 182       {
 183         /// min size.
 184         minSize      = valueGet.second.Get<float>();
 185         isMinSizeSet = true;
 186       }
 187       else if((Controller::TextFitInfo::Property::TEXT_FIT_MAX_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MAX_SIZE_KEY == valueGet.first.stringKey))
 188       {
 189         /// max size.
 190         maxSize      = valueGet.second.Get<float>();
 191         isMaxSizeSet = true;
 192       }
 193       else if((Controller::TextFitInfo::Property::TEXT_FIT_STEP_SIZE == valueGet.first.indexKey) || (TEXT_FIT_STEP_SIZE_KEY == valueGet.first.stringKey))
 194       {
 195         /// step size.
 196         stepSize      = valueGet.second.Get<float>();
 197         isStepSizeSet = true;
 198       }
 199       else if((Controller::TextFitInfo::Property::TEXT_FIT_FONT_SIZE_TYPE == valueGet.first.indexKey) || (TEXT_FIT_FONT_SIZE_TYPE_KEY == valueGet.first.stringKey))
 200       {
 201         if("pixelSize" == valueGet.second.Get<std::string>())
 202         {
 203           type = Controller::FontSizeType::PIXEL_SIZE;
 204         }
 205       }
 206     }
 207
 208     controller->SetTextFitEnabled(enabled);
 209     // The TextFit operation is performed based on the MinLineSize set in the TextLabel at the moment when the TextFit property is set.
 210     // So, if you change the TextLabel's MinLineSize after setting the TextFit property, it does not affect the operation of TextFit.
 211     // This may require a new LineSize item in TextFit.
 212     controller->SetTextFitLineSize(controller->GetDefaultLineSize());
 213     if(isMinSizeSet)
 214     {
 215       controller->SetTextFitMinSize(minSize, type);
 216     }
 217     if(isMaxSizeSet)
 218     {
 219       controller->SetTextFitMaxSize(maxSize, type);
 220     }
 221     if(isStepSizeSet)
 222     {
 223       controller->SetTextFitStepSize(stepSize, type);
 224     }
 225   }
 226 }
 227
 228 } // namespace
 229
 230 Toolkit::TextLabel TextLabel::New(ControlBehaviour additionalBehaviour)
 231 {
 232   // Create the implementation, temporarily owned by this handle on stack
 233   IntrusivePtr<TextLabel> impl = new TextLabel(additionalBehaviour);
 234
 235   // Pass ownership to CustomActor handle
 236   Toolkit::TextLabel handle(*impl);
 237
 238   // Second-phase init of the implementation
 239   // This can only be done after the CustomActor connection has been made...
 240   impl->Initialize();
 241
 242   return handle;
 243 }
 244
 245 void TextLabel::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
 246 {
 247   Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
 248
 249   if(label)
 250   {
 251     TextLabel& impl(GetImpl(label));
 252     DALI_ASSERT_ALWAYS(impl.mController && "No text contoller");
 253
 254     switch(index)
 255     {
 256       case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
 257       {
 258         int backend = value.Get<int>();
 259
 260 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
 261         if(DevelText::RENDERING_VECTOR_BASED == backend)
 262         {
 263           backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
 264         }
 265 #endif
 266         if(impl.mRenderingBackend != backend)
 267         {
 268           impl.mRenderingBackend = backend;
 269           impl.mTextUpdateNeeded = true;
 270
 271           // When using the vector-based rendering, the size of the GLyphs are different
 272           TextAbstraction::GlyphType glyphType = (DevelText::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
 273           impl.mController->SetGlyphType(glyphType);
 274         }
 275         break;
 276       }
 277       case Toolkit::TextLabel::Property::TEXT:
 278       {
 279         impl.mController->SetText(value.Get<std::string>());
 280
 281         if(impl.mController->HasAnchors())
 282         {
 283           // Forward input events to controller
 284           impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
 285         }
 286         else
 287         {
 288           impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
 289         }
 290
 291         break;
 292       }
 293       case Toolkit::TextLabel::Property::FONT_FAMILY:
 294       {
 295         const std::string& fontFamily = value.Get<std::string>();
 296
 297         DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str());
 298         impl.mController->SetDefaultFontFamily(fontFamily);
 299         break;
 300       }
 301       case Toolkit::TextLabel::Property::FONT_STYLE:
 302       {
 303         SetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
 304         break;
 305       }
 306       case Toolkit::TextLabel::Property::POINT_SIZE:
 307       {
 308         const float pointSize = value.Get<float>();
 309
 310         if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE), pointSize))
 311         {
 312           impl.mController->SetDefaultFontSize(pointSize, Text::Controller::POINT_SIZE);
 313         }
 314         break;
 315       }
 316       case Toolkit::TextLabel::Property::MULTI_LINE:
 317       {
 318         impl.mController->SetMultiLineEnabled(value.Get<bool>());
 319         break;
 320       }
 321       case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
 322       {
 323         Text::HorizontalAlignment::Type alignment(static_cast<Text::HorizontalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
 324         if(Text::GetHorizontalAlignmentEnumeration(value, alignment))
 325         {
 326           impl.mController->SetHorizontalAlignment(alignment);
 327         }
 328         break;
 329       }
 330       case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
 331       {
 332         Toolkit::Text::VerticalAlignment::Type alignment(static_cast<Text::VerticalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
 333         if(Text::GetVerticalAlignmentEnumeration(value, alignment))
 334         {
 335           impl.mController->SetVerticalAlignment(alignment);
 336         }
 337         break;
 338       }
 339       case Toolkit::TextLabel::Property::ENABLE_MARKUP:
 340       {
 341         const bool enableMarkup = value.Get<bool>();
 342         impl.mController->SetMarkupProcessorEnabled(enableMarkup);
 343
 344         if(impl.mController->HasAnchors())
 345         {
 346           // Forward input events to controller
 347           impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
 348         }
 349         else
 350         {
 351           impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
 352         }
 353         break;
 354       }
 355       case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
 356       {
 357         const bool enableAutoScroll = value.Get<bool>();
 358         impl.mLastAutoScrollEnabled = enableAutoScroll;
 359         // If request to auto scroll is the same as current state then do nothing.
 360         if(enableAutoScroll != impl.mController->IsAutoScrollEnabled())
 361         {
 362           // If request is disable (false) and auto scrolling is enabled then need to stop it
 363           if(enableAutoScroll == false)
 364           {
 365             if(impl.mTextScroller)
 366             {
 367               impl.mTextScroller->StopScrolling();
 368             }
 369           }
 370           // If request is enable (true) then start autoscroll as not already running
 371           else
 372           {
 373             impl.mController->SetAutoScrollEnabled(enableAutoScroll);
 374           }
 375         }
 376         break;
 377       }
 378       case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
 379       {
 380         Text::TextScrollerPtr                        textScroller = impl.GetTextScroller();
 381         Toolkit::TextLabel::AutoScrollStopMode::Type stopMode     = textScroller->GetStopMode();
 382         if(Scripting::GetEnumerationProperty<Toolkit::TextLabel::AutoScrollStopMode::Type>(value,
 383                                                                                            AUTO_SCROLL_STOP_MODE_TABLE,
 384                                                                                            AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
 385                                                                                            stopMode))
 386         {
 387           textScroller->SetStopMode(stopMode);
 388         }
 389         break;
 390       }
 391       case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
 392       {
 393         impl.GetTextScroller()->SetSpeed(value.Get<int>());
 394         break;
 395       }
 396       case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
 397       {
 398         impl.GetTextScroller()->SetLoopCount(value.Get<int>());
 399         break;
 400       }
 401       case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
 402       {
 403         impl.GetTextScroller()->SetLoopDelay(value.Get<float>());
 404         break;
 405       }
 406       case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
 407       {
 408         impl.GetTextScroller()->SetGap(value.Get<float>());
 409         break;
 410       }
 411       case Toolkit::TextLabel::Property::LINE_SPACING:
 412       {
 413         const float lineSpacing = value.Get<float>();
 414         impl.mTextUpdateNeeded  = impl.mController->SetDefaultLineSpacing(lineSpacing) || impl.mTextUpdateNeeded;
 415         break;
 416       }
 417       case Toolkit::TextLabel::Property::UNDERLINE:
 418       {
 419         impl.mTextUpdateNeeded = SetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 420         break;
 421       }
 422       case Toolkit::TextLabel::Property::SHADOW:
 423       {
 424         impl.mTextUpdateNeeded = SetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 425         break;
 426       }
 427       case Toolkit::TextLabel::Property::EMBOSS:
 428       {
 429         impl.mTextUpdateNeeded = SetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 430         break;
 431       }
 432       case Toolkit::TextLabel::Property::OUTLINE:
 433       {
 434         impl.mTextUpdateNeeded = SetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 435         break;
 436       }
 437       case Toolkit::TextLabel::Property::PIXEL_SIZE:
 438       {
 439         const float pixelSize = value.Get<float>();
 440         DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize);
 441
 442         if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE), pixelSize))
 443         {
 444           impl.mController->SetDefaultFontSize(pixelSize, Text::Controller::PIXEL_SIZE);
 445         }
 446         break;
 447       }
 448       case Toolkit::TextLabel::Property::ELLIPSIS:
 449       {
 450         const bool ellipsis = value.Get<bool>();
 451         DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis);
 452
 453         impl.mController->SetTextElideEnabled(ellipsis);
 454         break;
 455       }
 456       case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
 457       {
 458         Text::LineWrap::Mode lineWrapMode(static_cast<Text::LineWrap::Mode>(-1)); // Set to invalid value to ensure a valid mode does get set
 459         if(GetLineWrapModeEnumeration(value, lineWrapMode))
 460         {
 461           DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode);
 462           impl.mController->SetLineWrapMode(lineWrapMode);
 463         }
 464         break;
 465       }
 466       case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
 467       {
 468         if(impl.mController->GetTextModel())
 469         {
 470           DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>(value.Get<int>());
 471
 472           impl.mController->SetVerticalLineAlignment(alignment);
 473
 474           // Property doesn't affect the layout, only Visual must be updated
 475           TextVisual::EnableRendererUpdate(impl.mVisual);
 476
 477           // No need to trigger full re-layout. Instead call UpdateRenderer() directly
 478           TextVisual::UpdateRenderer(impl.mVisual);
 479         }
 480         break;
 481       }
 482       case Toolkit::DevelTextLabel::Property::BACKGROUND:
 483       {
 484         impl.mTextUpdateNeeded = SetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 485         break;
 486       }
 487       case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
 488       {
 489         impl.mController->SetIgnoreSpacesAfterText(value.Get<bool>());
 490         break;
 491       }
 492       case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
 493       {
 494         impl.mController->SetMatchLayoutDirection(value.Get<bool>() ? DevelText::MatchLayoutDirection::LOCALE : DevelText::MatchLayoutDirection::CONTENTS);
 495         break;
 496       }
 497       case Toolkit::DevelTextLabel::Property::TEXT_FIT:
 498       {
 499         // If TextFitArray is enabled, this should be disabled.
 500         if(impl.mController->IsTextFitArrayEnabled())
 501         {
 502           impl.mController->SetDefaultLineSize(impl.mController->GetCurrentLineSize());
 503           impl.mController->SetTextFitArrayEnabled(false);
 504         }
 505
 506         ParseTextFitProperty(impl.mController, value.GetMap());
 507         impl.mController->SetTextFitChanged(true);
 508         break;
 509       }
 510       case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
 511       {
 512         const float lineSize = value.Get<float>();
 513         // If TextFitArray is enabled, do not update the default line size.
 514         if(!impl.mController->IsTextFitArrayEnabled())
 515         {
 516           impl.mTextUpdateNeeded = impl.mController->SetDefaultLineSize(lineSize) || impl.mTextUpdateNeeded;
 517         }
 518         impl.mController->SetCurrentLineSize(lineSize);
 519         break;
 520       }
 521       case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
 522       {
 523         const float scale = value.Get<float>();
 524         DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p FONT_SIZE_SCALE %f\n", impl.mController.Get(), scale);
 525
 526         if(!Equals(impl.mController->GetFontSizeScale(), scale))
 527         {
 528           impl.mController->SetFontSizeScale(scale);
 529         }
 530         break;
 531       }
 532       case Toolkit::DevelTextLabel::Property::ENABLE_FONT_SIZE_SCALE:
 533       {
 534         const bool enableFontSizeScale = value.Get<bool>();
 535         if(!Equals(impl.mController->IsFontSizeScaleEnabled(), enableFontSizeScale))
 536         {
 537           impl.mController->SetFontSizeScaleEnabled(enableFontSizeScale);
 538         }
 539         break;
 540       }
 541       case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
 542       {
 543         DevelText::EllipsisPosition::Type ellipsisPositionType(static_cast<DevelText::EllipsisPosition::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
 544         if(GetEllipsisPositionTypeEnumeration(value, ellipsisPositionType))
 545         {
 546           DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p EllipsisPosition::Type %d\n", impl.mController.Get(), ellipsisPositionType);
 547           impl.mController->SetEllipsisPosition(ellipsisPositionType);
 548         }
 549         break;
 550       }
 551       case Toolkit::DevelTextLabel::Property::STRIKETHROUGH:
 552       {
 553         impl.mTextUpdateNeeded = SetStrikethroughProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
 554         break;
 555       }
 556       case Toolkit::DevelTextLabel::Property::CHARACTER_SPACING:
 557       {
 558         const float characterSpacing = value.Get<float>();
 559         impl.mController->SetCharacterSpacing(characterSpacing);
 560         break;
 561       }
 562       case Toolkit::DevelTextLabel::Property::RELATIVE_LINE_SIZE:
 563       {
 564         const float relativeLineSize = value.Get<float>();
 565         DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel %p RELATIVE_LINE_SIZE %f\n", impl.mController.Get(), relativeLineSize);
 566
 567         impl.mController->SetRelativeLineSize(relativeLineSize);
 568         break;
 569       }
 570     }
 571
 572     // Request relayout when text update is needed. It's necessary to call it
 573     // as changing the property not via UI interaction brings no effect if only
 574     // the mTextUpdateNeeded is changed.
 575     if(impl.mTextUpdateNeeded)
 576     {
 577       // need to request relayout as size of text may have changed
 578       impl.RequestTextRelayout();
 579     }
 580   }
 581 }
 582
 583 Text::ControllerPtr TextLabel::GetTextController()
 584 {
 585   return mController;
 586 }
 587
 588 Property::Value TextLabel::GetProperty(BaseObject* object, Property::Index index)
 589 {
 590   Property::Value value;
 591
 592   Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
 593
 594   if(label)
 595   {
 596     TextLabel& impl(GetImpl(label));
 597     DALI_ASSERT_DEBUG(impl.mController && "No text contoller");
 598
 599     switch(index)
 600     {
 601       case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
 602       {
 603         value = impl.mRenderingBackend;
 604         break;
 605       }
 606       case Toolkit::TextLabel::Property::TEXT:
 607       {
 608         std::string text;
 609         impl.mController->GetText(text);
 610         value = text;
 611         break;
 612       }
 613       case Toolkit::TextLabel::Property::FONT_FAMILY:
 614       {
 615         value = impl.mController->GetDefaultFontFamily();
 616         break;
 617       }
 618       case Toolkit::TextLabel::Property::FONT_STYLE:
 619       {
 620         GetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
 621         break;
 622       }
 623       case Toolkit::TextLabel::Property::POINT_SIZE:
 624       {
 625         value = impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE);
 626         break;
 627       }
 628       case Toolkit::TextLabel::Property::MULTI_LINE:
 629       {
 630         value = impl.mController->IsMultiLineEnabled();
 631         break;
 632       }
 633       case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
 634       {
 635         const char* name = Text::GetHorizontalAlignmentString(impl.mController->GetHorizontalAlignment());
 636
 637         if(name)
 638         {
 639           value = std::string(name);
 640         }
 641         break;
 642       }
 643       case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
 644       {
 645         const char* name = Text::GetVerticalAlignmentString(impl.mController->GetVerticalAlignment());
 646         if(name)
 647         {
 648           value = std::string(name);
 649         }
 650         break;
 651       }
 652       case Toolkit::TextLabel::Property::ENABLE_MARKUP:
 653       {
 654         value = impl.mController->IsMarkupProcessorEnabled();
 655         break;
 656       }
 657       case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
 658       {
 659         value = impl.mController->IsAutoScrollEnabled();
 660         break;
 661       }
 662       case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
 663       {
 664         if(impl.mTextScroller)
 665         {
 666           const char* mode = Scripting::GetEnumerationName<Toolkit::TextLabel::AutoScrollStopMode::Type>(impl.mTextScroller->GetStopMode(),
 667                                                                                                          AUTO_SCROLL_STOP_MODE_TABLE,
 668                                                                                                          AUTO_SCROLL_STOP_MODE_TABLE_COUNT);
 669           if(mode)
 670           {
 671             value = std::string(mode);
 672           }
 673         }
 674         break;
 675       }
 676       case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
 677       {
 678         if(impl.mTextScroller)
 679         {
 680           value = impl.mTextScroller->GetSpeed();
 681         }
 682         break;
 683       }
 684       case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
 685       {
 686         if(impl.mTextScroller)
 687         {
 688           value = impl.mTextScroller->GetLoopCount();
 689         }
 690         break;
 691       }
 692       case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
 693       {
 694         if(impl.mTextScroller)
 695         {
 696           value = impl.mTextScroller->GetLoopDelay();
 697         }
 698         break;
 699       }
 700       case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
 701       {
 702         if(impl.mTextScroller)
 703         {
 704           value = impl.mTextScroller->GetGap();
 705         }
 706         break;
 707       }
 708       case Toolkit::TextLabel::Property::LINE_SPACING:
 709       {
 710         value = impl.mController->GetDefaultLineSpacing();
 711         break;
 712       }
 713       case Toolkit::TextLabel::Property::UNDERLINE:
 714       {
 715         GetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 716         break;
 717       }
 718       case Toolkit::TextLabel::Property::SHADOW:
 719       {
 720         GetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 721         break;
 722       }
 723       case Toolkit::TextLabel::Property::EMBOSS:
 724       {
 725         GetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 726         break;
 727       }
 728       case Toolkit::TextLabel::Property::OUTLINE:
 729       {
 730         GetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 731         break;
 732       }
 733       case Toolkit::TextLabel::Property::PIXEL_SIZE:
 734       {
 735         value = impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE);
 736         break;
 737       }
 738       case Toolkit::TextLabel::Property::ELLIPSIS:
 739       {
 740         value = impl.mController->IsTextElideEnabled();
 741         break;
 742       }
 743       case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
 744       {
 745         value = impl.mController->GetLineWrapMode();
 746         break;
 747       }
 748       case Toolkit::TextLabel::Property::LINE_COUNT:
 749       {
 750         float width = label.GetProperty(Actor::Property::SIZE_WIDTH).Get<float>();
 751         value       = impl.mController->GetLineCount(width);
 752         break;
 753       }
 754       case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
 755       {
 756         value = impl.mController->GetTextDirection();
 757         break;
 758       }
 759       case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
 760       {
 761         value = impl.mController->GetVerticalLineAlignment();
 762         break;
 763       }
 764       case Toolkit::DevelTextLabel::Property::BACKGROUND:
 765       {
 766         GetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 767         break;
 768       }
 769       case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
 770       {
 771         value = impl.mController->IsIgnoreSpacesAfterText();
 772         break;
 773       }
 774       case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
 775       {
 776         value = impl.mController->GetMatchLayoutDirection() != DevelText::MatchLayoutDirection::CONTENTS;
 777         break;
 778       }
 779       case Toolkit::DevelTextLabel::Property::TEXT_FIT:
 780       {
 781         const bool  enabled   = impl.mController->IsTextFitEnabled();
 782         const float minSize   = impl.mController->GetTextFitMinSize();
 783         const float maxSize   = impl.mController->GetTextFitMaxSize();
 784         const float stepSize  = impl.mController->GetTextFitStepSize();
 785         const float pointSize = impl.mController->GetTextFitPointSize();
 786
 787         Property::Map map;
 788         map.Insert(TEXT_FIT_ENABLE_KEY, enabled);
 789         map.Insert(TEXT_FIT_MIN_SIZE_KEY, minSize);
 790         map.Insert(TEXT_FIT_MAX_SIZE_KEY, maxSize);
 791         map.Insert(TEXT_FIT_STEP_SIZE_KEY, stepSize);
 792         map.Insert(TEXT_FIT_FONT_SIZE_KEY, pointSize);
 793         map.Insert(TEXT_FIT_FONT_SIZE_TYPE_KEY, "pointSize");
 794
 795         value = map;
 796         break;
 797       }
 798       case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
 799       {
 800         // If TextFitArray is enabled, the stored value (MIN_LINE_SIZE set by the user) is retrun.
 801         value = impl.mController->IsTextFitArrayEnabled() ? impl.mController->GetCurrentLineSize() : impl.mController->GetDefaultLineSize();
 802         break;
 803       }
 804       case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
 805       {
 806         value = impl.mController->GetFontSizeScale();
 807         break;
 808       }
 809       case Toolkit::DevelTextLabel::Property::ENABLE_FONT_SIZE_SCALE:
 810       {
 811         value = impl.mController->IsFontSizeScaleEnabled();
 812         break;
 813       }
 814       case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
 815       {
 816         value = impl.mController->GetEllipsisPosition();
 817         break;
 818       }
 819       case Toolkit::DevelTextLabel::Property::STRIKETHROUGH:
 820       {
 821         GetStrikethroughProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
 822         break;
 823       }
 824       case Toolkit::DevelTextLabel::Property::CHARACTER_SPACING:
 825       {
 826         value = impl.mController->GetCharacterSpacing();
 827         break;
 828       }
 829       case Toolkit::DevelTextLabel::Property::RELATIVE_LINE_SIZE:
 830       {
 831         value = impl.mController->GetRelativeLineSize();
 832         break;
 833       }
 834     }
 835   }
 836
 837   return value;
 838 }
 839
 840 bool TextLabel::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
 841 {
 842   Dali::BaseHandle handle(object);
 843
 844   bool               connected(true);
 845   Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(handle);
 846
 847   if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
 848   {
 849     if(label)
 850     {
 851       Internal::TextLabel& labelImpl(GetImpl(label));
 852       labelImpl.AnchorClickedSignal().Connect(tracker, functor);
 853     }
 854   }
 855   else if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_FIT_CHANGED))
 856   {
 857     if(label)
 858     {
 859       Internal::TextLabel& labelImpl(GetImpl(label));
 860       labelImpl.TextFitChangedSignal().Connect(tracker, functor);
 861     }
 862   }
 863   else
 864   {
 865     // signalName does not match any signal
 866     connected = false;
 867   }
 868
 869   return connected;
 870 }
 871
 872 DevelTextLabel::AnchorClickedSignalType& TextLabel::AnchorClickedSignal()
 873 {
 874   return mAnchorClickedSignal;
 875 }
 876
 877 DevelTextLabel::TextFitChangedSignalType& TextLabel::TextFitChangedSignal()
 878 {
 879   return mTextFitChangedSignal;
 880 }
 881
 882 void TextLabel::OnInitialize()
 883 {
 884   Actor self = Self();
 885
 886   Property::Map propertyMap;
 887   propertyMap.Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
 888
 889   mVisual = Toolkit::VisualFactory::Get().CreateVisual(propertyMap);
 890   DevelControl::RegisterVisual(*this, Toolkit::TextLabel::Property::TEXT, mVisual);
 891
 892   TextVisual::SetAnimatableTextColorProperty(mVisual, Toolkit::TextLabel::Property::TEXT_COLOR);
 893
 894   mController = TextVisual::GetController(mVisual);
 895   DALI_ASSERT_DEBUG(mController && "Invalid Text Controller")
 896
 897   mController->SetControlInterface(this);
 898   mController->SetAnchorControlInterface(this);
 899
 900   // Use height-for-width negotiation by default
 901   self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
 902   self.SetResizePolicy(ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT);
 903
 904   // Enable the text ellipsis.
 905   mController->SetTextElideEnabled(true); // If false then text larger than control will overflow
 906
 907   // Sets layoutDirection value
 908   Dali::Stage                 stage           = Dali::Stage::GetCurrent();
 909   Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
 910   mController->SetLayoutDirection(layoutDirection);
 911
 912   self.LayoutDirectionChangedSignal().Connect(this, &TextLabel::OnLayoutDirectionChanged);
 913
 914   Layout::Engine& engine = mController->GetLayoutEngine();
 915   engine.SetCursorWidth(0u); // Do not layout space for the cursor.
 916
 917   // Accessibility
 918   self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::LABEL);
 919   self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
 920
 921   Accessibility::Bridge::EnabledSignal().Connect(this, &TextLabel::OnAccessibilityStatusChanged);
 922   Accessibility::Bridge::DisabledSignal().Connect(this, &TextLabel::OnAccessibilityStatusChanged);
 923 }
 924
 925 DevelControl::ControlAccessible* TextLabel::CreateAccessibleObject()
 926 {
 927   return new TextLabelAccessible(Self());
 928 }
 929
 930 void TextLabel::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
 931 {
 932   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
 933
 934   switch(change)
 935   {
 936     case StyleChange::DEFAULT_FONT_CHANGE:
 937     {
 938       // Property system did not set the font so should update it.
 939       const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
 940       DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str());
 941       mController->UpdateAfterFontChange(newFont);
 942       RelayoutRequest();
 943       break;
 944     }
 945     case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
 946     {
 947       GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
 948       RelayoutRequest();
 949       break;
 950     }
 951     case StyleChange::THEME_CHANGE:
 952     {
 953       // Nothing to do, let control base class handle this
 954       break;
 955     }
 956   }
 957
 958   // Up call to Control
 959   Control::OnStyleChange(styleManager, change);
 960 }
 961
 962 void TextLabel::OnTap(const TapGesture& gesture)
 963 {
 964   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnTap %p\n", mController.Get());
 965
 966   // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
 967   Extents padding;
 968   padding                   = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 969   const Vector2& localPoint = gesture.GetLocalPoint();
 970   mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
 971 }
 972
 973 void TextLabel::AnchorClicked(const std::string& href)
 974 {
 975   Dali::Toolkit::TextLabel handle(GetOwner());
 976   mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
 977 }
 978
 979 Vector3 TextLabel::GetNaturalSize()
 980 {
 981   Extents padding;
 982   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 983
 984   Vector3 naturalSize = mController->GetNaturalSize();
 985   naturalSize.width += (padding.start + padding.end);
 986   naturalSize.height += (padding.top + padding.bottom);
 987
 988   return naturalSize;
 989 }
 990
 991 float TextLabel::GetHeightForWidth(float width)
 992 {
 993   Extents padding;
 994   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 995
 996   return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
 997 }
 998
 999 void TextLabel::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
1000 {
1001   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index);
1002
1003   switch(index)
1004   {
1005     case Toolkit::TextLabel::Property::TEXT_COLOR:
1006     {
1007       const Vector4& textColor = propertyValue.Get<Vector4>();
1008       if(mController->GetDefaultColor() != textColor)
1009       {
1010         mController->SetDefaultColor(textColor);
1011         mTextUpdateNeeded = true;
1012       }
1013       break;
1014     }
1015     case Toolkit::TextLabel::Property::TEXT:
1016     case Toolkit::TextLabel::Property::ENABLE_MARKUP:
1017     {
1018       CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
1019       break;
1020     }
1021     default:
1022     {
1023       Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
1024       break;
1025     }
1026   }
1027 }
1028
1029 void TextLabel::OnSceneConnection(int depth)
1030 {
1031   if(mController->IsAutoScrollEnabled() || mLastAutoScrollEnabled)
1032   {
1033     mController->SetAutoScrollEnabled(true);
1034   }
1035   Control::OnSceneConnection(depth);
1036 }
1037
1038 void TextLabel::OnSceneDisconnection()
1039 {
1040   if(mTextScroller)
1041   {
1042     if(mLastAutoScrollEnabled && !mController->IsAutoScrollEnabled())
1043     {
1044       mLastAutoScrollEnabled = false;
1045     }
1046
1047     const Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = mTextScroller->GetStopMode();
1048     mTextScroller->SetStopMode(Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE);
1049     mTextScroller->StopScrolling();
1050     mTextScroller->SetStopMode(stopMode);
1051   }
1052   Control::OnSceneDisconnection();
1053 }
1054
1055 void TextLabel::OnRelayout(const Vector2& size, RelayoutContainer& container)
1056 {
1057   DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout\n");
1058
1059   Actor self = Self();
1060
1061   Extents padding;
1062   padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
1063
1064   Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
1065
1066   if(mController->IsTextFitArrayEnabled())
1067   {
1068     mController->FitArrayPointSizeforLayout(contentSize);
1069     mController->SetTextFitContentSize(contentSize);
1070   }
1071   else if(mController->IsTextFitEnabled())
1072   {
1073     mController->FitPointSizeforLayout(contentSize);
1074     mController->SetTextFitContentSize(contentSize);
1075   }
1076
1077   // Support Right-To-Left
1078   Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
1079
1080   const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
1081
1082   if((Text::Controller::NONE_UPDATED != (Text::Controller::MODEL_UPDATED & updateTextType)) || mTextUpdateNeeded)
1083   {
1084     DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", (mController->IsAutoScrollEnabled()) ? "true" : "false", this);
1085
1086     // Update the visual
1087     TextVisual::EnableRendererUpdate(mVisual);
1088
1089     // Support Right-To-Left of padding
1090     if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
1091     {
1092       std::swap(padding.start, padding.end);
1093     }
1094
1095     // Calculate the size of the visual that can fit the text
1096     Size layoutSize = mController->GetTextModel()->GetLayoutSize();
1097     layoutSize.x    = contentSize.x;
1098
1099     const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
1100     if(shadowOffset.y > Math::MACHINE_EPSILON_1)
1101     {
1102       layoutSize.y += shadowOffset.y;
1103     }
1104
1105     float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
1106     layoutSize.y += outlineWidth * 2.0f;
1107     layoutSize.y = std::min(layoutSize.y, contentSize.y);
1108
1109     // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
1110     Vector2 alignmentOffset;
1111     alignmentOffset.x = 0.0f;
1112     alignmentOffset.y = (contentSize.y - layoutSize.y) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
1113
1114     const int maxTextureSize = Dali::GetMaxTextureSize();
1115     if(layoutSize.width > maxTextureSize)
1116     {
1117       DALI_LOG_WARNING("layoutSize(%f) > maxTextureSize(%d): To guarantee the behavior of Texture::New, layoutSize must not be bigger than maxTextureSize\n", layoutSize.width, maxTextureSize);
1118       layoutSize.width = maxTextureSize;
1119     }
1120
1121     // This affects font rendering quality.
1122     // It need to be integerized.
1123     Vector2 visualTransformOffset;
1124     visualTransformOffset.x = roundf(padding.start + alignmentOffset.x);
1125     visualTransformOffset.y = roundf(padding.top + alignmentOffset.y);
1126
1127     Property::Map visualTransform;
1128     visualTransform.Add(Toolkit::Visual::Transform::Property::SIZE, layoutSize)
1129       .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
1130       .Add(Toolkit::Visual::Transform::Property::OFFSET, visualTransformOffset)
1131       .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
1132       .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
1133       .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN);
1134     mVisual.SetTransformAndSize(visualTransform, size);
1135
1136     if(mController->IsAutoScrollEnabled())
1137     {
1138       SetUpAutoScrolling();
1139     }
1140
1141     mTextUpdateNeeded = false;
1142   }
1143
1144   if(mController->IsTextFitChanged())
1145   {
1146     EmitTextFitChangedSignal();
1147     mController->SetTextFitChanged(false);
1148   }
1149 }
1150
1151 void TextLabel::RequestTextRelayout()
1152 {
1153   RelayoutRequest();
1154   // Signal that a Relayout may be needed
1155 }
1156
1157 void TextLabel::SetUpAutoScrolling()
1158 {
1159   const Size&                    controlSize     = mController->GetView().GetControlSize();
1160   const Size                     textNaturalSize = GetNaturalSize().GetVectorXY(); // As relayout of text may not be done at this point natural size is used to get size. Single line scrolling only.
1161   const Text::CharacterDirection direction       = mController->GetAutoScrollDirection();
1162
1163   DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n", textNaturalSize.x, textNaturalSize.y, controlSize.x, controlSize.y);
1164
1165   if(!mTextScroller)
1166   {
1167     DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n");
1168
1169     // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
1170     mTextScroller = Text::TextScroller::New(*this);
1171   }
1172
1173   // Calculate the actual gap before scrolling wraps.
1174   int     textPadding = std::max(controlSize.x - textNaturalSize.x, 0.0f);
1175   float   wrapGap     = std::max(mTextScroller->GetGap(), textPadding);
1176   Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
1177
1178   // Create a texture of the text for scrolling
1179   Size      verifiedSize   = textureSize;
1180   const int maxTextureSize = Dali::GetMaxTextureSize();
1181
1182   //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
1183   bool actualellipsis = mController->IsTextElideEnabled();
1184   if(verifiedSize.width > maxTextureSize)
1185   {
1186     verifiedSize.width = maxTextureSize;
1187     if(textNaturalSize.width > maxTextureSize)
1188     {
1189       mController->SetTextElideEnabled(true);
1190       mController->SetAutoScrollMaxTextureExceeded(true);
1191     }
1192     GetHeightForWidth(maxTextureSize);
1193     wrapGap = std::max(maxTextureSize - textNaturalSize.width, 0.0f);
1194   }
1195
1196   Text::TypesetterPtr typesetter = Text::Typesetter::New(mController->GetTextModel());
1197
1198   PixelData data    = typesetter->Render(verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888); // ignore the horizontal alignment
1199   Texture   texture = Texture::New(Dali::TextureType::TEXTURE_2D,
1200                                  data.GetPixelFormat(),
1201                                  data.GetWidth(),
1202                                  data.GetHeight());
1203   texture.Upload(data);
1204
1205   TextureSet textureSet = TextureSet::New();
1206   textureSet.SetTexture(0u, texture);
1207
1208   // Filter mode needs to be set to linear to produce better quality while scaling.
1209   Sampler sampler = Sampler::New();
1210   sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
1211   sampler.SetWrapMode(Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT); // Wrap the texture in the x direction
1212   textureSet.SetSampler(0u, sampler);
1213
1214   // Set parameters for scrolling
1215   Renderer renderer = static_cast<Internal::Visual::Base&>(GetImplementation(mVisual)).GetRenderer();
1216   mTextScroller->SetParameters(Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment());
1217   mController->SetTextElideEnabled(actualellipsis);
1218   mController->SetAutoScrollMaxTextureExceeded(false);
1219 }
1220
1221 void TextLabel::ScrollingFinished()
1222 {
1223   // Pure Virtual from TextScroller Interface
1224   DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1225
1226   if(mController->IsAutoScrollEnabled() || !mController->IsMultiLineEnabled())
1227   {
1228     mController->SetAutoScrollEnabled(false);
1229     RequestTextRelayout();
1230   }
1231 }
1232
1233 void TextLabel::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1234 {
1235   mController->ChangedLayoutDirection();
1236 }
1237
1238 void TextLabel::EmitTextFitChangedSignal()
1239 {
1240   Dali::Toolkit::TextLabel handle(GetOwner());
1241   mTextFitChangedSignal.Emit(handle);
1242 }
1243
1244 void TextLabel::OnAccessibilityStatusChanged()
1245 {
1246   CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
1247 }
1248
1249 TextLabel::TextLabel(ControlBehaviour additionalBehaviour)
1250 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
1251   mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1252   mTextUpdateNeeded(false),
1253   mLastAutoScrollEnabled(false)
1254 {
1255 }
1256
1257 TextLabel::~TextLabel()
1258 {
1259 }
1260
1261 Vector<Vector2> TextLabel::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
1262 {
1263   return mController->GetTextSize(startIndex, endIndex);
1264 }
1265
1266 Vector<Vector2> TextLabel::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
1267 {
1268   return mController->GetTextPosition(startIndex, endIndex);
1269 }
1270
1271 Rect<float> TextLabel::GetLineBoundingRectangle(const uint32_t lineIndex) const
1272 {
1273   return mController->GetLineBoundingRectangle(lineIndex);
1274 }
1275
1276 Rect<float> TextLabel::GetCharacterBoundingRectangle(const uint32_t charIndex) const
1277 {
1278   return mController->GetCharacterBoundingRectangle(charIndex);
1279 }
1280
1281 int TextLabel::GetCharacterIndexAtPosition(float visualX, float visualY) const
1282 {
1283   return mController->GetCharacterIndexAtPosition(visualX, visualY);
1284 }
1285
1286 Rect<> TextLabel::GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const
1287 {
1288   return mController->GetTextBoundingRectangle(startIndex, endIndex);
1289 }
1290
1291 void TextLabel::SetSpannedText(const Text::Spanned& spannedText)
1292 {
1293   mController->SetSpannedText(spannedText);
1294 }
1295
1296 void TextLabel::SetTextFitArray(const bool enable, std::vector<Toolkit::DevelTextLabel::FitOption>& fitOptions)
1297 {
1298   if(!enable)
1299   {
1300     // If TextFitArray is disabled, MinLineSize shoud be restored to its original size.
1301     mController->SetDefaultLineSize(mController->GetCurrentLineSize());
1302   }
1303   mController->SetTextFitArrayEnabled(enable);
1304   mController->SetTextFitArray(fitOptions);
1305 }
1306
1307 std::vector<Toolkit::DevelTextLabel::FitOption>& TextLabel::GetTextFitArray()
1308 {
1309   return mController->GetTextFitArray();
1310 }
1311
1312 bool TextLabel::IsTextFitArrayEnabled() const
1313 {
1314   return mController->IsTextFitArrayEnabled();
1315 }
1316
1317 std::string TextLabel::TextLabelAccessible::GetNameRaw() const
1318 {
1319   return GetWholeText();
1320 }
1321
1322 Property::Index TextLabel::TextLabelAccessible::GetNamePropertyIndex()
1323 {
1324   return Toolkit::TextLabel::Property::TEXT;
1325 }
1326
1327 const std::vector<Toolkit::TextAnchor>& TextLabel::TextLabelAccessible::GetTextAnchors() const
1328 {
1329   auto self = Toolkit::TextLabel::DownCast(Self());
1330
1331   return Toolkit::GetImpl(self).mAnchorActors;
1332 }
1333
1334 Toolkit::Text::ControllerPtr TextLabel::TextLabelAccessible::GetTextController() const
1335 {
1336   auto self = Toolkit::TextLabel::DownCast(Self());
1337
1338   return Toolkit::GetImpl(self).GetTextController();
1339 }
1340
1341 } // namespace Internal
1342
1343 } // namespace Toolkit
1344
1345 } // namespace Dali