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