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>
25 #include <dali/integration-api/trace.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/cursor-helper-functions.h>
32 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
36 #if defined(DEBUG_ENABLED)
37 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
40 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
42 const std::string KEY_C_NAME = "c";
43 const std::string KEY_V_NAME = "v";
44 const std::string KEY_X_NAME = "x";
45 const std::string KEY_A_NAME = "a";
46 const std::string KEY_INSERT_NAME = "Insert";
56 void Controller::EventHandler::KeyboardFocusGainEvent(Controller& controller)
58 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusGainEvent");
60 if(NULL != controller.mImpl->mEventData)
62 if((EventData::INACTIVE == controller.mImpl->mEventData->mState) ||
63 (EventData::INTERRUPTED == controller.mImpl->mEventData->mState))
65 controller.mImpl->ChangeState(EventData::EDITING);
66 controller.mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
67 controller.mImpl->mEventData->mUpdateInputStyle = true;
68 controller.mImpl->mEventData->mScrollAfterUpdatePosition = true;
70 controller.mImpl->NotifyInputMethodContextMultiLineStatus();
71 if(controller.mImpl->IsShowingPlaceholderText())
73 // Show alternative placeholder-text when editing
74 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
77 controller.mImpl->RequestRelayout();
81 void Controller::EventHandler::KeyboardFocusLostEvent(Controller& controller)
83 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusLostEvent");
85 if(NULL != controller.mImpl->mEventData)
87 if(EventData::INTERRUPTED != controller.mImpl->mEventData->mState)
89 // Init selection position
90 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
92 uint32_t oldStart, oldEnd;
93 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
94 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
96 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
97 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
99 if(controller.mImpl->mSelectableControlInterface != nullptr)
101 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mPrimaryCursorPosition, controller.mImpl->mEventData->mPrimaryCursorPosition);
105 controller.mImpl->ChangeState(EventData::INACTIVE);
107 if(!controller.mImpl->IsShowingRealText())
109 // Revert to regular placeholder-text when not editing
110 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
114 controller.mImpl->RequestRelayout();
117 bool Controller::EventHandler::KeyEvent(Controller& controller, const Dali::KeyEvent& keyEvent)
119 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyEvent");
121 bool textChanged = false;
122 bool relayoutNeeded = false;
123 bool isEditable = controller.IsEditable() && controller.IsUserInteractionEnabled();
125 if((NULL != controller.mImpl->mEventData) &&
126 (keyEvent.GetState() == KeyEvent::DOWN))
128 int keyCode = keyEvent.GetKeyCode();
129 const std::string& keyString = keyEvent.GetKeyString();
130 const std::string keyName = keyEvent.GetKeyName();
131 // Key will produce same logical-key value when ctrl
132 // is down, regardless of language layout
133 const std::string logicalKey = keyEvent.GetLogicalKey();
135 const bool isNullKey = (0 == keyCode) && (keyString.empty());
137 // Pre-process to separate modifying events from non-modifying input events.
140 // In some platforms arrive key events with no key code.
144 else if(Dali::DALI_KEY_ESCAPE == keyCode || Dali::DALI_KEY_BACK == keyCode || Dali::DALI_KEY_SEARCH == keyCode)
149 else if((Dali::DALI_KEY_CURSOR_LEFT == keyCode) ||
150 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode) ||
151 (Dali::DALI_KEY_CURSOR_UP == keyCode) ||
152 (Dali::DALI_KEY_CURSOR_DOWN == keyCode))
154 // If don't have any text, do nothing.
155 if(!controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters || !isEditable)
160 uint32_t cursorPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
161 uint32_t numberOfCharacters = controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
162 uint32_t cursorLine = controller.mImpl->mModel->mVisualModel->GetLineOfCharacter(cursorPosition);
163 uint32_t numberOfLines = controller.mImpl->mModel->GetNumberOfLines();
165 // Logic to determine whether this text control will lose focus or not.
166 if((Dali::DALI_KEY_CURSOR_LEFT == keyCode && 0 == cursorPosition && !keyEvent.IsShiftModifier()) ||
167 (Dali::DALI_KEY_CURSOR_RIGHT == keyCode && numberOfCharacters == cursorPosition && !keyEvent.IsShiftModifier()) ||
168 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && cursorLine == numberOfLines - 1) ||
169 (Dali::DALI_KEY_CURSOR_DOWN == keyCode && numberOfCharacters == cursorPosition && cursorLine - 1 == numberOfLines - 1) ||
170 (Dali::DALI_KEY_CURSOR_UP == keyCode && cursorLine == 0) ||
171 (Dali::DALI_KEY_CURSOR_UP == keyCode && numberOfCharacters == cursorPosition && cursorLine == 1))
173 // Release the active highlight.
174 if(controller.mImpl->mEventData->mState == EventData::SELECTING)
176 uint32_t oldStart, oldEnd;
177 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
178 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
180 controller.mImpl->ChangeState(EventData::EDITING);
182 // Update selection position.
183 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
184 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
185 controller.mImpl->mEventData->mUpdateCursorPosition = true;
187 if(controller.mImpl->mSelectableControlInterface != nullptr)
189 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
192 controller.mImpl->RequestRelayout();
197 if(controller.mImpl->mEventData->mState == EventData::INACTIVE)
199 // Cursor position will be updated
200 controller.mImpl->ChangeState(EventData::EDITING);
203 controller.mImpl->mEventData->mCheckScrollAmount = true;
204 Event event(Event::CURSOR_KEY_EVENT);
205 event.p1.mInt = keyCode;
206 event.p2.mBool = keyEvent.IsShiftModifier();
207 controller.mImpl->mEventData->mEventQueue.push_back(event);
209 // Will request for relayout.
210 relayoutNeeded = true;
212 else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
214 // Left or Right Control key event is received before Ctrl-C/V/X key event is received
215 // If not handle it here, any selected text will be deleted
220 else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier() && isEditable)
222 bool consumed = false;
223 if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
225 // Ctrl-C or Ctrl+Insert to copy the selected text
226 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
229 else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
231 // Ctrl-V to paste the copied text
232 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
235 else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
237 // Ctrl-X to cut the selected text
238 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
241 else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
243 // Ctrl-A to select All the text
244 controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
249 else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
250 (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
252 textChanged = DeleteEvent(controller, keyCode);
254 // Will request for relayout.
255 relayoutNeeded = true;
257 else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
258 IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
259 IsKey(keyEvent, Dali::DALI_KEY_HOME))
261 // Power key/Menu/Home key behaviour does not allow edit mode to resume.
262 controller.mImpl->ChangeState(EventData::INACTIVE);
264 // Will request for relayout.
265 relayoutNeeded = true;
267 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
269 else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
271 // 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
272 // and a character is typed after the type of a upper case latin character.
277 else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
279 // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
285 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
286 if(!isEditable) return false;
288 std::string refinedKey = keyString;
289 if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
291 bool accepted = false;
292 bool rejected = false;
293 accepted = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
294 rejected = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
298 // The filtered key is set to empty.
300 // Signal emits when the character to be inserted is filtered by the accepted filter.
301 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
305 // The filtered key is set to empty.
307 // Signal emits when the character to be inserted is filtered by the rejected filter.
308 controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
312 if(!refinedKey.empty())
314 // InputMethodContext is no longer handling key-events
315 controller.mImpl->ClearPreEditFlag();
317 TextUpdater::InsertText(controller, refinedKey, COMMIT);
321 // Will request for relayout.
322 relayoutNeeded = true;
326 if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
327 (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
329 (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
330 (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
331 (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
332 (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
334 // Should not change the state if the key is the shift send by the InputMethodContext.
335 // Otherwise, when the state is SELECTING the text controller can't send the right
336 // surrounding info to the InputMethodContext.
337 controller.mImpl->ChangeState(EventData::EDITING);
339 // Will request for relayout.
340 relayoutNeeded = true;
345 controller.mImpl->RequestRelayout();
348 else if((NULL != controller.mImpl->mEventData) && (keyEvent.GetState() == KeyEvent::UP))
350 // Handles specific keys that require event propagation.
351 if(Dali::DALI_KEY_BACK == keyEvent.GetKeyCode())
359 (NULL != controller.mImpl->mEditableControlInterface))
361 // Do this last since it provides callbacks into application code
362 controller.mImpl->mEditableControlInterface->TextChanged(false);
368 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
370 if(!controller.mImpl->mMarkupProcessorEnabled ||
371 !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
372 !controller.mImpl->IsShowingRealText())
377 CharacterIndex cursorPosition = 0u;
379 // Convert from control's coords to text's coords.
380 const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
381 const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
383 // Whether to touch point hits on a glyph.
384 bool matchedCharacter = false;
385 cursorPosition = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
386 controller.mImpl->mModel->mLogicalModel,
387 controller.mImpl->mMetrics,
390 CharacterHitTest::TAP,
393 for(const auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
395 // Anchor clicked if the calculated cursor position is within the range of anchor.
396 if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
398 if(controller.mImpl->mAnchorControlInterface && anchor.href)
400 std::string href(anchor.href);
401 controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
408 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
410 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
412 if(NULL != controller.mImpl->mEventData)
414 DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
415 EventData::State state(controller.mImpl->mEventData->mState);
416 bool relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
418 if(controller.mImpl->IsClipboardVisible())
420 if(EventData::INACTIVE == state || EventData::EDITING == state)
422 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
424 relayoutNeeded = true;
426 else if(1u == tapCount)
428 if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
430 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
433 if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
435 controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
436 relayoutNeeded = true;
440 if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
442 // Hide placeholder text
443 TextUpdater::ResetText(controller);
446 if(EventData::INACTIVE == state)
448 controller.mImpl->ChangeState(EventData::EDITING);
450 else if(!controller.mImpl->IsClipboardEmpty())
452 controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
454 relayoutNeeded = true;
457 else if(2u == tapCount)
459 if(controller.mImpl->mEventData->mSelectionEnabled &&
460 controller.mImpl->IsShowingRealText())
462 relayoutNeeded = true;
463 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
464 controller.mImpl->mEventData->mIsRightHandleSelected = true;
468 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
471 Event event(Event::TAP_EVENT);
472 event.p1.mUint = tapCount;
475 controller.mImpl->mEventData->mEventQueue.push_back(event);
477 controller.mImpl->RequestRelayout();
481 // Reset keyboard as tap event has occurred.
482 controller.mImpl->ResetInputMethodContext();
485 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
487 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
489 if(NULL != controller.mImpl->mEventData)
491 Event event(Event::PAN_EVENT);
492 event.p1.mInt = static_cast<int>(state);
493 event.p2.mFloat = displacement.x;
494 event.p3.mFloat = displacement.y;
495 controller.mImpl->mEventData->mEventQueue.push_back(event);
497 controller.mImpl->RequestRelayout();
501 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
503 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
505 if((state == GestureState::STARTED) &&
506 (NULL != controller.mImpl->mEventData))
508 // The 1st long-press on inactive text-field is treated as tap
509 if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
511 controller.mImpl->ChangeState(EventData::EDITING);
513 Event event(Event::TAP_EVENT);
517 controller.mImpl->mEventData->mEventQueue.push_back(event);
519 controller.mImpl->RequestRelayout();
521 else if(!controller.mImpl->IsShowingRealText())
523 Event event(Event::LONG_PRESS_EVENT);
524 event.p1.mInt = static_cast<int>(state);
527 controller.mImpl->mEventData->mEventQueue.push_back(event);
528 controller.mImpl->RequestRelayout();
530 else if(!controller.mImpl->IsClipboardVisible())
532 // Reset the InputMethodContext to commit the pre-edit before selecting the text.
533 controller.mImpl->ResetInputMethodContext();
535 Event event(Event::LONG_PRESS_EVENT);
536 event.p1.mInt = static_cast<int>(state);
539 controller.mImpl->mEventData->mEventQueue.push_back(event);
540 controller.mImpl->RequestRelayout();
542 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
543 controller.mImpl->mEventData->mIsRightHandleSelected = true;
548 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
550 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
552 if(NULL != controller.mImpl->mEventData)
554 if(selectType == SelectionType::ALL)
556 Event event(Event::SELECT_ALL);
557 controller.mImpl->mEventData->mEventQueue.push_back(event);
559 else if(selectType == SelectionType::NONE)
561 Event event(Event::SELECT_NONE);
562 controller.mImpl->mEventData->mEventQueue.push_back(event);
566 Event event(Event::SELECT);
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::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
581 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
583 if(NULL != controller.mImpl->mEventData)
585 if(selectType == SelectionType::RANGE)
587 Event event(Event::SELECT_RANGE);
588 event.p2.mUint = start;
589 event.p3.mUint = end;
590 controller.mImpl->mEventData->mEventQueue.push_back(event);
593 controller.mImpl->mEventData->mCheckScrollAmount = true;
594 controller.mImpl->mEventData->mIsLeftHandleSelected = true;
595 controller.mImpl->mEventData->mIsRightHandleSelected = true;
596 controller.mImpl->RequestRelayout();
600 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
602 Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
604 if(0u == events.Count())
610 DALI_TRACE_SCOPE(gTraceFilter, "DALI_TEXT_MODIFY_EVENTS");
612 for(Vector<ModifyEvent>::ConstIterator it = events.Begin(),
613 endIt = events.End();
617 const ModifyEvent& event = *it;
619 if(ModifyEvent::TEXT_REPLACED == event.type)
621 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
622 DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
624 TextReplacedEvent(controller);
626 else if(ModifyEvent::TEXT_INSERTED == event.type)
628 TextInsertedEvent(controller);
630 else if(ModifyEvent::TEXT_DELETED == event.type)
632 // Placeholder-text cannot be deleted
633 if(!controller.mImpl->IsShowingPlaceholderText())
635 TextDeletedEvent(controller);
640 if(NULL != controller.mImpl->mEventData)
642 uint32_t oldStart, oldEnd;
643 oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
644 oldEnd = controller.mImpl->mEventData->mRightSelectionPosition;
646 // When the text is being modified, delay cursor blinking
647 controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
649 // Update selection position after modifying the text
650 controller.mImpl->mEventData->mLeftSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
651 controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
653 if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
655 controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
659 // DISCARD temporary text
663 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
665 // The natural size needs to be re-calculated.
666 controller.mImpl->mRecalculateNaturalSize = true;
668 // The text direction needs to be updated.
669 controller.mImpl->mUpdateTextDirection = true;
671 // Apply modifications to the model
672 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
675 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
677 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
679 if(NULL == controller.mImpl->mEventData)
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 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
698 DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
700 if(NULL == controller.mImpl->mEventData)
705 if(!controller.IsEditable()) return;
707 controller.mImpl->mEventData->mCheckScrollAmount = true;
709 // The natural size needs to be re-calculated.
710 controller.mImpl->mRecalculateNaturalSize = true;
712 // The text direction needs to be updated.
713 controller.mImpl->mUpdateTextDirection = true;
715 // Apply modifications to the model; TODO - Optimize this
716 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
719 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
721 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
723 bool removed = false;
725 if(NULL == controller.mImpl->mEventData)
730 if(!controller.IsEditable()) return false;
732 // InputMethodContext is no longer handling key-events
733 controller.mImpl->ClearPreEditFlag();
735 if(EventData::SELECTING == controller.mImpl->mEventData->mState)
737 removed = TextUpdater::RemoveSelectedText(controller);
739 else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
741 // Remove the character before the current cursor position
742 removed = TextUpdater::RemoveText(controller, -1, 1, UPDATE_INPUT_STYLE);
744 else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
745 (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
747 // Remove the character after the current cursor position
748 removed = TextUpdater::RemoveText(controller, 0, 1, UPDATE_INPUT_STYLE);
753 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
754 !controller.mImpl->IsPlaceholderAvailable())
756 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
760 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
762 controller.mImpl->mEventData->mUpdateCursorPosition = true;
763 controller.mImpl->mEventData->mScrollAfterDelete = true;
769 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
771 // Whether the text needs to be relaid-out.
772 bool requestRelayout = false;
774 // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
775 bool retrieveText = false;
776 bool retrieveCursor = false;
778 switch(inputMethodContextEvent.eventName)
780 case InputMethodContext::COMMIT:
782 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
783 requestRelayout = true;
784 retrieveCursor = true;
787 case InputMethodContext::PRE_EDIT:
789 TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
790 requestRelayout = true;
791 retrieveCursor = true;
794 case InputMethodContext::DELETE_SURROUNDING:
796 const bool textDeleted = TextUpdater::RemoveText(controller,
797 inputMethodContextEvent.cursorOffset,
798 inputMethodContextEvent.numberOfChars,
799 DONT_UPDATE_INPUT_STYLE);
803 if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
804 !controller.mImpl->IsPlaceholderAvailable())
806 controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
810 PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
812 controller.mImpl->mEventData->mUpdateCursorPosition = true;
813 controller.mImpl->mEventData->mScrollAfterDelete = true;
815 requestRelayout = true;
819 case InputMethodContext::GET_SURROUNDING:
822 retrieveCursor = true;
825 case InputMethodContext::PRIVATE_COMMAND:
827 // PRIVATECOMMAND event is just for getting the private command message
829 retrieveCursor = true;
832 case InputMethodContext::SELECTION_SET:
834 uint32_t start = static_cast<uint32_t>(inputMethodContextEvent.startIndex);
835 uint32_t end = static_cast<uint32_t>(inputMethodContextEvent.endIndex);
838 controller.SetPrimaryCursorPosition(start, true);
842 controller.SelectText(start, end);
847 case InputMethodContext::VOID:
856 controller.mImpl->mOperationsPending = ALL_OPERATIONS;
857 controller.mImpl->RequestRelayout();
861 CharacterIndex cursorPosition = 0u;
862 Length numberOfWhiteSpaces = 0u;
866 numberOfWhiteSpaces = controller.mImpl->GetNumberOfWhiteSpaces(0u);
868 cursorPosition = controller.mImpl->GetLogicalCursorPosition();
870 if(cursorPosition < numberOfWhiteSpaces)
876 cursorPosition -= numberOfWhiteSpaces;
882 if(!controller.mImpl->IsShowingPlaceholderText())
884 // Retrieves the normal text string.
885 controller.mImpl->GetText(numberOfWhiteSpaces, text);
889 // When the current text is Placeholder Text, the surrounding text should be empty string.
890 // It means DALi should send empty string ("") to IME.
895 InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
897 if(requestRelayout &&
898 (NULL != controller.mImpl->mEditableControlInterface))
900 // Do this last since it provides callbacks into application code
901 controller.mImpl->mEditableControlInterface->TextChanged(false);
907 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller)
909 // Retrieve the clipboard contents first
910 ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
911 std::string stringToPaste(notifier.GetContent());
913 // Commit the current pre-edit text; the contents of the clipboard should be appended
914 controller.mImpl->ResetInputMethodContext();
916 // Temporary disable hiding clipboard
917 controller.mImpl->SetClipboardHideEnable(false);
920 TextUpdater::PasteText(controller, stringToPaste);
922 controller.mImpl->SetClipboardHideEnable(true);
925 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
927 DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
929 if(NULL != controller.mImpl->mEventData)
935 Event event(Event::GRAB_HANDLE_EVENT);
936 event.p1.mUint = state;
940 controller.mImpl->mEventData->mEventQueue.push_back(event);
943 case LEFT_SELECTION_HANDLE:
945 Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
946 event.p1.mUint = state;
950 controller.mImpl->mEventData->mEventQueue.push_back(event);
953 case RIGHT_SELECTION_HANDLE:
955 Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
956 event.p1.mUint = state;
960 controller.mImpl->mEventData->mEventQueue.push_back(event);
963 case LEFT_SELECTION_HANDLE_MARKER:
964 case RIGHT_SELECTION_HANDLE_MARKER:
966 // Markers do not move the handles.
969 case HANDLE_TYPE_COUNT:
971 DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
975 controller.mImpl->RequestRelayout();
979 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
981 if(NULL == controller.mImpl->mEventData)
988 case Toolkit::TextSelectionPopup::CUT:
990 controller.CutText();
993 case Toolkit::TextSelectionPopup::COPY:
995 controller.CopyText();
998 case Toolkit::TextSelectionPopup::PASTE:
1000 controller.PasteText();
1003 case Toolkit::TextSelectionPopup::SELECT:
1005 const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
1007 if(controller.mImpl->mEventData->mSelectionEnabled)
1009 // Creates a SELECT event.
1010 SelectEvent(controller, currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
1014 case Toolkit::TextSelectionPopup::SELECT_ALL:
1016 // Creates a SELECT_ALL event
1017 SelectEvent(controller, 0.f, 0.f, SelectionType::ALL);
1020 case Toolkit::TextSelectionPopup::CLIPBOARD:
1022 controller.mImpl->ShowClipboard();
1025 case Toolkit::TextSelectionPopup::NONE:
1035 } // namespace Toolkit