dali-toolkit/internal/text/controller/text-controller-event-handler.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/text/controller/text-controller-event-handler.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/key-devel.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/integration-api/trace.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/text/controller/text-controller-impl.h>
  28 #include <dali-toolkit/internal/text/controller/text-controller-placeholder-handler.h>
  29 #include <dali-toolkit/internal/text/controller/text-controller-text-updater.h>
  30 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
  31 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  32
  33 namespace
  34 {
  35 #if defined(DEBUG_ENABLED)
  36 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  37 #endif
  38
  39 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_TEXT_PERFORMANCE_MARKER, false);
  40
  41 const char* KEY_C_NAME      = "c";
  42 const char* KEY_V_NAME      = "v";
  43 const char* KEY_X_NAME      = "x";
  44 const char* KEY_A_NAME      = "a";
  45 const char* KEY_INSERT_NAME = "Insert";
  46
  47 } // namespace
  48
  49 namespace Dali
  50 {
  51 namespace Toolkit
  52 {
  53 namespace Text
  54 {
  55 void Controller::EventHandler::KeyboardFocusGainEvent(Controller& controller)
  56 {
  57   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusGainEvent");
  58
  59   if(NULL != controller.mImpl->mEventData)
  60   {
  61     if((EventData::INACTIVE == controller.mImpl->mEventData->mState) ||
  62        (EventData::INTERRUPTED == controller.mImpl->mEventData->mState))
  63     {
  64       controller.mImpl->ChangeState(EventData::EDITING);
  65       controller.mImpl->mEventData->mUpdateCursorPosition      = true; //If editing started without tap event, cursor update must be triggered.
  66       controller.mImpl->mEventData->mUpdateInputStyle          = true;
  67       controller.mImpl->mEventData->mScrollAfterUpdatePosition = true;
  68     }
  69     controller.mImpl->NotifyInputMethodContextMultiLineStatus();
  70     if(controller.mImpl->IsShowingPlaceholderText())
  71     {
  72       // Show alternative placeholder-text when editing
  73       PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
  74     }
  75
  76     controller.mImpl->RequestRelayout();
  77   }
  78 }
  79
  80 void Controller::EventHandler::KeyboardFocusLostEvent(Controller& controller)
  81 {
  82   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyboardFocusLostEvent");
  83
  84   if(NULL != controller.mImpl->mEventData)
  85   {
  86     if(EventData::INTERRUPTED != controller.mImpl->mEventData->mState)
  87     {
  88       // Init selection position
  89       if(controller.mImpl->mEventData->mState == EventData::SELECTING)
  90       {
  91         uint32_t oldStart, oldEnd;
  92         oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
  93         oldEnd   = controller.mImpl->mEventData->mRightSelectionPosition;
  94
  95         controller.mImpl->mEventData->mLeftSelectionPosition  = controller.mImpl->mEventData->mPrimaryCursorPosition;
  96         controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
  97
  98         if(controller.mImpl->mSelectableControlInterface != nullptr)
  99         {
 100           controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mPrimaryCursorPosition, controller.mImpl->mEventData->mPrimaryCursorPosition);
 101         }
 102       }
 103
 104       controller.mImpl->ChangeState(EventData::INACTIVE);
 105
 106       if(!controller.mImpl->IsShowingRealText())
 107       {
 108         // Revert to regular placeholder-text when not editing
 109         PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
 110       }
 111     }
 112   }
 113   controller.mImpl->RequestRelayout();
 114 }
 115
 116 bool Controller::EventHandler::KeyEvent(Controller& controller, const Dali::KeyEvent& keyEvent)
 117 {
 118   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected KeyEvent");
 119
 120   bool textChanged    = false;
 121   bool relayoutNeeded = false;
 122   bool isEditable     = controller.IsEditable() && controller.IsUserInteractionEnabled();
 123
 124   if((NULL != controller.mImpl->mEventData) &&
 125      (keyEvent.GetState() == KeyEvent::DOWN))
 126   {
 127     int                keyCode   = keyEvent.GetKeyCode();
 128     const std::string& keyString = keyEvent.GetKeyString();
 129     const std::string  keyName   = keyEvent.GetKeyName();
 130     // Key will produce same logical-key value when ctrl
 131     // is down, regardless of language layout
 132     const std::string logicalKey = keyEvent.GetLogicalKey();
 133
 134     const bool isNullKey = (0 == keyCode) && (keyString.empty());
 135
 136     // Pre-process to separate modifying events from non-modifying input events.
 137     if(isNullKey)
 138     {
 139       // In some platforms arrive key events with no key code.
 140       // Do nothing.
 141       return false;
 142     }
 143     else if(Dali::DALI_KEY_ESCAPE == keyCode || Dali::DALI_KEY_BACK == keyCode || Dali::DALI_KEY_SEARCH == keyCode)
 144     {
 145       // Do nothing
 146       return false;
 147     }
 148     else if((Dali::DALI_KEY_CURSOR_LEFT == keyCode) ||
 149             (Dali::DALI_KEY_CURSOR_RIGHT == keyCode) ||
 150             (Dali::DALI_KEY_CURSOR_UP == keyCode) ||
 151             (Dali::DALI_KEY_CURSOR_DOWN == keyCode))
 152     {
 153       // If don't have any text, do nothing.
 154       if(!controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters || !isEditable)
 155       {
 156         return false;
 157       }
 158
 159       uint32_t cursorPosition     = controller.mImpl->mEventData->mPrimaryCursorPosition;
 160       uint32_t numberOfCharacters = controller.mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
 161       uint32_t cursorLine         = controller.mImpl->mModel->mVisualModel->GetLineOfCharacter(cursorPosition);
 162       uint32_t numberOfLines      = controller.mImpl->mModel->GetNumberOfLines();
 163
 164       // Logic to determine whether this text control will lose focus or not.
 165       if((Dali::DALI_KEY_CURSOR_LEFT == keyCode && 0 == cursorPosition && !keyEvent.IsShiftModifier()) ||
 166          (Dali::DALI_KEY_CURSOR_RIGHT == keyCode && numberOfCharacters == cursorPosition && !keyEvent.IsShiftModifier()) ||
 167          (Dali::DALI_KEY_CURSOR_DOWN == keyCode && cursorLine == numberOfLines - 1) ||
 168          (Dali::DALI_KEY_CURSOR_DOWN == keyCode && numberOfCharacters == cursorPosition && cursorLine - 1 == numberOfLines - 1) ||
 169          (Dali::DALI_KEY_CURSOR_UP == keyCode && cursorLine == 0) ||
 170          (Dali::DALI_KEY_CURSOR_UP == keyCode && numberOfCharacters == cursorPosition && cursorLine == 1))
 171       {
 172         // Release the active highlight.
 173         if(controller.mImpl->mEventData->mState == EventData::SELECTING)
 174         {
 175           uint32_t oldStart, oldEnd;
 176           oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
 177           oldEnd   = controller.mImpl->mEventData->mRightSelectionPosition;
 178
 179           controller.mImpl->ChangeState(EventData::EDITING);
 180
 181           // Update selection position.
 182           controller.mImpl->mEventData->mLeftSelectionPosition  = controller.mImpl->mEventData->mPrimaryCursorPosition;
 183           controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
 184           controller.mImpl->mEventData->mUpdateCursorPosition   = true;
 185
 186           if(controller.mImpl->mSelectableControlInterface != nullptr)
 187           {
 188             controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
 189           }
 190
 191           controller.mImpl->RequestRelayout();
 192         }
 193         return false;
 194       }
 195
 196       if(controller.mImpl->mEventData->mState == EventData::INACTIVE)
 197       {
 198         // Cursor position will be updated
 199         controller.mImpl->ChangeState(EventData::EDITING);
 200       }
 201
 202       controller.mImpl->mEventData->mCheckScrollAmount = true;
 203       Event event(Event::CURSOR_KEY_EVENT);
 204       event.p1.mInt  = keyCode;
 205       event.p2.mBool = keyEvent.IsShiftModifier();
 206       controller.mImpl->mEventData->mEventQueue.push_back(event);
 207
 208       // Will request for relayout.
 209       relayoutNeeded = true;
 210     }
 211     else if(Dali::DevelKey::DALI_KEY_CONTROL_LEFT == keyCode || Dali::DevelKey::DALI_KEY_CONTROL_RIGHT == keyCode)
 212     {
 213       // Left or Right Control key event is received before Ctrl-C/V/X key event is received
 214       // If not handle it here, any selected text will be deleted
 215
 216       // Do nothing
 217       return false;
 218     }
 219     else if(keyEvent.IsCtrlModifier() && !keyEvent.IsShiftModifier() && isEditable)
 220     {
 221       bool consumed = false;
 222       if(keyName == KEY_C_NAME || keyName == KEY_INSERT_NAME || logicalKey == KEY_C_NAME || logicalKey == KEY_INSERT_NAME)
 223       {
 224         if(!keyEvent.IsRepeat())
 225         {
 226           // Ctrl-C or Ctrl+Insert to copy the selected text
 227           controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::COPY);
 228         }
 229         consumed = true;
 230       }
 231       else if(keyName == KEY_V_NAME || logicalKey == KEY_V_NAME)
 232       {
 233         // Ctrl-V to paste the copied text
 234         controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::PASTE);
 235         consumed = true;
 236       }
 237       else if(keyName == KEY_X_NAME || logicalKey == KEY_X_NAME)
 238       {
 239         // Ctrl-X to cut the selected text
 240         controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::CUT);
 241         consumed = true;
 242       }
 243       else if(keyName == KEY_A_NAME || logicalKey == KEY_A_NAME)
 244       {
 245         // Ctrl-A to select All the text
 246         controller.TextPopupButtonTouched(Toolkit::TextSelectionPopup::SELECT_ALL);
 247         consumed = true;
 248       }
 249       return consumed;
 250     }
 251     else if((Dali::DALI_KEY_BACKSPACE == keyCode) ||
 252             (Dali::DevelKey::DALI_KEY_DELETE == keyCode))
 253     {
 254       textChanged = DeleteEvent(controller, keyCode);
 255
 256       // Will request for relayout.
 257       relayoutNeeded = true;
 258     }
 259     else if(IsKey(keyEvent, Dali::DALI_KEY_POWER) ||
 260             IsKey(keyEvent, Dali::DALI_KEY_MENU) ||
 261             IsKey(keyEvent, Dali::DALI_KEY_HOME))
 262     {
 263       // Power key/Menu/Home key behaviour does not allow edit mode to resume.
 264       controller.mImpl->ChangeState(EventData::INACTIVE);
 265
 266       // Will request for relayout.
 267       relayoutNeeded = true;
 268
 269       // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
 270     }
 271     else if((Dali::DALI_KEY_SHIFT_LEFT == keyCode) || (Dali::DALI_KEY_SHIFT_RIGHT == keyCode))
 272     {
 273       // DALI_KEY_SHIFT_LEFT or DALI_KEY_SHIFT_RIGHT is the key code for Shift. It's sent (by the InputMethodContext?) when the predictive text is enabled
 274       // and a character is typed after the type of a upper case latin character.
 275
 276       // Do nothing.
 277       return false;
 278     }
 279     else if((Dali::DALI_KEY_VOLUME_UP == keyCode) || (Dali::DALI_KEY_VOLUME_DOWN == keyCode))
 280     {
 281       // This branch avoids calling the InsertText() method of the 'else' branch which can delete selected text.
 282       // Do nothing.
 283       return false;
 284     }
 285     else
 286     {
 287       DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", &controller, keyString.c_str());
 288       if(!isEditable) return false;
 289
 290       std::string refinedKey = keyString;
 291       if(controller.mImpl->mInputFilter != NULL && !refinedKey.empty())
 292       {
 293         bool accepted = false;
 294         bool rejected = false;
 295         accepted      = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::ACCEPTED, keyString);
 296         rejected      = controller.mImpl->mInputFilter->Contains(Toolkit::InputFilter::Property::REJECTED, keyString);
 297
 298         if(!accepted)
 299         {
 300           // The filtered key is set to empty.
 301           refinedKey = "";
 302           // Signal emits when the character to be inserted is filtered by the accepted filter.
 303           controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::ACCEPTED);
 304         }
 305         if(rejected)
 306         {
 307           // The filtered key is set to empty.
 308           refinedKey = "";
 309           // Signal emits when the character to be inserted is filtered by the rejected filter.
 310           controller.mImpl->mEditableControlInterface->InputFiltered(Toolkit::InputFilter::Property::REJECTED);
 311         }
 312       }
 313
 314       if(!refinedKey.empty())
 315       {
 316         // InputMethodContext is no longer handling key-events
 317         controller.mImpl->ClearPreEditFlag();
 318
 319         TextUpdater::InsertText(controller, refinedKey, COMMIT);
 320
 321         textChanged = true;
 322
 323         // Will request for relayout.
 324         relayoutNeeded = true;
 325       }
 326     }
 327
 328     if((controller.mImpl->mEventData->mState != EventData::INTERRUPTED) &&
 329        (controller.mImpl->mEventData->mState != EventData::INACTIVE) &&
 330        (!isNullKey) &&
 331        (Dali::DALI_KEY_SHIFT_LEFT != keyCode) &&
 332        (Dali::DALI_KEY_SHIFT_RIGHT != keyCode) &&
 333        (Dali::DALI_KEY_VOLUME_UP != keyCode) &&
 334        (Dali::DALI_KEY_VOLUME_DOWN != keyCode))
 335     {
 336       // Should not change the state if the key is the shift send by the InputMethodContext.
 337       // Otherwise, when the state is SELECTING the text controller can't send the right
 338       // surrounding info to the InputMethodContext.
 339       controller.mImpl->ChangeState(EventData::EDITING);
 340
 341       // Will request for relayout.
 342       relayoutNeeded = true;
 343     }
 344
 345     if(relayoutNeeded)
 346     {
 347       controller.mImpl->RequestRelayout();
 348     }
 349   }
 350   else if((NULL != controller.mImpl->mEventData) && (keyEvent.GetState() == KeyEvent::UP))
 351   {
 352     // Handles specific keys that require event propagation.
 353     if(Dali::DALI_KEY_BACK == keyEvent.GetKeyCode())
 354     {
 355       // Do nothing
 356       return false;
 357     }
 358   }
 359
 360   if(textChanged &&
 361      (NULL != controller.mImpl->mEditableControlInterface))
 362   {
 363     // Do this last since it provides callbacks into application code
 364     controller.mImpl->mEditableControlInterface->TextChanged(false);
 365   }
 366
 367   return true;
 368 }
 369
 370 void Controller::EventHandler::AnchorEvent(Controller& controller, float x, float y)
 371 {
 372   if(!controller.mImpl->mMarkupProcessorEnabled ||
 373      !controller.mImpl->mModel->mLogicalModel->mAnchors.Count() ||
 374      !controller.mImpl->IsShowingRealText())
 375   {
 376     return;
 377   }
 378
 379   CharacterIndex cursorPosition = 0u;
 380
 381   // Convert from control's coords to text's coords.
 382   const float xPosition = x - controller.mImpl->mModel->mScrollPosition.x;
 383   const float yPosition = y - controller.mImpl->mModel->mScrollPosition.y;
 384
 385   // Whether to touch point hits on a glyph.
 386   bool matchedCharacter = false;
 387   cursorPosition        = Text::GetClosestCursorIndex(controller.mImpl->mModel->mVisualModel,
 388                                                controller.mImpl->mModel->mLogicalModel,
 389                                                controller.mImpl->mMetrics,
 390                                                xPosition,
 391                                                yPosition,
 392                                                CharacterHitTest::TAP,
 393                                                matchedCharacter);
 394
 395   for(const auto& anchor : controller.mImpl->mModel->mLogicalModel->mAnchors)
 396   {
 397     // Anchor clicked if the calculated cursor position is within the range of anchor.
 398     if(cursorPosition >= anchor.startIndex && cursorPosition < anchor.endIndex)
 399     {
 400       if(controller.mImpl->mAnchorControlInterface && anchor.href)
 401       {
 402         std::string href(anchor.href);
 403         controller.mImpl->mAnchorControlInterface->AnchorClicked(href);
 404         break;
 405       }
 406     }
 407   }
 408 }
 409
 410 void Controller::EventHandler::TapEvent(Controller& controller, unsigned int tapCount, float x, float y)
 411 {
 412   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected TapEvent");
 413
 414   if(NULL != controller.mImpl->mEventData)
 415   {
 416     DALI_LOG_INFO(gLogFilter, Debug::Concise, "TapEvent state:%d \n", controller.mImpl->mEventData->mState);
 417     EventData::State state(controller.mImpl->mEventData->mState);
 418     bool             relayoutNeeded(false); // to avoid unnecessary relayouts when tapping an empty text-field
 419
 420     if(controller.mImpl->IsClipboardVisible())
 421     {
 422       if(EventData::INACTIVE == state || EventData::EDITING == state)
 423       {
 424         controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
 425       }
 426       relayoutNeeded = true;
 427     }
 428     else if(1u == tapCount)
 429     {
 430       if(EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state)
 431       {
 432         controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE); // If Popup shown hide it here so can be shown again if required.
 433       }
 434
 435       if(controller.mImpl->IsShowingRealText() && (EventData::INACTIVE != state))
 436       {
 437         controller.mImpl->ChangeState(EventData::EDITING_WITH_GRAB_HANDLE);
 438         relayoutNeeded = true;
 439       }
 440       else
 441       {
 442         if(controller.mImpl->IsShowingPlaceholderText() && !controller.mImpl->IsFocusedPlaceholderAvailable())
 443         {
 444           // Hide placeholder text
 445           TextUpdater::ResetText(controller);
 446         }
 447
 448         if(EventData::INACTIVE == state)
 449         {
 450           controller.mImpl->ChangeState(EventData::EDITING);
 451         }
 452         else if(!controller.mImpl->IsClipboardEmpty())
 453         {
 454           controller.mImpl->ChangeState(EventData::EDITING_WITH_POPUP);
 455         }
 456         relayoutNeeded = true;
 457       }
 458     }
 459     else if(2u == tapCount)
 460     {
 461       if(controller.mImpl->mEventData->mSelectionEnabled &&
 462          controller.mImpl->IsShowingRealText())
 463       {
 464         relayoutNeeded                                       = true;
 465         controller.mImpl->mEventData->mIsLeftHandleSelected  = true;
 466         controller.mImpl->mEventData->mIsRightHandleSelected = true;
 467       }
 468     }
 469
 470     // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
 471     if(relayoutNeeded)
 472     {
 473       Event event(Event::TAP_EVENT);
 474       event.p1.mUint  = tapCount;
 475       event.p2.mFloat = x;
 476       event.p3.mFloat = y;
 477       controller.mImpl->mEventData->mEventQueue.push_back(event);
 478
 479       controller.mImpl->RequestRelayout();
 480     }
 481   }
 482
 483   // Reset keyboard as tap event has occurred.
 484   controller.mImpl->ResetInputMethodContext();
 485 }
 486
 487 void Controller::EventHandler::PanEvent(Controller& controller, GestureState state, const Vector2& displacement)
 488 {
 489   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected PanEvent");
 490
 491   if(NULL != controller.mImpl->mEventData)
 492   {
 493     Event event(Event::PAN_EVENT);
 494     event.p1.mInt   = static_cast<int>(state);
 495     event.p2.mFloat = displacement.x;
 496     event.p3.mFloat = displacement.y;
 497     controller.mImpl->mEventData->mEventQueue.push_back(event);
 498
 499     controller.mImpl->RequestRelayout();
 500   }
 501 }
 502
 503 void Controller::EventHandler::LongPressEvent(Controller& controller, GestureState state, float x, float y)
 504 {
 505   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected LongPressEvent");
 506
 507   if((state == GestureState::STARTED) &&
 508      (NULL != controller.mImpl->mEventData))
 509   {
 510     // The 1st long-press on inactive text-field is treated as tap
 511     if(EventData::INACTIVE == controller.mImpl->mEventData->mState)
 512     {
 513       controller.mImpl->ChangeState(EventData::EDITING);
 514
 515       Event event(Event::TAP_EVENT);
 516       event.p1.mUint  = 1;
 517       event.p2.mFloat = x;
 518       event.p3.mFloat = y;
 519       controller.mImpl->mEventData->mEventQueue.push_back(event);
 520
 521       controller.mImpl->RequestRelayout();
 522     }
 523     else if(!controller.mImpl->IsShowingRealText())
 524     {
 525       Event event(Event::LONG_PRESS_EVENT);
 526       event.p1.mInt   = static_cast<int>(state);
 527       event.p2.mFloat = x;
 528       event.p3.mFloat = y;
 529       controller.mImpl->mEventData->mEventQueue.push_back(event);
 530       controller.mImpl->RequestRelayout();
 531     }
 532     else if(!controller.mImpl->IsClipboardVisible())
 533     {
 534       // Reset the InputMethodContext to commit the pre-edit before selecting the text.
 535       controller.mImpl->ResetInputMethodContext();
 536
 537       Event event(Event::LONG_PRESS_EVENT);
 538       event.p1.mInt   = static_cast<int>(state);
 539       event.p2.mFloat = x;
 540       event.p3.mFloat = y;
 541       controller.mImpl->mEventData->mEventQueue.push_back(event);
 542       controller.mImpl->RequestRelayout();
 543
 544       controller.mImpl->mEventData->mIsLeftHandleSelected  = true;
 545       controller.mImpl->mEventData->mIsRightHandleSelected = true;
 546     }
 547   }
 548 }
 549
 550 void Controller::EventHandler::SelectEvent(Controller& controller, float x, float y, SelectionType selectType)
 551 {
 552   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
 553
 554   if(NULL != controller.mImpl->mEventData)
 555   {
 556     if(selectType == SelectionType::ALL)
 557     {
 558       Event event(Event::SELECT_ALL);
 559       controller.mImpl->mEventData->mEventQueue.push_back(event);
 560     }
 561     else if(selectType == SelectionType::NONE)
 562     {
 563       Event event(Event::SELECT_NONE);
 564       controller.mImpl->mEventData->mEventQueue.push_back(event);
 565     }
 566     else
 567     {
 568       Event event(Event::SELECT);
 569       event.p2.mFloat = x;
 570       event.p3.mFloat = y;
 571       controller.mImpl->mEventData->mEventQueue.push_back(event);
 572     }
 573
 574     controller.mImpl->mEventData->mCheckScrollAmount     = true;
 575     controller.mImpl->mEventData->mIsLeftHandleSelected  = true;
 576     controller.mImpl->mEventData->mIsRightHandleSelected = true;
 577     controller.mImpl->RequestRelayout();
 578   }
 579 }
 580
 581 void Controller::EventHandler::SelectEvent(Controller& controller, const uint32_t start, const uint32_t end, SelectionType selectType)
 582 {
 583   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::SelectEvent\n");
 584
 585   if(NULL != controller.mImpl->mEventData)
 586   {
 587     if(selectType == SelectionType::RANGE)
 588     {
 589       Event event(Event::SELECT_RANGE);
 590       event.p2.mUint = start;
 591       event.p3.mUint = end;
 592       controller.mImpl->mEventData->mEventQueue.push_back(event);
 593     }
 594
 595     controller.mImpl->mEventData->mCheckScrollAmount     = true;
 596     controller.mImpl->mEventData->mIsLeftHandleSelected  = true;
 597     controller.mImpl->mEventData->mIsRightHandleSelected = true;
 598     controller.mImpl->RequestRelayout();
 599   }
 600 }
 601
 602 void Controller::EventHandler::ProcessModifyEvents(Controller& controller)
 603 {
 604   Vector<ModifyEvent>& events = controller.mImpl->mModifyEvents;
 605
 606   if(0u == events.Count())
 607   {
 608     // Nothing to do.
 609     return;
 610   }
 611
 612   DALI_TRACE_SCOPE(gTraceFilter, "DALI_TEXT_MODIFY_EVENTS");
 613
 614   for(Vector<ModifyEvent>::ConstIterator it    = events.Begin(),
 615                                          endIt = events.End();
 616       it != endIt;
 617       ++it)
 618   {
 619     const ModifyEvent& event = *it;
 620
 621     if(ModifyEvent::TEXT_REPLACED == event.type)
 622     {
 623       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
 624       DALI_ASSERT_DEBUG(it == events.Begin() && "Unexpected TEXT_REPLACED event");
 625
 626       TextReplacedEvent(controller);
 627     }
 628     else if(ModifyEvent::TEXT_INSERTED == event.type)
 629     {
 630       TextInsertedEvent(controller);
 631     }
 632     else if(ModifyEvent::TEXT_DELETED == event.type)
 633     {
 634       // Placeholder-text cannot be deleted
 635       if(!controller.mImpl->IsShowingPlaceholderText())
 636       {
 637         TextDeletedEvent(controller);
 638       }
 639     }
 640   }
 641
 642   if(NULL != controller.mImpl->mEventData)
 643   {
 644     uint32_t oldStart, oldEnd;
 645     oldStart = controller.mImpl->mEventData->mLeftSelectionPosition;
 646     oldEnd   = controller.mImpl->mEventData->mRightSelectionPosition;
 647
 648     // When the text is being modified, delay cursor blinking
 649     controller.mImpl->mEventData->mDecorator->DelayCursorBlink();
 650
 651     // Update selection position after modifying the text
 652     controller.mImpl->mEventData->mLeftSelectionPosition  = controller.mImpl->mEventData->mPrimaryCursorPosition;
 653     controller.mImpl->mEventData->mRightSelectionPosition = controller.mImpl->mEventData->mPrimaryCursorPosition;
 654
 655     if(controller.mImpl->mSelectableControlInterface != nullptr && controller.mImpl->mEventData->mState == EventData::SELECTING)
 656     {
 657       controller.mImpl->mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, controller.mImpl->mEventData->mLeftSelectionPosition, controller.mImpl->mEventData->mRightSelectionPosition);
 658     }
 659   }
 660
 661   // DISCARD temporary text
 662   events.Clear();
 663 }
 664
 665 void Controller::EventHandler::TextReplacedEvent(Controller& controller)
 666 {
 667   // The natural size needs to be re-calculated.
 668   controller.mImpl->mRecalculateNaturalSize = true;
 669
 670   // The text direction needs to be updated.
 671   controller.mImpl->mUpdateTextDirection = true;
 672
 673   // Apply modifications to the model
 674   controller.mImpl->mOperationsPending = ALL_OPERATIONS;
 675 }
 676
 677 void Controller::EventHandler::TextInsertedEvent(Controller& controller)
 678 {
 679   DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextInsertedEvent");
 680
 681   if(NULL == controller.mImpl->mEventData)
 682   {
 683     return;
 684   }
 685
 686   controller.mImpl->mEventData->mCheckScrollAmount = true;
 687
 688   // The natural size needs to be re-calculated.
 689   controller.mImpl->mRecalculateNaturalSize = true;
 690
 691   // The text direction needs to be updated.
 692   controller.mImpl->mUpdateTextDirection = true;
 693
 694   // Apply modifications to the model; TODO - Optimize this
 695   controller.mImpl->mOperationsPending = ALL_OPERATIONS;
 696 }
 697
 698 void Controller::EventHandler::TextDeletedEvent(Controller& controller)
 699 {
 700   DALI_ASSERT_DEBUG(NULL != controller.mImpl->mEventData && "Unexpected TextDeletedEvent");
 701
 702   if(NULL == controller.mImpl->mEventData)
 703   {
 704     return;
 705   }
 706
 707   if(!controller.IsEditable()) return;
 708
 709   controller.mImpl->mEventData->mCheckScrollAmount = true;
 710
 711   // The natural size needs to be re-calculated.
 712   controller.mImpl->mRecalculateNaturalSize = true;
 713
 714   // The text direction needs to be updated.
 715   controller.mImpl->mUpdateTextDirection = true;
 716
 717   // Apply modifications to the model; TODO - Optimize this
 718   controller.mImpl->mOperationsPending = ALL_OPERATIONS;
 719 }
 720
 721 bool Controller::EventHandler::DeleteEvent(Controller& controller, int keyCode)
 722 {
 723   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Controller::KeyEvent %p KeyCode : %d \n", &controller, keyCode);
 724
 725   bool removed = false;
 726
 727   if(NULL == controller.mImpl->mEventData)
 728   {
 729     return removed;
 730   }
 731
 732   if(!controller.IsEditable()) return false;
 733
 734   // InputMethodContext is no longer handling key-events
 735   controller.mImpl->ClearPreEditFlag();
 736
 737   if(EventData::SELECTING == controller.mImpl->mEventData->mState)
 738   {
 739     removed = TextUpdater::RemoveSelectedText(controller);
 740   }
 741   else if((controller.mImpl->mEventData->mPrimaryCursorPosition > 0) && (keyCode == Dali::DALI_KEY_BACKSPACE))
 742   {
 743     // Remove the character before the current cursor position
 744     removed = TextUpdater::RemoveText(controller, -1, 1, UPDATE_INPUT_STYLE);
 745   }
 746   else if((controller.mImpl->mEventData->mPrimaryCursorPosition < controller.mImpl->mModel->mLogicalModel->mText.Count()) &&
 747           (keyCode == Dali::DevelKey::DALI_KEY_DELETE))
 748   {
 749     // Remove the character after the current cursor position
 750     removed = TextUpdater::RemoveText(controller, 0, 1, UPDATE_INPUT_STYLE);
 751   }
 752
 753   if(removed)
 754   {
 755     if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
 756        !controller.mImpl->IsPlaceholderAvailable())
 757     {
 758       controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
 759     }
 760     else
 761     {
 762       PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
 763     }
 764     controller.mImpl->mEventData->mUpdateCursorPosition = true;
 765     controller.mImpl->mEventData->mScrollAfterDelete    = true;
 766   }
 767
 768   return removed;
 769 }
 770
 771 InputMethodContext::CallbackData Controller::EventHandler::OnInputMethodContextEvent(Controller& controller, InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 772 {
 773   // Whether the text needs to be relaid-out.
 774   bool requestRelayout = false;
 775
 776   // Whether to retrieve the text and cursor position to be sent to the InputMethodContext.
 777   bool retrieveText   = false;
 778   bool retrieveCursor = false;
 779
 780   switch(inputMethodContextEvent.eventName)
 781   {
 782     case InputMethodContext::COMMIT:
 783     {
 784       TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::COMMIT);
 785       requestRelayout = true;
 786       retrieveCursor  = true;
 787       break;
 788     }
 789     case InputMethodContext::PRE_EDIT:
 790     {
 791       TextUpdater::InsertText(controller, inputMethodContextEvent.predictiveString, Text::Controller::PRE_EDIT);
 792       requestRelayout = true;
 793       retrieveCursor  = true;
 794       break;
 795     }
 796     case InputMethodContext::DELETE_SURROUNDING:
 797     {
 798       const bool textDeleted = TextUpdater::RemoveText(controller,
 799                                                        inputMethodContextEvent.cursorOffset,
 800                                                        inputMethodContextEvent.numberOfChars,
 801                                                        DONT_UPDATE_INPUT_STYLE);
 802
 803       if(textDeleted)
 804       {
 805         if((0u != controller.mImpl->mModel->mLogicalModel->mText.Count()) ||
 806            !controller.mImpl->IsPlaceholderAvailable())
 807         {
 808           controller.mImpl->QueueModifyEvent(ModifyEvent::TEXT_DELETED);
 809         }
 810         else
 811         {
 812           PlaceholderHandler::ShowPlaceholderText(*controller.mImpl);
 813         }
 814         controller.mImpl->mEventData->mUpdateCursorPosition = true;
 815         controller.mImpl->mEventData->mScrollAfterDelete    = true;
 816
 817         requestRelayout = true;
 818       }
 819       break;
 820     }
 821     case InputMethodContext::GET_SURROUNDING:
 822     {
 823       retrieveText   = true;
 824       retrieveCursor = true;
 825       break;
 826     }
 827     case InputMethodContext::PRIVATE_COMMAND:
 828     {
 829       // PRIVATECOMMAND event is just for getting the private command message
 830       retrieveText   = true;
 831       retrieveCursor = true;
 832       break;
 833     }
 834     case InputMethodContext::SELECTION_SET:
 835     {
 836       uint32_t start = static_cast<uint32_t>(inputMethodContextEvent.startIndex);
 837       uint32_t end   = static_cast<uint32_t>(inputMethodContextEvent.endIndex);
 838       if(start == end)
 839       {
 840         controller.SetPrimaryCursorPosition(start, true);
 841       }
 842       else
 843       {
 844         controller.SelectText(start, end);
 845       }
 846
 847       break;
 848     }
 849     case InputMethodContext::VOID:
 850     {
 851       // do nothing
 852       break;
 853     }
 854   } // end switch
 855
 856   if(requestRelayout)
 857   {
 858     controller.mImpl->mOperationsPending = ALL_OPERATIONS;
 859     controller.mImpl->RequestRelayout();
 860   }
 861
 862   std::string    text;
 863   CharacterIndex cursorPosition      = 0u;
 864
 865   if(retrieveCursor)
 866   {
 867     cursorPosition = controller.mImpl->GetLogicalCursorPosition();
 868   }
 869
 870   if(retrieveText)
 871   {
 872     if(!controller.mImpl->IsShowingPlaceholderText())
 873     {
 874       // Retrieves the normal text string.
 875       controller.mImpl->GetText(0u, text);
 876     }
 877     else
 878     {
 879       // When the current text is Placeholder Text, the surrounding text should be empty string.
 880       // It means DALi should send empty string ("") to IME.
 881       text = "";
 882     }
 883   }
 884
 885   InputMethodContext::CallbackData callbackData((retrieveText || retrieveCursor), cursorPosition, text, false);
 886
 887   if(requestRelayout &&
 888      (NULL != controller.mImpl->mEditableControlInterface))
 889   {
 890     // Do this last since it provides callbacks into application code
 891     controller.mImpl->mEditableControlInterface->TextChanged(false);
 892   }
 893
 894   return callbackData;
 895 }
 896
 897 void Controller::EventHandler::PasteClipboardItemEvent(Controller& controller, const std::string& text)
 898 {
 899   // Commit the current pre-edit text; the contents of the clipboard should be appended
 900   controller.mImpl->ResetInputMethodContext();
 901
 902   // Temporary disable hiding clipboard
 903   controller.mImpl->SetClipboardHideEnable(false);
 904
 905   // Paste
 906   TextUpdater::PasteText(controller, text);
 907
 908   controller.mImpl->SetClipboardHideEnable(true);
 909 }
 910
 911 void Controller::EventHandler::DecorationEvent(Controller& controller, HandleType handleType, HandleState state, float x, float y)
 912 {
 913   DALI_ASSERT_DEBUG(controller.mImpl->mEventData && "Unexpected DecorationEvent");
 914
 915   if(NULL != controller.mImpl->mEventData)
 916   {
 917     switch(handleType)
 918     {
 919       case GRAB_HANDLE:
 920       {
 921         Event event(Event::GRAB_HANDLE_EVENT);
 922         event.p1.mUint  = state;
 923         event.p2.mFloat = x;
 924         event.p3.mFloat = y;
 925
 926         controller.mImpl->mEventData->mEventQueue.push_back(event);
 927         break;
 928       }
 929       case LEFT_SELECTION_HANDLE:
 930       {
 931         Event event(Event::LEFT_SELECTION_HANDLE_EVENT);
 932         event.p1.mUint  = state;
 933         event.p2.mFloat = x;
 934         event.p3.mFloat = y;
 935
 936         controller.mImpl->mEventData->mEventQueue.push_back(event);
 937         break;
 938       }
 939       case RIGHT_SELECTION_HANDLE:
 940       {
 941         Event event(Event::RIGHT_SELECTION_HANDLE_EVENT);
 942         event.p1.mUint  = state;
 943         event.p2.mFloat = x;
 944         event.p3.mFloat = y;
 945
 946         controller.mImpl->mEventData->mEventQueue.push_back(event);
 947         break;
 948       }
 949       case LEFT_SELECTION_HANDLE_MARKER:
 950       case RIGHT_SELECTION_HANDLE_MARKER:
 951       {
 952         // Markers do not move the handles.
 953         break;
 954       }
 955       case HANDLE_TYPE_COUNT:
 956       {
 957         DALI_ASSERT_DEBUG(!"Controller::HandleEvent. Unexpected handle type");
 958       }
 959     }
 960
 961     controller.mImpl->RequestRelayout();
 962   }
 963 }
 964
 965 void Controller::EventHandler::TextPopupButtonTouched(Controller& controller, Dali::Toolkit::TextSelectionPopup::Buttons button)
 966 {
 967   if(NULL == controller.mImpl->mEventData)
 968   {
 969     return;
 970   }
 971
 972   switch(button)
 973   {
 974     case Toolkit::TextSelectionPopup::CUT:
 975     {
 976       controller.CutText();
 977       break;
 978     }
 979     case Toolkit::TextSelectionPopup::COPY:
 980     {
 981       controller.CopyText();
 982       break;
 983     }
 984     case Toolkit::TextSelectionPopup::PASTE:
 985     {
 986       controller.PasteText();
 987       break;
 988     }
 989     case Toolkit::TextSelectionPopup::SELECT:
 990     {
 991       const Vector2& currentCursorPosition = controller.mImpl->mEventData->mDecorator->GetPosition(PRIMARY_CURSOR);
 992
 993       if(controller.mImpl->mEventData->mSelectionEnabled)
 994       {
 995         // Creates a SELECT event.
 996         SelectEvent(controller, currentCursorPosition.x, currentCursorPosition.y, SelectionType::INTERACTIVE);
 997       }
 998       break;
 999     }
1000     case Toolkit::TextSelectionPopup::SELECT_ALL:
1001     {
1002       // Creates a SELECT_ALL event
1003       SelectEvent(controller, 0.f, 0.f, SelectionType::ALL);
1004       break;
1005     }
1006     case Toolkit::TextSelectionPopup::CLIPBOARD:
1007     {
1008       controller.mImpl->ShowClipboard();
1009       break;
1010     }
1011     case Toolkit::TextSelectionPopup::NONE:
1012     {
1013       // Nothing to do.
1014       break;
1015     }
1016   }
1017 }
1018
1019 } // namespace Text
1020
1021 } // namespace Toolkit
1022
1023 } // namespace Dali