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-field-impl.h>
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/adaptor-framework/key-devel.h>
24 #include <dali/devel-api/common/stage.h>
25 #include <dali/devel-api/object/property-helper-devel.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>
34 #include <dali-toolkit/devel-api/controls/control-devel.h>
35 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
36 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
37 #include <dali-toolkit/devel-api/text/rendering-backend.h>
38 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
39 #include <dali-toolkit/internal/controls/text-controls/text-field-property-handler.h>
40 #include <dali-toolkit/internal/styling/style-manager-impl.h>
41 #include <dali-toolkit/internal/text/rendering/text-backend.h>
42 #include <dali-toolkit/internal/text/text-effects-style.h>
43 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
44 #include <dali-toolkit/internal/text/text-font-style.h>
45 #include <dali-toolkit/internal/text/text-view.h>
46 #include <dali-toolkit/public-api/text/text-enumerations.h>
47 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
48 #include <dali-toolkit/public-api/visuals/visual-properties.h>
49 #include <dali/integration-api/adaptor-framework/adaptor.h>
51 using namespace Dali::Toolkit::Text;
53 #if defined(DEBUG_ENABLED)
54 Debug::Filter* gTextFieldLogFilter = 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 } // unnamed namespace
73 return Toolkit::TextField::New();
77 // Setup properties, signals and actions using the type-registry.
78 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextField, Toolkit::Control, Create );
80 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "text", STRING, TEXT )
81 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "placeholderText", STRING, PLACEHOLDER_TEXT )
82 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "placeholderTextFocused", STRING, PLACEHOLDER_TEXT_FOCUSED )
83 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "fontFamily", STRING, FONT_FAMILY )
84 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "fontStyle", MAP, FONT_STYLE )
85 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "pointSize", FLOAT, POINT_SIZE )
86 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "maxLength", INTEGER, MAX_LENGTH )
87 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "exceedPolicy", INTEGER, EXCEED_POLICY )
88 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "horizontalAlignment", STRING, HORIZONTAL_ALIGNMENT )
89 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "verticalAlignment", STRING, VERTICAL_ALIGNMENT )
90 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "textColor", VECTOR4, TEXT_COLOR )
91 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "placeholderTextColor", VECTOR4, PLACEHOLDER_TEXT_COLOR )
92 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "primaryCursorColor", VECTOR4, PRIMARY_CURSOR_COLOR )
93 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "secondaryCursorColor", VECTOR4, SECONDARY_CURSOR_COLOR )
94 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "enableCursorBlink", BOOLEAN, ENABLE_CURSOR_BLINK )
95 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "cursorBlinkInterval", FLOAT, CURSOR_BLINK_INTERVAL )
96 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "cursorBlinkDuration", FLOAT, CURSOR_BLINK_DURATION )
97 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "cursorWidth", INTEGER, CURSOR_WIDTH )
98 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "grabHandleImage", STRING, GRAB_HANDLE_IMAGE )
99 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "grabHandlePressedImage", STRING, GRAB_HANDLE_PRESSED_IMAGE )
100 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "scrollThreshold", FLOAT, SCROLL_THRESHOLD )
101 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "scrollSpeed", FLOAT, SCROLL_SPEED )
102 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandleImageLeft", MAP, SELECTION_HANDLE_IMAGE_LEFT )
103 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandleImageRight", MAP, SELECTION_HANDLE_IMAGE_RIGHT )
104 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandlePressedImageLeft", MAP, SELECTION_HANDLE_PRESSED_IMAGE_LEFT )
105 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandlePressedImageRight", MAP, SELECTION_HANDLE_PRESSED_IMAGE_RIGHT)
106 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandleMarkerImageLeft", MAP, SELECTION_HANDLE_MARKER_IMAGE_LEFT )
107 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHandleMarkerImageRight", MAP, SELECTION_HANDLE_MARKER_IMAGE_RIGHT )
108 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "selectionHighlightColor", VECTOR4, SELECTION_HIGHLIGHT_COLOR )
109 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "decorationBoundingBox", RECTANGLE, DECORATION_BOUNDING_BOX )
110 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputMethodSettings", MAP, INPUT_METHOD_SETTINGS )
111 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputColor", VECTOR4, INPUT_COLOR )
112 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "enableMarkup", BOOLEAN, ENABLE_MARKUP )
113 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputFontFamily", STRING, INPUT_FONT_FAMILY )
114 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputFontStyle", MAP, INPUT_FONT_STYLE )
115 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputPointSize", FLOAT, INPUT_POINT_SIZE )
116 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "underline", MAP, UNDERLINE )
117 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputUnderline", MAP, INPUT_UNDERLINE )
118 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "shadow", MAP, SHADOW )
119 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputShadow", MAP, INPUT_SHADOW )
120 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "emboss", MAP, EMBOSS )
121 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputEmboss", MAP, INPUT_EMBOSS )
122 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "outline", MAP, OUTLINE )
123 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "inputOutline", MAP, INPUT_OUTLINE )
124 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "hiddenInputSettings", MAP, HIDDEN_INPUT_SETTINGS )
125 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "pixelSize", FLOAT, PIXEL_SIZE )
126 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "enableSelection", BOOLEAN, ENABLE_SELECTION )
127 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "placeholder", MAP, PLACEHOLDER )
128 DALI_PROPERTY_REGISTRATION(Toolkit, TextField, "ellipsis", BOOLEAN, ELLIPSIS )
129 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "enableShiftSelection", BOOLEAN, ENABLE_SHIFT_SELECTION )
130 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "enableGrabHandle", BOOLEAN, ENABLE_GRAB_HANDLE )
131 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "matchSystemLanguageDirection", BOOLEAN, MATCH_SYSTEM_LANGUAGE_DIRECTION )
132 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "enableGrabHandlePopup", BOOLEAN, ENABLE_GRAB_HANDLE_POPUP )
133 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "textBackground", VECTOR4, BACKGROUND )
134 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextField, "selectedText", STRING, SELECTED_TEXT )
135 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "renderingBackend", INTEGER, RENDERING_BACKEND )
136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "selectedTextStart", INTEGER, SELECTED_TEXT_START )
137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "selectedTextEnd", INTEGER, SELECTED_TEXT_END )
138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "enableEditing", BOOLEAN, ENABLE_EDITING )
139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "fontSizeScale", FLOAT, FONT_SIZE_SCALE )
140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "enableFontSizeScale", BOOLEAN, ENABLE_FONT_SIZE_SCALE )
141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "primaryCursorPosition", INTEGER, PRIMARY_CURSOR_POSITION )
142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "grabHandleColor", VECTOR4, GRAB_HANDLE_COLOR )
143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "inputFilter", MAP, INPUT_FILTER )
144 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "ellipsisPosition", INTEGER, ELLIPSIS_POSITION )
145 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "strikethrough", MAP, STRIKETHROUGH )
146 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "inputStrikethrough", MAP, INPUT_STRIKETHROUGH )
147 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit, TextField, "characterSpacing", FLOAT, CHARACTER_SPACING )
149 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "textChanged", SIGNAL_TEXT_CHANGED )
150 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "maxLengthReached", SIGNAL_MAX_LENGTH_REACHED )
151 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "inputStyleChanged", SIGNAL_INPUT_STYLE_CHANGED )
152 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "anchorClicked", SIGNAL_ANCHOR_CLICKED )
153 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "inputFiltered", SIGNAL_INPUT_FILTERED )
154 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
155 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "selectionChanged", SIGNAL_SELECTION_CHANGED )
156 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "selectionCleared", SIGNAL_SELECTION_CLEARED )
157 DALI_SIGNAL_REGISTRATION(Toolkit, TextField, "selectionStarted", SIGNAL_SELECTION_STARTED )
159 DALI_TYPE_REGISTRATION_END()
162 Toolkit::TextField::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
164 Toolkit::TextField::InputStyle::Mask fieldInputStyleMask = Toolkit::TextField::InputStyle::NONE;
166 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
168 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::COLOR);
170 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
172 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::FONT_FAMILY);
174 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
176 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::POINT_SIZE);
178 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
180 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::FONT_STYLE);
182 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
184 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::FONT_STYLE);
186 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
188 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::FONT_STYLE);
190 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
192 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::UNDERLINE);
194 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
196 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::SHADOW);
198 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
200 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::EMBOSS);
202 if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
204 fieldInputStyleMask = static_cast<Toolkit::TextField::InputStyle::Mask>(fieldInputStyleMask | Toolkit::TextField::InputStyle::OUTLINE);
206 return fieldInputStyleMask;
209 bool IsHiddenInput(Toolkit::TextField textField)
211 Property::Map hiddenInputSettings = textField.GetProperty<Property::Map>(Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS);
212 auto mode = hiddenInputSettings.Find(Toolkit::HiddenInput::Property::MODE);
213 if(mode && (mode->Get<int>() != Toolkit::HiddenInput::Mode::HIDE_NONE))
220 char GetSubstituteCharacter(Toolkit::TextField textField)
222 Property::Map hiddenInputSettings = textField.GetProperty<Property::Map>(Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS);
223 auto substChar = hiddenInputSettings.Find(Toolkit::HiddenInput::Property::SUBSTITUTE_CHARACTER);
226 return static_cast<char>(substChar->Get<int>());
233 Toolkit::TextField TextField::New()
235 // Create the implementation, temporarily owned by this handle on stack
236 IntrusivePtr<TextField> impl = new TextField();
238 // Pass ownership to CustomActor handle
239 Toolkit::TextField handle(*impl);
241 // Second-phase init of the implementation
242 // This can only be done after the CustomActor connection has been made...
248 void TextField::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
250 Toolkit::TextField textField = Toolkit::TextField::DownCast(Dali::BaseHandle(object));
252 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField SetProperty\n");
256 PropertyHandler::SetProperty(textField, index, value);
260 Property::Value TextField::GetProperty(BaseObject* object, Property::Index index)
262 Property::Value value;
264 Toolkit::TextField textField = Toolkit::TextField::DownCast(Dali::BaseHandle(object));
268 value = PropertyHandler::GetProperty(textField, index);
274 void TextField::SelectWholeText()
276 if(mController && mController->IsShowingRealText())
278 mController->SelectWholeText();
283 void TextField::SelectNone()
285 if(mController && mController->IsShowingRealText())
287 mController->SelectNone();
291 void TextField::SelectText(const uint32_t start, const uint32_t end)
293 if(mController && mController->IsShowingRealText())
295 mController->SelectText(start, end);
300 string TextField::GetSelectedText() const
302 string selectedText = "";
303 if(mController && mController->IsShowingRealText())
305 selectedText = mController->GetSelectedText();
310 void TextField::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
312 if(mController && mController->IsShowingRealText())
314 mController->SetTextSelectionRange(start, end);
319 Uint32Pair TextField::GetTextSelectionRange() const
322 if(mController && mController->IsShowingRealText())
324 range = mController->GetTextSelectionRange();
329 string TextField::CopyText()
331 string copiedText = "";
332 if(mController && mController->IsShowingRealText())
334 copiedText = mController->CopyText();
339 string TextField::CutText()
342 if(mController && mController->IsShowingRealText())
344 cutText = mController->CutText();
349 void TextField::PasteText()
353 SetKeyInputFocus(); //Giving focus to the field that was passed to the PasteText in case the passed field (current field) doesn't have focus.
354 mController->PasteText();
358 InputMethodContext TextField::GetInputMethodContext()
360 return mInputMethodContext;
363 bool TextField::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
365 Dali::BaseHandle handle(object);
367 bool connected(true);
368 Toolkit::TextField field = Toolkit::TextField::DownCast(handle);
370 if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
372 field.TextChangedSignal().Connect(tracker, functor);
374 else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
376 field.MaxLengthReachedSignal().Connect(tracker, functor);
378 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
380 field.InputStyleChangedSignal().Connect(tracker, functor);
382 else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
386 Internal::TextField& fieldImpl(GetImpl(field));
387 fieldImpl.AnchorClickedSignal().Connect(tracker, functor);
390 else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
394 Internal::TextField& fieldImpl(GetImpl(field));
395 fieldImpl.CursorPositionChangedSignal().Connect(tracker, functor);
398 else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
402 Internal::TextField& fieldImpl(GetImpl(field));
403 fieldImpl.InputFilteredSignal().Connect(tracker, functor);
406 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
410 Internal::TextField& fieldImpl(GetImpl(field));
411 fieldImpl.SelectionChangedSignal().Connect(tracker, functor);
414 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
418 Internal::TextField& fieldImpl(GetImpl(field));
419 fieldImpl.SelectionClearedSignal().Connect(tracker, functor);
422 else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
426 Internal::TextField& fieldImpl(GetImpl(field));
427 fieldImpl.SelectionStartedSignal().Connect(tracker, functor);
432 // signalName does not match any signal
439 Toolkit::TextField::TextChangedSignalType& TextField::TextChangedSignal()
441 return mTextChangedSignal;
444 Toolkit::TextField::MaxLengthReachedSignalType& TextField::MaxLengthReachedSignal()
446 return mMaxLengthReachedSignal;
449 Toolkit::TextField::InputStyleChangedSignalType& TextField::InputStyleChangedSignal()
451 return mInputStyleChangedSignal;
454 DevelTextField::AnchorClickedSignalType& TextField::AnchorClickedSignal()
456 return mAnchorClickedSignal;
459 DevelTextField::CursorPositionChangedSignalType& TextField::CursorPositionChangedSignal()
461 return mCursorPositionChangedSignal;
464 DevelTextField::InputFilteredSignalType& TextField::InputFilteredSignal()
466 return mInputFilteredSignal;
469 DevelTextField::SelectionChangedSignalType& TextField::SelectionChangedSignal()
471 return mSelectionChangedSignal;
474 DevelTextField::SelectionClearedSignalType& TextField::SelectionClearedSignal()
476 return mSelectionClearedSignal;
479 DevelTextField::SelectionStartedSignalType& TextField::SelectionStartedSignal()
481 return mSelectionStartedSignal;
484 void TextField::OnAccessibilityStatusChanged()
486 CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
489 void TextField::OnInitialize()
493 mController = Text::Controller::New(this, this, this, this);
495 // When using the vector-based rendering, the size of the GLyphs are different
496 TextAbstraction::GlyphType glyphType = (DevelText::RENDERING_VECTOR_BASED == mRenderingBackend) ? TextAbstraction::VECTOR_GLYPH : TextAbstraction::BITMAP_GLYPH;
497 mController->SetGlyphType(glyphType);
499 mDecorator = Text::Decorator::New(*mController,
502 mInputMethodContext = InputMethodContext::New(self);
504 mController->GetLayoutEngine().SetLayout(Layout::Engine::SINGLE_LINE_BOX);
506 // Enables the text input.
507 mController->EnableTextInput(mDecorator, mInputMethodContext);
509 // Enables the horizontal scrolling after the text input has been enabled.
510 mController->SetHorizontalScrollEnabled(true);
512 // Disables the vertical scrolling.
513 mController->SetVerticalScrollEnabled(false);
515 // Disable the smooth handle panning.
516 mController->SetSmoothHandlePanEnabled(false);
518 mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
519 mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
521 // Sets layoutDirection value
522 Dali::Stage stage = Dali::Stage::GetCurrent();
523 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
524 mController->SetLayoutDirection(layoutDirection);
526 self.LayoutDirectionChangedSignal().Connect(this, &TextField::OnLayoutDirectionChanged);
528 // Forward input events to controller
529 EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
530 GetTapGestureDetector().SetMaximumTapsRequired(2);
531 GetTapGestureDetector().ReceiveAllTapEvents(true);
533 self.TouchedSignal().Connect(this, &TextField::OnTouched);
535 // Set BoundingBox to stage size if not already set.
536 Rect<int> boundingBox;
537 mDecorator->GetBoundingBox(boundingBox);
539 if(boundingBox.IsEmpty())
541 Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
542 mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
545 // Flip vertically the 'left' selection handle
546 mDecorator->FlipHandleVertically(LEFT_SELECTION_HANDLE, true);
548 // Fill-parent area by default
549 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
550 self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
551 self.OnSceneSignal().Connect(this, &TextField::OnSceneConnect);
553 //Enable highightability
554 self.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
556 DevelControl::SetInputMethodContext(*this, mInputMethodContext);
558 if(Dali::Toolkit::TextField::EXCEED_POLICY_CLIP == mExceedPolicy)
563 DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) {
564 return std::make_unique<TextFieldAccessible>(actor, Dali::Accessibility::Role::ENTRY);
567 Accessibility::Bridge::EnabledSignal().Connect(this, &TextField::OnAccessibilityStatusChanged);
568 Accessibility::Bridge::DisabledSignal().Connect(this, &TextField::OnAccessibilityStatusChanged);
571 void TextField::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
573 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnStyleChange\n");
577 case StyleChange::DEFAULT_FONT_CHANGE:
579 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnStyleChange DEFAULT_FONT_CHANGE\n");
580 const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
581 // Property system did not set the font so should update it.
582 mController->UpdateAfterFontChange(newFont);
587 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
589 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
593 case StyleChange::THEME_CHANGE:
595 // Nothing to do, let control base class handle this
600 // Up call to Control
601 Control::OnStyleChange(styleManager, change);
604 Vector3 TextField::GetNaturalSize()
607 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
609 Vector3 naturalSize = mController->GetNaturalSize();
610 naturalSize.width += (padding.start + padding.end);
611 naturalSize.height += (padding.top + padding.bottom);
616 float TextField::GetHeightForWidth(float width)
619 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
620 return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
623 void TextField::ResizeActor(Actor& actor, const Vector2& size)
625 if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
627 actor.SetProperty(Actor::Property::SIZE, size);
631 void TextField::OnRelayout(const Vector2& size, RelayoutContainer& container)
633 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField OnRelayout\n");
638 padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
640 Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
642 // Support Right-To-Left of padding
643 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
645 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
647 std::swap(padding.start, padding.end);
652 mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
653 ResizeActor(mStencil, contentSize);
657 mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
658 ResizeActor(mActiveLayer, contentSize);
662 mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
663 ResizeActor(mCursorLayer, contentSize);
666 // If there is text changed, callback is called.
669 EmitTextChangedSignal();
672 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
674 if((Text::Controller::NONE_UPDATED != updateTextType) ||
677 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnRelayout %p Displaying new contents\n", mController.Get());
680 (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
682 mDecorator->Relayout(contentSize);
687 mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
690 RenderText(updateTextType);
693 if(mCursorPositionChanged)
695 EmitCursorPositionChangedSignal();
698 if(mSelectionStarted)
700 EmitSelectionStartedSignal();
703 if(mSelectionChanged)
705 EmitSelectionChangedSignal();
708 if(mSelectionCleared)
710 EmitSelectionClearedSignal();
713 // The text-field emits signals when the input style changes. These changes of style are
714 // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
715 // can't be emitted during the size negotiation as the callbacks may update the UI.
716 // The text-field adds an idle callback to the adaptor to emit the signals after the size negotiation.
717 if(!mController->IsInputStyleChangedSignalsQueueEmpty())
719 if(Adaptor::IsAvailable())
721 Adaptor& adaptor = Adaptor::Get();
723 if(NULL == mIdleCallback)
725 // @note: The callback manager takes the ownership of the callback object.
726 mIdleCallback = MakeCallback(this, &TextField::OnIdleSignal);
727 adaptor.AddIdle(mIdleCallback, false);
733 Text::ControllerPtr TextField::GetTextController()
738 void TextField::RenderText(Text::Controller::UpdateTextType updateTextType)
740 CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
743 void TextField::OnKeyInputFocusGained()
745 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnKeyInputFocusGained %p\n", mController.Get());
746 if(mInputMethodContext && IsEditable())
748 // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
749 mInputMethodContext.ApplyOptions(mInputMethodOptions);
750 mInputMethodContext.NotifyTextInputMultiLine(false);
752 mInputMethodContext.StatusChangedSignal().Connect(this, &TextField::KeyboardStatusChanged);
754 mInputMethodContext.EventReceivedSignal().Connect(this, &TextField::OnInputMethodContextEvent);
756 // Notify that the text editing start.
757 mInputMethodContext.Activate();
759 // When window gain lost focus, the inputMethodContext is deactivated. Thus when window gain focus again, the inputMethodContext must be activated.
760 mInputMethodContext.SetRestoreAfterFocusLost(true);
762 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
766 notifier.ContentSelectedSignal().Connect(this, &TextField::OnClipboardTextSelected);
769 mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
771 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
774 void TextField::OnKeyInputFocusLost()
776 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField:OnKeyInputFocusLost %p\n", mController.Get());
777 if(mInputMethodContext)
779 mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextField::KeyboardStatusChanged);
780 // The text editing is finished. Therefore the inputMethodContext don't have restore activation.
781 mInputMethodContext.SetRestoreAfterFocusLost(false);
783 // Notify that the text editing finish.
784 mInputMethodContext.Deactivate();
786 mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextField::OnInputMethodContextEvent);
788 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
792 notifier.ContentSelectedSignal().Disconnect(this, &TextField::OnClipboardTextSelected);
795 mController->KeyboardFocusLostEvent();
797 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
800 bool TextField::OnAccessibilityActivated()
806 void TextField::OnTap(const TapGesture& gesture)
808 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnTap %p\n", mController.Get());
809 if(mInputMethodContext && IsEditable())
811 mInputMethodContext.Activate();
813 // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
815 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
816 const Vector2& localPoint = gesture.GetLocalPoint();
817 mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
818 mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
823 void TextField::OnPan(const PanGesture& gesture)
825 mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
828 void TextField::OnLongPress(const LongPressGesture& gesture)
830 if(mInputMethodContext && IsEditable())
832 mInputMethodContext.Activate();
835 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
836 const Vector2& localPoint = gesture.GetLocalPoint();
837 mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
842 bool TextField::OnKeyEvent(const KeyEvent& event)
844 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
846 if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
848 // Make sure ClearKeyInputFocus when only key is up
849 if(event.GetState() == KeyEvent::UP)
851 ClearKeyInputFocus();
856 else if(Dali::DevelKey::DALI_KEY_RETURN == event.GetKeyCode())
858 // Do nothing when enter is comming.
862 return mController->KeyEvent(event);
865 void TextField::RequestTextRelayout()
870 bool TextField::IsEditable() const
872 return mController->IsEditable();
875 void TextField::SetEditable(bool editable)
877 mController->SetEditable(editable);
878 if(mInputMethodContext && !editable)
880 mInputMethodContext.Deactivate();
884 void TextField::TextInserted(unsigned int position, unsigned int length, const std::string& content)
886 if(Accessibility::IsUp())
888 Control::Impl::GetAccessibilityObject(Self())->EmitTextInserted(position, length, content);
892 void TextField::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
894 if(Accessibility::IsUp())
896 Control::Impl::GetAccessibilityObject(Self())->EmitTextDeleted(position, length, content);
900 void TextField::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
902 if(Accessibility::IsUp())
904 Control::Impl::GetAccessibilityObject(Self())->EmitTextCursorMoved(newPosition);
907 if((oldPosition != newPosition) && !mCursorPositionChanged)
909 mCursorPositionChanged = true;
910 mOldPosition = oldPosition;
914 void TextField::TextChanged(bool immediate)
916 if(immediate) // Emits TextChangedSignal immediately
918 EmitTextChangedSignal();
926 void TextField::EmitTextChangedSignal()
928 Dali::Toolkit::TextField handle(GetOwner());
929 mTextChangedSignal.Emit(handle);
930 mTextChanged = false;
933 void TextField::MaxLengthReached()
935 Dali::Toolkit::TextField handle(GetOwner());
936 mMaxLengthReachedSignal.Emit(handle);
939 void TextField::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
941 Dali::Toolkit::TextField handle(GetOwner());
942 mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
945 void TextField::AnchorClicked(const std::string& href)
947 Dali::Toolkit::TextField handle(GetOwner());
948 mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
951 void TextField::EmitCursorPositionChangedSignal()
953 Dali::Toolkit::TextField handle(GetOwner());
954 mCursorPositionChangedSignal.Emit(handle, mOldPosition);
955 mCursorPositionChanged = false;
958 void TextField::InputFiltered(Toolkit::InputFilter::Property::Type type)
960 Dali::Toolkit::TextField handle(GetOwner());
961 mInputFilteredSignal.Emit(handle, type);
964 void TextField::EmitSelectionChangedSignal()
966 Dali::Toolkit::TextField handle(GetOwner());
967 mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
968 mSelectionChanged = false;
971 void TextField::EmitSelectionClearedSignal()
973 Dali::Toolkit::TextField handle(GetOwner());
974 mSelectionClearedSignal.Emit(handle);
975 mSelectionCleared = false;
978 void TextField::EmitSelectionStartedSignal()
980 Dali::Toolkit::TextField handle(GetOwner());
981 mSelectionStartedSignal.Emit(handle);
982 mSelectionStarted = false;
985 void TextField::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
987 if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
989 if(newStart == newEnd)
991 mSelectionCleared = true;
995 if(oldStart == oldEnd)
997 mSelectionStarted = true;
1001 mSelectionChanged = true;
1002 mOldSelectionStart = oldStart;
1003 mOldSelectionEnd = oldEnd;
1005 if(mOldSelectionStart > mOldSelectionEnd)
1008 uint32_t temp = mOldSelectionStart;
1009 mOldSelectionStart = mOldSelectionEnd;
1010 mOldSelectionEnd = temp;
1015 void TextField::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1021 mClippingDecorationActors.push_back(actor);
1024 // If the actor is a layer type, add it.
1025 if(type == DecorationType::ACTIVE_LAYER)
1027 AddLayer(mActiveLayer, actor);
1029 else if(type == DecorationType::CURSOR_LAYER)
1031 AddLayer(mCursorLayer, actor);
1036 void TextField::AddLayer(Actor& layer, Actor& actor)
1038 actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1039 actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1044 void TextField::GetControlBackgroundColor(Vector4& color) const
1046 Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1047 Property::Map* resultMap = propValue.GetMap();
1049 Property::Value* colorValue = nullptr;
1050 if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1052 colorValue->Get(color);
1056 void TextField::OnSceneConnect(Dali::Actor actor)
1060 RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1064 mHasBeenStaged = true;
1068 InputMethodContext::CallbackData TextField::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1070 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1071 return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1074 void TextField::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1079 map[PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1085 void TextField::EnableClipping()
1089 // Creates an extra control to be used as stencil buffer.
1090 mStencil = Control::New();
1091 mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1092 mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1094 // Creates a background visual. Even if the color is transparent it updates the stencil.
1095 mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
1096 Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
1098 // Enable the clipping property.
1099 mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
1100 mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
1102 Self().Add(mStencil);
1106 void TextField::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1108 mController->PasteClipboardItemEvent();
1111 void TextField::KeyboardStatusChanged(bool keyboardShown)
1113 DALI_LOG_INFO(gTextFieldLogFilter, Debug::Verbose, "TextField::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1115 // Just hide the grab handle when keyboard is hidden.
1118 mController->KeyboardFocusLostEvent();
1122 mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1126 void TextField::OnSceneConnection(int depth)
1128 // Sets the depth to the visuals inside the text's decorator.
1129 mDecorator->SetTextDepth(depth);
1131 // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1133 // Call the Control::OnSceneConnection() to set the depth of the background.
1134 Control::OnSceneConnection(depth);
1137 bool TextField::OnTouched(Actor actor, const TouchEvent& touch)
1142 void TextField::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1144 mController->ChangedLayoutDirection();
1147 void TextField::OnIdleSignal()
1149 // Emits the change of input style signals.
1150 mController->ProcessInputStyleChangedSignals();
1152 // Set the pointer to null as the callback manager deletes the callback after execute it.
1153 mIdleCallback = NULL;
1156 TextField::TextField()
1157 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
1158 mIdleCallback(NULL),
1159 mAlignmentOffset(0.f),
1160 mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1161 mExceedPolicy(Dali::Toolkit::TextField::EXCEED_POLICY_CLIP),
1162 mHasBeenStaged(false),
1163 mTextChanged(false),
1164 mCursorPositionChanged(false),
1165 mSelectionChanged(false),
1166 mSelectionCleared(false),
1168 mOldSelectionStart(0u),
1169 mOldSelectionEnd(0u),
1170 mSelectionStarted(false)
1174 TextField::~TextField()
1176 UnparentAndReset(mStencil);
1178 if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1180 Adaptor::Get().RemoveIdle(mIdleCallback);
1184 Vector<Vector2> TextField::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
1186 return mController->GetTextSize(startIndex, endIndex);
1189 Vector<Vector2> TextField::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
1191 return mController->GetTextPosition(startIndex, endIndex);
1194 std::string TextField::TextFieldAccessible::GetName() const
1196 auto self = Toolkit::TextField::DownCast(Self());
1197 if(IsHiddenInput(self))
1202 return self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1205 std::string TextField::TextFieldAccessible::GetText(size_t startOffset, size_t endOffset) const
1207 if(endOffset <= startOffset)
1212 auto self = Toolkit::TextField::DownCast(Self());
1213 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1215 if(startOffset > text.size() || endOffset > text.size())
1219 if(IsHiddenInput(self))
1221 return std::string(endOffset - startOffset, GetSubstituteCharacter(self));
1223 return text.substr(startOffset, endOffset - startOffset);
1226 size_t TextField::TextFieldAccessible::GetCharacterCount() const
1228 auto self = Toolkit::TextField::DownCast(Self());
1229 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1234 size_t TextField::TextFieldAccessible::GetCursorOffset() const
1236 auto self = Toolkit::TextField::DownCast(Self());
1237 return Dali::Toolkit::GetImpl(self).GetTextController()->GetCursorPosition();
1240 bool TextField::TextFieldAccessible::SetCursorOffset(size_t offset)
1242 auto self = Toolkit::TextField::DownCast(Self());
1243 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1244 if(offset > text.size())
1249 auto& selfImpl = Dali::Toolkit::GetImpl(self);
1250 selfImpl.GetTextController()->ResetCursorPosition(offset);
1251 selfImpl.RequestTextRelayout();
1256 Dali::Accessibility::Range TextField::TextFieldAccessible::GetTextAtOffset(
1257 size_t offset, Dali::Accessibility::TextBoundary boundary) const
1259 auto self = Toolkit::TextField::DownCast(Self());
1260 auto range = Dali::Accessibility::Range{};
1262 if(IsHiddenInput(self))
1264 // Returning empty object, as there is no possibility to parse the textfield
1265 // when its content is hidden.
1269 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1270 auto textSize = text.size();
1274 case Dali::Accessibility::TextBoundary::CHARACTER:
1276 if(offset < textSize)
1278 range.content = text[offset];
1279 range.startOffset = offset;
1280 range.endOffset = offset + 1;
1284 case Dali::Accessibility::TextBoundary::WORD:
1285 case Dali::Accessibility::TextBoundary::LINE:
1287 auto textString = text.c_str();
1288 auto breaks = std::vector<char>(textSize, 0);
1290 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1292 Accessibility::Accessible::FindWordSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1296 Accessibility::Accessible::FindLineSeparationsUtf8(reinterpret_cast<const utf8_t*>(textString), textSize, "", breaks.data());
1301 while(index < textSize && counter <= offset)
1306 while(breaks[index])
1314 if(boundary == Dali::Accessibility::TextBoundary::WORD)
1318 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1324 if((counter > 0) && ((counter - 1) == offset))
1326 range.content = text.substr(start, index - start + 1);
1327 range.startOffset = start;
1328 range.endOffset = index + 1;
1331 if(boundary == Dali::Accessibility::TextBoundary::LINE)
1338 case Dali::Accessibility::TextBoundary::SENTENCE:
1340 /* not supported by default */
1343 case Dali::Accessibility::TextBoundary::PARAGRAPH:
1345 /* Paragraph is not supported by libunibreak library */
1355 Dali::Accessibility::Range TextField::TextFieldAccessible::GetRangeOfSelection(size_t selectionIndex) const
1357 // Since DALi supports only one selection indexes higher than 0 are ignored
1358 if(selectionIndex > 0)
1363 auto self = Toolkit::TextField::DownCast(Self());
1364 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1365 auto indices = controller->GetSelectionIndexes();
1367 auto startOffset = static_cast<size_t>(indices.first);
1368 auto endOffset = static_cast<size_t>(indices.second);
1370 if(IsHiddenInput(self))
1372 return {startOffset, endOffset, std::string(endOffset - startOffset, GetSubstituteCharacter(self))};
1375 std::string value{};
1376 controller->RetrieveSelection(value);
1377 return {startOffset, endOffset, value};
1380 bool TextField::TextFieldAccessible::RemoveSelection(size_t selectionIndex)
1382 // Since DALi supports only one selection indexes higher than 0 are ignored
1383 if(selectionIndex > 0)
1388 auto self = Toolkit::TextField::DownCast(Self());
1389 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(0, 0);
1393 bool TextField::TextFieldAccessible::SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset)
1395 // Since DALi supports only one selection indexes higher than 0 are ignored
1396 if(selectionIndex > 0)
1401 auto self = Toolkit::TextField::DownCast(Self());
1402 Dali::Toolkit::GetImpl(self).GetTextController()->SetSelection(startOffset, endOffset);
1406 Rect<> TextField::TextFieldAccessible::GetRangeExtents(size_t startOffset, size_t endOffset, Accessibility::CoordinateType type)
1408 if (endOffset <= startOffset || endOffset <= 0)
1410 return {0, 0, 0, 0};
1413 auto self = Toolkit::TextField::DownCast(Self());
1414 auto rect = Dali::Toolkit::GetImpl(self).GetTextController()->GetTextBoundingRectangle(startOffset, endOffset - 1);
1416 auto componentExtents = this->GetExtents(type);
1418 rect.x += componentExtents.x;
1419 rect.y += componentExtents.y;
1424 bool TextField::TextFieldAccessible::CopyText(size_t startPosition, size_t endPosition)
1426 if(endPosition <= startPosition)
1431 auto self = Toolkit::TextField::DownCast(Self());
1432 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1433 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1438 bool TextField::TextFieldAccessible::CutText(size_t startPosition, size_t endPosition)
1440 if(endPosition <= startPosition)
1445 auto self = Toolkit::TextField::DownCast(Self());
1446 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1447 Dali::Toolkit::GetImpl(self).GetTextController()->CopyStringToClipboard(text.substr(startPosition, endPosition - startPosition));
1449 self.SetProperty(Toolkit::TextField::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1454 bool TextField::TextFieldAccessible::DeleteText(size_t startPosition, size_t endPosition)
1456 if(endPosition <= startPosition)
1461 auto self = Toolkit::TextField::DownCast(Self());
1462 auto text = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1464 self.SetProperty(Toolkit::TextField::Property::TEXT, text.substr(0, startPosition) + text.substr(endPosition));
1469 Dali::Accessibility::States TextField::TextFieldAccessible::CalculateStates()
1471 using namespace Dali::Accessibility;
1473 auto states = DevelControl::ControlAccessible::CalculateStates();
1475 states[State::EDITABLE] = true;
1476 states[State::FOCUSABLE] = true;
1478 Toolkit::Control focusControl = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
1479 if(Self() == focusControl)
1481 states[State::FOCUSED] = true;
1487 bool TextField::TextFieldAccessible::InsertText(size_t startPosition, std::string text)
1489 auto self = Toolkit::TextField::DownCast(Self());
1490 auto insertedText = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
1492 insertedText.insert(startPosition, text);
1494 self.SetProperty(Toolkit::TextField::Property::TEXT, std::move(insertedText));
1499 bool TextField::TextFieldAccessible::SetTextContents(std::string newContents)
1501 auto self = Toolkit::TextField::DownCast(Self());
1502 self.SetProperty(Toolkit::TextField::Property::TEXT, std::move(newContents));
1506 int32_t TextField::TextFieldAccessible::GetLinkCount() const
1508 auto self = Toolkit::TextField::DownCast(Self());
1509 return Dali::Toolkit::GetImpl(self).mAnchorActors.size();
1512 Accessibility::Hyperlink* TextField::TextFieldAccessible::GetLink(int32_t linkIndex) const
1514 if(linkIndex < 0 || linkIndex >= GetLinkCount())
1518 auto self = Toolkit::TextField::DownCast(Self());
1519 auto anchorActor = Dali::Toolkit::GetImpl(self).mAnchorActors[linkIndex];
1520 return dynamic_cast<Accessibility::Hyperlink*>(Dali::Accessibility::Accessible::Get(anchorActor));
1523 int32_t TextField::TextFieldAccessible::GetLinkIndex(int32_t characterOffset) const
1525 auto self = Toolkit::TextField::DownCast(Self());
1526 auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
1527 return controller->GetAnchorIndex(static_cast<size_t>(characterOffset));
1530 } // namespace Internal
1532 } // namespace Toolkit