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::make_unique<TextEditorAccessible>(actor, Dali::Accessibility::Role::ENTRY);
610 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
611 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
614 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
616 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
620 case StyleChange::DEFAULT_FONT_CHANGE:
622 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
623 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
624 // Property system did not set the font so should update it.
625 mController->UpdateAfterFontChange(newFont);
630 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
632 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
636 case StyleChange::THEME_CHANGE:
638 // Nothing to do, let control base class handle this
643 // Up call to Control
644 Control::OnStyleChange(styleManager, change);
647 Vector3 TextEditor::GetNaturalSize()
650 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
652 Vector3 naturalSize = mController->GetNaturalSize();
653 naturalSize.width += (padding.start + padding.end);
654 naturalSize.height += (padding.top + padding.bottom);
659 float TextEditor::GetHeightForWidth(float width)
662 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
663 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
666 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
668 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
670 actor.SetProperty(Actor::Property::SIZE, size);
674 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
676 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
681 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
683 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
685 // Support Right-To-Left of padding
686 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
688 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
690 std::swap(padding.start, padding.end);
695 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
696 ResizeActor(mStencil, contentSize);
700 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
701 ResizeActor(mActiveLayer, contentSize);
705 mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
706 ResizeActor(mCursorLayer, contentSize);
709 // If there is text changed, callback is called.
712 EmitTextChangedSignal();
715 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
717 if((Text::Controller::NONE_UPDATED != updateTextType) ||
720 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
723 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
725 mDecorator->Relayout(contentSize);
730 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
733 RenderText(updateTextType);
736 if(mCursorPositionChanged)
738 EmitCursorPositionChangedSignal();
741 if(mSelectionStarted)
743 EmitSelectionStartedSignal();
746 if(mSelectionChanged)
748 EmitSelectionChangedSignal();
751 if(mSelectionCleared)
753 EmitSelectionClearedSignal();
756 // The text-editor emits signals when the input style changes. These changes of style are
757 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
758 // can't be emitted during the size negotiation as the callbacks may update the UI.
759 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
760 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
762 if(Adaptor::IsAvailable())
764 Adaptor& adaptor = Adaptor::Get();
766 if(NULL == mIdleCallback)
768 // @note: The callback manager takes the ownership of the callback object.
769 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
770 adaptor.AddIdle(mIdleCallback, false);
776 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
778 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
781 ApplyScrollPosition();
786 void TextEditor::OnKeyInputFocusGained()
788 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
789 if(mInputMethodContext && IsEditable())
791 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
792 mInputMethodContext.ApplyOptions(mInputMethodOptions);
793 mInputMethodContext.NotifyTextInputMultiLine(true);
795 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
797 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
799 // Notify that the text editing start.
800 mInputMethodContext.Activate();
802 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
803 mInputMethodContext.SetRestoreAfterFocusLost(true);
805 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
809 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
812 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
814 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
817 void TextEditor::OnKeyInputFocusLost()
819 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
820 if(mInputMethodContext)
822 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
824 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
825 mInputMethodContext.SetRestoreAfterFocusLost(false);
827 // Notify that the text editing finish.
828 mInputMethodContext.Deactivate();
830 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
832 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
836 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
839 mController->KeyboardFocusLostEvent();
841 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
844 bool TextEditor::OnAccessibilityActivated()
850 void TextEditor::OnTap(const TapGesture& gesture)
852 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
853 if(mInputMethodContext && IsEditable())
855 mInputMethodContext.Activate();
857 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
859 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
860 const Vector2& localPoint = gesture.GetLocalPoint();
861 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
862 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
867 void TextEditor::OnPan(const PanGesture& gesture)
869 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
872 void TextEditor::OnLongPress(const LongPressGesture& gesture)
874 if(mInputMethodContext && IsEditable())
876 mInputMethodContext.Activate();
879 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
880 const Vector2& localPoint = gesture.GetLocalPoint();
881 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
886 bool TextEditor::OnKeyEvent(const KeyEvent& event)
888 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
890 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
892 // Make sure ClearKeyInputFocus when only key is up
893 if(event.GetState() == KeyEvent::UP)
895 ClearKeyInputFocus();
901 return mController->KeyEvent(event);
904 void TextEditor::RequestTextRelayout()
909 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
911 if(Accessibility::IsUp())
913 Control::Impl::GetAccessibilityObject(Self())->EmitTextInserted(position, length, content);
917 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
919 if(Accessibility::IsUp())
921 Control::Impl::GetAccessibilityObject(Self())->EmitTextDeleted(position, length, content);
925 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
927 if(Accessibility::IsUp())
929 Control::Impl::GetAccessibilityObject(Self())->EmitTextCursorMoved(newPosition);
932 if((oldPosition != newPosition) && !mCursorPositionChanged)
934 mCursorPositionChanged = true;
935 mOldPosition = oldPosition;
939 void TextEditor::TextChanged(bool immediate)
941 if(immediate) // Emits TextChangedSignal immediately
943 EmitTextChangedSignal();
951 void TextEditor::EmitTextChangedSignal()
953 Dali::Toolkit::TextEditor handle(GetOwner());
954 mTextChangedSignal.Emit(handle);
955 mTextChanged = false;
958 void TextEditor::MaxLengthReached()
960 Dali::Toolkit::TextEditor handle(GetOwner());
961 mMaxLengthReachedSignal.Emit(handle);
964 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
966 Dali::Toolkit::TextEditor handle(GetOwner());
967 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
970 void TextEditor::AnchorClicked(const std::string& href)
972 Dali::Toolkit::TextEditor handle(GetOwner());
973 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
976 void TextEditor::EmitCursorPositionChangedSignal()
978 Dali::Toolkit::TextEditor handle(GetOwner());
979 mCursorPositionChanged = false;
980 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
983 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
985 Dali::Toolkit::TextEditor handle(GetOwner());
986 mInputFilteredSignal.Emit(handle, type);
989 void TextEditor::EmitSelectionChangedSignal()
991 Dali::Toolkit::TextEditor handle(GetOwner());
992 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
993 mSelectionChanged = false;
996 void TextEditor::EmitSelectionClearedSignal()
998 Dali::Toolkit::TextEditor handle(GetOwner());
999 mSelectionClearedSignal.Emit(handle);
1000 mSelectionCleared = false;
1003 void TextEditor::EmitSelectionStartedSignal()
1005 Dali::Toolkit::TextEditor handle(GetOwner());
1006 mSelectionStartedSignal.Emit(handle);
1007 mSelectionStarted = false;
1010 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1012 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1014 if(newStart == newEnd)
1016 mSelectionCleared = true;
1020 if(oldStart == oldEnd)
1022 mSelectionStarted = true;
1026 mSelectionChanged = true;
1027 mOldSelectionStart = oldStart;
1028 mOldSelectionEnd = oldEnd;
1030 if(mOldSelectionStart > mOldSelectionEnd)
1033 uint32_t temp = mOldSelectionStart;
1034 mOldSelectionStart = mOldSelectionEnd;
1035 mOldSelectionEnd = temp;
1040 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1046 mClippingDecorationActors.push_back(actor);
1049 // If the actor is a layer type, add it.
1050 if(type == DecorationType::ACTIVE_LAYER)
1052 AddLayer(mActiveLayer, actor);
1054 else if(type == DecorationType::CURSOR_LAYER)
1056 AddLayer(mCursorLayer, actor);
1061 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1063 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1064 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1069 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1071 if(mController && mController->IsShowingRealText())
1073 mController->SetTextSelectionRange(start, end);
1078 Uint32Pair TextEditor::GetTextSelectionRange() const
1080 Uint32Pair range(0, 0);
1081 if(mController && mController->IsShowingRealText())
1083 range = mController->GetTextSelectionRange();
1088 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1090 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1091 Property::Map* resultMap = propValue.GetMap();
1093 Property::Value* colorValue = nullptr;
1094 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1096 colorValue->Get(color);
1100 void TextEditor::UpdateScrollBar()
1102 using namespace Dali;
1104 float scrollPosition;
1107 bool latestScrolled;
1109 if(!mScrollBarEnabled)
1113 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1114 if(!latestScrolled || controlSize > layoutSize)
1119 CustomActor self = Self();
1122 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1123 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1124 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1125 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1126 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1127 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1129 // Register the scroll position property
1130 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1131 // Register the minimum scroll position property
1132 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1133 // Register the maximum scroll position property
1134 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1135 // Register the scroll content size property
1136 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1138 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1140 // Set style name of ScrollBar for styling
1141 mScrollBar.SetStyleName("TextEditorScrollBar");
1142 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1145 // Set style name of ScrollBarIndicator for styling
1146 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1149 self.Add(mScrollBar);
1153 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1154 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1155 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1157 self.SetProperty(propertyScrollPosition, scrollPosition);
1158 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1159 self.SetProperty(propertyScrollContentSize, layoutSize);
1162 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1165 mScrollStarted = true;
1166 Dali::Toolkit::TextEditor handle(GetOwner());
1167 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1170 Actor indicator = mScrollBar.GetScrollIndicator();
1173 mAnimation.Stop(); // Cancel any animation
1177 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1179 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1180 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1182 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1185 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1187 // If animation is successfully ended, then emit ScrollStateChangedSignal
1188 if(animation.GetCurrentProgress() == 0.0f)
1190 mScrollStarted = false;
1191 Dali::Toolkit::TextEditor handle(GetOwner());
1192 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1196 void TextEditor::OnSceneConnect(Dali::Actor actor)
1200 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1204 mHasBeenStaged = true;
1208 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1210 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1211 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1214 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1219 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1225 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1227 mController->PasteClipboardItemEvent();
1230 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1232 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1234 // Just hide the grab handle when keyboard is hidden.
1237 mController->KeyboardFocusLostEvent();
1241 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1245 void TextEditor::OnSceneConnection(int depth)
1247 // Sets the depth to the visuals inside the text's decorator.
1248 mDecorator->SetTextDepth(depth);
1250 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1252 // Call the Control::OnSceneConnection() to set the depth of the background.
1253 Control::OnSceneConnection(depth);
1256 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1261 void TextEditor::OnIdleSignal()
1263 // Emits the change of input style signals.
1264 mController->ProcessInputStyleChangedSignals();
1266 // Set the pointer to null as the callback manager deletes the callback after execute it.
1267 mIdleCallback = NULL;
1270 void TextEditor::ApplyScrollPosition()
1272 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1273 float scrollAmount = 0.0f;
1275 if(mScrollAnimationEnabled)
1277 scrollAmount = mController->GetScrollAmountByUserInput();
1279 if(mTextVerticalScroller)
1281 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1283 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1285 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1289 mTextVerticalScroller = Text::TextVerticalScroller::New();
1290 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1292 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1294 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1298 bool TextEditor::IsEditable() const
1300 return mController->IsEditable();
1303 void TextEditor::SetEditable(bool editable)
1305 mController->SetEditable(editable);
1306 if(mInputMethodContext && !editable)
1308 mInputMethodContext.Deactivate();
1312 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1314 mController->ChangedLayoutDirection();
1317 TextEditor::TextEditor()
1318 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1319 mAnimationPeriod(0.0f, 0.0f),
1320 mIdleCallback(NULL),
1321 mAlignmentOffset(0.f),
1322 mScrollAnimationDuration(0.f),
1324 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1325 mHasBeenStaged(false),
1326 mScrollAnimationEnabled(false),
1327 mScrollBarEnabled(false),
1328 mScrollStarted(false),
1329 mTextChanged(false),
1330 mCursorPositionChanged(false),
1331 mSelectionChanged(false),
1332 mSelectionCleared(false),
1334 mOldSelectionStart(0u),
1335 mOldSelectionEnd(0u),
1336 mSelectionStarted(false)
1340 TextEditor::~TextEditor()
1342 UnparentAndReset(mStencil);
1344 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1346 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1347 Adaptor::Get().RemoveIdle(mIdleCallback);
1351 std::string TextEditor::TextEditorAccessible::GetName() const
1353 auto self = Toolkit::TextEditor::DownCast(Self());
1354 return self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1357 std::string TextEditor::TextEditorAccessible::GetText(size_t startOffset, size_t endOffset) const
1359 if(endOffset <= startOffset)
1364 auto self = Toolkit::TextEditor::DownCast(Self());
1365 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1367 if(startOffset > text.size() || endOffset > text.size())
1372 return text.substr(startOffset, endOffset - startOffset);
1375 size_t TextEditor::TextEditorAccessible::GetCharacterCount() const
1377 auto self = Toolkit::TextEditor::DownCast(Self());
1378 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1383 size_t TextEditor::TextEditorAccessible::GetCursorOffset() const
1385 auto slf = Toolkit::TextEditor::DownCast(Self());
1386 return Dali::Toolkit::GetImpl(slf).GetTextController()->GetCursorPosition();
1389 bool TextEditor::TextEditorAccessible::SetCursorOffset(size_t offset)
1391 auto slf = Toolkit::TextEditor::DownCast(Self());
1392 auto txt = slf.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1393 if(offset > txt.size())
1398 auto& slfImpl = Dali::Toolkit::GetImpl(slf);
1399 slfImpl.GetTextController()->ResetCursorPosition(offset);
1400 slfImpl.RequestTextRelayout();
1405 Dali::Accessibility::Range TextEditor::TextEditorAccessible::GetTextAtOffset(size_t offset, Dali::Accessibility::TextBoundary boundary) const
1407 auto self = Toolkit::TextEditor::DownCast(Self());
1408 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1409 auto textSize = text.size();
1411 auto range = Dali::Accessibility::Range{};
1415 case Dali::Accessibility::TextBoundary::CHARACTER:
1417 if(offset < textSize)
1419 range.content = text[offset];
1420 range.startOffset = offset;
1421 range.endOffset = offset + 1;
1425 case Dali::Accessibility::TextBoundary::WORD:
1426 case Dali::Accessibility::TextBoundary::LINE:
1428 auto textString = text.c_str();
1429 auto breaks = std::vector<char>(textSize, 0);
1431 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1433 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1437 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1442 while(index < textSize && counter <= offset)
1447 while(breaks[index])
1455 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1459 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1465 if((counter > 0) && ((counter - 1) == offset))
1467 range.content = text.substr(start, index - start + 1);
1468 range.startOffset = start;
1469 range.endOffset = index + 1;
1472 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1479 case Dali::Accessibility::TextBoundary::SENTENCE:
1481 /* not supported by default */
1484 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1486 /* Paragraph is not supported by libunibreak library */
1496 Dali::Accessibility::Range TextEditor::TextEditorAccessible::GetRangeOfSelection(size_t selectionIndex) const
1498 // Since DALi supports only one selection indexes higher than 0 are ignored
1499 if(selectionIndex > 0)
1504 auto self = Toolkit::TextEditor::DownCast(Self());
1505 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1506 std::string value{};
1507 controller->RetrieveSelection(value);
1508 auto indices = controller->GetSelectionIndexes();
1510 return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
1513 bool TextEditor::TextEditorAccessible::RemoveSelection(size_t selectionIndex)
1515 // Since DALi supports only one selection indexes higher than 0 are ignored
1516 if(selectionIndex > 0)
1521 auto self = Toolkit::TextEditor::DownCast(Self());
1522 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1526 bool TextEditor::TextEditorAccessible::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1528 // Since DALi supports only one selection indexes higher than 0 are ignored
1529 if(selectionIndex > 0)
1534 auto self = Toolkit::TextEditor::DownCast(Self());
1535 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1539 Rect<> TextEditor::TextEditorAccessible::GetRangeExtents(size_t startOffset, size_t endOffset, Accessibility::CoordinateType type)
1541 if (endOffset <= startOffset || endOffset <= 0)
1543 return {0, 0, 0, 0};
1546 auto self = Toolkit::TextEditor::DownCast(Self());
1547 auto rect = Dali::Toolkit::GetImpl(self).GetTextController()->GetTextBoundingRectangle(startOffset, endOffset - 1);
1549 auto componentExtents = this->GetExtents(type);
1551 rect.x += componentExtents.x;
1552 rect.y += componentExtents.y;
1557 bool TextEditor::TextEditorAccessible::CopyText(size_t startPosition, size_t endPosition)
1559 if(endPosition <= startPosition)
1564 auto self = Toolkit::TextEditor::DownCast(Self());
1565 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1566 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1571 bool TextEditor::TextEditorAccessible::CutText(size_t startPosition, size_t endPosition)
1573 if(endPosition <= startPosition)
1578 auto self = Toolkit::TextEditor::DownCast(Self());
1579 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1580 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1582 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1587 bool TextEditor::TextEditorAccessible::DeleteText(size_t startPosition, size_t endPosition)
1589 if(endPosition <= startPosition)
1594 auto self = Toolkit::TextEditor::DownCast(Self());
1595 auto text = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1597 self.SetProperty(Toolkit::TextEditor::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1602 Dali::Accessibility::States TextEditor::TextEditorAccessible::CalculateStates()
1604 using namespace Dali::Accessibility;
1606 auto states = DevelControl::ControlAccessible::CalculateStates();
1607 states[State::EDITABLE] = true;
1608 states[State::FOCUSABLE] = true;
1610 Toolkit::Control focusControl = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
1611 if(Self() == focusControl)
1613 states[State::FOCUSED] = true;
1619 bool TextEditor::TextEditorAccessible::InsertText(size_t startPosition, std::string text)
1621 auto self = Toolkit::TextEditor::DownCast(Self());
1622 auto insertedText = self.GetProperty(Toolkit::TextEditor::Property::TEXT).Get<std::string>();
1624 insertedText.insert(startPosition, text);
1626 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(insertedText));
1631 bool TextEditor::TextEditorAccessible::SetTextContents(std::string newContents)
1633 auto self = Toolkit::TextEditor::DownCast(Self());
1634 self.SetProperty(Toolkit::TextEditor::Property::TEXT, std::move(newContents));
1638 int32_t TextEditor::TextEditorAccessible::GetLinkCount() const
1640 auto self = Toolkit::TextEditor::DownCast(Self());
1641 return Dali::Toolkit::GetImpl(self).mAnchorActors.size();
1644 Accessibility::Hyperlink* TextEditor::TextEditorAccessible::GetLink(int32_t linkIndex) const
1646 if(linkIndex < 0 || linkIndex >= GetLinkCount())
1650 auto self = Toolkit::TextEditor::DownCast(Self());
1651 auto anchorActor = Dali::Toolkit::GetImpl(self).mAnchorActors[linkIndex];
1652 return dynamic_cast<Accessibility::Hyperlink*>(Dali::Accessibility::Accessible::Get(anchorActor));
1655 int32_t TextEditor::TextEditorAccessible::GetLinkIndex(int32_t characterOffset) const
1657 auto self = Toolkit::TextEditor::DownCast(Self());
1658 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1659 return controller->GetAnchorIndex(static_cast<size_t>(characterOffset));
1662 } // namespace Internal
1664 } // namespace Toolkit