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/text/text-controller.h>
22 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
23 #include <dali/devel-api/adaptor-framework/window-devel.h>
24 #include <dali/integration-api/debug.h>
30 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
31 #include <dali-toolkit/internal/text/text-controller-background-actor.h>
32 #include <dali-toolkit/internal/text/text-controller-event-handler.h>
33 #include <dali-toolkit/internal/text/text-controller-impl.h>
34 #include <dali-toolkit/internal/text/text-controller-input-font-handler.h>
35 #include <dali-toolkit/internal/text/text-controller-input-properties.h>
36 #include <dali-toolkit/internal/text/text-controller-placeholder-handler.h>
37 #include <dali-toolkit/internal/text/text-controller-relayouter.h>
38 #include <dali-toolkit/internal/text/text-controller-text-updater.h>
39 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
40 #include <dali-toolkit/internal/text/text-geometry.h>
44 #if defined(DEBUG_ENABLED)
45 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
48 const std::string EMPTY_STRING("");
50 template<typename Type>
51 void EnsureCreated(Type*& object)
59 template<typename Type>
60 void EnsureCreated(std::unique_ptr<Type>& object)
64 object = std::unique_ptr<Type>(new Type());
68 template<typename Type, typename Arg1>
69 void EnsureCreated(Type*& object, Arg1 arg1)
73 object = new Type(arg1);
77 template<typename Type, typename Arg1, typename Arg2>
78 void EnsureCreated(Type*& object, Arg1 arg1, Arg2 arg2)
82 object = new Type(arg1, arg2);
88 unsigned int horizontalDpi = 0u;
89 unsigned int verticalDpi = 0u;
90 Dali::TextAbstraction::FontClient fontClient = Dali::TextAbstraction::FontClient::Get();
91 fontClient.GetDpi(horizontalDpi, verticalDpi);
92 return static_cast<float>(horizontalDpi);
95 float ConvertPixelToPoint(float pixel)
97 return pixel * 72.0f / GetDpi();
100 float ConvertPointToPixel(float point)
102 // Pixel size = Point size * DPI / 72.f
103 return point * GetDpi() / 72.0f;
106 void UpdateCursorPosition(Dali::Toolkit::Text::EventData* eventData)
108 if(eventData && Dali::Toolkit::Text::EventData::IsEditingState(eventData->mState))
110 // Update the cursor position if it's in editing mode
111 eventData->mDecoratorUpdated = true;
112 eventData->mUpdateCursorPosition = true; // Cursor position should be updated when the font size is updated.
118 namespace Dali::Toolkit::Text
120 void Controller::EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext)
124 delete mImpl->mEventData;
125 mImpl->mEventData = NULL;
127 // Nothing else to do.
131 EnsureCreated(mImpl->mEventData, decorator, inputMethodContext);
134 void Controller::SetGlyphType(TextAbstraction::GlyphType glyphType)
136 // Metrics for bitmap & vector based glyphs are different
137 mImpl->mMetrics->SetGlyphType(glyphType);
139 // Clear the font-specific data
140 mImpl->ClearFontData();
142 mImpl->RequestRelayout();
145 void Controller::SetMarkupProcessorEnabled(bool enable)
147 if(enable != mImpl->mMarkupProcessorEnabled)
149 //If Text was already set, call the SetText again for enabling or disabling markup
150 mImpl->mMarkupProcessorEnabled = enable;
156 mImpl->mModel->mVisualModel->SetMarkupProcessorEnabled(enable);
159 bool Controller::IsMarkupProcessorEnabled() const
161 return mImpl->mMarkupProcessorEnabled;
164 bool Controller::HasAnchors() const
166 return (mImpl->mMarkupProcessorEnabled && mImpl->mModel->mLogicalModel->mAnchors.Count() && mImpl->IsShowingRealText());
169 void Controller::SetAutoScrollEnabled(bool enable)
171 DALI_LOG_INFO(gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled[%s] SingleBox[%s]-> [%p]\n", (enable) ? "true" : "false", (mImpl->mLayoutEngine.GetLayout() == Layout::Engine::SINGLE_LINE_BOX) ? "true" : "false", this);
172 mImpl->SetAutoScrollEnabled(enable);
175 bool Controller::IsAutoScrollEnabled() const
177 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", mImpl->mIsAutoScrollEnabled ? "true" : "false");
178 return mImpl->mIsAutoScrollEnabled;
181 CharacterDirection Controller::GetAutoScrollDirection() const
183 return mImpl->mIsTextDirectionRTL;
186 float Controller::GetAutoScrollLineAlignment() const
189 if(mImpl->mModel->mVisualModel && (0u != mImpl->mModel->mVisualModel->mLines.Count()))
191 offset = (*mImpl->mModel->mVisualModel->mLines.Begin()).alignmentOffset;
196 void Controller::SetHorizontalScrollEnabled(bool enable)
198 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
200 mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled(enable);
204 bool Controller::IsHorizontalScrollEnabled() const
206 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
209 void Controller::SetVerticalScrollEnabled(bool enable)
211 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
213 mImpl->mEventData->mDecorator->SetVerticalScrollEnabled(enable);
217 bool Controller::IsVerticalScrollEnabled() const
219 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
222 void Controller::SetSmoothHandlePanEnabled(bool enable)
224 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
226 mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled(enable);
230 bool Controller::IsSmoothHandlePanEnabled() const
232 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
235 void Controller::SetMaximumNumberOfCharacters(Length maxCharacters)
237 mImpl->mMaximumNumberOfCharacters = maxCharacters;
240 int Controller::GetMaximumNumberOfCharacters()
242 return mImpl->mMaximumNumberOfCharacters;
245 void Controller::SetEnableCursorBlink(bool enable)
247 mImpl->SetEnableCursorBlink(enable);
250 bool Controller::GetEnableCursorBlink() const
252 return mImpl->mEventData && mImpl->mEventData->mCursorBlinkEnabled;
255 void Controller::SetMultiLineEnabled(bool enable)
257 mImpl->SetMultiLineEnabled(enable);
260 bool Controller::IsMultiLineEnabled() const
262 return Layout::Engine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
265 void Controller::SetHorizontalAlignment(Text::HorizontalAlignment::Type alignment)
267 mImpl->SetHorizontalAlignment(alignment);
270 Text::HorizontalAlignment::Type Controller::GetHorizontalAlignment() const
272 return mImpl->mModel->mHorizontalAlignment;
275 void Controller::SetVerticalAlignment(VerticalAlignment::Type alignment)
277 mImpl->SetVerticalAlignment(alignment);
280 VerticalAlignment::Type Controller::GetVerticalAlignment() const
282 return mImpl->mModel->mVerticalAlignment;
285 bool Controller::IsIgnoreSpacesAfterText() const
287 return mImpl->mModel->mIgnoreSpacesAfterText;
290 void Controller::SetIgnoreSpacesAfterText(bool ignore)
292 mImpl->mModel->mIgnoreSpacesAfterText = ignore;
295 void Controller::ChangedLayoutDirection()
297 mImpl->mIsLayoutDirectionChanged = true;
300 void Controller::SetMatchLayoutDirection(DevelText::MatchLayoutDirection type)
302 mImpl->mModel->mMatchLayoutDirection = type;
305 DevelText::MatchLayoutDirection Controller::GetMatchLayoutDirection() const
307 return mImpl->mModel->mMatchLayoutDirection;
310 void Controller::SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection)
312 mImpl->mLayoutDirection = layoutDirection;
315 Dali::LayoutDirection::Type Controller::GetLayoutDirection(Dali::Actor& actor) const
317 return mImpl->GetLayoutDirection(actor);
320 bool Controller::IsShowingRealText() const
322 return mImpl->IsShowingRealText();
325 void Controller::SetLineWrapMode(Text::LineWrap::Mode lineWrapMode)
327 mImpl->SetLineWrapMode(lineWrapMode);
330 Text::LineWrap::Mode Controller::GetLineWrapMode() const
332 return mImpl->mModel->mLineWrapMode;
335 void Controller::SetTextElideEnabled(bool enabled)
337 mImpl->mModel->mElideEnabled = enabled;
338 mImpl->mModel->mVisualModel->SetTextElideEnabled(enabled);
341 bool Controller::IsTextElideEnabled() const
343 return mImpl->mModel->mElideEnabled;
346 void Controller::SetTextFitEnabled(bool enabled)
348 mImpl->mTextFitEnabled = enabled;
351 bool Controller::IsTextFitEnabled() const
353 return mImpl->mTextFitEnabled;
356 void Controller::SetTextFitChanged(bool changed)
358 mImpl->mTextFitChanged = changed;
361 bool Controller::IsTextFitChanged() const
363 return mImpl->mTextFitChanged;
366 void Controller::SetTextFitMinSize(float minSize, FontSizeType type)
368 mImpl->mTextFitMinSize = (type == POINT_SIZE) ? minSize : ConvertPixelToPoint(minSize);
371 float Controller::GetTextFitMinSize() const
373 return mImpl->mTextFitMinSize;
376 void Controller::SetTextFitMaxSize(float maxSize, FontSizeType type)
378 mImpl->mTextFitMaxSize = (type == POINT_SIZE) ? maxSize : ConvertPixelToPoint(maxSize);
381 float Controller::GetTextFitMaxSize() const
383 return mImpl->mTextFitMaxSize;
386 void Controller::SetTextFitStepSize(float step, FontSizeType type)
388 mImpl->mTextFitStepSize = (type == POINT_SIZE) ? step : ConvertPixelToPoint(step);
391 float Controller::GetTextFitStepSize() const
393 return mImpl->mTextFitStepSize;
396 void Controller::SetTextFitContentSize(Vector2 size)
398 mImpl->mTextFitContentSize = size;
401 Vector2 Controller::GetTextFitContentSize() const
403 return mImpl->mTextFitContentSize;
406 float Controller::GetTextFitPointSize() const
408 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFitPointSize : 0.0f;
411 void Controller::SetPlaceholderTextElideEnabled(bool enabled)
413 PlaceholderHandler::SetPlaceholderTextElideEnabled(*this, enabled);
416 bool Controller::IsPlaceholderTextElideEnabled() const
418 return PlaceholderHandler::IsPlaceholderTextElideEnabled(*this);
421 void Controller::SetSelectionEnabled(bool enabled)
423 mImpl->mEventData->mSelectionEnabled = enabled;
426 bool Controller::IsSelectionEnabled() const
428 return mImpl->mEventData->mSelectionEnabled;
431 void Controller::SetShiftSelectionEnabled(bool enabled)
433 mImpl->mEventData->mShiftSelectionFlag = enabled;
436 bool Controller::IsShiftSelectionEnabled() const
438 return mImpl->mEventData->mShiftSelectionFlag;
441 void Controller::SetGrabHandleEnabled(bool enabled)
443 mImpl->mEventData->mGrabHandleEnabled = enabled;
446 bool Controller::IsGrabHandleEnabled() const
448 return mImpl->mEventData->mGrabHandleEnabled;
451 void Controller::SetGrabHandlePopupEnabled(bool enabled)
453 mImpl->mEventData->mGrabHandlePopupEnabled = enabled;
456 bool Controller::IsGrabHandlePopupEnabled() const
458 return mImpl->mEventData->mGrabHandlePopupEnabled;
461 void Controller::SetText(const std::string& text)
463 TextUpdater::SetText(*this, text);
466 void Controller::GetText(std::string& text) const
468 mImpl->GetText(text);
471 void Controller::SetPlaceholderText(PlaceholderType type, const std::string& text)
473 PlaceholderHandler::SetPlaceholderText(*this, type, text);
476 void Controller::GetPlaceholderText(PlaceholderType type, std::string& text) const
478 PlaceholderHandler::GetPlaceholderText(*this, type, text);
481 void Controller::UpdateAfterFontChange(const std::string& newDefaultFont)
483 mImpl->UpdateAfterFontChange(newDefaultFont);
486 void Controller::RetrieveSelection(std::string& selectedText) const
488 mImpl->RetrieveSelection(selectedText, false);
491 void Controller::SetSelection(int start, int end)
493 mImpl->SetSelection(start, end);
496 std::pair<int, int> Controller::GetSelectionIndexes() const
498 return mImpl->GetSelectionIndexes();
501 void Controller::CopyStringToClipboard(const std::string& source)
503 mImpl->CopyStringToClipboard(source);
506 void Controller::SendSelectionToClipboard(bool deleteAfterSending)
508 mImpl->SendSelectionToClipboard(deleteAfterSending);
511 void Controller::SetDefaultFontFamily(const std::string& defaultFontFamily)
513 EnsureCreated(mImpl->mFontDefaults);
515 mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
516 DALI_LOG_INFO(gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
517 mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
519 // Update the cursor position if it's in editing mode
520 UpdateCursorPosition(mImpl->mEventData);
522 // Clear the font-specific data
523 mImpl->ClearFontData();
525 mImpl->RequestRelayout();
528 const std::string& Controller::GetDefaultFontFamily() const
530 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.family : EMPTY_STRING;
533 void Controller::SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily)
535 PlaceholderHandler::SetPlaceholderFontFamily(*this, placeholderTextFontFamily);
538 const std::string& Controller::GetPlaceholderFontFamily() const
540 return PlaceholderHandler::GetPlaceholderFontFamily(*this);
543 void Controller::SetDefaultFontWeight(FontWeight weight)
545 EnsureCreated(mImpl->mFontDefaults);
547 mImpl->mFontDefaults->mFontDescription.weight = weight;
548 mImpl->mFontDefaults->weightDefined = true;
550 // Update the cursor position if it's in editing mode
551 UpdateCursorPosition(mImpl->mEventData);
553 // Clear the font-specific data
554 mImpl->ClearFontData();
556 mImpl->RequestRelayout();
559 bool Controller::IsDefaultFontWeightDefined() const
561 return mImpl->mFontDefaults && mImpl->mFontDefaults->weightDefined;
564 FontWeight Controller::GetDefaultFontWeight() const
566 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.weight : TextAbstraction::FontWeight::NORMAL;
569 void Controller::SetPlaceholderTextFontWeight(FontWeight weight)
571 PlaceholderHandler::SetPlaceholderTextFontWeight(*this, weight);
574 bool Controller::IsPlaceholderTextFontWeightDefined() const
576 return PlaceholderHandler::IsPlaceholderTextFontWeightDefined(*this);
579 FontWeight Controller::GetPlaceholderTextFontWeight() const
581 return PlaceholderHandler::GetPlaceholderTextFontWeight(*this);
584 void Controller::SetDefaultFontWidth(FontWidth width)
586 EnsureCreated(mImpl->mFontDefaults);
588 mImpl->mFontDefaults->mFontDescription.width = width;
589 mImpl->mFontDefaults->widthDefined = true;
591 // Update the cursor position if it's in editing mode
592 UpdateCursorPosition(mImpl->mEventData);
594 // Clear the font-specific data
595 mImpl->ClearFontData();
597 mImpl->RequestRelayout();
600 bool Controller::IsDefaultFontWidthDefined() const
602 return mImpl->mFontDefaults && mImpl->mFontDefaults->widthDefined;
605 FontWidth Controller::GetDefaultFontWidth() const
607 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.width : TextAbstraction::FontWidth::NORMAL;
610 void Controller::SetPlaceholderTextFontWidth(FontWidth width)
612 PlaceholderHandler::SetPlaceholderTextFontWidth(*this, width);
615 bool Controller::IsPlaceholderTextFontWidthDefined() const
617 return PlaceholderHandler::IsPlaceholderTextFontWidthDefined(*this);
620 FontWidth Controller::GetPlaceholderTextFontWidth() const
622 return PlaceholderHandler::GetPlaceholderTextFontWidth(*this);
625 void Controller::SetDefaultFontSlant(FontSlant slant)
627 EnsureCreated(mImpl->mFontDefaults);
629 mImpl->mFontDefaults->mFontDescription.slant = slant;
630 mImpl->mFontDefaults->slantDefined = true;
632 // Update the cursor position if it's in editing mode
633 UpdateCursorPosition(mImpl->mEventData);
635 // Clear the font-specific data
636 mImpl->ClearFontData();
638 mImpl->RequestRelayout();
641 bool Controller::IsDefaultFontSlantDefined() const
643 return mImpl->mFontDefaults && mImpl->mFontDefaults->slantDefined;
646 FontSlant Controller::GetDefaultFontSlant() const
648 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.slant : TextAbstraction::FontSlant::NORMAL;
651 void Controller::SetPlaceholderTextFontSlant(FontSlant slant)
653 PlaceholderHandler::SetPlaceholderTextFontSlant(*this, slant);
656 bool Controller::IsPlaceholderTextFontSlantDefined() const
658 return PlaceholderHandler::IsPlaceholderTextFontSlantDefined(*this);
661 FontSlant Controller::GetPlaceholderTextFontSlant() const
663 return PlaceholderHandler::GetPlaceholderTextFontSlant(*this);
666 void Controller::SetFontSizeScale(float scale)
668 mImpl->mFontSizeScale = scale;
670 // Update the cursor position if it's in editing mode
671 UpdateCursorPosition(mImpl->mEventData);
673 // Clear the font-specific data
674 mImpl->ClearFontData();
676 mImpl->RequestRelayout();
679 float Controller::GetFontSizeScale() const
681 return mImpl->mFontDefaults ? mImpl->mFontSizeScale : 1.0f;
684 void Controller::SetDefaultFontSize(float fontSize, FontSizeType type)
686 EnsureCreated(mImpl->mFontDefaults);
688 mImpl->mFontDefaults->mDefaultPointSize = (type == POINT_SIZE) ? fontSize : ConvertPixelToPoint(fontSize);
689 mImpl->mFontDefaults->sizeDefined = true;
691 // Update the cursor position if it's in editing mode
692 UpdateCursorPosition(mImpl->mEventData);
694 // Clear the font-specific data
695 mImpl->ClearFontData();
697 mImpl->RequestRelayout();
700 float Controller::GetDefaultFontSize(FontSizeType type) const
702 if(mImpl->mFontDefaults)
704 return (type == POINT_SIZE) ? mImpl->mFontDefaults->mDefaultPointSize : ConvertPointToPixel(mImpl->mFontDefaults->mDefaultPointSize);
709 void Controller::SetPlaceholderTextFontSize(float fontSize, FontSizeType type)
711 PlaceholderHandler::SetPlaceholderTextFontSize(*this, fontSize, type);
714 float Controller::GetPlaceholderTextFontSize(FontSizeType type) const
716 return PlaceholderHandler::GetPlaceholderTextFontSize(*this, type);
719 void Controller::SetDefaultColor(const Vector4& color)
721 mImpl->SetDefaultColor(color);
724 const Vector4& Controller::GetDefaultColor() const
726 return mImpl->mTextColor;
729 void Controller::SetPlaceholderTextColor(const Vector4& textColor)
731 PlaceholderHandler::SetPlaceholderTextColor(*this, textColor);
734 const Vector4& Controller::GetPlaceholderTextColor() const
736 return PlaceholderHandler::GetPlaceholderTextColor(*this);
739 void Controller::SetShadowOffset(const Vector2& shadowOffset)
741 mImpl->mModel->mVisualModel->SetShadowOffset(shadowOffset);
742 mImpl->RequestRelayout();
745 const Vector2& Controller::GetShadowOffset() const
747 return mImpl->mModel->mVisualModel->GetShadowOffset();
750 void Controller::SetShadowColor(const Vector4& shadowColor)
752 mImpl->mModel->mVisualModel->SetShadowColor(shadowColor);
753 mImpl->RequestRelayout();
756 const Vector4& Controller::GetShadowColor() const
758 return mImpl->mModel->mVisualModel->GetShadowColor();
761 void Controller::SetShadowBlurRadius(const float& shadowBlurRadius)
763 if(fabsf(GetShadowBlurRadius() - shadowBlurRadius) > Math::MACHINE_EPSILON_1)
765 mImpl->mModel->mVisualModel->SetShadowBlurRadius(shadowBlurRadius);
766 mImpl->RequestRelayout();
770 const float& Controller::GetShadowBlurRadius() const
772 return mImpl->mModel->mVisualModel->GetShadowBlurRadius();
775 void Controller::SetUnderlineColor(const Vector4& color)
777 mImpl->mModel->mVisualModel->SetUnderlineColor(color);
778 mImpl->RequestRelayout();
781 const Vector4& Controller::GetUnderlineColor() const
783 return mImpl->mModel->mVisualModel->GetUnderlineColor();
786 void Controller::SetUnderlineEnabled(bool enabled)
788 mImpl->mModel->mVisualModel->SetUnderlineEnabled(enabled);
789 mImpl->RequestRelayout();
792 bool Controller::IsUnderlineEnabled() const
794 return mImpl->mModel->mVisualModel->IsUnderlineEnabled();
797 void Controller::SetUnderlineHeight(float height)
799 mImpl->mModel->mVisualModel->SetUnderlineHeight(height);
800 mImpl->RequestRelayout();
803 float Controller::GetUnderlineHeight() const
805 return mImpl->mModel->mVisualModel->GetUnderlineHeight();
808 void Controller::SetOutlineColor(const Vector4& color)
810 mImpl->mModel->mVisualModel->SetOutlineColor(color);
811 mImpl->RequestRelayout();
814 const Vector4& Controller::GetOutlineColor() const
816 return mImpl->mModel->mVisualModel->GetOutlineColor();
819 void Controller::SetOutlineWidth(uint16_t width)
821 mImpl->mModel->mVisualModel->SetOutlineWidth(width);
822 mImpl->RequestRelayout();
825 uint16_t Controller::GetOutlineWidth() const
827 return mImpl->mModel->mVisualModel->GetOutlineWidth();
830 void Controller::SetBackgroundColor(const Vector4& color)
832 mImpl->mModel->mVisualModel->SetBackgroundColor(color);
833 mImpl->RequestRelayout();
836 const Vector4& Controller::GetBackgroundColor() const
838 return mImpl->mModel->mVisualModel->GetBackgroundColor();
841 void Controller::SetBackgroundEnabled(bool enabled)
843 mImpl->mModel->mVisualModel->SetBackgroundEnabled(enabled);
844 mImpl->RequestRelayout();
847 bool Controller::IsBackgroundEnabled() const
849 return mImpl->mModel->mVisualModel->IsBackgroundEnabled();
852 void Controller::SetDefaultEmbossProperties(const std::string& embossProperties)
854 EnsureCreated(mImpl->mEmbossDefaults);
855 mImpl->mEmbossDefaults->properties = embossProperties;
858 const std::string& Controller::GetDefaultEmbossProperties() const
860 return mImpl->mEmbossDefaults ? mImpl->mEmbossDefaults->properties : EMPTY_STRING;
863 void Controller::SetDefaultOutlineProperties(const std::string& outlineProperties)
865 EnsureCreated(mImpl->mOutlineDefaults);
866 mImpl->mOutlineDefaults->properties = outlineProperties;
869 const std::string& Controller::GetDefaultOutlineProperties() const
871 return mImpl->mOutlineDefaults ? mImpl->mOutlineDefaults->properties : EMPTY_STRING;
874 bool Controller::SetDefaultLineSpacing(float lineSpacing)
876 return mImpl->SetDefaultLineSpacing(lineSpacing);
879 float Controller::GetDefaultLineSpacing() const
881 return mImpl->mLayoutEngine.GetDefaultLineSpacing();
884 bool Controller::SetDefaultLineSize(float lineSize)
886 return mImpl->SetDefaultLineSize(lineSize);
889 float Controller::GetDefaultLineSize() const
891 return mImpl->mLayoutEngine.GetDefaultLineSize();
894 void Controller::SetInputColor(const Vector4& color)
896 InputProperties::SetInputColor(*this, color);
899 const Vector4& Controller::GetInputColor() const
901 return InputProperties::GetInputColor(*this);
904 void Controller::SetInputFontFamily(const std::string& fontFamily)
906 InputFontHandler::SetInputFontFamily(*this, fontFamily);
909 const std::string& Controller::GetInputFontFamily() const
911 return InputFontHandler::GetInputFontFamily(*this);
914 void Controller::SetInputFontWeight(FontWeight weight)
916 InputFontHandler::SetInputFontWeight(*this, weight);
919 bool Controller::IsInputFontWeightDefined() const
921 return InputFontHandler::IsInputFontWeightDefined(*this);
924 FontWeight Controller::GetInputFontWeight() const
926 return InputFontHandler::GetInputFontWeight(*this);
929 void Controller::SetInputFontWidth(FontWidth width)
931 InputFontHandler::SetInputFontWidth(*this, width);
934 bool Controller::IsInputFontWidthDefined() const
936 return InputFontHandler::IsInputFontWidthDefined(*this);
939 FontWidth Controller::GetInputFontWidth() const
941 return InputFontHandler::GetInputFontWidth(*this);
944 void Controller::SetInputFontSlant(FontSlant slant)
946 InputFontHandler::SetInputFontSlant(*this, slant);
949 bool Controller::IsInputFontSlantDefined() const
951 return InputFontHandler::IsInputFontSlantDefined(*this);
954 FontSlant Controller::GetInputFontSlant() const
956 return InputFontHandler::GetInputFontSlant(*this);
959 void Controller::SetInputFontPointSize(float size)
961 InputFontHandler::SetInputFontPointSize(*this, size);
964 float Controller::GetInputFontPointSize() const
966 return InputFontHandler::GetInputFontPointSize(*this);
969 void Controller::SetInputLineSpacing(float lineSpacing)
971 InputProperties::SetInputLineSpacing(*this, lineSpacing);
974 float Controller::GetInputLineSpacing() const
976 return InputProperties::GetInputLineSpacing(*this);
979 void Controller::SetInputShadowProperties(const std::string& shadowProperties)
981 InputProperties::SetInputShadowProperties(*this, shadowProperties);
984 const std::string& Controller::GetInputShadowProperties() const
986 return InputProperties::GetInputShadowProperties(*this);
989 void Controller::SetInputUnderlineProperties(const std::string& underlineProperties)
991 InputProperties::SetInputUnderlineProperties(*this, underlineProperties);
994 const std::string& Controller::GetInputUnderlineProperties() const
996 return InputProperties::GetInputUnderlineProperties(*this);
999 void Controller::SetInputEmbossProperties(const std::string& embossProperties)
1001 InputProperties::SetInputEmbossProperties(*this, embossProperties);
1004 const std::string& Controller::GetInputEmbossProperties() const
1006 return InputProperties::GetInputEmbossProperties(*this);
1009 void Controller::SetInputOutlineProperties(const std::string& outlineProperties)
1011 InputProperties::SetInputOutlineProperties(*this, outlineProperties);
1014 const std::string& Controller::GetInputOutlineProperties() const
1016 return InputProperties::GetInputOutlineProperties(*this);
1019 void Controller::SetInputModePassword(bool passwordInput)
1021 InputProperties::SetInputModePassword(*this, passwordInput);
1024 bool Controller::IsInputModePassword()
1026 return InputProperties::IsInputModePassword(*this);
1029 void Controller::SetNoTextDoubleTapAction(NoTextTap::Action action)
1031 if(mImpl->mEventData)
1033 mImpl->mEventData->mDoubleTapAction = action;
1037 Controller::NoTextTap::Action Controller::GetNoTextDoubleTapAction() const
1039 return mImpl->mEventData ? mImpl->mEventData->mDoubleTapAction : NoTextTap::NO_ACTION;
1042 void Controller::SetNoTextLongPressAction(NoTextTap::Action action)
1044 if(mImpl->mEventData)
1046 mImpl->mEventData->mLongPressAction = action;
1050 Controller::NoTextTap::Action Controller::GetNoTextLongPressAction() const
1052 return mImpl->mEventData ? mImpl->mEventData->mLongPressAction : NoTextTap::NO_ACTION;
1055 bool Controller::IsUnderlineSetByString()
1057 return mImpl->mUnderlineSetByString;
1060 void Controller::UnderlineSetByString(bool setByString)
1062 mImpl->mUnderlineSetByString = setByString;
1065 bool Controller::IsShadowSetByString()
1067 return mImpl->mShadowSetByString;
1070 void Controller::ShadowSetByString(bool setByString)
1072 mImpl->mShadowSetByString = setByString;
1075 bool Controller::IsOutlineSetByString()
1077 return mImpl->mOutlineSetByString;
1080 void Controller::OutlineSetByString(bool setByString)
1082 mImpl->mOutlineSetByString = setByString;
1085 bool Controller::IsFontStyleSetByString()
1087 return mImpl->mFontStyleSetByString;
1090 void Controller::FontStyleSetByString(bool setByString)
1092 mImpl->mFontStyleSetByString = setByString;
1095 void Controller::SetStrikethroughHeight(float height)
1097 mImpl->mModel->mVisualModel->SetStrikethroughHeight(height);
1099 mImpl->RequestRelayout();
1102 float Controller::GetStrikethroughHeight() const
1104 return mImpl->mModel->mVisualModel->GetStrikethroughHeight();
1107 void Controller::SetStrikethroughColor(const Vector4& color)
1109 mImpl->mModel->mVisualModel->SetStrikethroughColor(color);
1111 mImpl->RequestRelayout();
1114 const Vector4& Controller::GetStrikethroughColor() const
1116 return mImpl->mModel->mVisualModel->GetStrikethroughColor();
1119 void Controller::SetStrikethroughEnabled(bool enabled)
1121 mImpl->mModel->mVisualModel->SetStrikethroughEnabled(enabled);
1123 mImpl->RequestRelayout();
1126 bool Controller::IsStrikethroughEnabled() const
1128 return mImpl->mModel->mVisualModel->IsStrikethroughEnabled();
1131 void Controller::SetInputStrikethroughProperties(const std::string& strikethroughProperties)
1133 if(NULL != mImpl->mEventData)
1135 mImpl->mEventData->mInputStyle.strikethroughProperties = strikethroughProperties;
1139 const std::string& Controller::GetInputStrikethroughProperties() const
1141 return (NULL != mImpl->mEventData) ? mImpl->mEventData->mInputStyle.strikethroughProperties : EMPTY_STRING;
1144 bool Controller::IsStrikethroughSetByString()
1146 return mImpl->mStrikethroughSetByString;
1149 void Controller::StrikethroughSetByString(bool setByString)
1151 mImpl->mStrikethroughSetByString = setByString;
1154 Layout::Engine& Controller::GetLayoutEngine()
1156 return mImpl->mLayoutEngine;
1159 View& Controller::GetView()
1161 return mImpl->mView;
1164 Vector3 Controller::GetNaturalSize()
1166 return Relayouter::GetNaturalSize(*this);
1169 bool Controller::CheckForTextFit(float pointSize, Size& layoutSize)
1171 return Relayouter::CheckForTextFit(*this, pointSize, layoutSize);
1174 void Controller::FitPointSizeforLayout(Size layoutSize)
1176 Relayouter::FitPointSizeforLayout(*this, layoutSize);
1179 float Controller::GetHeightForWidth(float width)
1181 return Relayouter::GetHeightForWidth(*this, width);
1184 int Controller::GetLineCount(float width)
1186 GetHeightForWidth(width);
1187 return mImpl->mModel->GetNumberOfLines();
1190 const ModelInterface* const Controller::GetTextModel() const
1192 return mImpl->mModel.Get();
1195 float Controller::GetScrollAmountByUserInput()
1197 float scrollAmount = 0.0f;
1199 if(NULL != mImpl->mEventData && mImpl->mEventData->mCheckScrollAmount)
1201 scrollAmount = mImpl->mModel->mScrollPosition.y - mImpl->mModel->mScrollPositionLast.y;
1202 mImpl->mEventData->mCheckScrollAmount = false;
1204 return scrollAmount;
1207 bool Controller::GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight)
1209 const Vector2& layout = mImpl->mModel->mVisualModel->GetLayoutSize();
1212 controlHeight = mImpl->mModel->mVisualModel->mControlSize.height;
1213 layoutHeight = layout.height;
1214 scrollPosition = mImpl->mModel->mScrollPosition.y;
1215 isScrolled = !Equals(mImpl->mModel->mScrollPosition.y, mImpl->mModel->mScrollPositionLast.y, Math::MACHINE_EPSILON_1);
1219 void Controller::SetHiddenInputOption(const Property::Map& options)
1221 EnsureCreated<HiddenText, Controller*>(mImpl->mHiddenInput, this);
1222 mImpl->mHiddenInput->SetProperties(options);
1225 void Controller::GetHiddenInputOption(Property::Map& options)
1227 if(mImpl->mHiddenInput)
1229 mImpl->mHiddenInput->GetProperties(options);
1233 void Controller::SetInputFilterOption(const Property::Map& options)
1235 EnsureCreated(mImpl->mInputFilter);
1236 mImpl->mInputFilter->SetProperties(options);
1239 void Controller::GetInputFilterOption(Property::Map& options)
1241 if(mImpl->mInputFilter)
1243 mImpl->mInputFilter->GetProperties(options);
1247 void Controller::SetPlaceholderProperty(const Property::Map& map)
1249 PlaceholderHandler::SetPlaceholderProperty(*this, map);
1252 void Controller::GetPlaceholderProperty(Property::Map& map)
1254 PlaceholderHandler::GetPlaceholderProperty(*this, map);
1257 Toolkit::DevelText::TextDirection::Type Controller::GetTextDirection()
1259 // Make sure the model is up-to-date before layouting
1260 EventHandler::ProcessModifyEvents(*this);
1262 return mImpl->GetTextDirection();
1265 Toolkit::DevelText::VerticalLineAlignment::Type Controller::GetVerticalLineAlignment() const
1267 return mImpl->mModel->GetVerticalLineAlignment();
1270 void Controller::SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment)
1272 mImpl->mModel->mVerticalLineAlignment = alignment;
1275 Toolkit::DevelText::EllipsisPosition::Type Controller::GetEllipsisPosition() const
1277 return mImpl->mModel->GetEllipsisPosition();
1280 void Controller::SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition)
1282 mImpl->mModel->mEllipsisPosition = ellipsisPosition;
1283 mImpl->mModel->mVisualModel->SetEllipsisPosition(ellipsisPosition);
1286 Controller::UpdateTextType Controller::Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection)
1288 return Relayouter::Relayout(*this, size, layoutDirection);
1291 void Controller::RequestRelayout()
1293 mImpl->RequestRelayout();
1296 Vector<Vector2> Controller::GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex)
1298 Vector<Vector2> sizesList;
1299 Vector<Vector2> positionsList;
1301 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1305 Vector<Vector2> Controller::GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex)
1307 Vector<Vector2> sizesList;
1308 Vector<Vector2> positionsList;
1310 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1311 return positionsList;
1314 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1316 return mImpl->IsInputStyleChangedSignalsQueueEmpty();
1319 void Controller::ProcessInputStyleChangedSignals()
1321 mImpl->ProcessInputStyleChangedSignals();
1324 void Controller::KeyboardFocusGainEvent()
1326 EventHandler::KeyboardFocusGainEvent(*this);
1329 void Controller::KeyboardFocusLostEvent()
1331 EventHandler::KeyboardFocusLostEvent(*this);
1334 bool Controller::KeyEvent(const Dali::KeyEvent& keyEvent)
1336 return EventHandler::KeyEvent(*this, keyEvent);
1339 void Controller::AnchorEvent(float x, float y)
1341 EventHandler::AnchorEvent(*this, x, y);
1344 void Controller::TapEvent(unsigned int tapCount, float x, float y)
1346 EventHandler::TapEvent(*this, tapCount, x, y);
1349 void Controller::PanEvent(GestureState state, const Vector2& displacement)
1351 EventHandler::PanEvent(*this, state, displacement);
1354 void Controller::LongPressEvent(GestureState state, float x, float y)
1356 EventHandler::LongPressEvent(*this, state, x, y);
1359 void Controller::SelectEvent(float x, float y, SelectionType selectType)
1361 EventHandler::SelectEvent(*this, x, y, selectType);
1364 void Controller::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1366 if(mImpl->mEventData)
1368 mImpl->mEventData->mCheckScrollAmount = true;
1369 mImpl->mEventData->mIsLeftHandleSelected = true;
1370 mImpl->mEventData->mIsRightHandleSelected = true;
1371 mImpl->SetTextSelectionRange(start, end);
1372 mImpl->RequestRelayout();
1373 EventHandler::KeyboardFocusGainEvent(*this);
1377 Uint32Pair Controller::GetTextSelectionRange() const
1379 return mImpl->GetTextSelectionRange();
1382 CharacterIndex Controller::GetPrimaryCursorPosition() const
1384 return mImpl->GetPrimaryCursorPosition();
1387 bool Controller::SetPrimaryCursorPosition(CharacterIndex index, bool focused)
1389 if(mImpl->mEventData)
1391 mImpl->mEventData->mCheckScrollAmount = true;
1392 mImpl->mEventData->mIsLeftHandleSelected = true;
1393 mImpl->mEventData->mIsRightHandleSelected = true;
1394 mImpl->mEventData->mCheckScrollAmount = true;
1395 if(mImpl->SetPrimaryCursorPosition(index, focused) && focused)
1397 EventHandler::KeyboardFocusGainEvent(*this);
1404 void Controller::SelectWholeText()
1406 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::ALL);
1409 void Controller::SelectNone()
1411 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::NONE);
1414 void Controller::SelectText(const uint32_t start, const uint32_t end)
1416 EventHandler::SelectEvent(*this, start, end, SelectionType::RANGE);
1419 string Controller::GetSelectedText() const
1421 return mImpl->GetSelectedText();
1424 string Controller::CopyText()
1426 return mImpl->CopyText();
1429 string Controller::CutText()
1431 return mImpl->CutText();
1434 void Controller::PasteText()
1436 mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
1439 InputMethodContext::CallbackData Controller::OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1441 return EventHandler::OnInputMethodContextEvent(*this, inputMethodContext, inputMethodContextEvent);
1444 void Controller::PasteClipboardItemEvent()
1446 EventHandler::PasteClipboardItemEvent(*this);
1449 void Controller::GetTargetSize(Vector2& targetSize)
1451 targetSize = mImpl->mModel->mVisualModel->mControlSize;
1454 void Controller::AddDecoration(Actor& actor, bool needsClipping)
1456 if(mImpl->mEditableControlInterface)
1458 mImpl->mEditableControlInterface->AddDecoration(actor, needsClipping);
1462 bool Controller::IsEditable() const
1464 return mImpl->IsEditable();
1467 void Controller::SetEditable(bool editable)
1469 mImpl->SetEditable(editable);
1472 void Controller::ScrollBy(Vector2 scroll)
1474 mImpl->ScrollBy(scroll);
1477 float Controller::GetHorizontalScrollPosition()
1479 return mImpl->GetHorizontalScrollPosition();
1482 float Controller::GetVerticalScrollPosition()
1484 return mImpl->GetVerticalScrollPosition();
1487 void Controller::DecorationEvent(HandleType handleType, HandleState state, float x, float y)
1489 EventHandler::DecorationEvent(*this, handleType, state, x, y);
1492 void Controller::TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button)
1494 EventHandler::TextPopupButtonTouched(*this, button);
1497 void Controller::DisplayTimeExpired()
1499 mImpl->mEventData->mUpdateCursorPosition = true;
1500 // Apply modifications to the model
1501 mImpl->mOperationsPending = ALL_OPERATIONS;
1503 mImpl->RequestRelayout();
1506 void Controller::ResetCursorPosition(CharacterIndex cursorIndex)
1508 // Reset the cursor position
1509 if(NULL != mImpl->mEventData)
1511 mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
1513 // Update the cursor if it's in editing mode.
1514 if(EventData::IsEditingState(mImpl->mEventData->mState))
1516 mImpl->mEventData->mUpdateCursorPosition = true;
1521 CharacterIndex Controller::GetCursorPosition()
1523 return mImpl->mEventData ? mImpl->mEventData->mPrimaryCursorPosition : 0;
1526 void Controller::SetControlInterface(ControlInterface* controlInterface)
1528 mImpl->mControlInterface = controlInterface;
1531 void Controller::SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface)
1533 mImpl->mAnchorControlInterface = anchorControlInterface;
1536 bool Controller::ShouldClearFocusOnEscape() const
1538 return mImpl->mShouldClearFocusOnEscape;
1541 Actor Controller::CreateBackgroundActor()
1543 return CreateControllerBackgroundActor(mImpl->mView, mImpl->mModel->mVisualModel, mImpl->mShaderBackground);
1546 void Controller::GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors)
1548 mImpl->GetAnchorActors(anchorActors);
1551 int Controller::GetAnchorIndex(size_t characterOffset)
1553 return mImpl->GetAnchorIndex(characterOffset);
1556 Controller::Controller(ControlInterface* controlInterface,
1557 EditableControlInterface* editableControlInterface,
1558 SelectableControlInterface* selectableControlInterface,
1559 AnchorControlInterface* anchorControlInterface)
1560 : mImpl(new Controller::Impl(controlInterface, editableControlInterface, selectableControlInterface, anchorControlInterface))
1564 Controller::~Controller()
1569 } // namespace Dali::Toolkit::Text