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