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::SetDefaultShadowProperties( const std::string& shadowProperties )
 762 {
 763   if( NULL == mImpl->mShadowDefaults )
 764   {
 765     mImpl->mShadowDefaults = new ShadowDefaults();
 766   }
 767
 768   mImpl->mShadowDefaults->properties = shadowProperties;
 769 }
 770
 771 const std::string& Controller::GetDefaultShadowProperties() const
 772 {
 773   if( NULL != mImpl->mShadowDefaults )
 774   {
 775     return mImpl->mShadowDefaults->properties;
 776   }
 777
 778   return EMPTY_STRING;
 779 }
 780
 781 void Controller::SetUnderlineColor( const Vector4& color )
 782 {
 783   mImpl->mVisualModel->SetUnderlineColor( color );
 784
 785   mImpl->RequestRelayout();
 786 }
 787
 788 const Vector4& Controller::GetUnderlineColor() const
 789 {
 790   return mImpl->mVisualModel->GetUnderlineColor();
 791 }
 792
 793 void Controller::SetUnderlineEnabled( bool enabled )
 794 {
 795   mImpl->mVisualModel->SetUnderlineEnabled( enabled );
 796
 797   mImpl->RequestRelayout();
 798 }
 799
 800 bool Controller::IsUnderlineEnabled() const
 801 {
 802   return mImpl->mVisualModel->IsUnderlineEnabled();
 803 }
 804
 805 void Controller::SetUnderlineHeight( float height )
 806 {
 807   mImpl->mVisualModel->SetUnderlineHeight( height );
 808
 809   mImpl->RequestRelayout();
 810 }
 811
 812 float Controller::GetUnderlineHeight() const
 813 {
 814   return mImpl->mVisualModel->GetUnderlineHeight();
 815 }
 816
 817 void Controller::SetDefaultUnderlineProperties( const std::string& underlineProperties )
 818 {
 819   if( NULL == mImpl->mUnderlineDefaults )
 820   {
 821     mImpl->mUnderlineDefaults = new UnderlineDefaults();
 822   }
 823
 824   mImpl->mUnderlineDefaults->properties = underlineProperties;
 825 }
 826
 827 const std::string& Controller::GetDefaultUnderlineProperties() const
 828 {
 829   if( NULL != mImpl->mUnderlineDefaults )
 830   {
 831     return mImpl->mUnderlineDefaults->properties;
 832   }
 833
 834   return EMPTY_STRING;
 835 }
 836
 837 void Controller::SetDefaultEmbossProperties( const std::string& embossProperties )
 838 {
 839   if( NULL == mImpl->mEmbossDefaults )
 840   {
 841     mImpl->mEmbossDefaults = new EmbossDefaults();
 842   }
 843
 844   mImpl->mEmbossDefaults->properties = embossProperties;
 845 }
 846
 847 const std::string& Controller::GetDefaultEmbossProperties() const
 848 {
 849   if( NULL != mImpl->mEmbossDefaults )
 850   {
 851     return mImpl->mEmbossDefaults->properties;
 852   }
 853
 854   return EMPTY_STRING;
 855 }
 856
 857 void Controller::SetDefaultOutlineProperties( const std::string& outlineProperties )
 858 {
 859   if( NULL == mImpl->mOutlineDefaults )
 860   {
 861     mImpl->mOutlineDefaults = new OutlineDefaults();
 862   }
 863
 864   mImpl->mOutlineDefaults->properties = outlineProperties;
 865 }
 866
 867 const std::string& Controller::GetDefaultOutlineProperties() const
 868 {
 869   if( NULL != mImpl->mOutlineDefaults )
 870   {
 871     return mImpl->mOutlineDefaults->properties;
 872   }
 873
 874   return EMPTY_STRING;
 875 }
 876
 877 void Controller::SetDefaultLineSpacing( float lineSpacing )
 878 {
 879   //TODO finish implementation
 880   mImpl->mLayoutEngine.SetDefaultLineSpacing( lineSpacing );
 881 }
 882
 883 float Controller::GetDefaultLineSpacing() const
 884 {
 885   return mImpl->mLayoutEngine.GetDefaultLineSpacing();
 886 }
 887
 888 void Controller::SetInputColor( const Vector4& color )
 889 {
 890   if( NULL != mImpl->mEventData )
 891   {
 892     mImpl->mEventData->mInputStyle.textColor = color;
 893     mImpl->mEventData->mInputStyle.isDefaultColor = false;
 894
 895     if( EventData::SELECTING == mImpl->mEventData->mState )
 896     {
 897       const bool handlesCrossed = mImpl->mEventData->mLeftSelectionPosition > mImpl->mEventData->mRightSelectionPosition;
 898
 899       // Get start and end position of selection
 900       const CharacterIndex startOfSelectedText = handlesCrossed ? mImpl->mEventData->mRightSelectionPosition : mImpl->mEventData->mLeftSelectionPosition;
 901       const Length lengthOfSelectedText = ( handlesCrossed ? mImpl->mEventData->mLeftSelectionPosition : mImpl->mEventData->mRightSelectionPosition ) - startOfSelectedText;
 902
 903       // Add the color run.
 904       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
 905       mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
 906
 907       ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
 908       colorRun.color = color;
 909       colorRun.characterRun.characterIndex = startOfSelectedText;
 910       colorRun.characterRun.numberOfCharacters = lengthOfSelectedText;
 911
 912       // Request to relayout.
 913       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | COLOR );
 914       mImpl->RequestRelayout();
 915
 916       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 917       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 918       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 919     }
 920   }
 921 }
 922
 923 const Vector4& Controller::GetInputColor() const
 924 {
 925   if( NULL != mImpl->mEventData )
 926   {
 927     return mImpl->mEventData->mInputStyle.textColor;
 928   }
 929
 930   // Return the default text's color if there is no EventData.
 931   return mImpl->mTextColor;
 932
 933 }
 934
 935 void Controller::SetInputFontFamily( const std::string& fontFamily )
 936 {
 937   if( NULL != mImpl->mEventData )
 938   {
 939     mImpl->mEventData->mInputStyle.familyName = fontFamily;
 940     mImpl->mEventData->mInputStyle.isFamilyDefined = true;
 941
 942     if( EventData::SELECTING == mImpl->mEventData->mState )
 943     {
 944       CharacterIndex startOfSelectedText = 0u;
 945       Length lengthOfSelectedText = 0u;
 946       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
 947                                                                             mImpl->mLogicalModel,
 948                                                                             startOfSelectedText,
 949                                                                             lengthOfSelectedText );
 950
 951       fontDescriptionRun.familyLength = fontFamily.size();
 952       fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
 953       memcpy( fontDescriptionRun.familyName, fontFamily.c_str(), fontDescriptionRun.familyLength );
 954       fontDescriptionRun.familyDefined = true;
 955
 956       // The memory allocated for the font family name is freed when the font description is removed from the logical model.
 957
 958       // Request to relayout.
 959       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 960                                                                VALIDATE_FONTS            |
 961                                                                SHAPE_TEXT                |
 962                                                                GET_GLYPH_METRICS         |
 963                                                                LAYOUT                    |
 964                                                                UPDATE_LAYOUT_SIZE        |
 965                                                                REORDER                   |
 966                                                                ALIGN );
 967       mImpl->mRecalculateNaturalSize = true;
 968       mImpl->RequestRelayout();
 969
 970       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 971       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 972       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 973
 974       // As the font changes, recalculate the handle positions is needed.
 975       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
 976       mImpl->mEventData->mUpdateRightSelectionPosition = true;
 977       mImpl->mEventData->mUpdateHighlightBox = true;
 978       mImpl->mEventData->mScrollAfterUpdatePosition = true;
 979     }
 980   }
 981 }
 982
 983 const std::string& Controller::GetInputFontFamily() const
 984 {
 985   if( NULL != mImpl->mEventData )
 986   {
 987     return mImpl->mEventData->mInputStyle.familyName;
 988   }
 989
 990   // Return the default font's family if there is no EventData.
 991   return GetDefaultFontFamily();
 992 }
 993
 994 void Controller::SetInputFontWeight( FontWeight weight )
 995 {
 996   if( NULL != mImpl->mEventData )
 997   {
 998     mImpl->mEventData->mInputStyle.weight = weight;
 999     mImpl->mEventData->mInputStyle.isWeightDefined = true;
1000
1001     if( EventData::SELECTING == mImpl->mEventData->mState )
1002     {
1003       CharacterIndex startOfSelectedText = 0u;
1004       Length lengthOfSelectedText = 0u;
1005       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1006                                                                             mImpl->mLogicalModel,
1007                                                                             startOfSelectedText,
1008                                                                             lengthOfSelectedText );
1009
1010       fontDescriptionRun.weight = weight;
1011       fontDescriptionRun.weightDefined = true;
1012
1013       // Request to relayout.
1014       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1015                                                                VALIDATE_FONTS            |
1016                                                                SHAPE_TEXT                |
1017                                                                GET_GLYPH_METRICS         |
1018                                                                LAYOUT                    |
1019                                                                UPDATE_LAYOUT_SIZE        |
1020                                                                REORDER                   |
1021                                                                ALIGN );
1022       mImpl->mRecalculateNaturalSize = true;
1023       mImpl->RequestRelayout();
1024
1025       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1026       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1027       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1028
1029       // As the font might change, recalculate the handle positions is needed.
1030       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1031       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1032       mImpl->mEventData->mUpdateHighlightBox = true;
1033       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1034     }
1035   }
1036 }
1037
1038 bool Controller::IsInputFontWeightDefined() const
1039 {
1040   bool defined = false;
1041
1042   if( NULL != mImpl->mEventData )
1043   {
1044     defined = mImpl->mEventData->mInputStyle.isWeightDefined;
1045   }
1046
1047   return defined;
1048 }
1049
1050 FontWeight Controller::GetInputFontWeight() const
1051 {
1052   if( NULL != mImpl->mEventData )
1053   {
1054     return mImpl->mEventData->mInputStyle.weight;
1055   }
1056
1057   return GetDefaultFontWeight();
1058 }
1059
1060 void Controller::SetInputFontWidth( FontWidth width )
1061 {
1062   if( NULL != mImpl->mEventData )
1063   {
1064     mImpl->mEventData->mInputStyle.width = width;
1065     mImpl->mEventData->mInputStyle.isWidthDefined = true;
1066
1067     if( EventData::SELECTING == mImpl->mEventData->mState )
1068     {
1069       CharacterIndex startOfSelectedText = 0u;
1070       Length lengthOfSelectedText = 0u;
1071       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1072                                                                             mImpl->mLogicalModel,
1073                                                                             startOfSelectedText,
1074                                                                             lengthOfSelectedText );
1075
1076       fontDescriptionRun.width = width;
1077       fontDescriptionRun.widthDefined = true;
1078
1079       // Request to relayout.
1080       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1081                                                                VALIDATE_FONTS            |
1082                                                                SHAPE_TEXT                |
1083                                                                GET_GLYPH_METRICS         |
1084                                                                LAYOUT                    |
1085                                                                UPDATE_LAYOUT_SIZE        |
1086                                                                REORDER                   |
1087                                                                ALIGN );
1088       mImpl->mRecalculateNaturalSize = true;
1089       mImpl->RequestRelayout();
1090
1091       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1092       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1093       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1094
1095       // As the font might change, recalculate the handle positions is needed.
1096       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1097       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1098       mImpl->mEventData->mUpdateHighlightBox = true;
1099       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1100     }
1101   }
1102 }
1103
1104 bool Controller::IsInputFontWidthDefined() const
1105 {
1106   bool defined = false;
1107
1108   if( NULL != mImpl->mEventData )
1109   {
1110     defined = mImpl->mEventData->mInputStyle.isWidthDefined;
1111   }
1112
1113   return defined;
1114 }
1115
1116 FontWidth Controller::GetInputFontWidth() const
1117 {
1118   if( NULL != mImpl->mEventData )
1119   {
1120     return mImpl->mEventData->mInputStyle.width;
1121   }
1122
1123   return GetDefaultFontWidth();
1124 }
1125
1126 void Controller::SetInputFontSlant( FontSlant slant )
1127 {
1128   if( NULL != mImpl->mEventData )
1129   {
1130     mImpl->mEventData->mInputStyle.slant = slant;
1131     mImpl->mEventData->mInputStyle.isSlantDefined = true;
1132
1133     if( EventData::SELECTING == mImpl->mEventData->mState )
1134     {
1135       CharacterIndex startOfSelectedText = 0u;
1136       Length lengthOfSelectedText = 0u;
1137       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1138                                                                             mImpl->mLogicalModel,
1139                                                                             startOfSelectedText,
1140                                                                             lengthOfSelectedText );
1141
1142       fontDescriptionRun.slant = slant;
1143       fontDescriptionRun.slantDefined = true;
1144
1145       // Request to relayout.
1146       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1147                                                                VALIDATE_FONTS            |
1148                                                                SHAPE_TEXT                |
1149                                                                GET_GLYPH_METRICS         |
1150                                                                LAYOUT                    |
1151                                                                UPDATE_LAYOUT_SIZE        |
1152                                                                REORDER                   |
1153                                                                ALIGN );
1154       mImpl->mRecalculateNaturalSize = true;
1155       mImpl->RequestRelayout();
1156
1157       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1158       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1159       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1160
1161       // As the font might change, recalculate the handle positions is needed.
1162       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1163       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1164       mImpl->mEventData->mUpdateHighlightBox = true;
1165       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1166     }
1167   }
1168 }
1169
1170 bool Controller::IsInputFontSlantDefined() const
1171 {
1172   bool defined = false;
1173
1174   if( NULL != mImpl->mEventData )
1175   {
1176     defined = mImpl->mEventData->mInputStyle.isSlantDefined;
1177   }
1178
1179   return defined;
1180 }
1181
1182 FontSlant Controller::GetInputFontSlant() const
1183 {
1184   if( NULL != mImpl->mEventData )
1185   {
1186     return mImpl->mEventData->mInputStyle.slant;
1187   }
1188
1189   return GetDefaultFontSlant();
1190 }
1191
1192 void Controller::SetInputFontPointSize( float size )
1193 {
1194   if( NULL != mImpl->mEventData )
1195   {
1196     mImpl->mEventData->mInputStyle.size = size;
1197     mImpl->mEventData->mInputStyle.isSizeDefined = true;
1198
1199     if( EventData::SELECTING == mImpl->mEventData->mState )
1200     {
1201       CharacterIndex startOfSelectedText = 0u;
1202       Length lengthOfSelectedText = 0u;
1203       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1204                                                                             mImpl->mLogicalModel,
1205                                                                             startOfSelectedText,
1206                                                                             lengthOfSelectedText );
1207
1208       fontDescriptionRun.size = static_cast<PointSize26Dot6>( size * 64.f );
1209       fontDescriptionRun.sizeDefined = true;
1210
1211       // Request to relayout.
1212       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1213                                                                VALIDATE_FONTS            |
1214                                                                SHAPE_TEXT                |
1215                                                                GET_GLYPH_METRICS         |
1216                                                                LAYOUT                    |
1217                                                                UPDATE_LAYOUT_SIZE        |
1218                                                                REORDER                   |
1219                                                                ALIGN );
1220       mImpl->mRecalculateNaturalSize = true;
1221       mImpl->RequestRelayout();
1222
1223       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1224       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1225       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1226
1227       // As the font might change, recalculate the handle positions is needed.
1228       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1229       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1230       mImpl->mEventData->mUpdateHighlightBox = true;
1231       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1232     }
1233   }
1234 }
1235
1236 float Controller::GetInputFontPointSize() const
1237 {
1238   if( NULL != mImpl->mEventData )
1239   {
1240     return mImpl->mEventData->mInputStyle.size;
1241   }
1242
1243   // Return the default font's point size if there is no EventData.
1244   return GetDefaultPointSize();
1245 }
1246
1247 void Controller::SetInputLineSpacing( float lineSpacing )
1248 {
1249   if( NULL != mImpl->mEventData )
1250   {
1251     mImpl->mEventData->mInputStyle.lineSpacing = lineSpacing;
1252     mImpl->mEventData->mInputStyle.isLineSpacingDefined = true;
1253   }
1254 }
1255
1256 float Controller::GetInputLineSpacing() const
1257 {
1258   if( NULL != mImpl->mEventData )
1259   {
1260     return mImpl->mEventData->mInputStyle.lineSpacing;
1261   }
1262
1263   return 0.f;
1264 }
1265
1266 void Controller::SetInputShadowProperties( const std::string& shadowProperties )
1267 {
1268   if( NULL != mImpl->mEventData )
1269   {
1270     mImpl->mEventData->mInputStyle.shadowProperties = shadowProperties;
1271   }
1272 }
1273
1274 const std::string& Controller::GetInputShadowProperties() const
1275 {
1276   if( NULL != mImpl->mEventData )
1277   {
1278     return mImpl->mEventData->mInputStyle.shadowProperties;
1279   }
1280
1281   return GetDefaultShadowProperties();
1282 }
1283
1284 void Controller::SetInputUnderlineProperties( const std::string& underlineProperties )
1285 {
1286   if( NULL != mImpl->mEventData )
1287   {
1288     mImpl->mEventData->mInputStyle.underlineProperties = underlineProperties;
1289   }
1290 }
1291
1292 const std::string& Controller::GetInputUnderlineProperties() const
1293 {
1294   if( NULL != mImpl->mEventData )
1295   {
1296     return mImpl->mEventData->mInputStyle.underlineProperties;
1297   }
1298
1299   return GetDefaultUnderlineProperties();
1300 }
1301
1302 void Controller::SetInputEmbossProperties( const std::string& embossProperties )
1303 {
1304   if( NULL != mImpl->mEventData )
1305   {
1306     mImpl->mEventData->mInputStyle.embossProperties = embossProperties;
1307   }
1308 }
1309
1310 const std::string& Controller::GetInputEmbossProperties() const
1311 {
1312   if( NULL != mImpl->mEventData )
1313   {
1314     return mImpl->mEventData->mInputStyle.embossProperties;
1315   }
1316
1317   return GetDefaultEmbossProperties();
1318 }
1319
1320 void Controller::SetInputOutlineProperties( const std::string& outlineProperties )
1321 {
1322   if( NULL != mImpl->mEventData )
1323   {
1324     mImpl->mEventData->mInputStyle.outlineProperties = outlineProperties;
1325   }
1326 }
1327
1328 const std::string& Controller::GetInputOutlineProperties() const
1329 {
1330   if( NULL != mImpl->mEventData )
1331   {
1332     return mImpl->mEventData->mInputStyle.outlineProperties;
1333   }
1334
1335   return GetDefaultOutlineProperties();
1336 }
1337
1338 // public : Queries & retrieves.
1339
1340 LayoutEngine& Controller::GetLayoutEngine()
1341 {
1342   return mImpl->mLayoutEngine;
1343 }
1344
1345 View& Controller::GetView()
1346 {
1347   return mImpl->mView;
1348 }
1349
1350 const Vector2& Controller::GetScrollPosition() const
1351 {
1352   return mImpl->mScrollPosition;
1353 }
1354
1355 Vector3 Controller::GetNaturalSize()
1356 {
1357   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n" );
1358   Vector3 naturalSize;
1359
1360   // Make sure the model is up-to-date before layouting
1361   ProcessModifyEvents();
1362
1363   if( mImpl->mRecalculateNaturalSize )
1364   {
1365     // Operations that can be done only once until the text changes.
1366     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1367                                                                            GET_SCRIPTS       |
1368                                                                            VALIDATE_FONTS    |
1369                                                                            GET_LINE_BREAKS   |
1370                                                                            GET_WORD_BREAKS   |
1371                                                                            BIDI_INFO         |
1372                                                                            SHAPE_TEXT        |
1373                                                                            GET_GLYPH_METRICS );
1374
1375     // Set the update info to relayout the whole text.
1376     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1377     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1378
1379     // Make sure the model is up-to-date before layouting
1380     mImpl->UpdateModel( onlyOnceOperations );
1381
1382     // Layout the text for the new width.
1383     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1384
1385     // Store the actual control's size to restore later.
1386     const Size actualControlSize = mImpl->mVisualModel->mControlSize;
1387
1388     DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
1389                 static_cast<OperationsMask>( onlyOnceOperations |
1390                                              LAYOUT ),
1391                 naturalSize.GetVectorXY() );
1392
1393     // Do not do again the only once operations.
1394     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1395
1396     // Do the size related operations again.
1397     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1398                                                                         ALIGN  |
1399                                                                         REORDER );
1400     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1401
1402     // Stores the natural size to avoid recalculate it again
1403     // unless the text/style changes.
1404     mImpl->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
1405
1406     mImpl->mRecalculateNaturalSize = false;
1407
1408     // Clear the update info. This info will be set the next time the text is updated.
1409     mImpl->mTextUpdateInfo.Clear();
1410
1411     // Restore the actual control's size.
1412     mImpl->mVisualModel->mControlSize = actualControlSize;
1413
1414     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1415   }
1416   else
1417   {
1418     naturalSize = mImpl->mVisualModel->GetNaturalSize();
1419
1420     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1421   }
1422
1423   naturalSize.x = ConvertToEven( naturalSize.x );
1424   naturalSize.y = ConvertToEven( naturalSize.y );
1425
1426   return naturalSize;
1427 }
1428
1429 float Controller::GetHeightForWidth( float width )
1430 {
1431   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
1432   // Make sure the model is up-to-date before layouting
1433   ProcessModifyEvents();
1434
1435   Size layoutSize;
1436   if( fabsf( width - mImpl->mVisualModel->mControlSize.width ) > Math::MACHINE_EPSILON_1000 )
1437   {
1438     // Operations that can be done only once until the text changes.
1439     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1440                                                                            GET_SCRIPTS       |
1441                                                                            VALIDATE_FONTS    |
1442                                                                            GET_LINE_BREAKS   |
1443                                                                            GET_WORD_BREAKS   |
1444                                                                            BIDI_INFO         |
1445                                                                            SHAPE_TEXT        |
1446                                                                            GET_GLYPH_METRICS );
1447
1448     // Set the update info to relayout the whole text.
1449     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1450     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1451
1452     // Make sure the model is up-to-date before layouting
1453     mImpl->UpdateModel( onlyOnceOperations );
1454
1455
1456     // Layout the text for the new width.
1457     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1458
1459     // Store the actual control's width.
1460     const float actualControlWidth = mImpl->mVisualModel->mControlSize.width;
1461
1462     DoRelayout( Size( width, MAX_FLOAT ),
1463                 static_cast<OperationsMask>( onlyOnceOperations |
1464                                              LAYOUT ),
1465                 layoutSize );
1466
1467     // Do not do again the only once operations.
1468     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1469
1470     // Do the size related operations again.
1471     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1472                                                                         ALIGN  |
1473                                                                         REORDER );
1474
1475     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1476
1477     // Clear the update info. This info will be set the next time the text is updated.
1478     mImpl->mTextUpdateInfo.Clear();
1479
1480     // Restore the actual control's width.
1481     mImpl->mVisualModel->mControlSize.width = actualControlWidth;
1482
1483     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
1484   }
1485   else
1486   {
1487     layoutSize = mImpl->mVisualModel->GetLayoutSize();
1488     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
1489   }
1490
1491   return layoutSize.height;
1492 }
1493
1494 // public : Relayout.
1495
1496 Controller::UpdateTextType Controller::Relayout( const Size& size )
1497 {
1498   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", this, size.width, size.height, (mImpl->mAutoScrollEnabled)?"true":"false"  );
1499
1500   UpdateTextType updateTextType = NONE_UPDATED;
1501
1502   if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
1503   {
1504     if( 0u != mImpl->mVisualModel->mGlyphPositions.Count() )
1505     {
1506       mImpl->mVisualModel->mGlyphPositions.Clear();
1507       updateTextType = MODEL_UPDATED;
1508     }
1509
1510     // Clear the update info. This info will be set the next time the text is updated.
1511     mImpl->mTextUpdateInfo.Clear();
1512
1513     // Not worth to relayout if width or height is equal to zero.
1514     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
1515
1516     return updateTextType;
1517   }
1518
1519   // Whether a new size has been set.
1520   const bool newSize = ( size != mImpl->mVisualModel->mControlSize );
1521
1522   if( newSize )
1523   {
1524     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mVisualModel->mControlSize.width, mImpl->mVisualModel->mControlSize.height );
1525
1526     // Layout operations that need to be done if the size changes.
1527     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1528                                                              LAYOUT                    |
1529                                                              ALIGN                     |
1530                                                              UPDATE_LAYOUT_SIZE        |
1531                                                              REORDER );
1532     // Set the update info to relayout the whole text.
1533     mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
1534     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
1535
1536     // Store the size used to layout the text.
1537     mImpl->mVisualModel->mControlSize = size;
1538   }
1539
1540   // Whether there are modify events.
1541   if( 0u != mImpl->mModifyEvents.Count() )
1542   {
1543     // Style operations that need to be done if the text is modified.
1544     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1545                                                              COLOR );
1546   }
1547
1548   // Make sure the model is up-to-date before layouting.
1549   ProcessModifyEvents();
1550   bool updated = mImpl->UpdateModel( mImpl->mOperationsPending );
1551
1552   // Layout the text.
1553   Size layoutSize;
1554   updated = DoRelayout( size,
1555                         mImpl->mOperationsPending,
1556                         layoutSize ) || updated;
1557
1558   if( updated )
1559   {
1560     updateTextType = MODEL_UPDATED;
1561   }
1562
1563   // Do not re-do any operation until something changes.
1564   mImpl->mOperationsPending = NO_OPERATION;
1565
1566   // Whether the text control is editable
1567   const bool isEditable = NULL != mImpl->mEventData;
1568
1569   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
1570   Vector2 offset;
1571   if( newSize && isEditable )
1572   {
1573     offset = mImpl->mScrollPosition;
1574   }
1575
1576   if( !isEditable || !IsMultiLineEnabled() )
1577   {
1578     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
1579     CalculateVerticalOffset( size );
1580   }
1581
1582   if( isEditable )
1583   {
1584     if( newSize )
1585     {
1586       // If there is a new size, the scroll position needs to be clamped.
1587       mImpl->ClampHorizontalScroll( layoutSize );
1588
1589       // Update the decorator's positions is needed if there is a new size.
1590       mImpl->mEventData->mDecorator->UpdatePositions( mImpl->mScrollPosition - offset );
1591     }
1592
1593     // Move the cursor, grab handle etc.
1594     if( mImpl->ProcessInputEvents() )
1595     {
1596       updateTextType = static_cast<UpdateTextType>( updateTextType | DECORATOR_UPDATED );
1597     }
1598   }
1599
1600   // Clear the update info. This info will be set the next time the text is updated.
1601   mImpl->mTextUpdateInfo.Clear();
1602   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
1603
1604   return updateTextType;
1605 }
1606
1607 // public : Input style change signals.
1608
1609 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1610 {
1611   return ( NULL == mImpl->mEventData ) || ( 0u == mImpl->mEventData->mInputStyleChangedQueue.Count() );
1612 }
1613
1614 void Controller::ProcessInputStyleChangedSignals()
1615 {
1616   if( NULL == mImpl->mEventData )
1617   {
1618     // Nothing to do.
1619     return;
1620   }
1621
1622   for( Vector<InputStyle::Mask>::ConstIterator it = mImpl->mEventData->mInputStyleChangedQueue.Begin(),
1623          endIt = mImpl->mEventData->mInputStyleChangedQueue.End();
1624        it != endIt;
1625        ++it )
1626   {
1627     const InputStyle::Mask mask = *it;
1628
1629     if( NULL != mImpl->mEditableControlInterface )
1630     {
1631       // Emit the input style changed signal.
1632       mImpl->mEditableControlInterface->InputStyleChanged( mask );
1633     }
1634   }
1635
1636   mImpl->mEventData->mInputStyleChangedQueue.Clear();
1637 }
1638
1639 // public : Text-input Event Queuing.
1640
1641 void Controller::KeyboardFocusGainEvent()
1642 {
1643   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1644
1645   if( NULL != mImpl->mEventData )
1646   {
1647     if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1648         ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1649     {
1650       mImpl->ChangeState( EventData::EDITING );
1651       mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1652       mImpl->mEventData->mUpdateInputStyle = true;
1653     }
1654     mImpl->NotifyImfMultiLineStatus();
1655     if( mImpl->IsShowingPlaceholderText() )
1656     {
1657       // Show alternative placeholder-text when editing
1658       ShowPlaceholderText();
1659     }
1660
1661     mImpl->RequestRelayout();
1662   }
1663 }
1664
1665 void Controller::KeyboardFocusLostEvent()
1666 {
1667   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1668
1669   if( NULL != mImpl->mEventData )
1670   {
1671     if( EventData::INTERRUPTED != mImpl->mEventData->mState )
1672     {
1673       mImpl->ChangeState( EventData::INACTIVE );
1674
1675       if( !mImpl->IsShowingRealText() )
1676       {
1677         // Revert to regular placeholder-text when not editing
1678         ShowPlaceholderText();
1679       }
1680     }
1681   }
1682   mImpl->RequestRelayout();
1683 }
1684
1685 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1686 {
1687   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1688
1689   bool textChanged( false );
1690
1691   if( ( NULL != mImpl->mEventData ) &&
1692       ( keyEvent.state == KeyEvent::Down ) )
1693   {
1694     int keyCode = keyEvent.keyCode;
1695     const std::string& keyString = keyEvent.keyPressed;
1696
1697     // Pre-process to separate modifying events from non-modifying input events.
1698     if( Dali::DALI_KEY_ESCAPE == keyCode )
1699     {
1700       // Escape key is a special case which causes focus loss
1701       KeyboardFocusLostEvent();
1702     }
1703     else if( ( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ) ||
1704              ( Dali::DALI_KEY_CURSOR_RIGHT == keyCode ) ||
1705              ( Dali::DALI_KEY_CURSOR_UP    == keyCode ) ||
1706              ( Dali::DALI_KEY_CURSOR_DOWN  == keyCode ) )
1707     {
1708       Event event( Event::CURSOR_KEY_EVENT );
1709       event.p1.mInt = keyCode;
1710       mImpl->mEventData->mEventQueue.push_back( event );
1711     }
1712     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1713     {
1714       textChanged = BackspaceKeyEvent();
1715     }
1716     else if( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1717     {
1718       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1719       // Avoids calling the InsertText() method which can delete selected text
1720     }
1721     else if( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1722              IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1723     {
1724       mImpl->ChangeState( EventData::INACTIVE );
1725       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1726       // Avoids calling the InsertText() method which can delete selected text
1727     }
1728     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1729     {
1730       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1731       // and a character is typed after the type of a upper case latin character.
1732
1733       // Do nothing.
1734     }
1735     else
1736     {
1737       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1738
1739       // IMF manager is no longer handling key-events
1740       mImpl->ClearPreEditFlag();
1741
1742       InsertText( keyString, COMMIT );
1743       textChanged = true;
1744     }
1745
1746     if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1747          ( mImpl->mEventData->mState != EventData::INACTIVE ) &&
1748          ( Dali::DALI_KEY_SHIFT_LEFT != keyCode ) )
1749     {
1750       // Should not change the state if the key is the shift send by the imf manager.
1751       // Otherwise, when the state is SELECTING the text controller can't send the right
1752       // surrounding info to the imf.
1753       mImpl->ChangeState( EventData::EDITING );
1754     }
1755
1756     mImpl->RequestRelayout();
1757   }
1758
1759   if( textChanged &&
1760       ( NULL != mImpl->mEditableControlInterface ) )
1761   {
1762     // Do this last since it provides callbacks into application code
1763     mImpl->mEditableControlInterface->TextChanged();
1764   }
1765
1766   return true;
1767 }
1768
1769 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1770 {
1771   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1772
1773   if( NULL != mImpl->mEventData )
1774   {
1775     DALI_LOG_INFO( gLogFilter, Debug::Concise, "TapEvent state:%d \n", mImpl->mEventData->mState );
1776     EventData::State state( mImpl->mEventData->mState );
1777     bool relayoutNeeded( false );   // to avoid unnecessary relayouts when tapping an empty text-field
1778
1779     if( mImpl->IsClipboardVisible() )
1780     {
1781       if( EventData::INACTIVE == state || EventData::EDITING == state)
1782       {
1783         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1784       }
1785       relayoutNeeded = true;
1786     }
1787     else if( 1u == tapCount )
1788     {
1789       if( EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state )
1790       {
1791         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );  // If Popup shown hide it here so can be shown again if required.
1792       }
1793
1794       if( mImpl->IsShowingRealText() && ( EventData::INACTIVE != state ) )
1795       {
1796         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1797         relayoutNeeded = true;
1798       }
1799       else
1800       {
1801         if( mImpl->IsShowingPlaceholderText() && !mImpl->IsFocusedPlaceholderAvailable() )
1802         {
1803           // Hide placeholder text
1804           ResetText();
1805         }
1806
1807         if( EventData::INACTIVE == state )
1808         {
1809           mImpl->ChangeState( EventData::EDITING );
1810         }
1811         else if( !mImpl->IsClipboardEmpty() )
1812         {
1813           mImpl->ChangeState( EventData::EDITING_WITH_POPUP );
1814         }
1815         relayoutNeeded = true;
1816       }
1817     }
1818     else if( 2u == tapCount )
1819     {
1820       if( mImpl->mEventData->mSelectionEnabled &&
1821           mImpl->IsShowingRealText() )
1822       {
1823         SelectEvent( x, y, false );
1824       }
1825     }
1826     // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1827     if( relayoutNeeded )
1828     {
1829       Event event( Event::TAP_EVENT );
1830       event.p1.mUint = tapCount;
1831       event.p2.mFloat = x;
1832       event.p3.mFloat = y;
1833       mImpl->mEventData->mEventQueue.push_back( event );
1834
1835       mImpl->RequestRelayout();
1836     }
1837   }
1838
1839   // Reset keyboard as tap event has occurred.
1840   mImpl->ResetImfManager();
1841 }
1842
1843 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1844 {
1845   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1846
1847   if( NULL != mImpl->mEventData )
1848   {
1849     Event event( Event::PAN_EVENT );
1850     event.p1.mInt = state;
1851     event.p2.mFloat = displacement.x;
1852     event.p3.mFloat = displacement.y;
1853     mImpl->mEventData->mEventQueue.push_back( event );
1854
1855     mImpl->RequestRelayout();
1856   }
1857 }
1858
1859 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1860 {
1861   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected LongPressEvent" );
1862
1863   if( ( state == Gesture::Started ) &&
1864       ( NULL != mImpl->mEventData ) )
1865   {
1866     if( !mImpl->IsShowingRealText() )
1867     {
1868       Event event( Event::LONG_PRESS_EVENT );
1869       event.p1.mInt = state;
1870       mImpl->mEventData->mEventQueue.push_back( event );
1871       mImpl->RequestRelayout();
1872     }
1873     else
1874     {
1875       // The 1st long-press on inactive text-field is treated as tap
1876       if( EventData::INACTIVE == mImpl->mEventData->mState )
1877       {
1878         mImpl->ChangeState( EventData::EDITING );
1879
1880         Event event( Event::TAP_EVENT );
1881         event.p1.mUint = 1;
1882         event.p2.mFloat = x;
1883         event.p3.mFloat = y;
1884         mImpl->mEventData->mEventQueue.push_back( event );
1885
1886         mImpl->RequestRelayout();
1887       }
1888       else if( !mImpl->IsClipboardVisible() )
1889       {
1890         // Reset the imf manger to commit the pre-edit before selecting the text.
1891         mImpl->ResetImfManager();
1892
1893         SelectEvent( x, y, false );
1894       }
1895     }
1896   }
1897 }
1898
1899 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1900 {
1901   // Whether the text needs to be relaid-out.
1902   bool requestRelayout = false;
1903
1904   // Whether to retrieve the text and cursor position to be sent to the IMF manager.
1905   bool retrieveText = false;
1906   bool retrieveCursor = false;
1907
1908   switch( imfEvent.eventName )
1909   {
1910     case ImfManager::COMMIT:
1911     {
1912       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1913       requestRelayout = true;
1914       retrieveCursor = true;
1915       break;
1916     }
1917     case ImfManager::PREEDIT:
1918     {
1919       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1920       requestRelayout = true;
1921       retrieveCursor = true;
1922       break;
1923     }
1924     case ImfManager::DELETESURROUNDING:
1925     {
1926       const bool textDeleted = RemoveText( imfEvent.cursorOffset,
1927                                            imfEvent.numberOfChars,
1928                                            DONT_UPDATE_INPUT_STYLE );
1929
1930       if( textDeleted )
1931       {
1932         if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
1933             !mImpl->IsPlaceholderAvailable() )
1934         {
1935           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1936         }
1937         else
1938         {
1939           ShowPlaceholderText();
1940         }
1941         mImpl->mEventData->mUpdateCursorPosition = true;
1942         mImpl->mEventData->mScrollAfterDelete = true;
1943
1944         requestRelayout = true;
1945       }
1946       break;
1947     }
1948     case ImfManager::GETSURROUNDING:
1949     {
1950       retrieveText = true;
1951       retrieveCursor = true;
1952       break;
1953     }
1954     case ImfManager::VOID:
1955     {
1956       // do nothing
1957       break;
1958     }
1959   } // end switch
1960
1961   if( requestRelayout )
1962   {
1963     mImpl->mOperationsPending = ALL_OPERATIONS;
1964     mImpl->RequestRelayout();
1965   }
1966
1967   std::string text;
1968   CharacterIndex cursorPosition = 0u;
1969   Length numberOfWhiteSpaces = 0u;
1970
1971   if( retrieveCursor )
1972   {
1973     numberOfWhiteSpaces = mImpl->GetNumberOfWhiteSpaces( 0u );
1974
1975     cursorPosition = mImpl->GetLogicalCursorPosition();
1976
1977     if( cursorPosition < numberOfWhiteSpaces )
1978     {
1979       cursorPosition = 0u;
1980     }
1981     else
1982     {
1983       cursorPosition -= numberOfWhiteSpaces;
1984     }
1985   }
1986
1987   if( retrieveText )
1988   {
1989     mImpl->GetText( numberOfWhiteSpaces, text );
1990   }
1991
1992   ImfManager::ImfCallbackData callbackData( ( retrieveText || retrieveCursor ), cursorPosition, text, false );
1993
1994   if( requestRelayout &&
1995       ( NULL != mImpl->mEditableControlInterface ) )
1996   {
1997     // Do this last since it provides callbacks into application code
1998     mImpl->mEditableControlInterface->TextChanged();
1999   }
2000
2001   return callbackData;
2002 }
2003
2004 void Controller::PasteClipboardItemEvent()
2005 {
2006   // Retrieve the clipboard contents first
2007   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
2008   std::string stringToPaste( notifier.GetContent() );
2009
2010   // Commit the current pre-edit text; the contents of the clipboard should be appended
2011   mImpl->ResetImfManager();
2012
2013   // Temporary disable hiding clipboard
2014   mImpl->SetClipboardHideEnable( false );
2015
2016   // Paste
2017   PasteText( stringToPaste );
2018
2019   mImpl->SetClipboardHideEnable( true );
2020 }
2021
2022 // protected : Inherit from Text::Decorator::ControllerInterface.
2023
2024 void Controller::GetTargetSize( Vector2& targetSize )
2025 {
2026   targetSize = mImpl->mVisualModel->mControlSize;
2027 }
2028
2029 void Controller::AddDecoration( Actor& actor, bool needsClipping )
2030 {
2031   if( NULL != mImpl->mEditableControlInterface )
2032   {
2033     mImpl->mEditableControlInterface->AddDecoration( actor, needsClipping );
2034   }
2035 }
2036
2037 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
2038 {
2039   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
2040
2041   if( NULL != mImpl->mEventData )
2042   {
2043     switch( handleType )
2044     {
2045       case GRAB_HANDLE:
2046       {
2047         Event event( Event::GRAB_HANDLE_EVENT );
2048         event.p1.mUint  = state;
2049         event.p2.mFloat = x;
2050         event.p3.mFloat = y;
2051
2052         mImpl->mEventData->mEventQueue.push_back( event );
2053         break;
2054       }
2055       case LEFT_SELECTION_HANDLE:
2056       {
2057         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
2058         event.p1.mUint  = state;
2059         event.p2.mFloat = x;
2060         event.p3.mFloat = y;
2061
2062         mImpl->mEventData->mEventQueue.push_back( event );
2063         break;
2064       }
2065       case RIGHT_SELECTION_HANDLE:
2066       {
2067         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
2068         event.p1.mUint  = state;
2069         event.p2.mFloat = x;
2070         event.p3.mFloat = y;
2071
2072         mImpl->mEventData->mEventQueue.push_back( event );
2073         break;
2074       }
2075       case LEFT_SELECTION_HANDLE_MARKER:
2076       case RIGHT_SELECTION_HANDLE_MARKER:
2077       {
2078         // Markers do not move the handles.
2079         break;
2080       }
2081       case HANDLE_TYPE_COUNT:
2082       {
2083         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
2084       }
2085     }
2086
2087     mImpl->RequestRelayout();
2088   }
2089 }
2090
2091 // protected : Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2092
2093 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
2094 {
2095   if( NULL == mImpl->mEventData )
2096   {
2097     return;
2098   }
2099
2100   switch( button )
2101   {
2102     case Toolkit::TextSelectionPopup::CUT:
2103     {
2104       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
2105       mImpl->mOperationsPending = ALL_OPERATIONS;
2106
2107       if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2108           !mImpl->IsPlaceholderAvailable() )
2109       {
2110         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2111       }
2112       else
2113       {
2114         ShowPlaceholderText();
2115       }
2116
2117       mImpl->mEventData->mUpdateCursorPosition = true;
2118       mImpl->mEventData->mScrollAfterDelete = true;
2119
2120       mImpl->RequestRelayout();
2121
2122       if( NULL != mImpl->mEditableControlInterface )
2123       {
2124         mImpl->mEditableControlInterface->TextChanged();
2125       }
2126       break;
2127     }
2128     case Toolkit::TextSelectionPopup::COPY:
2129     {
2130       mImpl->SendSelectionToClipboard( false ); // Text not modified
2131
2132       mImpl->mEventData->mUpdateCursorPosition = true;
2133
2134       mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
2135       break;
2136     }
2137     case Toolkit::TextSelectionPopup::PASTE:
2138     {
2139       mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
2140       break;
2141     }
2142     case Toolkit::TextSelectionPopup::SELECT:
2143     {
2144       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
2145
2146       if( mImpl->mEventData->mSelectionEnabled )
2147       {
2148         // Creates a SELECT event.
2149         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
2150       }
2151       break;
2152     }
2153     case Toolkit::TextSelectionPopup::SELECT_ALL:
2154     {
2155       // Creates a SELECT_ALL event
2156       SelectEvent( 0.f, 0.f, true );
2157       break;
2158     }
2159     case Toolkit::TextSelectionPopup::CLIPBOARD:
2160     {
2161       mImpl->ShowClipboard();
2162       break;
2163     }
2164     case Toolkit::TextSelectionPopup::NONE:
2165     {
2166       // Nothing to do.
2167       break;
2168     }
2169   }
2170 }
2171
2172 // private : Update.
2173
2174 void Controller::InsertText( const std::string& text, Controller::InsertType type )
2175 {
2176   bool removedPrevious( false );
2177   bool maxLengthReached( false );
2178
2179   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
2180
2181   if( NULL == mImpl->mEventData )
2182   {
2183     return;
2184   }
2185
2186   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
2187                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
2188                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2189
2190   // TODO: At the moment the underline runs are only for pre-edit.
2191   mImpl->mVisualModel->mUnderlineRuns.Clear();
2192
2193   // Keep the current number of characters.
2194   const Length currentNumberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2195
2196   // Remove the previous IMF pre-edit.
2197   if( mImpl->mEventData->mPreEditFlag && ( 0u != mImpl->mEventData->mPreEditLength ) )
2198   {
2199     removedPrevious = RemoveText( -static_cast<int>( mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition ),
2200                                   mImpl->mEventData->mPreEditLength,
2201                                   DONT_UPDATE_INPUT_STYLE );
2202
2203     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
2204     mImpl->mEventData->mPreEditLength = 0u;
2205   }
2206   else
2207   {
2208     // Remove the previous Selection.
2209     removedPrevious = RemoveSelectedText();
2210   }
2211
2212   Vector<Character> utf32Characters;
2213   Length characterCount = 0u;
2214
2215   if( !text.empty() )
2216   {
2217     //  Convert text into UTF-32
2218     utf32Characters.Resize( text.size() );
2219
2220     // This is a bit horrible but std::string returns a (signed) char*
2221     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
2222
2223     // Transform a text array encoded in utf8 into an array encoded in utf32.
2224     // It returns the actual number of characters.
2225     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
2226     utf32Characters.Resize( characterCount );
2227
2228     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
2229     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
2230   }
2231
2232   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
2233   {
2234     // The placeholder text is no longer needed
2235     if( mImpl->IsShowingPlaceholderText() )
2236     {
2237       ResetText();
2238     }
2239
2240     mImpl->ChangeState( EventData::EDITING );
2241
2242     // Handle the IMF (predicitive text) state changes
2243     if( COMMIT == type )
2244     {
2245       // IMF manager is no longer handling key-events
2246       mImpl->ClearPreEditFlag();
2247     }
2248     else // PRE_EDIT
2249     {
2250       if( !mImpl->mEventData->mPreEditFlag )
2251       {
2252         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state\n" );
2253
2254         // Record the start of the pre-edit text
2255         mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
2256       }
2257
2258       mImpl->mEventData->mPreEditLength = utf32Characters.Count();
2259       mImpl->mEventData->mPreEditFlag = true;
2260
2261       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2262     }
2263
2264     const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
2265
2266     // Restrict new text to fit within Maximum characters setting.
2267     Length maxSizeOfNewText = std::min( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
2268     maxLengthReached = ( characterCount > maxSizeOfNewText );
2269
2270     // The cursor position.
2271     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2272
2273     // Update the text's style.
2274
2275     // Updates the text style runs by adding characters.
2276     mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, maxSizeOfNewText );
2277
2278     // Get the character index from the cursor index.
2279     const CharacterIndex styleIndex = ( cursorIndex > 0u ) ? cursorIndex - 1u : 0u;
2280
2281     // Retrieve the text's style for the given index.
2282     InputStyle style;
2283     mImpl->RetrieveDefaultInputStyle( style );
2284     mImpl->mLogicalModel->RetrieveStyle( styleIndex, style );
2285
2286     // Whether to add a new text color run.
2287     const bool addColorRun = ( style.textColor != mImpl->mEventData->mInputStyle.textColor );
2288
2289     // Whether to add a new font run.
2290     const bool addFontNameRun = style.familyName != mImpl->mEventData->mInputStyle.familyName;
2291     const bool addFontWeightRun = style.weight != mImpl->mEventData->mInputStyle.weight;
2292     const bool addFontWidthRun = style.width != mImpl->mEventData->mInputStyle.width;
2293     const bool addFontSlantRun = style.slant != mImpl->mEventData->mInputStyle.slant;
2294     const bool addFontSizeRun = style.size != mImpl->mEventData->mInputStyle.size;
2295
2296     // Add style runs.
2297     if( addColorRun )
2298     {
2299       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
2300       mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
2301
2302       ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
2303       colorRun.color = mImpl->mEventData->mInputStyle.textColor;
2304       colorRun.characterRun.characterIndex = cursorIndex;
2305       colorRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2306     }
2307
2308     if( addFontNameRun   ||
2309         addFontWeightRun ||
2310         addFontWidthRun  ||
2311         addFontSlantRun  ||
2312         addFontSizeRun )
2313     {
2314       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mFontDescriptionRuns.Count();
2315       mImpl->mLogicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
2316
2317       FontDescriptionRun& fontDescriptionRun = *( mImpl->mLogicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
2318
2319       if( addFontNameRun )
2320       {
2321         fontDescriptionRun.familyLength = mImpl->mEventData->mInputStyle.familyName.size();
2322         fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
2323         memcpy( fontDescriptionRun.familyName, mImpl->mEventData->mInputStyle.familyName.c_str(), fontDescriptionRun.familyLength );
2324         fontDescriptionRun.familyDefined = true;
2325
2326         // The memory allocated for the font family name is freed when the font description is removed from the logical model.
2327       }
2328
2329       if( addFontWeightRun )
2330       {
2331         fontDescriptionRun.weight = mImpl->mEventData->mInputStyle.weight;
2332         fontDescriptionRun.weightDefined = true;
2333       }
2334
2335       if( addFontWidthRun )
2336       {
2337         fontDescriptionRun.width = mImpl->mEventData->mInputStyle.width;
2338         fontDescriptionRun.widthDefined = true;
2339       }
2340
2341       if( addFontSlantRun )
2342       {
2343         fontDescriptionRun.slant = mImpl->mEventData->mInputStyle.slant;
2344         fontDescriptionRun.slantDefined = true;
2345       }
2346
2347       if( addFontSizeRun )
2348       {
2349         fontDescriptionRun.size = static_cast<PointSize26Dot6>( mImpl->mEventData->mInputStyle.size * 64.f );
2350         fontDescriptionRun.sizeDefined = true;
2351       }
2352
2353       fontDescriptionRun.characterRun.characterIndex = cursorIndex;
2354       fontDescriptionRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2355     }
2356
2357     // Insert at current cursor position.
2358     Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
2359
2360     if( cursorIndex < numberOfCharactersInModel )
2361     {
2362       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2363     }
2364     else
2365     {
2366       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2367     }
2368
2369     // Mark the first paragraph to be updated.
2370     mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2371     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd += maxSizeOfNewText;
2372
2373     // Update the cursor index.
2374     cursorIndex += maxSizeOfNewText;
2375
2376     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
2377   }
2378
2379   const Length numberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2380
2381   if( ( 0u == mImpl->mLogicalModel->mText.Count() ) &&
2382       mImpl->IsPlaceholderAvailable() )
2383   {
2384     // Show place-holder if empty after removing the pre-edit text
2385     ShowPlaceholderText();
2386     mImpl->mEventData->mUpdateCursorPosition = true;
2387     mImpl->ClearPreEditFlag();
2388   }
2389   else if( removedPrevious ||
2390            ( 0 != utf32Characters.Count() ) )
2391   {
2392     // Queue an inserted event
2393     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
2394
2395     mImpl->mEventData->mUpdateCursorPosition = true;
2396     if( numberOfCharacters < currentNumberOfCharacters )
2397     {
2398       mImpl->mEventData->mScrollAfterDelete = true;
2399     }
2400     else
2401     {
2402       mImpl->mEventData->mScrollAfterUpdatePosition = true;
2403     }
2404   }
2405
2406   if( maxLengthReached )
2407   {
2408     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
2409
2410     mImpl->ResetImfManager();
2411
2412     if( NULL != mImpl->mEditableControlInterface )
2413     {
2414       // Do this last since it provides callbacks into application code
2415       mImpl->mEditableControlInterface->MaxLengthReached();
2416     }
2417   }
2418 }
2419
2420 void Controller::PasteText( const std::string& stringToPaste )
2421 {
2422   InsertText( stringToPaste, Text::Controller::COMMIT );
2423   mImpl->ChangeState( EventData::EDITING );
2424   mImpl->RequestRelayout();
2425
2426   if( NULL != mImpl->mEditableControlInterface )
2427   {
2428     // Do this last since it provides callbacks into application code
2429     mImpl->mEditableControlInterface->TextChanged();
2430   }
2431 }
2432
2433 bool Controller::RemoveText( int cursorOffset,
2434                              int numberOfCharacters,
2435                              UpdateInputStyleType type )
2436 {
2437   bool removed = false;
2438
2439   if( NULL == mImpl->mEventData )
2440   {
2441     return removed;
2442   }
2443
2444   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfCharacters %d\n",
2445                  this, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfCharacters );
2446
2447   if( !mImpl->IsShowingPlaceholderText() )
2448   {
2449     // Delete at current cursor position
2450     Vector<Character>& currentText = mImpl->mLogicalModel->mText;
2451     CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2452
2453     CharacterIndex cursorIndex = oldCursorIndex;
2454
2455     // Validate the cursor position & number of characters
2456     if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
2457     {
2458       cursorIndex = oldCursorIndex + cursorOffset;
2459     }
2460
2461     if( ( cursorIndex + numberOfCharacters ) > currentText.Count() )
2462     {
2463       numberOfCharacters = currentText.Count() - cursorIndex;
2464     }
2465
2466     if( mImpl->mEventData->mPreEditFlag || // If the preedit flag is enabled, it means two (or more) of them came together i.e. when two keys have been pressed at the same time.
2467         ( ( cursorIndex + numberOfCharacters ) <= mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters ) )
2468     {
2469       // Mark the paragraphs to be updated.
2470       mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2471       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove += numberOfCharacters;
2472
2473       // Update the input style and remove the text's style before removing the text.
2474
2475       if( UPDATE_INPUT_STYLE == type )
2476       {
2477         // Keep a copy of the current input style.
2478         InputStyle currentInputStyle;
2479         currentInputStyle.Copy( mImpl->mEventData->mInputStyle );
2480
2481         // Set first the default input style.
2482         mImpl->RetrieveDefaultInputStyle( mImpl->mEventData->mInputStyle );
2483
2484         // Update the input style.
2485         mImpl->mLogicalModel->RetrieveStyle( cursorIndex, mImpl->mEventData->mInputStyle );
2486
2487         // Compare if the input style has changed.
2488         const bool hasInputStyleChanged = !currentInputStyle.Equal( mImpl->mEventData->mInputStyle );
2489
2490         if( hasInputStyleChanged )
2491         {
2492           const InputStyle::Mask styleChangedMask = currentInputStyle.GetInputStyleChangeMask( mImpl->mEventData->mInputStyle );
2493           // Queue the input style changed signal.
2494           mImpl->mEventData->mInputStyleChangedQueue.PushBack( styleChangedMask );
2495         }
2496       }
2497
2498       // Updates the text style runs by removing characters. Runs with no characters are removed.
2499       mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, -numberOfCharacters );
2500
2501       // Remove the characters.
2502       Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
2503       Vector<Character>::Iterator last  = first + numberOfCharacters;
2504
2505       currentText.Erase( first, last );
2506
2507       // Cursor position retreat
2508       oldCursorIndex = cursorIndex;
2509
2510       mImpl->mEventData->mScrollAfterDelete = true;
2511
2512       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfCharacters );
2513       removed = true;
2514     }
2515   }
2516
2517   return removed;
2518 }
2519
2520 bool Controller::RemoveSelectedText()
2521 {
2522   bool textRemoved( false );
2523
2524   if( EventData::SELECTING == mImpl->mEventData->mState )
2525   {
2526     std::string removedString;
2527     mImpl->RetrieveSelection( removedString, true );
2528
2529     if( !removedString.empty() )
2530     {
2531       textRemoved = true;
2532       mImpl->ChangeState( EventData::EDITING );
2533     }
2534   }
2535
2536   return textRemoved;
2537 }
2538
2539 // private : Relayout.
2540
2541 bool Controller::DoRelayout( const Size& size,
2542                              OperationsMask operationsRequired,
2543                              Size& layoutSize )
2544 {
2545   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
2546   bool viewUpdated( false );
2547
2548   // Calculate the operations to be done.
2549   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
2550
2551   const CharacterIndex startIndex = mImpl->mTextUpdateInfo.mParagraphCharacterIndex;
2552   const Length requestedNumberOfCharacters = mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters;
2553
2554   // Get the current layout size.
2555   layoutSize = mImpl->mVisualModel->GetLayoutSize();
2556
2557   if( NO_OPERATION != ( LAYOUT & operations ) )
2558   {
2559     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
2560
2561     // Some vectors with data needed to layout and reorder may be void
2562     // after the first time the text has been laid out.
2563     // Fill the vectors again.
2564
2565     // Calculate the number of glyphs to layout.
2566     const Vector<GlyphIndex>& charactersToGlyph = mImpl->mVisualModel->mCharactersToGlyph;
2567     const Vector<Length>& glyphsPerCharacter = mImpl->mVisualModel->mGlyphsPerCharacter;
2568     const GlyphIndex* const charactersToGlyphBuffer = charactersToGlyph.Begin();
2569     const Length* const glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
2570
2571     const CharacterIndex lastIndex = startIndex + ( ( requestedNumberOfCharacters > 0u ) ? requestedNumberOfCharacters - 1u : 0u );
2572     const GlyphIndex startGlyphIndex = mImpl->mTextUpdateInfo.mStartGlyphIndex;
2573     const Length numberOfGlyphs = ( requestedNumberOfCharacters > 0u ) ? *( charactersToGlyphBuffer + lastIndex ) + *( glyphsPerCharacterBuffer + lastIndex ) - startGlyphIndex : 0u;
2574     const Length totalNumberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
2575
2576     if( 0u == totalNumberOfGlyphs )
2577     {
2578       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2579       {
2580         mImpl->mVisualModel->SetLayoutSize( Size::ZERO );
2581       }
2582
2583       // Nothing else to do if there is no glyphs.
2584       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
2585       return true;
2586     }
2587
2588     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
2589     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
2590     const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
2591     const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
2592     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
2593     const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
2594     const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
2595
2596     // Set the layout parameters.
2597     LayoutParameters layoutParameters( size,
2598                                        textBuffer,
2599                                        lineBreakInfo.Begin(),
2600                                        wordBreakInfo.Begin(),
2601                                        ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
2602                                        glyphs.Begin(),
2603                                        glyphsToCharactersMap.Begin(),
2604                                        charactersPerGlyph.Begin(),
2605                                        charactersToGlyphBuffer,
2606                                        glyphsPerCharacterBuffer,
2607                                        totalNumberOfGlyphs );
2608
2609     // Resize the vector of positions to have the same size than the vector of glyphs.
2610     Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
2611     glyphPositions.Resize( totalNumberOfGlyphs );
2612
2613     // Whether the last character is a new paragraph character.
2614     mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph =  TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
2615     layoutParameters.isLastNewParagraph = mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph;
2616
2617     // The initial glyph and the number of glyphs to layout.
2618     layoutParameters.startGlyphIndex = startGlyphIndex;
2619     layoutParameters.numberOfGlyphs = numberOfGlyphs;
2620     layoutParameters.startLineIndex = mImpl->mTextUpdateInfo.mStartLineIndex;
2621     layoutParameters.estimatedNumberOfLines = mImpl->mTextUpdateInfo.mEstimatedNumberOfLines;
2622
2623     // Update the visual model.
2624     Size newLayoutSize;
2625     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
2626                                                    glyphPositions,
2627                                                    mImpl->mVisualModel->mLines,
2628                                                    newLayoutSize );
2629
2630     viewUpdated = viewUpdated || ( newLayoutSize != layoutSize );
2631
2632     if( viewUpdated )
2633     {
2634       layoutSize = newLayoutSize;
2635
2636       if ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) )
2637       {
2638         mImpl->mAutoScrollDirectionRTL = false;
2639       }
2640
2641       // Reorder the lines
2642       if( NO_OPERATION != ( REORDER & operations ) )
2643       {
2644         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
2645         Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = mImpl->mLogicalModel->mBidirectionalLineInfo;
2646
2647         // Check first if there are paragraphs with bidirectional info.
2648         if( 0u != bidirectionalInfo.Count() )
2649         {
2650           // Get the lines
2651           const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
2652
2653           // Reorder the lines.
2654           bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
2655           ReorderLines( bidirectionalInfo,
2656                         startIndex,
2657                         requestedNumberOfCharacters,
2658                         mImpl->mVisualModel->mLines,
2659                         bidirectionalLineInfo );
2660
2661           // Set the bidirectional info per line into the layout parameters.
2662           layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
2663           layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
2664
2665           // Re-layout the text. Reorder those lines with right to left characters.
2666           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
2667                                                          startIndex,
2668                                                          requestedNumberOfCharacters,
2669                                                          glyphPositions );
2670
2671           if ( ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) ) && ( numberOfLines > 0 ) )
2672           {
2673             const LineRun* const firstline = mImpl->mVisualModel->mLines.Begin();
2674             if ( firstline )
2675             {
2676               mImpl->mAutoScrollDirectionRTL = firstline->direction;
2677             }
2678           }
2679         }
2680       } // REORDER
2681
2682       // Sets the layout size.
2683       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2684       {
2685         mImpl->mVisualModel->SetLayoutSize( layoutSize );
2686       }
2687     } // view updated
2688   }
2689
2690   if( NO_OPERATION != ( ALIGN & operations ) )
2691   {
2692     // The laid-out lines.
2693     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
2694
2695     // Need to align with the control's size as the text may contain lines
2696     // starting either with left to right text or right to left.
2697     mImpl->mLayoutEngine.Align( size,
2698                                 startIndex,
2699                                 requestedNumberOfCharacters,
2700                                 lines,
2701                                 mImpl->mAlignmentOffset );
2702
2703     viewUpdated = true;
2704   }
2705 #if defined(DEBUG_ENABLED)
2706   std::string currentText;
2707   GetText( currentText );
2708   DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mAutoScrollDirectionRTL[%s] [%s]\n", this, (mImpl->mAutoScrollDirectionRTL)?"true":"false",  currentText.c_str() );
2709 #endif
2710   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
2711   return viewUpdated;
2712 }
2713
2714 void Controller::CalculateVerticalOffset( const Size& controlSize )
2715 {
2716   Size layoutSize = mImpl->mVisualModel->GetLayoutSize();
2717
2718   if( fabsf( layoutSize.height ) < Math::MACHINE_EPSILON_1000 )
2719   {
2720     // Get the line height of the default font.
2721     layoutSize.height = mImpl->GetDefaultFontLineHeight();
2722   }
2723
2724   switch( mImpl->mLayoutEngine.GetVerticalAlignment() )
2725   {
2726     case LayoutEngine::VERTICAL_ALIGN_TOP:
2727     {
2728       mImpl->mScrollPosition.y = 0.f;
2729       break;
2730     }
2731     case LayoutEngine::VERTICAL_ALIGN_CENTER:
2732     {
2733       mImpl->mScrollPosition.y = floorf( 0.5f * ( controlSize.height - layoutSize.height ) ); // try to avoid pixel alignment.
2734       break;
2735     }
2736     case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
2737     {
2738       mImpl->mScrollPosition.y = controlSize.height - layoutSize.height;
2739       break;
2740     }
2741   }
2742 }
2743
2744 // private : Events.
2745
2746 void Controller::ProcessModifyEvents()
2747 {
2748   Vector<ModifyEvent>& events = mImpl->mModifyEvents;
2749
2750   if( 0u == events.Count() )
2751   {
2752     // Nothing to do.
2753     return;
2754   }
2755
2756   for( Vector<ModifyEvent>::ConstIterator it = events.Begin(),
2757          endIt = events.End();
2758        it != endIt;
2759        ++it )
2760   {
2761     const ModifyEvent& event = *it;
2762
2763     if( ModifyEvent::TEXT_REPLACED == event.type )
2764     {
2765       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
2766       DALI_ASSERT_DEBUG( it == events.Begin() && "Unexpected TEXT_REPLACED event" );
2767
2768       TextReplacedEvent();
2769     }
2770     else if( ModifyEvent::TEXT_INSERTED == event.type )
2771     {
2772       TextInsertedEvent();
2773     }
2774     else if( ModifyEvent::TEXT_DELETED == event.type )
2775     {
2776       // Placeholder-text cannot be deleted
2777       if( !mImpl->IsShowingPlaceholderText() )
2778       {
2779         TextDeletedEvent();
2780       }
2781     }
2782   }
2783
2784   if( NULL != mImpl->mEventData )
2785   {
2786     // When the text is being modified, delay cursor blinking
2787     mImpl->mEventData->mDecorator->DelayCursorBlink();
2788   }
2789
2790   // Discard temporary text
2791   events.Clear();
2792 }
2793
2794 void Controller::TextReplacedEvent()
2795 {
2796   // The natural size needs to be re-calculated.
2797   mImpl->mRecalculateNaturalSize = true;
2798
2799   // Apply modifications to the model
2800   mImpl->mOperationsPending = ALL_OPERATIONS;
2801 }
2802
2803 void Controller::TextInsertedEvent()
2804 {
2805   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
2806
2807   if( NULL == mImpl->mEventData )
2808   {
2809     return;
2810   }
2811
2812   // The natural size needs to be re-calculated.
2813   mImpl->mRecalculateNaturalSize = true;
2814
2815   // Apply modifications to the model; TODO - Optimize this
2816   mImpl->mOperationsPending = ALL_OPERATIONS;
2817 }
2818
2819 void Controller::TextDeletedEvent()
2820 {
2821   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
2822
2823   if( NULL == mImpl->mEventData )
2824   {
2825     return;
2826   }
2827
2828   // The natural size needs to be re-calculated.
2829   mImpl->mRecalculateNaturalSize = true;
2830
2831   // Apply modifications to the model; TODO - Optimize this
2832   mImpl->mOperationsPending = ALL_OPERATIONS;
2833 }
2834
2835 void Controller::SelectEvent( float x, float y, bool selectAll )
2836 {
2837   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SelectEvent\n" );
2838
2839   if( NULL != mImpl->mEventData )
2840   {
2841     if( selectAll )
2842     {
2843       Event event( Event::SELECT_ALL );
2844       mImpl->mEventData->mEventQueue.push_back( event );
2845     }
2846     else
2847     {
2848       Event event( Event::SELECT );
2849       event.p2.mFloat = x;
2850       event.p3.mFloat = y;
2851       mImpl->mEventData->mEventQueue.push_back( event );
2852     }
2853
2854     mImpl->RequestRelayout();
2855   }
2856 }
2857
2858 bool Controller::BackspaceKeyEvent()
2859 {
2860   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
2861
2862   bool removed = false;
2863
2864   if( NULL == mImpl->mEventData )
2865   {
2866     return removed;
2867   }
2868
2869   // IMF manager is no longer handling key-events
2870   mImpl->ClearPreEditFlag();
2871
2872   if( EventData::SELECTING == mImpl->mEventData->mState )
2873   {
2874     removed = RemoveSelectedText();
2875   }
2876   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
2877   {
2878     // Remove the character before the current cursor position
2879     removed = RemoveText( -1,
2880                           1,
2881                           UPDATE_INPUT_STYLE );
2882   }
2883
2884   if( removed )
2885   {
2886     if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2887         !mImpl->IsPlaceholderAvailable() )
2888     {
2889       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2890     }
2891     else
2892     {
2893       ShowPlaceholderText();
2894     }
2895     mImpl->mEventData->mUpdateCursorPosition = true;
2896     mImpl->mEventData->mScrollAfterDelete = true;
2897   }
2898
2899   return removed;
2900 }
2901
2902 // private : Helpers.
2903
2904 void Controller::ResetText()
2905 {
2906   // Reset buffers.
2907   mImpl->mLogicalModel->mText.Clear();
2908
2909   // We have cleared everything including the placeholder-text
2910   mImpl->PlaceholderCleared();
2911
2912   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2913   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2914   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = 0u;
2915
2916   // Clear any previous text.
2917   mImpl->mTextUpdateInfo.mClearAll = true;
2918
2919   // The natural size needs to be re-calculated.
2920   mImpl->mRecalculateNaturalSize = true;
2921
2922   // Apply modifications to the model
2923   mImpl->mOperationsPending = ALL_OPERATIONS;
2924 }
2925
2926 void Controller::ShowPlaceholderText()
2927 {
2928   if( mImpl->IsPlaceholderAvailable() )
2929   {
2930     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
2931
2932     if( NULL == mImpl->mEventData )
2933     {
2934       return;
2935     }
2936
2937     mImpl->mEventData->mIsShowingPlaceholderText = true;
2938
2939     // Disable handles when showing place-holder text
2940     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
2941     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
2942     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
2943
2944     const char* text( NULL );
2945     size_t size( 0 );
2946
2947     // TODO - Switch placeholder text styles when changing state
2948     if( ( EventData::INACTIVE != mImpl->mEventData->mState ) &&
2949         ( 0u != mImpl->mEventData->mPlaceholderTextActive.c_str() ) )
2950     {
2951       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
2952       size = mImpl->mEventData->mPlaceholderTextActive.size();
2953     }
2954     else
2955     {
2956       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
2957       size = mImpl->mEventData->mPlaceholderTextInactive.size();
2958     }
2959
2960     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2961     mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2962
2963     // Reset model for showing placeholder.
2964     mImpl->mLogicalModel->mText.Clear();
2965     mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
2966
2967     // Convert text into UTF-32
2968     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
2969     utf32Characters.Resize( size );
2970
2971     // This is a bit horrible but std::string returns a (signed) char*
2972     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
2973
2974     // Transform a text array encoded in utf8 into an array encoded in utf32.
2975     // It returns the actual number of characters.
2976     const Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
2977     utf32Characters.Resize( characterCount );
2978
2979     // The characters to be added.
2980     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = characterCount;
2981
2982     // Reset the cursor position
2983     mImpl->mEventData->mPrimaryCursorPosition = 0;
2984
2985     // The natural size needs to be re-calculated.
2986     mImpl->mRecalculateNaturalSize = true;
2987
2988     // Apply modifications to the model
2989     mImpl->mOperationsPending = ALL_OPERATIONS;
2990
2991     // Update the rest of the model during size negotiation
2992     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
2993   }
2994 }
2995
2996 void Controller::ClearFontData()
2997 {
2998   if( mImpl->mFontDefaults )
2999   {
3000     mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
3001   }
3002
3003   // Set flags to update the model.
3004   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
3005   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
3006   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
3007
3008   mImpl->mTextUpdateInfo.mClearAll = true;
3009   mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
3010   mImpl->mRecalculateNaturalSize = true;
3011
3012   mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
3013                                                            VALIDATE_FONTS            |
3014                                                            SHAPE_TEXT                |
3015                                                            GET_GLYPH_METRICS         |
3016                                                            LAYOUT                    |
3017                                                            UPDATE_LAYOUT_SIZE        |
3018                                                            REORDER                   |
3019                                                            ALIGN );
3020 }
3021
3022 void Controller::ClearStyleData()
3023 {
3024   mImpl->mLogicalModel->mColorRuns.Clear();
3025   mImpl->mLogicalModel->ClearFontDescriptionRuns();
3026 }
3027
3028 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
3029 {
3030   // Reset the cursor position
3031   if( NULL != mImpl->mEventData )
3032   {
3033     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
3034
3035     // Update the cursor if it's in editing mode.
3036     if( EventData::IsEditingState( mImpl->mEventData->mState )  )
3037     {
3038       mImpl->mEventData->mUpdateCursorPosition = true;
3039     }
3040   }
3041 }
3042
3043 void Controller::ResetScrollPosition()
3044 {
3045   if( NULL != mImpl->mEventData )
3046   {
3047     // Reset the scroll position.
3048     mImpl->mScrollPosition = Vector2::ZERO;
3049     mImpl->mEventData->mScrollAfterUpdatePosition = true;
3050   }
3051 }
3052
3053 // private : Private contructors & copy operator.
3054
3055 Controller::Controller()
3056 : mImpl( NULL )
3057 {
3058   mImpl = new Controller::Impl( NULL, NULL );
3059 }
3060
3061 Controller::Controller( ControlInterface* controlInterface )
3062 {
3063   mImpl = new Controller::Impl( controlInterface, NULL );
3064 }
3065
3066 Controller::Controller( ControlInterface* controlInterface,
3067                         EditableControlInterface* editableControlInterface )
3068 {
3069   mImpl = new Controller::Impl( controlInterface,
3070                                 editableControlInterface );
3071 }
3072
3073 // The copy constructor and operator are left unimplemented.
3074
3075 // protected : Destructor.
3076
3077 Controller::~Controller()
3078 {
3079   delete mImpl;
3080 }
3081
3082 } // namespace Text
3083
3084 } // namespace Toolkit
3085
3086 } // namespace Dali