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/clipboard-event-notifier.h>
23 #include <dali/devel-api/adaptor-framework/key-devel.h>
24 #include <dali/integration-api/debug.h>
27 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
28 #include <dali-toolkit/internal/text/controller/text-controller-impl.h>
29 #include <dali-toolkit/internal/text/controller/text-controller-placeholder-handler.h>
30 #include <dali-toolkit/internal/text/controller/text-controller-text-updater.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 const std::string KEY_C_NAME = "c";
40 const std::string KEY_V_NAME = "v";
41 const std::string KEY_X_NAME = "x";
42 const std::string KEY_A_NAME = "a";
43 const std::string KEY_INSERT_NAME = "Insert";
53 void Controller::EventHandler::KeyboardFocusGainEvent(Controller& controller)
55 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusGainEvent");
57 if(NULL != controller.mImpl->mEventData)
59 if((EventData::INACTIVE == controller.mImpl->mEventData->mState) ||
60 (EventData::INTERRUPTED == controller.mImpl->mEventData->mState))
62 controller.mImpl->ChangeState(EventData::EDITING);
63 controller.mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
64 controller.mImpl->mEventData->mUpdateInputStyle = true;
65 controller.mImpl->mEventData->mScrollAfterUpdatePosition = true;
67 controller.mImpl->NotifyInputMethodContextMultiLineStatus();
68 if(controller.mImpl->IsShowingPlaceholderText())
70 // Show alternative placeholder-text when editing
71 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
74 controller.mImpl->RequestRelayout();
78 void Controller::EventHandler::KeyboardFocusLostEvent(Controller& controller)
80 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusLostEvent");
82 if(NULL != controller.mImpl->mEventData)
84 if(EventData::INTERRUPTED != controller.mImpl->mEventData->mState)
86 // Init selection position
87 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
89 uint32_t oldStart, oldEnd;
90 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
91 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
93 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
94 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
96 if(controller.mImpl->mSelectableControlInterface != nullptr)
98 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mPrimaryCursorPosition, controller.mImpl->mEventData->mPrimaryCursorPosition);
102 controller.mImpl->ChangeState(EventData::INACTIVE);
104 if(!controller.mImpl->IsShowingRealText())
106 // Revert to regular placeholder-text when not editing
107 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
111 controller.mImpl->RequestRelayout();
114 bool Controller::EventHandler::KeyEvent(Controller& controller, const Dali::KeyEvent& keyEvent)
116 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyEvent");
118 bool textChanged = false;
119 bool relayoutNeeded = false;
120 bool isEditable = controller.IsEditable() && controller.IsUserInteractionEnabled();
122 if((NULL != controller.mImpl->mEventData) &&
123 (keyEvent.GetState() == KeyEvent::DOWN))
125 int keyCode = keyEvent.GetKeyCode();
126 const std::string& keyString = keyEvent.GetKeyString();
127 const std::string keyName = keyEvent.GetKeyName();
128 // Key will produce same logical-key value when ctrl
129 // is down, regardless of language layout
130 const std::string logicalKey = keyEvent.GetLogicalKey();
132 const bool isNullKey = (0 == keyCode) && (keyString.empty());
134 // Pre-process to separate modifying events from non-modifying input events.
137 // In some platforms arrive key events with no key code.
141 else if(Dali::DALI_KEY_ESCAPE == keyCode || Dali::DALI_KEY_BACK == keyCode || Dali::DALI_KEY_SEARCH == keyCode)
146 else if((Dali::DALI_KEY_CURSOR_LEFT == keyCode) ||
147 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode) ||
148 (Dali::DALI_KEY_CURSOR_UP == keyCode) ||
149 (Dali::DALI_KEY_CURSOR_DOWN == keyCode))
151 // If don't have any text, do nothing.
152 if(!controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters || !isEditable)
157 uint32_t cursorPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
158 uint32_t numberOfCharacters = controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
159 uint32_t cursorLine = controller.mImpl->mModel->mVisualModel->GetLineOfCharacter(cursorPosition);
160 uint32_t numberOfLines = controller.mImpl->mModel->GetNumberOfLines();
162 // Logic to determine whether this text control will lose focus or not.
163 if((Dali::DALI_KEY_CURSOR_LEFT == keyCode && 0 == cursorPosition && !keyEvent.IsShiftModifier()) ||
164 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode && numberOfCharacters == cursorPosition && !keyEvent.IsShiftModifier()) ||
165 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && cursorLine == numberOfLines - 1) ||
166 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && numberOfCharacters == cursorPosition && cursorLine - 1 == numberOfLines - 1) ||
167 (Dali::DALI_KEY_CURSOR_UP == keyCode && cursorLine == 0) ||
168 (Dali::DALI_KEY_CURSOR_UP == keyCode && numberOfCharacters == cursorPosition && cursorLine == 1))
170 // Release the active highlight.
171 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
173 uint32_t oldStart, oldEnd;
174 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
175 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
177 controller.mImpl->ChangeState(EventData::EDITING);
179 // Update selection position.
180 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
181 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
182 controller.mImpl->mEventData->mUpdateCursorPosition = true;
184 if(controller.mImpl->mSelectableControlInterface != nullptr)
186 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
189 controller.mImpl->RequestRelayout();
194 if(controller.mImpl->mEventData->mState == EventData::INACTIVE)
196 // Cursor position will be updated
197 controller.mImpl->ChangeState(EventData::EDITING);
200 controller.mImpl->mEventData->mCheckScrollAmount = true;
201 Event event(Event::CURSOR_KEY_EVENT);
202 event.p1.mInt = keyCode;
203 event.p2.mBool = keyEvent.IsShiftModifier();
204 controller.mImpl->mEventData->mEventQueue.push_back(event);
206 // Will request for relayout.
207 relayoutNeeded = true;
209 else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
211 // Left or Right Control key event is received before Ctrl-C/V/X key event is received
212 // If not handle it here, any selected text will be deleted
217 else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier() && isEditable)
219 bool consumed = false;
220 if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
222 // Ctrl-C or Ctrl+Insert to copy the selected text
223 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
226 else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
228 // Ctrl-V to paste the copied text
229 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
232 else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
234 // Ctrl-X to cut the selected text
235 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
238 else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
240 // Ctrl-A to select All the text
241 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
246 else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
247 (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
249 textChanged = DeleteEvent(controller, keyCode);
251 // Will request for relayout.
252 relayoutNeeded = true;
254 else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
255 IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
256 IsKey(keyEvent, Dali::DALI_KEY_HOME))
258 // Power key/Menu/Home key behaviour does not allow edit mode to resume.
259 controller.mImpl->ChangeState(EventData::INACTIVE);
261 // Will request for relayout.
262 relayoutNeeded = true;
264 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
266 else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
268 // 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
269 // and a character is typed after the type of a upper case latin character.
274 else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
276 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
282 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
283 if(!isEditable) return false;
285 std::string refinedKey = keyString;
286 if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
288 bool accepted = false;
289 bool rejected = false;
290 accepted = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
291 rejected = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
295 // The filtered key is set to empty.
297 // Signal emits when the character to be inserted is filtered by the accepted filter.
298 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
302 // The filtered key is set to empty.
304 // Signal emits when the character to be inserted is filtered by the rejected filter.
305 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
309 if(!refinedKey.empty())
311 // InputMethodContext is no longer handling key-events
312 controller.mImpl->ClearPreEditFlag();
314 TextUpdater::InsertText(controller, refinedKey, COMMIT);
318 // Will request for relayout.
319 relayoutNeeded = true;
323 if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
324 (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
326 (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
327 (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
328 (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
329 (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
331 // Should not change the state if the key is the shift send by the InputMethodContext.
332 // Otherwise, when the state is SELECTING the text controller can't send the right
333 // surrounding info to the InputMethodContext.
334 controller.mImpl->ChangeState(EventData::EDITING);
336 // Will request for relayout.
337 relayoutNeeded = true;
342 controller.mImpl->RequestRelayout();
345 else if((NULL != controller.mImpl->mEventData) && (keyEvent.GetState() == KeyEvent::UP))
347 // Handles specific keys that require event propagation.
348 if(Dali::DALI_KEY_BACK == keyEvent.GetKeyCode())
356 (NULL != controller.mImpl->mEditableControlInterface))
358 // Do this last since it provides callbacks into application code
359 controller.mImpl->mEditableControlInterface->TextChanged(false);
365 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
367 if(!controller.mImpl->mMarkupProcessorEnabled ||
368 !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
369 !controller.mImpl->IsShowingRealText())
374 CharacterIndex cursorPosition = 0u;
376 // Convert from control's coords to text's coords.
377 const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
378 const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
380 // Whether to touch point hits on a glyph.
381 bool matchedCharacter = false;
382 cursorPosition = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
383 controller.mImpl->mModel->mLogicalModel,
384 controller.mImpl->mMetrics,
387 CharacterHitTest::TAP,
390 for(const auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
392 // Anchor clicked if the calculated cursor position is within the range of anchor.
393 if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
395 if(controller.mImpl->mAnchorControlInterface && anchor.href)
397 std::string href(anchor.href);
398 controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
405 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
407 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
409 if(NULL != controller.mImpl->mEventData)
411 DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
412 EventData::State state(controller.mImpl->mEventData->mState);
413 bool relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
415 if(controller.mImpl->IsClipboardVisible())
417 if(EventData::INACTIVE == state || EventData::EDITING == state)
419 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
421 relayoutNeeded = true;
423 else if(1u == tapCount)
425 if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
427 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
430 if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
432 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
433 relayoutNeeded = true;
437 if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
439 // Hide placeholder text
440 TextUpdater::ResetText(controller);
443 if(EventData::INACTIVE == state)
445 controller.mImpl->ChangeState(EventData::EDITING);
447 else if(!controller.mImpl->IsClipboardEmpty())
449 controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
451 relayoutNeeded = true;
454 else if(2u == tapCount)
456 if(controller.mImpl->mEventData->mSelectionEnabled &&
457 controller.mImpl->IsShowingRealText())
459 relayoutNeeded = true;
460 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
461 controller.mImpl->mEventData->mIsRightHandleSelected = true;
465 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
468 Event event(Event::TAP_EVENT);
469 event.p1.mUint = tapCount;
472 controller.mImpl->mEventData->mEventQueue.push_back(event);
474 controller.mImpl->RequestRelayout();
478 // Reset keyboard as tap event has occurred.
479 controller.mImpl->ResetInputMethodContext();
482 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
484 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
486 if(NULL != controller.mImpl->mEventData)
488 Event event(Event::PAN_EVENT);
489 event.p1.mInt = static_cast<int>(state);
490 event.p2.mFloat = displacement.x;
491 event.p3.mFloat = displacement.y;
492 controller.mImpl->mEventData->mEventQueue.push_back(event);
494 controller.mImpl->RequestRelayout();
498 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
500 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
502 if((state == GestureState::STARTED) &&
503 (NULL != controller.mImpl->mEventData))
505 // The 1st long-press on inactive text-field is treated as tap
506 if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
508 controller.mImpl->ChangeState(EventData::EDITING);
510 Event event(Event::TAP_EVENT);
514 controller.mImpl->mEventData->mEventQueue.push_back(event);
516 controller.mImpl->RequestRelayout();
518 else if(!controller.mImpl->IsShowingRealText())
520 Event event(Event::LONG_PRESS_EVENT);
521 event.p1.mInt = static_cast<int>(state);
524 controller.mImpl->mEventData->mEventQueue.push_back(event);
525 controller.mImpl->RequestRelayout();
527 else if(!controller.mImpl->IsClipboardVisible())
529 // Reset the InputMethodContext to commit the pre-edit before selecting the text.
530 controller.mImpl->ResetInputMethodContext();
532 Event event(Event::LONG_PRESS_EVENT);
533 event.p1.mInt = static_cast<int>(state);
536 controller.mImpl->mEventData->mEventQueue.push_back(event);
537 controller.mImpl->RequestRelayout();
539 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
540 controller.mImpl->mEventData->mIsRightHandleSelected = true;
545 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
547 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
549 if(NULL != controller.mImpl->mEventData)
551 if(selectType == SelectionType::ALL)
553 Event event(Event::SELECT_ALL);
554 controller.mImpl->mEventData->mEventQueue.push_back(event);
556 else if(selectType == SelectionType::NONE)
558 Event event(Event::SELECT_NONE);
559 controller.mImpl->mEventData->mEventQueue.push_back(event);
563 Event event(Event::SELECT);
566 controller.mImpl->mEventData->mEventQueue.push_back(event);
569 controller.mImpl->mEventData->mCheckScrollAmount = true;
570 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
571 controller.mImpl->mEventData->mIsRightHandleSelected = true;
572 controller.mImpl->RequestRelayout();
576 void Controller::EventHandler::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
578 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
580 if(NULL != controller.mImpl->mEventData)
582 if(selectType == SelectionType::RANGE)
584 Event event(Event::SELECT_RANGE);
585 event.p2.mUint = start;
586 event.p3.mUint = end;
587 controller.mImpl->mEventData->mEventQueue.push_back(event);
590 controller.mImpl->mEventData->mCheckScrollAmount = true;
591 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
592 controller.mImpl->mEventData->mIsRightHandleSelected = true;
593 controller.mImpl->RequestRelayout();
597 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
599 Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
601 if(0u == events.Count())
607 for(Vector<ModifyEvent>::ConstIterator it = events.Begin(),
608 endIt = events.End();
612 const ModifyEvent& event = *it;
614 if(ModifyEvent::TEXT_REPLACED == event.type)
616 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
617 DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
619 TextReplacedEvent(controller);
621 else if(ModifyEvent::TEXT_INSERTED == event.type)
623 TextInsertedEvent(controller);
625 else if(ModifyEvent::TEXT_DELETED == event.type)
627 // Placeholder-text cannot be deleted
628 if(!controller.mImpl->IsShowingPlaceholderText())
630 TextDeletedEvent(controller);
635 if(NULL != controller.mImpl->mEventData)
637 uint32_t oldStart, oldEnd;
638 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
639 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
641 // When the text is being modified, delay cursor blinking
642 controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
644 // Update selection position after modifying the text
645 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
646 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
648 if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
650 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
654 // DISCARD temporary text
658 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
660 // The natural size needs to be re-calculated.
661 controller.mImpl->mRecalculateNaturalSize = true;
663 // The text direction needs to be updated.
664 controller.mImpl->mUpdateTextDirection = true;
666 // Apply modifications to the model
667 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
670 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
672 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
674 if(NULL == controller.mImpl->mEventData)
679 controller.mImpl->mEventData->mCheckScrollAmount = true;
681 // The natural size needs to be re-calculated.
682 controller.mImpl->mRecalculateNaturalSize = true;
684 // The text direction needs to be updated.
685 controller.mImpl->mUpdateTextDirection = true;
687 // Apply modifications to the model; TODO - Optimize this
688 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
691 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
693 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
695 if(NULL == controller.mImpl->mEventData)
700 if(!controller.IsEditable()) return;
702 controller.mImpl->mEventData->mCheckScrollAmount = true;
704 // The natural size needs to be re-calculated.
705 controller.mImpl->mRecalculateNaturalSize = true;
707 // The text direction needs to be updated.
708 controller.mImpl->mUpdateTextDirection = true;
710 // Apply modifications to the model; TODO - Optimize this
711 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
714 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
716 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
718 bool removed = false;
720 if(NULL == controller.mImpl->mEventData)
725 if(!controller.IsEditable()) return false;
727 // InputMethodContext is no longer handling key-events
728 controller.mImpl->ClearPreEditFlag();
730 if(EventData::SELECTING == controller.mImpl->mEventData->mState)
732 removed = TextUpdater::RemoveSelectedText(controller);
734 else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
736 // Remove the character before the current cursor position
737 removed = TextUpdater::RemoveText(controller, -1, 1, UPDATE_INPUT_STYLE);
739 else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
740 (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
742 // Remove the character after the current cursor position
743 removed = TextUpdater::RemoveText(controller, 0, 1, UPDATE_INPUT_STYLE);
748 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
749 !controller.mImpl->IsPlaceholderAvailable())
751 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
755 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
757 controller.mImpl->mEventData->mUpdateCursorPosition = true;
758 controller.mImpl->mEventData->mScrollAfterDelete = true;
764 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
766 // Whether the text needs to be relaid-out.
767 bool requestRelayout = false;
769 // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
770 bool retrieveText = false;
771 bool retrieveCursor = false;
773 switch(inputMethodContextEvent.eventName)
775 case InputMethodContext::COMMIT:
777 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
778 requestRelayout = true;
779 retrieveCursor = true;
782 case InputMethodContext::PRE_EDIT:
784 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
785 requestRelayout = true;
786 retrieveCursor = true;
789 case InputMethodContext::DELETE_SURROUNDING:
791 const bool textDeleted = TextUpdater::RemoveText(controller,
792 inputMethodContextEvent.cursorOffset,
793 inputMethodContextEvent.numberOfChars,
794 DONT_UPDATE_INPUT_STYLE);
798 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
799 !controller.mImpl->IsPlaceholderAvailable())
801 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
805 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
807 controller.mImpl->mEventData->mUpdateCursorPosition = true;
808 controller.mImpl->mEventData->mScrollAfterDelete = true;
810 requestRelayout = true;
814 case InputMethodContext::GET_SURROUNDING:
817 retrieveCursor = true;
820 case InputMethodContext::PRIVATE_COMMAND:
822 // PRIVATECOMMAND event is just for getting the private command message
824 retrieveCursor = true;
827 case InputMethodContext::SELECTION_SET:
829 uint32_t start = static_cast<uint32_t>(inputMethodContextEvent.startIndex);
830 uint32_t end = static_cast<uint32_t>(inputMethodContextEvent.endIndex);
833 controller.SetPrimaryCursorPosition(start, true);
837 controller.SelectText(start, end);
842 case InputMethodContext::VOID:
851 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
852 controller.mImpl->RequestRelayout();
856 CharacterIndex cursorPosition = 0u;
857 Length numberOfWhiteSpaces = 0u;
861 numberOfWhiteSpaces = controller.mImpl->GetNumberOfWhiteSpaces(0u);
863 cursorPosition = controller.mImpl->GetLogicalCursorPosition();
865 if(cursorPosition < numberOfWhiteSpaces)
871 cursorPosition -= numberOfWhiteSpaces;
877 if(!controller.mImpl->IsShowingPlaceholderText())
879 // Retrieves the normal text string.
880 controller.mImpl->GetText(numberOfWhiteSpaces, text);
884 // When the current text is Placeholder Text, the surrounding text should be empty string.
885 // It means DALi should send empty string ("") to IME.
890 InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
892 if(requestRelayout &&
893 (NULL != controller.mImpl->mEditableControlInterface))
895 // Do this last since it provides callbacks into application code
896 controller.mImpl->mEditableControlInterface->TextChanged(false);
902 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller)
904 // Retrieve the clipboard contents first
905 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
906 std::string stringToPaste(notifier.GetContent());
908 // Commit the current pre-edit text; the contents of the clipboard should be appended
909 controller.mImpl->ResetInputMethodContext();
911 // Temporary disable hiding clipboard
912 controller.mImpl->SetClipboardHideEnable(false);
915 TextUpdater::PasteText(controller, stringToPaste);
917 controller.mImpl->SetClipboardHideEnable(true);
920 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
922 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
924 if(NULL != controller.mImpl->mEventData)
930 Event event(Event::GRAB_HANDLE_EVENT);
931 event.p1.mUint = state;
935 controller.mImpl->mEventData->mEventQueue.push_back(event);
938 case LEFT_SELECTION_HANDLE:
940 Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
941 event.p1.mUint = state;
945 controller.mImpl->mEventData->mEventQueue.push_back(event);
948 case RIGHT_SELECTION_HANDLE:
950 Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
951 event.p1.mUint = state;
955 controller.mImpl->mEventData->mEventQueue.push_back(event);
958 case LEFT_SELECTION_HANDLE_MARKER:
959 case RIGHT_SELECTION_HANDLE_MARKER:
961 // Markers do not move the handles.
964 case HANDLE_TYPE_COUNT:
966 DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
970 controller.mImpl->RequestRelayout();
974 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
976 if(NULL == controller.mImpl->mEventData)
983 case Toolkit::TextSelectionPopup::CUT:
985 controller.CutText();
988 case Toolkit::TextSelectionPopup::COPY:
990 controller.CopyText();
993 case Toolkit::TextSelectionPopup::PASTE:
995 controller.PasteText();
998 case Toolkit::TextSelectionPopup::SELECT:
1000 const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
1002 if(controller.mImpl->mEventData->mSelectionEnabled)
1004 // Creates a SELECT event.
1005 SelectEvent(controller, currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
1009 case Toolkit::TextSelectionPopup::SELECT_ALL:
1011 // Creates a SELECT_ALL event
1012 SelectEvent(controller, 0.f, 0.f, SelectionType::ALL);
1015 case Toolkit::TextSelectionPopup::CLIPBOARD:
1017 controller.mImpl->ShowClipboard();
1020 case Toolkit::TextSelectionPopup::NONE:
1030 } // namespace Toolkit