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()
238 // Create the implementation, temporarily owned by this handle on stack
239 IntrusivePtr<TextEditor> impl = new TextEditor();
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 string TextEditor::GetSelectedText() const
374 string selectedText = "";
375 if(mController && mController->IsShowingRealText())
377 selectedText = mController->GetSelectedText();
382 InputMethodContext TextEditor::GetInputMethodContext()
384 return mInputMethodContext;
387 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
389 return mMaxLengthReachedSignal;
392 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
394 return mAnchorClickedSignal;
397 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
399 return mCursorPositionChangedSignal;
402 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
404 return mInputFilteredSignal;
407 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
409 return mSelectionChangedSignal;
412 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
414 return mSelectionClearedSignal;
417 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
419 return mSelectionStartedSignal;
422 Text::ControllerPtr TextEditor::GetTextController()
427 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
429 Dali::BaseHandle handle(object);
431 bool connected(true);
432 Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
434 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
436 editor.TextChangedSignal().Connect(tracker, functor);
438 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
440 editor.InputStyleChangedSignal().Connect(tracker, functor);
442 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
446 Internal::TextEditor& editorImpl(GetImpl(editor));
447 editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
450 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
454 Internal::TextEditor& editorImpl(GetImpl(editor));
455 editorImpl.AnchorClickedSignal().Connect(tracker, functor);
458 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
462 Internal::TextEditor& editorImpl(GetImpl(editor));
463 editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
466 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
470 Internal::TextEditor& editorImpl(GetImpl(editor));
471 editorImpl.InputFilteredSignal().Connect(tracker, functor);
474 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
478 Internal::TextEditor& editorImpl(GetImpl(editor));
479 editorImpl.SelectionChangedSignal().Connect(tracker, functor);
482 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
486 Internal::TextEditor& editorImpl(GetImpl(editor));
487 editorImpl.SelectionClearedSignal().Connect(tracker, functor);
490 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
494 Internal::TextEditor& editorImpl(GetImpl(editor));
495 editorImpl.SelectionStartedSignal().Connect(tracker, functor);
500 // signalName does not match any signal
507 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
509 return mTextChangedSignal;
512 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
514 return mInputStyleChangedSignal;
517 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
519 return mScrollStateChangedSignal;
522 void TextEditor::OnAccessibilityStatusChanged()
524 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
527 void TextEditor::OnInitialize()
531 mController = Text::Controller::New(this, this, this, this);
533 mDecorator = Text::Decorator::New(*mController,
536 mInputMethodContext = InputMethodContext::New(self);
538 mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
540 // Enables the text input.
541 mController->EnableTextInput(mDecorator, mInputMethodContext);
543 // Enables the vertical scrolling after the text input has been enabled.
544 mController->SetVerticalScrollEnabled(true);
546 // Disables the horizontal scrolling.
547 mController->SetHorizontalScrollEnabled(false);
549 // Sets the maximum number of characters.
550 mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
552 // Enable the smooth handle panning.
553 mController->SetSmoothHandlePanEnabled(true);
555 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
556 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
558 // Sets layoutDirection value
559 Dali::Stage stage = Dali::Stage::GetCurrent();
560 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
561 mController->SetLayoutDirection(layoutDirection);
563 self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
565 // Forward input events to controller
566 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
567 GetTapGestureDetector().SetMaximumTapsRequired(2);
568 GetTapGestureDetector().ReceiveAllTapEvents(true);
570 self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
572 // Set BoundingBox to stage size if not already set.
573 Rect<int> boundingBox;
574 mDecorator->GetBoundingBox(boundingBox);
576 if(boundingBox.IsEmpty())
578 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
579 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
582 // Whether to flip the selection handles as soon as they cross.
583 mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
585 // Set the default scroll speed.
586 mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
588 // Fill-parent area by default
589 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
590 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
591 self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
593 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
595 // Creates an extra control to be used as stencil buffer.
596 mStencil = Control::New();
597 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
598 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
600 // Creates a background visual. Even if the color is transparent it updates the stencil.
601 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
602 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
604 // Enable the clipping property.
605 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
606 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
611 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::ENTRY);
612 self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
614 Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
615 Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
618 DevelControl::ControlAccessible* TextEditor::CreateAccessibleObject()
620 return new TextEditorAccessible(Self());
623 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
625 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
629 case StyleChange::DEFAULT_FONT_CHANGE:
631 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
632 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
633 // Property system did not set the font so should update it.
634 mController->UpdateAfterFontChange(newFont);
639 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
641 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
645 case StyleChange::THEME_CHANGE:
647 // Nothing to do, let control base class handle this
652 // Up call to Control
653 Control::OnStyleChange(styleManager, change);
656 Vector3 TextEditor::GetNaturalSize()
659 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
661 Vector3 naturalSize = mController->GetNaturalSize();
662 naturalSize.width += (padding.start + padding.end);
663 naturalSize.height += (padding.top + padding.bottom);
668 float TextEditor::GetHeightForWidth(float width)
671 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
672 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
675 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
677 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
679 actor.SetProperty(Actor::Property::SIZE, size);
683 void TextEditor::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
685 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnPropertySet index[%d]\n", index);
689 case DevelActor::Property::USER_INTERACTION_ENABLED:
691 const bool enabled = propertyValue.Get<bool>();
692 mController->SetUserInteractionEnabled(enabled);
695 float opacity = enabled ? 1.0f : mController->GetDisabledColorOpacity();
696 mStencil.SetProperty(Actor::Property::OPACITY, opacity);
702 Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
708 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
710 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
715 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
717 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
719 // Support Right-To-Left of padding
720 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
722 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
724 std::swap(padding.start, padding.end);
729 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
730 ResizeActor(mStencil, contentSize);
734 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
735 ResizeActor(mActiveLayer, contentSize);
739 mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
740 ResizeActor(mCursorLayer, contentSize);
743 // If there is text changed, callback is called.
746 EmitTextChangedSignal();
749 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
751 if((Text::Controller::NONE_UPDATED != updateTextType) ||
754 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
757 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
759 mDecorator->Relayout(contentSize);
764 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
767 RenderText(updateTextType);
770 if(mCursorPositionChanged)
772 EmitCursorPositionChangedSignal();
775 if(mSelectionStarted)
777 EmitSelectionStartedSignal();
780 if(mSelectionChanged)
782 EmitSelectionChangedSignal();
785 if(mSelectionCleared)
787 EmitSelectionClearedSignal();
790 // The text-editor emits signals when the input style changes. These changes of style are
791 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
792 // can't be emitted during the size negotiation as the callbacks may update the UI.
793 // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
794 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
796 if(Adaptor::IsAvailable())
798 Adaptor& adaptor = Adaptor::Get();
800 if(NULL == mIdleCallback)
802 // @note: The callback manager takes the ownership of the callback object.
803 mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
804 adaptor.AddIdle(mIdleCallback, false);
810 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
812 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mCursorLayer, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
815 ApplyScrollPosition();
820 void TextEditor::OnKeyInputFocusGained()
822 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
823 if(mInputMethodContext && IsEditable())
825 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
826 mInputMethodContext.ApplyOptions(mInputMethodOptions);
827 mInputMethodContext.NotifyTextInputMultiLine(true);
829 mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
831 mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
833 // Notify that the text editing start.
834 mInputMethodContext.Activate();
836 // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
837 mInputMethodContext.SetRestoreAfterFocusLost(true);
839 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
843 notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
846 if(IsEditable() && mController->IsUserInteractionEnabled())
848 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
851 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
854 void TextEditor::OnKeyInputFocusLost()
856 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
857 if(mInputMethodContext)
859 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
861 // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
862 mInputMethodContext.SetRestoreAfterFocusLost(false);
864 // Notify that the text editing finish.
865 mInputMethodContext.Deactivate();
867 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
869 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
873 notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
876 mController->KeyboardFocusLostEvent();
878 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
881 bool TextEditor::OnAccessibilityActivated()
887 void TextEditor::OnTap(const TapGesture& gesture)
889 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
890 if(mInputMethodContext && IsEditable())
892 mInputMethodContext.Activate();
894 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
896 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
897 const Vector2& localPoint = gesture.GetLocalPoint();
898 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
899 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
901 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
902 if (keyboardFocusManager)
904 keyboardFocusManager.SetCurrentFocusActor(Self());
909 void TextEditor::OnPan(const PanGesture& gesture)
911 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
912 if(gesture.GetState() == GestureState::STARTED && !mController->IsScrollable(gesture.GetDisplacement()))
914 Dali::DevelActor::SetNeedGesturePropagation(Self(), true);
918 void TextEditor::OnLongPress(const LongPressGesture& gesture)
920 if(mInputMethodContext && IsEditable())
922 mInputMethodContext.Activate();
925 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
926 const Vector2& localPoint = gesture.GetLocalPoint();
927 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
932 bool TextEditor::OnKeyEvent(const KeyEvent& event)
934 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
936 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
938 // Make sure ClearKeyInputFocus when only key is up
939 if(event.GetState() == KeyEvent::UP)
941 Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
942 if (keyboardFocusManager)
944 keyboardFocusManager.ClearFocus();
946 ClearKeyInputFocus();
952 return mController->KeyEvent(event);
955 void TextEditor::RequestTextRelayout()
960 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
962 GetAccessibleObject()->EmitTextInserted(position, length, content);
965 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
967 GetAccessibleObject()->EmitTextDeleted(position, length, content);
970 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
972 GetAccessibleObject()->EmitTextCursorMoved(newPosition);
974 if((oldPosition != newPosition) && !mCursorPositionChanged)
976 mCursorPositionChanged = true;
977 mOldPosition = oldPosition;
981 void TextEditor::TextChanged(bool immediate)
983 if(immediate) // Emits TextChangedSignal immediately
985 EmitTextChangedSignal();
993 void TextEditor::EmitTextChangedSignal()
995 Dali::Toolkit::TextEditor handle(GetOwner());
996 mTextChangedSignal.Emit(handle);
997 mTextChanged = false;
1000 void TextEditor::MaxLengthReached()
1002 Dali::Toolkit::TextEditor handle(GetOwner());
1003 mMaxLengthReachedSignal.Emit(handle);
1006 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
1008 Dali::Toolkit::TextEditor handle(GetOwner());
1009 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
1012 void TextEditor::AnchorClicked(const std::string& href)
1014 Dali::Toolkit::TextEditor handle(GetOwner());
1015 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
1018 void TextEditor::EmitCursorPositionChangedSignal()
1020 Dali::Toolkit::TextEditor handle(GetOwner());
1021 mCursorPositionChanged = false;
1022 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
1025 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
1027 Dali::Toolkit::TextEditor handle(GetOwner());
1028 mInputFilteredSignal.Emit(handle, type);
1031 void TextEditor::EmitSelectionChangedSignal()
1033 Dali::Toolkit::TextEditor handle(GetOwner());
1034 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
1035 mSelectionChanged = false;
1038 void TextEditor::EmitSelectionClearedSignal()
1040 Dali::Toolkit::TextEditor handle(GetOwner());
1041 mSelectionClearedSignal.Emit(handle);
1042 mSelectionCleared = false;
1045 void TextEditor::EmitSelectionStartedSignal()
1047 Dali::Toolkit::TextEditor handle(GetOwner());
1048 mSelectionStartedSignal.Emit(handle);
1049 mSelectionStarted = false;
1052 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1054 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1056 if(newStart == newEnd)
1058 mSelectionCleared = true;
1062 if(oldStart == oldEnd)
1064 mSelectionStarted = true;
1068 mSelectionChanged = true;
1069 mOldSelectionStart = oldStart;
1070 mOldSelectionEnd = oldEnd;
1072 if(mOldSelectionStart > mOldSelectionEnd)
1075 uint32_t temp = mOldSelectionStart;
1076 mOldSelectionStart = mOldSelectionEnd;
1077 mOldSelectionEnd = temp;
1082 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1088 mClippingDecorationActors.push_back(actor);
1091 // If the actor is a layer type, add it.
1092 if(type == DecorationType::ACTIVE_LAYER)
1094 AddLayer(mActiveLayer, actor);
1096 else if(type == DecorationType::CURSOR_LAYER)
1098 AddLayer(mCursorLayer, actor);
1103 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1105 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1106 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1111 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1113 if(mController && mController->IsShowingRealText())
1115 mController->SetTextSelectionRange(start, end);
1120 Uint32Pair TextEditor::GetTextSelectionRange() const
1122 Uint32Pair range(0, 0);
1123 if(mController && mController->IsShowingRealText())
1125 range = mController->GetTextSelectionRange();
1130 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1132 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1133 Property::Map* resultMap = propValue.GetMap();
1135 Property::Value* colorValue = nullptr;
1136 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1138 colorValue->Get(color);
1142 void TextEditor::UpdateScrollBar()
1144 using namespace Dali;
1146 float scrollPosition;
1149 bool latestScrolled;
1151 if(!mScrollBarEnabled)
1155 latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1156 if(!latestScrolled || controlSize > layoutSize)
1161 CustomActor self = Self();
1164 mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1165 mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1166 mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1167 mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1168 mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1169 mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1171 // Register the scroll position property
1172 Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1173 // Register the minimum scroll position property
1174 Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1175 // Register the maximum scroll position property
1176 Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1177 // Register the scroll content size property
1178 Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1180 mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1182 // Set style name of ScrollBar for styling
1183 mScrollBar.SetStyleName("TextEditorScrollBar");
1184 Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1187 // Set style name of ScrollBarIndicator for styling
1188 scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1191 self.Add(mScrollBar);
1195 Property::Index propertyScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1196 Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1197 Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1199 self.SetProperty(propertyScrollPosition, scrollPosition);
1200 self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1201 self.SetProperty(propertyScrollContentSize, layoutSize);
1204 // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1207 mScrollStarted = true;
1208 Dali::Toolkit::TextEditor handle(GetOwner());
1209 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1212 Actor indicator = mScrollBar.GetScrollIndicator();
1215 mAnimation.Stop(); // Cancel any animation
1219 mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1221 indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1222 mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1224 mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1227 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1229 // If animation is successfully ended, then emit ScrollStateChangedSignal
1230 if(animation.GetCurrentProgress() == 0.0f)
1232 mScrollStarted = false;
1233 Dali::Toolkit::TextEditor handle(GetOwner());
1234 mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1238 void TextEditor::OnSceneConnect(Dali::Actor actor)
1242 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1246 mHasBeenStaged = true;
1250 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1252 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1253 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1256 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1261 map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1267 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1269 mController->PasteClipboardItemEvent();
1272 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1274 DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1276 // Just hide the grab handle when keyboard is hidden.
1279 mController->KeyboardFocusLostEvent();
1283 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1287 void TextEditor::OnSceneConnection(int depth)
1289 // Sets the depth to the visuals inside the text's decorator.
1290 mDecorator->SetTextDepth(depth);
1292 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1294 // Call the Control::OnSceneConnection() to set the depth of the background.
1295 Control::OnSceneConnection(depth);
1298 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1303 void TextEditor::OnIdleSignal()
1305 // Emits the change of input style signals.
1306 mController->ProcessInputStyleChangedSignals();
1308 // Set the pointer to null as the callback manager deletes the callback after execute it.
1309 mIdleCallback = NULL;
1312 void TextEditor::ApplyScrollPosition()
1314 const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1315 float scrollAmount = 0.0f;
1317 if(mScrollAnimationEnabled)
1319 scrollAmount = mController->GetScrollAmountByUserInput();
1321 if(mTextVerticalScroller)
1323 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1325 else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1327 mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1331 mTextVerticalScroller = Text::TextVerticalScroller::New();
1332 if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1334 mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1336 mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1340 bool TextEditor::IsEditable() const
1342 return mController->IsEditable();
1345 void TextEditor::SetEditable(bool editable)
1347 mController->SetEditable(editable);
1348 if(mInputMethodContext && !editable)
1350 mInputMethodContext.Deactivate();
1354 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1356 mController->ChangedLayoutDirection();
1359 TextEditor::TextEditor()
1360 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1361 mAnimationPeriod(0.0f, 0.0f),
1362 mIdleCallback(NULL),
1363 mAlignmentOffset(0.f),
1364 mScrollAnimationDuration(0.f),
1366 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1367 mHasBeenStaged(false),
1368 mScrollAnimationEnabled(false),
1369 mScrollBarEnabled(false),
1370 mScrollStarted(false),
1371 mTextChanged(false),
1372 mCursorPositionChanged(false),
1373 mSelectionChanged(false),
1374 mSelectionCleared(false),
1376 mOldSelectionStart(0u),
1377 mOldSelectionEnd(0u),
1378 mSelectionStarted(false)
1382 TextEditor::~TextEditor()
1384 UnparentAndReset(mStencil);
1386 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1388 // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1389 Adaptor::Get().RemoveIdle(mIdleCallback);
1393 std::string TextEditor::TextEditorAccessible::GetName() const
1395 return GetWholeText();
1398 const std::vector<Toolkit::TextAnchor>& TextEditor::TextEditorAccessible::GetTextAnchors() const
1400 auto self = Toolkit::TextEditor::DownCast(Self());
1402 return Toolkit::GetImpl(self).mAnchorActors;
1405 Toolkit::Text::ControllerPtr TextEditor::TextEditorAccessible::GetTextController() const
1407 auto self = Toolkit::TextEditor::DownCast(Self());
1409 return Toolkit::GetImpl(self).GetTextController();
1412 void TextEditor::TextEditorAccessible::RequestTextRelayout()
1414 auto self = Toolkit::TextEditor::DownCast(Self());
1415 auto& selfImpl = Toolkit::GetImpl(self);
1417 selfImpl.RequestTextRelayout();
1420 } // namespace Internal
1422 } // namespace Toolkit