2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/controls/text-controls/text-label-impl.h>
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/adaptor-framework/adaptor.h>
27 #include <dali/integration-api/debug.h>
28 #include <dali/public-api/common/dali-common.h>
29 #include <dali/public-api/object/type-registry-helper.h>
32 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
33 #include <dali-toolkit/devel-api/text/rendering-backend.h>
34 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
35 #include <dali-toolkit/internal/styling/style-manager-impl.h>
36 #include <dali-toolkit/internal/text/property-string-parser.h>
37 #include <dali-toolkit/internal/text/rendering/text-backend.h>
38 #include <dali-toolkit/internal/text/text-definitions.h>
39 #include <dali-toolkit/internal/text/text-effects-style.h>
40 #include <dali-toolkit/internal/text/text-font-style.h>
41 #include <dali-toolkit/internal/text/text-view.h>
42 #include <dali-toolkit/public-api/text/text-enumerations.h>
44 #include <dali-toolkit/devel-api/controls/control-devel.h>
45 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
46 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
47 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
48 #include <dali-toolkit/public-api/align-enumerations.h>
49 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
50 #include <dali-toolkit/public-api/visuals/visual-properties.h>
53 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
55 using namespace Dali::Toolkit::Text;
65 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
68 * @brief How the text visual should be aligned vertically inside the control.
70 * 0.0f aligns the text to the top, 0.5f aligns the text to the center, 1.0f aligns the text to the bottom.
71 * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
73 const float VERTICAL_ALIGNMENT_TABLE[Text::VerticalAlignment::BOTTOM + 1] =
75 0.0f, // VerticalAlignment::TOP
76 0.5f, // VerticalAlignment::CENTER
77 1.0f // VerticalAlignment::BOTTOM
80 const char* TEXT_FIT_ENABLE_KEY("enable");
81 const char* TEXT_FIT_MIN_SIZE_KEY("minSize");
82 const char* TEXT_FIT_MAX_SIZE_KEY("maxSize");
83 const char* TEXT_FIT_STEP_SIZE_KEY("stepSize");
84 const char* TEXT_FIT_FONT_SIZE_KEY("fontSize");
85 const char* TEXT_FIT_FONT_SIZE_TYPE_KEY("fontSizeType");
87 #if defined(DEBUG_ENABLED)
88 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
91 const Scripting::StringEnum AUTO_SCROLL_STOP_MODE_TABLE[] =
93 {"IMMEDIATE", Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE},
94 {"FINISH_LOOP", Toolkit::TextLabel::AutoScrollStopMode::FINISH_LOOP},
96 const unsigned int AUTO_SCROLL_STOP_MODE_TABLE_COUNT = sizeof(AUTO_SCROLL_STOP_MODE_TABLE) / sizeof(AUTO_SCROLL_STOP_MODE_TABLE[0]);
101 return Toolkit::TextLabel::New();
105 // Setup properties, signals and actions using the type-registry.
106 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextLabel, Toolkit::Control, Create);
108 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "text", STRING, TEXT )
109 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontFamily", STRING, FONT_FAMILY )
110 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontStyle", MAP, FONT_STYLE )
111 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "pointSize", FLOAT, POINT_SIZE )
112 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "multiLine", BOOLEAN, MULTI_LINE )
113 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
114 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
115 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "enableMarkup", BOOLEAN, ENABLE_MARKUP )
116 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "enableAutoScroll", BOOLEAN, ENABLE_AUTO_SCROLL )
117 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollSpeed", INTEGER, AUTO_SCROLL_SPEED )
118 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollLoopCount", INTEGER, AUTO_SCROLL_LOOP_COUNT )
119 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollGap", FLOAT, AUTO_SCROLL_GAP )
120 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "lineSpacing", FLOAT, LINE_SPACING )
121 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "underline", MAP, UNDERLINE )
122 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "shadow", MAP, SHADOW )
123 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "emboss", MAP, EMBOSS )
124 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "outline", MAP, OUTLINE )
125 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "pixelSize", FLOAT, PIXEL_SIZE )
126 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ellipsis", BOOLEAN, ELLIPSIS )
127 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollLoopDelay", FLOAT, AUTO_SCROLL_LOOP_DELAY )
128 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollStopMode", STRING, AUTO_SCROLL_STOP_MODE )
129 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextLabel, "lineCount", INTEGER, LINE_COUNT )
130 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "lineWrapMode", INTEGER, LINE_WRAP_MODE )
131 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextLabel, "textDirection", INTEGER, TEXT_DIRECTION )
132 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "verticalLineAlignment", INTEGER, VERTICAL_LINE_ALIGNMENT )
133 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "textBackground", MAP, BACKGROUND )
134 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ignoreSpacesAfterText", BOOLEAN, IGNORE_SPACES_AFTER_TEXT )
135 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION)
136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "textFit", MAP, TEXT_FIT )
137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "minLineSize", FLOAT, MIN_LINE_SIZE )
138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "renderingBackend", INTEGER, RENDERING_BACKEND )
139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontSizeScale", FLOAT, FONT_SIZE_SCALE )
140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "enableFontSizeScale", BOOLEAN, ENABLE_FONT_SIZE_SCALE )
141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ellipsisPosition", INTEGER, ELLIPSIS_POSITION )
142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "strikethrough", MAP, STRIKETHROUGH )
143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "characterSpacing", FLOAT, CHARACTER_SPACING )
144 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "relativeLineSize", FLOAT, RELATIVE_LINE_SIZE )
145 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "anchorColor", VECTOR4, ANCHOR_COLOR )
146 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "anchorClickedColor", VECTOR4, ANCHOR_CLICKED_COLOR )
147 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "removeFrontInset", BOOLEAN, REMOVE_FRONT_INSET )
148 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "removeBackInset", BOOLEAN, REMOVE_BACK_INSET )
150 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, TextLabel, "textColor", Color::BLACK, TEXT_COLOR )
151 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorRed", TEXT_COLOR_RED, TEXT_COLOR, 0)
152 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1)
153 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorBlue", TEXT_COLOR_BLUE, TEXT_COLOR, 2)
154 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3)
156 DALI_SIGNAL_REGISTRATION(Toolkit, TextLabel, "anchorClicked", SIGNAL_ANCHOR_CLICKED)
157 DALI_SIGNAL_REGISTRATION(Toolkit, TextLabel, "textFitChanged", SIGNAL_TEXT_FIT_CHANGED)
159 DALI_TYPE_REGISTRATION_END()
162 /// Parses the property map for the TEXT_FIT property
163 void ParseTextFitProperty(Text::ControllerPtr& controller, const Property::Map* propertiesMap)
165 if(propertiesMap && !propertiesMap->Empty())
167 bool enabled = false;
170 float stepSize = 0.f;
171 bool isMinSizeSet = false, isMaxSizeSet = false, isStepSizeSet = false;
172 Controller::FontSizeType type = Controller::FontSizeType::POINT_SIZE;
174 const unsigned int numberOfItems = propertiesMap->Count();
176 // Parses and applies
177 for(unsigned int index = 0u; index < numberOfItems; ++index)
179 const KeyValuePair& valueGet = propertiesMap->GetKeyValue(index);
181 if((Controller::TextFitInfo::Property::TEXT_FIT_ENABLE == valueGet.first.indexKey) || (TEXT_FIT_ENABLE_KEY == valueGet.first.stringKey))
184 enabled = valueGet.second.Get<bool>();
186 else if((Controller::TextFitInfo::Property::TEXT_FIT_MIN_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MIN_SIZE_KEY == valueGet.first.stringKey))
189 minSize = valueGet.second.Get<float>();
192 else if((Controller::TextFitInfo::Property::TEXT_FIT_MAX_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MAX_SIZE_KEY == valueGet.first.stringKey))
195 maxSize = valueGet.second.Get<float>();
198 else if((Controller::TextFitInfo::Property::TEXT_FIT_STEP_SIZE == valueGet.first.indexKey) || (TEXT_FIT_STEP_SIZE_KEY == valueGet.first.stringKey))
201 stepSize = valueGet.second.Get<float>();
202 isStepSizeSet = true;
204 else if((Controller::TextFitInfo::Property::TEXT_FIT_FONT_SIZE_TYPE == valueGet.first.indexKey) || (TEXT_FIT_FONT_SIZE_TYPE_KEY == valueGet.first.stringKey))
206 if("pixelSize" == valueGet.second.Get<std::string>())
208 type = Controller::FontSizeType::PIXEL_SIZE;
213 controller->SetTextFitEnabled(enabled);
214 // The TextFit operation is performed based on the MinLineSize set in the TextLabel at the moment when the TextFit property is set.
215 // So, if you change the TextLabel's MinLineSize after setting the TextFit property, it does not affect the operation of TextFit.
216 // This may require a new LineSize item in TextFit.
217 controller->SetTextFitLineSize(controller->GetDefaultLineSize());
220 controller->SetTextFitMinSize(minSize, type);
224 controller->SetTextFitMaxSize(maxSize, type);
228 controller->SetTextFitStepSize(stepSize, type);
235 Toolkit::TextLabel TextLabel::New(ControlBehaviour additionalBehaviour)
237 // Create the implementation, temporarily owned by this handle on stack
238 IntrusivePtr<TextLabel> impl = new TextLabel(additionalBehaviour);
240 // Pass ownership to CustomActor handle
241 Toolkit::TextLabel handle(*impl);
243 // Second-phase init of the implementation
244 // This can only be done after the CustomActor connection has been made...
250 void TextLabel::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
252 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
256 TextLabel& impl(GetImpl(label));
257 DALI_ASSERT_ALWAYS(impl.mController && "No text contoller");
261 case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
263 int backend = value.Get<int>();
265 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
266 if(DevelText::RENDERING_VECTOR_BASED == backend)
268 backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
271 if(impl.mRenderingBackend != backend)
273 impl.mRenderingBackend = backend;
274 impl.mTextUpdateNeeded = true;
276 // When using the vector-based rendering, the size of the GLyphs are different
277 TextAbstraction::GlyphType glyphType = (DevelText::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
278 impl.mController->SetGlyphType(glyphType);
282 case Toolkit::TextLabel::Property::TEXT:
284 impl.mController->SetText(value.Get<std::string>());
286 if(impl.mController->HasAnchors())
288 // Forward input events to controller
289 impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
293 impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
298 case Toolkit::TextLabel::Property::FONT_FAMILY:
300 const std::string& fontFamily = value.Get<std::string>();
302 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str());
303 impl.mController->SetDefaultFontFamily(fontFamily);
306 case Toolkit::TextLabel::Property::FONT_STYLE:
308 SetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
311 case Toolkit::TextLabel::Property::POINT_SIZE:
313 const float pointSize = value.Get<float>();
315 if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE), pointSize))
317 impl.mController->SetDefaultFontSize(pointSize, Text::Controller::POINT_SIZE);
321 case Toolkit::TextLabel::Property::MULTI_LINE:
323 impl.mController->SetMultiLineEnabled(value.Get<bool>());
326 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
328 Text::HorizontalAlignment::Type alignment(static_cast<Text::HorizontalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
329 if(Text::GetHorizontalAlignmentEnumeration(value, alignment))
331 impl.mController->SetHorizontalAlignment(alignment);
335 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
337 Toolkit::Text::VerticalAlignment::Type alignment(static_cast<Text::VerticalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
338 if(Text::GetVerticalAlignmentEnumeration(value, alignment))
340 impl.mController->SetVerticalAlignment(alignment);
344 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
346 const bool enableMarkup = value.Get<bool>();
347 impl.mController->SetMarkupProcessorEnabled(enableMarkup);
349 if(impl.mController->HasAnchors())
351 // Forward input events to controller
352 impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
356 impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
360 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
362 const bool enableAutoScroll = value.Get<bool>();
363 impl.mLastAutoScrollEnabled = enableAutoScroll;
364 // If request to auto scroll is the same as current state then do nothing.
365 if(enableAutoScroll != impl.mController->IsAutoScrollEnabled())
367 // If request is disable (false) and auto scrolling is enabled then need to stop it
368 if(enableAutoScroll == false)
370 if(impl.mTextScroller)
372 impl.mTextScroller->StopScrolling();
375 // If request is enable (true) then start autoscroll as not already running
378 impl.mController->SetAutoScrollEnabled(enableAutoScroll);
383 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
385 Text::TextScrollerPtr textScroller = impl.GetTextScroller();
386 Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = textScroller->GetStopMode();
387 if(Scripting::GetEnumerationProperty<Toolkit::TextLabel::AutoScrollStopMode::Type>(value,
388 AUTO_SCROLL_STOP_MODE_TABLE,
389 AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
392 textScroller->SetStopMode(stopMode);
396 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
398 impl.GetTextScroller()->SetSpeed(value.Get<int>());
401 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
403 impl.GetTextScroller()->SetLoopCount(value.Get<int>());
406 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
408 impl.GetTextScroller()->SetLoopDelay(value.Get<float>());
411 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
413 impl.GetTextScroller()->SetGap(value.Get<float>());
416 case Toolkit::TextLabel::Property::LINE_SPACING:
418 const float lineSpacing = value.Get<float>();
419 impl.mTextUpdateNeeded = impl.mController->SetDefaultLineSpacing(lineSpacing) || impl.mTextUpdateNeeded;
422 case Toolkit::TextLabel::Property::UNDERLINE:
424 impl.mTextUpdateNeeded = SetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
427 case Toolkit::TextLabel::Property::SHADOW:
429 impl.mTextUpdateNeeded = SetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
432 case Toolkit::TextLabel::Property::EMBOSS:
434 impl.mTextUpdateNeeded = SetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
437 case Toolkit::TextLabel::Property::OUTLINE:
439 impl.mTextUpdateNeeded = SetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
442 case Toolkit::TextLabel::Property::PIXEL_SIZE:
444 const float pixelSize = value.Get<float>();
445 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize);
447 if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE), pixelSize))
449 impl.mController->SetDefaultFontSize(pixelSize, Text::Controller::PIXEL_SIZE);
453 case Toolkit::TextLabel::Property::ELLIPSIS:
455 const bool ellipsis = value.Get<bool>();
456 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis);
458 impl.mController->SetTextElideEnabled(ellipsis);
461 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
463 Text::LineWrap::Mode lineWrapMode(static_cast<Text::LineWrap::Mode>(-1)); // Set to invalid value to ensure a valid mode does get set
464 if(GetLineWrapModeEnumeration(value, lineWrapMode))
466 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode);
467 impl.mController->SetLineWrapMode(lineWrapMode);
471 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
473 if(impl.mController->GetTextModel())
475 DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>(value.Get<int>());
477 impl.mController->SetVerticalLineAlignment(alignment);
479 // Property doesn't affect the layout, only Visual must be updated
480 TextVisual::EnableRendererUpdate(impl.mVisual);
482 // No need to trigger full re-layout. Instead call UpdateRenderer() directly
483 TextVisual::UpdateRenderer(impl.mVisual);
487 case Toolkit::DevelTextLabel::Property::BACKGROUND:
489 impl.mTextUpdateNeeded = SetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
492 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
494 impl.mController->SetIgnoreSpacesAfterText(value.Get<bool>());
497 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
499 impl.mController->SetMatchLayoutDirection(value.Get<bool>() ? DevelText::MatchLayoutDirection::LOCALE : DevelText::MatchLayoutDirection::CONTENTS);
502 case Toolkit::DevelTextLabel::Property::TEXT_FIT:
504 // If TextFitArray is enabled, this should be disabled.
505 if(impl.mController->IsTextFitArrayEnabled())
507 impl.mController->SetDefaultLineSize(impl.mController->GetCurrentLineSize());
508 impl.mController->SetTextFitArrayEnabled(false);
511 ParseTextFitProperty(impl.mController, value.GetMap());
512 impl.mController->SetTextFitChanged(true);
515 case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
517 const float lineSize = value.Get<float>();
518 // If TextFitArray is enabled, do not update the default line size.
519 if(!impl.mController->IsTextFitArrayEnabled())
521 impl.mTextUpdateNeeded = impl.mController->SetDefaultLineSize(lineSize) || impl.mTextUpdateNeeded;
523 impl.mController->SetCurrentLineSize(lineSize);
526 case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
528 const float scale = value.Get<float>();
529 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p FONT_SIZE_SCALE %f\n", impl.mController.Get(), scale);
531 if(!Equals(impl.mController->GetFontSizeScale(), scale))
533 impl.mController->SetFontSizeScale(scale);
537 case Toolkit::DevelTextLabel::Property::ENABLE_FONT_SIZE_SCALE:
539 const bool enableFontSizeScale = value.Get<bool>();
540 if(!Equals(impl.mController->IsFontSizeScaleEnabled(), enableFontSizeScale))
542 impl.mController->SetFontSizeScaleEnabled(enableFontSizeScale);
546 case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
548 DevelText::EllipsisPosition::Type ellipsisPositionType(static_cast<DevelText::EllipsisPosition::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
549 if(GetEllipsisPositionTypeEnumeration(value, ellipsisPositionType))
551 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p EllipsisPosition::Type %d\n", impl.mController.Get(), ellipsisPositionType);
552 impl.mController->SetEllipsisPosition(ellipsisPositionType);
556 case Toolkit::DevelTextLabel::Property::STRIKETHROUGH:
558 impl.mTextUpdateNeeded = SetStrikethroughProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
561 case Toolkit::DevelTextLabel::Property::CHARACTER_SPACING:
563 const float characterSpacing = value.Get<float>();
564 impl.mController->SetCharacterSpacing(characterSpacing);
567 case Toolkit::DevelTextLabel::Property::RELATIVE_LINE_SIZE:
569 const float relativeLineSize = value.Get<float>();
570 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel %p RELATIVE_LINE_SIZE %f\n", impl.mController.Get(), relativeLineSize);
572 impl.mController->SetRelativeLineSize(relativeLineSize);
575 case Toolkit::DevelTextLabel::Property::ANCHOR_COLOR:
577 const Vector4& anchorColor = value.Get<Vector4>();
578 if(impl.mController->GetAnchorColor() != anchorColor)
580 impl.mController->SetAnchorColor(anchorColor);
581 impl.mTextUpdateNeeded = true;
585 case Toolkit::DevelTextLabel::Property::ANCHOR_CLICKED_COLOR:
587 const Vector4& anchorClickedColor = value.Get<Vector4>();
588 if(impl.mController->GetAnchorClickedColor() != anchorClickedColor)
590 impl.mController->SetAnchorClickedColor(anchorClickedColor);
591 impl.mTextUpdateNeeded = true;
595 case Toolkit::DevelTextLabel::Property::REMOVE_FRONT_INSET:
597 const bool remove = value.Get<bool>();
598 impl.mController->SetRemoveFrontInset(remove);
601 case Toolkit::DevelTextLabel::Property::REMOVE_BACK_INSET:
603 const bool remove = value.Get<bool>();
604 impl.mController->SetRemoveBackInset(remove);
609 // Request relayout when text update is needed. It's necessary to call it
610 // as changing the property not via UI interaction brings no effect if only
611 // the mTextUpdateNeeded is changed.
612 if(impl.mTextUpdateNeeded)
614 // need to request relayout as size of text may have changed
615 impl.RequestTextRelayout();
620 Text::ControllerPtr TextLabel::GetTextController()
625 Property::Value TextLabel::GetProperty(BaseObject* object, Property::Index index)
627 Property::Value value;
629 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
633 TextLabel& impl(GetImpl(label));
634 DALI_ASSERT_DEBUG(impl.mController && "No text contoller");
638 case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
640 value = impl.mRenderingBackend;
643 case Toolkit::TextLabel::Property::TEXT:
646 impl.mController->GetText(text);
650 case Toolkit::TextLabel::Property::FONT_FAMILY:
652 value = impl.mController->GetDefaultFontFamily();
655 case Toolkit::TextLabel::Property::FONT_STYLE:
657 GetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
660 case Toolkit::TextLabel::Property::POINT_SIZE:
662 value = impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE);
665 case Toolkit::TextLabel::Property::MULTI_LINE:
667 value = impl.mController->IsMultiLineEnabled();
670 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
672 const char* name = Text::GetHorizontalAlignmentString(impl.mController->GetHorizontalAlignment());
676 value = std::string(name);
680 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
682 const char* name = Text::GetVerticalAlignmentString(impl.mController->GetVerticalAlignment());
685 value = std::string(name);
689 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
691 value = impl.mController->IsMarkupProcessorEnabled();
694 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
696 value = impl.mController->IsAutoScrollEnabled();
699 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
701 if(impl.mTextScroller)
703 const char* mode = Scripting::GetEnumerationName<Toolkit::TextLabel::AutoScrollStopMode::Type>(impl.mTextScroller->GetStopMode(),
704 AUTO_SCROLL_STOP_MODE_TABLE,
705 AUTO_SCROLL_STOP_MODE_TABLE_COUNT);
708 value = std::string(mode);
713 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
715 if(impl.mTextScroller)
717 value = impl.mTextScroller->GetSpeed();
721 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
723 if(impl.mTextScroller)
725 value = impl.mTextScroller->GetLoopCount();
729 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
731 if(impl.mTextScroller)
733 value = impl.mTextScroller->GetLoopDelay();
737 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
739 if(impl.mTextScroller)
741 value = impl.mTextScroller->GetGap();
745 case Toolkit::TextLabel::Property::LINE_SPACING:
747 value = impl.mController->GetDefaultLineSpacing();
750 case Toolkit::TextLabel::Property::UNDERLINE:
752 GetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
755 case Toolkit::TextLabel::Property::SHADOW:
757 GetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
760 case Toolkit::TextLabel::Property::EMBOSS:
762 GetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
765 case Toolkit::TextLabel::Property::OUTLINE:
767 GetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
770 case Toolkit::TextLabel::Property::PIXEL_SIZE:
772 value = impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE);
775 case Toolkit::TextLabel::Property::ELLIPSIS:
777 value = impl.mController->IsTextElideEnabled();
780 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
782 value = impl.mController->GetLineWrapMode();
785 case Toolkit::TextLabel::Property::LINE_COUNT:
787 float width = label.GetProperty(Actor::Property::SIZE_WIDTH).Get<float>();
788 value = impl.mController->GetLineCount(width);
791 case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
793 value = impl.mController->GetTextDirection();
796 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
798 value = impl.mController->GetVerticalLineAlignment();
801 case Toolkit::DevelTextLabel::Property::BACKGROUND:
803 GetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
806 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
808 value = impl.mController->IsIgnoreSpacesAfterText();
811 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
813 value = impl.mController->GetMatchLayoutDirection() != DevelText::MatchLayoutDirection::CONTENTS;
816 case Toolkit::DevelTextLabel::Property::TEXT_FIT:
818 const bool enabled = impl.mController->IsTextFitEnabled();
819 const float minSize = impl.mController->GetTextFitMinSize();
820 const float maxSize = impl.mController->GetTextFitMaxSize();
821 const float stepSize = impl.mController->GetTextFitStepSize();
822 const float pointSize = impl.mController->GetTextFitPointSize();
825 map.Insert(TEXT_FIT_ENABLE_KEY, enabled);
826 map.Insert(TEXT_FIT_MIN_SIZE_KEY, minSize);
827 map.Insert(TEXT_FIT_MAX_SIZE_KEY, maxSize);
828 map.Insert(TEXT_FIT_STEP_SIZE_KEY, stepSize);
829 map.Insert(TEXT_FIT_FONT_SIZE_KEY, pointSize);
830 map.Insert(TEXT_FIT_FONT_SIZE_TYPE_KEY, "pointSize");
835 case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
837 // If TextFitArray is enabled, the stored value (MIN_LINE_SIZE set by the user) is retrun.
838 value = impl.mController->IsTextFitArrayEnabled() ? impl.mController->GetCurrentLineSize() : impl.mController->GetDefaultLineSize();
841 case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
843 value = impl.mController->GetFontSizeScale();
846 case Toolkit::DevelTextLabel::Property::ENABLE_FONT_SIZE_SCALE:
848 value = impl.mController->IsFontSizeScaleEnabled();
851 case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
853 value = impl.mController->GetEllipsisPosition();
856 case Toolkit::DevelTextLabel::Property::STRIKETHROUGH:
858 GetStrikethroughProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
861 case Toolkit::DevelTextLabel::Property::CHARACTER_SPACING:
863 value = impl.mController->GetCharacterSpacing();
866 case Toolkit::DevelTextLabel::Property::RELATIVE_LINE_SIZE:
868 value = impl.mController->GetRelativeLineSize();
871 case Toolkit::DevelTextLabel::Property::ANCHOR_COLOR:
873 value = impl.mController->GetAnchorColor();
876 case Toolkit::DevelTextLabel::Property::ANCHOR_CLICKED_COLOR:
878 value = impl.mController->GetAnchorClickedColor();
881 case Toolkit::DevelTextLabel::Property::REMOVE_FRONT_INSET:
883 value = impl.mController->IsRemoveFrontInset();
886 case Toolkit::DevelTextLabel::Property::REMOVE_BACK_INSET:
888 value = impl.mController->IsRemoveBackInset();
897 bool TextLabel::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
899 Dali::BaseHandle handle(object);
901 bool connected(true);
902 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(handle);
904 if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
908 Internal::TextLabel& labelImpl(GetImpl(label));
909 labelImpl.AnchorClickedSignal().Connect(tracker, functor);
912 else if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_FIT_CHANGED))
916 Internal::TextLabel& labelImpl(GetImpl(label));
917 labelImpl.TextFitChangedSignal().Connect(tracker, functor);
922 // signalName does not match any signal
929 DevelTextLabel::AnchorClickedSignalType& TextLabel::AnchorClickedSignal()
931 return mAnchorClickedSignal;
934 DevelTextLabel::TextFitChangedSignalType& TextLabel::TextFitChangedSignal()
936 return mTextFitChangedSignal;
939 void TextLabel::OnInitialize()
943 Property::Map propertyMap;
944 propertyMap.Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
946 mVisual = Toolkit::VisualFactory::Get().CreateVisual(propertyMap);
947 DevelControl::RegisterVisual(*this, Toolkit::TextLabel::Property::TEXT, mVisual);
949 TextVisual::SetAnimatableTextColorProperty(mVisual, Toolkit::TextLabel::Property::TEXT_COLOR);
951 mController = TextVisual::GetController(mVisual);
952 DALI_ASSERT_DEBUG(mController && "Invalid Text Controller")
954 mController->SetControlInterface(this);
955 mController->SetAnchorControlInterface(this);
957 // Use height-for-width negotiation by default
958 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
959 self.SetResizePolicy(ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT);
961 // Enable the text ellipsis.
962 mController->SetTextElideEnabled(true); // If false then text larger than control will overflow
964 // Sets layoutDirection value
965 Dali::Stage stage = Dali::Stage::GetCurrent();
966 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
967 mController->SetLayoutDirection(layoutDirection);
969 self.LayoutDirectionChangedSignal().Connect(this, &TextLabel::OnLayoutDirectionChanged);
971 if(Dali::Adaptor::IsAvailable())
973 Dali::Adaptor::Get().LocaleChangedSignal().Connect(this, &TextLabel::OnLocaleChanged);
976 Layout::Engine& engine = mController->GetLayoutEngine();
977 engine.SetCursorWidth(0u); // Do not layout space for the cursor.
980 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::LABEL);
981 self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
983 Accessibility::Bridge::EnabledSignal().Connect(this, &TextLabel::OnAccessibilityStatusChanged);
984 Accessibility::Bridge::DisabledSignal().Connect(this, &TextLabel::OnAccessibilityStatusChanged);
987 DevelControl::ControlAccessible* TextLabel::CreateAccessibleObject()
989 return new TextLabelAccessible(Self());
992 void TextLabel::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
994 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
998 case StyleChange::DEFAULT_FONT_CHANGE:
1000 // Property system did not set the font so should update it.
1001 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
1002 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str());
1003 mController->UpdateAfterFontChange(newFont);
1007 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
1009 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
1013 case StyleChange::THEME_CHANGE:
1015 // Nothing to do, let control base class handle this
1020 // Up call to Control
1021 Control::OnStyleChange(styleManager, change);
1024 void TextLabel::OnTap(const TapGesture& gesture)
1026 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnTap %p\n", mController.Get());
1028 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
1030 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
1031 const Vector2& localPoint = gesture.GetLocalPoint();
1032 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
1035 void TextLabel::AnchorClicked(const std::string& href)
1037 Dali::Toolkit::TextLabel handle(GetOwner());
1038 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
1041 Vector3 TextLabel::GetNaturalSize()
1044 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
1046 Vector3 naturalSize = mController->GetNaturalSize();
1047 naturalSize.width += (padding.start + padding.end);
1048 naturalSize.height += (padding.top + padding.bottom);
1053 float TextLabel::GetHeightForWidth(float width)
1056 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
1058 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
1061 void TextLabel::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
1063 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index);
1067 case Toolkit::TextLabel::Property::TEXT_COLOR:
1069 const Vector4& textColor = propertyValue.Get<Vector4>();
1070 if(mController->GetDefaultColor() != textColor)
1072 mController->SetDefaultColor(textColor);
1073 mTextUpdateNeeded = true;
1077 case Toolkit::TextLabel::Property::TEXT:
1078 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
1080 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
1085 Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
1091 void TextLabel::OnSceneConnection(int depth)
1093 if(mController->IsAutoScrollEnabled() || mLastAutoScrollEnabled)
1095 mController->SetAutoScrollEnabled(true);
1097 Control::OnSceneConnection(depth);
1100 void TextLabel::OnSceneDisconnection()
1104 if(mLastAutoScrollEnabled && !mController->IsAutoScrollEnabled())
1106 mLastAutoScrollEnabled = false;
1109 const Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = mTextScroller->GetStopMode();
1110 mTextScroller->SetStopMode(Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE);
1111 mTextScroller->StopScrolling();
1112 mTextScroller->SetStopMode(stopMode);
1114 Control::OnSceneDisconnection();
1117 void TextLabel::OnRelayout(const Vector2& size, RelayoutContainer& container)
1119 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout\n");
1121 Actor self = Self();
1124 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
1126 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
1128 if(mController->IsTextFitArrayEnabled())
1130 mController->FitArrayPointSizeforLayout(contentSize);
1131 mController->SetTextFitContentSize(contentSize);
1133 else if(mController->IsTextFitEnabled())
1135 mController->FitPointSizeforLayout(contentSize);
1136 mController->SetTextFitContentSize(contentSize);
1139 // Support Right-To-Left
1140 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
1142 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
1144 if((Text::Controller::NONE_UPDATED != (Text::Controller::MODEL_UPDATED & updateTextType)) || mTextUpdateNeeded)
1146 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", (mController->IsAutoScrollEnabled()) ? "true" : "false", this);
1148 // Update the visual
1149 TextVisual::EnableRendererUpdate(mVisual);
1151 // Support Right-To-Left of padding
1152 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
1154 std::swap(padding.start, padding.end);
1157 // Calculate the size of the visual that can fit the text
1158 Size layoutSize = mController->GetTextModel()->GetLayoutSize();
1159 layoutSize.x = contentSize.x;
1161 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
1162 if(shadowOffset.y > Math::MACHINE_EPSILON_1)
1164 layoutSize.y += shadowOffset.y;
1167 float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
1168 layoutSize.y += outlineWidth * 2.0f;
1169 layoutSize.y = std::min(layoutSize.y, contentSize.y);
1171 // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
1172 Vector2 alignmentOffset;
1173 alignmentOffset.x = 0.0f;
1174 alignmentOffset.y = (contentSize.y - layoutSize.y) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
1176 const int maxTextureSize = Dali::GetMaxTextureSize();
1177 if(layoutSize.width > maxTextureSize)
1179 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);
1180 layoutSize.width = maxTextureSize;
1183 // This affects font rendering quality.
1184 // It need to be integerized.
1185 Vector2 visualTransformOffset;
1186 visualTransformOffset.x = roundf(padding.start + alignmentOffset.x);
1187 visualTransformOffset.y = roundf(padding.top + alignmentOffset.y);
1189 mController->SetVisualTransformOffset(visualTransformOffset);
1191 Property::Map visualTransform;
1192 visualTransform.Add(Toolkit::Visual::Transform::Property::SIZE, layoutSize)
1193 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
1194 .Add(Toolkit::Visual::Transform::Property::OFFSET, visualTransformOffset)
1195 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
1196 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
1197 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN);
1198 mVisual.SetTransformAndSize(visualTransform, size);
1200 if(mController->IsAutoScrollEnabled())
1202 SetUpAutoScrolling();
1205 mTextUpdateNeeded = false;
1208 if(mController->IsTextFitChanged())
1210 EmitTextFitChangedSignal();
1211 mController->SetTextFitChanged(false);
1215 void TextLabel::RequestTextRelayout()
1218 // Signal that a Relayout may be needed
1221 void TextLabel::SetUpAutoScrolling()
1223 const Size& controlSize = mController->GetView().GetControlSize();
1224 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.
1225 const Text::CharacterDirection direction = mController->GetAutoScrollDirection();
1227 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n", textNaturalSize.x, textNaturalSize.y, controlSize.x, controlSize.y);
1231 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n");
1233 // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
1234 mTextScroller = Text::TextScroller::New(*this);
1237 // Calculate the actual gap before scrolling wraps.
1238 int textPadding = std::max(controlSize.x - textNaturalSize.x, 0.0f);
1239 float wrapGap = std::max(mTextScroller->GetGap(), textPadding);
1240 Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
1242 // Create a texture of the text for scrolling
1243 Size verifiedSize = textureSize;
1244 const int maxTextureSize = Dali::GetMaxTextureSize();
1246 //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
1247 bool actualellipsis = mController->IsTextElideEnabled();
1248 if(verifiedSize.width > maxTextureSize)
1250 verifiedSize.width = maxTextureSize;
1251 if(textNaturalSize.width > maxTextureSize)
1253 mController->SetTextElideEnabled(true);
1254 mController->SetAutoScrollMaxTextureExceeded(true);
1256 GetHeightForWidth(maxTextureSize);
1257 wrapGap = std::max(maxTextureSize - textNaturalSize.width, 0.0f);
1260 Text::TypesetterPtr typesetter = Text::Typesetter::New(mController->GetTextModel());
1262 PixelData data = typesetter->Render(verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888); // ignore the horizontal alignment
1263 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D,
1264 data.GetPixelFormat(),
1267 texture.Upload(data);
1269 TextureSet textureSet = TextureSet::New();
1270 textureSet.SetTexture(0u, texture);
1272 // Filter mode needs to be set to linear to produce better quality while scaling.
1273 Sampler sampler = Sampler::New();
1274 sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
1275 sampler.SetWrapMode(Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT); // Wrap the texture in the x direction
1276 textureSet.SetSampler(0u, sampler);
1278 // Set parameters for scrolling
1279 Renderer renderer = static_cast<Internal::Visual::Base&>(GetImplementation(mVisual)).GetRenderer();
1280 mTextScroller->SetParameters(Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment());
1281 mController->SetTextElideEnabled(actualellipsis);
1282 mController->SetAutoScrollMaxTextureExceeded(false);
1285 void TextLabel::ScrollingFinished()
1287 // Pure Virtual from TextScroller Interface
1288 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1290 if(mController->IsAutoScrollEnabled() || !mController->IsMultiLineEnabled())
1292 mController->SetAutoScrollEnabled(false);
1293 RequestTextRelayout();
1297 void TextLabel::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1299 mController->ChangedLayoutDirection();
1302 void TextLabel::OnLocaleChanged(std::string locale)
1304 if(mLocale != locale)
1307 mController->ResetFontAndStyleData();
1311 std::string TextLabel::GetLocale()
1316 void TextLabel::EmitTextFitChangedSignal()
1318 Dali::Toolkit::TextLabel handle(GetOwner());
1319 mTextFitChangedSignal.Emit(handle);
1322 void TextLabel::OnAccessibilityStatusChanged()
1324 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
1327 TextLabel::TextLabel(ControlBehaviour additionalBehaviour)
1328 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
1329 mLocale(std::string()),
1330 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1331 mTextUpdateNeeded(false),
1332 mLastAutoScrollEnabled(false)
1336 TextLabel::~TextLabel()
1340 Vector<Vector2> TextLabel::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
1342 return mController->GetTextSize(startIndex, endIndex);
1345 Vector<Vector2> TextLabel::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
1347 return mController->GetTextPosition(startIndex, endIndex);
1350 Rect<float> TextLabel::GetLineBoundingRectangle(const uint32_t lineIndex) const
1352 return mController->GetLineBoundingRectangle(lineIndex);
1355 Rect<float> TextLabel::GetCharacterBoundingRectangle(const uint32_t charIndex) const
1357 return mController->GetCharacterBoundingRectangle(charIndex);
1360 int TextLabel::GetCharacterIndexAtPosition(float visualX, float visualY) const
1362 return mController->GetCharacterIndexAtPosition(visualX, visualY);
1365 Rect<> TextLabel::GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const
1367 return mController->GetTextBoundingRectangle(startIndex, endIndex);
1370 void TextLabel::SetSpannedText(const Text::Spanned& spannedText)
1372 mController->SetSpannedText(spannedText);
1375 void TextLabel::SetTextFitArray(const bool enable, std::vector<Toolkit::DevelTextLabel::FitOption>& fitOptions)
1379 // If TextFitArray is disabled, MinLineSize shoud be restored to its original size.
1380 mController->SetDefaultLineSize(mController->GetCurrentLineSize());
1382 mController->SetTextFitArrayEnabled(enable);
1383 mController->SetTextFitArray(fitOptions);
1386 std::vector<Toolkit::DevelTextLabel::FitOption>& TextLabel::GetTextFitArray()
1388 return mController->GetTextFitArray();
1391 bool TextLabel::IsTextFitArrayEnabled() const
1393 return mController->IsTextFitArrayEnabled();
1396 void TextLabel::SetRemoveFrontInset(bool remove)
1398 mController->SetRemoveFrontInset(remove);
1401 bool TextLabel::IsRemoveFrontInset() const
1403 return mController->IsRemoveFrontInset();
1406 void TextLabel::SetRemoveBackInset(bool remove)
1408 mController->SetRemoveBackInset(remove);
1411 bool TextLabel::IsRemoveBackInset() const
1413 return mController->IsRemoveBackInset();
1416 std::string TextLabel::TextLabelAccessible::GetNameRaw() const
1418 return GetWholeText();
1421 Property::Index TextLabel::TextLabelAccessible::GetNamePropertyIndex()
1423 return Toolkit::TextLabel::Property::TEXT;
1426 const std::vector<Toolkit::TextAnchor>& TextLabel::TextLabelAccessible::GetTextAnchors() const
1428 auto self = Toolkit::TextLabel::DownCast(Self());
1430 return Toolkit::GetImpl(self).mAnchorActors;
1433 Toolkit::Text::ControllerPtr TextLabel::TextLabelAccessible::GetTextController() const
1435 auto self = Toolkit::TextLabel::DownCast(Self());
1437 return Toolkit::GetImpl(self).GetTextController();
1440 } // namespace Internal
1442 } // namespace Toolkit