2 * Copyright (c) 2018 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/public-api/object/type-registry-helper.h>
23 #include <dali/devel-api/object/property-helper-devel.h>
24 #include <dali/devel-api/adaptor-framework/image-loading.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali-toolkit/public-api/text/rendering-backend.h>
29 #include <dali-toolkit/public-api/text/text-enumerations.h>
30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
31 #include <dali-toolkit/internal/text/property-string-parser.h>
32 #include <dali-toolkit/internal/text/rendering/text-backend.h>
33 #include <dali-toolkit/internal/text/text-effects-style.h>
34 #include <dali-toolkit/internal/text/text-font-style.h>
35 #include <dali-toolkit/internal/text/text-view.h>
36 #include <dali-toolkit/internal/text/text-definitions.h>
37 #include <dali-toolkit/internal/styling/style-manager-impl.h>
39 #include <dali-toolkit/public-api/align-enumerations.h>
40 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
41 #include <dali-toolkit/devel-api/controls/control-devel.h>
42 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
43 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
44 #include <dali-toolkit/public-api/visuals/visual-properties.h>
45 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
47 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
49 using namespace Dali::Toolkit::Text;
62 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::Text::DEFAULT_RENDERING_BACKEND;
65 * @brief How the text visual should be aligned vertically inside the control.
67 * 0.0f aligns the text to the top, 0.5f aligns the text to the center, 1.0f aligns the text to the bottom.
68 * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
70 const float VERTICAL_ALIGNMENT_TABLE[ Text::VerticalAlignment::BOTTOM + 1 ] =
72 0.0f, // VerticalAlignment::TOP
73 0.5f, // VerticalAlignment::CENTER
74 1.0f // VerticalAlignment::BOTTOM
81 #if defined ( DEBUG_ENABLED )
82 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
85 const Scripting::StringEnum AUTO_SCROLL_STOP_MODE_TABLE[] =
87 { "IMMEDIATE", Toolkit::TextLabel::AutoScrollStopMode::IMMEDIATE },
88 { "FINISH_LOOP", Toolkit::TextLabel::AutoScrollStopMode::FINISH_LOOP },
90 const unsigned int AUTO_SCROLL_STOP_MODE_TABLE_COUNT = sizeof( AUTO_SCROLL_STOP_MODE_TABLE ) / sizeof( AUTO_SCROLL_STOP_MODE_TABLE[0] );
95 return Toolkit::TextLabel::New();
98 // Setup properties, signals and actions using the type-registry.
99 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextLabel, Toolkit::Control, Create );
101 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "renderingBackend", INTEGER, RENDERING_BACKEND )
102 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "text", STRING, TEXT )
103 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "fontFamily", STRING, FONT_FAMILY )
104 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "fontStyle", MAP, FONT_STYLE )
105 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "pointSize", FLOAT, POINT_SIZE )
106 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "multiLine", BOOLEAN, MULTI_LINE )
107 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
108 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
109 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "unusedPropertyTextColor", VECTOR4, UNUSED_PROPERTY_TEXT_COLOR )
110 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "shadowOffset", VECTOR2, SHADOW_OFFSET )
111 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "shadowColor", VECTOR4, SHADOW_COLOR )
112 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "underlineEnabled", BOOLEAN, UNDERLINE_ENABLED )
113 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "underlineColor", VECTOR4, UNDERLINE_COLOR )
114 DALI_PROPERTY_REGISTRATION( Toolkit, TextLabel, "underlineHeight", FLOAT, UNDERLINE_HEIGHT )
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_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, TextLabel, "textColor", Color::BLACK, TEXT_COLOR )
137 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorRed", TEXT_COLOR_RED, TEXT_COLOR, 0 )
138 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1 )
139 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorBlue", TEXT_COLOR_BLUE, TEXT_COLOR, 2 )
140 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3 )
141 DALI_TYPE_REGISTRATION_END()
145 Toolkit::TextLabel TextLabel::New()
147 // Create the implementation, temporarily owned by this handle on stack
148 IntrusivePtr< TextLabel > impl = new TextLabel();
150 // Pass ownership to CustomActor handle
151 Toolkit::TextLabel handle( *impl );
153 // Second-phase init of the implementation
154 // This can only be done after the CustomActor connection has been made...
160 void TextLabel::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
162 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
166 TextLabel& impl( GetImpl( label ) );
169 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
171 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
173 int backend = value.Get< int >();
175 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
176 if( Text::RENDERING_VECTOR_BASED == backend )
178 backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
181 if( impl.mRenderingBackend != backend )
183 impl.mRenderingBackend = backend;
184 impl.mTextUpdateNeeded = true;
186 if( impl.mController )
188 // When using the vector-based rendering, the size of the GLyphs are different
189 TextAbstraction::GlyphType glyphType = (Text::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
190 impl.mController->SetGlyphType( glyphType );
195 case Toolkit::TextLabel::Property::TEXT:
197 if( impl.mController )
199 impl.mController->SetText( value.Get< std::string >() );
203 case Toolkit::TextLabel::Property::FONT_FAMILY:
205 if( impl.mController )
207 const std::string& fontFamily = value.Get< std::string >();
209 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str() );
210 impl.mController->SetDefaultFontFamily( fontFamily );
214 case Toolkit::TextLabel::Property::FONT_STYLE:
216 SetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
219 case Toolkit::TextLabel::Property::POINT_SIZE:
221 if( impl.mController )
223 const float pointSize = value.Get< float >();
225 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
227 impl.mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
232 case Toolkit::TextLabel::Property::MULTI_LINE:
234 if( impl.mController )
236 impl.mController->SetMultiLineEnabled( value.Get< bool >() );
240 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
242 if( impl.mController )
244 Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
245 if( Text::GetHorizontalAlignmentEnumeration( value, alignment ) )
247 impl.mController->SetHorizontalAlignment( alignment );
252 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
254 if( impl.mController )
256 Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
257 if( Text::GetVerticalAlignmentEnumeration( value, alignment ) )
259 impl.mController->SetVerticalAlignment( alignment );
265 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
267 label.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, value );
268 impl.mTextUpdateNeeded = true;
272 case Toolkit::TextLabel::Property::SHADOW_OFFSET:
274 if( impl.mController )
276 const Vector2& shadowOffset = value.Get< Vector2 >();
277 if ( impl.mController->GetShadowOffset() != shadowOffset )
279 impl.mController->SetShadowOffset( shadowOffset );
280 impl.mTextUpdateNeeded = true;
285 case Toolkit::TextLabel::Property::SHADOW_COLOR:
287 if( impl.mController )
289 const Vector4& shadowColor = value.Get< Vector4 >();
290 if ( impl.mController->GetShadowColor() != shadowColor )
292 impl.mController->SetShadowColor( shadowColor );
293 impl.mTextUpdateNeeded = true;
298 case Toolkit::TextLabel::Property::UNDERLINE_COLOR:
300 if( impl.mController )
302 const Vector4& color = value.Get< Vector4 >();
303 if ( impl.mController->GetUnderlineColor() != color )
305 impl.mController->SetUnderlineColor( color );
306 impl.mTextUpdateNeeded = true;
311 case Toolkit::TextLabel::Property::UNDERLINE_ENABLED:
313 if( impl.mController )
315 const bool enabled = value.Get< bool >();
316 if ( impl.mController->IsUnderlineEnabled() != enabled )
318 impl.mController->SetUnderlineEnabled( enabled );
319 impl.mTextUpdateNeeded = true;
325 case Toolkit::TextLabel::Property::UNDERLINE_HEIGHT:
327 if( impl.mController )
329 float height = value.Get< float >();
330 if( fabsf( impl.mController->GetUnderlineHeight() - height ) > Math::MACHINE_EPSILON_1000 )
332 impl.mController->SetUnderlineHeight( height );
333 impl.mTextUpdateNeeded = true;
338 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
340 if( impl.mController )
342 const bool enableMarkup = value.Get<bool>();
343 impl.mController->SetMarkupProcessorEnabled( enableMarkup );
347 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
349 if( impl.mController )
351 const bool enableAutoScroll = value.Get<bool>();
352 // If request to auto scroll is the same as current state then do nothing.
353 if ( enableAutoScroll != impl.mController->IsAutoScrollEnabled() )
355 // If request is disable (false) and auto scrolling is enabled then need to stop it
356 if ( enableAutoScroll == false )
358 if( impl.mTextScroller )
360 impl.mTextScroller->StopScrolling();
363 // If request is enable (true) then start autoscroll as not already running
366 impl.mController->SetTextElideEnabled( false );
367 impl.mController->SetAutoScrollEnabled( enableAutoScroll );
373 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
375 if( !impl.mTextScroller )
377 impl.mTextScroller = Text::TextScroller::New( impl );
379 Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = impl.mTextScroller->GetStopMode();
380 if( Scripting::GetEnumerationProperty< Toolkit::TextLabel::AutoScrollStopMode::Type >( value,
381 AUTO_SCROLL_STOP_MODE_TABLE,
382 AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
385 impl.mTextScroller->SetStopMode( stopMode );
389 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
391 if( !impl.mTextScroller )
393 impl.mTextScroller = Text::TextScroller::New( impl );
395 impl.mTextScroller->SetSpeed( value.Get<int>() );
398 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
400 if( !impl.mTextScroller )
402 impl.mTextScroller = Text::TextScroller::New( impl );
404 impl.mTextScroller->SetLoopCount( value.Get<int>() );
407 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
409 if( !impl.mTextScroller )
411 impl.mTextScroller = Text::TextScroller::New( impl );
413 impl.mTextScroller->SetLoopDelay( value.Get<float>() );
416 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
418 if( !impl.mTextScroller )
420 impl.mTextScroller = Text::TextScroller::New( impl );
422 impl.mTextScroller->SetGap( value.Get<float>() );
425 case Toolkit::TextLabel::Property::LINE_SPACING:
427 if( impl.mController )
429 const float lineSpacing = value.Get<float>();
431 // Don't trigger anything if the line spacing didn't change
432 if( impl.mController->SetDefaultLineSpacing( lineSpacing ) )
434 impl.mTextUpdateNeeded = true;
439 case Toolkit::TextLabel::Property::UNDERLINE:
441 const bool update = SetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
444 impl.mTextUpdateNeeded = true;
448 case Toolkit::TextLabel::Property::SHADOW:
450 const bool update = SetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
453 impl.mTextUpdateNeeded = true;
457 case Toolkit::TextLabel::Property::EMBOSS:
459 const bool update = SetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
462 impl.mTextUpdateNeeded = true;
466 case Toolkit::TextLabel::Property::OUTLINE:
468 const bool update = SetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
471 impl.mTextUpdateNeeded = true;
475 case Toolkit::TextLabel::Property::PIXEL_SIZE:
477 if( impl.mController )
479 const float pixelSize = value.Get< float >();
480 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize );
482 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE ), pixelSize ) )
484 impl.mController->SetDefaultFontSize( pixelSize, Text::Controller::PIXEL_SIZE );
489 case Toolkit::TextLabel::Property::ELLIPSIS:
491 if( impl.mController )
493 const bool ellipsis = value.Get<bool>();
494 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis );
496 impl.mController->SetTextElideEnabled( ellipsis );
500 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
502 if( impl.mController )
504 Text::LineWrap::Mode lineWrapMode( static_cast< Text::LineWrap::Mode >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
505 if( GetLineWrapModeEnumeration( value, lineWrapMode ) )
507 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode );
508 impl.mController->SetLineWrapMode( lineWrapMode );
513 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
515 if( impl.mController && impl.mController->GetTextModel() )
517 DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>( value.Get<int>() );
519 impl.mController->SetVerticalLineAlignment( alignment );
521 // Property doesn't affect the layout, only Visual must be updated
522 TextVisual::EnableRendererUpdate( impl.mVisual );
524 // No need to trigger full re-layout. Instead call UpdateRenderer() directly
525 TextVisual::UpdateRenderer( impl.mVisual );
529 case Toolkit::DevelTextLabel::Property::BACKGROUND:
531 const bool update = SetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
534 impl.mTextUpdateNeeded = true;
538 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
540 impl.mController->SetIgnoreSpacesAfterText(value.Get< bool >());
543 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
545 impl.mController->SetMatchSystemLanguageDirection(value.Get< bool >());
550 // Request relayout when text update is needed. It's necessary to call it
551 // as changing the property not via UI interaction brings no effect if only
552 // the mTextUpdateNeeded is changed.
553 if( impl.mTextUpdateNeeded )
555 // need to request relayout as size of text may have changed
556 impl.RequestTextRelayout();
565 Property::Value TextLabel::GetProperty( BaseObject* object, Property::Index index )
567 Property::Value value;
569 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
573 TextLabel& impl( GetImpl( label ) );
576 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
578 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
580 value = impl.mRenderingBackend;
583 case Toolkit::TextLabel::Property::TEXT:
585 if( impl.mController )
588 impl.mController->GetText( text );
593 case Toolkit::TextLabel::Property::FONT_FAMILY:
595 if( impl.mController )
597 value = impl.mController->GetDefaultFontFamily();
601 case Toolkit::TextLabel::Property::FONT_STYLE:
603 GetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
606 case Toolkit::TextLabel::Property::POINT_SIZE:
608 if( impl.mController )
610 value = impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE );
614 case Toolkit::TextLabel::Property::MULTI_LINE:
616 if( impl.mController )
618 value = impl.mController->IsMultiLineEnabled();
622 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
624 if( impl.mController )
626 const char* name = Text::GetHorizontalAlignmentString( impl.mController->GetHorizontalAlignment() );
630 value = std::string( name );
635 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
637 if( impl.mController )
639 const char* name = Text::GetVerticalAlignmentString( impl.mController->GetVerticalAlignment() );
642 value = std::string( name );
647 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
649 value = label.GetProperty( Toolkit::TextLabel::Property::TEXT_COLOR );
652 case Toolkit::TextLabel::Property::SHADOW_OFFSET:
654 if ( impl.mController )
656 value = impl.mController->GetShadowOffset();
660 case Toolkit::TextLabel::Property::SHADOW_COLOR:
662 if ( impl.mController )
664 value = impl.mController->GetShadowColor();
668 case Toolkit::TextLabel::Property::UNDERLINE_COLOR:
670 if ( impl.mController )
672 value = impl.mController->GetUnderlineColor();
676 case Toolkit::TextLabel::Property::UNDERLINE_ENABLED:
678 if ( impl.mController )
680 value = impl.mController->IsUnderlineEnabled();
684 case Toolkit::TextLabel::Property::UNDERLINE_HEIGHT:
686 if ( impl.mController )
688 value = impl.mController->GetUnderlineHeight();
692 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
694 if( impl.mController )
696 value = impl.mController->IsMarkupProcessorEnabled();
700 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
702 if( impl.mController )
704 value = impl.mController->IsAutoScrollEnabled();
708 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
710 if( impl.mTextScroller )
712 const char* mode = Scripting::GetEnumerationName< Toolkit::TextLabel::AutoScrollStopMode::Type >( impl.mTextScroller->GetStopMode(),
713 AUTO_SCROLL_STOP_MODE_TABLE,
714 AUTO_SCROLL_STOP_MODE_TABLE_COUNT );
717 value = std::string( mode );
722 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
724 TextLabel& impl( GetImpl( label ) );
725 if ( impl.mTextScroller )
727 value = impl.mTextScroller->GetSpeed();
731 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
733 if( impl.mController )
735 TextLabel& impl( GetImpl( label ) );
736 if ( impl.mTextScroller )
738 value = impl.mTextScroller->GetLoopCount();
743 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
745 if( impl.mController )
747 TextLabel& impl( GetImpl( label ) );
748 if ( impl.mTextScroller )
750 value = impl.mTextScroller->GetLoopDelay();
755 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
757 TextLabel& impl( GetImpl( label ) );
758 if ( impl.mTextScroller )
760 value = impl.mTextScroller->GetGap();
764 case Toolkit::TextLabel::Property::LINE_SPACING:
766 if( impl.mController )
768 value = impl.mController->GetDefaultLineSpacing();
772 case Toolkit::TextLabel::Property::UNDERLINE:
774 GetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
777 case Toolkit::TextLabel::Property::SHADOW:
779 GetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
782 case Toolkit::TextLabel::Property::EMBOSS:
784 GetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
787 case Toolkit::TextLabel::Property::OUTLINE:
789 GetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
792 case Toolkit::TextLabel::Property::PIXEL_SIZE:
794 if( impl.mController )
796 value = impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE );
800 case Toolkit::TextLabel::Property::ELLIPSIS:
802 if( impl.mController )
804 value = impl.mController->IsTextElideEnabled();
808 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
810 if( impl.mController )
812 value = impl.mController->GetLineWrapMode();
816 case Toolkit::TextLabel::Property::LINE_COUNT:
818 if( impl.mController )
820 float width = label.GetProperty( Actor::Property::SIZE_WIDTH ).Get<float>();
821 value = impl.mController->GetLineCount( width );
825 case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
827 if( impl.mController )
829 value = impl.mController->GetTextDirection();
833 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
835 if( impl.mController )
837 value = impl.mController->GetVerticalLineAlignment();
841 case Toolkit::DevelTextLabel::Property::BACKGROUND:
843 GetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
846 case Toolkit::DevelTextLabel::Property::IGNORE_SPACES_AFTER_TEXT:
848 value = impl.mController->IsIgnoreSpacesAfterText();
851 case Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION:
853 value = impl.mController->IsMatchSystemLanguageDirection();
862 void TextLabel::OnInitialize()
866 Property::Map propertyMap;
867 propertyMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
869 mVisual = Toolkit::VisualFactory::Get().CreateVisual( propertyMap );
870 DevelControl::RegisterVisual( *this, Toolkit::TextLabel::Property::TEXT, mVisual );
872 TextVisual::SetAnimatableTextColorProperty( mVisual, Toolkit::TextLabel::Property::TEXT_COLOR );
874 mController = TextVisual::GetController(mVisual);
877 mController->SetControlInterface(this);
880 // Use height-for-width negotiation by default
881 self.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
882 self.SetResizePolicy( ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT );
884 // Enable the text ellipsis.
885 mController->SetTextElideEnabled( true ); // If false then text larger than control will overflow
887 // Sets layoutDirection value
888 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( self.GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
889 mController->SetLayoutDirection( layoutDirection );
891 self.LayoutDirectionChangedSignal().Connect( this, &TextLabel::OnLayoutDirectionChanged );
893 Layout::Engine& engine = mController->GetLayoutEngine();
894 engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
897 void TextLabel::OnLayoutDirectionChanged( Dali::Actor actor, Dali::LayoutDirection::Type type )
899 mController->UpdateLayoutDirectionChanged( type );
902 void TextLabel::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
904 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
908 case StyleChange::DEFAULT_FONT_CHANGE:
910 // Property system did not set the font so should update it.
911 const std::string& newFont = GetImpl( styleManager ).GetDefaultFontFamily();
912 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str() );
913 mController->UpdateAfterFontChange( newFont );
917 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
919 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
923 case StyleChange::THEME_CHANGE:
925 // Nothing to do, let control base class handle this
930 // Up call to Control
931 Control::OnStyleChange( styleManager, change );
934 Vector3 TextLabel::GetNaturalSize()
937 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
939 Vector3 naturalSize = mController->GetNaturalSize();
940 naturalSize.width += ( padding.start + padding.end );
941 naturalSize.height += ( padding.top + padding.bottom );
946 float TextLabel::GetHeightForWidth( float width )
949 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
951 return mController->GetHeightForWidth( width ) + padding.top + padding.bottom;
954 void TextLabel::OnPropertySet( Property::Index index, Property::Value propertyValue )
956 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index );
960 case Toolkit::TextLabel::Property::TEXT_COLOR:
962 const Vector4& textColor = propertyValue.Get< Vector4 >();
963 if( mController->GetDefaultColor() != textColor )
965 mController->SetDefaultColor( textColor );
966 mTextUpdateNeeded = true;
972 Control::OnPropertySet( index, propertyValue ); // up call to control for non-handled properties
978 void TextLabel::OnRelayout( const Vector2& size, RelayoutContainer& container )
980 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout\n" );
983 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
985 Vector2 contentSize( size.x - ( padding.start + padding.end ), size.y - ( padding.top + padding.bottom ) );
987 // Support Right-To-Left
988 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
990 const Text::Controller::UpdateTextType updateTextType = mController->Relayout( contentSize, layoutDirection );
992 if( ( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType ) )
993 || mTextUpdateNeeded )
995 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", ( mController->IsAutoScrollEnabled())?"true":"false", this );
998 TextVisual::EnableRendererUpdate( mVisual );
1000 // Support Right-To-Left of padding
1001 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
1003 std::swap( padding.start, padding.end );
1006 // Calculate the size of the visual that can fit the text
1007 Size layoutSize = mController->GetTextModel()->GetLayoutSize();
1008 layoutSize.x = contentSize.x;
1010 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
1011 if ( shadowOffset.y > Math::MACHINE_EPSILON_1 )
1013 layoutSize.y += shadowOffset.y;
1016 float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
1017 layoutSize.y += outlineWidth * 2.0f;
1018 layoutSize.y = std::min( layoutSize.y, contentSize.y );
1020 // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
1021 Vector2 alignmentOffset;
1022 alignmentOffset.x = 0.0f;
1023 alignmentOffset.y = ( contentSize.y - layoutSize.y ) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
1025 Property::Map visualTransform;
1026 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, layoutSize )
1027 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
1028 .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( padding.start, padding.top ) + alignmentOffset )
1029 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
1030 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
1031 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
1032 mVisual.SetTransformAndSize( visualTransform, size );
1034 if ( mController->IsAutoScrollEnabled() )
1036 SetUpAutoScrolling();
1039 mTextUpdateNeeded = false;
1043 void TextLabel::RequestTextRelayout()
1046 Toolkit::DevelControl::RequestLayout( *this );
1049 void TextLabel::SetUpAutoScrolling()
1051 const Size& controlSize = mController->GetView().GetControlSize();
1052 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.
1053 const Text::CharacterDirection direction = mController->GetAutoScrollDirection();
1055 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n",
1056 textNaturalSize.x,textNaturalSize.y , controlSize.x,controlSize.y );
1058 if ( !mTextScroller )
1060 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n" );
1062 // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
1063 mTextScroller = Text::TextScroller::New( *this );
1066 // Calculate the actual gap before scrolling wraps.
1067 int textPadding = std::max( controlSize.x - textNaturalSize.x, 0.0f );
1068 float wrapGap = std::max( mTextScroller->GetGap(), textPadding );
1069 Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
1071 // Create a texture of the text for scrolling
1072 Size verifiedSize = textureSize;
1073 const int maxTextureSize = Dali::GetMaxTextureSize();
1075 //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
1076 if( verifiedSize.width > maxTextureSize )
1078 verifiedSize.width = maxTextureSize;
1079 if( textNaturalSize.width > maxTextureSize )
1081 mController->SetTextElideEnabled( true );
1083 GetHeightForWidth( maxTextureSize );
1084 wrapGap = std::max( maxTextureSize - textNaturalSize.width, 0.0f );
1087 Text::TypesetterPtr typesetter = Text::Typesetter::New( mController->GetTextModel() );
1089 PixelData data = typesetter->Render( verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888 ); // ignore the horizontal alignment
1090 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
1091 data.GetPixelFormat(),
1094 texture.Upload( data );
1096 TextureSet textureSet = TextureSet::New();
1097 textureSet.SetTexture( 0u, texture );
1099 // Filter mode needs to be set to linear to produce better quality while scaling.
1100 Sampler sampler = Sampler::New();
1101 sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
1102 sampler.SetWrapMode( Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT ); // Wrap the texture in the x direction
1103 textureSet.SetSampler( 0u, sampler );
1105 // Set parameters for scrolling
1106 Renderer renderer = static_cast<Internal::Visual::Base&>( GetImplementation( mVisual ) ).GetRenderer();
1107 mTextScroller->SetParameters( Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment() );
1110 void TextLabel::ScrollingFinished()
1112 // Pure Virtual from TextScroller Interface
1113 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1114 mController->SetAutoScrollEnabled( false );
1115 mController->SetTextElideEnabled( true );
1116 RequestTextRelayout();
1119 TextLabel::TextLabel()
1120 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
1121 mRenderingBackend( DEFAULT_RENDERING_BACKEND ),
1122 mTextUpdateNeeded( false )
1126 TextLabel::~TextLabel()
1130 } // namespace Internal
1132 } // namespace Toolkit