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