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