2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/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 // No relayout is required
671 if(!mImpl->mFontSizeScaleEnabled) return;
673 // Update the cursor position if it's in editing mode
674 UpdateCursorPosition(mImpl->mEventData);
676 // Clear the font-specific data
677 mImpl->ClearFontData();
679 mImpl->RequestRelayout();
682 float Controller::GetFontSizeScale() const
684 return mImpl->mFontDefaults ? mImpl->mFontSizeScale : 1.0f;
687 void Controller::SetFontSizeScaleEnabled(bool enabled)
689 mImpl->mFontSizeScaleEnabled = enabled;
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 bool Controller::IsFontSizeScaleEnabled() const
702 return mImpl->mFontSizeScaleEnabled;
705 void Controller::SetDefaultFontSize(float fontSize, FontSizeType type)
707 EnsureCreated(mImpl->mFontDefaults);
709 mImpl->mFontDefaults->mDefaultPointSize = (type == POINT_SIZE) ? fontSize : ConvertPixelToPoint(fontSize);
710 mImpl->mFontDefaults->sizeDefined = true;
712 // Update the cursor position if it's in editing mode
713 UpdateCursorPosition(mImpl->mEventData);
715 // Clear the font-specific data
716 mImpl->ClearFontData();
718 mImpl->RequestRelayout();
721 float Controller::GetDefaultFontSize(FontSizeType type) const
723 if(mImpl->mFontDefaults)
725 return (type == POINT_SIZE) ? mImpl->mFontDefaults->mDefaultPointSize : ConvertPointToPixel(mImpl->mFontDefaults->mDefaultPointSize);
730 void Controller::SetPlaceholderTextFontSize(float fontSize, FontSizeType type)
732 PlaceholderHandler::SetPlaceholderTextFontSize(*this, fontSize, type);
735 float Controller::GetPlaceholderTextFontSize(FontSizeType type) const
737 return PlaceholderHandler::GetPlaceholderTextFontSize(*this, type);
740 void Controller::SetDefaultColor(const Vector4& color)
742 mImpl->SetDefaultColor(color);
745 const Vector4& Controller::GetDefaultColor() const
747 return mImpl->mTextColor;
750 void Controller::SetPlaceholderTextColor(const Vector4& textColor)
752 PlaceholderHandler::SetPlaceholderTextColor(*this, textColor);
755 const Vector4& Controller::GetPlaceholderTextColor() const
757 return PlaceholderHandler::GetPlaceholderTextColor(*this);
760 void Controller::SetShadowOffset(const Vector2& shadowOffset)
762 mImpl->mModel->mVisualModel->SetShadowOffset(shadowOffset);
763 mImpl->RequestRelayout();
766 const Vector2& Controller::GetShadowOffset() const
768 return mImpl->mModel->mVisualModel->GetShadowOffset();
771 void Controller::SetShadowColor(const Vector4& shadowColor)
773 mImpl->mModel->mVisualModel->SetShadowColor(shadowColor);
774 mImpl->RequestRelayout();
777 const Vector4& Controller::GetShadowColor() const
779 return mImpl->mModel->mVisualModel->GetShadowColor();
782 void Controller::SetShadowBlurRadius(const float& shadowBlurRadius)
784 if(fabsf(GetShadowBlurRadius() - shadowBlurRadius) > Math::MACHINE_EPSILON_1)
786 mImpl->mModel->mVisualModel->SetShadowBlurRadius(shadowBlurRadius);
787 mImpl->RequestRelayout();
791 const float& Controller::GetShadowBlurRadius() const
793 return mImpl->mModel->mVisualModel->GetShadowBlurRadius();
796 void Controller::SetUnderlineColor(const Vector4& color)
798 mImpl->mModel->mVisualModel->SetUnderlineColor(color);
799 mImpl->RequestRelayout();
802 const Vector4& Controller::GetUnderlineColor() const
804 return mImpl->mModel->mVisualModel->GetUnderlineColor();
807 void Controller::SetUnderlineEnabled(bool enabled)
809 mImpl->mModel->mVisualModel->SetUnderlineEnabled(enabled);
810 mImpl->RequestRelayout();
813 bool Controller::IsUnderlineEnabled() const
815 return mImpl->mModel->mVisualModel->IsUnderlineEnabled();
818 void Controller::SetUnderlineHeight(float height)
820 mImpl->mModel->mVisualModel->SetUnderlineHeight(height);
821 mImpl->RequestRelayout();
824 float Controller::GetUnderlineHeight() const
826 return mImpl->mModel->mVisualModel->GetUnderlineHeight();
829 void Controller::SetUnderlineType(Text::Underline::Type type)
831 mImpl->mModel->mVisualModel->SetUnderlineType(type);
833 mImpl->RequestRelayout();
836 Text::Underline::Type Controller::GetUnderlineType() const
838 return mImpl->mModel->mVisualModel->GetUnderlineType();
841 void Controller::SetDashedUnderlineWidth(float width)
843 mImpl->mModel->mVisualModel->SetDashedUnderlineWidth(width);
845 mImpl->RequestRelayout();
848 float Controller::GetDashedUnderlineWidth() const
850 return mImpl->mModel->mVisualModel->GetDashedUnderlineWidth();
853 void Controller::SetDashedUnderlineGap(float gap)
855 mImpl->mModel->mVisualModel->SetDashedUnderlineGap(gap);
857 mImpl->RequestRelayout();
860 float Controller::GetDashedUnderlineGap() const
862 return mImpl->mModel->mVisualModel->GetDashedUnderlineGap();
865 void Controller::SetOutlineColor(const Vector4& color)
867 mImpl->mModel->mVisualModel->SetOutlineColor(color);
868 mImpl->RequestRelayout();
871 const Vector4& Controller::GetOutlineColor() const
873 return mImpl->mModel->mVisualModel->GetOutlineColor();
876 void Controller::SetOutlineWidth(uint16_t width)
878 mImpl->mModel->mVisualModel->SetOutlineWidth(width);
879 mImpl->RequestRelayout();
882 uint16_t Controller::GetOutlineWidth() const
884 return mImpl->mModel->mVisualModel->GetOutlineWidth();
887 void Controller::SetBackgroundColor(const Vector4& color)
889 mImpl->mModel->mVisualModel->SetBackgroundColor(color);
890 mImpl->RequestRelayout();
893 const Vector4& Controller::GetBackgroundColor() const
895 return mImpl->mModel->mVisualModel->GetBackgroundColor();
898 void Controller::SetBackgroundEnabled(bool enabled)
900 mImpl->mModel->mVisualModel->SetBackgroundEnabled(enabled);
901 mImpl->RequestRelayout();
904 bool Controller::IsBackgroundEnabled() const
906 return mImpl->mModel->mVisualModel->IsBackgroundEnabled();
909 void Controller::SetDefaultEmbossProperties(const std::string& embossProperties)
911 EnsureCreated(mImpl->mEmbossDefaults);
912 mImpl->mEmbossDefaults->properties = embossProperties;
915 const std::string& Controller::GetDefaultEmbossProperties() const
917 return mImpl->mEmbossDefaults ? mImpl->mEmbossDefaults->properties : EMPTY_STRING;
920 void Controller::SetDefaultOutlineProperties(const std::string& outlineProperties)
922 EnsureCreated(mImpl->mOutlineDefaults);
923 mImpl->mOutlineDefaults->properties = outlineProperties;
926 const std::string& Controller::GetDefaultOutlineProperties() const
928 return mImpl->mOutlineDefaults ? mImpl->mOutlineDefaults->properties : EMPTY_STRING;
931 bool Controller::SetDefaultLineSpacing(float lineSpacing)
933 return mImpl->SetDefaultLineSpacing(lineSpacing);
936 float Controller::GetDefaultLineSpacing() const
938 return mImpl->mLayoutEngine.GetDefaultLineSpacing();
941 bool Controller::SetDefaultLineSize(float lineSize)
943 return mImpl->SetDefaultLineSize(lineSize);
946 float Controller::GetDefaultLineSize() const
948 return mImpl->mLayoutEngine.GetDefaultLineSize();
951 bool Controller::SetRelativeLineSize(float relativeLineSize)
953 return mImpl->SetRelativeLineSize(relativeLineSize);
956 float Controller::GetRelativeLineSize() const
958 return mImpl->GetRelativeLineSize();
961 void Controller::SetInputColor(const Vector4& color)
963 InputProperties::SetInputColor(*this, color);
966 const Vector4& Controller::GetInputColor() const
968 return InputProperties::GetInputColor(*this);
971 void Controller::SetInputFontFamily(const std::string& fontFamily)
973 InputFontHandler::SetInputFontFamily(*this, fontFamily);
976 const std::string& Controller::GetInputFontFamily() const
978 return InputFontHandler::GetInputFontFamily(*this);
981 void Controller::SetInputFontWeight(FontWeight weight)
983 InputFontHandler::SetInputFontWeight(*this, weight);
986 bool Controller::IsInputFontWeightDefined() const
988 return InputFontHandler::IsInputFontWeightDefined(*this);
991 FontWeight Controller::GetInputFontWeight() const
993 return InputFontHandler::GetInputFontWeight(*this);
996 void Controller::SetInputFontWidth(FontWidth width)
998 InputFontHandler::SetInputFontWidth(*this, width);
1001 bool Controller::IsInputFontWidthDefined() const
1003 return InputFontHandler::IsInputFontWidthDefined(*this);
1006 FontWidth Controller::GetInputFontWidth() const
1008 return InputFontHandler::GetInputFontWidth(*this);
1011 void Controller::SetInputFontSlant(FontSlant slant)
1013 InputFontHandler::SetInputFontSlant(*this, slant);
1016 bool Controller::IsInputFontSlantDefined() const
1018 return InputFontHandler::IsInputFontSlantDefined(*this);
1021 FontSlant Controller::GetInputFontSlant() const
1023 return InputFontHandler::GetInputFontSlant(*this);
1026 void Controller::SetInputFontPointSize(float size)
1028 InputFontHandler::SetInputFontPointSize(*this, size);
1031 float Controller::GetInputFontPointSize() const
1033 return InputFontHandler::GetInputFontPointSize(*this);
1036 void Controller::SetInputLineSpacing(float lineSpacing)
1038 InputProperties::SetInputLineSpacing(*this, lineSpacing);
1041 float Controller::GetInputLineSpacing() const
1043 return InputProperties::GetInputLineSpacing(*this);
1046 void Controller::SetInputShadowProperties(const std::string& shadowProperties)
1048 InputProperties::SetInputShadowProperties(*this, shadowProperties);
1051 const std::string& Controller::GetInputShadowProperties() const
1053 return InputProperties::GetInputShadowProperties(*this);
1056 void Controller::SetInputUnderlineProperties(const std::string& underlineProperties)
1058 InputProperties::SetInputUnderlineProperties(*this, underlineProperties);
1061 const std::string& Controller::GetInputUnderlineProperties() const
1063 return InputProperties::GetInputUnderlineProperties(*this);
1066 void Controller::SetInputEmbossProperties(const std::string& embossProperties)
1068 InputProperties::SetInputEmbossProperties(*this, embossProperties);
1071 const std::string& Controller::GetInputEmbossProperties() const
1073 return InputProperties::GetInputEmbossProperties(*this);
1076 void Controller::SetInputOutlineProperties(const std::string& outlineProperties)
1078 InputProperties::SetInputOutlineProperties(*this, outlineProperties);
1081 const std::string& Controller::GetInputOutlineProperties() const
1083 return InputProperties::GetInputOutlineProperties(*this);
1086 void Controller::SetInputModePassword(bool passwordInput)
1088 InputProperties::SetInputModePassword(*this, passwordInput);
1091 bool Controller::IsInputModePassword()
1093 return InputProperties::IsInputModePassword(*this);
1096 void Controller::SetNoTextDoubleTapAction(NoTextTap::Action action)
1098 if(mImpl->mEventData)
1100 mImpl->mEventData->mDoubleTapAction = action;
1104 Controller::NoTextTap::Action Controller::GetNoTextDoubleTapAction() const
1106 return mImpl->mEventData ? mImpl->mEventData->mDoubleTapAction : NoTextTap::NO_ACTION;
1109 void Controller::SetNoTextLongPressAction(NoTextTap::Action action)
1111 if(mImpl->mEventData)
1113 mImpl->mEventData->mLongPressAction = action;
1117 Controller::NoTextTap::Action Controller::GetNoTextLongPressAction() const
1119 return mImpl->mEventData ? mImpl->mEventData->mLongPressAction : NoTextTap::NO_ACTION;
1122 bool Controller::IsUnderlineSetByString()
1124 return mImpl->mUnderlineSetByString;
1127 void Controller::UnderlineSetByString(bool setByString)
1129 mImpl->mUnderlineSetByString = setByString;
1132 bool Controller::IsShadowSetByString()
1134 return mImpl->mShadowSetByString;
1137 void Controller::ShadowSetByString(bool setByString)
1139 mImpl->mShadowSetByString = setByString;
1142 bool Controller::IsOutlineSetByString()
1144 return mImpl->mOutlineSetByString;
1147 void Controller::OutlineSetByString(bool setByString)
1149 mImpl->mOutlineSetByString = setByString;
1152 bool Controller::IsFontStyleSetByString()
1154 return mImpl->mFontStyleSetByString;
1157 void Controller::FontStyleSetByString(bool setByString)
1159 mImpl->mFontStyleSetByString = setByString;
1162 void Controller::SetStrikethroughHeight(float height)
1164 mImpl->mModel->mVisualModel->SetStrikethroughHeight(height);
1166 mImpl->RequestRelayout();
1169 float Controller::GetStrikethroughHeight() const
1171 return mImpl->mModel->mVisualModel->GetStrikethroughHeight();
1174 void Controller::SetStrikethroughColor(const Vector4& color)
1176 mImpl->mModel->mVisualModel->SetStrikethroughColor(color);
1178 mImpl->RequestRelayout();
1181 const Vector4& Controller::GetStrikethroughColor() const
1183 return mImpl->mModel->mVisualModel->GetStrikethroughColor();
1186 void Controller::SetStrikethroughEnabled(bool enabled)
1188 mImpl->mModel->mVisualModel->SetStrikethroughEnabled(enabled);
1190 mImpl->RequestRelayout();
1193 bool Controller::IsStrikethroughEnabled() const
1195 return mImpl->mModel->mVisualModel->IsStrikethroughEnabled();
1198 void Controller::SetInputStrikethroughProperties(const std::string& strikethroughProperties)
1200 if(NULL != mImpl->mEventData)
1202 mImpl->mEventData->mInputStyle.strikethroughProperties = strikethroughProperties;
1206 const std::string& Controller::GetInputStrikethroughProperties() const
1208 return (NULL != mImpl->mEventData) ? mImpl->mEventData->mInputStyle.strikethroughProperties : EMPTY_STRING;
1211 bool Controller::IsStrikethroughSetByString()
1213 return mImpl->mStrikethroughSetByString;
1216 void Controller::StrikethroughSetByString(bool setByString)
1218 mImpl->mStrikethroughSetByString = setByString;
1221 Layout::Engine& Controller::GetLayoutEngine()
1223 return mImpl->mLayoutEngine;
1226 View& Controller::GetView()
1228 return mImpl->mView;
1231 Vector3 Controller::GetNaturalSize()
1233 return Relayouter::GetNaturalSize(*this);
1236 bool Controller::CheckForTextFit(float pointSize, Size& layoutSize)
1238 return Relayouter::CheckForTextFit(*this, pointSize, layoutSize);
1241 void Controller::FitPointSizeforLayout(Size layoutSize)
1243 Relayouter::FitPointSizeforLayout(*this, layoutSize);
1246 float Controller::GetHeightForWidth(float width)
1248 return Relayouter::GetHeightForWidth(*this, width);
1251 int Controller::GetLineCount(float width)
1253 GetHeightForWidth(width);
1254 return mImpl->mModel->GetNumberOfLines();
1257 const ModelInterface* const Controller::GetTextModel() const
1259 return mImpl->mModel.Get();
1262 float Controller::GetScrollAmountByUserInput()
1264 float scrollAmount = 0.0f;
1266 if(NULL != mImpl->mEventData && mImpl->mEventData->mCheckScrollAmount)
1268 scrollAmount = mImpl->mModel->mScrollPosition.y - mImpl->mModel->mScrollPositionLast.y;
1269 mImpl->mEventData->mCheckScrollAmount = false;
1271 return scrollAmount;
1274 bool Controller::GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight)
1276 const Vector2& layout = mImpl->mModel->mVisualModel->GetLayoutSize();
1279 controlHeight = mImpl->mModel->mVisualModel->mControlSize.height;
1280 layoutHeight = layout.height;
1281 scrollPosition = mImpl->mModel->mScrollPosition.y;
1282 isScrolled = !Equals(mImpl->mModel->mScrollPosition.y, mImpl->mModel->mScrollPositionLast.y, Math::MACHINE_EPSILON_1);
1286 void Controller::SetHiddenInputOption(const Property::Map& options)
1288 EnsureCreated<HiddenText, Controller*>(mImpl->mHiddenInput, this);
1289 mImpl->mHiddenInput->SetProperties(options);
1292 void Controller::GetHiddenInputOption(Property::Map& options)
1294 if(mImpl->mHiddenInput)
1296 mImpl->mHiddenInput->GetProperties(options);
1300 void Controller::SetInputFilterOption(const Property::Map& options)
1302 EnsureCreated(mImpl->mInputFilter);
1303 mImpl->mInputFilter->SetProperties(options);
1306 void Controller::GetInputFilterOption(Property::Map& options)
1308 if(mImpl->mInputFilter)
1310 mImpl->mInputFilter->GetProperties(options);
1314 void Controller::SetPlaceholderProperty(const Property::Map& map)
1316 PlaceholderHandler::SetPlaceholderProperty(*this, map);
1319 void Controller::GetPlaceholderProperty(Property::Map& map)
1321 PlaceholderHandler::GetPlaceholderProperty(*this, map);
1324 Toolkit::DevelText::TextDirection::Type Controller::GetTextDirection()
1326 // Make sure the model is up-to-date before layouting
1327 EventHandler::ProcessModifyEvents(*this);
1329 return mImpl->GetTextDirection();
1332 Toolkit::DevelText::VerticalLineAlignment::Type Controller::GetVerticalLineAlignment() const
1334 return mImpl->mModel->GetVerticalLineAlignment();
1337 void Controller::SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment)
1339 mImpl->mModel->mVerticalLineAlignment = alignment;
1342 Toolkit::DevelText::EllipsisPosition::Type Controller::GetEllipsisPosition() const
1344 return mImpl->mModel->GetEllipsisPosition();
1347 void Controller::SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition)
1349 mImpl->mModel->mEllipsisPosition = ellipsisPosition;
1350 mImpl->mModel->mVisualModel->SetEllipsisPosition(ellipsisPosition);
1353 void Controller::SetCharacterSpacing(float characterSpacing)
1355 mImpl->mModel->mVisualModel->SetCharacterSpacing(characterSpacing);
1357 mImpl->RelayoutAllCharacters();
1358 mImpl->RequestRelayout();
1361 const float Controller::GetCharacterSpacing() const
1363 return mImpl->mModel->mVisualModel->GetCharacterSpacing();
1366 Controller::UpdateTextType Controller::Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection)
1368 return Relayouter::Relayout(*this, size, layoutDirection);
1371 void Controller::RequestRelayout()
1373 mImpl->RequestRelayout();
1376 Vector<Vector2> Controller::GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex)
1378 Vector<Vector2> sizesList;
1379 Vector<Vector2> positionsList;
1381 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1385 Vector<Vector2> Controller::GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex)
1387 Vector<Vector2> sizesList;
1388 Vector<Vector2> positionsList;
1390 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1391 return positionsList;
1394 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1396 return mImpl->IsInputStyleChangedSignalsQueueEmpty();
1399 void Controller::ProcessInputStyleChangedSignals()
1401 mImpl->ProcessInputStyleChangedSignals();
1404 void Controller::KeyboardFocusGainEvent()
1406 EventHandler::KeyboardFocusGainEvent(*this);
1409 void Controller::KeyboardFocusLostEvent()
1411 EventHandler::KeyboardFocusLostEvent(*this);
1414 bool Controller::KeyEvent(const Dali::KeyEvent& keyEvent)
1416 return EventHandler::KeyEvent(*this, keyEvent);
1419 void Controller::AnchorEvent(float x, float y)
1421 EventHandler::AnchorEvent(*this, x, y);
1424 void Controller::TapEvent(unsigned int tapCount, float x, float y)
1426 EventHandler::TapEvent(*this, tapCount, x, y);
1429 void Controller::PanEvent(GestureState state, const Vector2& displacement)
1431 EventHandler::PanEvent(*this, state, displacement);
1434 void Controller::LongPressEvent(GestureState state, float x, float y)
1436 EventHandler::LongPressEvent(*this, state, x, y);
1439 void Controller::SelectEvent(float x, float y, SelectionType selectType)
1441 EventHandler::SelectEvent(*this, x, y, selectType);
1444 void Controller::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1446 if(mImpl->mEventData)
1448 mImpl->mEventData->mCheckScrollAmount = true;
1449 mImpl->mEventData->mIsLeftHandleSelected = true;
1450 mImpl->mEventData->mIsRightHandleSelected = true;
1451 mImpl->SetTextSelectionRange(start, end);
1452 mImpl->RequestRelayout();
1453 EventHandler::KeyboardFocusGainEvent(*this);
1457 Uint32Pair Controller::GetTextSelectionRange() const
1459 return mImpl->GetTextSelectionRange();
1462 CharacterIndex Controller::GetPrimaryCursorPosition() const
1464 return mImpl->GetPrimaryCursorPosition();
1467 bool Controller::SetPrimaryCursorPosition(CharacterIndex index, bool focused)
1469 if(mImpl->mEventData)
1471 mImpl->mEventData->mCheckScrollAmount = true;
1472 mImpl->mEventData->mIsLeftHandleSelected = true;
1473 mImpl->mEventData->mIsRightHandleSelected = true;
1474 mImpl->mEventData->mCheckScrollAmount = true;
1475 if(mImpl->SetPrimaryCursorPosition(index, focused) && focused)
1477 EventHandler::KeyboardFocusGainEvent(*this);
1484 void Controller::SelectWholeText()
1486 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::ALL);
1489 void Controller::SelectNone()
1491 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::NONE);
1494 void Controller::SelectText(const uint32_t start, const uint32_t end)
1496 EventHandler::SelectEvent(*this, start, end, SelectionType::RANGE);
1499 string Controller::GetSelectedText() const
1501 return mImpl->GetSelectedText();
1504 string Controller::CopyText()
1506 return mImpl->CopyText();
1509 string Controller::CutText()
1511 return mImpl->CutText();
1514 void Controller::PasteText()
1516 mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
1519 InputMethodContext::CallbackData Controller::OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1521 return EventHandler::OnInputMethodContextEvent(*this, inputMethodContext, inputMethodContextEvent);
1524 void Controller::PasteClipboardItemEvent()
1526 EventHandler::PasteClipboardItemEvent(*this);
1529 void Controller::GetTargetSize(Vector2& targetSize)
1531 targetSize = mImpl->mModel->mVisualModel->mControlSize;
1534 void Controller::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1536 if(mImpl->mEditableControlInterface)
1538 mImpl->mEditableControlInterface->AddDecoration(actor, type, needsClipping);
1542 bool Controller::IsEditable() const
1544 return mImpl->IsEditable();
1547 void Controller::SetEditable(bool editable)
1549 mImpl->SetEditable(editable);
1552 void Controller::ScrollBy(Vector2 scroll)
1554 mImpl->ScrollBy(scroll);
1557 float Controller::GetHorizontalScrollPosition()
1559 return mImpl->GetHorizontalScrollPosition();
1562 float Controller::GetVerticalScrollPosition()
1564 return mImpl->GetVerticalScrollPosition();
1567 void Controller::DecorationEvent(HandleType handleType, HandleState state, float x, float y)
1569 EventHandler::DecorationEvent(*this, handleType, state, x, y);
1572 void Controller::TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button)
1574 EventHandler::TextPopupButtonTouched(*this, button);
1577 void Controller::DisplayTimeExpired()
1579 mImpl->mEventData->mUpdateCursorPosition = true;
1580 // Apply modifications to the model
1581 mImpl->mOperationsPending = ALL_OPERATIONS;
1583 mImpl->RequestRelayout();
1586 void Controller::ResetCursorPosition(CharacterIndex cursorIndex)
1588 // Reset the cursor position
1589 if(NULL != mImpl->mEventData)
1591 mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
1593 // Update the cursor if it's in editing mode.
1594 if(EventData::IsEditingState(mImpl->mEventData->mState))
1596 mImpl->mEventData->mUpdateCursorPosition = true;
1601 CharacterIndex Controller::GetCursorPosition()
1603 return mImpl->mEventData ? mImpl->mEventData->mPrimaryCursorPosition : 0;
1606 void Controller::SetControlInterface(ControlInterface* controlInterface)
1608 mImpl->mControlInterface = controlInterface;
1611 void Controller::SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface)
1613 mImpl->mAnchorControlInterface = anchorControlInterface;
1616 bool Controller::ShouldClearFocusOnEscape() const
1618 return mImpl->mShouldClearFocusOnEscape;
1621 Actor Controller::CreateBackgroundActor()
1623 return CreateControllerBackgroundActor(mImpl->mView, mImpl->mModel->mVisualModel, mImpl->mModel->mLogicalModel, mImpl->mShaderBackground);
1626 void Controller::GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors)
1628 mImpl->GetAnchorActors(anchorActors);
1631 int Controller::GetAnchorIndex(size_t characterOffset)
1633 return mImpl->GetAnchorIndex(characterOffset);
1636 Controller::Controller(ControlInterface* controlInterface,
1637 EditableControlInterface* editableControlInterface,
1638 SelectableControlInterface* selectableControlInterface,
1639 AnchorControlInterface* anchorControlInterface)
1640 : mImpl(new Controller::Impl(controlInterface, editableControlInterface, selectableControlInterface, anchorControlInterface))
1644 Controller::~Controller()
1649 } // namespace Dali::Toolkit::Text