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

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