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/controller/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/controller/text-controller-background-actor.h>
32 #include <dali-toolkit/internal/text/controller/text-controller-event-handler.h>
33 #include <dali-toolkit/internal/text/controller/text-controller-impl.h>
34 #include <dali-toolkit/internal/text/controller/text-controller-input-font-handler.h>
35 #include <dali-toolkit/internal/text/controller/text-controller-input-properties.h>
36 #include <dali-toolkit/internal/text/controller/text-controller-placeholder-handler.h>
37 #include <dali-toolkit/internal/text/controller/text-controller-relayouter.h>
38 #include <dali-toolkit/internal/text/controller/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>
43 #if defined(DEBUG_ENABLED)
44 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
47 const std::string EMPTY_STRING("");
49 template<typename Type>
50 void EnsureCreated(Type*& object)
58 template<typename Type>
59 void EnsureCreated(std::unique_ptr<Type>& object)
63 object = std::unique_ptr<Type>(new Type());
67 template<typename Type, typename Arg1>
68 void EnsureCreated(Type*& object, Arg1 arg1)
72 object = new Type(arg1);
76 template<typename Type, typename Arg1, typename Arg2>
77 void EnsureCreated(Type*& object, Arg1 arg1, Arg2 arg2)
81 object = new Type(arg1, arg2);
87 unsigned int horizontalDpi = 0u;
88 unsigned int verticalDpi = 0u;
89 Dali::TextAbstraction::FontClient fontClient = Dali::TextAbstraction::FontClient::Get();
90 fontClient.GetDpi(horizontalDpi, verticalDpi);
91 return static_cast<float>(horizontalDpi);
94 float ConvertPixelToPoint(float pixel)
96 return pixel * 72.0f / GetDpi();
99 float ConvertPointToPixel(float point)
101 // Pixel size = Point size * DPI / 72.f
102 return point * GetDpi() / 72.0f;
105 void UpdateCursorPosition(Dali::Toolkit::Text::EventData* eventData)
107 if(eventData && Dali::Toolkit::Text::EventData::IsEditingState(eventData->mState))
109 // Update the cursor position if it's in editing mode
110 eventData->mDecoratorUpdated = true;
111 eventData->mUpdateCursorPosition = true; // Cursor position should be updated when the font size is updated.
117 namespace Dali::Toolkit::Text
119 void Controller::EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext)
123 delete mImpl->mEventData;
124 mImpl->mEventData = NULL;
126 // Nothing else to do.
130 EnsureCreated(mImpl->mEventData, decorator, inputMethodContext);
133 void Controller::SetGlyphType(TextAbstraction::GlyphType glyphType)
135 // Metrics for bitmap & vector based glyphs are different
136 mImpl->mMetrics->SetGlyphType(glyphType);
138 // Clear the font-specific data
139 mImpl->ClearFontData();
141 mImpl->RequestRelayout();
144 void Controller::SetMarkupProcessorEnabled(bool enable)
146 if(enable != mImpl->mMarkupProcessorEnabled)
148 //If Text was already set, call the SetText again for enabling or disabling markup
149 mImpl->mMarkupProcessorEnabled = enable;
155 mImpl->mModel->mVisualModel->SetMarkupProcessorEnabled(enable);
158 bool Controller::IsMarkupProcessorEnabled() const
160 return mImpl->mMarkupProcessorEnabled;
163 bool Controller::HasAnchors() const
165 return (mImpl->mMarkupProcessorEnabled && mImpl->mModel->mLogicalModel->mAnchors.Count() && mImpl->IsShowingRealText());
168 void Controller::SetAutoScrollEnabled(bool enable)
170 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);
171 mImpl->SetAutoScrollEnabled(enable);
174 void Controller::SetAutoScrollMaxTextureExceeded(bool exceed)
176 mImpl->mIsAutoScrollMaxTextureExceeded = exceed;
179 bool Controller::IsAutoScrollEnabled() const
181 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", mImpl->mIsAutoScrollEnabled ? "true" : "false");
182 return mImpl->mIsAutoScrollEnabled;
185 CharacterDirection Controller::GetAutoScrollDirection() const
187 return mImpl->mIsTextDirectionRTL;
190 float Controller::GetAutoScrollLineAlignment() const
193 if(mImpl->mModel->mVisualModel && (0u != mImpl->mModel->mVisualModel->mLines.Count()))
195 offset = (*mImpl->mModel->mVisualModel->mLines.Begin()).alignmentOffset;
200 void Controller::SetHorizontalScrollEnabled(bool enable)
202 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
204 mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled(enable);
208 bool Controller::IsHorizontalScrollEnabled() const
210 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
213 void Controller::SetVerticalScrollEnabled(bool enable)
215 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
217 mImpl->mEventData->mDecorator->SetVerticalScrollEnabled(enable);
221 bool Controller::IsVerticalScrollEnabled() const
223 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
226 void Controller::SetSmoothHandlePanEnabled(bool enable)
228 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
230 mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled(enable);
234 bool Controller::IsSmoothHandlePanEnabled() const
236 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
239 void Controller::SetMaximumNumberOfCharacters(Length maxCharacters)
241 mImpl->mMaximumNumberOfCharacters = maxCharacters;
244 int Controller::GetMaximumNumberOfCharacters()
246 return mImpl->mMaximumNumberOfCharacters;
249 void Controller::SetEnableCursorBlink(bool enable)
251 mImpl->SetEnableCursorBlink(enable);
254 bool Controller::GetEnableCursorBlink() const
256 return mImpl->mEventData && mImpl->mEventData->mCursorBlinkEnabled;
259 void Controller::SetMultiLineEnabled(bool enable)
261 mImpl->SetMultiLineEnabled(enable);
264 bool Controller::IsMultiLineEnabled() const
266 return Layout::Engine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
269 void Controller::SetHorizontalAlignment(Text::HorizontalAlignment::Type alignment)
271 mImpl->SetHorizontalAlignment(alignment);
274 Text::HorizontalAlignment::Type Controller::GetHorizontalAlignment() const
276 return mImpl->mModel->mHorizontalAlignment;
279 void Controller::SetVerticalAlignment(VerticalAlignment::Type alignment)
281 mImpl->SetVerticalAlignment(alignment);
284 VerticalAlignment::Type Controller::GetVerticalAlignment() const
286 return mImpl->mModel->mVerticalAlignment;
289 bool Controller::IsIgnoreSpacesAfterText() const
291 return mImpl->mModel->mIgnoreSpacesAfterText;
294 void Controller::SetIgnoreSpacesAfterText(bool ignore)
296 mImpl->mModel->mIgnoreSpacesAfterText = ignore;
299 void Controller::ChangedLayoutDirection()
301 mImpl->mIsLayoutDirectionChanged = true;
304 void Controller::SetMatchLayoutDirection(DevelText::MatchLayoutDirection type)
306 mImpl->mModel->mMatchLayoutDirection = type;
309 DevelText::MatchLayoutDirection Controller::GetMatchLayoutDirection() const
311 return mImpl->mModel->mMatchLayoutDirection;
314 void Controller::SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection)
316 mImpl->mLayoutDirection = layoutDirection;
319 Dali::LayoutDirection::Type Controller::GetLayoutDirection(Dali::Actor& actor) const
321 return mImpl->GetLayoutDirection(actor);
324 bool Controller::IsShowingRealText() const
326 return mImpl->IsShowingRealText();
329 void Controller::SetLineWrapMode(Text::LineWrap::Mode lineWrapMode)
331 mImpl->SetLineWrapMode(lineWrapMode);
334 Text::LineWrap::Mode Controller::GetLineWrapMode() const
336 return mImpl->mModel->mLineWrapMode;
339 void Controller::SetTextElideEnabled(bool enabled)
341 mImpl->mModel->mElideEnabled = enabled;
342 mImpl->mModel->mVisualModel->SetTextElideEnabled(enabled);
345 bool Controller::IsTextElideEnabled() const
347 return mImpl->mModel->mElideEnabled;
350 void Controller::SetTextFitEnabled(bool enabled)
352 mImpl->mTextFitEnabled = enabled;
355 bool Controller::IsTextFitEnabled() const
357 return mImpl->mTextFitEnabled;
360 void Controller::SetTextFitChanged(bool changed)
362 mImpl->mTextFitChanged = changed;
365 bool Controller::IsTextFitChanged() const
367 return mImpl->mTextFitChanged;
370 void Controller::SetTextFitMinSize(float minSize, FontSizeType type)
372 mImpl->mTextFitMinSize = (type == POINT_SIZE) ? minSize : ConvertPixelToPoint(minSize);
375 float Controller::GetTextFitMinSize() const
377 return mImpl->mTextFitMinSize;
380 void Controller::SetTextFitMaxSize(float maxSize, FontSizeType type)
382 mImpl->mTextFitMaxSize = (type == POINT_SIZE) ? maxSize : ConvertPixelToPoint(maxSize);
385 float Controller::GetTextFitMaxSize() const
387 return mImpl->mTextFitMaxSize;
390 void Controller::SetTextFitStepSize(float step, FontSizeType type)
392 mImpl->mTextFitStepSize = (type == POINT_SIZE) ? step : ConvertPixelToPoint(step);
395 float Controller::GetTextFitStepSize() const
397 return mImpl->mTextFitStepSize;
400 void Controller::SetTextFitContentSize(Vector2 size)
402 mImpl->mTextFitContentSize = size;
405 Vector2 Controller::GetTextFitContentSize() const
407 return mImpl->mTextFitContentSize;
410 float Controller::GetTextFitPointSize() const
412 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFitPointSize : 0.0f;
415 void Controller::SetPlaceholderTextElideEnabled(bool enabled)
417 PlaceholderHandler::SetPlaceholderTextElideEnabled(*this, enabled);
420 bool Controller::IsPlaceholderTextElideEnabled() const
422 return PlaceholderHandler::IsPlaceholderTextElideEnabled(*this);
425 void Controller::SetSelectionEnabled(bool enabled)
427 mImpl->mEventData->mSelectionEnabled = enabled;
430 bool Controller::IsSelectionEnabled() const
432 return mImpl->mEventData->mSelectionEnabled;
435 void Controller::SetShiftSelectionEnabled(bool enabled)
437 mImpl->mEventData->mShiftSelectionFlag = enabled;
440 bool Controller::IsShiftSelectionEnabled() const
442 return mImpl->mEventData->mShiftSelectionFlag;
445 void Controller::SetGrabHandleEnabled(bool enabled)
447 mImpl->mEventData->mGrabHandleEnabled = enabled;
450 bool Controller::IsGrabHandleEnabled() const
452 return mImpl->mEventData->mGrabHandleEnabled;
455 void Controller::SetGrabHandlePopupEnabled(bool enabled)
457 mImpl->mEventData->mGrabHandlePopupEnabled = enabled;
460 bool Controller::IsGrabHandlePopupEnabled() const
462 return mImpl->mEventData->mGrabHandlePopupEnabled;
465 void Controller::SetText(const std::string& text)
467 TextUpdater::SetText(*this, text);
470 void Controller::GetText(std::string& text) const
472 mImpl->GetText(text);
475 void Controller::SetPlaceholderText(PlaceholderType type, const std::string& text)
477 PlaceholderHandler::SetPlaceholderText(*this, type, text);
480 void Controller::GetPlaceholderText(PlaceholderType type, std::string& text) const
482 PlaceholderHandler::GetPlaceholderText(*this, type, text);
485 void Controller::UpdateAfterFontChange(const std::string& newDefaultFont)
487 mImpl->UpdateAfterFontChange(newDefaultFont);
490 void Controller::RetrieveSelection(std::string& selectedText) const
492 mImpl->RetrieveSelection(selectedText, false);
495 void Controller::SetSelection(int start, int end)
497 mImpl->SetSelection(start, end);
500 std::pair<int, int> Controller::GetSelectionIndexes() const
502 return mImpl->GetSelectionIndexes();
505 void Controller::CopyStringToClipboard(const std::string& source)
507 mImpl->CopyStringToClipboard(source);
510 void Controller::SendSelectionToClipboard(bool deleteAfterSending)
512 mImpl->SendSelectionToClipboard(deleteAfterSending);
515 void Controller::SetDefaultFontFamily(const std::string& defaultFontFamily)
517 EnsureCreated(mImpl->mFontDefaults);
519 mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
520 DALI_LOG_INFO(gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
521 mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
523 // Update the cursor position if it's in editing mode
524 UpdateCursorPosition(mImpl->mEventData);
526 // Clear the font-specific data
527 mImpl->ClearFontData();
529 mImpl->RequestRelayout();
532 const std::string& Controller::GetDefaultFontFamily() const
534 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.family : EMPTY_STRING;
537 void Controller::SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily)
539 PlaceholderHandler::SetPlaceholderFontFamily(*this, placeholderTextFontFamily);
542 const std::string& Controller::GetPlaceholderFontFamily() const
544 return PlaceholderHandler::GetPlaceholderFontFamily(*this);
547 void Controller::SetDefaultFontWeight(FontWeight weight)
549 EnsureCreated(mImpl->mFontDefaults);
551 mImpl->mFontDefaults->mFontDescription.weight = weight;
552 mImpl->mFontDefaults->weightDefined = true;
554 // Update the cursor position if it's in editing mode
555 UpdateCursorPosition(mImpl->mEventData);
557 // Clear the font-specific data
558 mImpl->ClearFontData();
560 mImpl->RequestRelayout();
563 bool Controller::IsDefaultFontWeightDefined() const
565 return mImpl->mFontDefaults && mImpl->mFontDefaults->weightDefined;
568 FontWeight Controller::GetDefaultFontWeight() const
570 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.weight : TextAbstraction::FontWeight::NORMAL;
573 void Controller::SetPlaceholderTextFontWeight(FontWeight weight)
575 PlaceholderHandler::SetPlaceholderTextFontWeight(*this, weight);
578 bool Controller::IsPlaceholderTextFontWeightDefined() const
580 return PlaceholderHandler::IsPlaceholderTextFontWeightDefined(*this);
583 FontWeight Controller::GetPlaceholderTextFontWeight() const
585 return PlaceholderHandler::GetPlaceholderTextFontWeight(*this);
588 void Controller::SetDefaultFontWidth(FontWidth width)
590 EnsureCreated(mImpl->mFontDefaults);
592 mImpl->mFontDefaults->mFontDescription.width = width;
593 mImpl->mFontDefaults->widthDefined = true;
595 // Update the cursor position if it's in editing mode
596 UpdateCursorPosition(mImpl->mEventData);
598 // Clear the font-specific data
599 mImpl->ClearFontData();
601 mImpl->RequestRelayout();
604 bool Controller::IsDefaultFontWidthDefined() const
606 return mImpl->mFontDefaults && mImpl->mFontDefaults->widthDefined;
609 FontWidth Controller::GetDefaultFontWidth() const
611 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.width : TextAbstraction::FontWidth::NORMAL;
614 void Controller::SetPlaceholderTextFontWidth(FontWidth width)
616 PlaceholderHandler::SetPlaceholderTextFontWidth(*this, width);
619 bool Controller::IsPlaceholderTextFontWidthDefined() const
621 return PlaceholderHandler::IsPlaceholderTextFontWidthDefined(*this);
624 FontWidth Controller::GetPlaceholderTextFontWidth() const
626 return PlaceholderHandler::GetPlaceholderTextFontWidth(*this);
629 void Controller::SetDefaultFontSlant(FontSlant slant)
631 EnsureCreated(mImpl->mFontDefaults);
633 mImpl->mFontDefaults->mFontDescription.slant = slant;
634 mImpl->mFontDefaults->slantDefined = true;
636 // Update the cursor position if it's in editing mode
637 UpdateCursorPosition(mImpl->mEventData);
639 // Clear the font-specific data
640 mImpl->ClearFontData();
642 mImpl->RequestRelayout();
645 bool Controller::IsDefaultFontSlantDefined() const
647 return mImpl->mFontDefaults && mImpl->mFontDefaults->slantDefined;
650 FontSlant Controller::GetDefaultFontSlant() const
652 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.slant : TextAbstraction::FontSlant::NORMAL;
655 void Controller::SetPlaceholderTextFontSlant(FontSlant slant)
657 PlaceholderHandler::SetPlaceholderTextFontSlant(*this, slant);
660 bool Controller::IsPlaceholderTextFontSlantDefined() const
662 return PlaceholderHandler::IsPlaceholderTextFontSlantDefined(*this);
665 FontSlant Controller::GetPlaceholderTextFontSlant() const
667 return PlaceholderHandler::GetPlaceholderTextFontSlant(*this);
670 void Controller::SetFontSizeScale(float scale)
672 mImpl->mFontSizeScale = scale;
674 // No relayout is required
675 if(!mImpl->mFontSizeScaleEnabled) return;
677 // Update the cursor position if it's in editing mode
678 UpdateCursorPosition(mImpl->mEventData);
680 // Clear the font-specific data
681 mImpl->ClearFontData();
683 mImpl->RequestRelayout();
686 float Controller::GetFontSizeScale() const
688 return mImpl->mFontDefaults ? mImpl->mFontSizeScale : 1.0f;
691 void Controller::SetFontSizeScaleEnabled(bool enabled)
693 mImpl->mFontSizeScaleEnabled = enabled;
695 // Update the cursor position if it's in editing mode
696 UpdateCursorPosition(mImpl->mEventData);
698 // Clear the font-specific data
699 mImpl->ClearFontData();
701 mImpl->RequestRelayout();
704 bool Controller::IsFontSizeScaleEnabled() const
706 return mImpl->mFontSizeScaleEnabled;
709 void Controller::SetDefaultFontSize(float fontSize, FontSizeType type)
711 EnsureCreated(mImpl->mFontDefaults);
713 mImpl->mFontDefaults->mDefaultPointSize = (type == POINT_SIZE) ? fontSize : ConvertPixelToPoint(fontSize);
714 mImpl->mFontDefaults->sizeDefined = true;
716 // Update the cursor position if it's in editing mode
717 UpdateCursorPosition(mImpl->mEventData);
719 // Clear the font-specific data
720 mImpl->ClearFontData();
722 mImpl->RequestRelayout();
725 float Controller::GetDefaultFontSize(FontSizeType type) const
727 if(mImpl->mFontDefaults)
729 return (type == POINT_SIZE) ? mImpl->mFontDefaults->mDefaultPointSize : ConvertPointToPixel(mImpl->mFontDefaults->mDefaultPointSize);
734 void Controller::SetPlaceholderTextFontSize(float fontSize, FontSizeType type)
736 PlaceholderHandler::SetPlaceholderTextFontSize(*this, fontSize, type);
739 float Controller::GetPlaceholderTextFontSize(FontSizeType type) const
741 return PlaceholderHandler::GetPlaceholderTextFontSize(*this, type);
744 void Controller::SetDefaultColor(const Vector4& color)
746 mImpl->SetDefaultColor(color);
749 const Vector4& Controller::GetDefaultColor() const
751 return mImpl->mTextColor;
754 void Controller::SetDisabledColorOpacity(float opacity)
756 mImpl->mDisabledColorOpacity = opacity;
759 float Controller::GetDisabledColorOpacity() const
761 return mImpl->mDisabledColorOpacity;
764 void Controller::SetUserInteractionEnabled(bool enabled)
766 mImpl->SetUserInteractionEnabled(enabled);
769 bool Controller::IsUserInteractionEnabled() const
771 return mImpl->mIsUserInteractionEnabled;
774 void Controller::SetPlaceholderTextColor(const Vector4& textColor)
776 PlaceholderHandler::SetPlaceholderTextColor(*this, textColor);
779 const Vector4& Controller::GetPlaceholderTextColor() const
781 return PlaceholderHandler::GetPlaceholderTextColor(*this);
784 void Controller::SetShadowOffset(const Vector2& shadowOffset)
786 mImpl->mModel->mVisualModel->SetShadowOffset(shadowOffset);
787 mImpl->RequestRelayout();
790 const Vector2& Controller::GetShadowOffset() const
792 return mImpl->mModel->mVisualModel->GetShadowOffset();
795 void Controller::SetShadowColor(const Vector4& shadowColor)
797 mImpl->mModel->mVisualModel->SetShadowColor(shadowColor);
798 mImpl->RequestRelayout();
801 const Vector4& Controller::GetShadowColor() const
803 return mImpl->mModel->mVisualModel->GetShadowColor();
806 void Controller::SetShadowBlurRadius(const float& shadowBlurRadius)
808 if(fabsf(GetShadowBlurRadius() - shadowBlurRadius) > Math::MACHINE_EPSILON_1)
810 mImpl->mModel->mVisualModel->SetShadowBlurRadius(shadowBlurRadius);
811 mImpl->RequestRelayout();
815 const float& Controller::GetShadowBlurRadius() const
817 return mImpl->mModel->mVisualModel->GetShadowBlurRadius();
820 void Controller::SetUnderlineColor(const Vector4& color)
822 mImpl->mModel->mVisualModel->SetUnderlineColor(color);
823 mImpl->RequestRelayout();
826 const Vector4& Controller::GetUnderlineColor() const
828 return mImpl->mModel->mVisualModel->GetUnderlineColor();
831 void Controller::SetUnderlineEnabled(bool enabled)
833 mImpl->mModel->mVisualModel->SetUnderlineEnabled(enabled);
834 mImpl->RequestRelayout();
837 bool Controller::IsUnderlineEnabled() const
839 return mImpl->mModel->mVisualModel->IsUnderlineEnabled();
842 void Controller::SetUnderlineHeight(float height)
844 mImpl->mModel->mVisualModel->SetUnderlineHeight(height);
845 mImpl->RequestRelayout();
848 float Controller::GetUnderlineHeight() const
850 return mImpl->mModel->mVisualModel->GetUnderlineHeight();
853 void Controller::SetUnderlineType(Text::Underline::Type type)
855 mImpl->mModel->mVisualModel->SetUnderlineType(type);
857 mImpl->RequestRelayout();
860 Text::Underline::Type Controller::GetUnderlineType() const
862 return mImpl->mModel->mVisualModel->GetUnderlineType();
865 void Controller::SetDashedUnderlineWidth(float width)
867 mImpl->mModel->mVisualModel->SetDashedUnderlineWidth(width);
869 mImpl->RequestRelayout();
872 float Controller::GetDashedUnderlineWidth() const
874 return mImpl->mModel->mVisualModel->GetDashedUnderlineWidth();
877 void Controller::SetDashedUnderlineGap(float gap)
879 mImpl->mModel->mVisualModel->SetDashedUnderlineGap(gap);
881 mImpl->RequestRelayout();
884 float Controller::GetDashedUnderlineGap() const
886 return mImpl->mModel->mVisualModel->GetDashedUnderlineGap();
889 void Controller::SetOutlineColor(const Vector4& color)
891 mImpl->mModel->mVisualModel->SetOutlineColor(color);
892 mImpl->RequestRelayout();
895 const Vector4& Controller::GetOutlineColor() const
897 return mImpl->mModel->mVisualModel->GetOutlineColor();
900 void Controller::SetOutlineWidth(uint16_t width)
902 mImpl->mModel->mVisualModel->SetOutlineWidth(width);
903 mImpl->RequestRelayout();
906 uint16_t Controller::GetOutlineWidth() const
908 return mImpl->mModel->mVisualModel->GetOutlineWidth();
911 void Controller::SetBackgroundColor(const Vector4& color)
913 mImpl->mModel->mVisualModel->SetBackgroundColor(color);
914 mImpl->RequestRelayout();
917 const Vector4& Controller::GetBackgroundColor() const
919 return mImpl->mModel->mVisualModel->GetBackgroundColor();
922 void Controller::SetBackgroundEnabled(bool enabled)
924 mImpl->mModel->mVisualModel->SetBackgroundEnabled(enabled);
925 mImpl->RequestRelayout();
928 bool Controller::IsBackgroundEnabled() const
930 return mImpl->mModel->mVisualModel->IsBackgroundEnabled();
933 void Controller::SetDefaultEmbossProperties(const std::string& embossProperties)
935 EnsureCreated(mImpl->mEmbossDefaults);
936 mImpl->mEmbossDefaults->properties = embossProperties;
939 const std::string& Controller::GetDefaultEmbossProperties() const
941 return mImpl->mEmbossDefaults ? mImpl->mEmbossDefaults->properties : EMPTY_STRING;
944 void Controller::SetDefaultOutlineProperties(const std::string& outlineProperties)
946 EnsureCreated(mImpl->mOutlineDefaults);
947 mImpl->mOutlineDefaults->properties = outlineProperties;
950 const std::string& Controller::GetDefaultOutlineProperties() const
952 return mImpl->mOutlineDefaults ? mImpl->mOutlineDefaults->properties : EMPTY_STRING;
955 bool Controller::SetDefaultLineSpacing(float lineSpacing)
957 return mImpl->SetDefaultLineSpacing(lineSpacing);
960 float Controller::GetDefaultLineSpacing() const
962 return mImpl->mLayoutEngine.GetDefaultLineSpacing();
965 bool Controller::SetDefaultLineSize(float lineSize)
967 return mImpl->SetDefaultLineSize(lineSize);
970 float Controller::GetDefaultLineSize() const
972 return mImpl->mLayoutEngine.GetDefaultLineSize();
975 bool Controller::SetRelativeLineSize(float relativeLineSize)
977 return mImpl->SetRelativeLineSize(relativeLineSize);
980 float Controller::GetRelativeLineSize() const
982 return mImpl->GetRelativeLineSize();
985 void Controller::SetInputColor(const Vector4& color)
987 InputProperties::SetInputColor(*this, color);
990 const Vector4& Controller::GetInputColor() const
992 return InputProperties::GetInputColor(*this);
995 void Controller::SetInputFontFamily(const std::string& fontFamily)
997 InputFontHandler::SetInputFontFamily(*this, fontFamily);
1000 const std::string& Controller::GetInputFontFamily() const
1002 return InputFontHandler::GetInputFontFamily(*this);
1005 void Controller::SetInputFontWeight(FontWeight weight)
1007 InputFontHandler::SetInputFontWeight(*this, weight);
1010 bool Controller::IsInputFontWeightDefined() const
1012 return InputFontHandler::IsInputFontWeightDefined(*this);
1015 FontWeight Controller::GetInputFontWeight() const
1017 return InputFontHandler::GetInputFontWeight(*this);
1020 void Controller::SetInputFontWidth(FontWidth width)
1022 InputFontHandler::SetInputFontWidth(*this, width);
1025 bool Controller::IsInputFontWidthDefined() const
1027 return InputFontHandler::IsInputFontWidthDefined(*this);
1030 FontWidth Controller::GetInputFontWidth() const
1032 return InputFontHandler::GetInputFontWidth(*this);
1035 void Controller::SetInputFontSlant(FontSlant slant)
1037 InputFontHandler::SetInputFontSlant(*this, slant);
1040 bool Controller::IsInputFontSlantDefined() const
1042 return InputFontHandler::IsInputFontSlantDefined(*this);
1045 FontSlant Controller::GetInputFontSlant() const
1047 return InputFontHandler::GetInputFontSlant(*this);
1050 void Controller::SetInputFontPointSize(float size)
1052 InputFontHandler::SetInputFontPointSize(*this, size);
1055 float Controller::GetInputFontPointSize() const
1057 return InputFontHandler::GetInputFontPointSize(*this);
1060 void Controller::SetInputLineSpacing(float lineSpacing)
1062 InputProperties::SetInputLineSpacing(*this, lineSpacing);
1065 float Controller::GetInputLineSpacing() const
1067 return InputProperties::GetInputLineSpacing(*this);
1070 void Controller::SetInputShadowProperties(const std::string& shadowProperties)
1072 InputProperties::SetInputShadowProperties(*this, shadowProperties);
1075 const std::string& Controller::GetInputShadowProperties() const
1077 return InputProperties::GetInputShadowProperties(*this);
1080 void Controller::SetInputUnderlineProperties(const std::string& underlineProperties)
1082 InputProperties::SetInputUnderlineProperties(*this, underlineProperties);
1085 const std::string& Controller::GetInputUnderlineProperties() const
1087 return InputProperties::GetInputUnderlineProperties(*this);
1090 void Controller::SetInputEmbossProperties(const std::string& embossProperties)
1092 InputProperties::SetInputEmbossProperties(*this, embossProperties);
1095 const std::string& Controller::GetInputEmbossProperties() const
1097 return InputProperties::GetInputEmbossProperties(*this);
1100 void Controller::SetInputOutlineProperties(const std::string& outlineProperties)
1102 InputProperties::SetInputOutlineProperties(*this, outlineProperties);
1105 const std::string& Controller::GetInputOutlineProperties() const
1107 return InputProperties::GetInputOutlineProperties(*this);
1110 void Controller::SetInputModePassword(bool passwordInput)
1112 InputProperties::SetInputModePassword(*this, passwordInput);
1115 bool Controller::IsInputModePassword()
1117 return InputProperties::IsInputModePassword(*this);
1120 void Controller::SetNoTextDoubleTapAction(NoTextTap::Action action)
1122 if(mImpl->mEventData)
1124 mImpl->mEventData->mDoubleTapAction = action;
1128 Controller::NoTextTap::Action Controller::GetNoTextDoubleTapAction() const
1130 return mImpl->mEventData ? mImpl->mEventData->mDoubleTapAction : NoTextTap::NO_ACTION;
1133 void Controller::SetNoTextLongPressAction(NoTextTap::Action action)
1135 if(mImpl->mEventData)
1137 mImpl->mEventData->mLongPressAction = action;
1141 Controller::NoTextTap::Action Controller::GetNoTextLongPressAction() const
1143 return mImpl->mEventData ? mImpl->mEventData->mLongPressAction : NoTextTap::NO_ACTION;
1146 bool Controller::IsUnderlineSetByString()
1148 return mImpl->mUnderlineSetByString;
1151 void Controller::UnderlineSetByString(bool setByString)
1153 mImpl->mUnderlineSetByString = setByString;
1156 bool Controller::IsShadowSetByString()
1158 return mImpl->mShadowSetByString;
1161 void Controller::ShadowSetByString(bool setByString)
1163 mImpl->mShadowSetByString = setByString;
1166 bool Controller::IsOutlineSetByString()
1168 return mImpl->mOutlineSetByString;
1171 void Controller::OutlineSetByString(bool setByString)
1173 mImpl->mOutlineSetByString = setByString;
1176 bool Controller::IsFontStyleSetByString()
1178 return mImpl->mFontStyleSetByString;
1181 void Controller::FontStyleSetByString(bool setByString)
1183 mImpl->mFontStyleSetByString = setByString;
1186 void Controller::SetStrikethroughHeight(float height)
1188 mImpl->mModel->mVisualModel->SetStrikethroughHeight(height);
1190 mImpl->RequestRelayout();
1193 float Controller::GetStrikethroughHeight() const
1195 return mImpl->mModel->mVisualModel->GetStrikethroughHeight();
1198 void Controller::SetStrikethroughColor(const Vector4& color)
1200 mImpl->mModel->mVisualModel->SetStrikethroughColor(color);
1202 mImpl->RequestRelayout();
1205 const Vector4& Controller::GetStrikethroughColor() const
1207 return mImpl->mModel->mVisualModel->GetStrikethroughColor();
1210 void Controller::SetStrikethroughEnabled(bool enabled)
1212 mImpl->mModel->mVisualModel->SetStrikethroughEnabled(enabled);
1214 mImpl->RequestRelayout();
1217 bool Controller::IsStrikethroughEnabled() const
1219 return mImpl->mModel->mVisualModel->IsStrikethroughEnabled();
1222 void Controller::SetInputStrikethroughProperties(const std::string& strikethroughProperties)
1224 if(NULL != mImpl->mEventData)
1226 mImpl->mEventData->mInputStyle.strikethroughProperties = strikethroughProperties;
1230 const std::string& Controller::GetInputStrikethroughProperties() const
1232 return (NULL != mImpl->mEventData) ? mImpl->mEventData->mInputStyle.strikethroughProperties : EMPTY_STRING;
1235 bool Controller::IsStrikethroughSetByString()
1237 return mImpl->mStrikethroughSetByString;
1240 void Controller::StrikethroughSetByString(bool setByString)
1242 mImpl->mStrikethroughSetByString = setByString;
1245 Layout::Engine& Controller::GetLayoutEngine()
1247 return mImpl->mLayoutEngine;
1250 View& Controller::GetView()
1252 return mImpl->mView;
1255 Vector3 Controller::GetNaturalSize()
1257 return Relayouter::GetNaturalSize(*this);
1260 bool Controller::CheckForTextFit(float pointSize, Size& layoutSize)
1262 return Relayouter::CheckForTextFit(*this, pointSize, layoutSize);
1265 void Controller::FitPointSizeforLayout(Size layoutSize)
1267 Relayouter::FitPointSizeforLayout(*this, layoutSize);
1270 float Controller::GetHeightForWidth(float width)
1272 return Relayouter::GetHeightForWidth(*this, width);
1275 int Controller::GetLineCount(float width)
1277 GetHeightForWidth(width);
1278 return mImpl->mModel->GetNumberOfLines();
1281 const ModelInterface* const Controller::GetTextModel() const
1283 return mImpl->mModel.Get();
1286 float Controller::GetScrollAmountByUserInput()
1288 float scrollAmount = 0.0f;
1290 if(NULL != mImpl->mEventData && mImpl->mEventData->mCheckScrollAmount)
1292 scrollAmount = mImpl->mModel->mScrollPosition.y - mImpl->mModel->mScrollPositionLast.y;
1293 mImpl->mEventData->mCheckScrollAmount = false;
1295 return scrollAmount;
1298 bool Controller::GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight)
1300 const Vector2& layout = mImpl->mModel->mVisualModel->GetLayoutSize();
1303 controlHeight = mImpl->mModel->mVisualModel->mControlSize.height;
1304 layoutHeight = layout.height;
1305 scrollPosition = mImpl->mModel->mScrollPosition.y;
1306 isScrolled = !Equals(mImpl->mModel->mScrollPosition.y, mImpl->mModel->mScrollPositionLast.y, Math::MACHINE_EPSILON_1);
1310 void Controller::SetHiddenInputOption(const Property::Map& options)
1312 EnsureCreated<HiddenText, Controller*>(mImpl->mHiddenInput, this);
1313 mImpl->mHiddenInput->SetProperties(options);
1316 void Controller::GetHiddenInputOption(Property::Map& options)
1318 if(mImpl->mHiddenInput)
1320 mImpl->mHiddenInput->GetProperties(options);
1324 void Controller::SetInputFilterOption(const Property::Map& options)
1326 EnsureCreated(mImpl->mInputFilter);
1327 mImpl->mInputFilter->SetProperties(options);
1330 void Controller::GetInputFilterOption(Property::Map& options)
1332 if(mImpl->mInputFilter)
1334 mImpl->mInputFilter->GetProperties(options);
1338 void Controller::SetPlaceholderProperty(const Property::Map& map)
1340 PlaceholderHandler::SetPlaceholderProperty(*this, map);
1343 void Controller::GetPlaceholderProperty(Property::Map& map)
1345 PlaceholderHandler::GetPlaceholderProperty(*this, map);
1348 Toolkit::DevelText::TextDirection::Type Controller::GetTextDirection()
1350 // Make sure the model is up-to-date before layouting
1351 EventHandler::ProcessModifyEvents(*this);
1353 return mImpl->GetTextDirection();
1356 Toolkit::DevelText::VerticalLineAlignment::Type Controller::GetVerticalLineAlignment() const
1358 return mImpl->mModel->GetVerticalLineAlignment();
1361 void Controller::SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment)
1363 mImpl->mModel->mVerticalLineAlignment = alignment;
1366 Toolkit::DevelText::EllipsisPosition::Type Controller::GetEllipsisPosition() const
1368 return mImpl->mModel->GetEllipsisPosition();
1371 void Controller::SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition)
1373 mImpl->mModel->mEllipsisPosition = ellipsisPosition;
1374 mImpl->mModel->mVisualModel->SetEllipsisPosition(ellipsisPosition);
1377 void Controller::SetCharacterSpacing(float characterSpacing)
1379 mImpl->mModel->mVisualModel->SetCharacterSpacing(characterSpacing);
1381 mImpl->RelayoutAllCharacters();
1382 mImpl->RequestRelayout();
1385 const float Controller::GetCharacterSpacing() const
1387 return mImpl->mModel->mVisualModel->GetCharacterSpacing();
1390 Controller::UpdateTextType Controller::Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection)
1392 return Relayouter::Relayout(*this, size, layoutDirection);
1395 void Controller::RequestRelayout()
1397 mImpl->RequestRelayout();
1400 Vector<Vector2> Controller::GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex)
1402 Vector<Vector2> sizesList;
1403 Vector<Vector2> positionsList;
1405 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1409 Vector<Vector2> Controller::GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex)
1411 Vector<Vector2> sizesList;
1412 Vector<Vector2> positionsList;
1414 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizesList, positionsList);
1415 return positionsList;
1418 Rect<float> Controller::GetLineBoundingRectangle(const uint32_t lineIndex)
1420 return GetLineBoundingRect(mImpl->mModel, lineIndex);
1423 Rect<> Controller::GetTextBoundingRectangle(CharacterIndex startIndex, CharacterIndex endIndex)
1425 Vector<Vector2> sizeList;
1426 Vector<Vector2> positionList;
1428 GetTextGeometry(mImpl->mModel, startIndex, endIndex, sizeList, positionList);
1430 if(sizeList.Empty() || sizeList.Size() != positionList.Size())
1432 return {0, 0, 0, 0};
1435 auto controlWidth = mImpl->mModel->mVisualModel->mControlSize.width;
1436 auto minX = positionList[0].x;
1437 auto minY = positionList[0].y;
1438 auto maxRight = positionList[0].x + sizeList[0].x;
1439 auto maxBottom = positionList[0].y + sizeList[0].y;
1441 for(unsigned int i = 1; i < sizeList.Size(); i++)
1443 minX = std::min(minX, positionList[i].x);
1444 minY = std::min(minY, positionList[i].y);
1445 maxRight = std::max(maxRight, positionList[i].x + sizeList[i].x);
1446 maxBottom = std::max(maxBottom, positionList[i].y + sizeList[i].y);
1454 if(maxRight > controlWidth)
1456 maxRight = controlWidth;
1459 return {minX, minY, maxRight - minX, maxBottom - minY};
1462 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1464 return mImpl->IsInputStyleChangedSignalsQueueEmpty();
1467 void Controller::ProcessInputStyleChangedSignals()
1469 mImpl->ProcessInputStyleChangedSignals();
1472 void Controller::KeyboardFocusGainEvent()
1474 EventHandler::KeyboardFocusGainEvent(*this);
1477 void Controller::KeyboardFocusLostEvent()
1479 EventHandler::KeyboardFocusLostEvent(*this);
1482 bool Controller::KeyEvent(const Dali::KeyEvent& keyEvent)
1484 return EventHandler::KeyEvent(*this, keyEvent);
1487 void Controller::AnchorEvent(float x, float y)
1489 EventHandler::AnchorEvent(*this, x, y);
1492 void Controller::TapEvent(unsigned int tapCount, float x, float y)
1494 EventHandler::TapEvent(*this, tapCount, x, y);
1497 void Controller::PanEvent(GestureState state, const Vector2& displacement)
1499 EventHandler::PanEvent(*this, state, displacement);
1502 void Controller::LongPressEvent(GestureState state, float x, float y)
1504 EventHandler::LongPressEvent(*this, state, x, y);
1507 void Controller::SelectEvent(float x, float y, SelectionType selectType)
1509 EventHandler::SelectEvent(*this, x, y, selectType);
1512 void Controller::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1514 if(mImpl->mEventData)
1516 mImpl->mEventData->mCheckScrollAmount = true;
1517 mImpl->mEventData->mIsLeftHandleSelected = true;
1518 mImpl->mEventData->mIsRightHandleSelected = true;
1519 mImpl->SetTextSelectionRange(start, end);
1520 mImpl->RequestRelayout();
1521 EventHandler::KeyboardFocusGainEvent(*this);
1525 Uint32Pair Controller::GetTextSelectionRange() const
1527 return mImpl->GetTextSelectionRange();
1530 CharacterIndex Controller::GetPrimaryCursorPosition() const
1532 return mImpl->GetPrimaryCursorPosition();
1535 bool Controller::SetPrimaryCursorPosition(CharacterIndex index, bool focused)
1537 if(mImpl->mEventData)
1539 mImpl->mEventData->mCheckScrollAmount = true;
1540 mImpl->mEventData->mIsLeftHandleSelected = true;
1541 mImpl->mEventData->mIsRightHandleSelected = true;
1542 mImpl->mEventData->mCheckScrollAmount = true;
1543 if(mImpl->SetPrimaryCursorPosition(index, focused) && focused)
1545 EventHandler::KeyboardFocusGainEvent(*this);
1552 void Controller::SelectWholeText()
1554 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::ALL);
1557 void Controller::SelectNone()
1559 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::NONE);
1562 void Controller::SelectText(const uint32_t start, const uint32_t end)
1564 EventHandler::SelectEvent(*this, start, end, SelectionType::RANGE);
1567 string Controller::GetSelectedText() const
1569 return mImpl->GetSelectedText();
1572 string Controller::CopyText()
1574 return mImpl->CopyText();
1577 string Controller::CutText()
1579 return mImpl->CutText();
1582 void Controller::PasteText()
1584 mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
1587 InputMethodContext::CallbackData Controller::OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1589 return EventHandler::OnInputMethodContextEvent(*this, inputMethodContext, inputMethodContextEvent);
1592 void Controller::PasteClipboardItemEvent()
1594 EventHandler::PasteClipboardItemEvent(*this);
1597 void Controller::GetTargetSize(Vector2& targetSize)
1599 targetSize = mImpl->mModel->mVisualModel->mControlSize;
1602 void Controller::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1604 if(mImpl->mEditableControlInterface)
1606 mImpl->mEditableControlInterface->AddDecoration(actor, type, needsClipping);
1610 bool Controller::IsEditable() const
1612 return mImpl->IsEditable();
1615 void Controller::SetEditable(bool editable)
1617 mImpl->SetEditable(editable);
1620 void Controller::ScrollBy(Vector2 scroll)
1622 mImpl->ScrollBy(scroll);
1625 bool Controller::IsScrollable(const Vector2& displacement)
1627 return mImpl->IsScrollable(displacement);
1630 float Controller::GetHorizontalScrollPosition()
1632 return mImpl->GetHorizontalScrollPosition();
1635 float Controller::GetVerticalScrollPosition()
1637 return mImpl->GetVerticalScrollPosition();
1640 void Controller::DecorationEvent(HandleType handleType, HandleState state, float x, float y)
1642 EventHandler::DecorationEvent(*this, handleType, state, x, y);
1645 void Controller::TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button)
1647 EventHandler::TextPopupButtonTouched(*this, button);
1650 void Controller::DisplayTimeExpired()
1652 mImpl->mEventData->mUpdateCursorPosition = true;
1653 // Apply modifications to the model
1654 mImpl->mOperationsPending = ALL_OPERATIONS;
1656 mImpl->RequestRelayout();
1659 void Controller::ResetCursorPosition(CharacterIndex cursorIndex)
1661 // Reset the cursor position
1662 if(NULL != mImpl->mEventData)
1664 mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
1666 // Update the cursor if it's in editing mode.
1667 if(EventData::IsEditingState(mImpl->mEventData->mState))
1669 mImpl->mEventData->mUpdateCursorPosition = true;
1674 CharacterIndex Controller::GetCursorPosition()
1676 return mImpl->mEventData ? mImpl->mEventData->mPrimaryCursorPosition : 0;
1679 void Controller::SetControlInterface(ControlInterface* controlInterface)
1681 mImpl->mControlInterface = controlInterface;
1684 void Controller::SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface)
1686 mImpl->mAnchorControlInterface = anchorControlInterface;
1689 bool Controller::ShouldClearFocusOnEscape() const
1691 return mImpl->mShouldClearFocusOnEscape;
1694 Actor Controller::CreateBackgroundActor()
1696 return CreateControllerBackgroundActor(mImpl->mView, mImpl->mModel->mVisualModel, mImpl->mModel->mLogicalModel, mImpl->mShaderBackground);
1699 void Controller::GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors)
1701 mImpl->GetAnchorActors(anchorActors);
1704 int Controller::GetAnchorIndex(size_t characterOffset)
1706 return mImpl->GetAnchorIndex(characterOffset);
1709 Controller::Controller(ControlInterface* controlInterface,
1710 EditableControlInterface* editableControlInterface,
1711 SelectableControlInterface* selectableControlInterface,
1712 AnchorControlInterface* anchorControlInterface)
1713 : mImpl(new Controller::Impl(controlInterface, editableControlInterface, selectableControlInterface, anchorControlInterface))
1717 Controller::~Controller()
1722 } // namespace Dali::Toolkit::Text