2 * Copyright (c) 2021 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/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/text-controller-impl.h>
29 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
33 #if defined(DEBUG_ENABLED)
34 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
37 const std::string KEY_C_NAME = "c";
38 const std::string KEY_V_NAME = "v";
39 const std::string KEY_X_NAME = "x";
40 const std::string KEY_A_NAME = "a";
41 const std::string KEY_INSERT_NAME = "Insert";
51 void Controller::EventHandler::KeyboardFocusGainEvent(Controller& controller)
53 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusGainEvent");
55 if(NULL != controller.mImpl->mEventData)
57 if((EventData::INACTIVE == controller.mImpl->mEventData->mState) ||
58 (EventData::INTERRUPTED == controller.mImpl->mEventData->mState))
60 controller.mImpl->ChangeState(EventData::EDITING);
61 controller.mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
62 controller.mImpl->mEventData->mUpdateInputStyle = true;
63 controller.mImpl->mEventData->mScrollAfterUpdatePosition = true;
65 controller.mImpl->NotifyInputMethodContextMultiLineStatus();
66 if(controller.mImpl->IsShowingPlaceholderText())
68 // Show alternative placeholder-text when editing
69 controller.ShowPlaceholderText();
72 controller.mImpl->RequestRelayout();
76 void Controller::EventHandler::KeyboardFocusLostEvent(Controller& controller)
78 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusLostEvent");
80 if(NULL != controller.mImpl->mEventData)
82 if(EventData::INTERRUPTED != controller.mImpl->mEventData->mState)
84 // Init selection position
85 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
87 uint32_t oldStart, oldEnd;
88 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
89 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
91 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
92 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
94 if(controller.mImpl->mSelectableControlInterface != nullptr)
96 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mPrimaryCursorPosition, controller.mImpl->mEventData->mPrimaryCursorPosition);
100 controller.mImpl->ChangeState(EventData::INACTIVE);
102 if(!controller.mImpl->IsShowingRealText())
104 // Revert to regular placeholder-text when not editing
105 controller.ShowPlaceholderText();
109 controller.mImpl->RequestRelayout();
112 bool Controller::EventHandler::KeyEvent(Controller& controller, const Dali::KeyEvent& keyEvent)
114 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyEvent");
116 bool textChanged = false;
117 bool relayoutNeeded = false;
119 if((NULL != controller.mImpl->mEventData) &&
120 (keyEvent.GetState() == KeyEvent::DOWN))
122 int keyCode = keyEvent.GetKeyCode();
123 const std::string& keyString = keyEvent.GetKeyString();
124 const std::string keyName = keyEvent.GetKeyName();
125 // Key will produce same logical-key value when ctrl
126 // is down, regardless of language layout
127 const std::string logicalKey = keyEvent.GetLogicalKey();
129 const bool isNullKey = (0 == keyCode) && (keyString.empty());
131 // Pre-process to separate modifying events from non-modifying input events.
134 // In some platforms arrive key events with no key code.
138 else if(Dali::DALI_KEY_ESCAPE == keyCode || Dali::DALI_KEY_BACK == keyCode || Dali::DALI_KEY_SEARCH == keyCode)
143 else if((Dali::DALI_KEY_CURSOR_LEFT == keyCode) ||
144 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode) ||
145 (Dali::DALI_KEY_CURSOR_UP == keyCode) ||
146 (Dali::DALI_KEY_CURSOR_DOWN == keyCode))
148 // If don't have any text, do nothing.
149 if(!controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters)
154 uint32_t cursorPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
155 uint32_t numberOfCharacters = controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
156 uint32_t cursorLine = controller.mImpl->mModel->mVisualModel->GetLineOfCharacter(cursorPosition);
157 uint32_t numberOfLines = controller.mImpl->mModel->GetNumberOfLines();
159 // Logic to determine whether this text control will lose focus or not.
160 if((Dali::DALI_KEY_CURSOR_LEFT == keyCode && 0 == cursorPosition && !keyEvent.IsShiftModifier()) ||
161 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode && numberOfCharacters == cursorPosition && !keyEvent.IsShiftModifier()) ||
162 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && cursorLine == numberOfLines - 1) ||
163 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && numberOfCharacters == cursorPosition && cursorLine - 1 == numberOfLines - 1) ||
164 (Dali::DALI_KEY_CURSOR_UP == keyCode && cursorLine == 0) ||
165 (Dali::DALI_KEY_CURSOR_UP == keyCode && numberOfCharacters == cursorPosition && cursorLine == 1))
167 // Release the active highlight.
168 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
170 uint32_t oldStart, oldEnd;
171 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
172 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
174 controller.mImpl->ChangeState(EventData::EDITING);
176 // Update selection position.
177 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
178 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
179 controller.mImpl->mEventData->mUpdateCursorPosition = true;
181 if(controller.mImpl->mSelectableControlInterface != nullptr)
183 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
186 controller.mImpl->RequestRelayout();
191 controller.mImpl->mEventData->mCheckScrollAmount = true;
192 Event event(Event::CURSOR_KEY_EVENT);
193 event.p1.mInt = keyCode;
194 event.p2.mBool = keyEvent.IsShiftModifier();
195 controller.mImpl->mEventData->mEventQueue.push_back(event);
197 // Will request for relayout.
198 relayoutNeeded = true;
200 else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
202 // Left or Right Control key event is received before Ctrl-C/V/X key event is received
203 // If not handle it here, any selected text will be deleted
208 else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier())
210 bool consumed = false;
211 if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
213 // Ctrl-C or Ctrl+Insert to copy the selected text
214 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
217 else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
219 // Ctrl-V to paste the copied text
220 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
223 else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
225 // Ctrl-X to cut the selected text
226 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
229 else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
231 // Ctrl-A to select All the text
232 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
237 else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
238 (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
240 textChanged = controller.DeleteEvent(keyCode);
242 // Will request for relayout.
243 relayoutNeeded = true;
245 else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
246 IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
247 IsKey(keyEvent, Dali::DALI_KEY_HOME))
249 // Power key/Menu/Home key behaviour does not allow edit mode to resume.
250 controller.mImpl->ChangeState(EventData::INACTIVE);
252 // Will request for relayout.
253 relayoutNeeded = true;
255 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
257 else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
259 // 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
260 // and a character is typed after the type of a upper case latin character.
265 else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
267 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
273 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
274 if(!controller.IsEditable()) return false;
276 std::string refinedKey = keyString;
277 if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
279 bool accepted = false;
280 bool rejected = false;
281 accepted = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
282 rejected = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
286 // The filtered key is set to empty.
288 // Signal emits when the character to be inserted is filtered by the accepted filter.
289 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
293 // The filtered key is set to empty.
295 // Signal emits when the character to be inserted is filtered by the rejected filter.
296 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
300 if(!refinedKey.empty())
302 // InputMethodContext is no longer handling key-events
303 controller.mImpl->ClearPreEditFlag();
305 controller.InsertText(refinedKey, COMMIT);
309 // Will request for relayout.
310 relayoutNeeded = true;
314 if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
315 (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
317 (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
318 (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
319 (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
320 (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
322 // Should not change the state if the key is the shift send by the InputMethodContext.
323 // Otherwise, when the state is SELECTING the text controller can't send the right
324 // surrounding info to the InputMethodContext.
325 controller.mImpl->ChangeState(EventData::EDITING);
327 // Will request for relayout.
328 relayoutNeeded = true;
333 controller.mImpl->RequestRelayout();
338 (NULL != controller.mImpl->mEditableControlInterface))
340 // Do this last since it provides callbacks into application code
341 controller.mImpl->mEditableControlInterface->TextChanged(false);
347 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
349 if(!controller.mImpl->mMarkupProcessorEnabled ||
350 !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
351 !controller.mImpl->IsShowingRealText())
356 CharacterIndex cursorPosition = 0u;
358 // Convert from control's coords to text's coords.
359 const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
360 const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
362 // Whether to touch point hits on a glyph.
363 bool matchedCharacter = false;
364 cursorPosition = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
365 controller.mImpl->mModel->mLogicalModel,
366 controller.mImpl->mMetrics,
369 CharacterHitTest::TAP,
372 for(const auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
374 // Anchor clicked if the calculated cursor position is within the range of anchor.
375 if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
377 if(controller.mImpl->mAnchorControlInterface && anchor.href)
379 std::string href(anchor.href);
380 controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
387 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
389 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
391 if(NULL != controller.mImpl->mEventData)
393 DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
394 EventData::State state(controller.mImpl->mEventData->mState);
395 bool relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
397 if(controller.mImpl->IsClipboardVisible())
399 if(EventData::INACTIVE == state || EventData::EDITING == state)
401 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
403 relayoutNeeded = true;
405 else if(1u == tapCount)
407 if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
409 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
412 if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
414 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
415 relayoutNeeded = true;
419 if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
421 // Hide placeholder text
422 controller.ResetText();
425 if(EventData::INACTIVE == state)
427 controller.mImpl->ChangeState(EventData::EDITING);
429 else if(!controller.mImpl->IsClipboardEmpty())
431 controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
433 relayoutNeeded = true;
436 else if(2u == tapCount)
438 if(controller.mImpl->mEventData->mSelectionEnabled &&
439 controller.mImpl->IsShowingRealText())
441 relayoutNeeded = true;
442 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
443 controller.mImpl->mEventData->mIsRightHandleSelected = true;
447 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
450 Event event(Event::TAP_EVENT);
451 event.p1.mUint = tapCount;
454 controller.mImpl->mEventData->mEventQueue.push_back(event);
456 controller.mImpl->RequestRelayout();
460 // Reset keyboard as tap event has occurred.
461 controller.mImpl->ResetInputMethodContext();
464 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
466 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
468 if(NULL != controller.mImpl->mEventData)
470 Event event(Event::PAN_EVENT);
471 event.p1.mInt = static_cast<int>(state);
472 event.p2.mFloat = displacement.x;
473 event.p3.mFloat = displacement.y;
474 controller.mImpl->mEventData->mEventQueue.push_back(event);
476 controller.mImpl->RequestRelayout();
480 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
482 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
484 if((state == GestureState::STARTED) &&
485 (NULL != controller.mImpl->mEventData))
487 // The 1st long-press on inactive text-field is treated as tap
488 if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
490 controller.mImpl->ChangeState(EventData::EDITING);
492 Event event(Event::TAP_EVENT);
496 controller.mImpl->mEventData->mEventQueue.push_back(event);
498 controller.mImpl->RequestRelayout();
500 else if(!controller.mImpl->IsShowingRealText())
502 Event event(Event::LONG_PRESS_EVENT);
503 event.p1.mInt = static_cast<int>(state);
506 controller.mImpl->mEventData->mEventQueue.push_back(event);
507 controller.mImpl->RequestRelayout();
509 else if(!controller.mImpl->IsClipboardVisible())
511 // Reset the InputMethodContext to commit the pre-edit before selecting the text.
512 controller.mImpl->ResetInputMethodContext();
514 Event event(Event::LONG_PRESS_EVENT);
515 event.p1.mInt = static_cast<int>(state);
518 controller.mImpl->mEventData->mEventQueue.push_back(event);
519 controller.mImpl->RequestRelayout();
521 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
522 controller.mImpl->mEventData->mIsRightHandleSelected = true;
527 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
529 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
531 if(NULL != controller.mImpl->mEventData)
533 if(selectType == SelectionType::ALL)
535 Event event(Event::SELECT_ALL);
536 controller.mImpl->mEventData->mEventQueue.push_back(event);
538 else if(selectType == SelectionType::NONE)
540 Event event(Event::SELECT_NONE);
541 controller.mImpl->mEventData->mEventQueue.push_back(event);
545 Event event(Event::SELECT);
548 controller.mImpl->mEventData->mEventQueue.push_back(event);
551 controller.mImpl->mEventData->mCheckScrollAmount = true;
552 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
553 controller.mImpl->mEventData->mIsRightHandleSelected = true;
554 controller.mImpl->RequestRelayout();
558 void Controller::EventHandler::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
560 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
562 if(NULL != controller.mImpl->mEventData)
564 if(selectType == SelectionType::RANGE)
566 Event event(Event::SELECT_RANGE);
567 event.p2.mUint = start;
568 event.p3.mUint = end;
569 controller.mImpl->mEventData->mEventQueue.push_back(event);
572 controller.mImpl->mEventData->mCheckScrollAmount = true;
573 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
574 controller.mImpl->mEventData->mIsRightHandleSelected = true;
575 controller.mImpl->RequestRelayout();
579 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
581 Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
583 if(0u == events.Count())
589 for(Vector<ModifyEvent>::ConstIterator it = events.Begin(),
590 endIt = events.End();
594 const ModifyEvent& event = *it;
596 if(ModifyEvent::TEXT_REPLACED == event.type)
598 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
599 DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
601 controller.TextReplacedEvent();
603 else if(ModifyEvent::TEXT_INSERTED == event.type)
605 controller.TextInsertedEvent();
607 else if(ModifyEvent::TEXT_DELETED == event.type)
609 // Placeholder-text cannot be deleted
610 if(!controller.mImpl->IsShowingPlaceholderText())
612 controller.TextDeletedEvent();
617 if(NULL != controller.mImpl->mEventData)
619 uint32_t oldStart, oldEnd;
620 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
621 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
623 // When the text is being modified, delay cursor blinking
624 controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
626 // Update selection position after modifying the text
627 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
628 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
630 if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
632 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
636 // DISCARD temporary text
640 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
642 // The natural size needs to be re-calculated.
643 controller.mImpl->mRecalculateNaturalSize = true;
645 // The text direction needs to be updated.
646 controller.mImpl->mUpdateTextDirection = true;
648 // Apply modifications to the model
649 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
652 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
654 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
656 if(NULL == controller.mImpl->mEventData)
661 controller.mImpl->mEventData->mCheckScrollAmount = true;
663 // The natural size needs to be re-calculated.
664 controller.mImpl->mRecalculateNaturalSize = true;
666 // The text direction needs to be updated.
667 controller.mImpl->mUpdateTextDirection = true;
669 // Apply modifications to the model; TODO - Optimize this
670 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
673 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
675 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
677 if(NULL == controller.mImpl->mEventData)
682 if(!controller.IsEditable()) return;
684 controller.mImpl->mEventData->mCheckScrollAmount = true;
686 // The natural size needs to be re-calculated.
687 controller.mImpl->mRecalculateNaturalSize = true;
689 // The text direction needs to be updated.
690 controller.mImpl->mUpdateTextDirection = true;
692 // Apply modifications to the model; TODO - Optimize this
693 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
696 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
698 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
700 bool removed = false;
702 if(NULL == controller.mImpl->mEventData)
707 if(!controller.IsEditable()) return false;
709 // InputMethodContext is no longer handling key-events
710 controller.mImpl->ClearPreEditFlag();
712 if(EventData::SELECTING == controller.mImpl->mEventData->mState)
714 removed = controller.RemoveSelectedText();
716 else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
718 // Remove the character before the current cursor position
719 removed = controller.RemoveText(-1,
723 else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
724 (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
726 // Remove the character after the current cursor position
727 removed = controller.RemoveText(0,
734 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
735 !controller.mImpl->IsPlaceholderAvailable())
737 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
741 controller.ShowPlaceholderText();
743 controller.mImpl->mEventData->mUpdateCursorPosition = true;
744 controller.mImpl->mEventData->mScrollAfterDelete = true;
750 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
752 // Whether the text needs to be relaid-out.
753 bool requestRelayout = false;
755 // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
756 bool retrieveText = false;
757 bool retrieveCursor = false;
759 switch(inputMethodContextEvent.eventName)
761 case InputMethodContext::COMMIT:
763 controller.InsertText(inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
764 requestRelayout = true;
765 retrieveCursor = true;
768 case InputMethodContext::PRE_EDIT:
770 controller.InsertText(inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
771 requestRelayout = true;
772 retrieveCursor = true;
775 case InputMethodContext::DELETE_SURROUNDING:
777 const bool textDeleted = controller.RemoveText(inputMethodContextEvent.cursorOffset,
778 inputMethodContextEvent.numberOfChars,
779 DONT_UPDATE_INPUT_STYLE);
783 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
784 !controller.mImpl->IsPlaceholderAvailable())
786 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
790 controller.ShowPlaceholderText();
792 controller.mImpl->mEventData->mUpdateCursorPosition = true;
793 controller.mImpl->mEventData->mScrollAfterDelete = true;
795 requestRelayout = true;
799 case InputMethodContext::GET_SURROUNDING:
802 retrieveCursor = true;
805 case InputMethodContext::PRIVATE_COMMAND:
807 // PRIVATECOMMAND event is just for getting the private command message
809 retrieveCursor = true;
812 case InputMethodContext::VOID:
821 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
822 controller.mImpl->RequestRelayout();
826 CharacterIndex cursorPosition = 0u;
827 Length numberOfWhiteSpaces = 0u;
831 numberOfWhiteSpaces = controller.mImpl->GetNumberOfWhiteSpaces(0u);
833 cursorPosition = controller.mImpl->GetLogicalCursorPosition();
835 if(cursorPosition < numberOfWhiteSpaces)
841 cursorPosition -= numberOfWhiteSpaces;
847 if(!controller.mImpl->IsShowingPlaceholderText())
849 // Retrieves the normal text string.
850 controller.mImpl->GetText(numberOfWhiteSpaces, text);
854 // When the current text is Placeholder Text, the surrounding text should be empty string.
855 // It means DALi should send empty string ("") to IME.
860 InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
862 if(requestRelayout &&
863 (NULL != controller.mImpl->mEditableControlInterface))
865 // Do this last since it provides callbacks into application code
866 controller.mImpl->mEditableControlInterface->TextChanged(false);
872 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller)
874 // Retrieve the clipboard contents first
875 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
876 std::string stringToPaste(notifier.GetContent());
878 // Commit the current pre-edit text; the contents of the clipboard should be appended
879 controller.mImpl->ResetInputMethodContext();
881 // Temporary disable hiding clipboard
882 controller.mImpl->SetClipboardHideEnable(false);
885 controller.PasteText(stringToPaste);
887 controller.mImpl->SetClipboardHideEnable(true);
890 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
892 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
894 if(NULL != controller.mImpl->mEventData)
900 Event event(Event::GRAB_HANDLE_EVENT);
901 event.p1.mUint = state;
905 controller.mImpl->mEventData->mEventQueue.push_back(event);
908 case LEFT_SELECTION_HANDLE:
910 Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
911 event.p1.mUint = state;
915 controller.mImpl->mEventData->mEventQueue.push_back(event);
918 case RIGHT_SELECTION_HANDLE:
920 Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
921 event.p1.mUint = state;
925 controller.mImpl->mEventData->mEventQueue.push_back(event);
928 case LEFT_SELECTION_HANDLE_MARKER:
929 case RIGHT_SELECTION_HANDLE_MARKER:
931 // Markers do not move the handles.
934 case HANDLE_TYPE_COUNT:
936 DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
940 controller.mImpl->RequestRelayout();
944 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
946 if(NULL == controller.mImpl->mEventData)
953 case Toolkit::TextSelectionPopup::CUT:
955 if(!controller.IsEditable()) return;
956 controller.mImpl->SendSelectionToClipboard(true); // Synchronous call to modify text
957 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
959 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
960 !controller.mImpl->IsPlaceholderAvailable())
962 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
966 controller.ShowPlaceholderText();
969 controller.mImpl->mEventData->mUpdateCursorPosition = true;
970 controller.mImpl->mEventData->mScrollAfterDelete = true;
972 controller.mImpl->RequestRelayout();
974 if(NULL != controller.mImpl->mEditableControlInterface)
976 controller.mImpl->mEditableControlInterface->TextChanged(true);
980 case Toolkit::TextSelectionPopup::COPY:
982 controller.mImpl->SendSelectionToClipboard(false); // Text not modified
984 controller.mImpl->mEventData->mUpdateCursorPosition = true;
986 controller.mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
989 case Toolkit::TextSelectionPopup::PASTE:
991 controller.mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
994 case Toolkit::TextSelectionPopup::SELECT:
996 const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
998 if(controller.mImpl->mEventData->mSelectionEnabled)
1000 // Creates a SELECT event.
1001 controller.SelectEvent(currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
1005 case Toolkit::TextSelectionPopup::SELECT_ALL:
1007 // Creates a SELECT_ALL event
1008 controller.SelectEvent(0.f, 0.f, SelectionType::ALL);
1011 case Toolkit::TextSelectionPopup::CLIPBOARD:
1013 controller.mImpl->ShowClipboard();
1016 case Toolkit::TextSelectionPopup::NONE:
1026 } // namespace Toolkit