2 * Copyright (c) 2021 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/debug.h>
27 #include <dali/public-api/common/dali-common.h>
28 #include <dali/public-api/object/type-registry-helper.h>
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/styling/style-manager-impl.h>
34 #include <dali-toolkit/internal/text/property-string-parser.h>
35 #include <dali-toolkit/internal/text/rendering/text-backend.h>
36 #include <dali-toolkit/internal/text/text-definitions.h>
37 #include <dali-toolkit/internal/text/text-effects-style.h>
38 #include <dali-toolkit/internal/text/text-font-style.h>
39 #include <dali-toolkit/internal/text/text-view.h>
40 #include <dali-toolkit/public-api/text/text-enumerations.h>
42 #include <dali-toolkit/devel-api/controls/control-devel.h>
43 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
44 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
45 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
46 #include <dali-toolkit/public-api/align-enumerations.h>
47 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
48 #include <dali-toolkit/public-api/visuals/visual-properties.h>
51 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
53 using namespace Dali::Toolkit::Text;
63 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
66 * @brief How the text visual should be aligned vertically inside the control.
68 * 0.0f aligns the text to the top, 0.5f aligns the text to the center, 1.0f aligns the text to the bottom.
69 * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
71 const float VERTICAL_ALIGNMENT_TABLE[Text::VerticalAlignment::BOTTOM + 1] =
73 0.0f, // VerticalAlignment::TOP
74 0.5f, // VerticalAlignment::CENTER
75 1.0f // VerticalAlignment::BOTTOM
78 const std::string TEXT_FIT_ENABLE_KEY("enable");
79 const std::string TEXT_FIT_MIN_SIZE_KEY("minSize");
80 const std::string TEXT_FIT_MAX_SIZE_KEY("maxSize");
81 const std::string TEXT_FIT_STEP_SIZE_KEY("stepSize");
82 const std::string TEXT_FIT_FONT_SIZE_TYPE_KEY("fontSizeType");
84 #if defined(DEBUG_ENABLED)
85 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
88 const Scripting::StringEnum AUTO_SCROLL_STOP_MODE_TABLE[] =
90 {"IMMEDIATE", Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE},
91 {"FINISH_LOOP", Toolkit::TextLabel::AutoScrollStopMode::FINISH_LOOP},
93 const unsigned int AUTO_SCROLL_STOP_MODE_TABLE_COUNT = sizeof(AUTO_SCROLL_STOP_MODE_TABLE) / sizeof(AUTO_SCROLL_STOP_MODE_TABLE[0]);
98 return Toolkit::TextLabel::New();
102 // Setup properties, signals and actions using the type-registry.
103 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextLabel, Toolkit::Control, Create);
105 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "text", STRING, TEXT )
106 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontFamily", STRING, FONT_FAMILY )
107 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontStyle", MAP, FONT_STYLE )
108 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "pointSize", FLOAT, POINT_SIZE )
109 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "multiLine", BOOLEAN, MULTI_LINE )
110 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
111 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
112 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "enableMarkup", BOOLEAN, ENABLE_MARKUP )
113 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "enableAutoScroll", BOOLEAN, ENABLE_AUTO_SCROLL )
114 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollSpeed", INTEGER, AUTO_SCROLL_SPEED )
115 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollLoopCount", INTEGER, AUTO_SCROLL_LOOP_COUNT )
116 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollGap", FLOAT, AUTO_SCROLL_GAP )
117 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "lineSpacing", FLOAT, LINE_SPACING )
118 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "underline", MAP, UNDERLINE )
119 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "shadow", MAP, SHADOW )
120 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "emboss", MAP, EMBOSS )
121 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "outline", MAP, OUTLINE )
122 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "pixelSize", FLOAT, PIXEL_SIZE )
123 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ellipsis", BOOLEAN, ELLIPSIS )
124 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollLoopDelay", FLOAT, AUTO_SCROLL_LOOP_DELAY )
125 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "autoScrollStopMode", STRING, AUTO_SCROLL_STOP_MODE )
126 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextLabel, "lineCount", INTEGER, LINE_COUNT )
127 DALI_PROPERTY_REGISTRATION(Toolkit, TextLabel, "lineWrapMode", INTEGER, LINE_WRAP_MODE )
128 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextLabel, "textDirection", INTEGER, TEXT_DIRECTION )
129 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "verticalLineAlignment", INTEGER, VERTICAL_LINE_ALIGNMENT )
130 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "textBackground", MAP, BACKGROUND )
131 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ignoreSpacesAfterText", BOOLEAN, IGNORE_SPACES_AFTER_TEXT )
132 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION)
133 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "textFit", MAP, TEXT_FIT )
134 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "minLineSize", FLOAT, MIN_LINE_SIZE )
135 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "renderingBackend", INTEGER, RENDERING_BACKEND )
136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "fontSizeScale", FLOAT, FONT_SIZE_SCALE )
137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextLabel, "ellipsisPosition", INTEGER, ELLIPSIS_POSITION )
139 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, TextLabel, "textColor", Color::BLACK, TEXT_COLOR )
140 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorRed", TEXT_COLOR_RED, TEXT_COLOR, 0)
141 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1)
142 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorBlue", TEXT_COLOR_BLUE, TEXT_COLOR, 2)
143 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3)
145 DALI_SIGNAL_REGISTRATION(Toolkit, TextLabel, "anchorClicked", SIGNAL_ANCHOR_CLICKED)
147 DALI_TYPE_REGISTRATION_END()
150 /// Parses the property map for the TEXT_FIT property
151 void ParseTextFitProperty(Text::ControllerPtr& controller, const Property::Map* propertiesMap)
153 if(propertiesMap && !propertiesMap->Empty())
155 bool enabled = false;
158 float stepSize = 0.f;
159 bool isMinSizeSet = false, isMaxSizeSet = false, isStepSizeSet = false;
160 Controller::FontSizeType type = Controller::FontSizeType::POINT_SIZE;
162 const unsigned int numberOfItems = propertiesMap->Count();
164 // Parses and applies
165 for(unsigned int index = 0u; index < numberOfItems; ++index)
167 const KeyValuePair& valueGet = propertiesMap->GetKeyValue(index);
169 if((Controller::TextFitInfo::Property::TEXT_FIT_ENABLE == valueGet.first.indexKey) || (TEXT_FIT_ENABLE_KEY == valueGet.first.stringKey))
172 enabled = valueGet.second.Get<bool>();
174 else if((Controller::TextFitInfo::Property::TEXT_FIT_MIN_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MIN_SIZE_KEY == valueGet.first.stringKey))
177 minSize = valueGet.second.Get<float>();
180 else if((Controller::TextFitInfo::Property::TEXT_FIT_MAX_SIZE == valueGet.first.indexKey) || (TEXT_FIT_MAX_SIZE_KEY == valueGet.first.stringKey))
183 maxSize = valueGet.second.Get<float>();
186 else if((Controller::TextFitInfo::Property::TEXT_FIT_STEP_SIZE == valueGet.first.indexKey) || (TEXT_FIT_STEP_SIZE_KEY == valueGet.first.stringKey))
189 stepSize = valueGet.second.Get<float>();
190 isStepSizeSet = true;
192 else if((Controller::TextFitInfo::Property::TEXT_FIT_FONT_SIZE_TYPE == valueGet.first.indexKey) || (TEXT_FIT_FONT_SIZE_TYPE_KEY == valueGet.first.stringKey))
194 if("pixelSize" == valueGet.second.Get<std::string>())
196 type = Controller::FontSizeType::PIXEL_SIZE;
201 controller->SetTextFitEnabled(enabled);
204 controller->SetTextFitMinSize(minSize, type);
208 controller->SetTextFitMaxSize(maxSize, type);
212 controller->SetTextFitStepSize(stepSize, type);
219 Toolkit::TextLabel TextLabel::New()
221 // Create the implementation, temporarily owned by this handle on stack
222 IntrusivePtr<TextLabel> impl = new TextLabel();
224 // Pass ownership to CustomActor handle
225 Toolkit::TextLabel handle(*impl);
227 // Second-phase init of the implementation
228 // This can only be done after the CustomActor connection has been made...
234 void TextLabel::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
236 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
240 TextLabel& impl(GetImpl(label));
241 DALI_ASSERT_ALWAYS(impl.mController && "No text contoller");
245 case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
247 int backend = value.Get<int>();
249 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
250 if(DevelText::RENDERING_VECTOR_BASED == backend)
252 backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
255 if(impl.mRenderingBackend != backend)
257 impl.mRenderingBackend = backend;
258 impl.mTextUpdateNeeded = true;
260 // When using the vector-based rendering, the size of the GLyphs are different
261 TextAbstraction::GlyphType glyphType = (DevelText::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
262 impl.mController->SetGlyphType(glyphType);
266 case Toolkit::TextLabel::Property::TEXT:
268 impl.mController->SetText(value.Get<std::string>());
270 if(impl.mController->HasAnchors())
272 // Forward input events to controller
273 impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
277 impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
282 case Toolkit::TextLabel::Property::FONT_FAMILY:
284 const std::string& fontFamily = value.Get<std::string>();
286 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str());
287 impl.mController->SetDefaultFontFamily(fontFamily);
290 case Toolkit::TextLabel::Property::FONT_STYLE:
292 SetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
295 case Toolkit::TextLabel::Property::POINT_SIZE:
297 const float pointSize = value.Get<float>();
299 if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE), pointSize))
301 impl.mController->SetDefaultFontSize(pointSize, Text::Controller::POINT_SIZE);
305 case Toolkit::TextLabel::Property::MULTI_LINE:
307 impl.mController->SetMultiLineEnabled(value.Get<bool>());
310 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
312 Text::HorizontalAlignment::Type alignment(static_cast<Text::HorizontalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
313 if(Text::GetHorizontalAlignmentEnumeration(value, alignment))
315 impl.mController->SetHorizontalAlignment(alignment);
319 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
321 Toolkit::Text::VerticalAlignment::Type alignment(static_cast<Text::VerticalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
322 if(Text::GetVerticalAlignmentEnumeration(value, alignment))
324 impl.mController->SetVerticalAlignment(alignment);
328 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
330 const bool enableMarkup = value.Get<bool>();
331 impl.mController->SetMarkupProcessorEnabled(enableMarkup);
333 if(impl.mController->HasAnchors())
335 // Forward input events to controller
336 impl.EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
340 impl.DisableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP));
344 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
346 const bool enableAutoScroll = value.Get<bool>();
347 // If request to auto scroll is the same as current state then do nothing.
348 if(enableAutoScroll != impl.mController->IsAutoScrollEnabled())
350 // If request is disable (false) and auto scrolling is enabled then need to stop it
351 if(enableAutoScroll == false)
353 if(impl.mTextScroller)
355 impl.mTextScroller->StopScrolling();
358 // If request is enable (true) then start autoscroll as not already running
361 impl.mController->SetAutoScrollEnabled(enableAutoScroll);
366 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
368 Text::TextScrollerPtr textScroller = impl.GetTextScroller();
369 Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = textScroller->GetStopMode();
370 if(Scripting::GetEnumerationProperty<Toolkit::TextLabel::AutoScrollStopMode::Type>(value,
371 AUTO_SCROLL_STOP_MODE_TABLE,
372 AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
375 textScroller->SetStopMode(stopMode);
379 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
381 impl.GetTextScroller()->SetSpeed(value.Get<int>());
384 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
386 impl.GetTextScroller()->SetLoopCount(value.Get<int>());
389 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
391 impl.GetTextScroller()->SetLoopDelay(value.Get<float>());
394 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
396 impl.GetTextScroller()->SetGap(value.Get<float>());
399 case Toolkit::TextLabel::Property::LINE_SPACING:
401 const float lineSpacing = value.Get<float>();
402 impl.mTextUpdateNeeded = impl.mController->SetDefaultLineSpacing(lineSpacing) || impl.mTextUpdateNeeded;
405 case Toolkit::TextLabel::Property::UNDERLINE:
407 impl.mTextUpdateNeeded = SetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
410 case Toolkit::TextLabel::Property::SHADOW:
412 impl.mTextUpdateNeeded = SetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
415 case Toolkit::TextLabel::Property::EMBOSS:
417 impl.mTextUpdateNeeded = SetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
420 case Toolkit::TextLabel::Property::OUTLINE:
422 impl.mTextUpdateNeeded = SetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
425 case Toolkit::TextLabel::Property::PIXEL_SIZE:
427 const float pixelSize = value.Get<float>();
428 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize);
430 if(!Equals(impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE), pixelSize))
432 impl.mController->SetDefaultFontSize(pixelSize, Text::Controller::PIXEL_SIZE);
436 case Toolkit::TextLabel::Property::ELLIPSIS:
438 const bool ellipsis = value.Get<bool>();
439 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis);
441 impl.mController->SetTextElideEnabled(ellipsis);
444 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
446 Text::LineWrap::Mode lineWrapMode(static_cast<Text::LineWrap::Mode>(-1)); // Set to invalid value to ensure a valid mode does get set
447 if(GetLineWrapModeEnumeration(value, lineWrapMode))
449 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode);
450 impl.mController->SetLineWrapMode(lineWrapMode);
454 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
456 if(impl.mController->GetTextModel())
458 DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>(value.Get<int>());
460 impl.mController->SetVerticalLineAlignment(alignment);
462 // Property doesn't affect the layout, only Visual must be updated
463 TextVisual::EnableRendererUpdate(impl.mVisual);
465 // No need to trigger full re-layout. Instead call UpdateRenderer() directly
466 TextVisual::UpdateRenderer(impl.mVisual);
470 case Toolkit::DevelTextLabel::Property::BACKGROUND:
472 impl.mTextUpdateNeeded = SetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT) || impl.mTextUpdateNeeded;
475 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
477 impl.mController->SetIgnoreSpacesAfterText(value.Get<bool>());
480 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
482 impl.mController->SetMatchLayoutDirection(value.Get<bool>() ? DevelText::MatchLayoutDirection::LOCALE : DevelText::MatchLayoutDirection::CONTENTS);
485 case Toolkit::DevelTextLabel::Property::TEXT_FIT:
487 ParseTextFitProperty(impl.mController, value.GetMap());
490 case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
492 const float lineSize = value.Get<float>();
493 impl.mTextUpdateNeeded = impl.mController->SetDefaultLineSize(lineSize) || impl.mTextUpdateNeeded;
496 case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
498 const float scale = value.Get<float>();
499 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p FONT_SIZE_SCALE %f\n", impl.mController.Get(), scale);
501 if(!Equals(impl.mController->GetFontSizeScale(), scale))
503 impl.mController->SetFontSizeScale(scale);
507 case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
509 DevelText::EllipsisPosition::Type ellipsisPositionType(static_cast<DevelText::EllipsisPosition::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
510 if(GetEllipsisPositionTypeEnumeration(value, ellipsisPositionType))
512 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel %p EllipsisPosition::Type %d\n", impl.mController.Get(), ellipsisPositionType);
513 impl.mController->SetEllipsisPosition(ellipsisPositionType);
519 // Request relayout when text update is needed. It's necessary to call it
520 // as changing the property not via UI interaction brings no effect if only
521 // the mTextUpdateNeeded is changed.
522 if(impl.mTextUpdateNeeded)
524 // need to request relayout as size of text may have changed
525 impl.RequestTextRelayout();
530 Text::ControllerPtr TextLabel::GetTextController()
535 Property::Value TextLabel::GetProperty(BaseObject* object, Property::Index index)
537 Property::Value value;
539 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(Dali::BaseHandle(object));
543 TextLabel& impl(GetImpl(label));
544 DALI_ASSERT_DEBUG(impl.mController && "No text contoller");
548 case Toolkit::DevelTextLabel::Property::RENDERING_BACKEND:
550 value = impl.mRenderingBackend;
553 case Toolkit::TextLabel::Property::TEXT:
556 impl.mController->GetText(text);
560 case Toolkit::TextLabel::Property::FONT_FAMILY:
562 value = impl.mController->GetDefaultFontFamily();
565 case Toolkit::TextLabel::Property::FONT_STYLE:
567 GetFontStyleProperty(impl.mController, value, Text::FontStyle::DEFAULT);
570 case Toolkit::TextLabel::Property::POINT_SIZE:
572 value = impl.mController->GetDefaultFontSize(Text::Controller::POINT_SIZE);
575 case Toolkit::TextLabel::Property::MULTI_LINE:
577 value = impl.mController->IsMultiLineEnabled();
580 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
582 const char* name = Text::GetHorizontalAlignmentString(impl.mController->GetHorizontalAlignment());
586 value = std::string(name);
590 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
592 const char* name = Text::GetVerticalAlignmentString(impl.mController->GetVerticalAlignment());
595 value = std::string(name);
599 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
601 value = impl.mController->IsMarkupProcessorEnabled();
604 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
606 value = impl.mController->IsAutoScrollEnabled();
609 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
611 if(impl.mTextScroller)
613 const char* mode = Scripting::GetEnumerationName<Toolkit::TextLabel::AutoScrollStopMode::Type>(impl.mTextScroller->GetStopMode(),
614 AUTO_SCROLL_STOP_MODE_TABLE,
615 AUTO_SCROLL_STOP_MODE_TABLE_COUNT);
618 value = std::string(mode);
623 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
625 if(impl.mTextScroller)
627 value = impl.mTextScroller->GetSpeed();
631 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
633 if(impl.mTextScroller)
635 value = impl.mTextScroller->GetLoopCount();
639 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
641 if(impl.mTextScroller)
643 value = impl.mTextScroller->GetLoopDelay();
647 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
649 if(impl.mTextScroller)
651 value = impl.mTextScroller->GetGap();
655 case Toolkit::TextLabel::Property::LINE_SPACING:
657 value = impl.mController->GetDefaultLineSpacing();
660 case Toolkit::TextLabel::Property::UNDERLINE:
662 GetUnderlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
665 case Toolkit::TextLabel::Property::SHADOW:
667 GetShadowProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
670 case Toolkit::TextLabel::Property::EMBOSS:
672 GetEmbossProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
675 case Toolkit::TextLabel::Property::OUTLINE:
677 GetOutlineProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
680 case Toolkit::TextLabel::Property::PIXEL_SIZE:
682 value = impl.mController->GetDefaultFontSize(Text::Controller::PIXEL_SIZE);
685 case Toolkit::TextLabel::Property::ELLIPSIS:
687 value = impl.mController->IsTextElideEnabled();
690 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
692 value = impl.mController->GetLineWrapMode();
695 case Toolkit::TextLabel::Property::LINE_COUNT:
697 float width = label.GetProperty(Actor::Property::SIZE_WIDTH).Get<float>();
698 value = impl.mController->GetLineCount(width);
701 case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
703 value = impl.mController->GetTextDirection();
706 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
708 value = impl.mController->GetVerticalLineAlignment();
711 case Toolkit::DevelTextLabel::Property::BACKGROUND:
713 GetBackgroundProperties(impl.mController, value, Text::EffectStyle::DEFAULT);
716 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
718 value = impl.mController->IsIgnoreSpacesAfterText();
721 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
723 value = impl.mController->GetMatchLayoutDirection() != DevelText::MatchLayoutDirection::CONTENTS;
726 case Toolkit::DevelTextLabel::Property::TEXT_FIT:
728 const bool enabled = impl.mController->IsTextFitEnabled();
729 const float minSize = impl.mController->GetTextFitMinSize();
730 const float maxSize = impl.mController->GetTextFitMaxSize();
731 const float stepSize = impl.mController->GetTextFitStepSize();
734 map.Insert(TEXT_FIT_ENABLE_KEY, enabled);
735 map.Insert(TEXT_FIT_MIN_SIZE_KEY, minSize);
736 map.Insert(TEXT_FIT_MAX_SIZE_KEY, maxSize);
737 map.Insert(TEXT_FIT_STEP_SIZE_KEY, stepSize);
738 map.Insert(TEXT_FIT_FONT_SIZE_TYPE_KEY, "pointSize");
743 case Toolkit::DevelTextLabel::Property::MIN_LINE_SIZE:
745 value = impl.mController->GetDefaultLineSize();
748 case Toolkit::DevelTextLabel::Property::FONT_SIZE_SCALE:
750 value = impl.mController->GetFontSizeScale();
753 case Toolkit::DevelTextLabel::Property::ELLIPSIS_POSITION:
755 value = impl.mController->GetEllipsisPosition();
764 bool TextLabel::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
766 Dali::BaseHandle handle(object);
768 bool connected(true);
769 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast(handle);
771 if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
775 Internal::TextLabel& labelImpl(GetImpl(label));
776 labelImpl.AnchorClickedSignal().Connect(tracker, functor);
781 // signalName does not match any signal
788 DevelTextLabel::AnchorClickedSignalType& TextLabel::AnchorClickedSignal()
790 return mAnchorClickedSignal;
793 void TextLabel::OnInitialize()
797 Property::Map propertyMap;
798 propertyMap.Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
800 mVisual = Toolkit::VisualFactory::Get().CreateVisual(propertyMap);
801 DevelControl::RegisterVisual(*this, Toolkit::TextLabel::Property::TEXT, mVisual);
803 TextVisual::SetAnimatableTextColorProperty(mVisual, Toolkit::TextLabel::Property::TEXT_COLOR);
805 mController = TextVisual::GetController(mVisual);
806 DALI_ASSERT_DEBUG(mController && "Invalid Text Controller")
808 mController->SetControlInterface(this);
809 mController->SetAnchorControlInterface(this);
811 // Use height-for-width negotiation by default
812 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
813 self.SetResizePolicy(ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT);
815 // Enable highlightability
816 self.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
818 // Enable the text ellipsis.
819 mController->SetTextElideEnabled(true); // If false then text larger than control will overflow
821 // Sets layoutDirection value
822 Dali::Stage stage = Dali::Stage::GetCurrent();
823 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
824 mController->SetLayoutDirection(layoutDirection);
826 self.LayoutDirectionChangedSignal().Connect(this, &TextLabel::OnLayoutDirectionChanged);
828 Layout::Engine& engine = mController->GetLayoutEngine();
829 engine.SetCursorWidth(0u); // Do not layout space for the cursor.
831 DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) {
832 return std::unique_ptr<Dali::Accessibility::Accessible>(
833 new AccessibleImpl(actor, Dali::Accessibility::Role::LABEL));
837 void TextLabel::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
839 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
843 case StyleChange::DEFAULT_FONT_CHANGE:
845 // Property system did not set the font so should update it.
846 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
847 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str());
848 mController->UpdateAfterFontChange(newFont);
852 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
854 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
858 case StyleChange::THEME_CHANGE:
860 // Nothing to do, let control base class handle this
865 // Up call to Control
866 Control::OnStyleChange(styleManager, change);
869 void TextLabel::OnTap(const TapGesture& gesture)
871 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnTap %p\n", mController.Get());
873 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
875 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
876 const Vector2& localPoint = gesture.GetLocalPoint();
877 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
880 void TextLabel::AnchorClicked(const std::string& href)
882 Dali::Toolkit::TextLabel handle(GetOwner());
883 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
886 Vector3 TextLabel::GetNaturalSize()
889 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
891 Vector3 naturalSize = mController->GetNaturalSize();
892 naturalSize.width += (padding.start + padding.end);
893 naturalSize.height += (padding.top + padding.bottom);
898 float TextLabel::GetHeightForWidth(float width)
901 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
903 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
906 void TextLabel::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
908 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index);
912 case Toolkit::TextLabel::Property::TEXT_COLOR:
914 const Vector4& textColor = propertyValue.Get<Vector4>();
915 if(mController->GetDefaultColor() != textColor)
917 mController->SetDefaultColor(textColor);
918 mTextUpdateNeeded = true;
924 Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
930 void TextLabel::OnRelayout(const Vector2& size, RelayoutContainer& container)
932 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout\n");
937 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
939 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
941 if(mController->IsTextFitEnabled())
943 mController->FitPointSizeforLayout(contentSize);
944 mController->SetTextFitContentSize(contentSize);
947 // Support Right-To-Left
948 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
950 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
952 if((Text::Controller::NONE_UPDATED != (Text::Controller::MODEL_UPDATED & updateTextType)) || mTextUpdateNeeded)
954 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", (mController->IsAutoScrollEnabled()) ? "true" : "false", this);
957 TextVisual::EnableRendererUpdate(mVisual);
959 // Support Right-To-Left of padding
960 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
962 std::swap(padding.start, padding.end);
965 // Calculate the size of the visual that can fit the text
966 Size layoutSize = mController->GetTextModel()->GetLayoutSize();
967 layoutSize.x = contentSize.x;
969 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
970 if(shadowOffset.y > Math::MACHINE_EPSILON_1)
972 layoutSize.y += shadowOffset.y;
975 float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
976 layoutSize.y += outlineWidth * 2.0f;
977 layoutSize.y = std::min(layoutSize.y, contentSize.y);
979 // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
980 Vector2 alignmentOffset;
981 alignmentOffset.x = 0.0f;
982 alignmentOffset.y = (contentSize.y - layoutSize.y) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
984 Property::Map visualTransform;
985 visualTransform.Add(Toolkit::Visual::Transform::Property::SIZE, layoutSize)
986 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
987 .Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2(padding.start, padding.top) + alignmentOffset)
988 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
989 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
990 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN);
991 mVisual.SetTransformAndSize(visualTransform, size);
993 if(mController->IsAutoScrollEnabled())
995 SetUpAutoScrolling();
998 mTextUpdateNeeded = false;
1002 void TextLabel::RequestTextRelayout()
1005 // Signal that a Relayout may be needed
1008 void TextLabel::SetUpAutoScrolling()
1010 const Size& controlSize = mController->GetView().GetControlSize();
1011 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.
1012 const Text::CharacterDirection direction = mController->GetAutoScrollDirection();
1014 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n", textNaturalSize.x, textNaturalSize.y, controlSize.x, controlSize.y);
1018 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n");
1020 // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
1021 mTextScroller = Text::TextScroller::New(*this);
1024 // Calculate the actual gap before scrolling wraps.
1025 int textPadding = std::max(controlSize.x - textNaturalSize.x, 0.0f);
1026 float wrapGap = std::max(mTextScroller->GetGap(), textPadding);
1027 Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
1029 // Create a texture of the text for scrolling
1030 Size verifiedSize = textureSize;
1031 const int maxTextureSize = Dali::GetMaxTextureSize();
1033 //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
1034 bool actualellipsis = mController->IsTextElideEnabled();
1035 if(verifiedSize.width > maxTextureSize)
1037 verifiedSize.width = maxTextureSize;
1038 if(textNaturalSize.width > maxTextureSize)
1040 mController->SetTextElideEnabled(true);
1042 GetHeightForWidth(maxTextureSize);
1043 wrapGap = std::max(maxTextureSize - textNaturalSize.width, 0.0f);
1046 Text::TypesetterPtr typesetter = Text::Typesetter::New(mController->GetTextModel());
1048 PixelData data = typesetter->Render(verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888); // ignore the horizontal alignment
1049 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D,
1050 data.GetPixelFormat(),
1053 texture.Upload(data);
1055 TextureSet textureSet = TextureSet::New();
1056 textureSet.SetTexture(0u, texture);
1058 // Filter mode needs to be set to linear to produce better quality while scaling.
1059 Sampler sampler = Sampler::New();
1060 sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
1061 sampler.SetWrapMode(Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT); // Wrap the texture in the x direction
1062 textureSet.SetSampler(0u, sampler);
1064 // Set parameters for scrolling
1065 Renderer renderer = static_cast<Internal::Visual::Base&>(GetImplementation(mVisual)).GetRenderer();
1066 mTextScroller->SetParameters(Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment());
1067 mController->SetTextElideEnabled(actualellipsis);
1070 void TextLabel::ScrollingFinished()
1072 // Pure Virtual from TextScroller Interface
1073 DALI_LOG_INFO(gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1074 mController->SetAutoScrollEnabled(false);
1075 RequestTextRelayout();
1078 void TextLabel::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1080 mController->ChangedLayoutDirection();
1083 TextLabel::TextLabel()
1084 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1085 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1086 mTextUpdateNeeded(false)
1090 TextLabel::~TextLabel()
1094 std::string TextLabel::AccessibleImpl::GetNameRaw()
1096 auto self = Toolkit::TextLabel::DownCast(Self());
1097 return self.GetProperty(Toolkit::TextLabel::Property::TEXT).Get<std::string>();
1100 Property::Index TextLabel::AccessibleImpl::GetNamePropertyIndex()
1102 return Toolkit::TextLabel::Property::TEXT;
1105 std::string TextLabel::AccessibleImpl::GetText(size_t startOffset, size_t endOffset)
1107 if(endOffset <= startOffset)
1112 auto self = Toolkit::TextLabel::DownCast(Self());
1113 auto text = self.GetProperty(Toolkit::TextLabel::Property::TEXT).Get<std::string>();
1115 if(startOffset > text.size() || endOffset > text.size())
1120 return text.substr(startOffset, endOffset - startOffset);
1123 size_t TextLabel::AccessibleImpl::GetCharacterCount()
1125 auto self = Toolkit::TextLabel::DownCast(Self());
1126 auto text = self.GetProperty(Toolkit::TextLabel::Property::TEXT).Get<std::string>();
1131 size_t TextLabel::AccessibleImpl::GetCursorOffset()
1136 bool TextLabel::AccessibleImpl::SetCursorOffset(size_t offset)
1141 Dali::Accessibility::Range TextLabel::AccessibleImpl::GetTextAtOffset(size_t offset, Dali::Accessibility::TextBoundary boundary)
1143 auto self = Toolkit::TextLabel::DownCast(Self());
1144 auto text = self.GetProperty(Toolkit::TextLabel::Property::TEXT).Get<std::string>();
1145 auto textSize = text.size();
1147 auto range = Dali::Accessibility::Range{};
1151 case Dali::Accessibility::TextBoundary::CHARACTER:
1153 if(offset < textSize)
1155 range.content = text[offset];
1156 range.startOffset = offset;
1157 range.endOffset = offset + 1;
1161 case Dali::Accessibility::TextBoundary::WORD:
1162 case Dali::Accessibility::TextBoundary::LINE:
1164 auto textString = text.c_str();
1165 auto breaks = std::vector<char>(textSize, 0);
1167 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1169 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1173 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1178 while(index < textSize && counter <= offset)
1183 while(breaks[index])
1191 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1195 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1201 if((counter > 0) && ((counter - 1) == offset))
1203 range.content = text.substr(start, index - start + 1);
1204 range.startOffset = start;
1205 range.endOffset = index + 1;
1208 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1215 case Dali::Accessibility::TextBoundary::SENTENCE:
1217 /* not supported by default */
1220 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1222 /* Paragraph is not supported by libunibreak library */
1232 Dali::Accessibility::Range TextLabel::AccessibleImpl::GetRangeOfSelection(size_t selectionIndex)
1234 // Since DALi supports only one selection indexes higher than 0 are ignored
1235 if(selectionIndex > 0)
1240 auto self = Toolkit::TextLabel::DownCast(Self());
1241 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1242 std::string value{};
1243 controller->RetrieveSelection(value);
1244 auto indices = controller->GetSelectionIndexes();
1246 return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
1249 bool TextLabel::AccessibleImpl::RemoveSelection(size_t selectionIndex)
1251 // Since DALi supports only one selection indexes higher than 0 are ignored
1252 if(selectionIndex > 0)
1257 auto self = Toolkit::TextLabel::DownCast(Self());
1258 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1262 bool TextLabel::AccessibleImpl::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1264 // Since DALi supports only one selection indexes higher than 0 are ignored
1265 if(selectionIndex > 0)
1270 auto self = Toolkit::TextLabel::DownCast(Self());
1271 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1275 } // namespace Internal
1277 } // namespace Toolkit