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 )
161 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "relativeLineSize", FLOAT, RELATIVE_LINE_SIZE )
163 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged", SIGNAL_TEXT_CHANGED )
164 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged", SIGNAL_INPUT_STYLE_CHANGED )
165 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached", SIGNAL_MAX_LENGTH_REACHED )
166 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked", SIGNAL_ANCHOR_CLICKED )
167 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered", SIGNAL_INPUT_FILTERED )
168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged", SIGNAL_SELECTION_CHANGED )
170 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared", SIGNAL_SELECTION_CLEARED )
171 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionStarted", SIGNAL_SELECTION_STARTED )
173 DALI_TYPE_REGISTRATION_END()
176 Toolkit::TextEditor::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
178 Toolkit::TextEditor::InputStyle::Mask editorInputStyleMask = Toolkit::TextEditor::InputStyle::NONE;
180 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
182 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::COLOR);
184 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
186 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_FAMILY);
188 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
190 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::POINT_SIZE);
192 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
194 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
196 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
198 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
200 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
202 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
204 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_LINE_SPACING))
206 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::LINE_SPACING);
208 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
210 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::UNDERLINE);
212 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
214 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::SHADOW);
216 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
218 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::EMBOSS);
220 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
222 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::OUTLINE);
224 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_STRIKETHROUGH))
226 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::STRIKETHROUGH);
229 return editorInputStyleMask;
234 Toolkit::TextEditor TextEditor::New()
236 // Create the implementation, temporarily owned by this handle on stack
237 IntrusivePtr<TextEditor> impl = new TextEditor();
239 // Pass ownership to CustomActor handle
240 Toolkit::TextEditor handle(*impl);
242 // Second-phase init of the implementation
243 // This can only be done after the CustomActor connection has been made...
249 void TextEditor::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
251 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
253 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor SetProperty\n");
257 PropertyHandler::SetProperty(textEditor, index, value);
261 Property::Value TextEditor::GetProperty(BaseObject* object, Property::Index index)
263 Property::Value value;
265 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
269 value = PropertyHandler::GetProperty(textEditor, index);
274 void TextEditor::SelectWholeText()
276 if(mController && mController->IsShowingRealText())
278 mController->SelectWholeText();
283 void TextEditor::SelectNone()
285 if(mController && mController->IsShowingRealText())
287 mController->SelectNone();
291 void TextEditor::SelectText(const uint32_t start, const uint32_t end)
293 if(mController && mController->IsShowingRealText())
295 mController->SelectText(start, end);
300 string TextEditor::CopyText()
302 string copiedText = "";
303 if(mController && mController->IsShowingRealText())
305 copiedText = mController->CopyText();
310 string TextEditor::CutText()
313 if(mController && mController->IsShowingRealText())
315 cutText = mController->CutText();
320 void TextEditor::PasteText()
324 SetKeyInputFocus(); //Giving focus to the editor that was passed to the PasteText in case the passed editor (current editor) doesn't have focus.
325 mController->PasteText();
329 void TextEditor::ScrollBy(Vector2 scroll)
331 if(mController && mController->IsShowingRealText())
333 mController->ScrollBy(scroll);
337 float TextEditor::GetHorizontalScrollPosition()
339 if(mController && mController->IsShowingRealText())
341 return mController->GetHorizontalScrollPosition();
346 float TextEditor::GetVerticalScrollPosition()
348 if(mController && mController->IsShowingRealText())
350 return mController->GetVerticalScrollPosition();
355 Vector<Vector2> TextEditor::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
357 return mController->GetTextSize(startIndex, endIndex);
360 Vector<Vector2> TextEditor::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
362 return mController->GetTextPosition(startIndex, endIndex);
365 string TextEditor::GetSelectedText() const
367 string selectedText = "";
368 if(mController && mController->IsShowingRealText())
370 selectedText = mController->GetSelectedText();
375 InputMethodContext TextEditor::GetInputMethodContext()
377 return mInputMethodContext;
380 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
382 return mMaxLengthReachedSignal;
385 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
387 return mAnchorClickedSignal;
390 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
392 return mCursorPositionChangedSignal;
395 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
397 return mInputFilteredSignal;
400 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
402 return mSelectionChangedSignal;
405 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
407 return mSelectionClearedSignal;
410 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
412 return mSelectionStartedSignal;
415 Text::ControllerPtr TextEditor::GetTextController()
420 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
422 Dali::BaseHandle handle(object);
424 bool connected(true);
425 Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
427 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
429 editor.TextChangedSignal().Connect(tracker, functor);
431 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
433 editor.InputStyleChangedSignal().Connect(tracker, functor);
435 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
439 Internal::TextEditor& editorImpl(GetImpl(editor));
440 editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
443 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
447 Internal::TextEditor& editorImpl(GetImpl(editor));
448 editorImpl.AnchorClickedSignal().Connect(tracker, functor);
451 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
455 Internal::TextEditor& editorImpl(GetImpl(editor));
456 editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
459 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
463 Internal::TextEditor& editorImpl(GetImpl(editor));
464 editorImpl.InputFilteredSignal().Connect(tracker, functor);
467 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
471 Internal::TextEditor& editorImpl(GetImpl(editor));
472 editorImpl.SelectionChangedSignal().Connect(tracker, functor);
475 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
479 Internal::TextEditor& editorImpl(GetImpl(editor));
480 editorImpl.SelectionClearedSignal().Connect(tracker, functor);
483 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
487 Internal::TextEditor& editorImpl(GetImpl(editor));
488 editorImpl.SelectionStartedSignal().Connect(tracker, functor);
493 // signalName does not match any signal
500 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
502 return mTextChangedSignal;
505 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
507 return mInputStyleChangedSignal;
510 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
512 return mScrollStateChangedSignal;
515 void TextEditor::OnAccessibilityStatusChanged()
517 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
520 void TextEditor::OnInitialize()
524 mController = Text::Controller::New(this, this, this, this);
526 mDecorator = Text::Decorator::New(*mController,
529 mInputMethodContext = InputMethodContext::New(self);
531 mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
533 // Enables the text input.
534 mController->EnableTextInput(mDecorator, mInputMethodContext);
536 // Enables the vertical scrolling after the text input has been enabled.
537 mController->SetVerticalScrollEnabled(true);
539 // Disables the horizontal scrolling.
540 mController->SetHorizontalScrollEnabled(false);
542 // Sets the maximum number of characters.
543 mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
545 // Enable the smooth handle panning.
546 mController->SetSmoothHandlePanEnabled(true);
548 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
549 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
551 // Sets layoutDirection value
552 Dali::Stage stage = Dali::Stage::GetCurrent();
553 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
554 mController->SetLayoutDirection(layoutDirection);
556 self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
558 // Forward input events to controller
559 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
560 GetTapGestureDetector().SetMaximumTapsRequired(2);
561 GetTapGestureDetector().ReceiveAllTapEvents(true);
563 self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
565 // Set BoundingBox to stage size if not already set.
566 Rect<int> boundingBox;
567 mDecorator->GetBoundingBox(boundingBox);
569 if(boundingBox.IsEmpty())
571 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
572 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
575 // Whether to flip the selection handles as soon as they cross.
576 mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
578 // Set the default scroll speed.
579 mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
581 // Fill-parent area by default
582 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
583 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
584 self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
586 //Enable highightability
587 self.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
589 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
591 // Creates an extra control to be used as stencil buffer.
592 mStencil = Control::New();
593 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
594 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
596 // Creates a background visual. Even if the color is transparent it updates the stencil.
597 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
598 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
600 // Enable the clipping property.
601 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
602 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
606 DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) {
607 return std::unique_ptr<Dali::Accessibility::Accessible>(
608 new AccessibleImpl(actor, Dali::Accessibility::Role::ENTRY));
611 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
612 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
615 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
617 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
621 case StyleChange::DEFAULT_FONT_CHANGE:
623 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
624 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
625 // Property system did not set the font so should update it.
626 mController->UpdateAfterFontChange(newFont);
631 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
633 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
637 case StyleChange::THEME_CHANGE:
639 // Nothing to do, let control base class handle this
644 // Up call to Control
645 Control::OnStyleChange(styleManager, change);
648 Vector3 TextEditor::GetNaturalSize()
651 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
653 Vector3 naturalSize = mController->GetNaturalSize();
654 naturalSize.width += (padding.start + padding.end);
655 naturalSize.height += (padding.top + padding.bottom);
660 float TextEditor::GetHeightForWidth(float width)
663 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
664 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
667 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
669 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
671 actor.SetProperty(Actor::Property::SIZE, size);
675 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
677 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
682 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
684 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
686 // Support Right-To-Left of padding
687 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
689 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
691 std::swap(padding.start, padding.end);
696 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
697 ResizeActor(mStencil, contentSize);
701 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
702 ResizeActor(mActiveLayer, contentSize);
706 mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
707 ResizeActor(mCursorLayer, contentSize);
710 // If there is text changed, callback is called.
713 EmitTextChangedSignal();
716 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
718 if((Text::Controller::NONE_UPDATED != updateTextType) ||
721 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
724 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
726 mDecorator->Relayout(contentSize);
731 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
734 RenderText(updateTextType);
737 if(mCursorPositionChanged)
739 EmitCursorPositionChangedSignal();
742 if(mSelectionStarted)
744 EmitSelectionStartedSignal();
747 if(mSelectionChanged)
749 EmitSelectionChangedSignal();
752 if(mSelectionCleared)
754 EmitSelectionClearedSignal();
757 // The text-editor emits signals when the input style changes. These changes of style are
758 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
759 // can't be emitted during the size negotiation as the callbacks may update the UI.
760 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
761 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
763 if(Adaptor::IsAvailable())
765 Adaptor& adaptor = Adaptor::Get();
767 if(NULL == mIdleCallback)
769 // @note: The callback manager takes the ownership of the callback object.
770 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
771 adaptor.AddIdle(mIdleCallback, false);
777 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
779 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
782 ApplyScrollPosition();
787 void TextEditor::OnKeyInputFocusGained()
789 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
790 if(mInputMethodContext && IsEditable())
792 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
793 mInputMethodContext.ApplyOptions(mInputMethodOptions);
794 mInputMethodContext.NotifyTextInputMultiLine(true);
796 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
798 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
800 // Notify that the text editing start.
801 mInputMethodContext.Activate();
803 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
804 mInputMethodContext.SetRestoreAfterFocusLost(true);
806 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
810 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
813 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
815 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
818 void TextEditor::OnKeyInputFocusLost()
820 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
821 if(mInputMethodContext)
823 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
825 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
826 mInputMethodContext.SetRestoreAfterFocusLost(false);
828 // Notify that the text editing finish.
829 mInputMethodContext.Deactivate();
831 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
833 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
837 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
840 mController->KeyboardFocusLostEvent();
842 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
845 bool TextEditor::OnAccessibilityActivated()
851 void TextEditor::OnTap(const TapGesture& gesture)
853 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
854 if(mInputMethodContext && IsEditable())
856 mInputMethodContext.Activate();
858 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
860 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
861 const Vector2& localPoint = gesture.GetLocalPoint();
862 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
863 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
868 void TextEditor::OnPan(const PanGesture& gesture)
870 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
873 void TextEditor::OnLongPress(const LongPressGesture& gesture)
875 if(mInputMethodContext && IsEditable())
877 mInputMethodContext.Activate();
880 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
881 const Vector2& localPoint = gesture.GetLocalPoint();
882 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
887 bool TextEditor::OnKeyEvent(const KeyEvent& event)
889 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
891 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
893 // Make sure ClearKeyInputFocus when only key is up
894 if(event.GetState() == KeyEvent::UP)
896 ClearKeyInputFocus();
902 return mController->KeyEvent(event);
905 void TextEditor::RequestTextRelayout()
910 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
912 if(Accessibility::IsUp())
914 Control::Impl::GetAccessibilityObject(Self())->EmitTextInserted(position, length, content);
918 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
920 if(Accessibility::IsUp())
922 Control::Impl::GetAccessibilityObject(Self())->EmitTextDeleted(position, length, content);
926 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
928 if(Accessibility::IsUp())
930 Control::Impl::GetAccessibilityObject(Self())->EmitTextCursorMoved(newPosition);
933 if((oldPosition != newPosition) && !mCursorPositionChanged)
935 mCursorPositionChanged = true;
936 mOldPosition = oldPosition;
940 void TextEditor::TextChanged(bool immediate)
942 if(immediate) // Emits TextChangedSignal immediately
944 EmitTextChangedSignal();
952 void TextEditor::EmitTextChangedSignal()
954 Dali::Toolkit::TextEditor handle(GetOwner());
955 mTextChangedSignal.Emit(handle);
956 mTextChanged = false;
959 void TextEditor::MaxLengthReached()
961 Dali::Toolkit::TextEditor handle(GetOwner());
962 mMaxLengthReachedSignal.Emit(handle);
965 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
967 Dali::Toolkit::TextEditor handle(GetOwner());
968 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
971 void TextEditor::AnchorClicked(const std::string& href)
973 Dali::Toolkit::TextEditor handle(GetOwner());
974 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
977 void TextEditor::EmitCursorPositionChangedSignal()
979 Dali::Toolkit::TextEditor handle(GetOwner());
980 mCursorPositionChanged = false;
981 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
984 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
986 Dali::Toolkit::TextEditor handle(GetOwner());
987 mInputFilteredSignal.Emit(handle, type);
990 void TextEditor::EmitSelectionChangedSignal()
992 Dali::Toolkit::TextEditor handle(GetOwner());
993 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
994 mSelectionChanged = false;
997 void TextEditor::EmitSelectionClearedSignal()
999 Dali::Toolkit::TextEditor handle(GetOwner());
1000 mSelectionClearedSignal.Emit(handle);
1001 mSelectionCleared = false;
1004 void TextEditor::EmitSelectionStartedSignal()
1006 Dali::Toolkit::TextEditor handle(GetOwner());
1007 mSelectionStartedSignal.Emit(handle);
1008 mSelectionStarted = false;
1011 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1013 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1015 if(newStart == newEnd)
1017 mSelectionCleared = true;
1021 if(oldStart == oldEnd)
1023 mSelectionStarted = true;
1027 mSelectionChanged = true;
1028 mOldSelectionStart = oldStart;
1029 mOldSelectionEnd = oldEnd;
1031 if(mOldSelectionStart > mOldSelectionEnd)
1034 uint32_t temp = mOldSelectionStart;
1035 mOldSelectionStart = mOldSelectionEnd;
1036 mOldSelectionEnd = temp;
1041 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1047 mClippingDecorationActors.push_back(actor);
1050 // If the actor is a layer type, add it.
1051 if(type == DecorationType::ACTIVE_LAYER)
1053 AddLayer(mActiveLayer, actor);
1055 else if(type == DecorationType::CURSOR_LAYER)
1057 AddLayer(mCursorLayer, actor);
1062 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1064 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1065 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1070 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1072 if(mController && mController->IsShowingRealText())
1074 mController->SetTextSelectionRange(start, end);
1079 Uint32Pair TextEditor::GetTextSelectionRange() const
1081 Uint32Pair range(0, 0);
1082 if(mController && mController->IsShowingRealText())
1084 range = mController->GetTextSelectionRange();
1089 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1091 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1092 Property::Map* resultMap = propValue.GetMap();
1094 Property::Value* colorValue = nullptr;
1095 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1097 colorValue->Get(color);
1101 void TextEditor::UpdateScrollBar()
1103 using namespace Dali;
1105 float scrollPosition;
1108 bool latestScrolled;
1110 if(!mScrollBarEnabled)
1114 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1115 if(!latestScrolled || controlSize > layoutSize)
1120 CustomActor self = Self();
1123 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1124 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1125 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1126 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1127 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1128 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1130 // Register the scroll position property
1131 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1132 // Register the minimum scroll position property
1133 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1134 // Register the maximum scroll position property
1135 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1136 // Register the scroll content size property
1137 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1139 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1141 // Set style name of ScrollBar for styling
1142 mScrollBar.SetStyleName("TextEditorScrollBar");
1143 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1146 // Set style name of ScrollBarIndicator for styling
1147 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1150 self.Add(mScrollBar);
1154 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1155 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1156 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1158 self.SetProperty(propertyScrollPosition, scrollPosition);
1159 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1160 self.SetProperty(propertyScrollContentSize, layoutSize);
1163 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1166 mScrollStarted = true;
1167 Dali::Toolkit::TextEditor handle(GetOwner());
1168 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1171 Actor indicator = mScrollBar.GetScrollIndicator();
1174 mAnimation.Stop(); // Cancel any animation
1178 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1180 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1181 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1183 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1186 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1188 // If animation is successfully ended, then emit ScrollStateChangedSignal
1189 if(animation.GetCurrentProgress() == 0.0f)
1191 mScrollStarted = false;
1192 Dali::Toolkit::TextEditor handle(GetOwner());
1193 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1197 void TextEditor::OnSceneConnect(Dali::Actor actor)
1201 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1205 mHasBeenStaged = true;
1209 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1211 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1212 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1215 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1220 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1226 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1228 mController->PasteClipboardItemEvent();
1231 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1233 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1235 // Just hide the grab handle when keyboard is hidden.
1238 mController->KeyboardFocusLostEvent();
1242 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1246 void TextEditor::OnSceneConnection(int depth)
1248 // Sets the depth to the visuals inside the text's decorator.
1249 mDecorator->SetTextDepth(depth);
1251 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1253 // Call the Control::OnSceneConnection() to set the depth of the background.
1254 Control::OnSceneConnection(depth);
1257 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1262 void TextEditor::OnIdleSignal()
1264 // Emits the change of input style signals.
1265 mController->ProcessInputStyleChangedSignals();
1267 // Set the pointer to null as the callback manager deletes the callback after execute it.
1268 mIdleCallback = NULL;
1271 void TextEditor::ApplyScrollPosition()
1273 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1274 float scrollAmount = 0.0f;
1276 if(mScrollAnimationEnabled)
1278 scrollAmount = mController->GetScrollAmountByUserInput();
1280 if(mTextVerticalScroller)
1282 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1284 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1286 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1290 mTextVerticalScroller = Text::TextVerticalScroller::New();
1291 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1293 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1295 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1299 bool TextEditor::IsEditable() const
1301 return mController->IsEditable();
1304 void TextEditor::SetEditable(bool editable)
1306 mController->SetEditable(editable);
1307 if(mInputMethodContext && !editable)
1309 mInputMethodContext.Deactivate();
1313 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1315 mController->ChangedLayoutDirection();
1318 TextEditor::TextEditor()
1319 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1320 mAnimationPeriod(0.0f, 0.0f),
1321 mIdleCallback(NULL),
1322 mAlignmentOffset(0.f),
1323 mScrollAnimationDuration(0.f),
1325 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1326 mHasBeenStaged(false),
1327 mScrollAnimationEnabled(false),
1328 mScrollBarEnabled(false),
1329 mScrollStarted(false),
1330 mTextChanged(false),
1331 mCursorPositionChanged(false),
1332 mSelectionChanged(false),
1333 mSelectionCleared(false),
1335 mOldSelectionStart(0u),
1336 mOldSelectionEnd(0u),
1337 mSelectionStarted(false)
1341 TextEditor::~TextEditor()
1343 UnparentAndReset(mStencil);
1345 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1347 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1348 Adaptor::Get().RemoveIdle(mIdleCallback);
1352 std::string TextEditor::AccessibleImpl::GetName() const
1354 auto self = Toolkit::TextEditor::DownCast(Self());
1355 return self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1358 std::string TextEditor::AccessibleImpl::GetText(size_t startOffset, size_t endOffset) const
1360 if(endOffset <= startOffset)
1365 auto self = Toolkit::TextEditor::DownCast(Self());
1366 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1368 if(startOffset > text.size() || endOffset > text.size())
1373 return text.substr(startOffset, endOffset - startOffset);
1376 size_t TextEditor::AccessibleImpl::GetCharacterCount() const
1378 auto self = Toolkit::TextEditor::DownCast(Self());
1379 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1384 size_t TextEditor::AccessibleImpl::GetCursorOffset() const
1386 auto slf = Toolkit::TextEditor::DownCast(Self());
1387 return Dali::Toolkit::GetImpl(slf).GetTextController()->GetCursorPosition();
1390 bool TextEditor::AccessibleImpl::SetCursorOffset(size_t offset)
1392 auto slf = Toolkit::TextEditor::DownCast(Self());
1393 auto txt = slf.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1394 if(offset > txt.size())
1399 auto& slfImpl = Dali::Toolkit::GetImpl(slf);
1400 slfImpl.GetTextController()->ResetCursorPosition(offset);
1401 slfImpl.RequestTextRelayout();
1406 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetTextAtOffset(size_t offset, Dali::Accessibility::TextBoundary boundary) const
1408 auto self = Toolkit::TextEditor::DownCast(Self());
1409 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1410 auto textSize = text.size();
1412 auto range = Dali::Accessibility::Range{};
1416 case Dali::Accessibility::TextBoundary::CHARACTER:
1418 if(offset < textSize)
1420 range.content = text[offset];
1421 range.startOffset = offset;
1422 range.endOffset = offset + 1;
1426 case Dali::Accessibility::TextBoundary::WORD:
1427 case Dali::Accessibility::TextBoundary::LINE:
1429 auto textString = text.c_str();
1430 auto breaks = std::vector<char>(textSize, 0);
1432 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1434 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1438 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1443 while(index < textSize && counter <= offset)
1448 while(breaks[index])
1456 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1460 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1466 if((counter > 0) && ((counter - 1) == offset))
1468 range.content = text.substr(start, index - start + 1);
1469 range.startOffset = start;
1470 range.endOffset = index + 1;
1473 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1480 case Dali::Accessibility::TextBoundary::SENTENCE:
1482 /* not supported by default */
1485 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1487 /* Paragraph is not supported by libunibreak library */
1497 Dali::Accessibility::Range TextEditor::AccessibleImpl::GetRangeOfSelection(size_t selectionIndex) const
1499 // Since DALi supports only one selection indexes higher than 0 are ignored
1500 if(selectionIndex > 0)
1505 auto self = Toolkit::TextEditor::DownCast(Self());
1506 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1507 std::string value{};
1508 controller->RetrieveSelection(value);
1509 auto indices = controller->GetSelectionIndexes();
1511 return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
1514 bool TextEditor::AccessibleImpl::RemoveSelection(size_t selectionIndex)
1516 // Since DALi supports only one selection indexes higher than 0 are ignored
1517 if(selectionIndex > 0)
1522 auto self = Toolkit::TextEditor::DownCast(Self());
1523 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1527 bool TextEditor::AccessibleImpl::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1529 // Since DALi supports only one selection indexes higher than 0 are ignored
1530 if(selectionIndex > 0)
1535 auto self = Toolkit::TextEditor::DownCast(Self());
1536 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1540 Rect<> TextEditor::AccessibleImpl::GetRangeExtents(size_t startOffset, size_t endOffset, Accessibility::CoordinateType type)
1542 if (endOffset <= startOffset || endOffset <= 0)
1544 return {0, 0, 0, 0};
1547 auto self = Toolkit::TextEditor::DownCast(Self());
1548 auto rect = Dali::Toolkit::GetImpl(self).GetTextController()->GetTextBoundingRectangle(startOffset, endOffset - 1);
1550 auto componentExtents = this->GetExtents(type);
1552 rect.x += componentExtents.x;
1553 rect.y += componentExtents.y;
1558 bool TextEditor::AccessibleImpl::CopyText(size_t startPosition, size_t endPosition)
1560 if(endPosition <= startPosition)
1565 auto self = Toolkit::TextEditor::DownCast(Self());
1566 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1567 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1572 bool TextEditor::AccessibleImpl::CutText(size_t startPosition, size_t endPosition)
1574 if(endPosition <= startPosition)
1579 auto self = Toolkit::TextEditor::DownCast(Self());
1580 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1581 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1583 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1588 bool TextEditor::AccessibleImpl::DeleteText(size_t startPosition, size_t endPosition)
1590 if(endPosition <= startPosition)
1595 auto self = Toolkit::TextEditor::DownCast(Self());
1596 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1598 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1603 Dali::Accessibility::States TextEditor::AccessibleImpl::CalculateStates()
1605 using namespace Dali::Accessibility;
1607 auto states = DevelControl::ControlAccessible::CalculateStates();
1608 states[State::EDITABLE] = true;
1609 states[State::FOCUSABLE] = true;
1611 Toolkit::Control focusControl = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
1612 if(Self() == focusControl)
1614 states[State::FOCUSED] = true;
1620 bool TextEditor::AccessibleImpl::InsertText(size_t startPosition, std::string text)
1622 auto self = Toolkit::TextEditor::DownCast(Self());
1623 auto insertedText = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1625 insertedText.insert(startPosition, text);
1627 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(insertedText));
1632 bool TextEditor::AccessibleImpl::SetTextContents(std::string newContents)
1634 auto self = Toolkit::TextEditor::DownCast(Self());
1635 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(newContents));
1639 int32_t TextEditor::AccessibleImpl::GetLinkCount() const
1641 auto self = Toolkit::TextEditor::DownCast(Self());
1642 return Dali::Toolkit::GetImpl(self).mAnchorActors.size();
1645 Accessibility::Hyperlink* TextEditor::AccessibleImpl::GetLink(int32_t linkIndex) const
1647 if(linkIndex < 0 || linkIndex >= GetLinkCount())
1651 auto self = Toolkit::TextEditor::DownCast(Self());
1652 auto anchorActor = Dali::Toolkit::GetImpl(self).mAnchorActors[linkIndex];
1653 return dynamic_cast<Accessibility::Hyperlink*>(Dali::Accessibility::Accessible::Get(anchorActor));
1656 int32_t TextEditor::AccessibleImpl::GetLinkIndex(int32_t characterOffset) const
1658 auto self = Toolkit::TextEditor::DownCast(Self());
1659 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1660 return controller->GetAnchorIndex(static_cast<size_t>(characterOffset));
1663 } // namespace Internal
1665 } // namespace Toolkit