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 )
160 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "characterSpacing", FLOAT, CHARACTER_SPACING )
162 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged", SIGNAL_TEXT_CHANGED )
163 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged", SIGNAL_INPUT_STYLE_CHANGED )
164 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached", SIGNAL_MAX_LENGTH_REACHED )
165 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked", SIGNAL_ANCHOR_CLICKED )
166 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered", SIGNAL_INPUT_FILTERED )
167 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged", SIGNAL_SELECTION_CHANGED )
169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared", SIGNAL_SELECTION_CLEARED )
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 Text::ControllerPtr TextEditor::GetTextController()
413 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
415 Dali::BaseHandle handle(object);
417 bool connected(true);
418 Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
420 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
422 editor.TextChangedSignal().Connect(tracker, functor);
424 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
426 editor.InputStyleChangedSignal().Connect(tracker, functor);
428 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
432 Internal::TextEditor& editorImpl(GetImpl(editor));
433 editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
436 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
440 Internal::TextEditor& editorImpl(GetImpl(editor));
441 editorImpl.AnchorClickedSignal().Connect(tracker, functor);
444 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
448 Internal::TextEditor& editorImpl(GetImpl(editor));
449 editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
452 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
456 Internal::TextEditor& editorImpl(GetImpl(editor));
457 editorImpl.InputFilteredSignal().Connect(tracker, functor);
460 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
464 Internal::TextEditor& editorImpl(GetImpl(editor));
465 editorImpl.SelectionChangedSignal().Connect(tracker, functor);
468 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
472 Internal::TextEditor& editorImpl(GetImpl(editor));
473 editorImpl.SelectionClearedSignal().Connect(tracker, functor);
478 // signalName does not match any signal
485 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
487 return mTextChangedSignal;
490 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
492 return mInputStyleChangedSignal;
495 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
497 return mScrollStateChangedSignal;
500 void TextEditor::OnAccessibilityStatusChanged()
502 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
505 void TextEditor::OnInitialize()
509 mController = Text::Controller::New(this, this, this, this);
511 mDecorator = Text::Decorator::New(*mController,
514 mInputMethodContext = InputMethodContext::New(self);
516 mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
518 // Enables the text input.
519 mController->EnableTextInput(mDecorator, mInputMethodContext);
521 // Enables the vertical scrolling after the text input has been enabled.
522 mController->SetVerticalScrollEnabled(true);
524 // Disables the horizontal scrolling.
525 mController->SetHorizontalScrollEnabled(false);
527 // Sets the maximum number of characters.
528 mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
530 // Enable the smooth handle panning.
531 mController->SetSmoothHandlePanEnabled(true);
533 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
534 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
536 // Sets layoutDirection value
537 Dali::Stage stage = Dali::Stage::GetCurrent();
538 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
539 mController->SetLayoutDirection(layoutDirection);
541 self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
543 // Forward input events to controller
544 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
545 GetTapGestureDetector().SetMaximumTapsRequired(2);
546 GetTapGestureDetector().ReceiveAllTapEvents(true);
548 self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
550 // Set BoundingBox to stage size if not already set.
551 Rect<int> boundingBox;
552 mDecorator->GetBoundingBox(boundingBox);
554 if(boundingBox.IsEmpty())
556 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
557 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
560 // Whether to flip the selection handles as soon as they cross.
561 mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
563 // Set the default scroll speed.
564 mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
566 // Fill-parent area by default
567 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
568 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
569 self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
571 //Enable highightability
572 self.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
574 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
576 // Creates an extra control to be used as stencil buffer.
577 mStencil = Control::New();
578 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
579 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
581 // Creates a background visual. Even if the color is transparent it updates the stencil.
582 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
583 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
585 // Enable the clipping property.
586 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
587 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
591 DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) {
592 return std::unique_ptr<Dali::Accessibility::Accessible>(
593 new AccessibleImpl(actor, Dali::Accessibility::Role::ENTRY));
596 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
597 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
600 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
602 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
606 case StyleChange::DEFAULT_FONT_CHANGE:
608 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
609 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
610 // Property system did not set the font so should update it.
611 mController->UpdateAfterFontChange(newFont);
616 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
618 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
622 case StyleChange::THEME_CHANGE:
624 // Nothing to do, let control base class handle this
629 // Up call to Control
630 Control::OnStyleChange(styleManager, change);
633 Vector3 TextEditor::GetNaturalSize()
636 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
638 Vector3 naturalSize = mController->GetNaturalSize();
639 naturalSize.width += (padding.start + padding.end);
640 naturalSize.height += (padding.top + padding.bottom);
645 float TextEditor::GetHeightForWidth(float width)
648 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
649 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
652 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
654 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
656 actor.SetProperty(Actor::Property::SIZE, size);
660 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
662 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
667 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
669 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
671 // Support Right-To-Left of padding
672 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
674 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
676 std::swap(padding.start, padding.end);
681 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
682 ResizeActor(mStencil, contentSize);
686 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
687 ResizeActor(mActiveLayer, contentSize);
690 // If there is text changed, callback is called.
693 EmitTextChangedSignal();
696 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
698 if((Text::Controller::NONE_UPDATED != updateTextType) ||
701 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
704 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
706 mDecorator->Relayout(contentSize);
711 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
714 RenderText(updateTextType);
717 if(mCursorPositionChanged)
719 EmitCursorPositionChangedSignal();
722 if(mSelectionChanged)
724 EmitSelectionChangedSignal();
727 if(mSelectionCleared)
729 EmitSelectionClearedSignal();
732 // The text-editor emits signals when the input style changes. These changes of style are
733 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
734 // can't be emitted during the size negotiation as the callbacks may update the UI.
735 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
736 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
738 if(Adaptor::IsAvailable())
740 Adaptor& adaptor = Adaptor::Get();
742 if(NULL == mIdleCallback)
744 // @note: The callback manager takes the ownership of the callback object.
745 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
746 adaptor.AddIdle(mIdleCallback, false);
752 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
754 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
757 ApplyScrollPosition();
762 void TextEditor::OnKeyInputFocusGained()
764 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
765 if(mInputMethodContext && IsEditable())
767 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
768 mInputMethodContext.ApplyOptions(mInputMethodOptions);
769 mInputMethodContext.NotifyTextInputMultiLine(true);
771 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
773 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
775 // Notify that the text editing start.
776 mInputMethodContext.Activate();
778 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
779 mInputMethodContext.SetRestoreAfterFocusLost(true);
781 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
785 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
788 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
790 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
793 void TextEditor::OnKeyInputFocusLost()
795 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
796 if(mInputMethodContext)
798 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
800 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
801 mInputMethodContext.SetRestoreAfterFocusLost(false);
803 // Notify that the text editing finish.
804 mInputMethodContext.Deactivate();
806 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
808 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
812 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
815 mController->KeyboardFocusLostEvent();
817 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
820 bool TextEditor::OnAccessibilityActivated()
826 void TextEditor::OnTap(const TapGesture& gesture)
828 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
829 if(mInputMethodContext && IsEditable())
831 mInputMethodContext.Activate();
833 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
835 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
836 const Vector2& localPoint = gesture.GetLocalPoint();
837 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
838 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
843 void TextEditor::OnPan(const PanGesture& gesture)
845 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
848 void TextEditor::OnLongPress(const LongPressGesture& gesture)
850 if(mInputMethodContext && IsEditable())
852 mInputMethodContext.Activate();
855 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
856 const Vector2& localPoint = gesture.GetLocalPoint();
857 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
862 bool TextEditor::OnKeyEvent(const KeyEvent& event)
864 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
866 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
868 // Make sure ClearKeyInputFocus when only key is up
869 if(event.GetState() == KeyEvent::UP)
871 ClearKeyInputFocus();
877 return mController->KeyEvent(event);
880 void TextEditor::RequestTextRelayout()
885 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
887 if(Accessibility::IsUp())
889 Control::Impl::GetAccessibilityObject(Self())->EmitTextInserted(position, length, content);
893 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
895 if(Accessibility::IsUp())
897 Control::Impl::GetAccessibilityObject(Self())->EmitTextDeleted(position, length, content);
901 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
903 if(Accessibility::IsUp())
905 Control::Impl::GetAccessibilityObject(Self())->EmitTextCursorMoved(newPosition);
908 if((oldPosition != newPosition) && !mCursorPositionChanged)
910 mCursorPositionChanged = true;
911 mOldPosition = oldPosition;
915 void TextEditor::TextChanged(bool immediate)
917 if(immediate) // Emits TextChangedSignal immediately
919 EmitTextChangedSignal();
927 void TextEditor::EmitTextChangedSignal()
929 Dali::Toolkit::TextEditor handle(GetOwner());
930 mTextChangedSignal.Emit(handle);
931 mTextChanged = false;
934 void TextEditor::MaxLengthReached()
936 Dali::Toolkit::TextEditor handle(GetOwner());
937 mMaxLengthReachedSignal.Emit(handle);
940 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
942 Dali::Toolkit::TextEditor handle(GetOwner());
943 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
946 void TextEditor::AnchorClicked(const std::string& href)
948 Dali::Toolkit::TextEditor handle(GetOwner());
949 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
952 void TextEditor::EmitCursorPositionChangedSignal()
954 Dali::Toolkit::TextEditor handle(GetOwner());
955 mCursorPositionChanged = false;
956 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
959 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
961 Dali::Toolkit::TextEditor handle(GetOwner());
962 mInputFilteredSignal.Emit(handle, type);
965 void TextEditor::EmitSelectionChangedSignal()
967 Dali::Toolkit::TextEditor handle(GetOwner());
968 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
969 mSelectionChanged = false;
972 void TextEditor::EmitSelectionClearedSignal()
974 Dali::Toolkit::TextEditor handle(GetOwner());
975 mSelectionClearedSignal.Emit(handle);
976 mSelectionCleared = false;
979 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
981 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
983 if(newStart == newEnd)
985 mSelectionCleared = true;
988 mSelectionChanged = true;
989 mOldSelectionStart = oldStart;
990 mOldSelectionEnd = oldEnd;
992 if(mOldSelectionStart > mOldSelectionEnd)
995 uint32_t temp = mOldSelectionStart;
996 mOldSelectionStart = mOldSelectionEnd;
997 mOldSelectionEnd = temp;
1002 void TextEditor::AddDecoration(Actor& actor, bool needsClipping)
1008 mClippingDecorationActors.push_back(actor);
1012 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1013 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1015 mActiveLayer = actor;
1020 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1022 if(mController && mController->IsShowingRealText())
1024 mController->SetTextSelectionRange(start, end);
1029 Uint32Pair TextEditor::GetTextSelectionRange() const
1031 Uint32Pair range(0, 0);
1032 if(mController && mController->IsShowingRealText())
1034 range = mController->GetTextSelectionRange();
1039 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1041 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1042 Property::Map* resultMap = propValue.GetMap();
1044 Property::Value* colorValue = nullptr;
1045 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1047 colorValue->Get(color);
1051 void TextEditor::UpdateScrollBar()
1053 using namespace Dali;
1055 float scrollPosition;
1058 bool latestScrolled;
1060 if(!mScrollBarEnabled)
1064 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1065 if(!latestScrolled || controlSize > layoutSize)
1070 CustomActor self = Self();
1073 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1074 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1075 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1076 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1077 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1078 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1080 // Register the scroll position property
1081 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1082 // Register the minimum scroll position property
1083 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1084 // Register the maximum scroll position property
1085 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1086 // Register the scroll content size property
1087 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1089 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1091 // Set style name of ScrollBar for styling
1092 mScrollBar.SetStyleName("TextEditorScrollBar");
1093 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1096 // Set style name of ScrollBarIndicator for styling
1097 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1100 self.Add(mScrollBar);
1104 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1105 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1106 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1108 self.SetProperty(propertyScrollPosition, scrollPosition);
1109 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1110 self.SetProperty(propertyScrollContentSize, layoutSize);
1113 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1116 mScrollStarted = true;
1117 Dali::Toolkit::TextEditor handle(GetOwner());
1118 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1121 Actor indicator = mScrollBar.GetScrollIndicator();
1124 mAnimation.Stop(); // Cancel any animation
1128 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1130 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1131 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1133 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1136 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1138 // If animation is successfully ended, then emit ScrollStateChangedSignal
1139 if(animation.GetCurrentProgress() == 0.0f)
1141 mScrollStarted = false;
1142 Dali::Toolkit::TextEditor handle(GetOwner());
1143 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1147 void TextEditor::OnSceneConnect(Dali::Actor actor)
1151 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1155 mHasBeenStaged = true;
1159 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1161 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1162 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1165 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1170 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1176 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1178 mController->PasteClipboardItemEvent();
1181 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1183 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1185 // Just hide the grab handle when keyboard is hidden.
1188 mController->KeyboardFocusLostEvent();
1192 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1196 void TextEditor::OnSceneConnection(int depth)
1198 // Sets the depth to the visuals inside the text's decorator.
1199 mDecorator->SetTextDepth(depth);
1201 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1203 // Call the Control::OnSceneConnection() to set the depth of the background.
1204 Control::OnSceneConnection(depth);
1207 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1212 void TextEditor::OnIdleSignal()
1214 // Emits the change of input style signals.
1215 mController->ProcessInputStyleChangedSignals();
1217 // Set the pointer to null as the callback manager deletes the callback after execute it.
1218 mIdleCallback = NULL;
1221 void TextEditor::ApplyScrollPosition()
1223 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1224 float scrollAmount = 0.0f;
1226 if(mScrollAnimationEnabled)
1228 scrollAmount = mController->GetScrollAmountByUserInput();
1230 if(mTextVerticalScroller)
1232 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1234 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1236 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1240 mTextVerticalScroller = Text::TextVerticalScroller::New();
1241 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1243 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1245 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1249 bool TextEditor::IsEditable() const
1251 return mController->IsEditable();
1254 void TextEditor::SetEditable(bool editable)
1256 mController->SetEditable(editable);
1257 if(mInputMethodContext && !editable)
1259 mInputMethodContext.Deactivate();
1263 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1265 mController->ChangedLayoutDirection();
1268 TextEditor::TextEditor()
1269 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1270 mAnimationPeriod(0.0f, 0.0f),
1271 mIdleCallback(NULL),
1272 mAlignmentOffset(0.f),
1273 mScrollAnimationDuration(0.f),
1275 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1276 mHasBeenStaged(false),
1277 mScrollAnimationEnabled(false),
1278 mScrollBarEnabled(false),
1279 mScrollStarted(false),
1280 mTextChanged(false),
1281 mCursorPositionChanged(false),
1282 mSelectionChanged(false),
1283 mSelectionCleared(false),
1285 mOldSelectionStart(0u),
1286 mOldSelectionEnd(0u)
1290 TextEditor::~TextEditor()
1292 UnparentAndReset(mStencil);
1294 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1296 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1297 Adaptor::Get().RemoveIdle(mIdleCallback);
1301 std::string TextEditor::AccessibleImpl::GetName() const
1303 auto self = Toolkit::TextEditor::DownCast(Self());
1304 return self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1307 std::string TextEditor::AccessibleImpl::GetText(size_t startOffset, size_t endOffset) const
1309 if(endOffset <= startOffset)
1314 auto self = Toolkit::TextEditor::DownCast(Self());
1315 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1317 if(startOffset > text.size() || endOffset > text.size())
1322 return text.substr(startOffset, endOffset - startOffset);
1325 size_t TextEditor::AccessibleImpl::GetCharacterCount() const
1327 auto self = Toolkit::TextEditor::DownCast(Self());
1328 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1333 size_t TextEditor::AccessibleImpl::GetCursorOffset() const
1335 auto slf = Toolkit::TextEditor::DownCast(Self());
1336 return Dali::Toolkit::GetImpl(slf).GetTextController()->GetCursorPosition();
1339 bool TextEditor::AccessibleImpl::SetCursorOffset(size_t offset)
1341 auto slf = Toolkit::TextEditor::DownCast(Self());
1342 auto txt = slf.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1343 if(offset > txt.size())
1348 auto& slfImpl = Dali::Toolkit::GetImpl(slf);
1349 slfImpl.GetTextController()->ResetCursorPosition(offset);
1350 slfImpl.RequestTextRelayout();
1355 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetTextAtOffset(size_t offset, Dali::Accessibility::TextBoundary boundary) const
1357 auto self = Toolkit::TextEditor::DownCast(Self());
1358 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1359 auto textSize = text.size();
1361 auto range = Dali::Accessibility::Range{};
1365 case Dali::Accessibility::TextBoundary::CHARACTER:
1367 if(offset < textSize)
1369 range.content = text[offset];
1370 range.startOffset = offset;
1371 range.endOffset = offset + 1;
1375 case Dali::Accessibility::TextBoundary::WORD:
1376 case Dali::Accessibility::TextBoundary::LINE:
1378 auto textString = text.c_str();
1379 auto breaks = std::vector<char>(textSize, 0);
1381 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1383 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1387 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1392 while(index < textSize && counter <= offset)
1397 while(breaks[index])
1405 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1409 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1415 if((counter > 0) && ((counter - 1) == offset))
1417 range.content = text.substr(start, index - start + 1);
1418 range.startOffset = start;
1419 range.endOffset = index + 1;
1422 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1429 case Dali::Accessibility::TextBoundary::SENTENCE:
1431 /* not supported by default */
1434 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1436 /* Paragraph is not supported by libunibreak library */
1446 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetRangeOfSelection(size_t selectionIndex) const
1448 // Since DALi supports only one selection indexes higher than 0 are ignored
1449 if(selectionIndex > 0)
1454 auto self = Toolkit::TextEditor::DownCast(Self());
1455 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1456 std::string value{};
1457 controller->RetrieveSelection(value);
1458 auto indices = controller->GetSelectionIndexes();
1460 return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
1463 bool TextEditor::AccessibleImpl::RemoveSelection(size_t selectionIndex)
1465 // Since DALi supports only one selection indexes higher than 0 are ignored
1466 if(selectionIndex > 0)
1471 auto self = Toolkit::TextEditor::DownCast(Self());
1472 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1476 bool TextEditor::AccessibleImpl::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1478 // Since DALi supports only one selection indexes higher than 0 are ignored
1479 if(selectionIndex > 0)
1484 auto self = Toolkit::TextEditor::DownCast(Self());
1485 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1489 bool TextEditor::AccessibleImpl::CopyText(size_t startPosition, size_t endPosition)
1491 if(endPosition <= startPosition)
1496 auto self = Toolkit::TextEditor::DownCast(Self());
1497 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1498 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1503 bool TextEditor::AccessibleImpl::CutText(size_t startPosition, size_t endPosition)
1505 if(endPosition <= startPosition)
1510 auto self = Toolkit::TextEditor::DownCast(Self());
1511 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1512 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1514 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1519 bool TextEditor::AccessibleImpl::DeleteText(size_t startPosition, size_t endPosition)
1521 if(endPosition <= startPosition)
1526 auto self = Toolkit::TextEditor::DownCast(Self());
1527 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1529 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1534 Dali::Accessibility::States TextEditor::AccessibleImpl::CalculateStates()
1536 using namespace Dali::Accessibility;
1538 auto states = DevelControl::ControlAccessible::CalculateStates();
1539 states[State::EDITABLE] = true;
1540 states[State::FOCUSABLE] = true;
1542 Toolkit::Control focusControl = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
1543 if(Self() == focusControl)
1545 states[State::FOCUSED] = true;
1551 bool TextEditor::AccessibleImpl::InsertText(size_t startPosition, std::string text)
1553 auto self = Toolkit::TextEditor::DownCast(Self());
1554 auto insertedText = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1556 insertedText.insert(startPosition, text);
1558 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(insertedText));
1563 bool TextEditor::AccessibleImpl::SetTextContents(std::string newContents)
1565 auto self = Toolkit::TextEditor::DownCast(Self());
1566 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(newContents));
1570 int32_t TextEditor::AccessibleImpl::GetLinkCount() const
1572 auto self = Toolkit::TextEditor::DownCast(Self());
1573 return Dali::Toolkit::GetImpl(self).mAnchorActors.size();
1576 Accessibility::Hyperlink* TextEditor::AccessibleImpl::GetLink(int32_t linkIndex) const
1578 if(linkIndex < 0 || linkIndex >= GetLinkCount())
1582 auto self = Toolkit::TextEditor::DownCast(Self());
1583 auto anchorActor = Dali::Toolkit::GetImpl(self).mAnchorActors[linkIndex];
1584 return dynamic_cast<Accessibility::Hyperlink*>(Dali::Accessibility::Accessible::Get(anchorActor));
1587 int32_t TextEditor::AccessibleImpl::GetLinkIndex(int32_t characterOffset) const
1589 auto self = Toolkit::TextEditor::DownCast(Self());
1590 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1591 return controller->GetAnchorIndex(static_cast<size_t>(characterOffset));
1594 } // namespace Internal
1596 } // namespace Toolkit