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/text/controller/text-controller-event-handler.h>
22 #include <dali/devel-api/adaptor-framework/key-devel.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/integration-api/trace.h>
27 #include <dali-toolkit/internal/text/controller/text-controller-impl.h>
28 #include <dali-toolkit/internal/text/controller/text-controller-placeholder-handler.h>
29 #include <dali-toolkit/internal/text/controller/text-controller-text-updater.h>
30 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
31 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
35 #if defined(DEBUG_ENABLED)
36 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
39 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_TEXT_PERFORMANCE_MARKER, false);
41 const char* KEY_C_NAME = "c";
42 const char* KEY_V_NAME = "v";
43 const char* KEY_X_NAME = "x";
44 const char* KEY_A_NAME = "a";
45 const char* KEY_INSERT_NAME = "Insert";
55 void Controller::EventHandler::KeyboardFocusGainEvent(Controller& controller)
57 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusGainEvent");
59 if(NULL != controller.mImpl->mEventData)
61 if((EventData::INACTIVE == controller.mImpl->mEventData->mState) ||
62 (EventData::INTERRUPTED == controller.mImpl->mEventData->mState))
64 controller.mImpl->ChangeState(EventData::EDITING);
65 controller.mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
66 controller.mImpl->mEventData->mUpdateInputStyle = true;
67 controller.mImpl->mEventData->mScrollAfterUpdatePosition = true;
69 controller.mImpl->NotifyInputMethodContextMultiLineStatus();
70 if(controller.mImpl->IsShowingPlaceholderText())
72 // Show alternative placeholder-text when editing
73 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
76 controller.mImpl->RequestRelayout();
80 void Controller::EventHandler::KeyboardFocusLostEvent(Controller& controller)
82 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusLostEvent");
84 if(NULL != controller.mImpl->mEventData)
86 if(EventData::INTERRUPTED != controller.mImpl->mEventData->mState)
88 // Init selection position
89 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
91 uint32_t oldStart, oldEnd;
92 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
93 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
95 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
96 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
98 if(controller.mImpl->mSelectableControlInterface != nullptr)
100 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mPrimaryCursorPosition, controller.mImpl->mEventData->mPrimaryCursorPosition);
104 controller.mImpl->ChangeState(EventData::INACTIVE);
106 if(!controller.mImpl->IsShowingRealText())
108 // Revert to regular placeholder-text when not editing
109 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
113 controller.mImpl->RequestRelayout();
116 bool Controller::EventHandler::KeyEvent(Controller& controller, const Dali::KeyEvent& keyEvent)
118 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyEvent");
120 bool textChanged = false;
121 bool relayoutNeeded = false;
122 bool isEditable = controller.IsEditable() && controller.IsUserInteractionEnabled();
124 if((NULL != controller.mImpl->mEventData) &&
125 (keyEvent.GetState() == KeyEvent::DOWN))
127 int keyCode = keyEvent.GetKeyCode();
128 const std::string& keyString = keyEvent.GetKeyString();
129 const std::string keyName = keyEvent.GetKeyName();
130 // Key will produce same logical-key value when ctrl
131 // is down, regardless of language layout
132 const std::string logicalKey = keyEvent.GetLogicalKey();
134 const bool isNullKey = (0 == keyCode) && (keyString.empty());
136 // Pre-process to separate modifying events from non-modifying input events.
139 // In some platforms arrive key events with no key code.
143 else if(Dali::DALI_KEY_ESCAPE == keyCode || Dali::DALI_KEY_BACK == keyCode || Dali::DALI_KEY_SEARCH == keyCode)
148 else if((Dali::DALI_KEY_CURSOR_LEFT == keyCode) ||
149 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode) ||
150 (Dali::DALI_KEY_CURSOR_UP == keyCode) ||
151 (Dali::DALI_KEY_CURSOR_DOWN == keyCode))
153 // If don't have any text, do nothing.
154 if(!controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters || !isEditable)
159 uint32_t cursorPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
160 uint32_t numberOfCharacters = controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
161 uint32_t cursorLine = controller.mImpl->mModel->mVisualModel->GetLineOfCharacter(cursorPosition);
162 uint32_t numberOfLines = controller.mImpl->mModel->GetNumberOfLines();
164 // Logic to determine whether this text control will lose focus or not.
165 if((Dali::DALI_KEY_CURSOR_LEFT == keyCode && 0 == cursorPosition && !keyEvent.IsShiftModifier()) ||
166 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode && numberOfCharacters == cursorPosition && !keyEvent.IsShiftModifier()) ||
167 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && cursorLine == numberOfLines - 1) ||
168 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && numberOfCharacters == cursorPosition && cursorLine - 1 == numberOfLines - 1) ||
169 (Dali::DALI_KEY_CURSOR_UP == keyCode && cursorLine == 0) ||
170 (Dali::DALI_KEY_CURSOR_UP == keyCode && numberOfCharacters == cursorPosition && cursorLine == 1))
172 // Release the active highlight.
173 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
175 uint32_t oldStart, oldEnd;
176 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
177 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
179 controller.mImpl->ChangeState(EventData::EDITING);
181 // Update selection position.
182 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
183 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
184 controller.mImpl->mEventData->mUpdateCursorPosition = true;
186 if(controller.mImpl->mSelectableControlInterface != nullptr)
188 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
191 controller.mImpl->RequestRelayout();
196 if(controller.mImpl->mEventData->mState == EventData::INACTIVE)
198 // Cursor position will be updated
199 controller.mImpl->ChangeState(EventData::EDITING);
202 controller.mImpl->mEventData->mCheckScrollAmount = true;
203 Event event(Event::CURSOR_KEY_EVENT);
204 event.p1.mInt = keyCode;
205 event.p2.mBool = keyEvent.IsShiftModifier();
206 controller.mImpl->mEventData->mEventQueue.push_back(event);
208 // Will request for relayout.
209 relayoutNeeded = true;
211 else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
213 // Left or Right Control key event is received before Ctrl-C/V/X key event is received
214 // If not handle it here, any selected text will be deleted
219 else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier() && isEditable)
221 bool consumed = false;
222 if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
224 if(!keyEvent.IsRepeat())
226 // Ctrl-C or Ctrl+Insert to copy the selected text
227 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
231 else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
233 // Ctrl-V to paste the copied text
234 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
237 else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
239 // Ctrl-X to cut the selected text
240 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
243 else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
245 // Ctrl-A to select All the text
246 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
251 else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
252 (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
254 textChanged = DeleteEvent(controller, keyCode);
256 // Will request for relayout.
257 relayoutNeeded = true;
259 else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
260 IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
261 IsKey(keyEvent, Dali::DALI_KEY_HOME))
263 // Power key/Menu/Home key behaviour does not allow edit mode to resume.
264 controller.mImpl->ChangeState(EventData::INACTIVE);
266 // Will request for relayout.
267 relayoutNeeded = true;
269 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
271 else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
273 // DALI_KEY_SHIFT_LEFT or DALI_KEY_SHIFT_RIGHT is the key code for Shift. It's sent (by the InputMethodContext?) when the predictive text is enabled
274 // and a character is typed after the type of a upper case latin character.
279 else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
281 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
287 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
288 if(!isEditable) return false;
290 std::string refinedKey = keyString;
291 if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
293 bool accepted = false;
294 bool rejected = false;
295 accepted = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
296 rejected = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
300 // The filtered key is set to empty.
302 // Signal emits when the character to be inserted is filtered by the accepted filter.
303 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
307 // The filtered key is set to empty.
309 // Signal emits when the character to be inserted is filtered by the rejected filter.
310 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
314 if(!refinedKey.empty())
316 // InputMethodContext is no longer handling key-events
317 controller.mImpl->ClearPreEditFlag();
319 TextUpdater::InsertText(controller, refinedKey, COMMIT);
323 // Will request for relayout.
324 relayoutNeeded = true;
328 if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
329 (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
331 (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
332 (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
333 (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
334 (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
336 // Should not change the state if the key is the shift send by the InputMethodContext.
337 // Otherwise, when the state is SELECTING the text controller can't send the right
338 // surrounding info to the InputMethodContext.
339 controller.mImpl->ChangeState(EventData::EDITING);
341 // Will request for relayout.
342 relayoutNeeded = true;
347 controller.mImpl->RequestRelayout();
350 else if((NULL != controller.mImpl->mEventData) && (keyEvent.GetState() == KeyEvent::UP))
352 // Handles specific keys that require event propagation.
353 if(Dali::DALI_KEY_BACK == keyEvent.GetKeyCode())
361 (NULL != controller.mImpl->mEditableControlInterface))
363 // Do this last since it provides callbacks into application code
364 controller.mImpl->mEditableControlInterface->TextChanged(false);
370 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
372 if(!controller.mImpl->mMarkupProcessorEnabled ||
373 !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
374 !controller.mImpl->IsShowingRealText())
379 CharacterIndex cursorPosition = 0u;
381 // Convert from control's coords to text's coords.
383 const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
384 const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
386 Vector2 visualTransformOffset = controller.mImpl->mModel->mVisualTransformOffset;
388 // Whether to touch point hits on a glyph.
389 bool matchedCharacter = false;
390 cursorPosition = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
391 controller.mImpl->mModel->mLogicalModel,
392 controller.mImpl->mMetrics,
394 yPosition - visualTransformOffset.y,
395 CharacterHitTest::TAP,
398 for(auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
400 // Anchor clicked if the calculated cursor position is within the range of anchor.
401 if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
403 if(controller.mImpl->mAnchorControlInterface)
405 if(!anchor.isClicked)
407 anchor.isClicked = true;
408 // TODO: in mutable text, the anchor color and underline run index should be able to be updated.
409 if(!controller.IsEditable())
411 // If there is a markup clicked color attribute, use it. Otherwise, use the property color.
412 if(controller.mImpl->mModel->mLogicalModel->mColorRuns.Count() > anchor.colorRunIndex)
414 ColorRun& colorRun = *(controller.mImpl->mModel->mLogicalModel->mColorRuns.Begin() + anchor.colorRunIndex);
415 colorRun.color = anchor.isMarkupClickedColorSet ? anchor.markupClickedColor : controller.mImpl->mAnchorClickedColor;
417 if(controller.mImpl->mModel->mLogicalModel->mUnderlinedCharacterRuns.Count() > anchor.underlinedCharacterRunIndex)
419 UnderlinedCharacterRun& underlineRun = *(controller.mImpl->mModel->mLogicalModel->mUnderlinedCharacterRuns.Begin() + anchor.underlinedCharacterRunIndex);
420 underlineRun.properties.color = anchor.isMarkupClickedColorSet ? anchor.markupClickedColor : controller.mImpl->mAnchorClickedColor;
423 controller.mImpl->ClearFontData();
424 controller.mImpl->mOperationsPending = static_cast<OperationsMask>(controller.mImpl->mOperationsPending | COLOR);
425 controller.mImpl->RequestRelayout();
429 std::string href = anchor.href == nullptr ? "" : anchor.href;
430 controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
437 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
439 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
441 if(NULL != controller.mImpl->mEventData)
443 DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
444 EventData::State state(controller.mImpl->mEventData->mState);
445 bool relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
447 if(controller.mImpl->IsClipboardVisible())
449 if(EventData::INACTIVE == state || EventData::EDITING == state)
451 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
453 relayoutNeeded = true;
455 else if(1u == tapCount)
457 if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
459 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
462 if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
464 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
465 relayoutNeeded = true;
469 if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
471 // Hide placeholder text
472 TextUpdater::ResetText(controller);
475 if(EventData::INACTIVE == state)
477 controller.mImpl->ChangeState(EventData::EDITING);
479 else if(!controller.mImpl->IsClipboardEmpty())
481 controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
483 relayoutNeeded = true;
486 else if(2u == tapCount)
488 if(controller.mImpl->mEventData->mSelectionEnabled &&
489 controller.mImpl->IsShowingRealText())
491 relayoutNeeded = true;
492 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
493 controller.mImpl->mEventData->mIsRightHandleSelected = true;
497 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
500 Event event(Event::TAP_EVENT);
501 event.p1.mUint = tapCount;
504 controller.mImpl->mEventData->mEventQueue.push_back(event);
506 controller.mImpl->RequestRelayout();
510 // Reset keyboard as tap event has occurred.
511 controller.mImpl->ResetInputMethodContext();
514 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
516 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
518 if(NULL != controller.mImpl->mEventData)
520 Event event(Event::PAN_EVENT);
521 event.p1.mInt = static_cast<int>(state);
522 event.p2.mFloat = displacement.x;
523 event.p3.mFloat = displacement.y;
524 controller.mImpl->mEventData->mEventQueue.push_back(event);
526 controller.mImpl->RequestRelayout();
530 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
532 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
534 if((state == GestureState::STARTED) &&
535 (NULL != controller.mImpl->mEventData))
537 // The 1st long-press on inactive text-field is treated as tap
538 if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
540 controller.mImpl->ChangeState(EventData::EDITING);
542 Event event(Event::TAP_EVENT);
546 controller.mImpl->mEventData->mEventQueue.push_back(event);
548 controller.mImpl->RequestRelayout();
550 else if(!controller.mImpl->IsShowingRealText())
552 Event event(Event::LONG_PRESS_EVENT);
553 event.p1.mInt = static_cast<int>(state);
556 controller.mImpl->mEventData->mEventQueue.push_back(event);
557 controller.mImpl->RequestRelayout();
559 else if(!controller.mImpl->IsClipboardVisible())
561 // Reset the InputMethodContext to commit the pre-edit before selecting the text.
562 controller.mImpl->ResetInputMethodContext();
564 Event event(Event::LONG_PRESS_EVENT);
565 event.p1.mInt = static_cast<int>(state);
568 controller.mImpl->mEventData->mEventQueue.push_back(event);
569 controller.mImpl->RequestRelayout();
571 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
572 controller.mImpl->mEventData->mIsRightHandleSelected = true;
577 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
579 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
581 if(NULL != controller.mImpl->mEventData)
583 if(selectType == SelectionType::ALL)
585 Event event(Event::SELECT_ALL);
586 controller.mImpl->mEventData->mEventQueue.push_back(event);
588 else if(selectType == SelectionType::NONE)
590 Event event(Event::SELECT_NONE);
591 controller.mImpl->mEventData->mEventQueue.push_back(event);
595 Event event(Event::SELECT);
598 controller.mImpl->mEventData->mEventQueue.push_back(event);
601 controller.mImpl->mEventData->mCheckScrollAmount = true;
602 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
603 controller.mImpl->mEventData->mIsRightHandleSelected = true;
604 controller.mImpl->RequestRelayout();
608 void Controller::EventHandler::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
610 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
612 if(NULL != controller.mImpl->mEventData)
614 if(selectType == SelectionType::RANGE)
616 Event event(Event::SELECT_RANGE);
617 event.p2.mUint = start;
618 event.p3.mUint = end;
619 controller.mImpl->mEventData->mEventQueue.push_back(event);
622 controller.mImpl->mEventData->mCheckScrollAmount = true;
623 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
624 controller.mImpl->mEventData->mIsRightHandleSelected = true;
625 controller.mImpl->RequestRelayout();
629 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
631 Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
633 if(0u == events.Count())
639 DALI_TRACE_SCOPE(gTraceFilter, "DALI_TEXT_MODIFY_EVENTS");
641 for(Vector<ModifyEvent>::ConstIterator it = events.Begin(),
642 endIt = events.End();
646 const ModifyEvent& event = *it;
648 if(ModifyEvent::TEXT_REPLACED == event.type)
650 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
651 DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
653 TextReplacedEvent(controller);
655 else if(ModifyEvent::TEXT_INSERTED == event.type)
657 TextInsertedEvent(controller);
659 else if(ModifyEvent::TEXT_DELETED == event.type)
661 // Placeholder-text cannot be deleted
662 if(!controller.mImpl->IsShowingPlaceholderText())
664 TextDeletedEvent(controller);
669 if(NULL != controller.mImpl->mEventData)
671 uint32_t oldStart, oldEnd;
672 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
673 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
675 // When the text is being modified, delay cursor blinking
676 controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
678 // Update selection position after modifying the text
679 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
680 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
682 if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
684 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
688 // DISCARD temporary text
692 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
694 // The natural size needs to be re-calculated.
695 controller.mImpl->mRecalculateNaturalSize = true;
697 // The text direction needs to be updated.
698 controller.mImpl->mUpdateTextDirection = true;
700 // Apply modifications to the model
701 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
704 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
706 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
708 if(NULL == controller.mImpl->mEventData)
713 controller.mImpl->mEventData->mCheckScrollAmount = true;
715 // The natural size needs to be re-calculated.
716 controller.mImpl->mRecalculateNaturalSize = true;
718 // The text direction needs to be updated.
719 controller.mImpl->mUpdateTextDirection = true;
721 // Apply modifications to the model; TODO - Optimize this
722 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
725 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
727 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
729 if(NULL == controller.mImpl->mEventData)
734 if(!controller.IsEditable()) return;
736 controller.mImpl->mEventData->mCheckScrollAmount = true;
738 // The natural size needs to be re-calculated.
739 controller.mImpl->mRecalculateNaturalSize = true;
741 // The text direction needs to be updated.
742 controller.mImpl->mUpdateTextDirection = true;
744 // Apply modifications to the model; TODO - Optimize this
745 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
748 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
750 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
752 bool removed = false;
754 if(NULL == controller.mImpl->mEventData)
759 if(!controller.IsEditable()) return false;
761 // InputMethodContext is no longer handling key-events
762 controller.mImpl->ClearPreEditFlag();
764 if(EventData::SELECTING == controller.mImpl->mEventData->mState)
766 removed = TextUpdater::RemoveSelectedText(controller);
768 else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
770 // Remove the character before the current cursor position
771 removed = TextUpdater::RemoveText(controller, -1, 1, UPDATE_INPUT_STYLE, false);
773 else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
774 (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
776 // Remove the character after the current cursor position
777 removed = TextUpdater::RemoveText(controller, 0, 1, UPDATE_INPUT_STYLE, false);
782 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
783 !controller.mImpl->IsPlaceholderAvailable())
785 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
789 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
791 controller.mImpl->mEventData->mUpdateCursorPosition = true;
792 controller.mImpl->mEventData->mScrollAfterDelete = true;
798 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
800 // Whether the text needs to be relaid-out.
801 bool requestRelayout = false;
803 // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
804 bool retrieveText = false;
805 bool retrieveCursor = false;
807 switch(inputMethodContextEvent.eventName)
809 case InputMethodContext::COMMIT:
811 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
812 requestRelayout = true;
813 retrieveCursor = true;
816 case InputMethodContext::PRE_EDIT:
818 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
819 requestRelayout = true;
820 retrieveCursor = true;
823 case InputMethodContext::DELETE_SURROUNDING:
825 const bool textDeleted = TextUpdater::RemoveText(controller,
826 inputMethodContextEvent.cursorOffset,
827 inputMethodContextEvent.numberOfChars,
828 DONT_UPDATE_INPUT_STYLE,
833 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
834 !controller.mImpl->IsPlaceholderAvailable())
836 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
840 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
842 controller.mImpl->mEventData->mUpdateCursorPosition = true;
843 controller.mImpl->mEventData->mScrollAfterDelete = true;
845 requestRelayout = true;
849 case InputMethodContext::GET_SURROUNDING:
852 retrieveCursor = true;
855 case InputMethodContext::PRIVATE_COMMAND:
857 // PRIVATECOMMAND event is just for getting the private command message
859 retrieveCursor = true;
862 case InputMethodContext::SELECTION_SET:
864 uint32_t start = static_cast<uint32_t>(inputMethodContextEvent.startIndex);
865 uint32_t end = static_cast<uint32_t>(inputMethodContextEvent.endIndex);
868 controller.SetPrimaryCursorPosition(start, true);
872 controller.SelectText(start, end);
877 case InputMethodContext::VOID:
886 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
887 controller.mImpl->RequestRelayout();
891 CharacterIndex cursorPosition = 0u;
895 cursorPosition = controller.mImpl->GetLogicalCursorPosition();
900 if(!controller.mImpl->IsShowingPlaceholderText())
902 // Retrieves the normal text string.
903 controller.mImpl->GetText(0u, text);
907 // When the current text is Placeholder Text, the surrounding text should be empty string.
908 // It means DALi should send empty string ("") to IME.
913 InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
915 if(requestRelayout &&
916 (NULL != controller.mImpl->mEditableControlInterface))
918 // Do this last since it provides callbacks into application code
919 controller.mImpl->mEditableControlInterface->TextChanged(false);
925 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller, const std::string& text)
927 // Commit the current pre-edit text; the contents of the clipboard should be appended
928 controller.mImpl->ResetInputMethodContext();
930 // Temporary disable hiding clipboard
931 controller.mImpl->SetClipboardHideEnable(false);
934 TextUpdater::PasteText(controller, text);
936 controller.mImpl->SetClipboardHideEnable(true);
939 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
941 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
943 if(NULL != controller.mImpl->mEventData)
949 Event event(Event::GRAB_HANDLE_EVENT);
950 event.p1.mUint = state;
954 controller.mImpl->mEventData->mEventQueue.push_back(event);
957 case LEFT_SELECTION_HANDLE:
959 Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
960 event.p1.mUint = state;
964 controller.mImpl->mEventData->mEventQueue.push_back(event);
967 case RIGHT_SELECTION_HANDLE:
969 Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
970 event.p1.mUint = state;
974 controller.mImpl->mEventData->mEventQueue.push_back(event);
977 case LEFT_SELECTION_HANDLE_MARKER:
978 case RIGHT_SELECTION_HANDLE_MARKER:
980 // Markers do not move the handles.
983 case HANDLE_TYPE_COUNT:
985 DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
989 controller.mImpl->RequestRelayout();
993 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
995 if(NULL == controller.mImpl->mEventData)
1002 case Toolkit::TextSelectionPopup::CUT:
1004 controller.CutText();
1007 case Toolkit::TextSelectionPopup::COPY:
1009 controller.CopyText();
1012 case Toolkit::TextSelectionPopup::PASTE:
1014 controller.PasteText();
1017 case Toolkit::TextSelectionPopup::SELECT:
1019 const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
1021 if(controller.mImpl->mEventData->mSelectionEnabled)
1023 // Creates a SELECT event.
1024 SelectEvent(controller, currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
1028 case Toolkit::TextSelectionPopup::SELECT_ALL:
1030 // Creates a SELECT_ALL event
1031 SelectEvent(controller, 0.f, 0.f, SelectionType::ALL);
1034 case Toolkit::TextSelectionPopup::CLIPBOARD:
1036 controller.mImpl->ShowClipboard();
1039 case Toolkit::TextSelectionPopup::NONE:
1049 } // namespace Toolkit