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-controller-placeholder-handler.h>
30 #include <dali-toolkit/internal/text/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 controller.mImpl->mEventData->mCheckScrollAmount = true;
195 Event event(Event::CURSOR_KEY_EVENT);
196 event.p1.mInt = keyCode;
197 event.p2.mBool = keyEvent.IsShiftModifier();
198 controller.mImpl->mEventData->mEventQueue.push_back(event);
200 // Will request for relayout.
201 relayoutNeeded = true;
203 else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
205 // Left or Right Control key event is received before Ctrl-C/V/X key event is received
206 // If not handle it here, any selected text will be deleted
211 else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier() && isEditable)
213 bool consumed = false;
214 if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
216 // Ctrl-C or Ctrl+Insert to copy the selected text
217 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
220 else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
222 // Ctrl-V to paste the copied text
223 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
226 else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
228 // Ctrl-X to cut the selected text
229 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
232 else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
234 // Ctrl-A to select All the text
235 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
240 else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
241 (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
243 textChanged = DeleteEvent(controller, keyCode);
245 // Will request for relayout.
246 relayoutNeeded = true;
248 else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
249 IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
250 IsKey(keyEvent, Dali::DALI_KEY_HOME))
252 // Power key/Menu/Home key behaviour does not allow edit mode to resume.
253 controller.mImpl->ChangeState(EventData::INACTIVE);
255 // Will request for relayout.
256 relayoutNeeded = true;
258 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
260 else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
262 // 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
263 // and a character is typed after the type of a upper case latin character.
268 else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
270 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
276 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
277 if(!isEditable) return false;
279 std::string refinedKey = keyString;
280 if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
282 bool accepted = false;
283 bool rejected = false;
284 accepted = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
285 rejected = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
289 // The filtered key is set to empty.
291 // Signal emits when the character to be inserted is filtered by the accepted filter.
292 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
296 // The filtered key is set to empty.
298 // Signal emits when the character to be inserted is filtered by the rejected filter.
299 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
303 if(!refinedKey.empty())
305 // InputMethodContext is no longer handling key-events
306 controller.mImpl->ClearPreEditFlag();
308 TextUpdater::InsertText(controller, refinedKey, COMMIT);
312 // Will request for relayout.
313 relayoutNeeded = true;
317 if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
318 (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
320 (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
321 (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
322 (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
323 (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
325 // Should not change the state if the key is the shift send by the InputMethodContext.
326 // Otherwise, when the state is SELECTING the text controller can't send the right
327 // surrounding info to the InputMethodContext.
328 controller.mImpl->ChangeState(EventData::EDITING);
330 // Will request for relayout.
331 relayoutNeeded = true;
336 controller.mImpl->RequestRelayout();
339 else if((NULL != controller.mImpl->mEventData) && (keyEvent.GetState() == KeyEvent::UP))
341 // Handles specific keys that require event propagation.
342 if(Dali::DALI_KEY_BACK == keyEvent.GetKeyCode())
350 (NULL != controller.mImpl->mEditableControlInterface))
352 // Do this last since it provides callbacks into application code
353 controller.mImpl->mEditableControlInterface->TextChanged(false);
359 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
361 if(!controller.mImpl->mMarkupProcessorEnabled ||
362 !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
363 !controller.mImpl->IsShowingRealText())
368 CharacterIndex cursorPosition = 0u;
370 // Convert from control's coords to text's coords.
371 const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
372 const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
374 // Whether to touch point hits on a glyph.
375 bool matchedCharacter = false;
376 cursorPosition = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
377 controller.mImpl->mModel->mLogicalModel,
378 controller.mImpl->mMetrics,
381 CharacterHitTest::TAP,
384 for(const auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
386 // Anchor clicked if the calculated cursor position is within the range of anchor.
387 if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
389 if(controller.mImpl->mAnchorControlInterface && anchor.href)
391 std::string href(anchor.href);
392 controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
399 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
401 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
403 if(NULL != controller.mImpl->mEventData)
405 DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
406 EventData::State state(controller.mImpl->mEventData->mState);
407 bool relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
409 if(controller.mImpl->IsClipboardVisible())
411 if(EventData::INACTIVE == state || EventData::EDITING == state)
413 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
415 relayoutNeeded = true;
417 else if(1u == tapCount)
419 if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
421 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
424 if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
426 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
427 relayoutNeeded = true;
431 if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
433 // Hide placeholder text
434 TextUpdater::ResetText(controller);
437 if(EventData::INACTIVE == state)
439 controller.mImpl->ChangeState(EventData::EDITING);
441 else if(!controller.mImpl->IsClipboardEmpty())
443 controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
445 relayoutNeeded = true;
448 else if(2u == tapCount)
450 if(controller.mImpl->mEventData->mSelectionEnabled &&
451 controller.mImpl->IsShowingRealText())
453 relayoutNeeded = true;
454 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
455 controller.mImpl->mEventData->mIsRightHandleSelected = true;
459 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
462 Event event(Event::TAP_EVENT);
463 event.p1.mUint = tapCount;
466 controller.mImpl->mEventData->mEventQueue.push_back(event);
468 controller.mImpl->RequestRelayout();
472 // Reset keyboard as tap event has occurred.
473 controller.mImpl->ResetInputMethodContext();
476 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
478 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
480 if(NULL != controller.mImpl->mEventData)
482 Event event(Event::PAN_EVENT);
483 event.p1.mInt = static_cast<int>(state);
484 event.p2.mFloat = displacement.x;
485 event.p3.mFloat = displacement.y;
486 controller.mImpl->mEventData->mEventQueue.push_back(event);
488 controller.mImpl->RequestRelayout();
492 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
494 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
496 if((state == GestureState::STARTED) &&
497 (NULL != controller.mImpl->mEventData))
499 // The 1st long-press on inactive text-field is treated as tap
500 if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
502 controller.mImpl->ChangeState(EventData::EDITING);
504 Event event(Event::TAP_EVENT);
508 controller.mImpl->mEventData->mEventQueue.push_back(event);
510 controller.mImpl->RequestRelayout();
512 else if(!controller.mImpl->IsShowingRealText())
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 else if(!controller.mImpl->IsClipboardVisible())
523 // Reset the InputMethodContext to commit the pre-edit before selecting the text.
524 controller.mImpl->ResetInputMethodContext();
526 Event event(Event::LONG_PRESS_EVENT);
527 event.p1.mInt = static_cast<int>(state);
530 controller.mImpl->mEventData->mEventQueue.push_back(event);
531 controller.mImpl->RequestRelayout();
533 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
534 controller.mImpl->mEventData->mIsRightHandleSelected = true;
539 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
541 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
543 if(NULL != controller.mImpl->mEventData)
545 if(selectType == SelectionType::ALL)
547 Event event(Event::SELECT_ALL);
548 controller.mImpl->mEventData->mEventQueue.push_back(event);
550 else if(selectType == SelectionType::NONE)
552 Event event(Event::SELECT_NONE);
553 controller.mImpl->mEventData->mEventQueue.push_back(event);
557 Event event(Event::SELECT);
560 controller.mImpl->mEventData->mEventQueue.push_back(event);
563 controller.mImpl->mEventData->mCheckScrollAmount = true;
564 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
565 controller.mImpl->mEventData->mIsRightHandleSelected = true;
566 controller.mImpl->RequestRelayout();
570 void Controller::EventHandler::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
572 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
574 if(NULL != controller.mImpl->mEventData)
576 if(selectType == SelectionType::RANGE)
578 Event event(Event::SELECT_RANGE);
579 event.p2.mUint = start;
580 event.p3.mUint = end;
581 controller.mImpl->mEventData->mEventQueue.push_back(event);
584 controller.mImpl->mEventData->mCheckScrollAmount = true;
585 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
586 controller.mImpl->mEventData->mIsRightHandleSelected = true;
587 controller.mImpl->RequestRelayout();
591 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
593 Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
595 if(0u == events.Count())
601 for(Vector<ModifyEvent>::ConstIterator it = events.Begin(),
602 endIt = events.End();
606 const ModifyEvent& event = *it;
608 if(ModifyEvent::TEXT_REPLACED == event.type)
610 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
611 DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
613 TextReplacedEvent(controller);
615 else if(ModifyEvent::TEXT_INSERTED == event.type)
617 TextInsertedEvent(controller);
619 else if(ModifyEvent::TEXT_DELETED == event.type)
621 // Placeholder-text cannot be deleted
622 if(!controller.mImpl->IsShowingPlaceholderText())
624 TextDeletedEvent(controller);
629 if(NULL != controller.mImpl->mEventData)
631 uint32_t oldStart, oldEnd;
632 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
633 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
635 // When the text is being modified, delay cursor blinking
636 controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
638 // Update selection position after modifying the text
639 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
640 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
642 if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
644 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
648 // DISCARD temporary text
652 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
654 // The natural size needs to be re-calculated.
655 controller.mImpl->mRecalculateNaturalSize = true;
657 // The text direction needs to be updated.
658 controller.mImpl->mUpdateTextDirection = true;
660 // Apply modifications to the model
661 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
664 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
666 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
668 if(NULL == controller.mImpl->mEventData)
673 controller.mImpl->mEventData->mCheckScrollAmount = true;
675 // The natural size needs to be re-calculated.
676 controller.mImpl->mRecalculateNaturalSize = true;
678 // The text direction needs to be updated.
679 controller.mImpl->mUpdateTextDirection = true;
681 // Apply modifications to the model; TODO - Optimize this
682 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
685 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
687 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
689 if(NULL == controller.mImpl->mEventData)
694 if(!controller.IsEditable()) return;
696 controller.mImpl->mEventData->mCheckScrollAmount = true;
698 // The natural size needs to be re-calculated.
699 controller.mImpl->mRecalculateNaturalSize = true;
701 // The text direction needs to be updated.
702 controller.mImpl->mUpdateTextDirection = true;
704 // Apply modifications to the model; TODO - Optimize this
705 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
708 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
710 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
712 bool removed = false;
714 if(NULL == controller.mImpl->mEventData)
719 if(!controller.IsEditable()) return false;
721 // InputMethodContext is no longer handling key-events
722 controller.mImpl->ClearPreEditFlag();
724 if(EventData::SELECTING == controller.mImpl->mEventData->mState)
726 removed = TextUpdater::RemoveSelectedText(controller);
728 else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
730 // Remove the character before the current cursor position
731 removed = TextUpdater::RemoveText(controller, -1, 1, UPDATE_INPUT_STYLE);
733 else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
734 (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
736 // Remove the character after the current cursor position
737 removed = TextUpdater::RemoveText(controller, 0, 1, UPDATE_INPUT_STYLE);
742 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
743 !controller.mImpl->IsPlaceholderAvailable())
745 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
749 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
751 controller.mImpl->mEventData->mUpdateCursorPosition = true;
752 controller.mImpl->mEventData->mScrollAfterDelete = true;
758 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
760 // Whether the text needs to be relaid-out.
761 bool requestRelayout = false;
763 // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
764 bool retrieveText = false;
765 bool retrieveCursor = false;
767 switch(inputMethodContextEvent.eventName)
769 case InputMethodContext::COMMIT:
771 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
772 requestRelayout = true;
773 retrieveCursor = true;
776 case InputMethodContext::PRE_EDIT:
778 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
779 requestRelayout = true;
780 retrieveCursor = true;
783 case InputMethodContext::DELETE_SURROUNDING:
785 const bool textDeleted = TextUpdater::RemoveText(controller,
786 inputMethodContextEvent.cursorOffset,
787 inputMethodContextEvent.numberOfChars,
788 DONT_UPDATE_INPUT_STYLE);
792 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
793 !controller.mImpl->IsPlaceholderAvailable())
795 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
799 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
801 controller.mImpl->mEventData->mUpdateCursorPosition = true;
802 controller.mImpl->mEventData->mScrollAfterDelete = true;
804 requestRelayout = true;
808 case InputMethodContext::GET_SURROUNDING:
811 retrieveCursor = true;
814 case InputMethodContext::PRIVATE_COMMAND:
816 // PRIVATECOMMAND event is just for getting the private command message
818 retrieveCursor = true;
821 case InputMethodContext::SELECTION_SET:
823 uint32_t start = static_cast<uint32_t>(inputMethodContextEvent.startIndex);
824 uint32_t end = static_cast<uint32_t>(inputMethodContextEvent.endIndex);
827 controller.SetPrimaryCursorPosition(start, true);
831 controller.SelectText(start, end);
836 case InputMethodContext::VOID:
845 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
846 controller.mImpl->RequestRelayout();
850 CharacterIndex cursorPosition = 0u;
851 Length numberOfWhiteSpaces = 0u;
855 numberOfWhiteSpaces = controller.mImpl->GetNumberOfWhiteSpaces(0u);
857 cursorPosition = controller.mImpl->GetLogicalCursorPosition();
859 if(cursorPosition < numberOfWhiteSpaces)
865 cursorPosition -= numberOfWhiteSpaces;
871 if(!controller.mImpl->IsShowingPlaceholderText())
873 // Retrieves the normal text string.
874 controller.mImpl->GetText(numberOfWhiteSpaces, text);
878 // When the current text is Placeholder Text, the surrounding text should be empty string.
879 // It means DALi should send empty string ("") to IME.
884 InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
886 if(requestRelayout &&
887 (NULL != controller.mImpl->mEditableControlInterface))
889 // Do this last since it provides callbacks into application code
890 controller.mImpl->mEditableControlInterface->TextChanged(false);
896 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller)
898 // Retrieve the clipboard contents first
899 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
900 std::string stringToPaste(notifier.GetContent());
902 // Commit the current pre-edit text; the contents of the clipboard should be appended
903 controller.mImpl->ResetInputMethodContext();
905 // Temporary disable hiding clipboard
906 controller.mImpl->SetClipboardHideEnable(false);
909 TextUpdater::PasteText(controller, stringToPaste);
911 controller.mImpl->SetClipboardHideEnable(true);
914 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
916 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
918 if(NULL != controller.mImpl->mEventData)
924 Event event(Event::GRAB_HANDLE_EVENT);
925 event.p1.mUint = state;
929 controller.mImpl->mEventData->mEventQueue.push_back(event);
932 case LEFT_SELECTION_HANDLE:
934 Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
935 event.p1.mUint = state;
939 controller.mImpl->mEventData->mEventQueue.push_back(event);
942 case RIGHT_SELECTION_HANDLE:
944 Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
945 event.p1.mUint = state;
949 controller.mImpl->mEventData->mEventQueue.push_back(event);
952 case LEFT_SELECTION_HANDLE_MARKER:
953 case RIGHT_SELECTION_HANDLE_MARKER:
955 // Markers do not move the handles.
958 case HANDLE_TYPE_COUNT:
960 DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
964 controller.mImpl->RequestRelayout();
968 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
970 if(NULL == controller.mImpl->mEventData)
977 case Toolkit::TextSelectionPopup::CUT:
979 controller.CutText();
982 case Toolkit::TextSelectionPopup::COPY:
984 controller.CopyText();
987 case Toolkit::TextSelectionPopup::PASTE:
989 controller.PasteText();
992 case Toolkit::TextSelectionPopup::SELECT:
994 const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
996 if(controller.mImpl->mEventData->mSelectionEnabled)
998 // Creates a SELECT event.
999 SelectEvent(controller, currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
1003 case Toolkit::TextSelectionPopup::SELECT_ALL:
1005 // Creates a SELECT_ALL event
1006 SelectEvent(controller, 0.f, 0.f, SelectionType::ALL);
1009 case Toolkit::TextSelectionPopup::CLIPBOARD:
1011 controller.mImpl->ShowClipboard();
1014 case Toolkit::TextSelectionPopup::NONE:
1024 } // namespace Toolkit