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

   1 /*
   2  * Copyright (c) 2016 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/text-controller.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <limits>
  23 #include <memory.h>
  24 #include <dali/public-api/adaptor-framework/key.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/text/bidirectional-support.h>
  30 #include <dali-toolkit/internal/text/character-set-conversion.h>
  31 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
  32 #include <dali-toolkit/internal/text/markup-processor.h>
  33 #include <dali-toolkit/internal/text/text-controller-impl.h>
  34 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  35
  36 namespace
  37 {
  38
  39 #if defined(DEBUG_ENABLED)
  40   Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  41 #endif
  42
  43 const float MAX_FLOAT = std::numeric_limits<float>::max();
  44
  45 const std::string EMPTY_STRING("");
  46
  47 float ConvertToEven( float value )
  48 {
  49   int intValue(static_cast<int>( value ));
  50   return static_cast<float>(intValue % 2 == 0) ? intValue : (intValue + 1);
  51 }
  52
  53 } // namespace
  54
  55 namespace Dali
  56 {
  57
  58 namespace Toolkit
  59 {
  60
  61 namespace Text
  62 {
  63
  64 /**
  65  * @brief Adds a new font description run for the selected text.
  66  *
  67  * The new font parameters are added after the call to this method.
  68  *
  69  * @param[in] eventData The event data pointer.
  70  * @param[in] logicalModel The logical model where to add the new font description run.
  71  * @param[out] startOfSelectedText Index to the first selected character.
  72  * @param[out] lengthOfSelectedText Number of selected characters.
  73  */
  74 FontDescriptionRun& UpdateSelectionFontStyleRun( EventData* eventData,
  75                                                  LogicalModelPtr logicalModel,
  76                                                  CharacterIndex& startOfSelectedText,
  77                                                  Length& lengthOfSelectedText )
  78 {
  79   const bool handlesCrossed = eventData->mLeftSelectionPosition > eventData->mRightSelectionPosition;
  80
  81   // Get start and end position of selection
  82   startOfSelectedText = handlesCrossed ? eventData->mRightSelectionPosition : eventData->mLeftSelectionPosition;
  83   lengthOfSelectedText = ( handlesCrossed ? eventData->mLeftSelectionPosition : eventData->mRightSelectionPosition ) - startOfSelectedText;
  84
  85   // Add the font run.
  86   const VectorBase::SizeType numberOfRuns = logicalModel->mFontDescriptionRuns.Count();
  87   logicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
  88
  89   FontDescriptionRun& fontDescriptionRun = *( logicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
  90
  91   fontDescriptionRun.characterRun.characterIndex = startOfSelectedText;
  92   fontDescriptionRun.characterRun.numberOfCharacters = lengthOfSelectedText;
  93
  94   // Recalculate the selection highlight as the metrics may have changed.
  95   eventData->mUpdateLeftSelectionPosition = true;
  96   eventData->mUpdateRightSelectionPosition = true;
  97   eventData->mUpdateHighlightBox = true;
  98
  99   return fontDescriptionRun;
 100 }
 101
 102 // public : Constructor.
 103
 104 ControllerPtr Controller::New()
 105 {
 106   return ControllerPtr( new Controller() );
 107 }
 108
 109 ControllerPtr Controller::New( ControlInterface* controlInterface )
 110 {
 111   return ControllerPtr( new Controller( controlInterface ) );
 112 }
 113
 114 ControllerPtr Controller::New( ControlInterface* controlInterface,
 115                                EditableControlInterface* editableControlInterface )
 116 {
 117   return ControllerPtr( new Controller( controlInterface,
 118                                         editableControlInterface ) );
 119 }
 120
 121 // public : Configure the text controller.
 122
 123 void Controller::EnableTextInput( DecoratorPtr decorator )
 124 {
 125   if( NULL == mImpl->mEventData )
 126   {
 127     mImpl->mEventData = new EventData( decorator );
 128   }
 129 }
 130
 131 void Controller::SetGlyphType( TextAbstraction::GlyphType glyphType )
 132 {
 133   // Metrics for bitmap & vector based glyphs are different
 134   mImpl->mMetrics->SetGlyphType( glyphType );
 135
 136   // Clear the font-specific data
 137   ClearFontData();
 138
 139   mImpl->RequestRelayout();
 140 }
 141
 142 void Controller::SetMarkupProcessorEnabled( bool enable )
 143 {
 144   mImpl->mMarkupProcessorEnabled = enable;
 145 }
 146
 147 bool Controller::IsMarkupProcessorEnabled() const
 148 {
 149   return mImpl->mMarkupProcessorEnabled;
 150 }
 151
 152 void Controller::SetAutoScrollEnabled( bool enable )
 153 {
 154   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled[%s] SingleBox[%s]-> [%p]\n", (enable)?"true":"false", ( mImpl->mLayoutEngine.GetLayout() == LayoutEngine::SINGLE_LINE_BOX)?"true":"false", this );
 155
 156   if ( mImpl->mLayoutEngine.GetLayout() == LayoutEngine::SINGLE_LINE_BOX )
 157   {
 158     if ( enable )
 159     {
 160       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled for SINGLE_LINE_BOX\n" );
 161       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 162                                                                LAYOUT                    |
 163                                                                ALIGN                     |
 164                                                                UPDATE_LAYOUT_SIZE        |
 165                                                                UPDATE_DIRECTION          |
 166                                                                REORDER );
 167
 168     }
 169     else
 170     {
 171       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled Disabling autoscroll\n");
 172       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 173                                                                LAYOUT                    |
 174                                                                ALIGN                     |
 175                                                                UPDATE_LAYOUT_SIZE        |
 176                                                                REORDER );
 177     }
 178
 179     mImpl->mAutoScrollEnabled = enable;
 180     mImpl->RequestRelayout();
 181   }
 182   else
 183   {
 184     DALI_LOG_WARNING( "Attempted AutoScrolling on a non SINGLE_LINE_BOX, request ignored\n" );
 185     mImpl->mAutoScrollEnabled = false;
 186   }
 187 }
 188
 189 bool Controller::IsAutoScrollEnabled() const
 190 {
 191   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", (mImpl->mAutoScrollEnabled)?"true":"false" );
 192
 193   return mImpl->mAutoScrollEnabled;
 194 }
 195
 196 CharacterDirection Controller::GetAutoScrollDirection() const
 197 {
 198   return mImpl->mAutoScrollDirectionRTL;
 199 }
 200
 201 float Controller::GetAutoScrollLineAlignment() const
 202 {
 203   float offset = 0.f;
 204
 205   if( mImpl->mVisualModel &&
 206       ( 0u != mImpl->mVisualModel->mLines.Count() ) )
 207   {
 208     offset = ( *mImpl->mVisualModel->mLines.Begin() ).alignmentOffset;
 209   }
 210
 211   return offset;
 212 }
 213
 214 void Controller::SetHorizontalScrollEnabled( bool enable )
 215 {
 216   if( ( NULL != mImpl->mEventData ) &&
 217       mImpl->mEventData->mDecorator )
 218   {
 219     mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled( enable );
 220   }
 221 }
 222
 223 bool Controller::IsHorizontalScrollEnabled() const
 224 {
 225   if( ( NULL != mImpl->mEventData ) &&
 226       mImpl->mEventData->mDecorator )
 227   {
 228     return mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
 229   }
 230
 231   return false;
 232 }
 233
 234 void Controller::SetVerticalScrollEnabled( bool enable )
 235 {
 236   if( ( NULL != mImpl->mEventData ) &&
 237       mImpl->mEventData->mDecorator )
 238   {
 239     if( mImpl->mEventData->mDecorator )
 240     {
 241       mImpl->mEventData->mDecorator->SetVerticalScrollEnabled( enable );
 242     }
 243   }
 244 }
 245
 246 bool Controller::IsVerticalScrollEnabled() const
 247 {
 248   if( ( NULL != mImpl->mEventData ) &&
 249       mImpl->mEventData->mDecorator )
 250   {
 251     return mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
 252   }
 253
 254   return false;
 255 }
 256
 257 void Controller::SetSmoothHandlePanEnabled( bool enable )
 258 {
 259   if( ( NULL != mImpl->mEventData ) &&
 260       mImpl->mEventData->mDecorator )
 261   {
 262     mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled( enable );
 263   }
 264 }
 265
 266 bool Controller::IsSmoothHandlePanEnabled() const
 267 {
 268   if( ( NULL != mImpl->mEventData ) &&
 269       mImpl->mEventData->mDecorator )
 270   {
 271     return mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
 272   }
 273
 274   return false;
 275 }
 276
 277 void Controller::SetMaximumNumberOfCharacters( Length maxCharacters )
 278 {
 279   mImpl->mMaximumNumberOfCharacters = maxCharacters;
 280 }
 281
 282 int Controller::GetMaximumNumberOfCharacters()
 283 {
 284   return mImpl->mMaximumNumberOfCharacters;
 285 }
 286
 287 void Controller::SetEnableCursorBlink( bool enable )
 288 {
 289   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "TextInput disabled" );
 290
 291   if( NULL != mImpl->mEventData )
 292   {
 293     mImpl->mEventData->mCursorBlinkEnabled = enable;
 294
 295     if( !enable &&
 296         mImpl->mEventData->mDecorator )
 297     {
 298       mImpl->mEventData->mDecorator->StopCursorBlink();
 299     }
 300   }
 301 }
 302
 303 bool Controller::GetEnableCursorBlink() const
 304 {
 305   if( NULL != mImpl->mEventData )
 306   {
 307     return mImpl->mEventData->mCursorBlinkEnabled;
 308   }
 309
 310   return false;
 311 }
 312
 313 void Controller::SetMultiLineEnabled( bool enable )
 314 {
 315   const LayoutEngine::Layout layout = enable ? LayoutEngine::MULTI_LINE_BOX : LayoutEngine::SINGLE_LINE_BOX;
 316
 317   if( layout != mImpl->mLayoutEngine.GetLayout() )
 318   {
 319     // Set the layout type.
 320     mImpl->mLayoutEngine.SetLayout( layout );
 321
 322     // Set the flags to redo the layout operations
 323     const OperationsMask layoutOperations =  static_cast<OperationsMask>( LAYOUT             |
 324                                                                           UPDATE_LAYOUT_SIZE |
 325                                                                           ALIGN              |
 326                                                                           REORDER );
 327
 328     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | layoutOperations );
 329
 330     mImpl->RequestRelayout();
 331   }
 332 }
 333
 334 bool Controller::IsMultiLineEnabled() const
 335 {
 336   return LayoutEngine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
 337 }
 338
 339 void Controller::SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment )
 340 {
 341   if( alignment != mImpl->mLayoutEngine.GetHorizontalAlignment() )
 342   {
 343     // Set the alignment.
 344     mImpl->mLayoutEngine.SetHorizontalAlignment( alignment );
 345
 346     // Set the flag to redo the alignment operation.
 347     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 348
 349     mImpl->RequestRelayout();
 350   }
 351 }
 352
 353 LayoutEngine::HorizontalAlignment Controller::GetHorizontalAlignment() const
 354 {
 355   return mImpl->mLayoutEngine.GetHorizontalAlignment();
 356 }
 357
 358 void Controller::SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment )
 359 {
 360   if( alignment != mImpl->mLayoutEngine.GetVerticalAlignment() )
 361   {
 362     // Set the alignment.
 363     mImpl->mLayoutEngine.SetVerticalAlignment( alignment );
 364
 365     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 366
 367     mImpl->RequestRelayout();
 368   }
 369 }
 370
 371 LayoutEngine::VerticalAlignment Controller::GetVerticalAlignment() const
 372 {
 373   return mImpl->mLayoutEngine.GetVerticalAlignment();
 374 }
 375
 376 // public : Update
 377
 378 void Controller::SetText( const std::string& text )
 379 {
 380   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText\n" );
 381
 382   // Reset keyboard as text changed
 383   mImpl->ResetImfManager();
 384
 385   // Remove the previously set text and style.
 386   ResetText();
 387
 388   // Remove the style.
 389   ClearStyleData();
 390
 391   CharacterIndex lastCursorIndex = 0u;
 392
 393   if( NULL != mImpl->mEventData )
 394   {
 395     // If popup shown then hide it by switching to Editing state
 396     if( ( EventData::SELECTING == mImpl->mEventData->mState )          ||
 397         ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 398         ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) ||
 399         ( EventData::EDITING_WITH_PASTE_POPUP == mImpl->mEventData->mState ) )
 400     {
 401       mImpl->ChangeState( EventData::EDITING );
 402     }
 403   }
 404
 405   if( !text.empty() )
 406   {
 407     mImpl->mVisualModel->SetTextColor( mImpl->mTextColor );
 408
 409     MarkupProcessData markupProcessData( mImpl->mLogicalModel->mColorRuns,
 410                                          mImpl->mLogicalModel->mFontDescriptionRuns );
 411
 412     Length textSize = 0u;
 413     const uint8_t* utf8 = NULL;
 414     if( mImpl->mMarkupProcessorEnabled )
 415     {
 416       ProcessMarkupString( text, markupProcessData );
 417       textSize = markupProcessData.markupProcessedText.size();
 418
 419       // This is a bit horrible but std::string returns a (signed) char*
 420       utf8 = reinterpret_cast<const uint8_t*>( markupProcessData.markupProcessedText.c_str() );
 421     }
 422     else
 423     {
 424       textSize = text.size();
 425
 426       // This is a bit horrible but std::string returns a (signed) char*
 427       utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
 428     }
 429
 430     //  Convert text into UTF-32
 431     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
 432     utf32Characters.Resize( textSize );
 433
 434     // Transform a text array encoded in utf8 into an array encoded in utf32.
 435     // It returns the actual number of characters.
 436     Length characterCount = Utf8ToUtf32( utf8, textSize, utf32Characters.Begin() );
 437     utf32Characters.Resize( characterCount );
 438
 439     DALI_ASSERT_DEBUG( textSize >= characterCount && "Invalid UTF32 conversion length" );
 440     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText %p UTF8 size %d, UTF32 size %d\n", this, textSize, mImpl->mLogicalModel->mText.Count() );
 441
 442     // The characters to be added.
 443     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
 444
 445     // To reset the cursor position
 446     lastCursorIndex = characterCount;
 447
 448     // Update the rest of the model during size negotiation
 449     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
 450
 451     // The natural size needs to be re-calculated.
 452     mImpl->mRecalculateNaturalSize = true;
 453
 454     // Apply modifications to the model
 455     mImpl->mOperationsPending = ALL_OPERATIONS;
 456   }
 457   else
 458   {
 459     ShowPlaceholderText();
 460   }
 461
 462   // Resets the cursor position.
 463   ResetCursorPosition( lastCursorIndex );
 464
 465   // Scrolls the text to make the cursor visible.
 466   ResetScrollPosition();
 467
 468   mImpl->RequestRelayout();
 469
 470   if( NULL != mImpl->mEventData )
 471   {
 472     // Cancel previously queued events
 473     mImpl->mEventData->mEventQueue.clear();
 474   }
 475
 476   // Do this last since it provides callbacks into application code.
 477   if( NULL != mImpl->mEditableControlInterface )
 478   {
 479     mImpl->mEditableControlInterface->TextChanged();
 480   }
 481 }
 482
 483 void Controller::GetText( std::string& text ) const
 484 {
 485   if( !mImpl->IsShowingPlaceholderText() )
 486   {
 487     // Retrieves the text string.
 488     mImpl->GetText( 0u, text );
 489   }
 490   else
 491   {
 492     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::GetText %p empty (but showing placeholder)\n", this );
 493   }
 494 }
 495
 496 void Controller::SetPlaceholderText( PlaceholderType type, const std::string& text )
 497 {
 498   if( NULL != mImpl->mEventData )
 499   {
 500     if( PLACEHOLDER_TYPE_INACTIVE == type )
 501     {
 502       mImpl->mEventData->mPlaceholderTextInactive = text;
 503     }
 504     else
 505     {
 506       mImpl->mEventData->mPlaceholderTextActive = text;
 507     }
 508
 509     // Update placeholder if there is no text
 510     if( mImpl->IsShowingPlaceholderText() ||
 511         ( 0u == mImpl->mLogicalModel->mText.Count() ) )
 512     {
 513       ShowPlaceholderText();
 514     }
 515   }
 516 }
 517
 518 void Controller::GetPlaceholderText( PlaceholderType type, std::string& text ) const
 519 {
 520   if( NULL != mImpl->mEventData )
 521   {
 522     if( PLACEHOLDER_TYPE_INACTIVE == type )
 523     {
 524       text = mImpl->mEventData->mPlaceholderTextInactive;
 525     }
 526     else
 527     {
 528       text = mImpl->mEventData->mPlaceholderTextActive;
 529     }
 530   }
 531 }
 532
 533 void Controller::UpdateAfterFontChange( const std::string& newDefaultFont )
 534 {
 535   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::UpdateAfterFontChange\n");
 536
 537   if( !mImpl->mFontDefaults->familyDefined ) // If user defined font then should not update when system font changes
 538   {
 539     DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::UpdateAfterFontChange newDefaultFont(%s)\n", newDefaultFont.c_str() );
 540     mImpl->mFontDefaults->mFontDescription.family = newDefaultFont;
 541
 542     ClearFontData();
 543
 544     mImpl->RequestRelayout();
 545   }
 546 }
 547
 548 // public : Default style & Input style
 549
 550 void Controller::SetDefaultFontFamily( const std::string& defaultFontFamily )
 551 {
 552   if( NULL == mImpl->mFontDefaults )
 553   {
 554     mImpl->mFontDefaults = new FontDefaults();
 555   }
 556
 557   mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
 558   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
 559   mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
 560
 561   // Clear the font-specific data
 562   ClearFontData();
 563
 564   mImpl->RequestRelayout();
 565 }
 566
 567 const std::string& Controller::GetDefaultFontFamily() const
 568 {
 569   if( NULL != mImpl->mFontDefaults )
 570   {
 571     return mImpl->mFontDefaults->mFontDescription.family;
 572   }
 573
 574   return EMPTY_STRING;
 575 }
 576
 577 void Controller::SetDefaultFontWeight( FontWeight weight )
 578 {
 579   if( NULL == mImpl->mFontDefaults )
 580   {
 581     mImpl->mFontDefaults = new FontDefaults();
 582   }
 583
 584   mImpl->mFontDefaults->mFontDescription.weight = weight;
 585   mImpl->mFontDefaults->weightDefined = true;
 586
 587   // Clear the font-specific data
 588   ClearFontData();
 589
 590   mImpl->RequestRelayout();
 591 }
 592
 593 bool Controller::IsDefaultFontWeightDefined() const
 594 {
 595   return mImpl->mFontDefaults->weightDefined;
 596 }
 597
 598 FontWeight Controller::GetDefaultFontWeight() const
 599 {
 600   if( NULL != mImpl->mFontDefaults )
 601   {
 602     return mImpl->mFontDefaults->mFontDescription.weight;
 603   }
 604
 605   return TextAbstraction::FontWeight::NORMAL;
 606 }
 607
 608 void Controller::SetDefaultFontWidth( FontWidth width )
 609 {
 610   if( NULL == mImpl->mFontDefaults )
 611   {
 612     mImpl->mFontDefaults = new FontDefaults();
 613   }
 614
 615   mImpl->mFontDefaults->mFontDescription.width = width;
 616   mImpl->mFontDefaults->widthDefined = true;
 617
 618   // Clear the font-specific data
 619   ClearFontData();
 620
 621   mImpl->RequestRelayout();
 622 }
 623
 624 bool Controller::IsDefaultFontWidthDefined() const
 625 {
 626   return mImpl->mFontDefaults->widthDefined;
 627 }
 628
 629 FontWidth Controller::GetDefaultFontWidth() const
 630 {
 631   if( NULL != mImpl->mFontDefaults )
 632   {
 633     return mImpl->mFontDefaults->mFontDescription.width;
 634   }
 635
 636   return TextAbstraction::FontWidth::NORMAL;
 637 }
 638
 639 void Controller::SetDefaultFontSlant( FontSlant slant )
 640 {
 641   if( NULL == mImpl->mFontDefaults )
 642   {
 643     mImpl->mFontDefaults = new FontDefaults();
 644   }
 645
 646   mImpl->mFontDefaults->mFontDescription.slant = slant;
 647   mImpl->mFontDefaults->slantDefined = true;
 648
 649   // Clear the font-specific data
 650   ClearFontData();
 651
 652   mImpl->RequestRelayout();
 653 }
 654
 655 bool Controller::IsDefaultFontSlantDefined() const
 656 {
 657   return mImpl->mFontDefaults->slantDefined;
 658 }
 659
 660 FontSlant Controller::GetDefaultFontSlant() const
 661 {
 662   if( NULL != mImpl->mFontDefaults )
 663   {
 664     return mImpl->mFontDefaults->mFontDescription.slant;
 665   }
 666
 667   return TextAbstraction::FontSlant::NORMAL;
 668 }
 669
 670 void Controller::SetDefaultPointSize( float pointSize )
 671 {
 672   if( NULL == mImpl->mFontDefaults )
 673   {
 674     mImpl->mFontDefaults = new FontDefaults();
 675   }
 676
 677   mImpl->mFontDefaults->mDefaultPointSize = pointSize;
 678   mImpl->mFontDefaults->sizeDefined = true;
 679
 680   // Clear the font-specific data
 681   ClearFontData();
 682
 683   mImpl->RequestRelayout();
 684 }
 685
 686 float Controller::GetDefaultPointSize() const
 687 {
 688   if( NULL != mImpl->mFontDefaults )
 689   {
 690     return mImpl->mFontDefaults->mDefaultPointSize;
 691   }
 692
 693   return 0.0f;
 694 }
 695
 696 void Controller::SetTextColor( const Vector4& textColor )
 697 {
 698   mImpl->mTextColor = textColor;
 699
 700   if( !mImpl->IsShowingPlaceholderText() )
 701   {
 702     mImpl->mVisualModel->SetTextColor( textColor );
 703
 704     mImpl->RequestRelayout();
 705   }
 706 }
 707
 708 const Vector4& Controller::GetTextColor() const
 709 {
 710   return mImpl->mTextColor;
 711 }
 712
 713 void Controller::SetPlaceholderTextColor( const Vector4& textColor )
 714 {
 715   if( NULL != mImpl->mEventData )
 716   {
 717     mImpl->mEventData->mPlaceholderTextColor = textColor;
 718   }
 719
 720   if( mImpl->IsShowingPlaceholderText() )
 721   {
 722     mImpl->mVisualModel->SetTextColor( textColor );
 723     mImpl->RequestRelayout();
 724   }
 725 }
 726
 727 const Vector4& Controller::GetPlaceholderTextColor() const
 728 {
 729   if( NULL != mImpl->mEventData )
 730   {
 731     return mImpl->mEventData->mPlaceholderTextColor;
 732   }
 733
 734   return Color::BLACK;
 735 }
 736
 737 void Controller::SetShadowOffset( const Vector2& shadowOffset )
 738 {
 739   mImpl->mVisualModel->SetShadowOffset( shadowOffset );
 740
 741   mImpl->RequestRelayout();
 742 }
 743
 744 const Vector2& Controller::GetShadowOffset() const
 745 {
 746   return mImpl->mVisualModel->GetShadowOffset();
 747 }
 748
 749 void Controller::SetShadowColor( const Vector4& shadowColor )
 750 {
 751   mImpl->mVisualModel->SetShadowColor( shadowColor );
 752
 753   mImpl->RequestRelayout();
 754 }
 755
 756 const Vector4& Controller::GetShadowColor() const
 757 {
 758   return mImpl->mVisualModel->GetShadowColor();
 759 }
 760
 761 void Controller::SetUnderlineColor( const Vector4& color )
 762 {
 763   mImpl->mVisualModel->SetUnderlineColor( color );
 764
 765   mImpl->RequestRelayout();
 766 }
 767
 768 const Vector4& Controller::GetUnderlineColor() const
 769 {
 770   return mImpl->mVisualModel->GetUnderlineColor();
 771 }
 772
 773 void Controller::SetUnderlineEnabled( bool enabled )
 774 {
 775   mImpl->mVisualModel->SetUnderlineEnabled( enabled );
 776
 777   mImpl->RequestRelayout();
 778 }
 779
 780 bool Controller::IsUnderlineEnabled() const
 781 {
 782   return mImpl->mVisualModel->IsUnderlineEnabled();
 783 }
 784
 785 void Controller::SetUnderlineHeight( float height )
 786 {
 787   mImpl->mVisualModel->SetUnderlineHeight( height );
 788
 789   mImpl->RequestRelayout();
 790 }
 791
 792 float Controller::GetUnderlineHeight() const
 793 {
 794   return mImpl->mVisualModel->GetUnderlineHeight();
 795 }
 796
 797 void Controller::SetDefaultEmbossProperties( const std::string& embossProperties )
 798 {
 799   if( NULL == mImpl->mEmbossDefaults )
 800   {
 801     mImpl->mEmbossDefaults = new EmbossDefaults();
 802   }
 803
 804   mImpl->mEmbossDefaults->properties = embossProperties;
 805 }
 806
 807 const std::string& Controller::GetDefaultEmbossProperties() const
 808 {
 809   if( NULL != mImpl->mEmbossDefaults )
 810   {
 811     return mImpl->mEmbossDefaults->properties;
 812   }
 813
 814   return EMPTY_STRING;
 815 }
 816
 817 void Controller::SetDefaultOutlineProperties( const std::string& outlineProperties )
 818 {
 819   if( NULL == mImpl->mOutlineDefaults )
 820   {
 821     mImpl->mOutlineDefaults = new OutlineDefaults();
 822   }
 823
 824   mImpl->mOutlineDefaults->properties = outlineProperties;
 825 }
 826
 827 const std::string& Controller::GetDefaultOutlineProperties() const
 828 {
 829   if( NULL != mImpl->mOutlineDefaults )
 830   {
 831     return mImpl->mOutlineDefaults->properties;
 832   }
 833
 834   return EMPTY_STRING;
 835 }
 836
 837 void Controller::SetDefaultLineSpacing( float lineSpacing )
 838 {
 839   //TODO finish implementation
 840   mImpl->mLayoutEngine.SetDefaultLineSpacing( lineSpacing );
 841 }
 842
 843 float Controller::GetDefaultLineSpacing() const
 844 {
 845   return mImpl->mLayoutEngine.GetDefaultLineSpacing();
 846 }
 847
 848 void Controller::SetInputColor( const Vector4& color )
 849 {
 850   if( NULL != mImpl->mEventData )
 851   {
 852     mImpl->mEventData->mInputStyle.textColor = color;
 853     mImpl->mEventData->mInputStyle.isDefaultColor = false;
 854
 855     if( EventData::SELECTING == mImpl->mEventData->mState )
 856     {
 857       const bool handlesCrossed = mImpl->mEventData->mLeftSelectionPosition > mImpl->mEventData->mRightSelectionPosition;
 858
 859       // Get start and end position of selection
 860       const CharacterIndex startOfSelectedText = handlesCrossed ? mImpl->mEventData->mRightSelectionPosition : mImpl->mEventData->mLeftSelectionPosition;
 861       const Length lengthOfSelectedText = ( handlesCrossed ? mImpl->mEventData->mLeftSelectionPosition : mImpl->mEventData->mRightSelectionPosition ) - startOfSelectedText;
 862
 863       // Add the color run.
 864       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
 865       mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
 866
 867       ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
 868       colorRun.color = color;
 869       colorRun.characterRun.characterIndex = startOfSelectedText;
 870       colorRun.characterRun.numberOfCharacters = lengthOfSelectedText;
 871
 872       // Request to relayout.
 873       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | COLOR );
 874       mImpl->RequestRelayout();
 875
 876       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 877       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 878       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 879     }
 880   }
 881 }
 882
 883 const Vector4& Controller::GetInputColor() const
 884 {
 885   if( NULL != mImpl->mEventData )
 886   {
 887     return mImpl->mEventData->mInputStyle.textColor;
 888   }
 889
 890   // Return the default text's color if there is no EventData.
 891   return mImpl->mTextColor;
 892
 893 }
 894
 895 void Controller::SetInputFontFamily( const std::string& fontFamily )
 896 {
 897   if( NULL != mImpl->mEventData )
 898   {
 899     mImpl->mEventData->mInputStyle.familyName = fontFamily;
 900     mImpl->mEventData->mInputStyle.isFamilyDefined = true;
 901
 902     if( EventData::SELECTING == mImpl->mEventData->mState )
 903     {
 904       CharacterIndex startOfSelectedText = 0u;
 905       Length lengthOfSelectedText = 0u;
 906       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
 907                                                                             mImpl->mLogicalModel,
 908                                                                             startOfSelectedText,
 909                                                                             lengthOfSelectedText );
 910
 911       fontDescriptionRun.familyLength = fontFamily.size();
 912       fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
 913       memcpy( fontDescriptionRun.familyName, fontFamily.c_str(), fontDescriptionRun.familyLength );
 914       fontDescriptionRun.familyDefined = true;
 915
 916       // The memory allocated for the font family name is freed when the font description is removed from the logical model.
 917
 918       // Request to relayout.
 919       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 920                                                                VALIDATE_FONTS            |
 921                                                                SHAPE_TEXT                |
 922                                                                GET_GLYPH_METRICS         |
 923                                                                LAYOUT                    |
 924                                                                UPDATE_LAYOUT_SIZE        |
 925                                                                REORDER                   |
 926                                                                ALIGN );
 927       mImpl->mRecalculateNaturalSize = true;
 928       mImpl->RequestRelayout();
 929
 930       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 931       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 932       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 933
 934       // As the font changes, recalculate the handle positions is needed.
 935       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
 936       mImpl->mEventData->mUpdateRightSelectionPosition = true;
 937       mImpl->mEventData->mUpdateHighlightBox = true;
 938       mImpl->mEventData->mScrollAfterUpdatePosition = true;
 939     }
 940   }
 941 }
 942
 943 const std::string& Controller::GetInputFontFamily() const
 944 {
 945   if( NULL != mImpl->mEventData )
 946   {
 947     return mImpl->mEventData->mInputStyle.familyName;
 948   }
 949
 950   // Return the default font's family if there is no EventData.
 951   return GetDefaultFontFamily();
 952 }
 953
 954 void Controller::SetInputFontWeight( FontWeight weight )
 955 {
 956   if( NULL != mImpl->mEventData )
 957   {
 958     mImpl->mEventData->mInputStyle.weight = weight;
 959     mImpl->mEventData->mInputStyle.isWeightDefined = true;
 960
 961     if( EventData::SELECTING == mImpl->mEventData->mState )
 962     {
 963       CharacterIndex startOfSelectedText = 0u;
 964       Length lengthOfSelectedText = 0u;
 965       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
 966                                                                             mImpl->mLogicalModel,
 967                                                                             startOfSelectedText,
 968                                                                             lengthOfSelectedText );
 969
 970       fontDescriptionRun.weight = weight;
 971       fontDescriptionRun.weightDefined = true;
 972
 973       // Request to relayout.
 974       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 975                                                                VALIDATE_FONTS            |
 976                                                                SHAPE_TEXT                |
 977                                                                GET_GLYPH_METRICS         |
 978                                                                LAYOUT                    |
 979                                                                UPDATE_LAYOUT_SIZE        |
 980                                                                REORDER                   |
 981                                                                ALIGN );
 982       mImpl->mRecalculateNaturalSize = true;
 983       mImpl->RequestRelayout();
 984
 985       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 986       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 987       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 988
 989       // As the font might change, recalculate the handle positions is needed.
 990       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
 991       mImpl->mEventData->mUpdateRightSelectionPosition = true;
 992       mImpl->mEventData->mUpdateHighlightBox = true;
 993       mImpl->mEventData->mScrollAfterUpdatePosition = true;
 994     }
 995   }
 996 }
 997
 998 bool Controller::IsInputFontWeightDefined() const
 999 {
1000   bool defined = false;
1001
1002   if( NULL != mImpl->mEventData )
1003   {
1004     defined = mImpl->mEventData->mInputStyle.isWeightDefined;
1005   }
1006
1007   return defined;
1008 }
1009
1010 FontWeight Controller::GetInputFontWeight() const
1011 {
1012   if( NULL != mImpl->mEventData )
1013   {
1014     return mImpl->mEventData->mInputStyle.weight;
1015   }
1016
1017   return GetDefaultFontWeight();
1018 }
1019
1020 void Controller::SetInputFontWidth( FontWidth width )
1021 {
1022   if( NULL != mImpl->mEventData )
1023   {
1024     mImpl->mEventData->mInputStyle.width = width;
1025     mImpl->mEventData->mInputStyle.isWidthDefined = true;
1026
1027     if( EventData::SELECTING == mImpl->mEventData->mState )
1028     {
1029       CharacterIndex startOfSelectedText = 0u;
1030       Length lengthOfSelectedText = 0u;
1031       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1032                                                                             mImpl->mLogicalModel,
1033                                                                             startOfSelectedText,
1034                                                                             lengthOfSelectedText );
1035
1036       fontDescriptionRun.width = width;
1037       fontDescriptionRun.widthDefined = true;
1038
1039       // Request to relayout.
1040       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1041                                                                VALIDATE_FONTS            |
1042                                                                SHAPE_TEXT                |
1043                                                                GET_GLYPH_METRICS         |
1044                                                                LAYOUT                    |
1045                                                                UPDATE_LAYOUT_SIZE        |
1046                                                                REORDER                   |
1047                                                                ALIGN );
1048       mImpl->mRecalculateNaturalSize = true;
1049       mImpl->RequestRelayout();
1050
1051       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1052       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1053       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1054
1055       // As the font might change, recalculate the handle positions is needed.
1056       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1057       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1058       mImpl->mEventData->mUpdateHighlightBox = true;
1059       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1060     }
1061   }
1062 }
1063
1064 bool Controller::IsInputFontWidthDefined() const
1065 {
1066   bool defined = false;
1067
1068   if( NULL != mImpl->mEventData )
1069   {
1070     defined = mImpl->mEventData->mInputStyle.isWidthDefined;
1071   }
1072
1073   return defined;
1074 }
1075
1076 FontWidth Controller::GetInputFontWidth() const
1077 {
1078   if( NULL != mImpl->mEventData )
1079   {
1080     return mImpl->mEventData->mInputStyle.width;
1081   }
1082
1083   return GetDefaultFontWidth();
1084 }
1085
1086 void Controller::SetInputFontSlant( FontSlant slant )
1087 {
1088   if( NULL != mImpl->mEventData )
1089   {
1090     mImpl->mEventData->mInputStyle.slant = slant;
1091     mImpl->mEventData->mInputStyle.isSlantDefined = true;
1092
1093     if( EventData::SELECTING == mImpl->mEventData->mState )
1094     {
1095       CharacterIndex startOfSelectedText = 0u;
1096       Length lengthOfSelectedText = 0u;
1097       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1098                                                                             mImpl->mLogicalModel,
1099                                                                             startOfSelectedText,
1100                                                                             lengthOfSelectedText );
1101
1102       fontDescriptionRun.slant = slant;
1103       fontDescriptionRun.slantDefined = true;
1104
1105       // Request to relayout.
1106       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1107                                                                VALIDATE_FONTS            |
1108                                                                SHAPE_TEXT                |
1109                                                                GET_GLYPH_METRICS         |
1110                                                                LAYOUT                    |
1111                                                                UPDATE_LAYOUT_SIZE        |
1112                                                                REORDER                   |
1113                                                                ALIGN );
1114       mImpl->mRecalculateNaturalSize = true;
1115       mImpl->RequestRelayout();
1116
1117       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1118       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1119       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1120
1121       // As the font might change, recalculate the handle positions is needed.
1122       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1123       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1124       mImpl->mEventData->mUpdateHighlightBox = true;
1125       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1126     }
1127   }
1128 }
1129
1130 bool Controller::IsInputFontSlantDefined() const
1131 {
1132   bool defined = false;
1133
1134   if( NULL != mImpl->mEventData )
1135   {
1136     defined = mImpl->mEventData->mInputStyle.isSlantDefined;
1137   }
1138
1139   return defined;
1140 }
1141
1142 FontSlant Controller::GetInputFontSlant() const
1143 {
1144   if( NULL != mImpl->mEventData )
1145   {
1146     return mImpl->mEventData->mInputStyle.slant;
1147   }
1148
1149   return GetDefaultFontSlant();
1150 }
1151
1152 void Controller::SetInputFontPointSize( float size )
1153 {
1154   if( NULL != mImpl->mEventData )
1155   {
1156     mImpl->mEventData->mInputStyle.size = size;
1157     mImpl->mEventData->mInputStyle.isSizeDefined = true;
1158
1159     if( EventData::SELECTING == mImpl->mEventData->mState )
1160     {
1161       CharacterIndex startOfSelectedText = 0u;
1162       Length lengthOfSelectedText = 0u;
1163       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1164                                                                             mImpl->mLogicalModel,
1165                                                                             startOfSelectedText,
1166                                                                             lengthOfSelectedText );
1167
1168       fontDescriptionRun.size = static_cast<PointSize26Dot6>( size * 64.f );
1169       fontDescriptionRun.sizeDefined = true;
1170
1171       // Request to relayout.
1172       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1173                                                                VALIDATE_FONTS            |
1174                                                                SHAPE_TEXT                |
1175                                                                GET_GLYPH_METRICS         |
1176                                                                LAYOUT                    |
1177                                                                UPDATE_LAYOUT_SIZE        |
1178                                                                REORDER                   |
1179                                                                ALIGN );
1180       mImpl->mRecalculateNaturalSize = true;
1181       mImpl->RequestRelayout();
1182
1183       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1184       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1185       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1186
1187       // As the font might change, recalculate the handle positions is needed.
1188       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1189       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1190       mImpl->mEventData->mUpdateHighlightBox = true;
1191       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1192     }
1193   }
1194 }
1195
1196 float Controller::GetInputFontPointSize() const
1197 {
1198   if( NULL != mImpl->mEventData )
1199   {
1200     return mImpl->mEventData->mInputStyle.size;
1201   }
1202
1203   // Return the default font's point size if there is no EventData.
1204   return GetDefaultPointSize();
1205 }
1206
1207 void Controller::SetInputLineSpacing( float lineSpacing )
1208 {
1209   if( NULL != mImpl->mEventData )
1210   {
1211     mImpl->mEventData->mInputStyle.lineSpacing = lineSpacing;
1212     mImpl->mEventData->mInputStyle.isLineSpacingDefined = true;
1213   }
1214 }
1215
1216 float Controller::GetInputLineSpacing() const
1217 {
1218   if( NULL != mImpl->mEventData )
1219   {
1220     return mImpl->mEventData->mInputStyle.lineSpacing;
1221   }
1222
1223   return 0.f;
1224 }
1225
1226 void Controller::SetInputShadowProperties( const std::string& shadowProperties )
1227 {
1228   if( NULL != mImpl->mEventData )
1229   {
1230     mImpl->mEventData->mInputStyle.shadowProperties = shadowProperties;
1231   }
1232 }
1233
1234 const std::string& Controller::GetInputShadowProperties() const
1235 {
1236   if( NULL != mImpl->mEventData )
1237   {
1238     return mImpl->mEventData->mInputStyle.shadowProperties;
1239   }
1240
1241   return EMPTY_STRING;
1242 }
1243
1244 void Controller::SetInputUnderlineProperties( const std::string& underlineProperties )
1245 {
1246   if( NULL != mImpl->mEventData )
1247   {
1248     mImpl->mEventData->mInputStyle.underlineProperties = underlineProperties;
1249   }
1250 }
1251
1252 const std::string& Controller::GetInputUnderlineProperties() const
1253 {
1254   if( NULL != mImpl->mEventData )
1255   {
1256     return mImpl->mEventData->mInputStyle.underlineProperties;
1257   }
1258
1259   return EMPTY_STRING;
1260 }
1261
1262 void Controller::SetInputEmbossProperties( const std::string& embossProperties )
1263 {
1264   if( NULL != mImpl->mEventData )
1265   {
1266     mImpl->mEventData->mInputStyle.embossProperties = embossProperties;
1267   }
1268 }
1269
1270 const std::string& Controller::GetInputEmbossProperties() const
1271 {
1272   if( NULL != mImpl->mEventData )
1273   {
1274     return mImpl->mEventData->mInputStyle.embossProperties;
1275   }
1276
1277   return GetDefaultEmbossProperties();
1278 }
1279
1280 void Controller::SetInputOutlineProperties( const std::string& outlineProperties )
1281 {
1282   if( NULL != mImpl->mEventData )
1283   {
1284     mImpl->mEventData->mInputStyle.outlineProperties = outlineProperties;
1285   }
1286 }
1287
1288 const std::string& Controller::GetInputOutlineProperties() const
1289 {
1290   if( NULL != mImpl->mEventData )
1291   {
1292     return mImpl->mEventData->mInputStyle.outlineProperties;
1293   }
1294
1295   return GetDefaultOutlineProperties();
1296 }
1297
1298 // public : Queries & retrieves.
1299
1300 LayoutEngine& Controller::GetLayoutEngine()
1301 {
1302   return mImpl->mLayoutEngine;
1303 }
1304
1305 View& Controller::GetView()
1306 {
1307   return mImpl->mView;
1308 }
1309
1310 const Vector2& Controller::GetScrollPosition() const
1311 {
1312   return mImpl->mScrollPosition;
1313 }
1314
1315 Vector3 Controller::GetNaturalSize()
1316 {
1317   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n" );
1318   Vector3 naturalSize;
1319
1320   // Make sure the model is up-to-date before layouting
1321   ProcessModifyEvents();
1322
1323   if( mImpl->mRecalculateNaturalSize )
1324   {
1325     // Operations that can be done only once until the text changes.
1326     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1327                                                                            GET_SCRIPTS       |
1328                                                                            VALIDATE_FONTS    |
1329                                                                            GET_LINE_BREAKS   |
1330                                                                            GET_WORD_BREAKS   |
1331                                                                            BIDI_INFO         |
1332                                                                            SHAPE_TEXT        |
1333                                                                            GET_GLYPH_METRICS );
1334     // Make sure the model is up-to-date before layouting
1335     mImpl->UpdateModel( onlyOnceOperations );
1336
1337     // Layout the text for the new width.
1338     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1339
1340     // Set the update info to relayout the whole text.
1341     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1342     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1343
1344     // Store the actual control's size to restore later.
1345     const Size actualControlSize = mImpl->mVisualModel->mControlSize;
1346
1347     DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
1348                 static_cast<OperationsMask>( onlyOnceOperations |
1349                                              LAYOUT ),
1350                 naturalSize.GetVectorXY() );
1351
1352     // Do not do again the only once operations.
1353     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1354
1355     // Do the size related operations again.
1356     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1357                                                                         ALIGN  |
1358                                                                         REORDER );
1359     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1360
1361     // Stores the natural size to avoid recalculate it again
1362     // unless the text/style changes.
1363     mImpl->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
1364
1365     mImpl->mRecalculateNaturalSize = false;
1366
1367     // Clear the update info. This info will be set the next time the text is updated.
1368     mImpl->mTextUpdateInfo.Clear();
1369
1370     // Restore the actual control's size.
1371     mImpl->mVisualModel->mControlSize = actualControlSize;
1372
1373     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1374   }
1375   else
1376   {
1377     naturalSize = mImpl->mVisualModel->GetNaturalSize();
1378
1379     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1380   }
1381
1382   naturalSize.x = ConvertToEven( naturalSize.x );
1383   naturalSize.y = ConvertToEven( naturalSize.y );
1384
1385   return naturalSize;
1386 }
1387
1388 float Controller::GetHeightForWidth( float width )
1389 {
1390   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
1391   // Make sure the model is up-to-date before layouting
1392   ProcessModifyEvents();
1393
1394   Size layoutSize;
1395   if( fabsf( width - mImpl->mVisualModel->mControlSize.width ) > Math::MACHINE_EPSILON_1000 )
1396   {
1397     // Operations that can be done only once until the text changes.
1398     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1399                                                                            GET_SCRIPTS       |
1400                                                                            VALIDATE_FONTS    |
1401                                                                            GET_LINE_BREAKS   |
1402                                                                            GET_WORD_BREAKS   |
1403                                                                            BIDI_INFO         |
1404                                                                            SHAPE_TEXT        |
1405                                                                            GET_GLYPH_METRICS );
1406     // Make sure the model is up-to-date before layouting
1407     mImpl->UpdateModel( onlyOnceOperations );
1408
1409
1410     // Layout the text for the new width.
1411     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1412
1413     // Set the update info to relayout the whole text.
1414     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1415     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1416
1417     // Store the actual control's width.
1418     const float actualControlWidth = mImpl->mVisualModel->mControlSize.width;
1419
1420     DoRelayout( Size( width, MAX_FLOAT ),
1421                 static_cast<OperationsMask>( onlyOnceOperations |
1422                                              LAYOUT ),
1423                 layoutSize );
1424
1425     // Do not do again the only once operations.
1426     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1427
1428     // Do the size related operations again.
1429     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1430                                                                         ALIGN  |
1431                                                                         REORDER );
1432
1433     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1434
1435     // Clear the update info. This info will be set the next time the text is updated.
1436     mImpl->mTextUpdateInfo.Clear();
1437
1438     // Restore the actual control's width.
1439     mImpl->mVisualModel->mControlSize.width = actualControlWidth;
1440
1441     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
1442   }
1443   else
1444   {
1445     layoutSize = mImpl->mVisualModel->GetLayoutSize();
1446     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
1447   }
1448
1449   return layoutSize.height;
1450 }
1451
1452 // public : Relayout.
1453
1454 Controller::UpdateTextType Controller::Relayout( const Size& size )
1455 {
1456   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", this, size.width, size.height, (mImpl->mAutoScrollEnabled)?"true":"false"  );
1457
1458   UpdateTextType updateTextType = NONE_UPDATED;
1459
1460   if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
1461   {
1462     if( 0u != mImpl->mVisualModel->mGlyphPositions.Count() )
1463     {
1464       mImpl->mVisualModel->mGlyphPositions.Clear();
1465       updateTextType = MODEL_UPDATED;
1466     }
1467
1468     // Clear the update info. This info will be set the next time the text is updated.
1469     mImpl->mTextUpdateInfo.Clear();
1470
1471     // Not worth to relayout if width or height is equal to zero.
1472     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
1473
1474     return updateTextType;
1475   }
1476
1477   // Whether a new size has been set.
1478   const bool newSize = ( size != mImpl->mVisualModel->mControlSize );
1479
1480   if( newSize )
1481   {
1482     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mVisualModel->mControlSize.width, mImpl->mVisualModel->mControlSize.height );
1483
1484     // Layout operations that need to be done if the size changes.
1485     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1486                                                              LAYOUT                    |
1487                                                              ALIGN                     |
1488                                                              UPDATE_LAYOUT_SIZE        |
1489                                                              REORDER );
1490     // Set the update info to relayout the whole text.
1491     mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
1492     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
1493   }
1494
1495   // Whether there are modify events.
1496   if( 0u != mImpl->mModifyEvents.Count() )
1497   {
1498     // Style operations that need to be done if the text is modified.
1499     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1500                                                              COLOR );
1501   }
1502
1503   // Make sure the model is up-to-date before layouting.
1504   ProcessModifyEvents();
1505   bool updated = mImpl->UpdateModel( mImpl->mOperationsPending );
1506
1507   // Layout the text.
1508   Size layoutSize;
1509   updated = DoRelayout( size,
1510                         mImpl->mOperationsPending,
1511                         layoutSize ) || updated;
1512
1513   if( updated )
1514   {
1515     updateTextType = MODEL_UPDATED;
1516   }
1517
1518   // Do not re-do any operation until something changes.
1519   mImpl->mOperationsPending = NO_OPERATION;
1520
1521   // Whether the text control is editable
1522   const bool isEditable = NULL != mImpl->mEventData;
1523
1524   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
1525   Vector2 offset;
1526   if( newSize && isEditable )
1527   {
1528     offset = mImpl->mScrollPosition;
1529   }
1530
1531   if( !isEditable || !IsMultiLineEnabled() )
1532   {
1533     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
1534     CalculateVerticalOffset( size );
1535   }
1536
1537   if( isEditable )
1538   {
1539     if( newSize )
1540     {
1541       // If there is a new size, the scroll position needs to be clamped.
1542       mImpl->ClampHorizontalScroll( layoutSize );
1543
1544       // Update the decorator's positions is needed if there is a new size.
1545       mImpl->mEventData->mDecorator->UpdatePositions( mImpl->mScrollPosition - offset );
1546     }
1547
1548     // Move the cursor, grab handle etc.
1549     if( mImpl->ProcessInputEvents() )
1550     {
1551       updateTextType = static_cast<UpdateTextType>( updateTextType | DECORATOR_UPDATED );
1552     }
1553   }
1554
1555   // Clear the update info. This info will be set the next time the text is updated.
1556   mImpl->mTextUpdateInfo.Clear();
1557   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
1558
1559   return updateTextType;
1560 }
1561
1562 // public : Input style change signals.
1563
1564 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1565 {
1566   return ( NULL == mImpl->mEventData ) || ( 0u == mImpl->mEventData->mInputStyleChangedQueue.Count() );
1567 }
1568
1569 void Controller::ProcessInputStyleChangedSignals()
1570 {
1571   if( NULL == mImpl->mEventData )
1572   {
1573     // Nothing to do.
1574     return;
1575   }
1576
1577   for( Vector<InputStyle::Mask>::ConstIterator it = mImpl->mEventData->mInputStyleChangedQueue.Begin(),
1578          endIt = mImpl->mEventData->mInputStyleChangedQueue.End();
1579        it != endIt;
1580        ++it )
1581   {
1582     const InputStyle::Mask mask = *it;
1583
1584     if( NULL != mImpl->mEditableControlInterface )
1585     {
1586       // Emit the input style changed signal.
1587       mImpl->mEditableControlInterface->InputStyleChanged( mask );
1588     }
1589   }
1590
1591   mImpl->mEventData->mInputStyleChangedQueue.Clear();
1592 }
1593
1594 // public : Text-input Event Queuing.
1595
1596 void Controller::KeyboardFocusGainEvent()
1597 {
1598   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1599
1600   if( NULL != mImpl->mEventData )
1601   {
1602     if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1603         ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1604     {
1605       mImpl->ChangeState( EventData::EDITING );
1606       mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1607     }
1608     mImpl->NotifyImfMultiLineStatus();
1609     if( mImpl->IsShowingPlaceholderText() )
1610     {
1611       // Show alternative placeholder-text when editing
1612       ShowPlaceholderText();
1613     }
1614
1615     mImpl->RequestRelayout();
1616   }
1617 }
1618
1619 void Controller::KeyboardFocusLostEvent()
1620 {
1621   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1622
1623   if( NULL != mImpl->mEventData )
1624   {
1625     if( EventData::INTERRUPTED != mImpl->mEventData->mState )
1626     {
1627       mImpl->ChangeState( EventData::INACTIVE );
1628
1629       if( !mImpl->IsShowingRealText() )
1630       {
1631         // Revert to regular placeholder-text when not editing
1632         ShowPlaceholderText();
1633       }
1634     }
1635   }
1636   mImpl->RequestRelayout();
1637 }
1638
1639 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1640 {
1641   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1642
1643   bool textChanged( false );
1644
1645   if( ( NULL != mImpl->mEventData ) &&
1646       ( keyEvent.state == KeyEvent::Down ) )
1647   {
1648     int keyCode = keyEvent.keyCode;
1649     const std::string& keyString = keyEvent.keyPressed;
1650
1651     // Pre-process to separate modifying events from non-modifying input events.
1652     if( Dali::DALI_KEY_ESCAPE == keyCode )
1653     {
1654       // Escape key is a special case which causes focus loss
1655       KeyboardFocusLostEvent();
1656     }
1657     else if( ( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ) ||
1658              ( Dali::DALI_KEY_CURSOR_RIGHT == keyCode ) ||
1659              ( Dali::DALI_KEY_CURSOR_UP    == keyCode ) ||
1660              ( Dali::DALI_KEY_CURSOR_DOWN  == keyCode ) )
1661     {
1662       Event event( Event::CURSOR_KEY_EVENT );
1663       event.p1.mInt = keyCode;
1664       mImpl->mEventData->mEventQueue.push_back( event );
1665     }
1666     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1667     {
1668       textChanged = BackspaceKeyEvent();
1669     }
1670     else if( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1671     {
1672       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1673       // Avoids calling the InsertText() method which can delete selected text
1674     }
1675     else if( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1676              IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1677     {
1678       mImpl->ChangeState( EventData::INACTIVE );
1679       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1680       // Avoids calling the InsertText() method which can delete selected text
1681     }
1682     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1683     {
1684       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1685       // and a character is typed after the type of a upper case latin character.
1686
1687       // Do nothing.
1688     }
1689     else
1690     {
1691       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1692
1693       // IMF manager is no longer handling key-events
1694       mImpl->ClearPreEditFlag();
1695
1696       InsertText( keyString, COMMIT );
1697       textChanged = true;
1698     }
1699
1700     if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1701          ( mImpl->mEventData->mState != EventData::INACTIVE ) &&
1702          ( Dali::DALI_KEY_SHIFT_LEFT != keyCode ) )
1703     {
1704       // Should not change the state if the key is the shift send by the imf manager.
1705       // Otherwise, when the state is SELECTING the text controller can't send the right
1706       // surrounding info to the imf.
1707       mImpl->ChangeState( EventData::EDITING );
1708     }
1709
1710     mImpl->RequestRelayout();
1711   }
1712
1713   if( textChanged &&
1714       ( NULL != mImpl->mEditableControlInterface ) )
1715   {
1716     // Do this last since it provides callbacks into application code
1717     mImpl->mEditableControlInterface->TextChanged();
1718   }
1719
1720   return true;
1721 }
1722
1723 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1724 {
1725   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1726
1727   if( NULL != mImpl->mEventData )
1728   {
1729     DALI_LOG_INFO( gLogFilter, Debug::Concise, "TapEvent state:%d \n", mImpl->mEventData->mState );
1730     EventData::State state( mImpl->mEventData->mState );
1731     bool relayoutNeeded( false );   // to avoid unnecessary relayouts when tapping an empty text-field
1732
1733     if( mImpl->IsClipboardVisible() )
1734     {
1735       if( EventData::INACTIVE == state || EventData::EDITING == state)
1736       {
1737         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1738       }
1739       relayoutNeeded = true;
1740     }
1741     else if( 1u == tapCount )
1742     {
1743       if( EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state )
1744       {
1745         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );  // If Popup shown hide it here so can be shown again if required.
1746       }
1747
1748       if( mImpl->IsShowingRealText() && ( EventData::INACTIVE != state ) )
1749       {
1750         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1751         relayoutNeeded = true;
1752       }
1753       else
1754       {
1755         if( mImpl->IsShowingPlaceholderText() && !mImpl->IsFocusedPlaceholderAvailable() )
1756         {
1757           // Hide placeholder text
1758           ResetText();
1759         }
1760
1761         if( EventData::INACTIVE == state )
1762         {
1763           mImpl->ChangeState( EventData::EDITING );
1764         }
1765         else if( !mImpl->IsClipboardEmpty() )
1766         {
1767           mImpl->ChangeState( EventData::EDITING_WITH_POPUP );
1768         }
1769         relayoutNeeded = true;
1770       }
1771     }
1772     else if( 2u == tapCount )
1773     {
1774       if( mImpl->mEventData->mSelectionEnabled &&
1775           mImpl->IsShowingRealText() )
1776       {
1777         SelectEvent( x, y, false );
1778       }
1779     }
1780     // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1781     if( relayoutNeeded )
1782     {
1783       Event event( Event::TAP_EVENT );
1784       event.p1.mUint = tapCount;
1785       event.p2.mFloat = x;
1786       event.p3.mFloat = y;
1787       mImpl->mEventData->mEventQueue.push_back( event );
1788
1789       mImpl->RequestRelayout();
1790     }
1791   }
1792
1793   // Reset keyboard as tap event has occurred.
1794   mImpl->ResetImfManager();
1795 }
1796
1797 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1798 {
1799   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1800
1801   if( NULL != mImpl->mEventData )
1802   {
1803     Event event( Event::PAN_EVENT );
1804     event.p1.mInt = state;
1805     event.p2.mFloat = displacement.x;
1806     event.p3.mFloat = displacement.y;
1807     mImpl->mEventData->mEventQueue.push_back( event );
1808
1809     mImpl->RequestRelayout();
1810   }
1811 }
1812
1813 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1814 {
1815   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected LongPressEvent" );
1816
1817   if( ( state == Gesture::Started ) &&
1818       ( NULL != mImpl->mEventData ) )
1819   {
1820     if( !mImpl->IsShowingRealText() )
1821     {
1822       Event event( Event::LONG_PRESS_EVENT );
1823       event.p1.mInt = state;
1824       mImpl->mEventData->mEventQueue.push_back( event );
1825       mImpl->RequestRelayout();
1826     }
1827     else
1828     {
1829       // The 1st long-press on inactive text-field is treated as tap
1830       if( EventData::INACTIVE == mImpl->mEventData->mState )
1831       {
1832         mImpl->ChangeState( EventData::EDITING );
1833
1834         Event event( Event::TAP_EVENT );
1835         event.p1.mUint = 1;
1836         event.p2.mFloat = x;
1837         event.p3.mFloat = y;
1838         mImpl->mEventData->mEventQueue.push_back( event );
1839
1840         mImpl->RequestRelayout();
1841       }
1842       else if( !mImpl->IsClipboardVisible() )
1843       {
1844         // Reset the imf manger to commit the pre-edit before selecting the text.
1845         mImpl->ResetImfManager();
1846
1847         SelectEvent( x, y, false );
1848       }
1849     }
1850   }
1851 }
1852
1853 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1854 {
1855   // Whether the text needs to be relaid-out.
1856   bool requestRelayout = false;
1857
1858   // Whether to retrieve the text and cursor position to be sent to the IMF manager.
1859   bool retrieveText = false;
1860   bool retrieveCursor = false;
1861
1862   switch( imfEvent.eventName )
1863   {
1864     case ImfManager::COMMIT:
1865     {
1866       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1867       requestRelayout = true;
1868       retrieveCursor = true;
1869       break;
1870     }
1871     case ImfManager::PREEDIT:
1872     {
1873       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1874       requestRelayout = true;
1875       retrieveCursor = true;
1876       break;
1877     }
1878     case ImfManager::DELETESURROUNDING:
1879     {
1880       const bool textDeleted = RemoveText( imfEvent.cursorOffset,
1881                                            imfEvent.numberOfChars,
1882                                            DONT_UPDATE_INPUT_STYLE );
1883
1884       if( textDeleted )
1885       {
1886         if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
1887             !mImpl->IsPlaceholderAvailable() )
1888         {
1889           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1890         }
1891         else
1892         {
1893           ShowPlaceholderText();
1894         }
1895         mImpl->mEventData->mUpdateCursorPosition = true;
1896         mImpl->mEventData->mScrollAfterDelete = true;
1897
1898         requestRelayout = true;
1899       }
1900       break;
1901     }
1902     case ImfManager::GETSURROUNDING:
1903     {
1904       retrieveText = true;
1905       retrieveCursor = true;
1906       break;
1907     }
1908     case ImfManager::VOID:
1909     {
1910       // do nothing
1911       break;
1912     }
1913   } // end switch
1914
1915   if( requestRelayout )
1916   {
1917     mImpl->mOperationsPending = ALL_OPERATIONS;
1918     mImpl->RequestRelayout();
1919   }
1920
1921   std::string text;
1922   CharacterIndex cursorPosition = 0u;
1923   Length numberOfWhiteSpaces = 0u;
1924
1925   if( retrieveCursor )
1926   {
1927     numberOfWhiteSpaces = mImpl->GetNumberOfWhiteSpaces( 0u );
1928
1929     cursorPosition = mImpl->GetLogicalCursorPosition();
1930
1931     if( cursorPosition < numberOfWhiteSpaces )
1932     {
1933       cursorPosition = 0u;
1934     }
1935     else
1936     {
1937       cursorPosition -= numberOfWhiteSpaces;
1938     }
1939   }
1940
1941   if( retrieveText )
1942   {
1943     mImpl->GetText( numberOfWhiteSpaces, text );
1944   }
1945
1946   ImfManager::ImfCallbackData callbackData( ( retrieveText || retrieveCursor ), cursorPosition, text, false );
1947
1948   if( requestRelayout &&
1949       ( NULL != mImpl->mEditableControlInterface ) )
1950   {
1951     // Do this last since it provides callbacks into application code
1952     mImpl->mEditableControlInterface->TextChanged();
1953   }
1954
1955   return callbackData;
1956 }
1957
1958 void Controller::PasteClipboardItemEvent()
1959 {
1960   // Retrieve the clipboard contents first
1961   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
1962   std::string stringToPaste( notifier.GetContent() );
1963
1964   // Commit the current pre-edit text; the contents of the clipboard should be appended
1965   mImpl->ResetImfManager();
1966
1967   // Temporary disable hiding clipboard
1968   mImpl->SetClipboardHideEnable( false );
1969
1970   // Paste
1971   PasteText( stringToPaste );
1972
1973   mImpl->SetClipboardHideEnable( true );
1974 }
1975
1976 // protected : Inherit from Text::Decorator::ControllerInterface.
1977
1978 void Controller::GetTargetSize( Vector2& targetSize )
1979 {
1980   targetSize = mImpl->mVisualModel->mControlSize;
1981 }
1982
1983 void Controller::AddDecoration( Actor& actor, bool needsClipping )
1984 {
1985   if( NULL != mImpl->mEditableControlInterface )
1986   {
1987     mImpl->mEditableControlInterface->AddDecoration( actor, needsClipping );
1988   }
1989 }
1990
1991 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
1992 {
1993   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
1994
1995   if( NULL != mImpl->mEventData )
1996   {
1997     switch( handleType )
1998     {
1999       case GRAB_HANDLE:
2000       {
2001         Event event( Event::GRAB_HANDLE_EVENT );
2002         event.p1.mUint  = state;
2003         event.p2.mFloat = x;
2004         event.p3.mFloat = y;
2005
2006         mImpl->mEventData->mEventQueue.push_back( event );
2007         break;
2008       }
2009       case LEFT_SELECTION_HANDLE:
2010       {
2011         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
2012         event.p1.mUint  = state;
2013         event.p2.mFloat = x;
2014         event.p3.mFloat = y;
2015
2016         mImpl->mEventData->mEventQueue.push_back( event );
2017         break;
2018       }
2019       case RIGHT_SELECTION_HANDLE:
2020       {
2021         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
2022         event.p1.mUint  = state;
2023         event.p2.mFloat = x;
2024         event.p3.mFloat = y;
2025
2026         mImpl->mEventData->mEventQueue.push_back( event );
2027         break;
2028       }
2029       case LEFT_SELECTION_HANDLE_MARKER:
2030       case RIGHT_SELECTION_HANDLE_MARKER:
2031       {
2032         // Markers do not move the handles.
2033         break;
2034       }
2035       case HANDLE_TYPE_COUNT:
2036       {
2037         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
2038       }
2039     }
2040
2041     mImpl->RequestRelayout();
2042   }
2043 }
2044
2045 // protected : Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2046
2047 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
2048 {
2049   if( NULL == mImpl->mEventData )
2050   {
2051     return;
2052   }
2053
2054   switch( button )
2055   {
2056     case Toolkit::TextSelectionPopup::CUT:
2057     {
2058       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
2059       mImpl->mOperationsPending = ALL_OPERATIONS;
2060
2061       if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2062           !mImpl->IsPlaceholderAvailable() )
2063       {
2064         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2065       }
2066       else
2067       {
2068         ShowPlaceholderText();
2069       }
2070
2071       mImpl->mEventData->mUpdateCursorPosition = true;
2072       mImpl->mEventData->mScrollAfterDelete = true;
2073
2074       mImpl->RequestRelayout();
2075
2076       if( NULL != mImpl->mEditableControlInterface )
2077       {
2078         mImpl->mEditableControlInterface->TextChanged();
2079       }
2080       break;
2081     }
2082     case Toolkit::TextSelectionPopup::COPY:
2083     {
2084       mImpl->SendSelectionToClipboard( false ); // Text not modified
2085
2086       mImpl->mEventData->mUpdateCursorPosition = true;
2087
2088       mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
2089       break;
2090     }
2091     case Toolkit::TextSelectionPopup::PASTE:
2092     {
2093       mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
2094       break;
2095     }
2096     case Toolkit::TextSelectionPopup::SELECT:
2097     {
2098       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
2099
2100       if( mImpl->mEventData->mSelectionEnabled )
2101       {
2102         // Creates a SELECT event.
2103         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
2104       }
2105       break;
2106     }
2107     case Toolkit::TextSelectionPopup::SELECT_ALL:
2108     {
2109       // Creates a SELECT_ALL event
2110       SelectEvent( 0.f, 0.f, true );
2111       break;
2112     }
2113     case Toolkit::TextSelectionPopup::CLIPBOARD:
2114     {
2115       mImpl->ShowClipboard();
2116       break;
2117     }
2118     case Toolkit::TextSelectionPopup::NONE:
2119     {
2120       // Nothing to do.
2121       break;
2122     }
2123   }
2124 }
2125
2126 // private : Update.
2127
2128 void Controller::InsertText( const std::string& text, Controller::InsertType type )
2129 {
2130   bool removedPrevious( false );
2131   bool maxLengthReached( false );
2132
2133   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
2134
2135   if( NULL == mImpl->mEventData )
2136   {
2137     return;
2138   }
2139
2140   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
2141                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
2142                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2143
2144   // TODO: At the moment the underline runs are only for pre-edit.
2145   mImpl->mVisualModel->mUnderlineRuns.Clear();
2146
2147   // Keep the current number of characters.
2148   const Length currentNumberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2149
2150   // Remove the previous IMF pre-edit.
2151   if( mImpl->mEventData->mPreEditFlag && ( 0u != mImpl->mEventData->mPreEditLength ) )
2152   {
2153     removedPrevious = RemoveText( -static_cast<int>( mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition ),
2154                                   mImpl->mEventData->mPreEditLength,
2155                                   DONT_UPDATE_INPUT_STYLE );
2156
2157     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
2158     mImpl->mEventData->mPreEditLength = 0u;
2159   }
2160   else
2161   {
2162     // Remove the previous Selection.
2163     removedPrevious = RemoveSelectedText();
2164   }
2165
2166   Vector<Character> utf32Characters;
2167   Length characterCount = 0u;
2168
2169   if( !text.empty() )
2170   {
2171     //  Convert text into UTF-32
2172     utf32Characters.Resize( text.size() );
2173
2174     // This is a bit horrible but std::string returns a (signed) char*
2175     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
2176
2177     // Transform a text array encoded in utf8 into an array encoded in utf32.
2178     // It returns the actual number of characters.
2179     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
2180     utf32Characters.Resize( characterCount );
2181
2182     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
2183     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
2184   }
2185
2186   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
2187   {
2188     // The placeholder text is no longer needed
2189     if( mImpl->IsShowingPlaceholderText() )
2190     {
2191       ResetText();
2192     }
2193
2194     mImpl->ChangeState( EventData::EDITING );
2195
2196     // Handle the IMF (predicitive text) state changes
2197     if( COMMIT == type )
2198     {
2199       // IMF manager is no longer handling key-events
2200       mImpl->ClearPreEditFlag();
2201     }
2202     else // PRE_EDIT
2203     {
2204       if( !mImpl->mEventData->mPreEditFlag )
2205       {
2206         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state\n" );
2207
2208         // Record the start of the pre-edit text
2209         mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
2210       }
2211
2212       mImpl->mEventData->mPreEditLength = utf32Characters.Count();
2213       mImpl->mEventData->mPreEditFlag = true;
2214
2215       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2216     }
2217
2218     const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
2219
2220     // Restrict new text to fit within Maximum characters setting.
2221     Length maxSizeOfNewText = std::min( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
2222     maxLengthReached = ( characterCount > maxSizeOfNewText );
2223
2224     // The cursor position.
2225     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2226
2227     // Update the text's style.
2228
2229     // Updates the text style runs by adding characters.
2230     mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, maxSizeOfNewText );
2231
2232     // Get the character index from the cursor index.
2233     const CharacterIndex styleIndex = ( cursorIndex > 0u ) ? cursorIndex - 1u : 0u;
2234
2235     // Retrieve the text's style for the given index.
2236     InputStyle style;
2237     mImpl->RetrieveDefaultInputStyle( style );
2238     mImpl->mLogicalModel->RetrieveStyle( styleIndex, style );
2239
2240     // Whether to add a new text color run.
2241     const bool addColorRun = ( style.textColor != mImpl->mEventData->mInputStyle.textColor );
2242
2243     // Whether to add a new font run.
2244     const bool addFontNameRun = style.familyName != mImpl->mEventData->mInputStyle.familyName;
2245     const bool addFontWeightRun = style.weight != mImpl->mEventData->mInputStyle.weight;
2246     const bool addFontWidthRun = style.width != mImpl->mEventData->mInputStyle.width;
2247     const bool addFontSlantRun = style.slant != mImpl->mEventData->mInputStyle.slant;
2248     const bool addFontSizeRun = style.size != mImpl->mEventData->mInputStyle.size;
2249
2250     // Add style runs.
2251     if( addColorRun )
2252     {
2253       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
2254       mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
2255
2256       ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
2257       colorRun.color = mImpl->mEventData->mInputStyle.textColor;
2258       colorRun.characterRun.characterIndex = cursorIndex;
2259       colorRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2260     }
2261
2262     if( addFontNameRun   ||
2263         addFontWeightRun ||
2264         addFontWidthRun  ||
2265         addFontSlantRun  ||
2266         addFontSizeRun )
2267     {
2268       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mFontDescriptionRuns.Count();
2269       mImpl->mLogicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
2270
2271       FontDescriptionRun& fontDescriptionRun = *( mImpl->mLogicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
2272
2273       if( addFontNameRun )
2274       {
2275         fontDescriptionRun.familyLength = mImpl->mEventData->mInputStyle.familyName.size();
2276         fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
2277         memcpy( fontDescriptionRun.familyName, mImpl->mEventData->mInputStyle.familyName.c_str(), fontDescriptionRun.familyLength );
2278         fontDescriptionRun.familyDefined = true;
2279
2280         // The memory allocated for the font family name is freed when the font description is removed from the logical model.
2281       }
2282
2283       if( addFontWeightRun )
2284       {
2285         fontDescriptionRun.weight = mImpl->mEventData->mInputStyle.weight;
2286         fontDescriptionRun.weightDefined = true;
2287       }
2288
2289       if( addFontWidthRun )
2290       {
2291         fontDescriptionRun.width = mImpl->mEventData->mInputStyle.width;
2292         fontDescriptionRun.widthDefined = true;
2293       }
2294
2295       if( addFontSlantRun )
2296       {
2297         fontDescriptionRun.slant = mImpl->mEventData->mInputStyle.slant;
2298         fontDescriptionRun.slantDefined = true;
2299       }
2300
2301       if( addFontSizeRun )
2302       {
2303         fontDescriptionRun.size = static_cast<PointSize26Dot6>( mImpl->mEventData->mInputStyle.size * 64.f );
2304         fontDescriptionRun.sizeDefined = true;
2305       }
2306
2307       fontDescriptionRun.characterRun.characterIndex = cursorIndex;
2308       fontDescriptionRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2309     }
2310
2311     // Insert at current cursor position.
2312     Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
2313
2314     if( cursorIndex < numberOfCharactersInModel )
2315     {
2316       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2317     }
2318     else
2319     {
2320       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2321     }
2322
2323     // Mark the first paragraph to be updated.
2324     mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2325     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd += maxSizeOfNewText;
2326
2327     // Update the cursor index.
2328     cursorIndex += maxSizeOfNewText;
2329
2330     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
2331   }
2332
2333   const Length numberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2334
2335   if( ( 0u == mImpl->mLogicalModel->mText.Count() ) &&
2336       mImpl->IsPlaceholderAvailable() )
2337   {
2338     // Show place-holder if empty after removing the pre-edit text
2339     ShowPlaceholderText();
2340     mImpl->mEventData->mUpdateCursorPosition = true;
2341     mImpl->ClearPreEditFlag();
2342   }
2343   else if( removedPrevious ||
2344            ( 0 != utf32Characters.Count() ) )
2345   {
2346     // Queue an inserted event
2347     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
2348
2349     mImpl->mEventData->mUpdateCursorPosition = true;
2350     if( numberOfCharacters < currentNumberOfCharacters )
2351     {
2352       mImpl->mEventData->mScrollAfterDelete = true;
2353     }
2354     else
2355     {
2356       mImpl->mEventData->mScrollAfterUpdatePosition = true;
2357     }
2358   }
2359
2360   if( maxLengthReached )
2361   {
2362     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
2363
2364     mImpl->ResetImfManager();
2365
2366     if( NULL != mImpl->mEditableControlInterface )
2367     {
2368       // Do this last since it provides callbacks into application code
2369       mImpl->mEditableControlInterface->MaxLengthReached();
2370     }
2371   }
2372 }
2373
2374 void Controller::PasteText( const std::string& stringToPaste )
2375 {
2376   InsertText( stringToPaste, Text::Controller::COMMIT );
2377   mImpl->ChangeState( EventData::EDITING );
2378   mImpl->RequestRelayout();
2379
2380   if( NULL != mImpl->mEditableControlInterface )
2381   {
2382     // Do this last since it provides callbacks into application code
2383     mImpl->mEditableControlInterface->TextChanged();
2384   }
2385 }
2386
2387 bool Controller::RemoveText( int cursorOffset,
2388                              int numberOfCharacters,
2389                              UpdateInputStyleType type )
2390 {
2391   bool removed = false;
2392
2393   if( NULL == mImpl->mEventData )
2394   {
2395     return removed;
2396   }
2397
2398   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfCharacters %d\n",
2399                  this, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfCharacters );
2400
2401   if( !mImpl->IsShowingPlaceholderText() )
2402   {
2403     // Delete at current cursor position
2404     Vector<Character>& currentText = mImpl->mLogicalModel->mText;
2405     CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2406
2407     CharacterIndex cursorIndex = oldCursorIndex;
2408
2409     // Validate the cursor position & number of characters
2410     if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
2411     {
2412       cursorIndex = oldCursorIndex + cursorOffset;
2413     }
2414
2415     if( ( cursorIndex + numberOfCharacters ) > currentText.Count() )
2416     {
2417       numberOfCharacters = currentText.Count() - cursorIndex;
2418     }
2419
2420     if( ( cursorIndex + numberOfCharacters ) <= mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters )
2421     {
2422       // Mark the paragraphs to be updated.
2423       mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2424       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove += numberOfCharacters;
2425
2426       // Update the input style and remove the text's style before removing the text.
2427
2428       if( UPDATE_INPUT_STYLE == type )
2429       {
2430         // Keep a copy of the current input style.
2431         InputStyle currentInputStyle;
2432         currentInputStyle.Copy( mImpl->mEventData->mInputStyle );
2433
2434         // Set first the default input style.
2435         mImpl->RetrieveDefaultInputStyle( mImpl->mEventData->mInputStyle );
2436
2437         // Update the input style.
2438         mImpl->mLogicalModel->RetrieveStyle( cursorIndex, mImpl->mEventData->mInputStyle );
2439
2440         // Compare if the input style has changed.
2441         const bool hasInputStyleChanged = !currentInputStyle.Equal( mImpl->mEventData->mInputStyle );
2442
2443         if( hasInputStyleChanged )
2444         {
2445           const InputStyle::Mask styleChangedMask = currentInputStyle.GetInputStyleChangeMask( mImpl->mEventData->mInputStyle );
2446           // Queue the input style changed signal.
2447           mImpl->mEventData->mInputStyleChangedQueue.PushBack( styleChangedMask );
2448         }
2449       }
2450
2451       // Updates the text style runs by removing characters. Runs with no characters are removed.
2452       mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, -numberOfCharacters );
2453
2454       // Remove the characters.
2455       Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
2456       Vector<Character>::Iterator last  = first + numberOfCharacters;
2457
2458       currentText.Erase( first, last );
2459
2460       // Cursor position retreat
2461       oldCursorIndex = cursorIndex;
2462
2463       mImpl->mEventData->mScrollAfterDelete = true;
2464
2465       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfCharacters );
2466       removed = true;
2467     }
2468   }
2469
2470   return removed;
2471 }
2472
2473 bool Controller::RemoveSelectedText()
2474 {
2475   bool textRemoved( false );
2476
2477   if( EventData::SELECTING == mImpl->mEventData->mState )
2478   {
2479     std::string removedString;
2480     mImpl->RetrieveSelection( removedString, true );
2481
2482     if( !removedString.empty() )
2483     {
2484       textRemoved = true;
2485       mImpl->ChangeState( EventData::EDITING );
2486     }
2487   }
2488
2489   return textRemoved;
2490 }
2491
2492 // private : Relayout.
2493
2494 bool Controller::DoRelayout( const Size& size,
2495                              OperationsMask operationsRequired,
2496                              Size& layoutSize )
2497 {
2498   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
2499   bool viewUpdated( false );
2500
2501   // Calculate the operations to be done.
2502   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
2503
2504   const CharacterIndex startIndex = mImpl->mTextUpdateInfo.mParagraphCharacterIndex;
2505   const Length requestedNumberOfCharacters = mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters;
2506
2507   // Get the current layout size.
2508   layoutSize = mImpl->mVisualModel->GetLayoutSize();
2509
2510   if( NO_OPERATION != ( LAYOUT & operations ) )
2511   {
2512     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
2513
2514     // Some vectors with data needed to layout and reorder may be void
2515     // after the first time the text has been laid out.
2516     // Fill the vectors again.
2517
2518     // Calculate the number of glyphs to layout.
2519     const Vector<GlyphIndex>& charactersToGlyph = mImpl->mVisualModel->mCharactersToGlyph;
2520     const Vector<Length>& glyphsPerCharacter = mImpl->mVisualModel->mGlyphsPerCharacter;
2521     const GlyphIndex* const charactersToGlyphBuffer = charactersToGlyph.Begin();
2522     const Length* const glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
2523
2524     const CharacterIndex lastIndex = startIndex + ( ( requestedNumberOfCharacters > 0u ) ? requestedNumberOfCharacters - 1u : 0u );
2525     const GlyphIndex startGlyphIndex = mImpl->mTextUpdateInfo.mStartGlyphIndex;
2526     const Length numberOfGlyphs = ( requestedNumberOfCharacters > 0u ) ? *( charactersToGlyphBuffer + lastIndex ) + *( glyphsPerCharacterBuffer + lastIndex ) - startGlyphIndex : 0u;
2527     const Length totalNumberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
2528
2529     if( 0u == totalNumberOfGlyphs )
2530     {
2531       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2532       {
2533         mImpl->mVisualModel->SetLayoutSize( Size::ZERO );
2534       }
2535
2536       // Nothing else to do if there is no glyphs.
2537       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
2538       return true;
2539     }
2540
2541     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
2542     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
2543     const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
2544     const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
2545     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
2546     const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
2547     const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
2548
2549     // Set the layout parameters.
2550     LayoutParameters layoutParameters( size,
2551                                        textBuffer,
2552                                        lineBreakInfo.Begin(),
2553                                        wordBreakInfo.Begin(),
2554                                        ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
2555                                        glyphs.Begin(),
2556                                        glyphsToCharactersMap.Begin(),
2557                                        charactersPerGlyph.Begin(),
2558                                        charactersToGlyphBuffer,
2559                                        glyphsPerCharacterBuffer,
2560                                        totalNumberOfGlyphs );
2561
2562     // Resize the vector of positions to have the same size than the vector of glyphs.
2563     Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
2564     glyphPositions.Resize( totalNumberOfGlyphs );
2565
2566     // Whether the last character is a new paragraph character.
2567     mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph =  TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
2568     layoutParameters.isLastNewParagraph = mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph;
2569
2570     // The initial glyph and the number of glyphs to layout.
2571     layoutParameters.startGlyphIndex = startGlyphIndex;
2572     layoutParameters.numberOfGlyphs = numberOfGlyphs;
2573     layoutParameters.startLineIndex = mImpl->mTextUpdateInfo.mStartLineIndex;
2574     layoutParameters.estimatedNumberOfLines = mImpl->mTextUpdateInfo.mEstimatedNumberOfLines;
2575
2576     // Update the visual model.
2577     Size newLayoutSize;
2578     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
2579                                                    glyphPositions,
2580                                                    mImpl->mVisualModel->mLines,
2581                                                    newLayoutSize );
2582
2583     viewUpdated = viewUpdated || ( newLayoutSize != layoutSize );
2584
2585     if( viewUpdated )
2586     {
2587       layoutSize = newLayoutSize;
2588
2589       if ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) )
2590       {
2591         mImpl->mAutoScrollDirectionRTL = false;
2592       }
2593
2594       // Reorder the lines
2595       if( NO_OPERATION != ( REORDER & operations ) )
2596       {
2597         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
2598         Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = mImpl->mLogicalModel->mBidirectionalLineInfo;
2599
2600         // Check first if there are paragraphs with bidirectional info.
2601         if( 0u != bidirectionalInfo.Count() )
2602         {
2603           // Get the lines
2604           const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
2605
2606           // Reorder the lines.
2607           bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
2608           ReorderLines( bidirectionalInfo,
2609                         startIndex,
2610                         requestedNumberOfCharacters,
2611                         mImpl->mVisualModel->mLines,
2612                         bidirectionalLineInfo );
2613
2614           // Set the bidirectional info per line into the layout parameters.
2615           layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
2616           layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
2617
2618           // Re-layout the text. Reorder those lines with right to left characters.
2619           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
2620                                                          startIndex,
2621                                                          requestedNumberOfCharacters,
2622                                                          glyphPositions );
2623
2624           if ( ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) ) && ( numberOfLines > 0 ) )
2625           {
2626             const LineRun* const firstline = mImpl->mVisualModel->mLines.Begin();
2627             if ( firstline )
2628             {
2629               mImpl->mAutoScrollDirectionRTL = firstline->direction;
2630             }
2631           }
2632         }
2633       } // REORDER
2634
2635       // Sets the layout size.
2636       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2637       {
2638         mImpl->mVisualModel->SetLayoutSize( layoutSize );
2639       }
2640     } // view updated
2641
2642     // Store the size used to layout the text.
2643     mImpl->mVisualModel->mControlSize = size;
2644   }
2645
2646   if( NO_OPERATION != ( ALIGN & operations ) )
2647   {
2648     // The laid-out lines.
2649     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
2650
2651     mImpl->mLayoutEngine.Align( size,
2652                                 startIndex,
2653                                 requestedNumberOfCharacters,
2654                                 lines );
2655
2656     viewUpdated = true;
2657   }
2658 #if defined(DEBUG_ENABLED)
2659   std::string currentText;
2660   GetText( currentText );
2661   DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mAutoScrollDirectionRTL[%s] [%s]\n", this, (mImpl->mAutoScrollDirectionRTL)?"true":"false",  currentText.c_str() );
2662 #endif
2663   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
2664   return viewUpdated;
2665 }
2666
2667 void Controller::CalculateVerticalOffset( const Size& controlSize )
2668 {
2669   Size layoutSize = mImpl->mVisualModel->GetLayoutSize();
2670
2671   if( fabsf( layoutSize.height ) < Math::MACHINE_EPSILON_1000 )
2672   {
2673     // Get the line height of the default font.
2674     layoutSize.height = mImpl->GetDefaultFontLineHeight();
2675   }
2676
2677   switch( mImpl->mLayoutEngine.GetVerticalAlignment() )
2678   {
2679     case LayoutEngine::VERTICAL_ALIGN_TOP:
2680     {
2681       mImpl->mScrollPosition.y = 0.f;
2682       break;
2683     }
2684     case LayoutEngine::VERTICAL_ALIGN_CENTER:
2685     {
2686       mImpl->mScrollPosition.y = floorf( 0.5f * ( controlSize.height - layoutSize.height ) ); // try to avoid pixel alignment.
2687       break;
2688     }
2689     case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
2690     {
2691       mImpl->mScrollPosition.y = controlSize.height - layoutSize.height;
2692       break;
2693     }
2694   }
2695 }
2696
2697 // private : Events.
2698
2699 void Controller::ProcessModifyEvents()
2700 {
2701   Vector<ModifyEvent>& events = mImpl->mModifyEvents;
2702
2703   if( 0u == events.Count() )
2704   {
2705     // Nothing to do.
2706     return;
2707   }
2708
2709   for( Vector<ModifyEvent>::ConstIterator it = events.Begin(),
2710          endIt = events.End();
2711        it != endIt;
2712        ++it )
2713   {
2714     const ModifyEvent& event = *it;
2715
2716     if( ModifyEvent::TEXT_REPLACED == event.type )
2717     {
2718       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
2719       DALI_ASSERT_DEBUG( it == events.Begin() && "Unexpected TEXT_REPLACED event" );
2720
2721       TextReplacedEvent();
2722     }
2723     else if( ModifyEvent::TEXT_INSERTED == event.type )
2724     {
2725       TextInsertedEvent();
2726     }
2727     else if( ModifyEvent::TEXT_DELETED == event.type )
2728     {
2729       // Placeholder-text cannot be deleted
2730       if( !mImpl->IsShowingPlaceholderText() )
2731       {
2732         TextDeletedEvent();
2733       }
2734     }
2735   }
2736
2737   if( NULL != mImpl->mEventData )
2738   {
2739     // When the text is being modified, delay cursor blinking
2740     mImpl->mEventData->mDecorator->DelayCursorBlink();
2741   }
2742
2743   // Discard temporary text
2744   events.Clear();
2745 }
2746
2747 void Controller::TextReplacedEvent()
2748 {
2749   // The natural size needs to be re-calculated.
2750   mImpl->mRecalculateNaturalSize = true;
2751
2752   // Apply modifications to the model
2753   mImpl->mOperationsPending = ALL_OPERATIONS;
2754 }
2755
2756 void Controller::TextInsertedEvent()
2757 {
2758   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
2759
2760   if( NULL == mImpl->mEventData )
2761   {
2762     return;
2763   }
2764
2765   // The natural size needs to be re-calculated.
2766   mImpl->mRecalculateNaturalSize = true;
2767
2768   // Apply modifications to the model; TODO - Optimize this
2769   mImpl->mOperationsPending = ALL_OPERATIONS;
2770 }
2771
2772 void Controller::TextDeletedEvent()
2773 {
2774   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
2775
2776   if( NULL == mImpl->mEventData )
2777   {
2778     return;
2779   }
2780
2781   // The natural size needs to be re-calculated.
2782   mImpl->mRecalculateNaturalSize = true;
2783
2784   // Apply modifications to the model; TODO - Optimize this
2785   mImpl->mOperationsPending = ALL_OPERATIONS;
2786 }
2787
2788 void Controller::SelectEvent( float x, float y, bool selectAll )
2789 {
2790   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SelectEvent\n" );
2791
2792   if( NULL != mImpl->mEventData )
2793   {
2794     if( selectAll )
2795     {
2796       Event event( Event::SELECT_ALL );
2797       mImpl->mEventData->mEventQueue.push_back( event );
2798     }
2799     else
2800     {
2801       Event event( Event::SELECT );
2802       event.p2.mFloat = x;
2803       event.p3.mFloat = y;
2804       mImpl->mEventData->mEventQueue.push_back( event );
2805     }
2806
2807     mImpl->RequestRelayout();
2808   }
2809 }
2810
2811 bool Controller::BackspaceKeyEvent()
2812 {
2813   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
2814
2815   bool removed = false;
2816
2817   if( NULL == mImpl->mEventData )
2818   {
2819     return removed;
2820   }
2821
2822   // IMF manager is no longer handling key-events
2823   mImpl->ClearPreEditFlag();
2824
2825   if( EventData::SELECTING == mImpl->mEventData->mState )
2826   {
2827     removed = RemoveSelectedText();
2828   }
2829   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
2830   {
2831     // Remove the character before the current cursor position
2832     removed = RemoveText( -1,
2833                           1,
2834                           UPDATE_INPUT_STYLE );
2835   }
2836
2837   if( removed )
2838   {
2839     if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2840         !mImpl->IsPlaceholderAvailable() )
2841     {
2842       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2843     }
2844     else
2845     {
2846       ShowPlaceholderText();
2847     }
2848     mImpl->mEventData->mUpdateCursorPosition = true;
2849     mImpl->mEventData->mScrollAfterDelete = true;
2850   }
2851
2852   return removed;
2853 }
2854
2855 // private : Helpers.
2856
2857 void Controller::ResetText()
2858 {
2859   // Reset buffers.
2860   mImpl->mLogicalModel->mText.Clear();
2861
2862   // We have cleared everything including the placeholder-text
2863   mImpl->PlaceholderCleared();
2864
2865   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2866   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2867   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = 0u;
2868
2869   // Clear any previous text.
2870   mImpl->mTextUpdateInfo.mClearAll = true;
2871
2872   // The natural size needs to be re-calculated.
2873   mImpl->mRecalculateNaturalSize = true;
2874
2875   // Apply modifications to the model
2876   mImpl->mOperationsPending = ALL_OPERATIONS;
2877 }
2878
2879 void Controller::ShowPlaceholderText()
2880 {
2881   if( mImpl->IsPlaceholderAvailable() )
2882   {
2883     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
2884
2885     if( NULL == mImpl->mEventData )
2886     {
2887       return;
2888     }
2889
2890     mImpl->mEventData->mIsShowingPlaceholderText = true;
2891
2892     // Disable handles when showing place-holder text
2893     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
2894     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
2895     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
2896
2897     const char* text( NULL );
2898     size_t size( 0 );
2899
2900     // TODO - Switch placeholder text styles when changing state
2901     if( ( EventData::INACTIVE != mImpl->mEventData->mState ) &&
2902         ( 0u != mImpl->mEventData->mPlaceholderTextActive.c_str() ) )
2903     {
2904       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
2905       size = mImpl->mEventData->mPlaceholderTextActive.size();
2906     }
2907     else
2908     {
2909       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
2910       size = mImpl->mEventData->mPlaceholderTextInactive.size();
2911     }
2912
2913     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2914     mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2915
2916     // Reset model for showing placeholder.
2917     mImpl->mLogicalModel->mText.Clear();
2918     mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
2919
2920     // Convert text into UTF-32
2921     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
2922     utf32Characters.Resize( size );
2923
2924     // This is a bit horrible but std::string returns a (signed) char*
2925     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
2926
2927     // Transform a text array encoded in utf8 into an array encoded in utf32.
2928     // It returns the actual number of characters.
2929     const Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
2930     utf32Characters.Resize( characterCount );
2931
2932     // The characters to be added.
2933     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = characterCount;
2934
2935     // Reset the cursor position
2936     mImpl->mEventData->mPrimaryCursorPosition = 0;
2937
2938     // The natural size needs to be re-calculated.
2939     mImpl->mRecalculateNaturalSize = true;
2940
2941     // Apply modifications to the model
2942     mImpl->mOperationsPending = ALL_OPERATIONS;
2943
2944     // Update the rest of the model during size negotiation
2945     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
2946   }
2947 }
2948
2949 void Controller::ClearFontData()
2950 {
2951   if( mImpl->mFontDefaults )
2952   {
2953     mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
2954   }
2955
2956   // Set flags to update the model.
2957   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2958   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2959   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
2960
2961   mImpl->mTextUpdateInfo.mClearAll = true;
2962   mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
2963   mImpl->mRecalculateNaturalSize = true;
2964
2965   mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
2966                                                            VALIDATE_FONTS            |
2967                                                            SHAPE_TEXT                |
2968                                                            GET_GLYPH_METRICS         |
2969                                                            LAYOUT                    |
2970                                                            UPDATE_LAYOUT_SIZE        |
2971                                                            REORDER                   |
2972                                                            ALIGN );
2973 }
2974
2975 void Controller::ClearStyleData()
2976 {
2977   mImpl->mLogicalModel->mColorRuns.Clear();
2978   mImpl->mLogicalModel->ClearFontDescriptionRuns();
2979 }
2980
2981 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
2982 {
2983   // Reset the cursor position
2984   if( NULL != mImpl->mEventData )
2985   {
2986     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
2987
2988     // Update the cursor if it's in editing mode.
2989     if( EventData::IsEditingState( mImpl->mEventData->mState )  )
2990     {
2991       mImpl->mEventData->mUpdateCursorPosition = true;
2992     }
2993   }
2994 }
2995
2996 void Controller::ResetScrollPosition()
2997 {
2998   if( NULL != mImpl->mEventData )
2999   {
3000     // Reset the scroll position.
3001     mImpl->mScrollPosition = Vector2::ZERO;
3002     mImpl->mEventData->mScrollAfterUpdatePosition = true;
3003   }
3004 }
3005
3006 // private : Private contructors & copy operator.
3007
3008 Controller::Controller()
3009 : mImpl( NULL )
3010 {
3011   mImpl = new Controller::Impl( NULL, NULL );
3012 }
3013
3014 Controller::Controller( ControlInterface* controlInterface )
3015 {
3016   mImpl = new Controller::Impl( controlInterface, NULL );
3017 }
3018
3019 Controller::Controller( ControlInterface* controlInterface,
3020                         EditableControlInterface* editableControlInterface )
3021 {
3022   mImpl = new Controller::Impl( controlInterface,
3023                                 editableControlInterface );
3024 }
3025
3026 // The copy constructor and operator are left unimplemented.
3027
3028 // protected : Destructor.
3029
3030 Controller::~Controller()
3031 {
3032   delete mImpl;
3033 }
3034
3035 } // namespace Text
3036
3037 } // namespace Toolkit
3038
3039 } // namespace Dali