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/text/rendering-backend.h>
37 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
38 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
39 #include <dali-toolkit/internal/controls/text-controls/text-editor-property-handler.h>
40 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.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 )
162 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
163 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextEditor, "selectionPopupStyle", MAP, SELECTION_POPUP_STYLE )
165 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged", SIGNAL_TEXT_CHANGED )
166 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged", SIGNAL_INPUT_STYLE_CHANGED )
167 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached", SIGNAL_MAX_LENGTH_REACHED )
168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked", SIGNAL_ANCHOR_CLICKED )
169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered", SIGNAL_INPUT_FILTERED )
170 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
171 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged", SIGNAL_SELECTION_CHANGED )
172 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared", SIGNAL_SELECTION_CLEARED )
173 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionStarted", SIGNAL_SELECTION_STARTED )
175 DALI_TYPE_REGISTRATION_END()
178 Toolkit::TextEditor::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
180 Toolkit::TextEditor::InputStyle::Mask editorInputStyleMask = Toolkit::TextEditor::InputStyle::NONE;
182 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
184 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::COLOR);
186 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
188 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_FAMILY);
190 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
192 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::POINT_SIZE);
194 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
196 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
198 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
200 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
202 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
204 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
206 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_LINE_SPACING))
208 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::LINE_SPACING);
210 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
212 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::UNDERLINE);
214 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
216 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::SHADOW);
218 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
220 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::EMBOSS);
222 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
224 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::OUTLINE);
226 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_STRIKETHROUGH))
228 editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::STRIKETHROUGH);
231 return editorInputStyleMask;
236 Toolkit::TextEditor TextEditor::New(ControlBehaviour additionalBehaviour)
238 // Create the implementation, temporarily owned by this handle on stack
239 IntrusivePtr<TextEditor> impl = new TextEditor(additionalBehaviour);
241 // Pass ownership to CustomActor handle
242 Toolkit::TextEditor handle(*impl);
244 // Second-phase init of the implementation
245 // This can only be done after the CustomActor connection has been made...
251 void TextEditor::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
253 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
255 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor SetProperty\n");
259 PropertyHandler::SetProperty(textEditor, index, value);
263 Property::Value TextEditor::GetProperty(BaseObject* object, Property::Index index)
265 Property::Value value;
267 Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
271 value = PropertyHandler::GetProperty(textEditor, index);
276 void TextEditor::SelectWholeText()
278 if(mController && mController->IsShowingRealText())
280 mController->SelectWholeText();
285 void TextEditor::SelectNone()
287 if(mController && mController->IsShowingRealText())
289 mController->SelectNone();
293 void TextEditor::SelectText(const uint32_t start, const uint32_t end)
295 if(mController && mController->IsShowingRealText())
297 mController->SelectText(start, end);
302 string TextEditor::CopyText()
304 string copiedText = "";
305 if(mController && mController->IsShowingRealText())
307 copiedText = mController->CopyText();
312 string TextEditor::CutText()
315 if(mController && mController->IsShowingRealText())
317 cutText = mController->CutText();
322 void TextEditor::PasteText()
326 SetKeyInputFocus(); //Giving focus to the editor that was passed to the PasteText in case the passed editor (current editor) doesn't have focus.
327 mController->PasteText();
331 void TextEditor::ScrollBy(Vector2 scroll)
333 if(mController && mController->IsShowingRealText())
335 mController->ScrollBy(scroll);
339 float TextEditor::GetHorizontalScrollPosition()
341 if(mController && mController->IsShowingRealText())
343 return mController->GetHorizontalScrollPosition();
348 float TextEditor::GetVerticalScrollPosition()
350 if(mController && mController->IsShowingRealText())
352 return mController->GetVerticalScrollPosition();
357 Vector<Vector2> TextEditor::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
359 return mController->GetTextSize(startIndex, endIndex);
362 Vector<Vector2> TextEditor::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
364 return mController->GetTextPosition(startIndex, endIndex);
367 Rect<float> TextEditor::GetLineBoundingRectangle(const uint32_t lineIndex) const
369 return mController->GetLineBoundingRectangle(lineIndex);
372 Rect<float> TextEditor::GetCharacterBoundingRectangle(const uint32_t charIndex) const
374 return mController->GetCharacterBoundingRectangle(charIndex);
377 int TextEditor::GetCharacterIndexAtPosition(float visualX, float visualY) const
379 return mController->GetCharacterIndexAtPosition(visualX, visualY);
382 void TextEditor::SetSpannedText(const Text::Spanned& spannedText)
384 mController->SetSpannedText(spannedText);
387 string TextEditor::GetSelectedText() const
389 string selectedText = "";
390 if(mController && mController->IsShowingRealText())
392 selectedText = mController->GetSelectedText();
397 InputMethodContext TextEditor::GetInputMethodContext()
399 return mInputMethodContext;
402 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
404 return mMaxLengthReachedSignal;
407 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
409 return mAnchorClickedSignal;
412 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
414 return mCursorPositionChangedSignal;
417 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
419 return mInputFilteredSignal;
422 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
424 return mSelectionChangedSignal;
427 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
429 return mSelectionClearedSignal;
432 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
434 return mSelectionStartedSignal;
437 Text::ControllerPtr TextEditor::GetTextController()
442 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
444 Dali::BaseHandle handle(object);
446 bool connected(true);
447 Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
449 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
451 editor.TextChangedSignal().Connect(tracker, functor);
453 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
455 editor.InputStyleChangedSignal().Connect(tracker, functor);
457 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
461 Internal::TextEditor& editorImpl(GetImpl(editor));
462 editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
465 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
469 Internal::TextEditor& editorImpl(GetImpl(editor));
470 editorImpl.AnchorClickedSignal().Connect(tracker, functor);
473 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
477 Internal::TextEditor& editorImpl(GetImpl(editor));
478 editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
481 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
485 Internal::TextEditor& editorImpl(GetImpl(editor));
486 editorImpl.InputFilteredSignal().Connect(tracker, functor);
489 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
493 Internal::TextEditor& editorImpl(GetImpl(editor));
494 editorImpl.SelectionChangedSignal().Connect(tracker, functor);
497 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
501 Internal::TextEditor& editorImpl(GetImpl(editor));
502 editorImpl.SelectionClearedSignal().Connect(tracker, functor);
505 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
509 Internal::TextEditor& editorImpl(GetImpl(editor));
510 editorImpl.SelectionStartedSignal().Connect(tracker, functor);
515 // signalName does not match any signal
522 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
524 return mTextChangedSignal;
527 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
529 return mInputStyleChangedSignal;
532 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
534 return mScrollStateChangedSignal;
537 void TextEditor::OnAccessibilityStatusChanged()
539 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
542 void TextEditor::OnInitialize()
546 mController = Text::Controller::New(this, this, this, this);
548 mDecorator = Text::Decorator::New(*mController,
551 mInputMethodContext = InputMethodContext::New(self);
553 mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
555 // Enables the text input.
556 mController->EnableTextInput(mDecorator, mInputMethodContext);
558 // Enables the vertical scrolling after the text input has been enabled.
559 mController->SetVerticalScrollEnabled(true);
561 // Disables the horizontal scrolling.
562 mController->SetHorizontalScrollEnabled(false);
564 // Sets the maximum number of characters.
565 mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
567 // Enable the smooth handle panning.
568 mController->SetSmoothHandlePanEnabled(true);
570 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
571 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
573 // Sets layoutDirection value
574 Dali::Stage stage = Dali::Stage::GetCurrent();
575 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
576 mController->SetLayoutDirection(layoutDirection);
578 self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
580 // Forward input events to controller
581 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
582 GetTapGestureDetector().SetMaximumTapsRequired(2);
583 GetTapGestureDetector().ReceiveAllTapEvents(true);
585 self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
587 // Set BoundingBox to stage size if not already set.
588 Rect<int> boundingBox;
589 mDecorator->GetBoundingBox(boundingBox);
591 if(boundingBox.IsEmpty())
593 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
594 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
597 // Whether to flip the selection handles as soon as they cross.
598 mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
600 // Set the default scroll speed.
601 mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
603 // Fill-parent area by default
604 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
605 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
606 self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
608 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
610 // Creates an extra control to be used as stencil buffer.
611 mStencil = Control::New();
612 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
613 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
615 // Creates a background visual. Even if the color is transparent it updates the stencil.
616 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
617 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
619 // Enable the clipping property.
620 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
621 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
626 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::ENTRY);
627 self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
629 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
630 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
633 DevelControl::ControlAccessible* TextEditor::CreateAccessibleObject()
635 return new TextEditorAccessible(Self());
638 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
640 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
644 case StyleChange::DEFAULT_FONT_CHANGE:
646 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
647 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
648 // Property system did not set the font so should update it.
649 mController->UpdateAfterFontChange(newFont);
654 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
656 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
660 case StyleChange::THEME_CHANGE:
662 // Nothing to do, let control base class handle this
667 // Up call to Control
668 Control::OnStyleChange(styleManager, change);
671 Vector3 TextEditor::GetNaturalSize()
674 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
676 Vector3 naturalSize = mController->GetNaturalSize();
677 naturalSize.width += (padding.start + padding.end);
678 naturalSize.height += (padding.top + padding.bottom);
683 float TextEditor::GetHeightForWidth(float width)
686 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
687 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
690 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
692 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
694 actor.SetProperty(Actor::Property::SIZE, size);
698 void TextEditor::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
700 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnPropertySet index[%d]\n", index);
704 case DevelActor::Property::USER_INTERACTION_ENABLED:
706 const bool enabled = propertyValue.Get<bool>();
707 mController->SetUserInteractionEnabled(enabled);
710 float opacity = enabled ? 1.0f : mController->GetDisabledColorOpacity();
711 mStencil.SetProperty(Actor::Property::OPACITY, opacity);
717 Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
723 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
725 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
730 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
732 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
734 // Support Right-To-Left of padding
735 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
737 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
739 std::swap(padding.start, padding.end);
744 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
745 ResizeActor(mStencil, contentSize);
749 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
750 ResizeActor(mActiveLayer, contentSize);
754 mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
755 ResizeActor(mCursorLayer, contentSize);
758 // If there is text changed, callback is called.
761 EmitTextChangedSignal();
764 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
766 if((Text::Controller::NONE_UPDATED != updateTextType) ||
769 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
772 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
774 mDecorator->Relayout(contentSize);
779 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
782 RenderText(updateTextType);
785 if(mCursorPositionChanged)
787 EmitCursorPositionChangedSignal();
790 if(mSelectionStarted)
792 EmitSelectionStartedSignal();
795 if(mSelectionChanged)
797 EmitSelectionChangedSignal();
800 if(mSelectionCleared)
802 EmitSelectionClearedSignal();
805 // The text-editor emits signals when the input style changes. These changes of style are
806 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
807 // can't be emitted during the size negotiation as the callbacks may update the UI.
808 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
809 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
811 if(Adaptor::IsAvailable())
813 Adaptor& adaptor = Adaptor::Get();
815 if(NULL == mIdleCallback)
817 // @note: The callback manager takes the ownership of the callback object.
818 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
819 adaptor.AddIdle(mIdleCallback, false);
825 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
827 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mCursorLayer, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
830 ApplyScrollPosition();
835 void TextEditor::OnKeyInputFocusGained()
837 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
838 if(mInputMethodContext && IsEditable())
840 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
841 mInputMethodContext.ApplyOptions(mInputMethodOptions);
842 mInputMethodContext.NotifyTextInputMultiLine(true);
844 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
846 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
848 // Notify that the text editing start.
849 mInputMethodContext.Activate();
851 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
852 mInputMethodContext.SetRestoreAfterFocusLost(true);
854 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
858 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
861 if(IsEditable() && mController->IsUserInteractionEnabled())
863 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
866 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
869 void TextEditor::OnKeyInputFocusLost()
871 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
872 if(mInputMethodContext)
874 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
876 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
877 mInputMethodContext.SetRestoreAfterFocusLost(false);
879 // Notify that the text editing finish.
880 mInputMethodContext.Deactivate();
882 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
884 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
888 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
891 mController->KeyboardFocusLostEvent();
893 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
896 bool TextEditor::OnAccessibilityActivated()
902 void TextEditor::OnTap(const TapGesture& gesture)
904 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
905 if(mInputMethodContext && IsEditable())
907 mInputMethodContext.Activate();
909 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
911 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
912 const Vector2& localPoint = gesture.GetLocalPoint();
913 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
914 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
916 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
917 if(keyboardFocusManager)
919 keyboardFocusManager.SetCurrentFocusActor(Self());
924 void TextEditor::OnPan(const PanGesture& gesture)
926 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
927 if(gesture.GetState() == GestureState::STARTED && !mController->IsScrollable(gesture.GetDisplacement()))
929 Dali::DevelActor::SetNeedGesturePropagation(Self(), true);
933 void TextEditor::OnLongPress(const LongPressGesture& gesture)
935 if(mInputMethodContext && IsEditable())
937 mInputMethodContext.Activate();
940 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
941 const Vector2& localPoint = gesture.GetLocalPoint();
942 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
947 bool TextEditor::OnKeyEvent(const KeyEvent& event)
949 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
951 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
953 // Make sure ClearKeyInputFocus when only key is up
954 if(event.GetState() == KeyEvent::UP)
956 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
957 if(keyboardFocusManager)
959 keyboardFocusManager.ClearFocus();
961 ClearKeyInputFocus();
967 return mController->KeyEvent(event);
970 void TextEditor::RequestTextRelayout()
975 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
977 GetAccessibleObject()->EmitTextInserted(position, length, content);
980 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
982 GetAccessibleObject()->EmitTextDeleted(position, length, content);
985 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
987 GetAccessibleObject()->EmitTextCursorMoved(newPosition);
989 if((oldPosition != newPosition) && !mCursorPositionChanged)
991 mCursorPositionChanged = true;
992 mOldPosition = oldPosition;
996 void TextEditor::TextChanged(bool immediate)
998 if(immediate) // Emits TextChangedSignal immediately
1000 EmitTextChangedSignal();
1004 mTextChanged = true;
1008 void TextEditor::EmitTextChangedSignal()
1010 Dali::Toolkit::TextEditor handle(GetOwner());
1011 mTextChangedSignal.Emit(handle);
1012 mTextChanged = false;
1015 void TextEditor::MaxLengthReached()
1017 Dali::Toolkit::TextEditor handle(GetOwner());
1018 mMaxLengthReachedSignal.Emit(handle);
1021 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
1023 Dali::Toolkit::TextEditor handle(GetOwner());
1024 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
1027 void TextEditor::AnchorClicked(const std::string& href)
1029 Dali::Toolkit::TextEditor handle(GetOwner());
1030 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
1033 void TextEditor::EmitCursorPositionChangedSignal()
1035 Dali::Toolkit::TextEditor handle(GetOwner());
1036 mCursorPositionChanged = false;
1037 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
1040 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
1042 Dali::Toolkit::TextEditor handle(GetOwner());
1043 mInputFilteredSignal.Emit(handle, type);
1046 void TextEditor::EmitSelectionChangedSignal()
1048 Dali::Toolkit::TextEditor handle(GetOwner());
1049 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
1050 mSelectionChanged = false;
1053 void TextEditor::EmitSelectionClearedSignal()
1055 Dali::Toolkit::TextEditor handle(GetOwner());
1056 mSelectionClearedSignal.Emit(handle);
1057 mSelectionCleared = false;
1060 void TextEditor::EmitSelectionStartedSignal()
1062 Dali::Toolkit::TextEditor handle(GetOwner());
1063 mSelectionStartedSignal.Emit(handle);
1064 mSelectionStarted = false;
1067 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1069 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1071 if(newStart == newEnd)
1073 mSelectionCleared = true;
1077 if(oldStart == oldEnd)
1079 mSelectionStarted = true;
1083 mSelectionChanged = true;
1084 mOldSelectionStart = oldStart;
1085 mOldSelectionEnd = oldEnd;
1087 if(mOldSelectionStart > mOldSelectionEnd)
1090 uint32_t temp = mOldSelectionStart;
1091 mOldSelectionStart = mOldSelectionEnd;
1092 mOldSelectionEnd = temp;
1097 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1103 mClippingDecorationActors.push_back(actor);
1106 // If the actor is a layer type, add it.
1107 if(type == DecorationType::ACTIVE_LAYER)
1109 AddLayer(mActiveLayer, actor);
1111 else if(type == DecorationType::CURSOR_LAYER)
1113 AddLayer(mCursorLayer, actor);
1118 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1120 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1121 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1126 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1128 if(mController && mController->IsShowingRealText())
1130 mController->SetTextSelectionRange(start, end);
1135 Uint32Pair TextEditor::GetTextSelectionRange() const
1137 Uint32Pair range(0, 0);
1138 if(mController && mController->IsShowingRealText())
1140 range = mController->GetTextSelectionRange();
1145 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1147 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1148 Property::Map* resultMap = propValue.GetMap();
1150 Property::Value* colorValue = nullptr;
1151 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1153 colorValue->Get(color);
1157 void TextEditor::UpdateScrollBar()
1159 using namespace Dali;
1161 float scrollPosition;
1164 bool latestScrolled;
1166 if(!mScrollBarEnabled)
1170 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1171 if(!latestScrolled || controlSize > layoutSize)
1176 CustomActor self = Self();
1179 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1180 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1181 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1182 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1183 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1184 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1186 // Register the scroll position property
1187 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1188 // Register the minimum scroll position property
1189 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1190 // Register the maximum scroll position property
1191 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1192 // Register the scroll content size property
1193 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1195 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1197 // Set style name of ScrollBar for styling
1198 mScrollBar.SetStyleName("TextEditorScrollBar");
1199 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1202 // Set style name of ScrollBarIndicator for styling
1203 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1206 self.Add(mScrollBar);
1210 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1211 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1212 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1214 self.SetProperty(propertyScrollPosition, scrollPosition);
1215 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1216 self.SetProperty(propertyScrollContentSize, layoutSize);
1219 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1222 mScrollStarted = true;
1223 Dali::Toolkit::TextEditor handle(GetOwner());
1224 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1227 Actor indicator = mScrollBar.GetScrollIndicator();
1230 mAnimation.Stop(); // Cancel any animation
1234 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1236 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1237 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1239 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1242 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1244 // If animation is successfully ended, then emit ScrollStateChangedSignal
1245 if(animation.GetCurrentProgress() == 0.0f)
1247 mScrollStarted = false;
1248 Dali::Toolkit::TextEditor handle(GetOwner());
1249 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1253 void TextEditor::OnSceneConnect(Dali::Actor actor)
1257 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1261 mHasBeenStaged = true;
1265 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1267 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1268 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1271 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1276 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1282 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1284 mController->PasteClipboardItemEvent();
1287 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1289 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1291 // Just hide the grab handle when keyboard is hidden.
1294 mController->KeyboardFocusLostEvent();
1298 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1302 void TextEditor::OnSceneConnection(int depth)
1304 // Sets the depth to the visuals inside the text's decorator.
1305 mDecorator->SetTextDepth(depth);
1307 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1309 // Call the Control::OnSceneConnection() to set the depth of the background.
1310 Control::OnSceneConnection(depth);
1313 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1318 void TextEditor::OnIdleSignal()
1320 // Emits the change of input style signals.
1321 mController->ProcessInputStyleChangedSignals();
1323 // Set the pointer to null as the callback manager deletes the callback after execute it.
1324 mIdleCallback = NULL;
1327 void TextEditor::ApplyScrollPosition()
1329 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1330 float scrollAmount = 0.0f;
1332 if(mScrollAnimationEnabled)
1334 scrollAmount = mController->GetScrollAmountByUserInput();
1336 if(mTextVerticalScroller)
1338 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1340 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1342 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1346 mTextVerticalScroller = Text::TextVerticalScroller::New();
1347 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1349 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1351 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1355 bool TextEditor::IsEditable() const
1357 return mController->IsEditable();
1360 void TextEditor::SetEditable(bool editable)
1362 mController->SetEditable(editable);
1363 if(mInputMethodContext && !editable)
1365 mInputMethodContext.Deactivate();
1369 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1371 mController->ChangedLayoutDirection();
1374 TextEditor::TextEditor(ControlBehaviour additionalBehaviour)
1375 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
1376 mAnimationPeriod(0.0f, 0.0f),
1377 mIdleCallback(NULL),
1378 mAlignmentOffset(0.f),
1379 mScrollAnimationDuration(0.f),
1381 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1382 mHasBeenStaged(false),
1383 mScrollAnimationEnabled(false),
1384 mScrollBarEnabled(false),
1385 mScrollStarted(false),
1386 mTextChanged(false),
1387 mCursorPositionChanged(false),
1388 mSelectionChanged(false),
1389 mSelectionCleared(false),
1391 mOldSelectionStart(0u),
1392 mOldSelectionEnd(0u),
1393 mSelectionStarted(false)
1397 TextEditor::~TextEditor()
1399 UnparentAndReset(mStencil);
1401 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1403 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1404 Adaptor::Get().RemoveIdle(mIdleCallback);
1408 std::string TextEditor::TextEditorAccessible::GetName() const
1410 return GetWholeText();
1413 const std::vector<Toolkit::TextAnchor>& TextEditor::TextEditorAccessible::GetTextAnchors() const
1415 auto self = Toolkit::TextEditor::DownCast(Self());
1417 return Toolkit::GetImpl(self).mAnchorActors;
1420 Toolkit::Text::ControllerPtr TextEditor::TextEditorAccessible::GetTextController() const
1422 auto self = Toolkit::TextEditor::DownCast(Self());
1424 return Toolkit::GetImpl(self).GetTextController();
1427 void TextEditor::TextEditorAccessible::RequestTextRelayout()
1429 auto self = Toolkit::TextEditor::DownCast(Self());
1430 auto& selfImpl = Toolkit::GetImpl(self);
1432 selfImpl.RequestTextRelayout();
1435 } // namespace Internal
1437 } // namespace Toolkit