dali-toolkit/internal/controls/text-controls/text-editor-impl.cpp

   1 /*
   2  * Copyright (c) 2024 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/controls/text-controls/text-editor-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/actors/actor-devel.h>
  23 #include <dali/devel-api/common/stage.h>
  24 #include <dali/devel-api/object/property-helper-devel.h>
  25 #include <dali/integration-api/adaptor-framework/adaptor.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/public-api/actors/layer.h>
  28 #include <dali/public-api/adaptor-framework/key.h>
  29 #include <dali/public-api/common/dali-common.h>
  30 #include <dali/public-api/math/math-utils.h>
  31 #include <dali/public-api/object/type-registry-helper.h>
  32 #include <cstring>
  33 #include <limits>
  34
  35 // INTERNAL INCLUDES
  36 #include <dali-toolkit/devel-api/controls/control-devel.h>
  37 #include <dali-toolkit/devel-api/text/rendering-backend.h>
  38 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  39 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  40 #include <dali-toolkit/internal/controls/text-controls/text-editor-property-handler.h>
  41 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
  42 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  43 #include <dali-toolkit/internal/text/rendering/text-backend.h>
  44 #include <dali-toolkit/internal/text/text-effects-style.h>
  45 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
  46 #include <dali-toolkit/internal/text/text-font-style.h>
  47 #include <dali-toolkit/internal/text/text-view.h>
  48 #include <dali-toolkit/public-api/text/text-enumerations.h>
  49 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
  50 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  51
  52 using namespace Dali::Toolkit::Text;
  53
  54 #if defined(DEBUG_ENABLED)
  55 Debug::Filter* gTextEditorLogFilter = Debug::Filter::New(Debug::Concise, true, "LOG_TEXT_CONTROLS");
  56 #endif
  57
  58 namespace Dali
  59 {
  60 namespace Toolkit
  61 {
  62 namespace Internal
  63 {
  64 namespace // unnamed namespace
  65 {
  66 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
  67 const float        DEFAULT_SCROLL_SPEED      = 1200.f; ///< The default scroll speed for the text editor in pixels/second.
  68 } // unnamed namespace
  69
  70 namespace
  71 {
  72 const char* const SCROLL_BAR_POSITION("sourcePosition");
  73 const char* const SCROLL_BAR_POSITION_MIN("sourcePositionMin");
  74 const char* const SCROLL_BAR_POSITION_MAX("sourcePositionMax");
  75 const char* const SCROLL_BAR_CONTENT_SIZE("sourceContentSize");
  76
  77 // Type registration
  78 BaseHandle Create()
  79 {
  80   return Toolkit::TextEditor::New();
  81 }
  82
  83 // clang-format off
  84 // Setup properties, signals and actions using the type-registry.
  85 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextEditor, Toolkit::Control, Create);
  86
  87 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "text",                                 STRING,    TEXT                                )
  88 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "textColor",                            VECTOR4,   TEXT_COLOR                          )
  89 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "fontFamily",                           STRING,    FONT_FAMILY                         )
  90 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "fontStyle",                            MAP,       FONT_STYLE                          )
  91 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "pointSize",                            FLOAT,     POINT_SIZE                          )
  92 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "horizontalAlignment",                  STRING,    HORIZONTAL_ALIGNMENT                )
  93 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollThreshold",                      FLOAT,     SCROLL_THRESHOLD                    )
  94 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollSpeed",                          FLOAT,     SCROLL_SPEED                        )
  95 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "primaryCursorColor",                   VECTOR4,   PRIMARY_CURSOR_COLOR                )
  96 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "secondaryCursorColor",                 VECTOR4,   SECONDARY_CURSOR_COLOR              )
  97 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableCursorBlink",                    BOOLEAN,   ENABLE_CURSOR_BLINK                 )
  98 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorBlinkInterval",                  FLOAT,     CURSOR_BLINK_INTERVAL               )
  99 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorBlinkDuration",                  FLOAT,     CURSOR_BLINK_DURATION               )
 100 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorWidth",                          INTEGER,   CURSOR_WIDTH                        )
 101 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "grabHandleImage",                      STRING,    GRAB_HANDLE_IMAGE                   )
 102 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "grabHandlePressedImage",               STRING,    GRAB_HANDLE_PRESSED_IMAGE           )
 103 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleImageLeft",             MAP,       SELECTION_HANDLE_IMAGE_LEFT         )
 104 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleImageRight",            MAP,       SELECTION_HANDLE_IMAGE_RIGHT        )
 105 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandlePressedImageLeft",      MAP,       SELECTION_HANDLE_PRESSED_IMAGE_LEFT )
 106 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandlePressedImageRight",     MAP,       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT)
 107 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleMarkerImageLeft",       MAP,       SELECTION_HANDLE_MARKER_IMAGE_LEFT  )
 108 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleMarkerImageRight",      MAP,       SELECTION_HANDLE_MARKER_IMAGE_RIGHT )
 109 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHighlightColor",              VECTOR4,   SELECTION_HIGHLIGHT_COLOR           )
 110 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "decorationBoundingBox",                RECTANGLE, DECORATION_BOUNDING_BOX             )
 111 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableMarkup",                         BOOLEAN,   ENABLE_MARKUP                       )
 112 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputColor",                           VECTOR4,   INPUT_COLOR                         )
 113 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputFontFamily",                      STRING,    INPUT_FONT_FAMILY                   )
 114 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputFontStyle",                       MAP,       INPUT_FONT_STYLE                    )
 115 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputPointSize",                       FLOAT,     INPUT_POINT_SIZE                    )
 116 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "lineSpacing",                          FLOAT,     LINE_SPACING                        )
 117 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputLineSpacing",                     FLOAT,     INPUT_LINE_SPACING                  )
 118 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "underline",                            MAP,       UNDERLINE                           )
 119 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputUnderline",                       MAP,       INPUT_UNDERLINE                     )
 120 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "shadow",                               MAP,       SHADOW                              )
 121 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputShadow",                          MAP,       INPUT_SHADOW                        )
 122 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "emboss",                               MAP,       EMBOSS                              )
 123 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputEmboss",                          MAP,       INPUT_EMBOSS                        )
 124 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "outline",                              MAP,       OUTLINE                             )
 125 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputOutline",                         MAP,       INPUT_OUTLINE                       )
 126 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "smoothScroll",                         BOOLEAN,   SMOOTH_SCROLL                       )
 127 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "smoothScrollDuration",                 FLOAT,     SMOOTH_SCROLL_DURATION              )
 128 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableScrollBar",                      BOOLEAN,   ENABLE_SCROLL_BAR                   )
 129 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollBarShowDuration",                FLOAT,     SCROLL_BAR_SHOW_DURATION            )
 130 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollBarFadeDuration",                FLOAT,     SCROLL_BAR_FADE_DURATION            )
 131 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "pixelSize",                            FLOAT,     PIXEL_SIZE                          )
 132 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit,       TextEditor, "lineCount",                            INTEGER,   LINE_COUNT                          )
 133 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableSelection",                      BOOLEAN,   ENABLE_SELECTION                    )
 134 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "placeholder",                          MAP,       PLACEHOLDER                         )
 135 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "lineWrapMode",                         INTEGER,   LINE_WRAP_MODE                      )
 136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "placeholderText",                      STRING,    PLACEHOLDER_TEXT                    )
 137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "placeholderTextColor",                 VECTOR4,   PLACEHOLDER_TEXT_COLOR              )
 138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableShiftSelection",                 BOOLEAN,   ENABLE_SHIFT_SELECTION              )
 139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableGrabHandle",                     BOOLEAN,   ENABLE_GRAB_HANDLE                  )
 140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "matchSystemLanguageDirection",         BOOLEAN,   MATCH_SYSTEM_LANGUAGE_DIRECTION     )
 141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "renderingBackend",                     INTEGER,   RENDERING_BACKEND                   )
 142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "maxLength",                            INTEGER,   MAX_LENGTH                          )
 143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectedTextStart",                    INTEGER,   SELECTED_TEXT_START                 )
 144 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectedTextEnd",                      INTEGER,   SELECTED_TEXT_END                   )
 145 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "horizontalScrollPosition",             FLOAT,     HORIZONTAL_SCROLL_POSITION          )
 146 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "verticalScrollPosition",               INTEGER,   VERTICAL_SCROLL_POSITION            )
 147 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableEditing",                        BOOLEAN,   ENABLE_EDITING                      )
 148 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextEditor, "selectedText",                         STRING,    SELECTED_TEXT                       )
 149 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "fontSizeScale",                        FLOAT,     FONT_SIZE_SCALE                     )
 150 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableFontSizeScale",                  BOOLEAN,   ENABLE_FONT_SIZE_SCALE              )
 151 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "primaryCursorPosition",                INTEGER,   PRIMARY_CURSOR_POSITION             )
 152 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "grabHandleColor",                      VECTOR4,   GRAB_HANDLE_COLOR                   )
 153 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableGrabHandlePopup",                BOOLEAN,   ENABLE_GRAB_HANDLE_POPUP            )
 154 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputMethodSettings",                  MAP,       INPUT_METHOD_SETTINGS               )
 155 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputFilter",                          MAP,       INPUT_FILTER                        )
 156 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "ellipsis",                             BOOLEAN,   ELLIPSIS                            )
 157 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "ellipsisPosition",                     INTEGER,   ELLIPSIS_POSITION                   )
 158 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "minLineSize",                          FLOAT,     MIN_LINE_SIZE                       )
 159 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "strikethrough",                        MAP,       STRIKETHROUGH                       )
 160 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputStrikethrough",                   MAP,       INPUT_STRIKETHROUGH                 )
 161 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "characterSpacing",                     FLOAT,     CHARACTER_SPACING                   )
 162 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "relativeLineSize",                     FLOAT,     RELATIVE_LINE_SIZE                  )
 163 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "verticalAlignment",                    STRING,    VERTICAL_ALIGNMENT                  )
 164 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectionPopupStyle",                  MAP,       SELECTION_POPUP_STYLE               )
 165 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "removeFrontInset",                     BOOLEAN,   REMOVE_FRONT_INSET                  )
 166 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "removeBackInset",                      BOOLEAN,   REMOVE_BACK_INSET                   )
 167
 168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged",           SIGNAL_TEXT_CHANGED           )
 169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged",     SIGNAL_INPUT_STYLE_CHANGED    )
 170 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached",      SIGNAL_MAX_LENGTH_REACHED     )
 171 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked",         SIGNAL_ANCHOR_CLICKED         )
 172 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered",         SIGNAL_INPUT_FILTERED         )
 173 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
 174 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged",      SIGNAL_SELECTION_CHANGED      )
 175 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared",      SIGNAL_SELECTION_CLEARED      )
 176 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionStarted",      SIGNAL_SELECTION_STARTED      )
 177
 178 DALI_TYPE_REGISTRATION_END()
 179 // clang-format on
 180
 181 Toolkit::TextEditor::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
 182 {
 183   Toolkit::TextEditor::InputStyle::Mask editorInputStyleMask = Toolkit::TextEditor::InputStyle::NONE;
 184
 185   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
 186   {
 187     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::COLOR);
 188   }
 189   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
 190   {
 191     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_FAMILY);
 192   }
 193   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
 194   {
 195     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::POINT_SIZE);
 196   }
 197   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
 198   {
 199     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 200   }
 201   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
 202   {
 203     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 204   }
 205   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
 206   {
 207     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 208   }
 209   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_LINE_SPACING))
 210   {
 211     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::LINE_SPACING);
 212   }
 213   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
 214   {
 215     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::UNDERLINE);
 216   }
 217   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
 218   {
 219     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::SHADOW);
 220   }
 221   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
 222   {
 223     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::EMBOSS);
 224   }
 225   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
 226   {
 227     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::OUTLINE);
 228   }
 229   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_STRIKETHROUGH))
 230   {
 231     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::STRIKETHROUGH);
 232   }
 233
 234   return editorInputStyleMask;
 235 }
 236
 237 } // namespace
 238
 239 Toolkit::TextEditor TextEditor::New(ControlBehaviour additionalBehaviour)
 240 {
 241   // Create the implementation, temporarily owned by this handle on stack
 242   IntrusivePtr<TextEditor> impl = new TextEditor(additionalBehaviour);
 243
 244   // Pass ownership to CustomActor handle
 245   Toolkit::TextEditor handle(*impl);
 246
 247   // Second-phase init of the implementation
 248   // This can only be done after the CustomActor connection has been made...
 249   impl->Initialize();
 250
 251   return handle;
 252 }
 253
 254 void TextEditor::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
 255 {
 256   Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
 257
 258   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor SetProperty\n");
 259
 260   if(textEditor)
 261   {
 262     PropertyHandler::SetProperty(textEditor, index, value);
 263   }
 264 }
 265
 266 Property::Value TextEditor::GetProperty(BaseObject* object, Property::Index index)
 267 {
 268   Property::Value value;
 269
 270   Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
 271
 272   if(textEditor)
 273   {
 274     value = PropertyHandler::GetProperty(textEditor, index);
 275   }
 276   return value;
 277 }
 278
 279 void TextEditor::SelectWholeText()
 280 {
 281   if(mController && mController->IsShowingRealText())
 282   {
 283     mController->SelectWholeText();
 284     SetKeyInputFocus();
 285   }
 286 }
 287
 288 void TextEditor::SelectNone()
 289 {
 290   if(mController && mController->IsShowingRealText())
 291   {
 292     mController->SelectNone();
 293   }
 294 }
 295
 296 void TextEditor::SelectText(const uint32_t start, const uint32_t end)
 297 {
 298   if(mController && mController->IsShowingRealText())
 299   {
 300     mController->SelectText(start, end);
 301     SetKeyInputFocus();
 302   }
 303 }
 304
 305 string TextEditor::CopyText()
 306 {
 307   string copiedText = "";
 308   if(mController && mController->IsShowingRealText())
 309   {
 310     copiedText = mController->CopyText();
 311   }
 312   return copiedText;
 313 }
 314
 315 string TextEditor::CutText()
 316 {
 317   string cutText = "";
 318   if(mController && mController->IsShowingRealText())
 319   {
 320     cutText = mController->CutText();
 321   }
 322   return cutText;
 323 }
 324
 325 void TextEditor::PasteText()
 326 {
 327   if(mController)
 328   {
 329     SetKeyInputFocus(); //Giving focus to the editor that was passed to the PasteText in case the passed editor (current editor) doesn't have focus.
 330     mController->PasteText();
 331   }
 332 }
 333
 334 void TextEditor::ScrollBy(Vector2 scroll)
 335 {
 336   if(mController && mController->IsShowingRealText())
 337   {
 338     mController->ScrollBy(scroll);
 339   }
 340 }
 341
 342 float TextEditor::GetHorizontalScrollPosition()
 343 {
 344   if(mController && mController->IsShowingRealText())
 345   {
 346     return mController->GetHorizontalScrollPosition();
 347   }
 348   return 0;
 349 }
 350
 351 float TextEditor::GetVerticalScrollPosition()
 352 {
 353   if(mController && mController->IsShowingRealText())
 354   {
 355     return mController->GetVerticalScrollPosition();
 356   }
 357   return 0;
 358 }
 359
 360 Vector<Vector2> TextEditor::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
 361 {
 362   return mController->GetTextSize(startIndex, endIndex);
 363 }
 364
 365 Vector<Vector2> TextEditor::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
 366 {
 367   return mController->GetTextPosition(startIndex, endIndex);
 368 }
 369
 370 Rect<float> TextEditor::GetLineBoundingRectangle(const uint32_t lineIndex) const
 371 {
 372   return mController->GetLineBoundingRectangle(lineIndex);
 373 }
 374
 375 Rect<float> TextEditor::GetCharacterBoundingRectangle(const uint32_t charIndex) const
 376 {
 377   return mController->GetCharacterBoundingRectangle(charIndex);
 378 }
 379
 380 int TextEditor::GetCharacterIndexAtPosition(float visualX, float visualY) const
 381 {
 382   return mController->GetCharacterIndexAtPosition(visualX, visualY);
 383 }
 384
 385 Rect<> TextEditor::GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const
 386 {
 387   return mController->GetTextBoundingRectangle(startIndex, endIndex);
 388 }
 389
 390 void TextEditor::SetSpannedText(const Text::Spanned& spannedText)
 391 {
 392   mController->SetSpannedText(spannedText);
 393 }
 394
 395 string TextEditor::GetSelectedText() const
 396 {
 397   string selectedText = "";
 398   if(mController && mController->IsShowingRealText())
 399   {
 400     selectedText = mController->GetSelectedText();
 401   }
 402   return selectedText;
 403 }
 404
 405 InputMethodContext TextEditor::GetInputMethodContext()
 406 {
 407   return mInputMethodContext;
 408 }
 409
 410 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
 411 {
 412   return mMaxLengthReachedSignal;
 413 }
 414
 415 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
 416 {
 417   return mAnchorClickedSignal;
 418 }
 419
 420 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
 421 {
 422   return mCursorPositionChangedSignal;
 423 }
 424
 425 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
 426 {
 427   return mInputFilteredSignal;
 428 }
 429
 430 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
 431 {
 432   return mSelectionChangedSignal;
 433 }
 434
 435 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
 436 {
 437   return mSelectionClearedSignal;
 438 }
 439
 440 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
 441 {
 442   return mSelectionStartedSignal;
 443 }
 444
 445 Text::ControllerPtr TextEditor::GetTextController()
 446 {
 447   return mController;
 448 }
 449
 450 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
 451 {
 452   Dali::BaseHandle handle(object);
 453
 454   bool                connected(true);
 455   Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
 456
 457   if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
 458   {
 459     editor.TextChangedSignal().Connect(tracker, functor);
 460   }
 461   else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
 462   {
 463     editor.InputStyleChangedSignal().Connect(tracker, functor);
 464   }
 465   else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
 466   {
 467     if(editor)
 468     {
 469       Internal::TextEditor& editorImpl(GetImpl(editor));
 470       editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
 471     }
 472   }
 473   else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
 474   {
 475     if(editor)
 476     {
 477       Internal::TextEditor& editorImpl(GetImpl(editor));
 478       editorImpl.AnchorClickedSignal().Connect(tracker, functor);
 479     }
 480   }
 481   else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
 482   {
 483     if(editor)
 484     {
 485       Internal::TextEditor& editorImpl(GetImpl(editor));
 486       editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
 487     }
 488   }
 489   else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
 490   {
 491     if(editor)
 492     {
 493       Internal::TextEditor& editorImpl(GetImpl(editor));
 494       editorImpl.InputFilteredSignal().Connect(tracker, functor);
 495     }
 496   }
 497   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
 498   {
 499     if(editor)
 500     {
 501       Internal::TextEditor& editorImpl(GetImpl(editor));
 502       editorImpl.SelectionChangedSignal().Connect(tracker, functor);
 503     }
 504   }
 505   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
 506   {
 507     if(editor)
 508     {
 509       Internal::TextEditor& editorImpl(GetImpl(editor));
 510       editorImpl.SelectionClearedSignal().Connect(tracker, functor);
 511     }
 512   }
 513   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
 514   {
 515     if(editor)
 516     {
 517       Internal::TextEditor& editorImpl(GetImpl(editor));
 518       editorImpl.SelectionStartedSignal().Connect(tracker, functor);
 519     }
 520   }
 521   else
 522   {
 523     // signalName does not match any signal
 524     connected = false;
 525   }
 526
 527   return connected;
 528 }
 529
 530 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
 531 {
 532   return mTextChangedSignal;
 533 }
 534
 535 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
 536 {
 537   return mInputStyleChangedSignal;
 538 }
 539
 540 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
 541 {
 542   return mScrollStateChangedSignal;
 543 }
 544
 545 void TextEditor::OnAccessibilityStatusChanged()
 546 {
 547   CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
 548 }
 549
 550 void TextEditor::OnInitialize()
 551 {
 552   Actor self = Self();
 553
 554   mController = Text::Controller::New(this, this, this, this);
 555
 556   mDecorator = Text::Decorator::New(*mController,
 557                                     *mController);
 558
 559   mInputMethodContext = InputMethodContext::New(self);
 560
 561   mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
 562
 563   // Enables the text input.
 564   mController->EnableTextInput(mDecorator, mInputMethodContext);
 565
 566   // Enables the vertical scrolling after the text input has been enabled.
 567   mController->SetVerticalScrollEnabled(true);
 568
 569   // Disables the horizontal scrolling.
 570   mController->SetHorizontalScrollEnabled(false);
 571
 572   // Sets the maximum number of characters.
 573   mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
 574
 575   // Enable the smooth handle panning.
 576   mController->SetSmoothHandlePanEnabled(true);
 577
 578   mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
 579   mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
 580
 581   // Sets layoutDirection value
 582   Dali::Stage                 stage           = Dali::Stage::GetCurrent();
 583   Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
 584   mController->SetLayoutDirection(layoutDirection);
 585
 586   self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
 587
 588   // Forward input events to controller
 589   EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
 590   GetTapGestureDetector().SetMaximumTapsRequired(2);
 591   GetTapGestureDetector().ReceiveAllTapEvents(true);
 592
 593   self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
 594
 595   // Set BoundingBox to stage size if not already set.
 596   Rect<int> boundingBox;
 597   mDecorator->GetBoundingBox(boundingBox);
 598
 599   if(boundingBox.IsEmpty())
 600   {
 601     Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
 602     mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
 603   }
 604
 605   // Whether to flip the selection handles as soon as they cross.
 606   mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
 607
 608   // Set the default scroll speed.
 609   mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
 610
 611   // Fill-parent area by default
 612   self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
 613   self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
 614   self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
 615
 616   DevelControl::SetInputMethodContext(*this, mInputMethodContext);
 617
 618   // Creates an extra control to be used as stencil buffer.
 619   mStencil = Control::New();
 620   mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
 621   mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
 622   mStencil.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIDDEN, true);
 623
 624   // Creates a background visual. Even if the color is transparent it updates the stencil.
 625   mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
 626                        Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
 627
 628   // Enable the clipping property.
 629   mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
 630   mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
 631
 632   self.Add(mStencil);
 633
 634   // Accessibility
 635   self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::ENTRY);
 636   self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
 637
 638   Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
 639   Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
 640 }
 641
 642 DevelControl::ControlAccessible* TextEditor::CreateAccessibleObject()
 643 {
 644   return new TextEditorAccessible(Self());
 645 }
 646
 647 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
 648 {
 649   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
 650
 651   switch(change)
 652   {
 653     case StyleChange::DEFAULT_FONT_CHANGE:
 654     {
 655       DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
 656       const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
 657       // Property system did not set the font so should update it.
 658       mController->UpdateAfterFontChange(newFont);
 659       RelayoutRequest();
 660       break;
 661     }
 662
 663     case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
 664     {
 665       GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
 666       RelayoutRequest();
 667       break;
 668     }
 669     case StyleChange::THEME_CHANGE:
 670     {
 671       // Nothing to do, let control base class handle this
 672       break;
 673     }
 674   }
 675
 676   // Up call to Control
 677   Control::OnStyleChange(styleManager, change);
 678 }
 679
 680 Vector3 TextEditor::GetNaturalSize()
 681 {
 682   Extents padding;
 683   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 684
 685   Vector3 naturalSize = mController->GetNaturalSize();
 686   naturalSize.width += (padding.start + padding.end);
 687   naturalSize.height += (padding.top + padding.bottom);
 688
 689   return naturalSize;
 690 }
 691
 692 float TextEditor::GetHeightForWidth(float width)
 693 {
 694   Extents padding;
 695   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 696   return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
 697 }
 698
 699 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
 700 {
 701   if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
 702   {
 703     actor.SetProperty(Actor::Property::SIZE, size);
 704   }
 705 }
 706
 707 void TextEditor::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
 708 {
 709   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnPropertySet index[%d]\n", index);
 710
 711   switch(index)
 712   {
 713     case DevelActor::Property::USER_INTERACTION_ENABLED:
 714     {
 715       const bool enabled = propertyValue.Get<bool>();
 716       mController->SetUserInteractionEnabled(enabled);
 717       if(mStencil)
 718       {
 719         float opacity = enabled ? 1.0f : mController->GetDisabledColorOpacity();
 720         mStencil.SetProperty(Actor::Property::OPACITY, opacity);
 721       }
 722       break;
 723     }
 724     default:
 725     {
 726       Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
 727       break;
 728     }
 729   }
 730 }
 731
 732 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
 733 {
 734   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
 735
 736   Actor self = Self();
 737
 738   Extents padding;
 739   padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 740
 741   Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
 742
 743   // Support Right-To-Left of padding
 744   Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
 745
 746   if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
 747   {
 748     std::swap(padding.start, padding.end);
 749   }
 750
 751   if(mStencil)
 752   {
 753     mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
 754     ResizeActor(mStencil, contentSize);
 755   }
 756   if(mActiveLayer)
 757   {
 758     mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
 759     ResizeActor(mActiveLayer, contentSize);
 760   }
 761   if(mCursorLayer)
 762   {
 763     // The cursor layer is added to the stencil in RenderText.
 764     // Do not calculate the position because the stencil has already been resized excluding the padding size.
 765     // There is no case where the text editor does not have a stencil.
 766     ResizeActor(mCursorLayer, contentSize);
 767   }
 768
 769   // If there is text changed, callback is called.
 770   if(mTextChanged)
 771   {
 772     EmitTextChangedSignal();
 773   }
 774
 775   const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
 776
 777   if((Text::Controller::NONE_UPDATED != updateTextType) ||
 778      !mRenderer)
 779   {
 780     DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
 781
 782     if(mDecorator &&
 783        (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
 784     {
 785       mDecorator->Relayout(contentSize, container);
 786     }
 787
 788     if(!mRenderer)
 789     {
 790       mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
 791     }
 792
 793     RenderText(updateTextType);
 794   }
 795
 796   if(mCursorPositionChanged)
 797   {
 798     EmitCursorPositionChangedSignal();
 799   }
 800
 801   if(mSelectionStarted)
 802   {
 803     EmitSelectionStartedSignal();
 804   }
 805
 806   if(mSelectionChanged)
 807   {
 808     EmitSelectionChangedSignal();
 809   }
 810
 811   if(mSelectionCleared)
 812   {
 813     EmitSelectionClearedSignal();
 814   }
 815
 816   // The text-editor emits signals when the input style changes. These changes of style are
 817   // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
 818   // can't be emitted during the size negotiation as the callbacks may update the UI.
 819   // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
 820   if(!mController->IsInputStyleChangedSignalsQueueEmpty())
 821   {
 822     mController->RequestProcessInputStyleChangedSignals();
 823   }
 824 }
 825
 826 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
 827 {
 828   CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mCursorLayer, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
 829   if(mRenderableActor)
 830   {
 831     ApplyScrollPosition();
 832   }
 833   UpdateScrollBar();
 834 }
 835
 836 void TextEditor::OnKeyInputFocusGained()
 837 {
 838   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
 839   if(mInputMethodContext && IsEditable())
 840   {
 841     // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
 842     mInputMethodContext.ApplyOptions(mInputMethodOptions);
 843     mInputMethodContext.NotifyTextInputMultiLine(true);
 844
 845     mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
 846
 847     mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
 848
 849     // Notify that the text editing start.
 850     mInputMethodContext.Activate();
 851
 852     // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
 853     mInputMethodContext.SetRestoreAfterFocusLost(true);
 854   }
 855
 856   if(IsEditable() && mController->IsUserInteractionEnabled())
 857   {
 858     mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
 859   }
 860
 861   EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
 862 }
 863
 864 void TextEditor::OnKeyInputFocusLost()
 865 {
 866   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
 867   if(mInputMethodContext)
 868   {
 869     mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
 870
 871     // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
 872     mInputMethodContext.SetRestoreAfterFocusLost(false);
 873
 874     // Notify that the text editing finish.
 875     mInputMethodContext.Deactivate();
 876
 877     mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
 878   }
 879
 880   mController->KeyboardFocusLostEvent();
 881
 882   EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
 883 }
 884
 885 bool TextEditor::OnAccessibilityActivated()
 886 {
 887   SetKeyInputFocus();
 888   return true;
 889 }
 890
 891 void TextEditor::OnTap(const TapGesture& gesture)
 892 {
 893   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
 894   if(mInputMethodContext && IsEditable())
 895   {
 896     mInputMethodContext.Activate();
 897   }
 898   // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
 899   Extents padding;
 900   padding                   = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 901   const Vector2& localPoint = gesture.GetLocalPoint();
 902   mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
 903   mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
 904
 905   Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
 906   if(keyboardFocusManager)
 907   {
 908     keyboardFocusManager.SetCurrentFocusActor(Self());
 909   }
 910   SetKeyInputFocus();
 911 }
 912
 913 void TextEditor::OnPan(const PanGesture& gesture)
 914 {
 915   mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
 916   if(gesture.GetState() == GestureState::STARTED && !mController->IsScrollable(gesture.GetDisplacement()))
 917   {
 918     Dali::DevelActor::SetNeedGesturePropagation(Self(), true);
 919   }
 920 }
 921
 922 void TextEditor::OnLongPress(const LongPressGesture& gesture)
 923 {
 924   if(mInputMethodContext && IsEditable())
 925   {
 926     mInputMethodContext.Activate();
 927   }
 928   Extents padding;
 929   padding                   = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 930   const Vector2& localPoint = gesture.GetLocalPoint();
 931   mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
 932
 933   SetKeyInputFocus();
 934 }
 935
 936 bool TextEditor::OnKeyEvent(const KeyEvent& event)
 937 {
 938   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
 939
 940   if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
 941   {
 942     // Make sure ClearKeyInputFocus when only key is up
 943     if(event.GetState() == KeyEvent::UP)
 944     {
 945       Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
 946       if(keyboardFocusManager)
 947       {
 948         keyboardFocusManager.ClearFocus();
 949       }
 950       ClearKeyInputFocus();
 951     }
 952
 953     return true;
 954   }
 955
 956   return mController->KeyEvent(event);
 957 }
 958
 959 void TextEditor::RequestTextRelayout()
 960 {
 961   RelayoutRequest();
 962 }
 963
 964 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
 965 {
 966   auto accessible = GetAccessibleObject();
 967   if(DALI_LIKELY(accessible) && accessible->IsHighlighted())
 968   {
 969     accessible->EmitTextInserted(position, length, content);
 970   }
 971 }
 972
 973 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
 974 {
 975   auto accessible = GetAccessibleObject();
 976   if(DALI_LIKELY(accessible) && accessible->IsHighlighted())
 977   {
 978     accessible->EmitTextDeleted(position, length, content);
 979   }
 980 }
 981
 982 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
 983 {
 984   auto accessible = GetAccessibleObject();
 985   if(DALI_LIKELY(accessible) && accessible->IsHighlighted())
 986   {
 987     accessible->EmitTextCursorMoved(newPosition);
 988   }
 989
 990   if((oldPosition != newPosition) && !mCursorPositionChanged)
 991   {
 992     mCursorPositionChanged = true;
 993     mOldPosition           = oldPosition;
 994   }
 995 }
 996
 997 void TextEditor::TextChanged(bool immediate)
 998 {
 999   if(immediate) // Emits TextChangedSignal immediately
1000   {
1001     EmitTextChangedSignal();
1002   }
1003   else
1004   {
1005     mTextChanged = true;
1006   }
1007 }
1008
1009 void TextEditor::EmitTextChangedSignal()
1010 {
1011   Dali::Toolkit::TextEditor handle(GetOwner());
1012   mTextChangedSignal.Emit(handle);
1013   mTextChanged = false;
1014 }
1015
1016 void TextEditor::MaxLengthReached()
1017 {
1018   Dali::Toolkit::TextEditor handle(GetOwner());
1019   mMaxLengthReachedSignal.Emit(handle);
1020 }
1021
1022 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
1023 {
1024   Dali::Toolkit::TextEditor handle(GetOwner());
1025   mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
1026 }
1027
1028 void TextEditor::AnchorClicked(const std::string& href)
1029 {
1030   Dali::Toolkit::TextEditor handle(GetOwner());
1031   mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
1032 }
1033
1034 void TextEditor::EmitCursorPositionChangedSignal()
1035 {
1036   Dali::Toolkit::TextEditor handle(GetOwner());
1037   mCursorPositionChanged = false;
1038   mCursorPositionChangedSignal.Emit(handle, mOldPosition);
1039 }
1040
1041 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
1042 {
1043   Dali::Toolkit::TextEditor handle(GetOwner());
1044   mInputFilteredSignal.Emit(handle, type);
1045 }
1046
1047 void TextEditor::EmitSelectionChangedSignal()
1048 {
1049   Dali::Toolkit::TextEditor handle(GetOwner());
1050   mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
1051   mSelectionChanged = false;
1052 }
1053
1054 void TextEditor::EmitSelectionClearedSignal()
1055 {
1056   Dali::Toolkit::TextEditor handle(GetOwner());
1057   mSelectionClearedSignal.Emit(handle);
1058   mSelectionCleared = false;
1059 }
1060
1061 void TextEditor::EmitSelectionStartedSignal()
1062 {
1063   Dali::Toolkit::TextEditor handle(GetOwner());
1064   mSelectionStartedSignal.Emit(handle);
1065   mSelectionStarted = false;
1066 }
1067
1068 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1069 {
1070   if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1071   {
1072     if(newStart == newEnd)
1073     {
1074       mSelectionCleared = true;
1075     }
1076     else
1077     {
1078       if(oldStart == oldEnd)
1079       {
1080         mSelectionStarted = true;
1081       }
1082     }
1083
1084     mSelectionChanged  = true;
1085     mOldSelectionStart = oldStart;
1086     mOldSelectionEnd   = oldEnd;
1087
1088     if(mOldSelectionStart > mOldSelectionEnd)
1089     {
1090       //swap
1091       uint32_t temp      = mOldSelectionStart;
1092       mOldSelectionStart = mOldSelectionEnd;
1093       mOldSelectionEnd   = temp;
1094     }
1095   }
1096 }
1097
1098 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1099 {
1100   if(actor)
1101   {
1102     if(needsClipping)
1103     {
1104       mClippingDecorationActors.push_back(actor);
1105     }
1106
1107     // If the actor is a layer type, add it.
1108     if(type == DecorationType::ACTIVE_LAYER)
1109     {
1110       AddLayer(mActiveLayer, actor);
1111     }
1112     else if(type == DecorationType::CURSOR_LAYER)
1113     {
1114       AddLayer(mCursorLayer, actor);
1115     }
1116   }
1117 }
1118
1119 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1120 {
1121   actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1122   actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1123   Self().Add(actor);
1124   layer = actor;
1125 }
1126
1127 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1128 {
1129   if(mController && mController->IsShowingRealText())
1130   {
1131     mController->SetTextSelectionRange(start, end);
1132     SetKeyInputFocus();
1133   }
1134 }
1135
1136 Uint32Pair TextEditor::GetTextSelectionRange() const
1137 {
1138   Uint32Pair range(0, 0);
1139   if(mController && mController->IsShowingRealText())
1140   {
1141     range = mController->GetTextSelectionRange();
1142   }
1143   return range;
1144 }
1145
1146 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1147 {
1148   Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1149   Property::Map*  resultMap = propValue.GetMap();
1150
1151   Property::Value* colorValue = nullptr;
1152   if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1153   {
1154     colorValue->Get(color);
1155   }
1156 }
1157
1158 void TextEditor::UpdateScrollBar()
1159 {
1160   using namespace Dali;
1161
1162   float scrollPosition;
1163   float controlSize;
1164   float layoutSize;
1165   bool  latestScrolled;
1166
1167   if(!mScrollBarEnabled)
1168   {
1169     return;
1170   }
1171   latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1172   if(!latestScrolled || controlSize > layoutSize)
1173   {
1174     return;
1175   }
1176
1177   CustomActor self = Self();
1178   if(!mScrollBar)
1179   {
1180     mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1181     mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1182     mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1183     mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1184     mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1185     mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1186
1187     // Register the scroll position property
1188     Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1189     // Register the minimum scroll position property
1190     Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1191     // Register the maximum scroll position property
1192     Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1193     // Register the scroll content size property
1194     Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1195
1196     mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1197
1198     // Set style name of ScrollBar for styling
1199     mScrollBar.SetStyleName("TextEditorScrollBar");
1200     Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1201     if(scrollIndicator)
1202     {
1203       // Set style name of ScrollBarIndicator for styling
1204       scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1205     }
1206
1207     self.Add(mScrollBar);
1208   }
1209   else
1210   {
1211     Property::Index propertyScrollPosition    = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1212     Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1213     Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1214
1215     self.SetProperty(propertyScrollPosition, scrollPosition);
1216     self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1217     self.SetProperty(propertyScrollContentSize, layoutSize);
1218   }
1219
1220   // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1221   if(!mScrollStarted)
1222   {
1223     mScrollStarted = true;
1224     Dali::Toolkit::TextEditor handle(GetOwner());
1225     mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1226   }
1227
1228   Actor indicator = mScrollBar.GetScrollIndicator();
1229   if(mAnimation)
1230   {
1231     mAnimation.Stop(); // Cancel any animation
1232   }
1233   else
1234   {
1235     mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1236   }
1237   indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1238   mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1239   mAnimation.Play();
1240   mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1241 }
1242
1243 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1244 {
1245   // If animation is successfully ended, then emit ScrollStateChangedSignal
1246   if(Dali::EqualsZero(animation.GetCurrentProgress()))
1247   {
1248     mScrollStarted = false;
1249     Dali::Toolkit::TextEditor handle(GetOwner());
1250     mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1251   }
1252 }
1253
1254 void TextEditor::OnSceneConnect(Dali::Actor actor)
1255 {
1256   if(mHasBeenStaged)
1257   {
1258     RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1259   }
1260   else
1261   {
1262     mHasBeenStaged = true;
1263   }
1264 }
1265
1266 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1267 {
1268   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1269   return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1270 }
1271
1272 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1273 {
1274   if(mDecorator)
1275   {
1276     Property::Map map;
1277     map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1278
1279     value = map;
1280   }
1281 }
1282
1283 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1284 {
1285   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1286
1287   // Just hide the grab handle when keyboard is hidden.
1288   if(!keyboardShown)
1289   {
1290     mController->KeyboardFocusLostEvent();
1291   }
1292   else
1293   {
1294     mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1295   }
1296 }
1297
1298 void TextEditor::OnSceneConnection(int depth)
1299 {
1300   // Sets the depth to the visuals inside the text's decorator.
1301   mDecorator->SetTextDepth(depth);
1302
1303   // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1304
1305   // Call the Control::OnSceneConnection() to set the depth of the background.
1306   Control::OnSceneConnection(depth);
1307 }
1308
1309 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1310 {
1311   return false;
1312 }
1313
1314 void TextEditor::ApplyScrollPosition()
1315 {
1316   const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1317   float          scrollAmount = 0.0f;
1318
1319   if(mScrollAnimationEnabled)
1320   {
1321     scrollAmount = mController->GetScrollAmountByUserInput();
1322   }
1323   if(mTextVerticalScroller)
1324   {
1325     mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1326   }
1327   else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1328   {
1329     mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1330   }
1331   else
1332   {
1333     mTextVerticalScroller = Text::TextVerticalScroller::New();
1334     if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1335     {
1336       mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1337     }
1338     mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1339   }
1340 }
1341
1342 bool TextEditor::IsEditable() const
1343 {
1344   return mController->IsEditable();
1345 }
1346
1347 void TextEditor::SetEditable(bool editable)
1348 {
1349   mController->SetEditable(editable);
1350   if(mInputMethodContext && !editable)
1351   {
1352     mInputMethodContext.Deactivate();
1353   }
1354 }
1355
1356 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1357 {
1358   mController->ChangedLayoutDirection();
1359 }
1360
1361 void TextEditor::SetRemoveFrontInset(bool remove)
1362 {
1363   mController->SetRemoveFrontInset(remove);
1364 }
1365
1366 bool TextEditor::IsRemoveFrontInset() const
1367 {
1368   return mController->IsRemoveFrontInset();
1369 }
1370
1371 void TextEditor::SetRemoveBackInset(bool remove)
1372 {
1373   mController->SetRemoveBackInset(remove);
1374 }
1375
1376 bool TextEditor::IsRemoveBackInset() const
1377 {
1378   return mController->IsRemoveBackInset();
1379 }
1380
1381 TextEditor::TextEditor(ControlBehaviour additionalBehaviour)
1382 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
1383   mAnimationPeriod(0.0f, 0.0f),
1384   mAlignmentOffset(0.f),
1385   mScrollAnimationDuration(0.f),
1386   mLineSpacing(0.f),
1387   mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1388   mHasBeenStaged(false),
1389   mScrollAnimationEnabled(false),
1390   mScrollBarEnabled(false),
1391   mScrollStarted(false),
1392   mTextChanged(false),
1393   mCursorPositionChanged(false),
1394   mSelectionChanged(false),
1395   mSelectionCleared(false),
1396   mOldPosition(0u),
1397   mOldSelectionStart(0u),
1398   mOldSelectionEnd(0u),
1399   mSelectionStarted(false)
1400 {
1401 }
1402
1403 TextEditor::~TextEditor()
1404 {
1405   UnparentAndReset(mStencil);
1406 }
1407
1408 std::string TextEditor::TextEditorAccessible::GetName() const
1409 {
1410   return GetWholeText();
1411 }
1412
1413 const std::vector<Toolkit::TextAnchor>& TextEditor::TextEditorAccessible::GetTextAnchors() const
1414 {
1415   auto self = Toolkit::TextEditor::DownCast(Self());
1416
1417   return Toolkit::GetImpl(self).mAnchorActors;
1418 }
1419
1420 Toolkit::Text::ControllerPtr TextEditor::TextEditorAccessible::GetTextController() const
1421 {
1422   auto self = Toolkit::TextEditor::DownCast(Self());
1423
1424   return Toolkit::GetImpl(self).GetTextController();
1425 }
1426
1427 void TextEditor::TextEditorAccessible::RequestTextRelayout()
1428 {
1429   auto  self     = Toolkit::TextEditor::DownCast(Self());
1430   auto& selfImpl = Toolkit::GetImpl(self);
1431
1432   selfImpl.RequestTextRelayout();
1433 }
1434
1435 } // namespace Internal
1436
1437 } // namespace Toolkit
1438
1439 } // namespace Dali