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_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, TextLabel, "textColor", Color::BLACK, TEXT_COLOR )
135 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorRed", TEXT_COLOR_RED, TEXT_COLOR, 0 )
136 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorGreen", TEXT_COLOR_GREEN, TEXT_COLOR, 1 )
137 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorBlue", TEXT_COLOR_BLUE, TEXT_COLOR, 2 )
138 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, TextLabel, "textColorAlpha", TEXT_COLOR_ALPHA, TEXT_COLOR, 3 )
139 DALI_TYPE_REGISTRATION_END()
143 Toolkit::TextLabel TextLabel::New()
145 // Create the implementation, temporarily owned by this handle on stack
146 IntrusivePtr< TextLabel > impl = new TextLabel();
148 // Pass ownership to CustomActor handle
149 Toolkit::TextLabel handle( *impl );
151 // Second-phase init of the implementation
152 // This can only be done after the CustomActor connection has been made...
158 void TextLabel::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
160 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
164 TextLabel& impl( GetImpl( label ) );
167 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
169 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
171 int backend = value.Get< int >();
173 #ifndef ENABLE_VECTOR_BASED_TEXT_RENDERING
174 if( Text::RENDERING_VECTOR_BASED == backend )
176 backend = TextAbstraction::BITMAP_GLYPH; // Fallback to bitmap-based rendering
179 if( impl.mRenderingBackend != backend )
181 impl.mRenderingBackend = backend;
182 impl.mTextUpdateNeeded = true;
184 if( impl.mController )
186 // When using the vector-based rendering, the size of the GLyphs are different
187 TextAbstraction::GlyphType glyphType = (Text::RENDERING_VECTOR_BASED == impl.mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
188 impl.mController->SetGlyphType( glyphType );
193 case Toolkit::TextLabel::Property::TEXT:
195 if( impl.mController )
197 impl.mController->SetText( value.Get< std::string >() );
201 case Toolkit::TextLabel::Property::FONT_FAMILY:
203 if( impl.mController )
205 const std::string& fontFamily = value.Get< std::string >();
207 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::SetProperty Property::FONT_FAMILY newFont(%s)\n", fontFamily.c_str() );
208 impl.mController->SetDefaultFontFamily( fontFamily );
212 case Toolkit::TextLabel::Property::FONT_STYLE:
214 SetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
217 case Toolkit::TextLabel::Property::POINT_SIZE:
219 if( impl.mController )
221 const float pointSize = value.Get< float >();
223 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
225 impl.mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
230 case Toolkit::TextLabel::Property::MULTI_LINE:
232 if( impl.mController )
234 impl.mController->SetMultiLineEnabled( value.Get< bool >() );
238 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
240 if( impl.mController )
242 Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
243 if( Text::GetHorizontalAlignmentEnumeration( value, alignment ) )
245 impl.mController->SetHorizontalAlignment( alignment );
250 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
252 if( impl.mController )
254 Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
255 if( Text::GetVerticalAlignmentEnumeration( value, alignment ) )
257 impl.mController->SetVerticalAlignment( alignment );
263 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
265 label.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, value );
266 impl.mTextUpdateNeeded = true;
270 case Toolkit::TextLabel::Property::SHADOW_OFFSET:
272 if( impl.mController )
274 const Vector2& shadowOffset = value.Get< Vector2 >();
275 if ( impl.mController->GetShadowOffset() != shadowOffset )
277 impl.mController->SetShadowOffset( shadowOffset );
278 impl.mTextUpdateNeeded = true;
283 case Toolkit::TextLabel::Property::SHADOW_COLOR:
285 if( impl.mController )
287 const Vector4& shadowColor = value.Get< Vector4 >();
288 if ( impl.mController->GetShadowColor() != shadowColor )
290 impl.mController->SetShadowColor( shadowColor );
291 impl.mTextUpdateNeeded = true;
296 case Toolkit::TextLabel::Property::UNDERLINE_COLOR:
298 if( impl.mController )
300 const Vector4& color = value.Get< Vector4 >();
301 if ( impl.mController->GetUnderlineColor() != color )
303 impl.mController->SetUnderlineColor( color );
304 impl.mTextUpdateNeeded = true;
309 case Toolkit::TextLabel::Property::UNDERLINE_ENABLED:
311 if( impl.mController )
313 const bool enabled = value.Get< bool >();
314 if ( impl.mController->IsUnderlineEnabled() != enabled )
316 impl.mController->SetUnderlineEnabled( enabled );
317 impl.mTextUpdateNeeded = true;
323 case Toolkit::TextLabel::Property::UNDERLINE_HEIGHT:
325 if( impl.mController )
327 float height = value.Get< float >();
328 if( fabsf( impl.mController->GetUnderlineHeight() - height ) > Math::MACHINE_EPSILON_1000 )
330 impl.mController->SetUnderlineHeight( height );
331 impl.mTextUpdateNeeded = true;
336 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
338 if( impl.mController )
340 const bool enableMarkup = value.Get<bool>();
341 impl.mController->SetMarkupProcessorEnabled( enableMarkup );
345 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
347 if( impl.mController )
349 const bool enableAutoScroll = value.Get<bool>();
350 // If request to auto scroll is the same as current state then do nothing.
351 if ( enableAutoScroll != impl.mController->IsAutoScrollEnabled() )
353 // If request is disable (false) and auto scrolling is enabled then need to stop it
354 if ( enableAutoScroll == false )
356 if( impl.mTextScroller )
358 impl.mTextScroller->StopScrolling();
361 // If request is enable (true) then start autoscroll as not already running
364 impl.mController->SetTextElideEnabled( false );
365 impl.mController->SetAutoScrollEnabled( enableAutoScroll );
371 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
373 if( !impl.mTextScroller )
375 impl.mTextScroller = Text::TextScroller::New( impl );
377 Toolkit::TextLabel::AutoScrollStopMode::Type stopMode = impl.mTextScroller->GetStopMode();
378 if( Scripting::GetEnumerationProperty< Toolkit::TextLabel::AutoScrollStopMode::Type >( value,
379 AUTO_SCROLL_STOP_MODE_TABLE,
380 AUTO_SCROLL_STOP_MODE_TABLE_COUNT,
383 impl.mTextScroller->SetStopMode( stopMode );
387 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
389 if( !impl.mTextScroller )
391 impl.mTextScroller = Text::TextScroller::New( impl );
393 impl.mTextScroller->SetSpeed( value.Get<int>() );
396 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
398 if( !impl.mTextScroller )
400 impl.mTextScroller = Text::TextScroller::New( impl );
402 impl.mTextScroller->SetLoopCount( value.Get<int>() );
405 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
407 if( !impl.mTextScroller )
409 impl.mTextScroller = Text::TextScroller::New( impl );
411 impl.mTextScroller->SetLoopDelay( value.Get<float>() );
414 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
416 if( !impl.mTextScroller )
418 impl.mTextScroller = Text::TextScroller::New( impl );
420 impl.mTextScroller->SetGap( value.Get<float>() );
423 case Toolkit::TextLabel::Property::LINE_SPACING:
425 if( impl.mController )
427 const float lineSpacing = value.Get<float>();
429 // Don't trigger anything if the line spacing didn't change
430 if( impl.mController->SetDefaultLineSpacing( lineSpacing ) )
432 impl.mTextUpdateNeeded = true;
437 case Toolkit::TextLabel::Property::UNDERLINE:
439 const bool update = SetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
442 impl.mTextUpdateNeeded = true;
446 case Toolkit::TextLabel::Property::SHADOW:
448 const bool update = SetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
451 impl.mTextUpdateNeeded = true;
455 case Toolkit::TextLabel::Property::EMBOSS:
457 const bool update = SetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
460 impl.mTextUpdateNeeded = true;
464 case Toolkit::TextLabel::Property::OUTLINE:
466 const bool update = SetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
469 impl.mTextUpdateNeeded = true;
473 case Toolkit::TextLabel::Property::PIXEL_SIZE:
475 if( impl.mController )
477 const float pixelSize = value.Get< float >();
478 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p PIXEL_SIZE %f\n", impl.mController.Get(), pixelSize );
480 if( !Equals( impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE ), pixelSize ) )
482 impl.mController->SetDefaultFontSize( pixelSize, Text::Controller::PIXEL_SIZE );
487 case Toolkit::TextLabel::Property::ELLIPSIS:
489 if( impl.mController )
491 const bool ellipsis = value.Get<bool>();
492 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p ELLIPSIS %d\n", impl.mController.Get(), ellipsis );
494 impl.mController->SetTextElideEnabled( ellipsis );
498 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
500 if( impl.mController )
502 Text::LineWrap::Mode lineWrapMode( static_cast< Text::LineWrap::Mode >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
503 if( GetLineWrapModeEnumeration( value, lineWrapMode ) )
505 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel %p LineWrap::MODE %d\n", impl.mController.Get(), lineWrapMode );
506 impl.mController->SetLineWrapMode( lineWrapMode );
511 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
513 if( impl.mController && impl.mController->GetTextModel() )
515 DevelText::VerticalLineAlignment::Type alignment = static_cast<DevelText::VerticalLineAlignment::Type>( value.Get<int>() );
517 impl.mController->SetVerticalLineAlignment( alignment );
519 // Property doesn't affect the layout, only Visual must be updated
520 TextVisual::EnableRendererUpdate( impl.mVisual );
522 // No need to trigger full re-layout. Instead call UpdateRenderer() directly
523 TextVisual::UpdateRenderer( impl.mVisual );
527 case Toolkit::DevelTextLabel::Property::BACKGROUND:
529 const bool update = SetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
532 impl.mTextUpdateNeeded = true;
538 // Request relayout when text update is needed. It's necessary to call it
539 // as changing the property not via UI interaction brings no effect if only
540 // the mTextUpdateNeeded is changed.
541 if( impl.mTextUpdateNeeded )
543 // need to request relayout as size of text may have changed
544 impl.RequestTextRelayout();
553 Property::Value TextLabel::GetProperty( BaseObject* object, Property::Index index )
555 Property::Value value;
557 Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( Dali::BaseHandle( object ) );
561 TextLabel& impl( GetImpl( label ) );
564 case Toolkit::TextLabel::Property::RENDERING_BACKEND:
566 DALI_LOG_WARNING("[%s] Using deprecated Property TextLabel::Property::RENDERING_BACKEND which is no longer supported and will be ignored\n", __FUNCTION__);
568 value = impl.mRenderingBackend;
571 case Toolkit::TextLabel::Property::TEXT:
573 if( impl.mController )
576 impl.mController->GetText( text );
581 case Toolkit::TextLabel::Property::FONT_FAMILY:
583 if( impl.mController )
585 value = impl.mController->GetDefaultFontFamily();
589 case Toolkit::TextLabel::Property::FONT_STYLE:
591 GetFontStyleProperty( impl.mController, value, Text::FontStyle::DEFAULT );
594 case Toolkit::TextLabel::Property::POINT_SIZE:
596 if( impl.mController )
598 value = impl.mController->GetDefaultFontSize( Text::Controller::POINT_SIZE );
602 case Toolkit::TextLabel::Property::MULTI_LINE:
604 if( impl.mController )
606 value = impl.mController->IsMultiLineEnabled();
610 case Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT:
612 if( impl.mController )
614 const char* name = Text::GetHorizontalAlignmentString( impl.mController->GetHorizontalAlignment() );
618 value = std::string( name );
623 case Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT:
625 if( impl.mController )
627 const char* name = Text::GetVerticalAlignmentString( impl.mController->GetVerticalAlignment() );
630 value = std::string( name );
635 case Toolkit::TextLabel::Property::UNUSED_PROPERTY_TEXT_COLOR:
637 value = label.GetProperty( Toolkit::TextLabel::Property::TEXT_COLOR );
640 case Toolkit::TextLabel::Property::SHADOW_OFFSET:
642 if ( impl.mController )
644 value = impl.mController->GetShadowOffset();
648 case Toolkit::TextLabel::Property::SHADOW_COLOR:
650 if ( impl.mController )
652 value = impl.mController->GetShadowColor();
656 case Toolkit::TextLabel::Property::UNDERLINE_COLOR:
658 if ( impl.mController )
660 value = impl.mController->GetUnderlineColor();
664 case Toolkit::TextLabel::Property::UNDERLINE_ENABLED:
666 if ( impl.mController )
668 value = impl.mController->IsUnderlineEnabled();
672 case Toolkit::TextLabel::Property::UNDERLINE_HEIGHT:
674 if ( impl.mController )
676 value = impl.mController->GetUnderlineHeight();
680 case Toolkit::TextLabel::Property::ENABLE_MARKUP:
682 if( impl.mController )
684 value = impl.mController->IsMarkupProcessorEnabled();
688 case Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL:
690 if( impl.mController )
692 value = impl.mController->IsAutoScrollEnabled();
696 case Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE:
698 if( impl.mTextScroller )
700 const char* mode = Scripting::GetEnumerationName< Toolkit::TextLabel::AutoScrollStopMode::Type >( impl.mTextScroller->GetStopMode(),
701 AUTO_SCROLL_STOP_MODE_TABLE,
702 AUTO_SCROLL_STOP_MODE_TABLE_COUNT );
705 value = std::string( mode );
710 case Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED:
712 TextLabel& impl( GetImpl( label ) );
713 if ( impl.mTextScroller )
715 value = impl.mTextScroller->GetSpeed();
719 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT:
721 if( impl.mController )
723 TextLabel& impl( GetImpl( label ) );
724 if ( impl.mTextScroller )
726 value = impl.mTextScroller->GetLoopCount();
731 case Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY:
733 if( impl.mController )
735 TextLabel& impl( GetImpl( label ) );
736 if ( impl.mTextScroller )
738 value = impl.mTextScroller->GetLoopDelay();
743 case Toolkit::TextLabel::Property::AUTO_SCROLL_GAP:
745 TextLabel& impl( GetImpl( label ) );
746 if ( impl.mTextScroller )
748 value = impl.mTextScroller->GetGap();
752 case Toolkit::TextLabel::Property::LINE_SPACING:
754 if( impl.mController )
756 value = impl.mController->GetDefaultLineSpacing();
760 case Toolkit::TextLabel::Property::UNDERLINE:
762 GetUnderlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
765 case Toolkit::TextLabel::Property::SHADOW:
767 GetShadowProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
770 case Toolkit::TextLabel::Property::EMBOSS:
772 GetEmbossProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
775 case Toolkit::TextLabel::Property::OUTLINE:
777 GetOutlineProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
780 case Toolkit::TextLabel::Property::PIXEL_SIZE:
782 if( impl.mController )
784 value = impl.mController->GetDefaultFontSize( Text::Controller::PIXEL_SIZE );
788 case Toolkit::TextLabel::Property::ELLIPSIS:
790 if( impl.mController )
792 value = impl.mController->IsTextElideEnabled();
796 case Toolkit::TextLabel::Property::LINE_WRAP_MODE:
798 if( impl.mController )
800 value = impl.mController->GetLineWrapMode();
804 case Toolkit::TextLabel::Property::LINE_COUNT:
806 if( impl.mController )
808 float width = label.GetProperty( Actor::Property::SIZE_WIDTH ).Get<float>();
809 value = impl.mController->GetLineCount( width );
813 case Toolkit::DevelTextLabel::Property::TEXT_DIRECTION:
815 if( impl.mController )
817 value = impl.mController->GetTextDirection();
821 case Toolkit::DevelTextLabel::Property::VERTICAL_LINE_ALIGNMENT:
823 if( impl.mController )
825 value = impl.mController->GetVerticalLineAlignment();
829 case Toolkit::DevelTextLabel::Property::BACKGROUND:
831 GetBackgroundProperties( impl.mController, value, Text::EffectStyle::DEFAULT );
840 void TextLabel::OnInitialize()
844 Property::Map propertyMap;
845 propertyMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
847 mVisual = Toolkit::VisualFactory::Get().CreateVisual( propertyMap );
848 DevelControl::RegisterVisual( *this, Toolkit::TextLabel::Property::TEXT, mVisual );
850 TextVisual::SetAnimatableTextColorProperty( mVisual, Toolkit::TextLabel::Property::TEXT_COLOR );
852 mController = TextVisual::GetController(mVisual);
855 mController->SetControlInterface(this);
858 // Use height-for-width negotiation by default
859 self.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
860 self.SetResizePolicy( ResizePolicy::DIMENSION_DEPENDENCY, Dimension::HEIGHT );
862 // Enable the text ellipsis.
863 mController->SetTextElideEnabled( true ); // If false then text larger than control will overflow
865 Layout::Engine& engine = mController->GetLayoutEngine();
866 engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
869 void TextLabel::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
871 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnStyleChange\n");
875 case StyleChange::DEFAULT_FONT_CHANGE:
877 // Property system did not set the font so should update it.
878 const std::string& newFont = GetImpl( styleManager ).GetDefaultFontFamily();
879 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnStyleChange StyleChange::DEFAULT_FONT_CHANGE newFont(%s)\n", newFont.c_str() );
880 mController->UpdateAfterFontChange( newFont );
884 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
886 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
890 case StyleChange::THEME_CHANGE:
892 // Nothing to do, let control base class handle this
897 // Up call to Control
898 Control::OnStyleChange( styleManager, change );
901 Vector3 TextLabel::GetNaturalSize()
904 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
906 Vector3 naturalSize = mController->GetNaturalSize();
907 naturalSize.width += ( padding.start + padding.end );
908 naturalSize.height += ( padding.top + padding.bottom );
913 float TextLabel::GetHeightForWidth( float width )
916 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
918 return mController->GetHeightForWidth( width ) + padding.top + padding.bottom;
921 void TextLabel::OnPropertySet( Property::Index index, Property::Value propertyValue )
923 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextLabel::OnPropertySet index[%d]\n", index );
927 case Toolkit::TextLabel::Property::TEXT_COLOR:
929 const Vector4& textColor = propertyValue.Get< Vector4 >();
930 if( mController->GetDefaultColor() != textColor )
932 mController->SetDefaultColor( textColor );
933 mTextUpdateNeeded = true;
939 Control::OnPropertySet( index, propertyValue ); // up call to control for non-handled properties
945 void TextLabel::OnRelayout( const Vector2& size, RelayoutContainer& container )
947 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout\n" );
950 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
952 Vector2 contentSize( size.x - ( padding.start + padding.end ), size.y - ( padding.top + padding.bottom ) );
954 const Text::Controller::UpdateTextType updateTextType = mController->Relayout( contentSize );
956 if( ( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType ) )
957 || mTextUpdateNeeded )
959 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::OnRelayout IsAutoScrollEnabled[%s] [%p]\n", ( mController->IsAutoScrollEnabled())?"true":"false", this );
962 TextVisual::EnableRendererUpdate( mVisual );
964 // Support Right-To-Left of padding
965 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
966 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
968 std::swap( padding.start, padding.end );
971 // Calculate the size of the visual that can fit the text
972 Size layoutSize = mController->GetTextModel()->GetLayoutSize();
973 layoutSize.x = contentSize.x;
975 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
976 if ( shadowOffset.y > Math::MACHINE_EPSILON_1 )
978 layoutSize.y += shadowOffset.y;
981 float outlineWidth = mController->GetTextModel()->GetOutlineWidth();
982 layoutSize.y += outlineWidth * 2.0f;
983 layoutSize.y = std::min( layoutSize.y, contentSize.y );
985 // Calculate the offset for vertical alignment only, as the layout engine will do the horizontal alignment.
986 Vector2 alignmentOffset;
987 alignmentOffset.x = 0.0f;
988 alignmentOffset.y = ( contentSize.y - layoutSize.y ) * VERTICAL_ALIGNMENT_TABLE[mController->GetVerticalAlignment()];
990 Property::Map visualTransform;
991 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, layoutSize )
992 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
993 .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( padding.start, padding.top ) + alignmentOffset )
994 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
995 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
996 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
997 mVisual.SetTransformAndSize( visualTransform, size );
999 if ( mController->IsAutoScrollEnabled() )
1001 SetUpAutoScrolling();
1004 mTextUpdateNeeded = false;
1008 void TextLabel::RequestTextRelayout()
1011 Toolkit::DevelControl::RequestLayout( *this );
1014 void TextLabel::SetUpAutoScrolling()
1016 const Size& controlSize = mController->GetView().GetControlSize();
1017 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.
1018 const Text::CharacterDirection direction = mController->GetAutoScrollDirection();
1020 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling textNaturalSize[%f,%f] controlSize[%f,%f]\n",
1021 textNaturalSize.x,textNaturalSize.y , controlSize.x,controlSize.y );
1023 if ( !mTextScroller )
1025 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::SetUpAutoScrolling Creating default TextScoller\n" );
1027 // If speed, loopCount or gap not set via property system then will need to create a TextScroller with defaults
1028 mTextScroller = Text::TextScroller::New( *this );
1031 // Calculate the actual gap before scrolling wraps.
1032 int textPadding = std::max( controlSize.x - textNaturalSize.x, 0.0f );
1033 float wrapGap = std::max( mTextScroller->GetGap(), textPadding );
1034 Vector2 textureSize = textNaturalSize + Vector2(wrapGap, 0.0f); // Add the gap as a part of the texture
1036 // Create a texture of the text for scrolling
1037 Size verifiedSize = textureSize;
1038 const int maxTextureSize = Dali::GetMaxTextureSize();
1040 //if the texture size width exceed maxTextureSize, modify the visual model size and enabled the ellipsis
1041 if( verifiedSize.width > maxTextureSize )
1043 verifiedSize.width = maxTextureSize;
1044 if( textNaturalSize.width > maxTextureSize )
1046 mController->SetTextElideEnabled( true );
1048 GetHeightForWidth( maxTextureSize );
1049 wrapGap = std::max( maxTextureSize - textNaturalSize.width, 0.0f );
1052 Text::TypesetterPtr typesetter = Text::Typesetter::New( mController->GetTextModel() );
1054 PixelData data = typesetter->Render( verifiedSize, mController->GetTextDirection(), Text::Typesetter::RENDER_TEXT_AND_STYLES, true, Pixel::RGBA8888 ); // ignore the horizontal alignment
1055 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
1056 data.GetPixelFormat(),
1059 texture.Upload( data );
1061 TextureSet textureSet = TextureSet::New();
1062 textureSet.SetTexture( 0u, texture );
1064 // Filter mode needs to be set to linear to produce better quality while scaling.
1065 Sampler sampler = Sampler::New();
1066 sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
1067 sampler.SetWrapMode( Dali::WrapMode::DEFAULT, Dali::WrapMode::REPEAT, Dali::WrapMode::DEFAULT ); // Wrap the texture in the x direction
1068 textureSet.SetSampler( 0u, sampler );
1070 // Set parameters for scrolling
1071 Renderer renderer = static_cast<Internal::Visual::Base&>( GetImplementation( mVisual ) ).GetRenderer();
1072 mTextScroller->SetParameters( Self(), renderer, textureSet, controlSize, verifiedSize, wrapGap, direction, mController->GetHorizontalAlignment(), mController->GetVerticalAlignment() );
1075 void TextLabel::ScrollingFinished()
1077 // Pure Virtual from TextScroller Interface
1078 DALI_LOG_INFO( gLogFilter, Debug::General, "TextLabel::ScrollingFinished\n");
1079 mController->SetAutoScrollEnabled( false );
1080 mController->SetTextElideEnabled( true );
1081 RequestTextRelayout();
1084 TextLabel::TextLabel()
1085 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
1086 mRenderingBackend( DEFAULT_RENDERING_BACKEND ),
1087 mTextUpdateNeeded( false )
1091 TextLabel::~TextLabel()
1095 } // namespace Internal
1097 } // namespace Toolkit