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>
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 bool Controller::IsAutoScrollEnabled() const
176 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", mImpl->mIsAutoScrollEnabled ? "true" : "false");
177 return mImpl->mIsAutoScrollEnabled;
180 CharacterDirection Controller::GetAutoScrollDirection() const
182 return mImpl->mIsTextDirectionRTL;
185 float Controller::GetAutoScrollLineAlignment() const
188 if(mImpl->mModel->mVisualModel && (0u != mImpl->mModel->mVisualModel->mLines.Count()))
190 offset = (*mImpl->mModel->mVisualModel->mLines.Begin()).alignmentOffset;
195 void Controller::SetHorizontalScrollEnabled(bool enable)
197 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
199 mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled(enable);
203 bool Controller::IsHorizontalScrollEnabled() const
205 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
208 void Controller::SetVerticalScrollEnabled(bool enable)
210 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
212 mImpl->mEventData->mDecorator->SetVerticalScrollEnabled(enable);
216 bool Controller::IsVerticalScrollEnabled() const
218 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
221 void Controller::SetSmoothHandlePanEnabled(bool enable)
223 if(mImpl->mEventData && mImpl->mEventData->mDecorator)
225 mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled(enable);
229 bool Controller::IsSmoothHandlePanEnabled() const
231 return mImpl->mEventData && mImpl->mEventData->mDecorator && mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
234 void Controller::SetMaximumNumberOfCharacters(Length maxCharacters)
236 mImpl->mMaximumNumberOfCharacters = maxCharacters;
239 int Controller::GetMaximumNumberOfCharacters()
241 return mImpl->mMaximumNumberOfCharacters;
244 void Controller::SetEnableCursorBlink(bool enable)
246 mImpl->SetEnableCursorBlink(enable);
249 bool Controller::GetEnableCursorBlink() const
251 return mImpl->mEventData && mImpl->mEventData->mCursorBlinkEnabled;
254 void Controller::SetMultiLineEnabled(bool enable)
256 mImpl->SetMultiLineEnabled(enable);
259 bool Controller::IsMultiLineEnabled() const
261 return Layout::Engine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
264 void Controller::SetHorizontalAlignment(Text::HorizontalAlignment::Type alignment)
266 mImpl->SetHorizontalAlignment(alignment);
269 Text::HorizontalAlignment::Type Controller::GetHorizontalAlignment() const
271 return mImpl->mModel->mHorizontalAlignment;
274 void Controller::SetVerticalAlignment(VerticalAlignment::Type alignment)
276 mImpl->SetVerticalAlignment(alignment);
279 VerticalAlignment::Type Controller::GetVerticalAlignment() const
281 return mImpl->mModel->mVerticalAlignment;
284 bool Controller::IsIgnoreSpacesAfterText() const
286 return mImpl->mModel->mIgnoreSpacesAfterText;
289 void Controller::SetIgnoreSpacesAfterText(bool ignore)
291 mImpl->mModel->mIgnoreSpacesAfterText = ignore;
294 void Controller::ChangedLayoutDirection()
296 mImpl->mIsLayoutDirectionChanged = true;
299 void Controller::SetMatchLayoutDirection(DevelText::MatchLayoutDirection type)
301 mImpl->mModel->mMatchLayoutDirection = type;
304 DevelText::MatchLayoutDirection Controller::GetMatchLayoutDirection() const
306 return mImpl->mModel->mMatchLayoutDirection;
309 void Controller::SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection)
311 mImpl->mLayoutDirection = layoutDirection;
314 Dali::LayoutDirection::Type Controller::GetLayoutDirection(Dali::Actor& actor) const
316 return mImpl->GetLayoutDirection(actor);
319 bool Controller::IsShowingRealText() const
321 return mImpl->IsShowingRealText();
324 void Controller::SetLineWrapMode(Text::LineWrap::Mode lineWrapMode)
326 mImpl->SetLineWrapMode(lineWrapMode);
329 Text::LineWrap::Mode Controller::GetLineWrapMode() const
331 return mImpl->mModel->mLineWrapMode;
334 void Controller::SetTextElideEnabled(bool enabled)
336 mImpl->mModel->mElideEnabled = enabled;
337 mImpl->mModel->mVisualModel->SetTextElideEnabled(enabled);
340 bool Controller::IsTextElideEnabled() const
342 return mImpl->mModel->mElideEnabled;
345 void Controller::SetTextFitEnabled(bool enabled)
347 mImpl->mTextFitEnabled = enabled;
350 bool Controller::IsTextFitEnabled() const
352 return mImpl->mTextFitEnabled;
355 void Controller::SetTextFitChanged(bool changed)
357 mImpl->mTextFitChanged = changed;
360 bool Controller::IsTextFitChanged() const
362 return mImpl->mTextFitChanged;
365 void Controller::SetTextFitMinSize(float minSize, FontSizeType type)
367 mImpl->mTextFitMinSize = (type == POINT_SIZE) ? minSize : ConvertPixelToPoint(minSize);
370 float Controller::GetTextFitMinSize() const
372 return mImpl->mTextFitMinSize;
375 void Controller::SetTextFitMaxSize(float maxSize, FontSizeType type)
377 mImpl->mTextFitMaxSize = (type == POINT_SIZE) ? maxSize : ConvertPixelToPoint(maxSize);
380 float Controller::GetTextFitMaxSize() const
382 return mImpl->mTextFitMaxSize;
385 void Controller::SetTextFitStepSize(float step, FontSizeType type)
387 mImpl->mTextFitStepSize = (type == POINT_SIZE) ? step : ConvertPixelToPoint(step);
390 float Controller::GetTextFitStepSize() const
392 return mImpl->mTextFitStepSize;
395 void Controller::SetTextFitContentSize(Vector2 size)
397 mImpl->mTextFitContentSize = size;
400 Vector2 Controller::GetTextFitContentSize() const
402 return mImpl->mTextFitContentSize;
405 float Controller::GetTextFitPointSize() const
407 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFitPointSize : 0.0f;
410 void Controller::SetPlaceholderTextElideEnabled(bool enabled)
412 PlaceholderHandler::SetPlaceholderTextElideEnabled(*this, enabled);
415 bool Controller::IsPlaceholderTextElideEnabled() const
417 return PlaceholderHandler::IsPlaceholderTextElideEnabled(*this);
420 void Controller::SetSelectionEnabled(bool enabled)
422 mImpl->mEventData->mSelectionEnabled = enabled;
425 bool Controller::IsSelectionEnabled() const
427 return mImpl->mEventData->mSelectionEnabled;
430 void Controller::SetShiftSelectionEnabled(bool enabled)
432 mImpl->mEventData->mShiftSelectionFlag = enabled;
435 bool Controller::IsShiftSelectionEnabled() const
437 return mImpl->mEventData->mShiftSelectionFlag;
440 void Controller::SetGrabHandleEnabled(bool enabled)
442 mImpl->mEventData->mGrabHandleEnabled = enabled;
445 bool Controller::IsGrabHandleEnabled() const
447 return mImpl->mEventData->mGrabHandleEnabled;
450 void Controller::SetGrabHandlePopupEnabled(bool enabled)
452 mImpl->mEventData->mGrabHandlePopupEnabled = enabled;
455 bool Controller::IsGrabHandlePopupEnabled() const
457 return mImpl->mEventData->mGrabHandlePopupEnabled;
460 void Controller::SetText(const std::string& text)
462 TextUpdater::SetText(*this, text);
465 void Controller::GetText(std::string& text) const
467 mImpl->GetText(text);
470 void Controller::SetPlaceholderText(PlaceholderType type, const std::string& text)
472 PlaceholderHandler::SetPlaceholderText(*this, type, text);
475 void Controller::GetPlaceholderText(PlaceholderType type, std::string& text) const
477 PlaceholderHandler::GetPlaceholderText(*this, type, text);
480 void Controller::UpdateAfterFontChange(const std::string& newDefaultFont)
482 mImpl->UpdateAfterFontChange(newDefaultFont);
485 void Controller::RetrieveSelection(std::string& selectedText) const
487 mImpl->RetrieveSelection(selectedText, false);
490 void Controller::SetSelection(int start, int end)
492 mImpl->SetSelection(start, end);
495 std::pair<int, int> Controller::GetSelectionIndexes() const
497 return mImpl->GetSelectionIndexes();
500 void Controller::CopyStringToClipboard(const std::string& source)
502 mImpl->CopyStringToClipboard(source);
505 void Controller::SendSelectionToClipboard(bool deleteAfterSending)
507 mImpl->SendSelectionToClipboard(deleteAfterSending);
510 void Controller::SetDefaultFontFamily(const std::string& defaultFontFamily)
512 EnsureCreated(mImpl->mFontDefaults);
514 mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
515 DALI_LOG_INFO(gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
516 mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
518 // Update the cursor position if it's in editing mode
519 UpdateCursorPosition(mImpl->mEventData);
521 // Clear the font-specific data
522 mImpl->ClearFontData();
524 mImpl->RequestRelayout();
527 const std::string& Controller::GetDefaultFontFamily() const
529 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.family : EMPTY_STRING;
532 void Controller::SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily)
534 PlaceholderHandler::SetPlaceholderFontFamily(*this, placeholderTextFontFamily);
537 const std::string& Controller::GetPlaceholderFontFamily() const
539 return PlaceholderHandler::GetPlaceholderFontFamily(*this);
542 void Controller::SetDefaultFontWeight(FontWeight weight)
544 EnsureCreated(mImpl->mFontDefaults);
546 mImpl->mFontDefaults->mFontDescription.weight = weight;
547 mImpl->mFontDefaults->weightDefined = true;
549 // Update the cursor position if it's in editing mode
550 UpdateCursorPosition(mImpl->mEventData);
552 // Clear the font-specific data
553 mImpl->ClearFontData();
555 mImpl->RequestRelayout();
558 bool Controller::IsDefaultFontWeightDefined() const
560 return mImpl->mFontDefaults && mImpl->mFontDefaults->weightDefined;
563 FontWeight Controller::GetDefaultFontWeight() const
565 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.weight : TextAbstraction::FontWeight::NORMAL;
568 void Controller::SetPlaceholderTextFontWeight(FontWeight weight)
570 PlaceholderHandler::SetPlaceholderTextFontWeight(*this, weight);
573 bool Controller::IsPlaceholderTextFontWeightDefined() const
575 return PlaceholderHandler::IsPlaceholderTextFontWeightDefined(*this);
578 FontWeight Controller::GetPlaceholderTextFontWeight() const
580 return PlaceholderHandler::GetPlaceholderTextFontWeight(*this);
583 void Controller::SetDefaultFontWidth(FontWidth width)
585 EnsureCreated(mImpl->mFontDefaults);
587 mImpl->mFontDefaults->mFontDescription.width = width;
588 mImpl->mFontDefaults->widthDefined = true;
590 // Update the cursor position if it's in editing mode
591 UpdateCursorPosition(mImpl->mEventData);
593 // Clear the font-specific data
594 mImpl->ClearFontData();
596 mImpl->RequestRelayout();
599 bool Controller::IsDefaultFontWidthDefined() const
601 return mImpl->mFontDefaults && mImpl->mFontDefaults->widthDefined;
604 FontWidth Controller::GetDefaultFontWidth() const
606 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.width : TextAbstraction::FontWidth::NORMAL;
609 void Controller::SetPlaceholderTextFontWidth(FontWidth width)
611 PlaceholderHandler::SetPlaceholderTextFontWidth(*this, width);
614 bool Controller::IsPlaceholderTextFontWidthDefined() const
616 return PlaceholderHandler::IsPlaceholderTextFontWidthDefined(*this);
619 FontWidth Controller::GetPlaceholderTextFontWidth() const
621 return PlaceholderHandler::GetPlaceholderTextFontWidth(*this);
624 void Controller::SetDefaultFontSlant(FontSlant slant)
626 EnsureCreated(mImpl->mFontDefaults);
628 mImpl->mFontDefaults->mFontDescription.slant = slant;
629 mImpl->mFontDefaults->slantDefined = true;
631 // Update the cursor position if it's in editing mode
632 UpdateCursorPosition(mImpl->mEventData);
634 // Clear the font-specific data
635 mImpl->ClearFontData();
637 mImpl->RequestRelayout();
640 bool Controller::IsDefaultFontSlantDefined() const
642 return mImpl->mFontDefaults && mImpl->mFontDefaults->slantDefined;
645 FontSlant Controller::GetDefaultFontSlant() const
647 return mImpl->mFontDefaults ? mImpl->mFontDefaults->mFontDescription.slant : TextAbstraction::FontSlant::NORMAL;
650 void Controller::SetPlaceholderTextFontSlant(FontSlant slant)
652 PlaceholderHandler::SetPlaceholderTextFontSlant(*this, slant);
655 bool Controller::IsPlaceholderTextFontSlantDefined() const
657 return PlaceholderHandler::IsPlaceholderTextFontSlantDefined(*this);
660 FontSlant Controller::GetPlaceholderTextFontSlant() const
662 return PlaceholderHandler::GetPlaceholderTextFontSlant(*this);
665 void Controller::SetFontSizeScale(float scale)
667 mImpl->mFontSizeScale = scale;
669 // Update the cursor position if it's in editing mode
670 UpdateCursorPosition(mImpl->mEventData);
672 // Clear the font-specific data
673 mImpl->ClearFontData();
675 mImpl->RequestRelayout();
678 float Controller::GetFontSizeScale() const
680 return mImpl->mFontDefaults ? mImpl->mFontSizeScale : 1.0f;
683 void Controller::SetDefaultFontSize(float fontSize, FontSizeType type)
685 EnsureCreated(mImpl->mFontDefaults);
687 mImpl->mFontDefaults->mDefaultPointSize = (type == POINT_SIZE) ? fontSize : ConvertPixelToPoint(fontSize);
688 mImpl->mFontDefaults->sizeDefined = true;
690 // Update the cursor position if it's in editing mode
691 UpdateCursorPosition(mImpl->mEventData);
693 // Clear the font-specific data
694 mImpl->ClearFontData();
696 mImpl->RequestRelayout();
699 float Controller::GetDefaultFontSize(FontSizeType type) const
701 if(mImpl->mFontDefaults)
703 return (type == POINT_SIZE) ? mImpl->mFontDefaults->mDefaultPointSize : ConvertPointToPixel(mImpl->mFontDefaults->mDefaultPointSize);
708 void Controller::SetPlaceholderTextFontSize(float fontSize, FontSizeType type)
710 PlaceholderHandler::SetPlaceholderTextFontSize(*this, fontSize, type);
713 float Controller::GetPlaceholderTextFontSize(FontSizeType type) const
715 return PlaceholderHandler::GetPlaceholderTextFontSize(*this, type);
718 void Controller::SetDefaultColor(const Vector4& color)
720 mImpl->SetDefaultColor(color);
723 const Vector4& Controller::GetDefaultColor() const
725 return mImpl->mTextColor;
728 void Controller::SetPlaceholderTextColor(const Vector4& textColor)
730 PlaceholderHandler::SetPlaceholderTextColor(*this, textColor);
733 const Vector4& Controller::GetPlaceholderTextColor() const
735 return PlaceholderHandler::GetPlaceholderTextColor(*this);
738 void Controller::SetShadowOffset(const Vector2& shadowOffset)
740 mImpl->mModel->mVisualModel->SetShadowOffset(shadowOffset);
741 mImpl->RequestRelayout();
744 const Vector2& Controller::GetShadowOffset() const
746 return mImpl->mModel->mVisualModel->GetShadowOffset();
749 void Controller::SetShadowColor(const Vector4& shadowColor)
751 mImpl->mModel->mVisualModel->SetShadowColor(shadowColor);
752 mImpl->RequestRelayout();
755 const Vector4& Controller::GetShadowColor() const
757 return mImpl->mModel->mVisualModel->GetShadowColor();
760 void Controller::SetShadowBlurRadius(const float& shadowBlurRadius)
762 if(fabsf(GetShadowBlurRadius() - shadowBlurRadius) > Math::MACHINE_EPSILON_1)
764 mImpl->mModel->mVisualModel->SetShadowBlurRadius(shadowBlurRadius);
765 mImpl->RequestRelayout();
769 const float& Controller::GetShadowBlurRadius() const
771 return mImpl->mModel->mVisualModel->GetShadowBlurRadius();
774 void Controller::SetUnderlineColor(const Vector4& color)
776 mImpl->mModel->mVisualModel->SetUnderlineColor(color);
777 mImpl->RequestRelayout();
780 const Vector4& Controller::GetUnderlineColor() const
782 return mImpl->mModel->mVisualModel->GetUnderlineColor();
785 void Controller::SetUnderlineEnabled(bool enabled)
787 mImpl->mModel->mVisualModel->SetUnderlineEnabled(enabled);
788 mImpl->RequestRelayout();
791 bool Controller::IsUnderlineEnabled() const
793 return mImpl->mModel->mVisualModel->IsUnderlineEnabled();
796 void Controller::SetUnderlineHeight(float height)
798 mImpl->mModel->mVisualModel->SetUnderlineHeight(height);
799 mImpl->RequestRelayout();
802 float Controller::GetUnderlineHeight() const
804 return mImpl->mModel->mVisualModel->GetUnderlineHeight();
807 void Controller::SetOutlineColor(const Vector4& color)
809 mImpl->mModel->mVisualModel->SetOutlineColor(color);
810 mImpl->RequestRelayout();
813 const Vector4& Controller::GetOutlineColor() const
815 return mImpl->mModel->mVisualModel->GetOutlineColor();
818 void Controller::SetOutlineWidth(uint16_t width)
820 mImpl->mModel->mVisualModel->SetOutlineWidth(width);
821 mImpl->RequestRelayout();
824 uint16_t Controller::GetOutlineWidth() const
826 return mImpl->mModel->mVisualModel->GetOutlineWidth();
829 void Controller::SetBackgroundColor(const Vector4& color)
831 mImpl->mModel->mVisualModel->SetBackgroundColor(color);
832 mImpl->RequestRelayout();
835 const Vector4& Controller::GetBackgroundColor() const
837 return mImpl->mModel->mVisualModel->GetBackgroundColor();
840 void Controller::SetBackgroundEnabled(bool enabled)
842 mImpl->mModel->mVisualModel->SetBackgroundEnabled(enabled);
843 mImpl->RequestRelayout();
846 bool Controller::IsBackgroundEnabled() const
848 return mImpl->mModel->mVisualModel->IsBackgroundEnabled();
851 void Controller::SetDefaultEmbossProperties(const std::string& embossProperties)
853 EnsureCreated(mImpl->mEmbossDefaults);
854 mImpl->mEmbossDefaults->properties = embossProperties;
857 const std::string& Controller::GetDefaultEmbossProperties() const
859 return mImpl->mEmbossDefaults ? mImpl->mEmbossDefaults->properties : EMPTY_STRING;
862 void Controller::SetDefaultOutlineProperties(const std::string& outlineProperties)
864 EnsureCreated(mImpl->mOutlineDefaults);
865 mImpl->mOutlineDefaults->properties = outlineProperties;
868 const std::string& Controller::GetDefaultOutlineProperties() const
870 return mImpl->mOutlineDefaults ? mImpl->mOutlineDefaults->properties : EMPTY_STRING;
873 bool Controller::SetDefaultLineSpacing(float lineSpacing)
875 return mImpl->SetDefaultLineSpacing(lineSpacing);
878 float Controller::GetDefaultLineSpacing() const
880 return mImpl->mLayoutEngine.GetDefaultLineSpacing();
883 bool Controller::SetDefaultLineSize(float lineSize)
885 return mImpl->SetDefaultLineSize(lineSize);
888 float Controller::GetDefaultLineSize() const
890 return mImpl->mLayoutEngine.GetDefaultLineSize();
893 void Controller::SetInputColor(const Vector4& color)
895 InputProperties::SetInputColor(*this, color);
898 const Vector4& Controller::GetInputColor() const
900 return InputProperties::GetInputColor(*this);
903 void Controller::SetInputFontFamily(const std::string& fontFamily)
905 InputFontHandler::SetInputFontFamily(*this, fontFamily);
908 const std::string& Controller::GetInputFontFamily() const
910 return InputFontHandler::GetInputFontFamily(*this);
913 void Controller::SetInputFontWeight(FontWeight weight)
915 InputFontHandler::SetInputFontWeight(*this, weight);
918 bool Controller::IsInputFontWeightDefined() const
920 return InputFontHandler::IsInputFontWeightDefined(*this);
923 FontWeight Controller::GetInputFontWeight() const
925 return InputFontHandler::GetInputFontWeight(*this);
928 void Controller::SetInputFontWidth(FontWidth width)
930 InputFontHandler::SetInputFontWidth(*this, width);
933 bool Controller::IsInputFontWidthDefined() const
935 return InputFontHandler::IsInputFontWidthDefined(*this);
938 FontWidth Controller::GetInputFontWidth() const
940 return InputFontHandler::GetInputFontWidth(*this);
943 void Controller::SetInputFontSlant(FontSlant slant)
945 InputFontHandler::SetInputFontSlant(*this, slant);
948 bool Controller::IsInputFontSlantDefined() const
950 return InputFontHandler::IsInputFontSlantDefined(*this);
953 FontSlant Controller::GetInputFontSlant() const
955 return InputFontHandler::GetInputFontSlant(*this);
958 void Controller::SetInputFontPointSize(float size)
960 InputFontHandler::SetInputFontPointSize(*this, size);
963 float Controller::GetInputFontPointSize() const
965 return InputFontHandler::GetInputFontPointSize(*this);
968 void Controller::SetInputLineSpacing(float lineSpacing)
970 InputProperties::SetInputLineSpacing(*this, lineSpacing);
973 float Controller::GetInputLineSpacing() const
975 return InputProperties::GetInputLineSpacing(*this);
978 void Controller::SetInputShadowProperties(const std::string& shadowProperties)
980 InputProperties::SetInputShadowProperties(*this, shadowProperties);
983 const std::string& Controller::GetInputShadowProperties() const
985 return InputProperties::GetInputShadowProperties(*this);
988 void Controller::SetInputUnderlineProperties(const std::string& underlineProperties)
990 InputProperties::SetInputUnderlineProperties(*this, underlineProperties);
993 const std::string& Controller::GetInputUnderlineProperties() const
995 return InputProperties::GetInputUnderlineProperties(*this);
998 void Controller::SetInputEmbossProperties(const std::string& embossProperties)
1000 InputProperties::SetInputEmbossProperties(*this, embossProperties);
1003 const std::string& Controller::GetInputEmbossProperties() const
1005 return InputProperties::GetInputEmbossProperties(*this);
1008 void Controller::SetInputOutlineProperties(const std::string& outlineProperties)
1010 InputProperties::SetInputOutlineProperties(*this, outlineProperties);
1013 const std::string& Controller::GetInputOutlineProperties() const
1015 return InputProperties::GetInputOutlineProperties(*this);
1018 void Controller::SetInputModePassword(bool passwordInput)
1020 InputProperties::SetInputModePassword(*this, passwordInput);
1023 bool Controller::IsInputModePassword()
1025 return InputProperties::IsInputModePassword(*this);
1028 void Controller::SetNoTextDoubleTapAction(NoTextTap::Action action)
1030 if(mImpl->mEventData)
1032 mImpl->mEventData->mDoubleTapAction = action;
1036 Controller::NoTextTap::Action Controller::GetNoTextDoubleTapAction() const
1038 return mImpl->mEventData ? mImpl->mEventData->mDoubleTapAction : NoTextTap::NO_ACTION;
1041 void Controller::SetNoTextLongPressAction(NoTextTap::Action action)
1043 if(mImpl->mEventData)
1045 mImpl->mEventData->mLongPressAction = action;
1049 Controller::NoTextTap::Action Controller::GetNoTextLongPressAction() const
1051 return mImpl->mEventData ? mImpl->mEventData->mLongPressAction : NoTextTap::NO_ACTION;
1054 bool Controller::IsUnderlineSetByString()
1056 return mImpl->mUnderlineSetByString;
1059 void Controller::UnderlineSetByString(bool setByString)
1061 mImpl->mUnderlineSetByString = setByString;
1064 bool Controller::IsShadowSetByString()
1066 return mImpl->mShadowSetByString;
1069 void Controller::ShadowSetByString(bool setByString)
1071 mImpl->mShadowSetByString = setByString;
1074 bool Controller::IsOutlineSetByString()
1076 return mImpl->mOutlineSetByString;
1079 void Controller::OutlineSetByString(bool setByString)
1081 mImpl->mOutlineSetByString = setByString;
1084 bool Controller::IsFontStyleSetByString()
1086 return mImpl->mFontStyleSetByString;
1089 void Controller::FontStyleSetByString(bool setByString)
1091 mImpl->mFontStyleSetByString = setByString;
1094 Layout::Engine& Controller::GetLayoutEngine()
1096 return mImpl->mLayoutEngine;
1099 View& Controller::GetView()
1101 return mImpl->mView;
1104 Vector3 Controller::GetNaturalSize()
1106 return Relayouter::GetNaturalSize(*this);
1109 bool Controller::CheckForTextFit(float pointSize, Size& layoutSize)
1111 return Relayouter::CheckForTextFit(*this, pointSize, layoutSize);
1114 void Controller::FitPointSizeforLayout(Size layoutSize)
1116 Relayouter::FitPointSizeforLayout(*this, layoutSize);
1119 float Controller::GetHeightForWidth(float width)
1121 return Relayouter::GetHeightForWidth(*this, width);
1124 int Controller::GetLineCount(float width)
1126 GetHeightForWidth(width);
1127 return mImpl->mModel->GetNumberOfLines();
1130 const ModelInterface* const Controller::GetTextModel() const
1132 return mImpl->mModel.Get();
1135 float Controller::GetScrollAmountByUserInput()
1137 float scrollAmount = 0.0f;
1139 if(NULL != mImpl->mEventData && mImpl->mEventData->mCheckScrollAmount)
1141 scrollAmount = mImpl->mModel->mScrollPosition.y - mImpl->mModel->mScrollPositionLast.y;
1142 mImpl->mEventData->mCheckScrollAmount = false;
1144 return scrollAmount;
1147 bool Controller::GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight)
1149 const Vector2& layout = mImpl->mModel->mVisualModel->GetLayoutSize();
1152 controlHeight = mImpl->mModel->mVisualModel->mControlSize.height;
1153 layoutHeight = layout.height;
1154 scrollPosition = mImpl->mModel->mScrollPosition.y;
1155 isScrolled = !Equals(mImpl->mModel->mScrollPosition.y, mImpl->mModel->mScrollPositionLast.y, Math::MACHINE_EPSILON_1);
1159 void Controller::SetHiddenInputOption(const Property::Map& options)
1161 EnsureCreated<HiddenText, Controller*>(mImpl->mHiddenInput, this);
1162 mImpl->mHiddenInput->SetProperties(options);
1165 void Controller::GetHiddenInputOption(Property::Map& options)
1167 if(mImpl->mHiddenInput)
1169 mImpl->mHiddenInput->GetProperties(options);
1173 void Controller::SetInputFilterOption(const Property::Map& options)
1175 EnsureCreated(mImpl->mInputFilter);
1176 mImpl->mInputFilter->SetProperties(options);
1179 void Controller::GetInputFilterOption(Property::Map& options)
1181 if(mImpl->mInputFilter)
1183 mImpl->mInputFilter->GetProperties(options);
1187 void Controller::SetPlaceholderProperty(const Property::Map& map)
1189 PlaceholderHandler::SetPlaceholderProperty(*this, map);
1192 void Controller::GetPlaceholderProperty(Property::Map& map)
1194 PlaceholderHandler::GetPlaceholderProperty(*this, map);
1197 Toolkit::DevelText::TextDirection::Type Controller::GetTextDirection()
1199 // Make sure the model is up-to-date before layouting
1200 EventHandler::ProcessModifyEvents(*this);
1202 return mImpl->GetTextDirection();
1205 Toolkit::DevelText::VerticalLineAlignment::Type Controller::GetVerticalLineAlignment() const
1207 return mImpl->mModel->GetVerticalLineAlignment();
1210 void Controller::SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment)
1212 mImpl->mModel->mVerticalLineAlignment = alignment;
1215 Toolkit::DevelText::EllipsisPosition::Type Controller::GetEllipsisPosition() const
1217 return mImpl->mModel->GetEllipsisPosition();
1220 void Controller::SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition)
1222 mImpl->mModel->mEllipsisPosition = ellipsisPosition;
1223 mImpl->mModel->mVisualModel->SetEllipsisPosition(ellipsisPosition);
1226 Controller::UpdateTextType Controller::Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection)
1228 return Relayouter::Relayout(*this, size, layoutDirection);
1231 void Controller::RequestRelayout()
1233 mImpl->RequestRelayout();
1236 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1238 return mImpl->IsInputStyleChangedSignalsQueueEmpty();
1241 void Controller::ProcessInputStyleChangedSignals()
1243 mImpl->ProcessInputStyleChangedSignals();
1246 void Controller::KeyboardFocusGainEvent()
1248 EventHandler::KeyboardFocusGainEvent(*this);
1251 void Controller::KeyboardFocusLostEvent()
1253 EventHandler::KeyboardFocusLostEvent(*this);
1256 bool Controller::KeyEvent(const Dali::KeyEvent& keyEvent)
1258 return EventHandler::KeyEvent(*this, keyEvent);
1261 void Controller::AnchorEvent(float x, float y)
1263 EventHandler::AnchorEvent(*this, x, y);
1266 void Controller::TapEvent(unsigned int tapCount, float x, float y)
1268 EventHandler::TapEvent(*this, tapCount, x, y);
1271 void Controller::PanEvent(GestureState state, const Vector2& displacement)
1273 EventHandler::PanEvent(*this, state, displacement);
1276 void Controller::LongPressEvent(GestureState state, float x, float y)
1278 EventHandler::LongPressEvent(*this, state, x, y);
1281 void Controller::SelectEvent(float x, float y, SelectionType selectType)
1283 EventHandler::SelectEvent(*this, x, y, selectType);
1286 void Controller::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1288 if(mImpl->mEventData)
1290 mImpl->mEventData->mCheckScrollAmount = true;
1291 mImpl->mEventData->mIsLeftHandleSelected = true;
1292 mImpl->mEventData->mIsRightHandleSelected = true;
1293 mImpl->SetTextSelectionRange(start, end);
1294 mImpl->RequestRelayout();
1295 EventHandler::KeyboardFocusGainEvent(*this);
1299 Uint32Pair Controller::GetTextSelectionRange() const
1301 return mImpl->GetTextSelectionRange();
1304 CharacterIndex Controller::GetPrimaryCursorPosition() const
1306 return mImpl->GetPrimaryCursorPosition();
1309 bool Controller::SetPrimaryCursorPosition(CharacterIndex index, bool focused)
1311 if(mImpl->mEventData)
1313 mImpl->mEventData->mCheckScrollAmount = true;
1314 mImpl->mEventData->mIsLeftHandleSelected = true;
1315 mImpl->mEventData->mIsRightHandleSelected = true;
1316 mImpl->mEventData->mCheckScrollAmount = true;
1317 if(mImpl->SetPrimaryCursorPosition(index, focused) && focused)
1319 EventHandler::KeyboardFocusGainEvent(*this);
1326 void Controller::SelectWholeText()
1328 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::ALL);
1331 void Controller::SelectNone()
1333 EventHandler::SelectEvent(*this, 0.f, 0.f, SelectionType::NONE);
1336 void Controller::SelectText(const uint32_t start, const uint32_t end)
1338 EventHandler::SelectEvent(*this, start, end, SelectionType::RANGE);
1341 string Controller::GetSelectedText() const
1343 return mImpl->GetSelectedText();
1346 string Controller::CopyText()
1348 return mImpl->CopyText();
1351 string Controller::CutText()
1353 return mImpl->CutText();
1356 void Controller::PasteText()
1358 mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
1361 InputMethodContext::CallbackData Controller::OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1363 return EventHandler::OnInputMethodContextEvent(*this, inputMethodContext, inputMethodContextEvent);
1366 void Controller::PasteClipboardItemEvent()
1368 EventHandler::PasteClipboardItemEvent(*this);
1371 void Controller::GetTargetSize(Vector2& targetSize)
1373 targetSize = mImpl->mModel->mVisualModel->mControlSize;
1376 void Controller::AddDecoration(Actor& actor, bool needsClipping)
1378 if(mImpl->mEditableControlInterface)
1380 mImpl->mEditableControlInterface->AddDecoration(actor, needsClipping);
1384 bool Controller::IsEditable() const
1386 return mImpl->IsEditable();
1389 void Controller::SetEditable(bool editable)
1391 mImpl->SetEditable(editable);
1394 void Controller::ScrollBy(Vector2 scroll)
1396 mImpl->ScrollBy(scroll);
1399 float Controller::GetHorizontalScrollPosition()
1401 return mImpl->GetHorizontalScrollPosition();
1404 float Controller::GetVerticalScrollPosition()
1406 return mImpl->GetVerticalScrollPosition();
1409 void Controller::DecorationEvent(HandleType handleType, HandleState state, float x, float y)
1411 EventHandler::DecorationEvent(*this, handleType, state, x, y);
1414 void Controller::TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button)
1416 EventHandler::TextPopupButtonTouched(*this, button);
1419 void Controller::DisplayTimeExpired()
1421 mImpl->mEventData->mUpdateCursorPosition = true;
1422 // Apply modifications to the model
1423 mImpl->mOperationsPending = ALL_OPERATIONS;
1425 mImpl->RequestRelayout();
1428 void Controller::ResetCursorPosition(CharacterIndex cursorIndex)
1430 // Reset the cursor position
1431 if(NULL != mImpl->mEventData)
1433 mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
1435 // Update the cursor if it's in editing mode.
1436 if(EventData::IsEditingState(mImpl->mEventData->mState))
1438 mImpl->mEventData->mUpdateCursorPosition = true;
1443 CharacterIndex Controller::GetCursorPosition()
1445 return mImpl->mEventData ? mImpl->mEventData->mPrimaryCursorPosition : 0;
1448 void Controller::SetControlInterface(ControlInterface* controlInterface)
1450 mImpl->mControlInterface = controlInterface;
1453 void Controller::SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface)
1455 mImpl->mAnchorControlInterface = anchorControlInterface;
1458 bool Controller::ShouldClearFocusOnEscape() const
1460 return mImpl->mShouldClearFocusOnEscape;
1463 Actor Controller::CreateBackgroundActor()
1465 return CreateControllerBackgroundActor(mImpl->mView, mImpl->mModel->mVisualModel, mImpl->mShaderBackground);
1468 void Controller::GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors)
1470 mImpl->GetAnchorActors(anchorActors);
1473 int Controller::GetAnchorIndex(size_t characterOffset)
1475 return mImpl->GetAnchorIndex(characterOffset);
1478 Controller::Controller(ControlInterface* controlInterface,
1479 EditableControlInterface* editableControlInterface,
1480 SelectableControlInterface* selectableControlInterface,
1481 AnchorControlInterface* anchorControlInterface)
1482 : mImpl(new Controller::Impl(controlInterface, editableControlInterface, selectableControlInterface, anchorControlInterface))
1486 Controller::~Controller()
1491 } // namespace Dali::Toolkit::Text