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/controls/text-controls/text-editor-impl.h>
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/common/stage.h>
24 #include <dali/devel-api/object/property-helper-devel.h>
25 #include <dali/integration-api/adaptor-framework/adaptor.h>
26 #include <dali/integration-api/debug.h>
27 #include <dali/public-api/actors/layer.h>
28 #include <dali/public-api/adaptor-framework/key.h>
29 #include <dali/public-api/common/dali-common.h>
30 #include <dali/public-api/object/type-registry-helper.h>
35 #include <dali-toolkit/devel-api/controls/control-devel.h>
36 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
37 #include <dali-toolkit/devel-api/text/rendering-backend.h>
38 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
39 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
40 #include <dali-toolkit/internal/controls/text-controls/text-editor-property-handler.h>
41 #include <dali-toolkit/internal/styling/style-manager-impl.h>
42 #include <dali-toolkit/internal/text/rendering/text-backend.h>
43 #include <dali-toolkit/internal/text/text-effects-style.h>
44 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
45 #include <dali-toolkit/internal/text/text-font-style.h>
46 #include <dali-toolkit/internal/text/text-view.h>
47 #include <dali-toolkit/public-api/text/text-enumerations.h>
48 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
49 #include <dali-toolkit/public-api/visuals/visual-properties.h>
51 using namespace Dali::Toolkit::Text;
53 #if defined(DEBUG_ENABLED)
54 Debug::Filter* gTextEditorLogFilter = Debug::Filter::New(Debug::Concise, true, "LOG_TEXT_CONTROLS");
63 namespace // unnamed namespace
65 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
66 const float DEFAULT_SCROLL_SPEED = 1200.f; ///< The default scroll speed for the text editor in pixels/second.
67 } // unnamed namespace
71 const char* const SCROLL_BAR_POSITION("sourcePosition");
72 const char* const SCROLL_BAR_POSITION_MIN("sourcePositionMin");
73 const char* const SCROLL_BAR_POSITION_MAX("sourcePositionMax");
74 const char* const SCROLL_BAR_CONTENT_SIZE("sourceContentSize");
79 return Toolkit::TextEditor::New();
83 // Setup properties, signals and actions using the type-registry.
84 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextEditor, Toolkit::Control, Create);
86 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "text", STRING, TEXT )
87 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "textColor", VECTOR4, TEXT_COLOR )
88 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "fontFamily", STRING, FONT_FAMILY )
89 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "fontStyle", MAP, FONT_STYLE )
90 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "pointSize", FLOAT, POINT_SIZE )
91 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
92 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "scrollThreshold", FLOAT, SCROLL_THRESHOLD )
93 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "scrollSpeed", FLOAT, SCROLL_SPEED )
94 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "primaryCursorColor", VECTOR4, PRIMARY_CURSOR_COLOR )
95 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "secondaryCursorColor", VECTOR4, SECONDARY_CURSOR_COLOR )
96 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableCursorBlink", BOOLEAN, ENABLE_CURSOR_BLINK )
97 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "cursorBlinkInterval", FLOAT, CURSOR_BLINK_INTERVAL )
98 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "cursorBlinkDuration", FLOAT, CURSOR_BLINK_DURATION )
99 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "cursorWidth", INTEGER, CURSOR_WIDTH )
100 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "grabHandleImage", STRING, GRAB_HANDLE_IMAGE )
101 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "grabHandlePressedImage", STRING, GRAB_HANDLE_PRESSED_IMAGE )
102 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandleImageLeft", MAP, SELECTION_HANDLE_IMAGE_LEFT )
103 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandleImageRight", MAP, SELECTION_HANDLE_IMAGE_RIGHT )
104 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandlePressedImageLeft", MAP, SELECTION_HANDLE_PRESSED_IMAGE_LEFT )
105 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandlePressedImageRight", MAP, SELECTION_HANDLE_PRESSED_IMAGE_RIGHT)
106 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandleMarkerImageLeft", MAP, SELECTION_HANDLE_MARKER_IMAGE_LEFT )
107 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHandleMarkerImageRight", MAP, SELECTION_HANDLE_MARKER_IMAGE_RIGHT )
108 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionHighlightColor", VECTOR4, SELECTION_HIGHLIGHT_COLOR )
109 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "decorationBoundingBox", RECTANGLE, DECORATION_BOUNDING_BOX )
110 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableMarkup", BOOLEAN, ENABLE_MARKUP )
111 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputColor", VECTOR4, INPUT_COLOR )
112 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputFontFamily", STRING, INPUT_FONT_FAMILY )
113 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputFontStyle", MAP, INPUT_FONT_STYLE )
114 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputPointSize", FLOAT, INPUT_POINT_SIZE )
115 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "lineSpacing", FLOAT, LINE_SPACING )
116 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputLineSpacing", FLOAT, INPUT_LINE_SPACING )
117 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "underline", MAP, UNDERLINE )
118 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputUnderline", MAP, INPUT_UNDERLINE )
119 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "shadow", MAP, SHADOW )
120 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputShadow", MAP, INPUT_SHADOW )
121 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "emboss", MAP, EMBOSS )
122 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputEmboss", MAP, INPUT_EMBOSS )
123 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "outline", MAP, OUTLINE )
124 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputOutline", MAP, INPUT_OUTLINE )
125 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "smoothScroll", BOOLEAN, SMOOTH_SCROLL )
126 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "smoothScrollDuration", FLOAT, SMOOTH_SCROLL_DURATION )
127 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableScrollBar", BOOLEAN, ENABLE_SCROLL_BAR )
128 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "scrollBarShowDuration", FLOAT, SCROLL_BAR_SHOW_DURATION )
129 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "scrollBarFadeDuration", FLOAT, SCROLL_BAR_FADE_DURATION )
130 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "pixelSize", FLOAT, PIXEL_SIZE )
131 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextEditor, "lineCount", INTEGER, LINE_COUNT )
132 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableSelection", BOOLEAN, ENABLE_SELECTION )
133 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "placeholder", MAP, PLACEHOLDER )
134 DALI_PROPERTY_REGISTRATION(Toolkit, TextEditor, "lineWrapMode", INTEGER, LINE_WRAP_MODE )
135 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "placeholderText", STRING, PLACEHOLDER_TEXT )
136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "placeholderTextColor", VECTOR4, PLACEHOLDER_TEXT_COLOR )
137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableShiftSelection", BOOLEAN, ENABLE_SHIFT_SELECTION )
138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableGrabHandle", BOOLEAN, ENABLE_GRAB_HANDLE )
139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION )
140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "renderingBackend", INTEGER, RENDERING_BACKEND )
141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "maxLength", INTEGER, MAX_LENGTH )
142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectedTextStart", INTEGER, SELECTED_TEXT_START )
143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectedTextEnd", INTEGER, SELECTED_TEXT_END )
144 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "horizontalScrollPosition", FLOAT, HORIZONTAL_SCROLL_POSITION )
145 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "verticalScrollPosition", INTEGER, VERTICAL_SCROLL_POSITION )
146 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableEditing", BOOLEAN, ENABLE_EDITING )
147 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextEditor, "selectedText", STRING, SELECTED_TEXT )
148 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "fontSizeScale", FLOAT, FONT_SIZE_SCALE )
149 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableFontSizeScale", BOOLEAN, ENABLE_FONT_SIZE_SCALE )
150 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "primaryCursorPosition", INTEGER, PRIMARY_CURSOR_POSITION )
151 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "grabHandleColor", VECTOR4, GRAB_HANDLE_COLOR )
152 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "enableGrabHandlePopup", BOOLEAN, ENABLE_GRAB_HANDLE_POPUP )
153 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputMethodSettings", MAP, INPUT_METHOD_SETTINGS )
154 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputFilter", MAP, INPUT_FILTER )
155 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "ellipsis", BOOLEAN, ELLIPSIS )
156 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "ellipsisPosition", INTEGER, ELLIPSIS_POSITION )
157 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "minLineSize", FLOAT, MIN_LINE_SIZE )
158 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "strikethrough", MAP, STRIKETHROUGH )
159 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "inputStrikethrough", MAP, INPUT_STRIKETHROUGH )
161 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged", SIGNAL_TEXT_CHANGED )
162 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged", SIGNAL_INPUT_STYLE_CHANGED )
163 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached", SIGNAL_MAX_LENGTH_REACHED )
164 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked", SIGNAL_ANCHOR_CLICKED )
165 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered", SIGNAL_INPUT_FILTERED )
166 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
167 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged", SIGNAL_SELECTION_CHANGED )
168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared", SIGNAL_SELECTION_CLEARED )
169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionStarted", SIGNAL_SELECTION_STARTED )
171 DALI_TYPE_REGISTRATION_END()
174 Toolkit::TextEditor::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
176 Toolkit::TextEditor::InputStyle::Mask editorInputStyleMask = Toolkit::TextEditor::InputStyle::NONE;
178 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
180 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::COLOR);
182 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
184 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_FAMILY);
186 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
188 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::POINT_SIZE);
190 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
192 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
194 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
196 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
198 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
200 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
202 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_LINE_SPACING))
204 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::LINE_SPACING);
206 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
208 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::UNDERLINE);
210 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
212 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::SHADOW);
214 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
216 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::EMBOSS);
218 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
220 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::OUTLINE);
222 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_STRIKETHROUGH))
224 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::STRIKETHROUGH);
227 return editorInputStyleMask;
232 Toolkit::TextEditor TextEditor::New()
234 // Create the implementation, temporarily owned by this handle on stack
235 IntrusivePtr<TextEditor> impl = new TextEditor();
237 // Pass ownership to CustomActor handle
238 Toolkit::TextEditor handle(*impl);
240 // Second-phase init of the implementation
241 // This can only be done after the CustomActor connection has been made...
247 void TextEditor::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
249 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
251 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor SetProperty\n");
255 PropertyHandler::SetProperty(textEditor, index, value);
259 Property::Value TextEditor::GetProperty(BaseObject* object, Property::Index index)
261 Property::Value value;
263 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
267 value = PropertyHandler::GetProperty(textEditor, index);
272 void TextEditor::SelectWholeText()
274 if(mController && mController->IsShowingRealText())
276 mController->SelectWholeText();
281 void TextEditor::SelectNone()
283 if(mController && mController->IsShowingRealText())
285 mController->SelectNone();
289 void TextEditor::SelectText(const uint32_t start, const uint32_t end)
291 if(mController && mController->IsShowingRealText())
293 mController->SelectText(start, end);
298 string TextEditor::CopyText()
300 string copiedText = "";
301 if(mController && mController->IsShowingRealText())
303 copiedText = mController->CopyText();
308 string TextEditor::CutText()
311 if(mController && mController->IsShowingRealText())
313 cutText = mController->CutText();
318 void TextEditor::PasteText()
322 SetKeyInputFocus(); //Giving focus to the editor that was passed to the PasteText in case the passed editor (current editor) doesn't have focus.
323 mController->PasteText();
327 void TextEditor::ScrollBy(Vector2 scroll)
329 if(mController && mController->IsShowingRealText())
331 mController->ScrollBy(scroll);
335 float TextEditor::GetHorizontalScrollPosition()
337 if(mController && mController->IsShowingRealText())
339 return mController->GetHorizontalScrollPosition();
344 float TextEditor::GetVerticalScrollPosition()
346 if(mController && mController->IsShowingRealText())
348 return mController->GetVerticalScrollPosition();
353 Vector<Vector2> TextEditor::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
355 return mController->GetTextSize(startIndex, endIndex);
358 Vector<Vector2> TextEditor::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
360 return mController->GetTextPosition(startIndex, endIndex);
363 string TextEditor::GetSelectedText() const
365 string selectedText = "";
366 if(mController && mController->IsShowingRealText())
368 selectedText = mController->GetSelectedText();
373 InputMethodContext TextEditor::GetInputMethodContext()
375 return mInputMethodContext;
378 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
380 return mMaxLengthReachedSignal;
383 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
385 return mAnchorClickedSignal;
388 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
390 return mCursorPositionChangedSignal;
393 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
395 return mInputFilteredSignal;
398 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
400 return mSelectionChangedSignal;
403 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
405 return mSelectionClearedSignal;
408 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
410 return mSelectionStartedSignal;
413 Text::ControllerPtr TextEditor::GetTextController()
418 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
420 Dali::BaseHandle handle(object);
422 bool connected(true);
423 Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
425 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
427 editor.TextChangedSignal().Connect(tracker, functor);
429 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
431 editor.InputStyleChangedSignal().Connect(tracker, functor);
433 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
437 Internal::TextEditor& editorImpl(GetImpl(editor));
438 editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
441 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
445 Internal::TextEditor& editorImpl(GetImpl(editor));
446 editorImpl.AnchorClickedSignal().Connect(tracker, functor);
449 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
453 Internal::TextEditor& editorImpl(GetImpl(editor));
454 editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
457 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
461 Internal::TextEditor& editorImpl(GetImpl(editor));
462 editorImpl.InputFilteredSignal().Connect(tracker, functor);
465 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
469 Internal::TextEditor& editorImpl(GetImpl(editor));
470 editorImpl.SelectionChangedSignal().Connect(tracker, functor);
473 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
477 Internal::TextEditor& editorImpl(GetImpl(editor));
478 editorImpl.SelectionClearedSignal().Connect(tracker, functor);
481 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
485 Internal::TextEditor& editorImpl(GetImpl(editor));
486 editorImpl.SelectionStartedSignal().Connect(tracker, functor);
491 // signalName does not match any signal
498 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
500 return mTextChangedSignal;
503 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
505 return mInputStyleChangedSignal;
508 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
510 return mScrollStateChangedSignal;
513 void TextEditor::OnAccessibilityStatusChanged()
515 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
518 void TextEditor::OnInitialize()
522 mController = Text::Controller::New(this, this, this, this);
524 mDecorator = Text::Decorator::New(*mController,
527 mInputMethodContext = InputMethodContext::New(self);
529 mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
531 // Enables the text input.
532 mController->EnableTextInput(mDecorator, mInputMethodContext);
534 // Enables the vertical scrolling after the text input has been enabled.
535 mController->SetVerticalScrollEnabled(true);
537 // Disables the horizontal scrolling.
538 mController->SetHorizontalScrollEnabled(false);
540 // Sets the maximum number of characters.
541 mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
543 // Enable the smooth handle panning.
544 mController->SetSmoothHandlePanEnabled(true);
546 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
547 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
549 // Sets layoutDirection value
550 Dali::Stage stage = Dali::Stage::GetCurrent();
551 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
552 mController->SetLayoutDirection(layoutDirection);
554 self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
556 // Forward input events to controller
557 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
558 GetTapGestureDetector().SetMaximumTapsRequired(2);
559 GetTapGestureDetector().ReceiveAllTapEvents(true);
561 self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
563 // Set BoundingBox to stage size if not already set.
564 Rect<int> boundingBox;
565 mDecorator->GetBoundingBox(boundingBox);
567 if(boundingBox.IsEmpty())
569 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
570 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
573 // Whether to flip the selection handles as soon as they cross.
574 mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
576 // Set the default scroll speed.
577 mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
579 // Fill-parent area by default
580 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
581 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
582 self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
584 //Enable highightability
585 self.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
587 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
589 // Creates an extra control to be used as stencil buffer.
590 mStencil = Control::New();
591 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
592 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
594 // Creates a background visual. Even if the color is transparent it updates the stencil.
595 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
596 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
598 // Enable the clipping property.
599 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
600 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
604 DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) {
605 return std::unique_ptr<Dali::Accessibility::Accessible>(
606 new AccessibleImpl(actor, Dali::Accessibility::Role::ENTRY));
609 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
610 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
613 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
615 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
619 case StyleChange::DEFAULT_FONT_CHANGE:
621 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
622 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
623 // Property system did not set the font so should update it.
624 mController->UpdateAfterFontChange(newFont);
629 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
631 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
635 case StyleChange::THEME_CHANGE:
637 // Nothing to do, let control base class handle this
642 // Up call to Control
643 Control::OnStyleChange(styleManager, change);
646 Vector3 TextEditor::GetNaturalSize()
649 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
651 Vector3 naturalSize = mController->GetNaturalSize();
652 naturalSize.width += (padding.start + padding.end);
653 naturalSize.height += (padding.top + padding.bottom);
658 float TextEditor::GetHeightForWidth(float width)
661 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
662 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
665 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
667 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
669 actor.SetProperty(Actor::Property::SIZE, size);
673 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
675 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
680 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
682 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
684 // Support Right-To-Left of padding
685 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
687 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
689 std::swap(padding.start, padding.end);
694 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
695 ResizeActor(mStencil, contentSize);
699 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
700 ResizeActor(mActiveLayer, contentSize);
703 // If there is text changed, callback is called.
706 EmitTextChangedSignal();
709 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
711 if((Text::Controller::NONE_UPDATED != updateTextType) ||
714 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
717 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
719 mDecorator->Relayout(contentSize);
724 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
727 RenderText(updateTextType);
730 if(mCursorPositionChanged)
732 EmitCursorPositionChangedSignal();
735 if(mSelectionStarted)
737 EmitSelectionStartedSignal();
740 if(mSelectionChanged)
742 EmitSelectionChangedSignal();
745 if(mSelectionCleared)
747 EmitSelectionClearedSignal();
750 // The text-editor emits signals when the input style changes. These changes of style are
751 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
752 // can't be emitted during the size negotiation as the callbacks may update the UI.
753 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
754 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
756 if(Adaptor::IsAvailable())
758 Adaptor& adaptor = Adaptor::Get();
760 if(NULL == mIdleCallback)
762 // @note: The callback manager takes the ownership of the callback object.
763 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
764 adaptor.AddIdle(mIdleCallback, false);
770 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
772 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
775 ApplyScrollPosition();
780 void TextEditor::OnKeyInputFocusGained()
782 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
783 if(mInputMethodContext && IsEditable())
785 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
786 mInputMethodContext.ApplyOptions(mInputMethodOptions);
787 mInputMethodContext.NotifyTextInputMultiLine(true);
789 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
791 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
793 // Notify that the text editing start.
794 mInputMethodContext.Activate();
796 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
797 mInputMethodContext.SetRestoreAfterFocusLost(true);
799 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
803 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
806 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
808 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
811 void TextEditor::OnKeyInputFocusLost()
813 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
814 if(mInputMethodContext)
816 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
818 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
819 mInputMethodContext.SetRestoreAfterFocusLost(false);
821 // Notify that the text editing finish.
822 mInputMethodContext.Deactivate();
824 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
826 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
830 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
833 mController->KeyboardFocusLostEvent();
835 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
838 bool TextEditor::OnAccessibilityActivated()
844 void TextEditor::OnTap(const TapGesture& gesture)
846 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
847 if(mInputMethodContext && IsEditable())
849 mInputMethodContext.Activate();
851 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
853 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
854 const Vector2& localPoint = gesture.GetLocalPoint();
855 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
856 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
861 void TextEditor::OnPan(const PanGesture& gesture)
863 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
866 void TextEditor::OnLongPress(const LongPressGesture& gesture)
868 if(mInputMethodContext && IsEditable())
870 mInputMethodContext.Activate();
873 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
874 const Vector2& localPoint = gesture.GetLocalPoint();
875 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
880 bool TextEditor::OnKeyEvent(const KeyEvent& event)
882 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
884 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
886 // Make sure ClearKeyInputFocus when only key is up
887 if(event.GetState() == KeyEvent::UP)
889 ClearKeyInputFocus();
895 return mController->KeyEvent(event);
898 void TextEditor::RequestTextRelayout()
903 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
905 if(Accessibility::IsUp())
907 Control::Impl::GetAccessibilityObject(Self())->EmitTextInserted(position, length, content);
911 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
913 if(Accessibility::IsUp())
915 Control::Impl::GetAccessibilityObject(Self())->EmitTextDeleted(position, length, content);
919 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
921 if(Accessibility::IsUp())
923 Control::Impl::GetAccessibilityObject(Self())->EmitTextCursorMoved(newPosition);
926 if((oldPosition != newPosition) && !mCursorPositionChanged)
928 mCursorPositionChanged = true;
929 mOldPosition = oldPosition;
933 void TextEditor::TextChanged(bool immediate)
935 if(immediate) // Emits TextChangedSignal immediately
937 EmitTextChangedSignal();
945 void TextEditor::EmitTextChangedSignal()
947 Dali::Toolkit::TextEditor handle(GetOwner());
948 mTextChangedSignal.Emit(handle);
949 mTextChanged = false;
952 void TextEditor::MaxLengthReached()
954 Dali::Toolkit::TextEditor handle(GetOwner());
955 mMaxLengthReachedSignal.Emit(handle);
958 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
960 Dali::Toolkit::TextEditor handle(GetOwner());
961 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
964 void TextEditor::AnchorClicked(const std::string& href)
966 Dali::Toolkit::TextEditor handle(GetOwner());
967 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
970 void TextEditor::EmitCursorPositionChangedSignal()
972 Dali::Toolkit::TextEditor handle(GetOwner());
973 mCursorPositionChanged = false;
974 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
977 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
979 Dali::Toolkit::TextEditor handle(GetOwner());
980 mInputFilteredSignal.Emit(handle, type);
983 void TextEditor::EmitSelectionChangedSignal()
985 Dali::Toolkit::TextEditor handle(GetOwner());
986 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
987 mSelectionChanged = false;
990 void TextEditor::EmitSelectionClearedSignal()
992 Dali::Toolkit::TextEditor handle(GetOwner());
993 mSelectionClearedSignal.Emit(handle);
994 mSelectionCleared = false;
997 void TextEditor::EmitSelectionStartedSignal()
999 Dali::Toolkit::TextEditor handle(GetOwner());
1000 mSelectionStartedSignal.Emit(handle);
1001 mSelectionStarted = false;
1004 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1006 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1008 if(newStart == newEnd)
1010 mSelectionCleared = true;
1014 if(oldStart == oldEnd)
1016 mSelectionStarted = true;
1020 mSelectionChanged = true;
1021 mOldSelectionStart = oldStart;
1022 mOldSelectionEnd = oldEnd;
1024 if(mOldSelectionStart > mOldSelectionEnd)
1027 uint32_t temp = mOldSelectionStart;
1028 mOldSelectionStart = mOldSelectionEnd;
1029 mOldSelectionEnd = temp;
1034 void TextEditor::AddDecoration(Actor& actor, bool needsClipping)
1040 mClippingDecorationActors.push_back(actor);
1044 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1045 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1047 mActiveLayer = actor;
1052 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1054 if(mController && mController->IsShowingRealText())
1056 mController->SetTextSelectionRange(start, end);
1061 Uint32Pair TextEditor::GetTextSelectionRange() const
1063 Uint32Pair range(0, 0);
1064 if(mController && mController->IsShowingRealText())
1066 range = mController->GetTextSelectionRange();
1071 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1073 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1074 Property::Map* resultMap = propValue.GetMap();
1076 Property::Value* colorValue = nullptr;
1077 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1079 colorValue->Get(color);
1083 void TextEditor::UpdateScrollBar()
1085 using namespace Dali;
1087 float scrollPosition;
1090 bool latestScrolled;
1092 if(!mScrollBarEnabled)
1096 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1097 if(!latestScrolled || controlSize > layoutSize)
1102 CustomActor self = Self();
1105 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1106 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1107 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1108 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1109 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1110 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1112 // Register the scroll position property
1113 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1114 // Register the minimum scroll position property
1115 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1116 // Register the maximum scroll position property
1117 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1118 // Register the scroll content size property
1119 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1121 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1123 // Set style name of ScrollBar for styling
1124 mScrollBar.SetStyleName("TextEditorScrollBar");
1125 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1128 // Set style name of ScrollBarIndicator for styling
1129 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1132 self.Add(mScrollBar);
1136 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1137 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1138 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1140 self.SetProperty(propertyScrollPosition, scrollPosition);
1141 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1142 self.SetProperty(propertyScrollContentSize, layoutSize);
1145 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1148 mScrollStarted = true;
1149 Dali::Toolkit::TextEditor handle(GetOwner());
1150 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1153 Actor indicator = mScrollBar.GetScrollIndicator();
1156 mAnimation.Stop(); // Cancel any animation
1160 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1162 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1163 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1165 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1168 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1170 // If animation is successfully ended, then emit ScrollStateChangedSignal
1171 if(animation.GetCurrentProgress() == 0.0f)
1173 mScrollStarted = false;
1174 Dali::Toolkit::TextEditor handle(GetOwner());
1175 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1179 void TextEditor::OnSceneConnect(Dali::Actor actor)
1183 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1187 mHasBeenStaged = true;
1191 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1193 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1194 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1197 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1202 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1208 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1210 mController->PasteClipboardItemEvent();
1213 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1215 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1217 // Just hide the grab handle when keyboard is hidden.
1220 mController->KeyboardFocusLostEvent();
1224 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1228 void TextEditor::OnSceneConnection(int depth)
1230 // Sets the depth to the visuals inside the text's decorator.
1231 mDecorator->SetTextDepth(depth);
1233 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1235 // Call the Control::OnSceneConnection() to set the depth of the background.
1236 Control::OnSceneConnection(depth);
1239 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1244 void TextEditor::OnIdleSignal()
1246 // Emits the change of input style signals.
1247 mController->ProcessInputStyleChangedSignals();
1249 // Set the pointer to null as the callback manager deletes the callback after execute it.
1250 mIdleCallback = NULL;
1253 void TextEditor::ApplyScrollPosition()
1255 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1256 float scrollAmount = 0.0f;
1258 if(mScrollAnimationEnabled)
1260 scrollAmount = mController->GetScrollAmountByUserInput();
1262 if(mTextVerticalScroller)
1264 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1266 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1268 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1272 mTextVerticalScroller = Text::TextVerticalScroller::New();
1273 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1275 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1277 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1281 bool TextEditor::IsEditable() const
1283 return mController->IsEditable();
1286 void TextEditor::SetEditable(bool editable)
1288 mController->SetEditable(editable);
1289 if(mInputMethodContext && !editable)
1291 mInputMethodContext.Deactivate();
1295 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1297 mController->ChangedLayoutDirection();
1300 TextEditor::TextEditor()
1301 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1302 mAnimationPeriod(0.0f, 0.0f),
1303 mIdleCallback(NULL),
1304 mAlignmentOffset(0.f),
1305 mScrollAnimationDuration(0.f),
1307 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1308 mHasBeenStaged(false),
1309 mScrollAnimationEnabled(false),
1310 mScrollBarEnabled(false),
1311 mScrollStarted(false),
1312 mTextChanged(false),
1313 mCursorPositionChanged(false),
1314 mSelectionChanged(false),
1315 mSelectionCleared(false),
1317 mOldSelectionStart(0u),
1318 mOldSelectionEnd(0u),
1319 mSelectionStarted(false)
1323 TextEditor::~TextEditor()
1325 UnparentAndReset(mStencil);
1327 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1329 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1330 Adaptor::Get().RemoveIdle(mIdleCallback);
1334 std::string TextEditor::AccessibleImpl::GetName() const
1336 auto self = Toolkit::TextEditor::DownCast(Self());
1337 return self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1340 std::string TextEditor::AccessibleImpl::GetText(size_t startOffset, size_t endOffset) const
1342 if(endOffset <= startOffset)
1347 auto self = Toolkit::TextEditor::DownCast(Self());
1348 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1350 if(startOffset > text.size() || endOffset > text.size())
1355 return text.substr(startOffset, endOffset - startOffset);
1358 size_t TextEditor::AccessibleImpl::GetCharacterCount() const
1360 auto self = Toolkit::TextEditor::DownCast(Self());
1361 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1366 size_t TextEditor::AccessibleImpl::GetCursorOffset() const
1368 auto slf = Toolkit::TextEditor::DownCast(Self());
1369 return Dali::Toolkit::GetImpl(slf).GetTextController()->GetCursorPosition();
1372 bool TextEditor::AccessibleImpl::SetCursorOffset(size_t offset)
1374 auto slf = Toolkit::TextEditor::DownCast(Self());
1375 auto txt = slf.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1376 if(offset > txt.size())
1381 auto& slfImpl = Dali::Toolkit::GetImpl(slf);
1382 slfImpl.GetTextController()->ResetCursorPosition(offset);
1383 slfImpl.RequestTextRelayout();
1388 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetTextAtOffset(size_t offset, Dali::Accessibility::TextBoundary boundary) const
1390 auto self = Toolkit::TextEditor::DownCast(Self());
1391 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1392 auto textSize = text.size();
1394 auto range = Dali::Accessibility::Range{};
1398 case Dali::Accessibility::TextBoundary::CHARACTER:
1400 if(offset < textSize)
1402 range.content = text[offset];
1403 range.startOffset = offset;
1404 range.endOffset = offset + 1;
1408 case Dali::Accessibility::TextBoundary::WORD:
1409 case Dali::Accessibility::TextBoundary::LINE:
1411 auto textString = text.c_str();
1412 auto breaks = std::vector<char>(textSize, 0);
1414 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1416 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1420 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1425 while(index < textSize && counter <= offset)
1430 while(breaks[index])
1438 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1442 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1448 if((counter > 0) && ((counter - 1) == offset))
1450 range.content = text.substr(start, index - start + 1);
1451 range.startOffset = start;
1452 range.endOffset = index + 1;
1455 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1462 case Dali::Accessibility::TextBoundary::SENTENCE:
1464 /* not supported by default */
1467 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1469 /* Paragraph is not supported by libunibreak library */
1479 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetRangeOfSelection(size_t selectionIndex) const
1481 // Since DALi supports only one selection indexes higher than 0 are ignored
1482 if(selectionIndex > 0)
1487 auto self = Toolkit::TextEditor::DownCast(Self());
1488 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1489 std::string value{};
1490 controller->RetrieveSelection(value);
1491 auto indices = controller->GetSelectionIndexes();
1493 return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
1496 bool TextEditor::AccessibleImpl::RemoveSelection(size_t selectionIndex)
1498 // Since DALi supports only one selection indexes higher than 0 are ignored
1499 if(selectionIndex > 0)
1504 auto self = Toolkit::TextEditor::DownCast(Self());
1505 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1509 bool TextEditor::AccessibleImpl::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1511 // Since DALi supports only one selection indexes higher than 0 are ignored
1512 if(selectionIndex > 0)
1517 auto self = Toolkit::TextEditor::DownCast(Self());
1518 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1522 bool TextEditor::AccessibleImpl::CopyText(size_t startPosition, size_t endPosition)
1524 if(endPosition <= startPosition)
1529 auto self = Toolkit::TextEditor::DownCast(Self());
1530 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1531 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1536 bool TextEditor::AccessibleImpl::CutText(size_t startPosition, size_t endPosition)
1538 if(endPosition <= startPosition)
1543 auto self = Toolkit::TextEditor::DownCast(Self());
1544 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1545 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1547 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1552 bool TextEditor::AccessibleImpl::DeleteText(size_t startPosition, size_t endPosition)
1554 if(endPosition <= startPosition)
1559 auto self = Toolkit::TextEditor::DownCast(Self());
1560 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1562 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1567 Dali::Accessibility::States TextEditor::AccessibleImpl::CalculateStates()
1569 using namespace Dali::Accessibility;
1571 auto states = DevelControl::ControlAccessible::CalculateStates();
1572 states[State::EDITABLE] = true;
1573 states[State::FOCUSABLE] = true;
1575 Toolkit::Control focusControl = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
1576 if(Self() == focusControl)
1578 states[State::FOCUSED] = true;
1584 bool TextEditor::AccessibleImpl::InsertText(size_t startPosition, std::string text)
1586 auto self = Toolkit::TextEditor::DownCast(Self());
1587 auto insertedText = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1589 insertedText.insert(startPosition, text);
1591 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(insertedText));
1596 bool TextEditor::AccessibleImpl::SetTextContents(std::string newContents)
1598 auto self = Toolkit::TextEditor::DownCast(Self());
1599 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(newContents));
1603 int32_t TextEditor::AccessibleImpl::GetLinkCount() const
1605 auto self = Toolkit::TextEditor::DownCast(Self());
1606 return Dali::Toolkit::GetImpl(self).mAnchorActors.size();
1609 Accessibility::Hyperlink* TextEditor::AccessibleImpl::GetLink(int32_t linkIndex) const
1611 if(linkIndex < 0 || linkIndex >= GetLinkCount())
1615 auto self = Toolkit::TextEditor::DownCast(Self());
1616 auto anchorActor = Dali::Toolkit::GetImpl(self).mAnchorActors[linkIndex];
1617 return dynamic_cast<Accessibility::Hyperlink*>(Dali::Accessibility::Accessible::Get(anchorActor));
1620 int32_t TextEditor::AccessibleImpl::GetLinkIndex(int32_t characterOffset) const
1622 auto self = Toolkit::TextEditor::DownCast(Self());
1623 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1624 return controller->GetAnchorIndex(static_cast<size_t>(characterOffset));
1627 } // namespace Internal
1629 } // namespace Toolkit