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     // Make sure the model is up-to-date before layouting
1375     mImpl->UpdateModel( onlyOnceOperations );
1376
1377     // Layout the text for the new width.
1378     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1379
1380     // Set the update info to relayout the whole text.
1381     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1382     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1383
1384     // Store the actual control's size to restore later.
1385     const Size actualControlSize = mImpl->mVisualModel->mControlSize;
1386
1387     DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
1388                 static_cast<OperationsMask>( onlyOnceOperations |
1389                                              LAYOUT ),
1390                 naturalSize.GetVectorXY() );
1391
1392     // Do not do again the only once operations.
1393     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1394
1395     // Do the size related operations again.
1396     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1397                                                                         ALIGN  |
1398                                                                         REORDER );
1399     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1400
1401     // Stores the natural size to avoid recalculate it again
1402     // unless the text/style changes.
1403     mImpl->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
1404
1405     mImpl->mRecalculateNaturalSize = false;
1406
1407     // Clear the update info. This info will be set the next time the text is updated.
1408     mImpl->mTextUpdateInfo.Clear();
1409
1410     // Restore the actual control's size.
1411     mImpl->mVisualModel->mControlSize = actualControlSize;
1412
1413     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1414   }
1415   else
1416   {
1417     naturalSize = mImpl->mVisualModel->GetNaturalSize();
1418
1419     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1420   }
1421
1422   naturalSize.x = ConvertToEven( naturalSize.x );
1423   naturalSize.y = ConvertToEven( naturalSize.y );
1424
1425   return naturalSize;
1426 }
1427
1428 float Controller::GetHeightForWidth( float width )
1429 {
1430   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
1431   // Make sure the model is up-to-date before layouting
1432   ProcessModifyEvents();
1433
1434   Size layoutSize;
1435   if( fabsf( width - mImpl->mVisualModel->mControlSize.width ) > Math::MACHINE_EPSILON_1000 )
1436   {
1437     // Operations that can be done only once until the text changes.
1438     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1439                                                                            GET_SCRIPTS       |
1440                                                                            VALIDATE_FONTS    |
1441                                                                            GET_LINE_BREAKS   |
1442                                                                            GET_WORD_BREAKS   |
1443                                                                            BIDI_INFO         |
1444                                                                            SHAPE_TEXT        |
1445                                                                            GET_GLYPH_METRICS );
1446     // Make sure the model is up-to-date before layouting
1447     mImpl->UpdateModel( onlyOnceOperations );
1448
1449
1450     // Layout the text for the new width.
1451     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1452
1453     // Set the update info to relayout the whole text.
1454     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1455     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1456
1457     // Store the actual control's width.
1458     const float actualControlWidth = mImpl->mVisualModel->mControlSize.width;
1459
1460     DoRelayout( Size( width, MAX_FLOAT ),
1461                 static_cast<OperationsMask>( onlyOnceOperations |
1462                                              LAYOUT ),
1463                 layoutSize );
1464
1465     // Do not do again the only once operations.
1466     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1467
1468     // Do the size related operations again.
1469     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1470                                                                         ALIGN  |
1471                                                                         REORDER );
1472
1473     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1474
1475     // Clear the update info. This info will be set the next time the text is updated.
1476     mImpl->mTextUpdateInfo.Clear();
1477
1478     // Restore the actual control's width.
1479     mImpl->mVisualModel->mControlSize.width = actualControlWidth;
1480
1481     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
1482   }
1483   else
1484   {
1485     layoutSize = mImpl->mVisualModel->GetLayoutSize();
1486     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
1487   }
1488
1489   return layoutSize.height;
1490 }
1491
1492 // public : Relayout.
1493
1494 Controller::UpdateTextType Controller::Relayout( const Size& size )
1495 {
1496   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", this, size.width, size.height, (mImpl->mAutoScrollEnabled)?"true":"false"  );
1497
1498   UpdateTextType updateTextType = NONE_UPDATED;
1499
1500   if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
1501   {
1502     if( 0u != mImpl->mVisualModel->mGlyphPositions.Count() )
1503     {
1504       mImpl->mVisualModel->mGlyphPositions.Clear();
1505       updateTextType = MODEL_UPDATED;
1506     }
1507
1508     // Clear the update info. This info will be set the next time the text is updated.
1509     mImpl->mTextUpdateInfo.Clear();
1510
1511     // Not worth to relayout if width or height is equal to zero.
1512     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
1513
1514     return updateTextType;
1515   }
1516
1517   // Whether a new size has been set.
1518   const bool newSize = ( size != mImpl->mVisualModel->mControlSize );
1519
1520   if( newSize )
1521   {
1522     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mVisualModel->mControlSize.width, mImpl->mVisualModel->mControlSize.height );
1523
1524     // Layout operations that need to be done if the size changes.
1525     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1526                                                              LAYOUT                    |
1527                                                              ALIGN                     |
1528                                                              UPDATE_LAYOUT_SIZE        |
1529                                                              REORDER );
1530     // Set the update info to relayout the whole text.
1531     mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
1532     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
1533
1534     // Store the size used to layout the text.
1535     mImpl->mVisualModel->mControlSize = size;
1536   }
1537
1538   // Whether there are modify events.
1539   if( 0u != mImpl->mModifyEvents.Count() )
1540   {
1541     // Style operations that need to be done if the text is modified.
1542     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1543                                                              COLOR );
1544   }
1545
1546   // Make sure the model is up-to-date before layouting.
1547   ProcessModifyEvents();
1548   bool updated = mImpl->UpdateModel( mImpl->mOperationsPending );
1549
1550   // Layout the text.
1551   Size layoutSize;
1552   updated = DoRelayout( size,
1553                         mImpl->mOperationsPending,
1554                         layoutSize ) || updated;
1555
1556   if( updated )
1557   {
1558     updateTextType = MODEL_UPDATED;
1559   }
1560
1561   // Do not re-do any operation until something changes.
1562   mImpl->mOperationsPending = NO_OPERATION;
1563
1564   // Whether the text control is editable
1565   const bool isEditable = NULL != mImpl->mEventData;
1566
1567   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
1568   Vector2 offset;
1569   if( newSize && isEditable )
1570   {
1571     offset = mImpl->mScrollPosition;
1572   }
1573
1574   if( !isEditable || !IsMultiLineEnabled() )
1575   {
1576     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
1577     CalculateVerticalOffset( size );
1578   }
1579
1580   if( isEditable )
1581   {
1582     if( newSize )
1583     {
1584       // If there is a new size, the scroll position needs to be clamped.
1585       mImpl->ClampHorizontalScroll( layoutSize );
1586
1587       // Update the decorator's positions is needed if there is a new size.
1588       mImpl->mEventData->mDecorator->UpdatePositions( mImpl->mScrollPosition - offset );
1589     }
1590
1591     // Move the cursor, grab handle etc.
1592     if( mImpl->ProcessInputEvents() )
1593     {
1594       updateTextType = static_cast<UpdateTextType>( updateTextType | DECORATOR_UPDATED );
1595     }
1596   }
1597
1598   // Clear the update info. This info will be set the next time the text is updated.
1599   mImpl->mTextUpdateInfo.Clear();
1600   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
1601
1602   return updateTextType;
1603 }
1604
1605 // public : Input style change signals.
1606
1607 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1608 {
1609   return ( NULL == mImpl->mEventData ) || ( 0u == mImpl->mEventData->mInputStyleChangedQueue.Count() );
1610 }
1611
1612 void Controller::ProcessInputStyleChangedSignals()
1613 {
1614   if( NULL == mImpl->mEventData )
1615   {
1616     // Nothing to do.
1617     return;
1618   }
1619
1620   for( Vector<InputStyle::Mask>::ConstIterator it = mImpl->mEventData->mInputStyleChangedQueue.Begin(),
1621          endIt = mImpl->mEventData->mInputStyleChangedQueue.End();
1622        it != endIt;
1623        ++it )
1624   {
1625     const InputStyle::Mask mask = *it;
1626
1627     if( NULL != mImpl->mEditableControlInterface )
1628     {
1629       // Emit the input style changed signal.
1630       mImpl->mEditableControlInterface->InputStyleChanged( mask );
1631     }
1632   }
1633
1634   mImpl->mEventData->mInputStyleChangedQueue.Clear();
1635 }
1636
1637 // public : Text-input Event Queuing.
1638
1639 void Controller::KeyboardFocusGainEvent()
1640 {
1641   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1642
1643   if( NULL != mImpl->mEventData )
1644   {
1645     if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1646         ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1647     {
1648       mImpl->ChangeState( EventData::EDITING );
1649       mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1650       mImpl->mEventData->mUpdateInputStyle = true;
1651     }
1652     mImpl->NotifyImfMultiLineStatus();
1653     if( mImpl->IsShowingPlaceholderText() )
1654     {
1655       // Show alternative placeholder-text when editing
1656       ShowPlaceholderText();
1657     }
1658
1659     mImpl->RequestRelayout();
1660   }
1661 }
1662
1663 void Controller::KeyboardFocusLostEvent()
1664 {
1665   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1666
1667   if( NULL != mImpl->mEventData )
1668   {
1669     if( EventData::INTERRUPTED != mImpl->mEventData->mState )
1670     {
1671       mImpl->ChangeState( EventData::INACTIVE );
1672
1673       if( !mImpl->IsShowingRealText() )
1674       {
1675         // Revert to regular placeholder-text when not editing
1676         ShowPlaceholderText();
1677       }
1678     }
1679   }
1680   mImpl->RequestRelayout();
1681 }
1682
1683 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1684 {
1685   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1686
1687   bool textChanged( false );
1688
1689   if( ( NULL != mImpl->mEventData ) &&
1690       ( keyEvent.state == KeyEvent::Down ) )
1691   {
1692     int keyCode = keyEvent.keyCode;
1693     const std::string& keyString = keyEvent.keyPressed;
1694
1695     // Pre-process to separate modifying events from non-modifying input events.
1696     if( Dali::DALI_KEY_ESCAPE == keyCode )
1697     {
1698       // Escape key is a special case which causes focus loss
1699       KeyboardFocusLostEvent();
1700     }
1701     else if( ( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ) ||
1702              ( Dali::DALI_KEY_CURSOR_RIGHT == keyCode ) ||
1703              ( Dali::DALI_KEY_CURSOR_UP    == keyCode ) ||
1704              ( Dali::DALI_KEY_CURSOR_DOWN  == keyCode ) )
1705     {
1706       Event event( Event::CURSOR_KEY_EVENT );
1707       event.p1.mInt = keyCode;
1708       mImpl->mEventData->mEventQueue.push_back( event );
1709     }
1710     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1711     {
1712       textChanged = BackspaceKeyEvent();
1713     }
1714     else if( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1715     {
1716       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1717       // Avoids calling the InsertText() method which can delete selected text
1718     }
1719     else if( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1720              IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1721     {
1722       mImpl->ChangeState( EventData::INACTIVE );
1723       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1724       // Avoids calling the InsertText() method which can delete selected text
1725     }
1726     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1727     {
1728       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1729       // and a character is typed after the type of a upper case latin character.
1730
1731       // Do nothing.
1732     }
1733     else
1734     {
1735       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1736
1737       // IMF manager is no longer handling key-events
1738       mImpl->ClearPreEditFlag();
1739
1740       InsertText( keyString, COMMIT );
1741       textChanged = true;
1742     }
1743
1744     if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1745          ( mImpl->mEventData->mState != EventData::INACTIVE ) &&
1746          ( Dali::DALI_KEY_SHIFT_LEFT != keyCode ) )
1747     {
1748       // Should not change the state if the key is the shift send by the imf manager.
1749       // Otherwise, when the state is SELECTING the text controller can't send the right
1750       // surrounding info to the imf.
1751       mImpl->ChangeState( EventData::EDITING );
1752     }
1753
1754     mImpl->RequestRelayout();
1755   }
1756
1757   if( textChanged &&
1758       ( NULL != mImpl->mEditableControlInterface ) )
1759   {
1760     // Do this last since it provides callbacks into application code
1761     mImpl->mEditableControlInterface->TextChanged();
1762   }
1763
1764   return true;
1765 }
1766
1767 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1768 {
1769   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1770
1771   if( NULL != mImpl->mEventData )
1772   {
1773     DALI_LOG_INFO( gLogFilter, Debug::Concise, "TapEvent state:%d \n", mImpl->mEventData->mState );
1774     EventData::State state( mImpl->mEventData->mState );
1775     bool relayoutNeeded( false );   // to avoid unnecessary relayouts when tapping an empty text-field
1776
1777     if( mImpl->IsClipboardVisible() )
1778     {
1779       if( EventData::INACTIVE == state || EventData::EDITING == state)
1780       {
1781         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1782       }
1783       relayoutNeeded = true;
1784     }
1785     else if( 1u == tapCount )
1786     {
1787       if( EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state )
1788       {
1789         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );  // If Popup shown hide it here so can be shown again if required.
1790       }
1791
1792       if( mImpl->IsShowingRealText() && ( EventData::INACTIVE != state ) )
1793       {
1794         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1795         relayoutNeeded = true;
1796       }
1797       else
1798       {
1799         if( mImpl->IsShowingPlaceholderText() && !mImpl->IsFocusedPlaceholderAvailable() )
1800         {
1801           // Hide placeholder text
1802           ResetText();
1803         }
1804
1805         if( EventData::INACTIVE == state )
1806         {
1807           mImpl->ChangeState( EventData::EDITING );
1808         }
1809         else if( !mImpl->IsClipboardEmpty() )
1810         {
1811           mImpl->ChangeState( EventData::EDITING_WITH_POPUP );
1812         }
1813         relayoutNeeded = true;
1814       }
1815     }
1816     else if( 2u == tapCount )
1817     {
1818       if( mImpl->mEventData->mSelectionEnabled &&
1819           mImpl->IsShowingRealText() )
1820       {
1821         SelectEvent( x, y, false );
1822       }
1823     }
1824     // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1825     if( relayoutNeeded )
1826     {
1827       Event event( Event::TAP_EVENT );
1828       event.p1.mUint = tapCount;
1829       event.p2.mFloat = x;
1830       event.p3.mFloat = y;
1831       mImpl->mEventData->mEventQueue.push_back( event );
1832
1833       mImpl->RequestRelayout();
1834     }
1835   }
1836
1837   // Reset keyboard as tap event has occurred.
1838   mImpl->ResetImfManager();
1839 }
1840
1841 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1842 {
1843   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1844
1845   if( NULL != mImpl->mEventData )
1846   {
1847     Event event( Event::PAN_EVENT );
1848     event.p1.mInt = state;
1849     event.p2.mFloat = displacement.x;
1850     event.p3.mFloat = displacement.y;
1851     mImpl->mEventData->mEventQueue.push_back( event );
1852
1853     mImpl->RequestRelayout();
1854   }
1855 }
1856
1857 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1858 {
1859   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected LongPressEvent" );
1860
1861   if( ( state == Gesture::Started ) &&
1862       ( NULL != mImpl->mEventData ) )
1863   {
1864     if( !mImpl->IsShowingRealText() )
1865     {
1866       Event event( Event::LONG_PRESS_EVENT );
1867       event.p1.mInt = state;
1868       mImpl->mEventData->mEventQueue.push_back( event );
1869       mImpl->RequestRelayout();
1870     }
1871     else
1872     {
1873       // The 1st long-press on inactive text-field is treated as tap
1874       if( EventData::INACTIVE == mImpl->mEventData->mState )
1875       {
1876         mImpl->ChangeState( EventData::EDITING );
1877
1878         Event event( Event::TAP_EVENT );
1879         event.p1.mUint = 1;
1880         event.p2.mFloat = x;
1881         event.p3.mFloat = y;
1882         mImpl->mEventData->mEventQueue.push_back( event );
1883
1884         mImpl->RequestRelayout();
1885       }
1886       else if( !mImpl->IsClipboardVisible() )
1887       {
1888         // Reset the imf manger to commit the pre-edit before selecting the text.
1889         mImpl->ResetImfManager();
1890
1891         SelectEvent( x, y, false );
1892       }
1893     }
1894   }
1895 }
1896
1897 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1898 {
1899   // Whether the text needs to be relaid-out.
1900   bool requestRelayout = false;
1901
1902   // Whether to retrieve the text and cursor position to be sent to the IMF manager.
1903   bool retrieveText = false;
1904   bool retrieveCursor = false;
1905
1906   switch( imfEvent.eventName )
1907   {
1908     case ImfManager::COMMIT:
1909     {
1910       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1911       requestRelayout = true;
1912       retrieveCursor = true;
1913       break;
1914     }
1915     case ImfManager::PREEDIT:
1916     {
1917       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1918       requestRelayout = true;
1919       retrieveCursor = true;
1920       break;
1921     }
1922     case ImfManager::DELETESURROUNDING:
1923     {
1924       const bool textDeleted = RemoveText( imfEvent.cursorOffset,
1925                                            imfEvent.numberOfChars,
1926                                            DONT_UPDATE_INPUT_STYLE );
1927
1928       if( textDeleted )
1929       {
1930         if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
1931             !mImpl->IsPlaceholderAvailable() )
1932         {
1933           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1934         }
1935         else
1936         {
1937           ShowPlaceholderText();
1938         }
1939         mImpl->mEventData->mUpdateCursorPosition = true;
1940         mImpl->mEventData->mScrollAfterDelete = true;
1941
1942         requestRelayout = true;
1943       }
1944       break;
1945     }
1946     case ImfManager::GETSURROUNDING:
1947     {
1948       retrieveText = true;
1949       retrieveCursor = true;
1950       break;
1951     }
1952     case ImfManager::VOID:
1953     {
1954       // do nothing
1955       break;
1956     }
1957   } // end switch
1958
1959   if( requestRelayout )
1960   {
1961     mImpl->mOperationsPending = ALL_OPERATIONS;
1962     mImpl->RequestRelayout();
1963   }
1964
1965   std::string text;
1966   CharacterIndex cursorPosition = 0u;
1967   Length numberOfWhiteSpaces = 0u;
1968
1969   if( retrieveCursor )
1970   {
1971     numberOfWhiteSpaces = mImpl->GetNumberOfWhiteSpaces( 0u );
1972
1973     cursorPosition = mImpl->GetLogicalCursorPosition();
1974
1975     if( cursorPosition < numberOfWhiteSpaces )
1976     {
1977       cursorPosition = 0u;
1978     }
1979     else
1980     {
1981       cursorPosition -= numberOfWhiteSpaces;
1982     }
1983   }
1984
1985   if( retrieveText )
1986   {
1987     mImpl->GetText( numberOfWhiteSpaces, text );
1988   }
1989
1990   ImfManager::ImfCallbackData callbackData( ( retrieveText || retrieveCursor ), cursorPosition, text, false );
1991
1992   if( requestRelayout &&
1993       ( NULL != mImpl->mEditableControlInterface ) )
1994   {
1995     // Do this last since it provides callbacks into application code
1996     mImpl->mEditableControlInterface->TextChanged();
1997   }
1998
1999   return callbackData;
2000 }
2001
2002 void Controller::PasteClipboardItemEvent()
2003 {
2004   // Retrieve the clipboard contents first
2005   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
2006   std::string stringToPaste( notifier.GetContent() );
2007
2008   // Commit the current pre-edit text; the contents of the clipboard should be appended
2009   mImpl->ResetImfManager();
2010
2011   // Temporary disable hiding clipboard
2012   mImpl->SetClipboardHideEnable( false );
2013
2014   // Paste
2015   PasteText( stringToPaste );
2016
2017   mImpl->SetClipboardHideEnable( true );
2018 }
2019
2020 // protected : Inherit from Text::Decorator::ControllerInterface.
2021
2022 void Controller::GetTargetSize( Vector2& targetSize )
2023 {
2024   targetSize = mImpl->mVisualModel->mControlSize;
2025 }
2026
2027 void Controller::AddDecoration( Actor& actor, bool needsClipping )
2028 {
2029   if( NULL != mImpl->mEditableControlInterface )
2030   {
2031     mImpl->mEditableControlInterface->AddDecoration( actor, needsClipping );
2032   }
2033 }
2034
2035 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
2036 {
2037   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
2038
2039   if( NULL != mImpl->mEventData )
2040   {
2041     switch( handleType )
2042     {
2043       case GRAB_HANDLE:
2044       {
2045         Event event( Event::GRAB_HANDLE_EVENT );
2046         event.p1.mUint  = state;
2047         event.p2.mFloat = x;
2048         event.p3.mFloat = y;
2049
2050         mImpl->mEventData->mEventQueue.push_back( event );
2051         break;
2052       }
2053       case LEFT_SELECTION_HANDLE:
2054       {
2055         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
2056         event.p1.mUint  = state;
2057         event.p2.mFloat = x;
2058         event.p3.mFloat = y;
2059
2060         mImpl->mEventData->mEventQueue.push_back( event );
2061         break;
2062       }
2063       case RIGHT_SELECTION_HANDLE:
2064       {
2065         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
2066         event.p1.mUint  = state;
2067         event.p2.mFloat = x;
2068         event.p3.mFloat = y;
2069
2070         mImpl->mEventData->mEventQueue.push_back( event );
2071         break;
2072       }
2073       case LEFT_SELECTION_HANDLE_MARKER:
2074       case RIGHT_SELECTION_HANDLE_MARKER:
2075       {
2076         // Markers do not move the handles.
2077         break;
2078       }
2079       case HANDLE_TYPE_COUNT:
2080       {
2081         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
2082       }
2083     }
2084
2085     mImpl->RequestRelayout();
2086   }
2087 }
2088
2089 // protected : Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2090
2091 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
2092 {
2093   if( NULL == mImpl->mEventData )
2094   {
2095     return;
2096   }
2097
2098   switch( button )
2099   {
2100     case Toolkit::TextSelectionPopup::CUT:
2101     {
2102       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
2103       mImpl->mOperationsPending = ALL_OPERATIONS;
2104
2105       if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2106           !mImpl->IsPlaceholderAvailable() )
2107       {
2108         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2109       }
2110       else
2111       {
2112         ShowPlaceholderText();
2113       }
2114
2115       mImpl->mEventData->mUpdateCursorPosition = true;
2116       mImpl->mEventData->mScrollAfterDelete = true;
2117
2118       mImpl->RequestRelayout();
2119
2120       if( NULL != mImpl->mEditableControlInterface )
2121       {
2122         mImpl->mEditableControlInterface->TextChanged();
2123       }
2124       break;
2125     }
2126     case Toolkit::TextSelectionPopup::COPY:
2127     {
2128       mImpl->SendSelectionToClipboard( false ); // Text not modified
2129
2130       mImpl->mEventData->mUpdateCursorPosition = true;
2131
2132       mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
2133       break;
2134     }
2135     case Toolkit::TextSelectionPopup::PASTE:
2136     {
2137       mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
2138       break;
2139     }
2140     case Toolkit::TextSelectionPopup::SELECT:
2141     {
2142       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
2143
2144       if( mImpl->mEventData->mSelectionEnabled )
2145       {
2146         // Creates a SELECT event.
2147         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
2148       }
2149       break;
2150     }
2151     case Toolkit::TextSelectionPopup::SELECT_ALL:
2152     {
2153       // Creates a SELECT_ALL event
2154       SelectEvent( 0.f, 0.f, true );
2155       break;
2156     }
2157     case Toolkit::TextSelectionPopup::CLIPBOARD:
2158     {
2159       mImpl->ShowClipboard();
2160       break;
2161     }
2162     case Toolkit::TextSelectionPopup::NONE:
2163     {
2164       // Nothing to do.
2165       break;
2166     }
2167   }
2168 }
2169
2170 // private : Update.
2171
2172 void Controller::InsertText( const std::string& text, Controller::InsertType type )
2173 {
2174   bool removedPrevious( false );
2175   bool maxLengthReached( false );
2176
2177   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
2178
2179   if( NULL == mImpl->mEventData )
2180   {
2181     return;
2182   }
2183
2184   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
2185                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
2186                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2187
2188   // TODO: At the moment the underline runs are only for pre-edit.
2189   mImpl->mVisualModel->mUnderlineRuns.Clear();
2190
2191   // Keep the current number of characters.
2192   const Length currentNumberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2193
2194   // Remove the previous IMF pre-edit.
2195   if( mImpl->mEventData->mPreEditFlag && ( 0u != mImpl->mEventData->mPreEditLength ) )
2196   {
2197     removedPrevious = RemoveText( -static_cast<int>( mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition ),
2198                                   mImpl->mEventData->mPreEditLength,
2199                                   DONT_UPDATE_INPUT_STYLE );
2200
2201     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
2202     mImpl->mEventData->mPreEditLength = 0u;
2203   }
2204   else
2205   {
2206     // Remove the previous Selection.
2207     removedPrevious = RemoveSelectedText();
2208   }
2209
2210   Vector<Character> utf32Characters;
2211   Length characterCount = 0u;
2212
2213   if( !text.empty() )
2214   {
2215     //  Convert text into UTF-32
2216     utf32Characters.Resize( text.size() );
2217
2218     // This is a bit horrible but std::string returns a (signed) char*
2219     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
2220
2221     // Transform a text array encoded in utf8 into an array encoded in utf32.
2222     // It returns the actual number of characters.
2223     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
2224     utf32Characters.Resize( characterCount );
2225
2226     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
2227     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
2228   }
2229
2230   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
2231   {
2232     // The placeholder text is no longer needed
2233     if( mImpl->IsShowingPlaceholderText() )
2234     {
2235       ResetText();
2236     }
2237
2238     mImpl->ChangeState( EventData::EDITING );
2239
2240     // Handle the IMF (predicitive text) state changes
2241     if( COMMIT == type )
2242     {
2243       // IMF manager is no longer handling key-events
2244       mImpl->ClearPreEditFlag();
2245     }
2246     else // PRE_EDIT
2247     {
2248       if( !mImpl->mEventData->mPreEditFlag )
2249       {
2250         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state\n" );
2251
2252         // Record the start of the pre-edit text
2253         mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
2254       }
2255
2256       mImpl->mEventData->mPreEditLength = utf32Characters.Count();
2257       mImpl->mEventData->mPreEditFlag = true;
2258
2259       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2260     }
2261
2262     const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
2263
2264     // Restrict new text to fit within Maximum characters setting.
2265     Length maxSizeOfNewText = std::min( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
2266     maxLengthReached = ( characterCount > maxSizeOfNewText );
2267
2268     // The cursor position.
2269     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2270
2271     // Update the text's style.
2272
2273     // Updates the text style runs by adding characters.
2274     mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, maxSizeOfNewText );
2275
2276     // Get the character index from the cursor index.
2277     const CharacterIndex styleIndex = ( cursorIndex > 0u ) ? cursorIndex - 1u : 0u;
2278
2279     // Retrieve the text's style for the given index.
2280     InputStyle style;
2281     mImpl->RetrieveDefaultInputStyle( style );
2282     mImpl->mLogicalModel->RetrieveStyle( styleIndex, style );
2283
2284     // Whether to add a new text color run.
2285     const bool addColorRun = ( style.textColor != mImpl->mEventData->mInputStyle.textColor );
2286
2287     // Whether to add a new font run.
2288     const bool addFontNameRun = style.familyName != mImpl->mEventData->mInputStyle.familyName;
2289     const bool addFontWeightRun = style.weight != mImpl->mEventData->mInputStyle.weight;
2290     const bool addFontWidthRun = style.width != mImpl->mEventData->mInputStyle.width;
2291     const bool addFontSlantRun = style.slant != mImpl->mEventData->mInputStyle.slant;
2292     const bool addFontSizeRun = style.size != mImpl->mEventData->mInputStyle.size;
2293
2294     // Add style runs.
2295     if( addColorRun )
2296     {
2297       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
2298       mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
2299
2300       ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
2301       colorRun.color = mImpl->mEventData->mInputStyle.textColor;
2302       colorRun.characterRun.characterIndex = cursorIndex;
2303       colorRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2304     }
2305
2306     if( addFontNameRun   ||
2307         addFontWeightRun ||
2308         addFontWidthRun  ||
2309         addFontSlantRun  ||
2310         addFontSizeRun )
2311     {
2312       const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mFontDescriptionRuns.Count();
2313       mImpl->mLogicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
2314
2315       FontDescriptionRun& fontDescriptionRun = *( mImpl->mLogicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
2316
2317       if( addFontNameRun )
2318       {
2319         fontDescriptionRun.familyLength = mImpl->mEventData->mInputStyle.familyName.size();
2320         fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
2321         memcpy( fontDescriptionRun.familyName, mImpl->mEventData->mInputStyle.familyName.c_str(), fontDescriptionRun.familyLength );
2322         fontDescriptionRun.familyDefined = true;
2323
2324         // The memory allocated for the font family name is freed when the font description is removed from the logical model.
2325       }
2326
2327       if( addFontWeightRun )
2328       {
2329         fontDescriptionRun.weight = mImpl->mEventData->mInputStyle.weight;
2330         fontDescriptionRun.weightDefined = true;
2331       }
2332
2333       if( addFontWidthRun )
2334       {
2335         fontDescriptionRun.width = mImpl->mEventData->mInputStyle.width;
2336         fontDescriptionRun.widthDefined = true;
2337       }
2338
2339       if( addFontSlantRun )
2340       {
2341         fontDescriptionRun.slant = mImpl->mEventData->mInputStyle.slant;
2342         fontDescriptionRun.slantDefined = true;
2343       }
2344
2345       if( addFontSizeRun )
2346       {
2347         fontDescriptionRun.size = static_cast<PointSize26Dot6>( mImpl->mEventData->mInputStyle.size * 64.f );
2348         fontDescriptionRun.sizeDefined = true;
2349       }
2350
2351       fontDescriptionRun.characterRun.characterIndex = cursorIndex;
2352       fontDescriptionRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2353     }
2354
2355     // Insert at current cursor position.
2356     Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
2357
2358     if( cursorIndex < numberOfCharactersInModel )
2359     {
2360       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2361     }
2362     else
2363     {
2364       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2365     }
2366
2367     // Mark the first paragraph to be updated.
2368     mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2369     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd += maxSizeOfNewText;
2370
2371     // Update the cursor index.
2372     cursorIndex += maxSizeOfNewText;
2373
2374     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
2375   }
2376
2377   const Length numberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2378
2379   if( ( 0u == mImpl->mLogicalModel->mText.Count() ) &&
2380       mImpl->IsPlaceholderAvailable() )
2381   {
2382     // Show place-holder if empty after removing the pre-edit text
2383     ShowPlaceholderText();
2384     mImpl->mEventData->mUpdateCursorPosition = true;
2385     mImpl->ClearPreEditFlag();
2386   }
2387   else if( removedPrevious ||
2388            ( 0 != utf32Characters.Count() ) )
2389   {
2390     // Queue an inserted event
2391     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
2392
2393     mImpl->mEventData->mUpdateCursorPosition = true;
2394     if( numberOfCharacters < currentNumberOfCharacters )
2395     {
2396       mImpl->mEventData->mScrollAfterDelete = true;
2397     }
2398     else
2399     {
2400       mImpl->mEventData->mScrollAfterUpdatePosition = true;
2401     }
2402   }
2403
2404   if( maxLengthReached )
2405   {
2406     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
2407
2408     mImpl->ResetImfManager();
2409
2410     if( NULL != mImpl->mEditableControlInterface )
2411     {
2412       // Do this last since it provides callbacks into application code
2413       mImpl->mEditableControlInterface->MaxLengthReached();
2414     }
2415   }
2416 }
2417
2418 void Controller::PasteText( const std::string& stringToPaste )
2419 {
2420   InsertText( stringToPaste, Text::Controller::COMMIT );
2421   mImpl->ChangeState( EventData::EDITING );
2422   mImpl->RequestRelayout();
2423
2424   if( NULL != mImpl->mEditableControlInterface )
2425   {
2426     // Do this last since it provides callbacks into application code
2427     mImpl->mEditableControlInterface->TextChanged();
2428   }
2429 }
2430
2431 bool Controller::RemoveText( int cursorOffset,
2432                              int numberOfCharacters,
2433                              UpdateInputStyleType type )
2434 {
2435   bool removed = false;
2436
2437   if( NULL == mImpl->mEventData )
2438   {
2439     return removed;
2440   }
2441
2442   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfCharacters %d\n",
2443                  this, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfCharacters );
2444
2445   if( !mImpl->IsShowingPlaceholderText() )
2446   {
2447     // Delete at current cursor position
2448     Vector<Character>& currentText = mImpl->mLogicalModel->mText;
2449     CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2450
2451     CharacterIndex cursorIndex = oldCursorIndex;
2452
2453     // Validate the cursor position & number of characters
2454     if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
2455     {
2456       cursorIndex = oldCursorIndex + cursorOffset;
2457     }
2458
2459     if( ( cursorIndex + numberOfCharacters ) > currentText.Count() )
2460     {
2461       numberOfCharacters = currentText.Count() - cursorIndex;
2462     }
2463
2464     if( ( cursorIndex + numberOfCharacters ) <= mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters )
2465     {
2466       // Mark the paragraphs to be updated.
2467       mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2468       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove += numberOfCharacters;
2469
2470       // Update the input style and remove the text's style before removing the text.
2471
2472       if( UPDATE_INPUT_STYLE == type )
2473       {
2474         // Keep a copy of the current input style.
2475         InputStyle currentInputStyle;
2476         currentInputStyle.Copy( mImpl->mEventData->mInputStyle );
2477
2478         // Set first the default input style.
2479         mImpl->RetrieveDefaultInputStyle( mImpl->mEventData->mInputStyle );
2480
2481         // Update the input style.
2482         mImpl->mLogicalModel->RetrieveStyle( cursorIndex, mImpl->mEventData->mInputStyle );
2483
2484         // Compare if the input style has changed.
2485         const bool hasInputStyleChanged = !currentInputStyle.Equal( mImpl->mEventData->mInputStyle );
2486
2487         if( hasInputStyleChanged )
2488         {
2489           const InputStyle::Mask styleChangedMask = currentInputStyle.GetInputStyleChangeMask( mImpl->mEventData->mInputStyle );
2490           // Queue the input style changed signal.
2491           mImpl->mEventData->mInputStyleChangedQueue.PushBack( styleChangedMask );
2492         }
2493       }
2494
2495       // Updates the text style runs by removing characters. Runs with no characters are removed.
2496       mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, -numberOfCharacters );
2497
2498       // Remove the characters.
2499       Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
2500       Vector<Character>::Iterator last  = first + numberOfCharacters;
2501
2502       currentText.Erase( first, last );
2503
2504       // Cursor position retreat
2505       oldCursorIndex = cursorIndex;
2506
2507       mImpl->mEventData->mScrollAfterDelete = true;
2508
2509       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfCharacters );
2510       removed = true;
2511     }
2512   }
2513
2514   return removed;
2515 }
2516
2517 bool Controller::RemoveSelectedText()
2518 {
2519   bool textRemoved( false );
2520
2521   if( EventData::SELECTING == mImpl->mEventData->mState )
2522   {
2523     std::string removedString;
2524     mImpl->RetrieveSelection( removedString, true );
2525
2526     if( !removedString.empty() )
2527     {
2528       textRemoved = true;
2529       mImpl->ChangeState( EventData::EDITING );
2530     }
2531   }
2532
2533   return textRemoved;
2534 }
2535
2536 // private : Relayout.
2537
2538 bool Controller::DoRelayout( const Size& size,
2539                              OperationsMask operationsRequired,
2540                              Size& layoutSize )
2541 {
2542   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
2543   bool viewUpdated( false );
2544
2545   // Calculate the operations to be done.
2546   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
2547
2548   const CharacterIndex startIndex = mImpl->mTextUpdateInfo.mParagraphCharacterIndex;
2549   const Length requestedNumberOfCharacters = mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters;
2550
2551   // Get the current layout size.
2552   layoutSize = mImpl->mVisualModel->GetLayoutSize();
2553
2554   if( NO_OPERATION != ( LAYOUT & operations ) )
2555   {
2556     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
2557
2558     // Some vectors with data needed to layout and reorder may be void
2559     // after the first time the text has been laid out.
2560     // Fill the vectors again.
2561
2562     // Calculate the number of glyphs to layout.
2563     const Vector<GlyphIndex>& charactersToGlyph = mImpl->mVisualModel->mCharactersToGlyph;
2564     const Vector<Length>& glyphsPerCharacter = mImpl->mVisualModel->mGlyphsPerCharacter;
2565     const GlyphIndex* const charactersToGlyphBuffer = charactersToGlyph.Begin();
2566     const Length* const glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
2567
2568     const CharacterIndex lastIndex = startIndex + ( ( requestedNumberOfCharacters > 0u ) ? requestedNumberOfCharacters - 1u : 0u );
2569     const GlyphIndex startGlyphIndex = mImpl->mTextUpdateInfo.mStartGlyphIndex;
2570     const Length numberOfGlyphs = ( requestedNumberOfCharacters > 0u ) ? *( charactersToGlyphBuffer + lastIndex ) + *( glyphsPerCharacterBuffer + lastIndex ) - startGlyphIndex : 0u;
2571     const Length totalNumberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
2572
2573     if( 0u == totalNumberOfGlyphs )
2574     {
2575       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2576       {
2577         mImpl->mVisualModel->SetLayoutSize( Size::ZERO );
2578       }
2579
2580       // Nothing else to do if there is no glyphs.
2581       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
2582       return true;
2583     }
2584
2585     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
2586     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
2587     const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
2588     const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
2589     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
2590     const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
2591     const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
2592
2593     // Set the layout parameters.
2594     LayoutParameters layoutParameters( size,
2595                                        textBuffer,
2596                                        lineBreakInfo.Begin(),
2597                                        wordBreakInfo.Begin(),
2598                                        ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
2599                                        glyphs.Begin(),
2600                                        glyphsToCharactersMap.Begin(),
2601                                        charactersPerGlyph.Begin(),
2602                                        charactersToGlyphBuffer,
2603                                        glyphsPerCharacterBuffer,
2604                                        totalNumberOfGlyphs );
2605
2606     // Resize the vector of positions to have the same size than the vector of glyphs.
2607     Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
2608     glyphPositions.Resize( totalNumberOfGlyphs );
2609
2610     // Whether the last character is a new paragraph character.
2611     mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph =  TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
2612     layoutParameters.isLastNewParagraph = mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph;
2613
2614     // The initial glyph and the number of glyphs to layout.
2615     layoutParameters.startGlyphIndex = startGlyphIndex;
2616     layoutParameters.numberOfGlyphs = numberOfGlyphs;
2617     layoutParameters.startLineIndex = mImpl->mTextUpdateInfo.mStartLineIndex;
2618     layoutParameters.estimatedNumberOfLines = mImpl->mTextUpdateInfo.mEstimatedNumberOfLines;
2619
2620     // Update the visual model.
2621     Size newLayoutSize;
2622     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
2623                                                    glyphPositions,
2624                                                    mImpl->mVisualModel->mLines,
2625                                                    newLayoutSize );
2626
2627     viewUpdated = viewUpdated || ( newLayoutSize != layoutSize );
2628
2629     if( viewUpdated )
2630     {
2631       layoutSize = newLayoutSize;
2632
2633       if ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) )
2634       {
2635         mImpl->mAutoScrollDirectionRTL = false;
2636       }
2637
2638       // Reorder the lines
2639       if( NO_OPERATION != ( REORDER & operations ) )
2640       {
2641         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
2642         Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = mImpl->mLogicalModel->mBidirectionalLineInfo;
2643
2644         // Check first if there are paragraphs with bidirectional info.
2645         if( 0u != bidirectionalInfo.Count() )
2646         {
2647           // Get the lines
2648           const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
2649
2650           // Reorder the lines.
2651           bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
2652           ReorderLines( bidirectionalInfo,
2653                         startIndex,
2654                         requestedNumberOfCharacters,
2655                         mImpl->mVisualModel->mLines,
2656                         bidirectionalLineInfo );
2657
2658           // Set the bidirectional info per line into the layout parameters.
2659           layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
2660           layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
2661
2662           // Re-layout the text. Reorder those lines with right to left characters.
2663           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
2664                                                          startIndex,
2665                                                          requestedNumberOfCharacters,
2666                                                          glyphPositions );
2667
2668           if ( ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) ) && ( numberOfLines > 0 ) )
2669           {
2670             const LineRun* const firstline = mImpl->mVisualModel->mLines.Begin();
2671             if ( firstline )
2672             {
2673               mImpl->mAutoScrollDirectionRTL = firstline->direction;
2674             }
2675           }
2676         }
2677       } // REORDER
2678
2679       // Sets the layout size.
2680       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2681       {
2682         mImpl->mVisualModel->SetLayoutSize( layoutSize );
2683       }
2684     } // view updated
2685   }
2686
2687   if( NO_OPERATION != ( ALIGN & operations ) )
2688   {
2689     // The laid-out lines.
2690     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
2691
2692     // Need to align with the control's size as the text may contain lines
2693     // starting either with left to right text or right to left.
2694     mImpl->mLayoutEngine.Align( size,
2695                                 startIndex,
2696                                 requestedNumberOfCharacters,
2697                                 lines,
2698                                 mImpl->mAlignmentOffset );
2699
2700     viewUpdated = true;
2701   }
2702 #if defined(DEBUG_ENABLED)
2703   std::string currentText;
2704   GetText( currentText );
2705   DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mAutoScrollDirectionRTL[%s] [%s]\n", this, (mImpl->mAutoScrollDirectionRTL)?"true":"false",  currentText.c_str() );
2706 #endif
2707   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
2708   return viewUpdated;
2709 }
2710
2711 void Controller::CalculateVerticalOffset( const Size& controlSize )
2712 {
2713   Size layoutSize = mImpl->mVisualModel->GetLayoutSize();
2714
2715   if( fabsf( layoutSize.height ) < Math::MACHINE_EPSILON_1000 )
2716   {
2717     // Get the line height of the default font.
2718     layoutSize.height = mImpl->GetDefaultFontLineHeight();
2719   }
2720
2721   switch( mImpl->mLayoutEngine.GetVerticalAlignment() )
2722   {
2723     case LayoutEngine::VERTICAL_ALIGN_TOP:
2724     {
2725       mImpl->mScrollPosition.y = 0.f;
2726       break;
2727     }
2728     case LayoutEngine::VERTICAL_ALIGN_CENTER:
2729     {
2730       mImpl->mScrollPosition.y = floorf( 0.5f * ( controlSize.height - layoutSize.height ) ); // try to avoid pixel alignment.
2731       break;
2732     }
2733     case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
2734     {
2735       mImpl->mScrollPosition.y = controlSize.height - layoutSize.height;
2736       break;
2737     }
2738   }
2739 }
2740
2741 // private : Events.
2742
2743 void Controller::ProcessModifyEvents()
2744 {
2745   Vector<ModifyEvent>& events = mImpl->mModifyEvents;
2746
2747   if( 0u == events.Count() )
2748   {
2749     // Nothing to do.
2750     return;
2751   }
2752
2753   for( Vector<ModifyEvent>::ConstIterator it = events.Begin(),
2754          endIt = events.End();
2755        it != endIt;
2756        ++it )
2757   {
2758     const ModifyEvent& event = *it;
2759
2760     if( ModifyEvent::TEXT_REPLACED == event.type )
2761     {
2762       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
2763       DALI_ASSERT_DEBUG( it == events.Begin() && "Unexpected TEXT_REPLACED event" );
2764
2765       TextReplacedEvent();
2766     }
2767     else if( ModifyEvent::TEXT_INSERTED == event.type )
2768     {
2769       TextInsertedEvent();
2770     }
2771     else if( ModifyEvent::TEXT_DELETED == event.type )
2772     {
2773       // Placeholder-text cannot be deleted
2774       if( !mImpl->IsShowingPlaceholderText() )
2775       {
2776         TextDeletedEvent();
2777       }
2778     }
2779   }
2780
2781   if( NULL != mImpl->mEventData )
2782   {
2783     // When the text is being modified, delay cursor blinking
2784     mImpl->mEventData->mDecorator->DelayCursorBlink();
2785   }
2786
2787   // Discard temporary text
2788   events.Clear();
2789 }
2790
2791 void Controller::TextReplacedEvent()
2792 {
2793   // The natural size needs to be re-calculated.
2794   mImpl->mRecalculateNaturalSize = true;
2795
2796   // Apply modifications to the model
2797   mImpl->mOperationsPending = ALL_OPERATIONS;
2798 }
2799
2800 void Controller::TextInsertedEvent()
2801 {
2802   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
2803
2804   if( NULL == mImpl->mEventData )
2805   {
2806     return;
2807   }
2808
2809   // The natural size needs to be re-calculated.
2810   mImpl->mRecalculateNaturalSize = true;
2811
2812   // Apply modifications to the model; TODO - Optimize this
2813   mImpl->mOperationsPending = ALL_OPERATIONS;
2814 }
2815
2816 void Controller::TextDeletedEvent()
2817 {
2818   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
2819
2820   if( NULL == mImpl->mEventData )
2821   {
2822     return;
2823   }
2824
2825   // The natural size needs to be re-calculated.
2826   mImpl->mRecalculateNaturalSize = true;
2827
2828   // Apply modifications to the model; TODO - Optimize this
2829   mImpl->mOperationsPending = ALL_OPERATIONS;
2830 }
2831
2832 void Controller::SelectEvent( float x, float y, bool selectAll )
2833 {
2834   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SelectEvent\n" );
2835
2836   if( NULL != mImpl->mEventData )
2837   {
2838     if( selectAll )
2839     {
2840       Event event( Event::SELECT_ALL );
2841       mImpl->mEventData->mEventQueue.push_back( event );
2842     }
2843     else
2844     {
2845       Event event( Event::SELECT );
2846       event.p2.mFloat = x;
2847       event.p3.mFloat = y;
2848       mImpl->mEventData->mEventQueue.push_back( event );
2849     }
2850
2851     mImpl->RequestRelayout();
2852   }
2853 }
2854
2855 bool Controller::BackspaceKeyEvent()
2856 {
2857   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
2858
2859   bool removed = false;
2860
2861   if( NULL == mImpl->mEventData )
2862   {
2863     return removed;
2864   }
2865
2866   // IMF manager is no longer handling key-events
2867   mImpl->ClearPreEditFlag();
2868
2869   if( EventData::SELECTING == mImpl->mEventData->mState )
2870   {
2871     removed = RemoveSelectedText();
2872   }
2873   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
2874   {
2875     // Remove the character before the current cursor position
2876     removed = RemoveText( -1,
2877                           1,
2878                           UPDATE_INPUT_STYLE );
2879   }
2880
2881   if( removed )
2882   {
2883     if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2884         !mImpl->IsPlaceholderAvailable() )
2885     {
2886       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2887     }
2888     else
2889     {
2890       ShowPlaceholderText();
2891     }
2892     mImpl->mEventData->mUpdateCursorPosition = true;
2893     mImpl->mEventData->mScrollAfterDelete = true;
2894   }
2895
2896   return removed;
2897 }
2898
2899 // private : Helpers.
2900
2901 void Controller::ResetText()
2902 {
2903   // Reset buffers.
2904   mImpl->mLogicalModel->mText.Clear();
2905
2906   // We have cleared everything including the placeholder-text
2907   mImpl->PlaceholderCleared();
2908
2909   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2910   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2911   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = 0u;
2912
2913   // Clear any previous text.
2914   mImpl->mTextUpdateInfo.mClearAll = true;
2915
2916   // The natural size needs to be re-calculated.
2917   mImpl->mRecalculateNaturalSize = true;
2918
2919   // Apply modifications to the model
2920   mImpl->mOperationsPending = ALL_OPERATIONS;
2921 }
2922
2923 void Controller::ShowPlaceholderText()
2924 {
2925   if( mImpl->IsPlaceholderAvailable() )
2926   {
2927     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
2928
2929     if( NULL == mImpl->mEventData )
2930     {
2931       return;
2932     }
2933
2934     mImpl->mEventData->mIsShowingPlaceholderText = true;
2935
2936     // Disable handles when showing place-holder text
2937     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
2938     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
2939     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
2940
2941     const char* text( NULL );
2942     size_t size( 0 );
2943
2944     // TODO - Switch placeholder text styles when changing state
2945     if( ( EventData::INACTIVE != mImpl->mEventData->mState ) &&
2946         ( 0u != mImpl->mEventData->mPlaceholderTextActive.c_str() ) )
2947     {
2948       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
2949       size = mImpl->mEventData->mPlaceholderTextActive.size();
2950     }
2951     else
2952     {
2953       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
2954       size = mImpl->mEventData->mPlaceholderTextInactive.size();
2955     }
2956
2957     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2958     mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2959
2960     // Reset model for showing placeholder.
2961     mImpl->mLogicalModel->mText.Clear();
2962     mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
2963
2964     // Convert text into UTF-32
2965     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
2966     utf32Characters.Resize( size );
2967
2968     // This is a bit horrible but std::string returns a (signed) char*
2969     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
2970
2971     // Transform a text array encoded in utf8 into an array encoded in utf32.
2972     // It returns the actual number of characters.
2973     const Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
2974     utf32Characters.Resize( characterCount );
2975
2976     // The characters to be added.
2977     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = characterCount;
2978
2979     // Reset the cursor position
2980     mImpl->mEventData->mPrimaryCursorPosition = 0;
2981
2982     // The natural size needs to be re-calculated.
2983     mImpl->mRecalculateNaturalSize = true;
2984
2985     // Apply modifications to the model
2986     mImpl->mOperationsPending = ALL_OPERATIONS;
2987
2988     // Update the rest of the model during size negotiation
2989     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
2990   }
2991 }
2992
2993 void Controller::ClearFontData()
2994 {
2995   if( mImpl->mFontDefaults )
2996   {
2997     mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
2998   }
2999
3000   // Set flags to update the model.
3001   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
3002   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
3003   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
3004
3005   mImpl->mTextUpdateInfo.mClearAll = true;
3006   mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
3007   mImpl->mRecalculateNaturalSize = true;
3008
3009   mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
3010                                                            VALIDATE_FONTS            |
3011                                                            SHAPE_TEXT                |
3012                                                            GET_GLYPH_METRICS         |
3013                                                            LAYOUT                    |
3014                                                            UPDATE_LAYOUT_SIZE        |
3015                                                            REORDER                   |
3016                                                            ALIGN );
3017 }
3018
3019 void Controller::ClearStyleData()
3020 {
3021   mImpl->mLogicalModel->mColorRuns.Clear();
3022   mImpl->mLogicalModel->ClearFontDescriptionRuns();
3023 }
3024
3025 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
3026 {
3027   // Reset the cursor position
3028   if( NULL != mImpl->mEventData )
3029   {
3030     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
3031
3032     // Update the cursor if it's in editing mode.
3033     if( EventData::IsEditingState( mImpl->mEventData->mState )  )
3034     {
3035       mImpl->mEventData->mUpdateCursorPosition = true;
3036     }
3037   }
3038 }
3039
3040 void Controller::ResetScrollPosition()
3041 {
3042   if( NULL != mImpl->mEventData )
3043   {
3044     // Reset the scroll position.
3045     mImpl->mScrollPosition = Vector2::ZERO;
3046     mImpl->mEventData->mScrollAfterUpdatePosition = true;
3047   }
3048 }
3049
3050 // private : Private contructors & copy operator.
3051
3052 Controller::Controller()
3053 : mImpl( NULL )
3054 {
3055   mImpl = new Controller::Impl( NULL, NULL );
3056 }
3057
3058 Controller::Controller( ControlInterface* controlInterface )
3059 {
3060   mImpl = new Controller::Impl( controlInterface, NULL );
3061 }
3062
3063 Controller::Controller( ControlInterface* controlInterface,
3064                         EditableControlInterface* editableControlInterface )
3065 {
3066   mImpl = new Controller::Impl( controlInterface,
3067                                 editableControlInterface );
3068 }
3069
3070 // The copy constructor and operator are left unimplemented.
3071
3072 // protected : Destructor.
3073
3074 Controller::~Controller()
3075 {
3076   delete mImpl;
3077 }
3078
3079 } // namespace Text
3080
3081 } // namespace Toolkit
3082
3083 } // namespace Dali