2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/text/text-controller.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>
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>
39 #if defined(DEBUG_ENABLED)
40 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
43 const float MAX_FLOAT = std::numeric_limits<float>::max();
45 const std::string EMPTY_STRING("");
47 float ConvertToEven( float value )
49 int intValue(static_cast<int>( value ));
50 return static_cast<float>(intValue % 2 == 0) ? intValue : (intValue + 1);
65 * @brief Adds a new font description run for the selected text.
67 * The new font parameters are added after the call to this method.
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.
74 FontDescriptionRun& UpdateSelectionFontStyleRun( EventData* eventData,
75 LogicalModelPtr logicalModel,
76 CharacterIndex& startOfSelectedText,
77 Length& lengthOfSelectedText )
79 const bool handlesCrossed = eventData->mLeftSelectionPosition > eventData->mRightSelectionPosition;
81 // Get start and end position of selection
82 startOfSelectedText = handlesCrossed ? eventData->mRightSelectionPosition : eventData->mLeftSelectionPosition;
83 lengthOfSelectedText = ( handlesCrossed ? eventData->mLeftSelectionPosition : eventData->mRightSelectionPosition ) - startOfSelectedText;
86 const VectorBase::SizeType numberOfRuns = logicalModel->mFontDescriptionRuns.Count();
87 logicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
89 FontDescriptionRun& fontDescriptionRun = *( logicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
91 fontDescriptionRun.characterRun.characterIndex = startOfSelectedText;
92 fontDescriptionRun.characterRun.numberOfCharacters = lengthOfSelectedText;
94 // Recalculate the selection highlight as the metrics may have changed.
95 eventData->mUpdateLeftSelectionPosition = true;
96 eventData->mUpdateRightSelectionPosition = true;
97 eventData->mUpdateHighlightBox = true;
99 return fontDescriptionRun;
102 // public : Constructor.
104 ControllerPtr Controller::New()
106 return ControllerPtr( new Controller() );
109 ControllerPtr Controller::New( ControlInterface* controlInterface )
111 return ControllerPtr( new Controller( controlInterface ) );
114 ControllerPtr Controller::New( ControlInterface* controlInterface,
115 EditableControlInterface* editableControlInterface )
117 return ControllerPtr( new Controller( controlInterface,
118 editableControlInterface ) );
121 // public : Configure the text controller.
123 void Controller::EnableTextInput( DecoratorPtr decorator )
125 if( NULL == mImpl->mEventData )
127 mImpl->mEventData = new EventData( decorator );
131 void Controller::SetGlyphType( TextAbstraction::GlyphType glyphType )
133 // Metrics for bitmap & vector based glyphs are different
134 mImpl->mMetrics->SetGlyphType( glyphType );
136 // Clear the font-specific data
139 mImpl->RequestRelayout();
142 void Controller::SetMarkupProcessorEnabled( bool enable )
144 mImpl->mMarkupProcessorEnabled = enable;
147 bool Controller::IsMarkupProcessorEnabled() const
149 return mImpl->mMarkupProcessorEnabled;
152 void Controller::SetAutoScrollEnabled( bool enable )
154 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled[%s] SingleBox[%s]-> [%p]\n", (enable)?"true":"false", ( mImpl->mLayoutEngine.GetLayout() == LayoutEngine::SINGLE_LINE_BOX)?"true":"false", this );
156 if( mImpl->mLayoutEngine.GetLayout() == LayoutEngine::SINGLE_LINE_BOX )
160 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled for SINGLE_LINE_BOX\n" );
161 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
171 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled Disabling autoscroll\n");
172 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
179 mImpl->mIsAutoScrollEnabled = enable;
180 mImpl->RequestRelayout();
184 DALI_LOG_WARNING( "Attempted AutoScrolling on a non SINGLE_LINE_BOX, request ignored\n" );
185 mImpl->mIsAutoScrollEnabled = false;
189 bool Controller::IsAutoScrollEnabled() const
191 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", mImpl->mIsAutoScrollEnabled?"true":"false" );
193 return mImpl->mIsAutoScrollEnabled;
196 CharacterDirection Controller::GetAutoScrollDirection() const
198 return mImpl->mAutoScrollDirectionRTL;
201 float Controller::GetAutoScrollLineAlignment() const
205 if( mImpl->mVisualModel &&
206 ( 0u != mImpl->mVisualModel->mLines.Count() ) )
208 offset = ( *mImpl->mVisualModel->mLines.Begin() ).alignmentOffset;
214 void Controller::SetHorizontalScrollEnabled( bool enable )
216 if( ( NULL != mImpl->mEventData ) &&
217 mImpl->mEventData->mDecorator )
219 mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled( enable );
223 bool Controller::IsHorizontalScrollEnabled() const
225 if( ( NULL != mImpl->mEventData ) &&
226 mImpl->mEventData->mDecorator )
228 return mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
234 void Controller::SetVerticalScrollEnabled( bool enable )
236 if( ( NULL != mImpl->mEventData ) &&
237 mImpl->mEventData->mDecorator )
239 if( mImpl->mEventData->mDecorator )
241 mImpl->mEventData->mDecorator->SetVerticalScrollEnabled( enable );
246 bool Controller::IsVerticalScrollEnabled() const
248 if( ( NULL != mImpl->mEventData ) &&
249 mImpl->mEventData->mDecorator )
251 return mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
257 void Controller::SetSmoothHandlePanEnabled( bool enable )
259 if( ( NULL != mImpl->mEventData ) &&
260 mImpl->mEventData->mDecorator )
262 mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled( enable );
266 bool Controller::IsSmoothHandlePanEnabled() const
268 if( ( NULL != mImpl->mEventData ) &&
269 mImpl->mEventData->mDecorator )
271 return mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
277 void Controller::SetMaximumNumberOfCharacters( Length maxCharacters )
279 mImpl->mMaximumNumberOfCharacters = maxCharacters;
282 int Controller::GetMaximumNumberOfCharacters()
284 return mImpl->mMaximumNumberOfCharacters;
287 void Controller::SetEnableCursorBlink( bool enable )
289 DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "TextInput disabled" );
291 if( NULL != mImpl->mEventData )
293 mImpl->mEventData->mCursorBlinkEnabled = enable;
296 mImpl->mEventData->mDecorator )
298 mImpl->mEventData->mDecorator->StopCursorBlink();
303 bool Controller::GetEnableCursorBlink() const
305 if( NULL != mImpl->mEventData )
307 return mImpl->mEventData->mCursorBlinkEnabled;
313 void Controller::SetMultiLineEnabled( bool enable )
315 const LayoutEngine::Layout layout = enable ? LayoutEngine::MULTI_LINE_BOX : LayoutEngine::SINGLE_LINE_BOX;
317 if( layout != mImpl->mLayoutEngine.GetLayout() )
319 // Set the layout type.
320 mImpl->mLayoutEngine.SetLayout( layout );
322 // Set the flags to redo the layout operations
323 const OperationsMask layoutOperations = static_cast<OperationsMask>( LAYOUT |
328 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | layoutOperations );
330 mImpl->RequestRelayout();
334 bool Controller::IsMultiLineEnabled() const
336 return LayoutEngine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
339 void Controller::SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment )
341 if( alignment != mImpl->mLayoutEngine.GetHorizontalAlignment() )
343 // Set the alignment.
344 mImpl->mLayoutEngine.SetHorizontalAlignment( alignment );
346 // Set the flag to redo the alignment operation.
347 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
349 mImpl->RequestRelayout();
353 LayoutEngine::HorizontalAlignment Controller::GetHorizontalAlignment() const
355 return mImpl->mLayoutEngine.GetHorizontalAlignment();
358 void Controller::SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment )
360 if( alignment != mImpl->mLayoutEngine.GetVerticalAlignment() )
362 // Set the alignment.
363 mImpl->mLayoutEngine.SetVerticalAlignment( alignment );
365 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
367 mImpl->RequestRelayout();
371 LayoutEngine::VerticalAlignment Controller::GetVerticalAlignment() const
373 return mImpl->mLayoutEngine.GetVerticalAlignment();
378 void Controller::SetText( const std::string& text )
380 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText\n" );
382 // Reset keyboard as text changed
383 mImpl->ResetImfManager();
385 // Remove the previously set text and style.
391 CharacterIndex lastCursorIndex = 0u;
393 if( NULL != mImpl->mEventData )
395 // If popup shown then hide it by switching to Editing state
396 if( ( EventData::SELECTING == mImpl->mEventData->mState ) ||
397 ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
398 ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) ||
399 ( EventData::EDITING_WITH_PASTE_POPUP == mImpl->mEventData->mState ) )
401 mImpl->ChangeState( EventData::EDITING );
407 mImpl->mVisualModel->SetTextColor( mImpl->mTextColor );
409 MarkupProcessData markupProcessData( mImpl->mLogicalModel->mColorRuns,
410 mImpl->mLogicalModel->mFontDescriptionRuns );
412 Length textSize = 0u;
413 const uint8_t* utf8 = NULL;
414 if( mImpl->mMarkupProcessorEnabled )
416 ProcessMarkupString( text, markupProcessData );
417 textSize = markupProcessData.markupProcessedText.size();
419 // This is a bit horrible but std::string returns a (signed) char*
420 utf8 = reinterpret_cast<const uint8_t*>( markupProcessData.markupProcessedText.c_str() );
424 textSize = text.size();
426 // This is a bit horrible but std::string returns a (signed) char*
427 utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
430 // Convert text into UTF-32
431 Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
432 utf32Characters.Resize( textSize );
434 // Transform a text array encoded in utf8 into an array encoded in utf32.
435 // It returns the actual number of characters.
436 Length characterCount = Utf8ToUtf32( utf8, textSize, utf32Characters.Begin() );
437 utf32Characters.Resize( characterCount );
439 DALI_ASSERT_DEBUG( textSize >= characterCount && "Invalid UTF32 conversion length" );
440 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText %p UTF8 size %d, UTF32 size %d\n", this, textSize, mImpl->mLogicalModel->mText.Count() );
442 // The characters to be added.
443 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
445 // To reset the cursor position
446 lastCursorIndex = characterCount;
448 // Update the rest of the model during size negotiation
449 mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
451 // The natural size needs to be re-calculated.
452 mImpl->mRecalculateNaturalSize = true;
454 // Apply modifications to the model
455 mImpl->mOperationsPending = ALL_OPERATIONS;
459 ShowPlaceholderText();
462 // Resets the cursor position.
463 ResetCursorPosition( lastCursorIndex );
465 // Scrolls the text to make the cursor visible.
466 ResetScrollPosition();
468 mImpl->RequestRelayout();
470 if( NULL != mImpl->mEventData )
472 // Cancel previously queued events
473 mImpl->mEventData->mEventQueue.clear();
476 // Do this last since it provides callbacks into application code.
477 if( NULL != mImpl->mEditableControlInterface )
479 mImpl->mEditableControlInterface->TextChanged();
483 void Controller::GetText( std::string& text ) const
485 if( !mImpl->IsShowingPlaceholderText() )
487 // Retrieves the text string.
488 mImpl->GetText( 0u, text );
492 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::GetText %p empty (but showing placeholder)\n", this );
496 void Controller::SetPlaceholderText( PlaceholderType type, const std::string& text )
498 if( NULL != mImpl->mEventData )
500 if( PLACEHOLDER_TYPE_INACTIVE == type )
502 mImpl->mEventData->mPlaceholderTextInactive = text;
506 mImpl->mEventData->mPlaceholderTextActive = text;
509 // Update placeholder if there is no text
510 if( mImpl->IsShowingPlaceholderText() ||
511 ( 0u == mImpl->mLogicalModel->mText.Count() ) )
513 ShowPlaceholderText();
518 void Controller::GetPlaceholderText( PlaceholderType type, std::string& text ) const
520 if( NULL != mImpl->mEventData )
522 if( PLACEHOLDER_TYPE_INACTIVE == type )
524 text = mImpl->mEventData->mPlaceholderTextInactive;
528 text = mImpl->mEventData->mPlaceholderTextActive;
533 void Controller::UpdateAfterFontChange( const std::string& newDefaultFont )
535 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::UpdateAfterFontChange\n");
537 if( !mImpl->mFontDefaults->familyDefined ) // If user defined font then should not update when system font changes
539 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::UpdateAfterFontChange newDefaultFont(%s)\n", newDefaultFont.c_str() );
540 mImpl->mFontDefaults->mFontDescription.family = newDefaultFont;
544 mImpl->RequestRelayout();
548 // public : Default style & Input style
550 void Controller::SetDefaultFontFamily( const std::string& defaultFontFamily )
552 if( NULL == mImpl->mFontDefaults )
554 mImpl->mFontDefaults = new FontDefaults();
557 mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
558 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
559 mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
561 // Clear the font-specific data
564 mImpl->RequestRelayout();
567 const std::string& Controller::GetDefaultFontFamily() const
569 if( NULL != mImpl->mFontDefaults )
571 return mImpl->mFontDefaults->mFontDescription.family;
577 void Controller::SetDefaultFontWeight( FontWeight weight )
579 if( NULL == mImpl->mFontDefaults )
581 mImpl->mFontDefaults = new FontDefaults();
584 mImpl->mFontDefaults->mFontDescription.weight = weight;
585 mImpl->mFontDefaults->weightDefined = true;
587 // Clear the font-specific data
590 mImpl->RequestRelayout();
593 bool Controller::IsDefaultFontWeightDefined() const
595 return mImpl->mFontDefaults->weightDefined;
598 FontWeight Controller::GetDefaultFontWeight() const
600 if( NULL != mImpl->mFontDefaults )
602 return mImpl->mFontDefaults->mFontDescription.weight;
605 return TextAbstraction::FontWeight::NORMAL;
608 void Controller::SetDefaultFontWidth( FontWidth width )
610 if( NULL == mImpl->mFontDefaults )
612 mImpl->mFontDefaults = new FontDefaults();
615 mImpl->mFontDefaults->mFontDescription.width = width;
616 mImpl->mFontDefaults->widthDefined = true;
618 // Clear the font-specific data
621 mImpl->RequestRelayout();
624 bool Controller::IsDefaultFontWidthDefined() const
626 return mImpl->mFontDefaults->widthDefined;
629 FontWidth Controller::GetDefaultFontWidth() const
631 if( NULL != mImpl->mFontDefaults )
633 return mImpl->mFontDefaults->mFontDescription.width;
636 return TextAbstraction::FontWidth::NORMAL;
639 void Controller::SetDefaultFontSlant( FontSlant slant )
641 if( NULL == mImpl->mFontDefaults )
643 mImpl->mFontDefaults = new FontDefaults();
646 mImpl->mFontDefaults->mFontDescription.slant = slant;
647 mImpl->mFontDefaults->slantDefined = true;
649 // Clear the font-specific data
652 mImpl->RequestRelayout();
655 bool Controller::IsDefaultFontSlantDefined() const
657 return mImpl->mFontDefaults->slantDefined;
660 FontSlant Controller::GetDefaultFontSlant() const
662 if( NULL != mImpl->mFontDefaults )
664 return mImpl->mFontDefaults->mFontDescription.slant;
667 return TextAbstraction::FontSlant::NORMAL;
670 void Controller::SetDefaultPointSize( float pointSize )
672 if( NULL == mImpl->mFontDefaults )
674 mImpl->mFontDefaults = new FontDefaults();
677 mImpl->mFontDefaults->mDefaultPointSize = pointSize;
678 mImpl->mFontDefaults->sizeDefined = true;
680 // Clear the font-specific data
683 mImpl->RequestRelayout();
686 float Controller::GetDefaultPointSize() const
688 if( NULL != mImpl->mFontDefaults )
690 return mImpl->mFontDefaults->mDefaultPointSize;
696 void Controller::SetTextColor( const Vector4& textColor )
698 mImpl->mTextColor = textColor;
700 if( !mImpl->IsShowingPlaceholderText() )
702 mImpl->mVisualModel->SetTextColor( textColor );
704 mImpl->RequestRelayout();
708 const Vector4& Controller::GetTextColor() const
710 return mImpl->mTextColor;
713 void Controller::SetPlaceholderTextColor( const Vector4& textColor )
715 if( NULL != mImpl->mEventData )
717 mImpl->mEventData->mPlaceholderTextColor = textColor;
720 if( mImpl->IsShowingPlaceholderText() )
722 mImpl->mVisualModel->SetTextColor( textColor );
723 mImpl->RequestRelayout();
727 const Vector4& Controller::GetPlaceholderTextColor() const
729 if( NULL != mImpl->mEventData )
731 return mImpl->mEventData->mPlaceholderTextColor;
737 void Controller::SetShadowOffset( const Vector2& shadowOffset )
739 mImpl->mVisualModel->SetShadowOffset( shadowOffset );
741 mImpl->RequestRelayout();
744 const Vector2& Controller::GetShadowOffset() const
746 return mImpl->mVisualModel->GetShadowOffset();
749 void Controller::SetShadowColor( const Vector4& shadowColor )
751 mImpl->mVisualModel->SetShadowColor( shadowColor );
753 mImpl->RequestRelayout();
756 const Vector4& Controller::GetShadowColor() const
758 return mImpl->mVisualModel->GetShadowColor();
761 void Controller::SetUnderlineColor( const Vector4& color )
763 mImpl->mVisualModel->SetUnderlineColor( color );
765 mImpl->RequestRelayout();
768 const Vector4& Controller::GetUnderlineColor() const
770 return mImpl->mVisualModel->GetUnderlineColor();
773 void Controller::SetUnderlineEnabled( bool enabled )
775 mImpl->mVisualModel->SetUnderlineEnabled( enabled );
777 mImpl->RequestRelayout();
780 bool Controller::IsUnderlineEnabled() const
782 return mImpl->mVisualModel->IsUnderlineEnabled();
785 void Controller::SetUnderlineHeight( float height )
787 mImpl->mVisualModel->SetUnderlineHeight( height );
789 mImpl->RequestRelayout();
792 float Controller::GetUnderlineHeight() const
794 return mImpl->mVisualModel->GetUnderlineHeight();
797 void Controller::SetDefaultEmbossProperties( const std::string& embossProperties )
799 if( NULL == mImpl->mEmbossDefaults )
801 mImpl->mEmbossDefaults = new EmbossDefaults();
804 mImpl->mEmbossDefaults->properties = embossProperties;
807 const std::string& Controller::GetDefaultEmbossProperties() const
809 if( NULL != mImpl->mEmbossDefaults )
811 return mImpl->mEmbossDefaults->properties;
817 void Controller::SetDefaultOutlineProperties( const std::string& outlineProperties )
819 if( NULL == mImpl->mOutlineDefaults )
821 mImpl->mOutlineDefaults = new OutlineDefaults();
824 mImpl->mOutlineDefaults->properties = outlineProperties;
827 const std::string& Controller::GetDefaultOutlineProperties() const
829 if( NULL != mImpl->mOutlineDefaults )
831 return mImpl->mOutlineDefaults->properties;
837 void Controller::SetDefaultLineSpacing( float lineSpacing )
839 //TODO finish implementation
840 mImpl->mLayoutEngine.SetDefaultLineSpacing( lineSpacing );
843 float Controller::GetDefaultLineSpacing() const
845 return mImpl->mLayoutEngine.GetDefaultLineSpacing();
848 void Controller::SetInputColor( const Vector4& color )
850 if( NULL != mImpl->mEventData )
852 mImpl->mEventData->mInputStyle.textColor = color;
853 mImpl->mEventData->mInputStyle.isDefaultColor = false;
855 if( EventData::SELECTING == mImpl->mEventData->mState )
857 const bool handlesCrossed = mImpl->mEventData->mLeftSelectionPosition > mImpl->mEventData->mRightSelectionPosition;
859 // Get start and end position of selection
860 const CharacterIndex startOfSelectedText = handlesCrossed ? mImpl->mEventData->mRightSelectionPosition : mImpl->mEventData->mLeftSelectionPosition;
861 const Length lengthOfSelectedText = ( handlesCrossed ? mImpl->mEventData->mLeftSelectionPosition : mImpl->mEventData->mRightSelectionPosition ) - startOfSelectedText;
863 // Add the color run.
864 const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
865 mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
867 ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
868 colorRun.color = color;
869 colorRun.characterRun.characterIndex = startOfSelectedText;
870 colorRun.characterRun.numberOfCharacters = lengthOfSelectedText;
872 // Request to relayout.
873 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | COLOR );
874 mImpl->RequestRelayout();
876 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
877 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
878 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
883 const Vector4& Controller::GetInputColor() const
885 if( NULL != mImpl->mEventData )
887 return mImpl->mEventData->mInputStyle.textColor;
890 // Return the default text's color if there is no EventData.
891 return mImpl->mTextColor;
895 void Controller::SetInputFontFamily( const std::string& fontFamily )
897 if( NULL != mImpl->mEventData )
899 mImpl->mEventData->mInputStyle.familyName = fontFamily;
900 mImpl->mEventData->mInputStyle.isFamilyDefined = true;
902 if( EventData::SELECTING == mImpl->mEventData->mState )
904 CharacterIndex startOfSelectedText = 0u;
905 Length lengthOfSelectedText = 0u;
906 FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
907 mImpl->mLogicalModel,
909 lengthOfSelectedText );
911 fontDescriptionRun.familyLength = fontFamily.size();
912 fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
913 memcpy( fontDescriptionRun.familyName, fontFamily.c_str(), fontDescriptionRun.familyLength );
914 fontDescriptionRun.familyDefined = true;
916 // The memory allocated for the font family name is freed when the font description is removed from the logical model.
918 // Request to relayout.
919 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
927 mImpl->mRecalculateNaturalSize = true;
928 mImpl->RequestRelayout();
930 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
931 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
932 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
934 // As the font changes, recalculate the handle positions is needed.
935 mImpl->mEventData->mUpdateLeftSelectionPosition = true;
936 mImpl->mEventData->mUpdateRightSelectionPosition = true;
937 mImpl->mEventData->mUpdateHighlightBox = true;
938 mImpl->mEventData->mScrollAfterUpdatePosition = true;
943 const std::string& Controller::GetInputFontFamily() const
945 if( NULL != mImpl->mEventData )
947 return mImpl->mEventData->mInputStyle.familyName;
950 // Return the default font's family if there is no EventData.
951 return GetDefaultFontFamily();
954 void Controller::SetInputFontWeight( FontWeight weight )
956 if( NULL != mImpl->mEventData )
958 mImpl->mEventData->mInputStyle.weight = weight;
959 mImpl->mEventData->mInputStyle.isWeightDefined = true;
961 if( EventData::SELECTING == mImpl->mEventData->mState )
963 CharacterIndex startOfSelectedText = 0u;
964 Length lengthOfSelectedText = 0u;
965 FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
966 mImpl->mLogicalModel,
968 lengthOfSelectedText );
970 fontDescriptionRun.weight = weight;
971 fontDescriptionRun.weightDefined = true;
973 // Request to relayout.
974 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
982 mImpl->mRecalculateNaturalSize = true;
983 mImpl->RequestRelayout();
985 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
986 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
987 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
989 // As the font might change, recalculate the handle positions is needed.
990 mImpl->mEventData->mUpdateLeftSelectionPosition = true;
991 mImpl->mEventData->mUpdateRightSelectionPosition = true;
992 mImpl->mEventData->mUpdateHighlightBox = true;
993 mImpl->mEventData->mScrollAfterUpdatePosition = true;
998 bool Controller::IsInputFontWeightDefined() const
1000 bool defined = false;
1002 if( NULL != mImpl->mEventData )
1004 defined = mImpl->mEventData->mInputStyle.isWeightDefined;
1010 FontWeight Controller::GetInputFontWeight() const
1012 if( NULL != mImpl->mEventData )
1014 return mImpl->mEventData->mInputStyle.weight;
1017 return GetDefaultFontWeight();
1020 void Controller::SetInputFontWidth( FontWidth width )
1022 if( NULL != mImpl->mEventData )
1024 mImpl->mEventData->mInputStyle.width = width;
1025 mImpl->mEventData->mInputStyle.isWidthDefined = true;
1027 if( EventData::SELECTING == mImpl->mEventData->mState )
1029 CharacterIndex startOfSelectedText = 0u;
1030 Length lengthOfSelectedText = 0u;
1031 FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1032 mImpl->mLogicalModel,
1033 startOfSelectedText,
1034 lengthOfSelectedText );
1036 fontDescriptionRun.width = width;
1037 fontDescriptionRun.widthDefined = true;
1039 // Request to relayout.
1040 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1045 UPDATE_LAYOUT_SIZE |
1048 mImpl->mRecalculateNaturalSize = true;
1049 mImpl->RequestRelayout();
1051 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1052 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1053 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1055 // As the font might change, recalculate the handle positions is needed.
1056 mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1057 mImpl->mEventData->mUpdateRightSelectionPosition = true;
1058 mImpl->mEventData->mUpdateHighlightBox = true;
1059 mImpl->mEventData->mScrollAfterUpdatePosition = true;
1064 bool Controller::IsInputFontWidthDefined() const
1066 bool defined = false;
1068 if( NULL != mImpl->mEventData )
1070 defined = mImpl->mEventData->mInputStyle.isWidthDefined;
1076 FontWidth Controller::GetInputFontWidth() const
1078 if( NULL != mImpl->mEventData )
1080 return mImpl->mEventData->mInputStyle.width;
1083 return GetDefaultFontWidth();
1086 void Controller::SetInputFontSlant( FontSlant slant )
1088 if( NULL != mImpl->mEventData )
1090 mImpl->mEventData->mInputStyle.slant = slant;
1091 mImpl->mEventData->mInputStyle.isSlantDefined = true;
1093 if( EventData::SELECTING == mImpl->mEventData->mState )
1095 CharacterIndex startOfSelectedText = 0u;
1096 Length lengthOfSelectedText = 0u;
1097 FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1098 mImpl->mLogicalModel,
1099 startOfSelectedText,
1100 lengthOfSelectedText );
1102 fontDescriptionRun.slant = slant;
1103 fontDescriptionRun.slantDefined = true;
1105 // Request to relayout.
1106 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1111 UPDATE_LAYOUT_SIZE |
1114 mImpl->mRecalculateNaturalSize = true;
1115 mImpl->RequestRelayout();
1117 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1118 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1119 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1121 // As the font might change, recalculate the handle positions is needed.
1122 mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1123 mImpl->mEventData->mUpdateRightSelectionPosition = true;
1124 mImpl->mEventData->mUpdateHighlightBox = true;
1125 mImpl->mEventData->mScrollAfterUpdatePosition = true;
1130 bool Controller::IsInputFontSlantDefined() const
1132 bool defined = false;
1134 if( NULL != mImpl->mEventData )
1136 defined = mImpl->mEventData->mInputStyle.isSlantDefined;
1142 FontSlant Controller::GetInputFontSlant() const
1144 if( NULL != mImpl->mEventData )
1146 return mImpl->mEventData->mInputStyle.slant;
1149 return GetDefaultFontSlant();
1152 void Controller::SetInputFontPointSize( float size )
1154 if( NULL != mImpl->mEventData )
1156 mImpl->mEventData->mInputStyle.size = size;
1157 mImpl->mEventData->mInputStyle.isSizeDefined = true;
1159 if( EventData::SELECTING == mImpl->mEventData->mState )
1161 CharacterIndex startOfSelectedText = 0u;
1162 Length lengthOfSelectedText = 0u;
1163 FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1164 mImpl->mLogicalModel,
1165 startOfSelectedText,
1166 lengthOfSelectedText );
1168 fontDescriptionRun.size = static_cast<PointSize26Dot6>( size * 64.f );
1169 fontDescriptionRun.sizeDefined = true;
1171 // Request to relayout.
1172 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1177 UPDATE_LAYOUT_SIZE |
1180 mImpl->mRecalculateNaturalSize = true;
1181 mImpl->RequestRelayout();
1183 mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1184 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1185 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1187 // As the font might change, recalculate the handle positions is needed.
1188 mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1189 mImpl->mEventData->mUpdateRightSelectionPosition = true;
1190 mImpl->mEventData->mUpdateHighlightBox = true;
1191 mImpl->mEventData->mScrollAfterUpdatePosition = true;
1196 float Controller::GetInputFontPointSize() const
1198 if( NULL != mImpl->mEventData )
1200 return mImpl->mEventData->mInputStyle.size;
1203 // Return the default font's point size if there is no EventData.
1204 return GetDefaultPointSize();
1207 void Controller::SetInputLineSpacing( float lineSpacing )
1209 if( NULL != mImpl->mEventData )
1211 mImpl->mEventData->mInputStyle.lineSpacing = lineSpacing;
1212 mImpl->mEventData->mInputStyle.isLineSpacingDefined = true;
1216 float Controller::GetInputLineSpacing() const
1218 if( NULL != mImpl->mEventData )
1220 return mImpl->mEventData->mInputStyle.lineSpacing;
1226 void Controller::SetInputShadowProperties( const std::string& shadowProperties )
1228 if( NULL != mImpl->mEventData )
1230 mImpl->mEventData->mInputStyle.shadowProperties = shadowProperties;
1234 const std::string& Controller::GetInputShadowProperties() const
1236 if( NULL != mImpl->mEventData )
1238 return mImpl->mEventData->mInputStyle.shadowProperties;
1241 return EMPTY_STRING;
1244 void Controller::SetInputUnderlineProperties( const std::string& underlineProperties )
1246 if( NULL != mImpl->mEventData )
1248 mImpl->mEventData->mInputStyle.underlineProperties = underlineProperties;
1252 const std::string& Controller::GetInputUnderlineProperties() const
1254 if( NULL != mImpl->mEventData )
1256 return mImpl->mEventData->mInputStyle.underlineProperties;
1259 return EMPTY_STRING;
1262 void Controller::SetInputEmbossProperties( const std::string& embossProperties )
1264 if( NULL != mImpl->mEventData )
1266 mImpl->mEventData->mInputStyle.embossProperties = embossProperties;
1270 const std::string& Controller::GetInputEmbossProperties() const
1272 if( NULL != mImpl->mEventData )
1274 return mImpl->mEventData->mInputStyle.embossProperties;
1277 return GetDefaultEmbossProperties();
1280 void Controller::SetInputOutlineProperties( const std::string& outlineProperties )
1282 if( NULL != mImpl->mEventData )
1284 mImpl->mEventData->mInputStyle.outlineProperties = outlineProperties;
1288 const std::string& Controller::GetInputOutlineProperties() const
1290 if( NULL != mImpl->mEventData )
1292 return mImpl->mEventData->mInputStyle.outlineProperties;
1295 return GetDefaultOutlineProperties();
1298 // public : Queries & retrieves.
1300 LayoutEngine& Controller::GetLayoutEngine()
1302 return mImpl->mLayoutEngine;
1305 View& Controller::GetView()
1307 return mImpl->mView;
1310 const Vector2& Controller::GetScrollPosition() const
1312 return mImpl->mScrollPosition;
1315 Vector3 Controller::GetNaturalSize()
1317 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n" );
1318 Vector3 naturalSize;
1320 // Make sure the model is up-to-date before layouting
1321 ProcessModifyEvents();
1323 if( mImpl->mRecalculateNaturalSize )
1325 // Operations that can be done only once until the text changes.
1326 const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32 |
1333 GET_GLYPH_METRICS );
1334 // Make sure the model is up-to-date before layouting
1335 mImpl->UpdateModel( onlyOnceOperations );
1337 // Layout the text for the new width.
1338 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1340 // Set the update info to relayout the whole text.
1341 mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1342 mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1344 // Store the actual control's size to restore later.
1345 const Size actualControlSize = mImpl->mVisualModel->mControlSize;
1347 DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
1348 static_cast<OperationsMask>( onlyOnceOperations |
1350 naturalSize.GetVectorXY() );
1352 // Do not do again the only once operations.
1353 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1355 // Do the size related operations again.
1356 const OperationsMask sizeOperations = static_cast<OperationsMask>( LAYOUT |
1359 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1361 // Stores the natural size to avoid recalculate it again
1362 // unless the text/style changes.
1363 mImpl->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
1365 mImpl->mRecalculateNaturalSize = false;
1367 // Clear the update info. This info will be set the next time the text is updated.
1368 mImpl->mTextUpdateInfo.Clear();
1370 // Restore the actual control's size.
1371 mImpl->mVisualModel->mControlSize = actualControlSize;
1373 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1377 naturalSize = mImpl->mVisualModel->GetNaturalSize();
1379 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1382 naturalSize.x = ConvertToEven( naturalSize.x );
1383 naturalSize.y = ConvertToEven( naturalSize.y );
1388 float Controller::GetHeightForWidth( float width )
1390 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
1391 // Make sure the model is up-to-date before layouting
1392 ProcessModifyEvents();
1395 if( fabsf( width - mImpl->mVisualModel->mControlSize.width ) > Math::MACHINE_EPSILON_1000 )
1397 // Operations that can be done only once until the text changes.
1398 const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32 |
1405 GET_GLYPH_METRICS );
1406 // Make sure the model is up-to-date before layouting
1407 mImpl->UpdateModel( onlyOnceOperations );
1410 // Layout the text for the new width.
1411 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1413 // Set the update info to relayout the whole text.
1414 mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1415 mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mLogicalModel->mText.Count();
1417 // Store the actual control's width.
1418 const float actualControlWidth = mImpl->mVisualModel->mControlSize.width;
1420 DoRelayout( Size( width, MAX_FLOAT ),
1421 static_cast<OperationsMask>( onlyOnceOperations |
1425 // Do not do again the only once operations.
1426 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1428 // Do the size related operations again.
1429 const OperationsMask sizeOperations = static_cast<OperationsMask>( LAYOUT |
1433 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1435 // Clear the update info. This info will be set the next time the text is updated.
1436 mImpl->mTextUpdateInfo.Clear();
1438 // Restore the actual control's width.
1439 mImpl->mVisualModel->mControlSize.width = actualControlWidth;
1441 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
1445 layoutSize = mImpl->mVisualModel->GetLayoutSize();
1446 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
1449 return layoutSize.height;
1452 // public : Relayout.
1454 Controller::UpdateTextType Controller::Relayout( const Size& size )
1456 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", this, size.width, size.height, mImpl->mIsAutoScrollEnabled ?"true":"false" );
1458 UpdateTextType updateTextType = NONE_UPDATED;
1460 if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
1462 if( 0u != mImpl->mVisualModel->mGlyphPositions.Count() )
1464 mImpl->mVisualModel->mGlyphPositions.Clear();
1465 updateTextType = MODEL_UPDATED;
1468 // Clear the update info. This info will be set the next time the text is updated.
1469 mImpl->mTextUpdateInfo.Clear();
1471 // Not worth to relayout if width or height is equal to zero.
1472 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
1474 return updateTextType;
1477 // Whether a new size has been set.
1478 const bool newSize = ( size != mImpl->mVisualModel->mControlSize );
1482 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mVisualModel->mControlSize.width, mImpl->mVisualModel->mControlSize.height );
1484 // Layout operations that need to be done if the size changes.
1485 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1488 UPDATE_LAYOUT_SIZE |
1490 // Set the update info to relayout the whole text.
1491 mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
1492 mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
1495 // Whether there are modify events.
1496 if( 0u != mImpl->mModifyEvents.Count() )
1498 // Style operations that need to be done if the text is modified.
1499 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1503 // Make sure the model is up-to-date before layouting.
1504 ProcessModifyEvents();
1505 bool updated = mImpl->UpdateModel( mImpl->mOperationsPending );
1509 updated = DoRelayout( size,
1510 mImpl->mOperationsPending,
1511 layoutSize ) || updated;
1515 updateTextType = MODEL_UPDATED;
1518 // Do not re-do any operation until something changes.
1519 mImpl->mOperationsPending = NO_OPERATION;
1521 // Whether the text control is editable
1522 const bool isEditable = NULL != mImpl->mEventData;
1524 // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
1526 if( newSize && isEditable )
1528 offset = mImpl->mScrollPosition;
1531 if( !isEditable || !IsMultiLineEnabled() )
1533 // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
1534 CalculateVerticalOffset( size );
1541 // If there is a new size, the scroll position needs to be clamped.
1542 mImpl->ClampHorizontalScroll( layoutSize );
1544 // Update the decorator's positions is needed if there is a new size.
1545 mImpl->mEventData->mDecorator->UpdatePositions( mImpl->mScrollPosition - offset );
1548 // Move the cursor, grab handle etc.
1549 if( mImpl->ProcessInputEvents() )
1551 updateTextType = static_cast<UpdateTextType>( updateTextType | DECORATOR_UPDATED );
1555 // Clear the update info. This info will be set the next time the text is updated.
1556 mImpl->mTextUpdateInfo.Clear();
1557 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
1559 return updateTextType;
1562 void Controller::RequestRelayout()
1564 mImpl->RequestRelayout();
1567 // public : Input style change signals.
1569 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1571 return ( NULL == mImpl->mEventData ) || ( 0u == mImpl->mEventData->mInputStyleChangedQueue.Count() );
1574 void Controller::ProcessInputStyleChangedSignals()
1576 if( NULL == mImpl->mEventData )
1582 for( Vector<InputStyle::Mask>::ConstIterator it = mImpl->mEventData->mInputStyleChangedQueue.Begin(),
1583 endIt = mImpl->mEventData->mInputStyleChangedQueue.End();
1587 const InputStyle::Mask mask = *it;
1589 if( NULL != mImpl->mEditableControlInterface )
1591 // Emit the input style changed signal.
1592 mImpl->mEditableControlInterface->InputStyleChanged( mask );
1596 mImpl->mEventData->mInputStyleChangedQueue.Clear();
1599 // public : Text-input Event Queuing.
1601 void Controller::KeyboardFocusGainEvent()
1603 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1605 if( NULL != mImpl->mEventData )
1607 if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1608 ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1610 mImpl->ChangeState( EventData::EDITING );
1611 mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1613 mImpl->NotifyImfMultiLineStatus();
1614 if( mImpl->IsShowingPlaceholderText() )
1616 // Show alternative placeholder-text when editing
1617 ShowPlaceholderText();
1620 mImpl->RequestRelayout();
1624 void Controller::KeyboardFocusLostEvent()
1626 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1628 if( NULL != mImpl->mEventData )
1630 if( EventData::INTERRUPTED != mImpl->mEventData->mState )
1632 mImpl->ChangeState( EventData::INACTIVE );
1634 if( !mImpl->IsShowingRealText() )
1636 // Revert to regular placeholder-text when not editing
1637 ShowPlaceholderText();
1641 mImpl->RequestRelayout();
1644 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1646 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1648 bool textChanged( false );
1650 if( ( NULL != mImpl->mEventData ) &&
1651 ( keyEvent.state == KeyEvent::Down ) )
1653 int keyCode = keyEvent.keyCode;
1654 const std::string& keyString = keyEvent.keyPressed;
1656 // Pre-process to separate modifying events from non-modifying input events.
1657 if( Dali::DALI_KEY_ESCAPE == keyCode )
1659 // Escape key is a special case which causes focus loss
1660 KeyboardFocusLostEvent();
1662 else if( ( Dali::DALI_KEY_CURSOR_LEFT == keyCode ) ||
1663 ( Dali::DALI_KEY_CURSOR_RIGHT == keyCode ) ||
1664 ( Dali::DALI_KEY_CURSOR_UP == keyCode ) ||
1665 ( Dali::DALI_KEY_CURSOR_DOWN == keyCode ) )
1667 Event event( Event::CURSOR_KEY_EVENT );
1668 event.p1.mInt = keyCode;
1669 mImpl->mEventData->mEventQueue.push_back( event );
1671 else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1673 textChanged = BackspaceKeyEvent();
1675 else if( IsKey( keyEvent, Dali::DALI_KEY_POWER ) )
1677 mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1678 // Avoids calling the InsertText() method which can delete selected text
1680 else if( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1681 IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1683 mImpl->ChangeState( EventData::INACTIVE );
1684 // Menu/Home key behaviour does not allow edit mode to resume like Power key
1685 // Avoids calling the InsertText() method which can delete selected text
1687 else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1689 // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1690 // and a character is typed after the type of a upper case latin character.
1696 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1698 // IMF manager is no longer handling key-events
1699 mImpl->ClearPreEditFlag();
1701 InsertText( keyString, COMMIT );
1705 if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1706 ( mImpl->mEventData->mState != EventData::INACTIVE ) &&
1707 ( Dali::DALI_KEY_SHIFT_LEFT != keyCode ) )
1709 // Should not change the state if the key is the shift send by the imf manager.
1710 // Otherwise, when the state is SELECTING the text controller can't send the right
1711 // surrounding info to the imf.
1712 mImpl->ChangeState( EventData::EDITING );
1715 mImpl->RequestRelayout();
1719 ( NULL != mImpl->mEditableControlInterface ) )
1721 // Do this last since it provides callbacks into application code
1722 mImpl->mEditableControlInterface->TextChanged();
1728 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1730 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1732 if( NULL != mImpl->mEventData )
1734 DALI_LOG_INFO( gLogFilter, Debug::Concise, "TapEvent state:%d \n", mImpl->mEventData->mState );
1735 EventData::State state( mImpl->mEventData->mState );
1736 bool relayoutNeeded( false ); // to avoid unnecessary relayouts when tapping an empty text-field
1738 if( mImpl->IsClipboardVisible() )
1740 if( EventData::INACTIVE == state || EventData::EDITING == state)
1742 mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1744 relayoutNeeded = true;
1746 else if( 1u == tapCount )
1748 if( EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state )
1750 mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE ); // If Popup shown hide it here so can be shown again if required.
1753 if( mImpl->IsShowingRealText() && ( EventData::INACTIVE != state ) )
1755 mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1756 relayoutNeeded = true;
1760 if( mImpl->IsShowingPlaceholderText() && !mImpl->IsFocusedPlaceholderAvailable() )
1762 // Hide placeholder text
1766 if( EventData::INACTIVE == state )
1768 mImpl->ChangeState( EventData::EDITING );
1770 else if( !mImpl->IsClipboardEmpty() )
1772 mImpl->ChangeState( EventData::EDITING_WITH_POPUP );
1774 relayoutNeeded = true;
1777 else if( 2u == tapCount )
1779 if( mImpl->mEventData->mSelectionEnabled &&
1780 mImpl->IsShowingRealText() )
1782 SelectEvent( x, y, false );
1785 // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1786 if( relayoutNeeded )
1788 Event event( Event::TAP_EVENT );
1789 event.p1.mUint = tapCount;
1790 event.p2.mFloat = x;
1791 event.p3.mFloat = y;
1792 mImpl->mEventData->mEventQueue.push_back( event );
1794 mImpl->RequestRelayout();
1798 // Reset keyboard as tap event has occurred.
1799 mImpl->ResetImfManager();
1802 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1804 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1806 if( NULL != mImpl->mEventData )
1808 Event event( Event::PAN_EVENT );
1809 event.p1.mInt = state;
1810 event.p2.mFloat = displacement.x;
1811 event.p3.mFloat = displacement.y;
1812 mImpl->mEventData->mEventQueue.push_back( event );
1814 mImpl->RequestRelayout();
1818 void Controller::LongPressEvent( Gesture::State state, float x, float y )
1820 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected LongPressEvent" );
1822 if( ( state == Gesture::Started ) &&
1823 ( NULL != mImpl->mEventData ) )
1825 if( !mImpl->IsShowingRealText() )
1827 Event event( Event::LONG_PRESS_EVENT );
1828 event.p1.mInt = state;
1829 mImpl->mEventData->mEventQueue.push_back( event );
1830 mImpl->RequestRelayout();
1834 // The 1st long-press on inactive text-field is treated as tap
1835 if( EventData::INACTIVE == mImpl->mEventData->mState )
1837 mImpl->ChangeState( EventData::EDITING );
1839 Event event( Event::TAP_EVENT );
1841 event.p2.mFloat = x;
1842 event.p3.mFloat = y;
1843 mImpl->mEventData->mEventQueue.push_back( event );
1845 mImpl->RequestRelayout();
1847 else if( !mImpl->IsClipboardVisible() )
1849 // Reset the imf manger to commit the pre-edit before selecting the text.
1850 mImpl->ResetImfManager();
1852 SelectEvent( x, y, false );
1858 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1860 // Whether the text needs to be relaid-out.
1861 bool requestRelayout = false;
1863 // Whether to retrieve the text and cursor position to be sent to the IMF manager.
1864 bool retrieveText = false;
1865 bool retrieveCursor = false;
1867 switch( imfEvent.eventName )
1869 case ImfManager::COMMIT:
1871 InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1872 requestRelayout = true;
1873 retrieveCursor = true;
1876 case ImfManager::PREEDIT:
1878 InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1879 requestRelayout = true;
1880 retrieveCursor = true;
1883 case ImfManager::DELETESURROUNDING:
1885 const bool textDeleted = RemoveText( imfEvent.cursorOffset,
1886 imfEvent.numberOfChars,
1887 DONT_UPDATE_INPUT_STYLE );
1891 if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
1892 !mImpl->IsPlaceholderAvailable() )
1894 mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1898 ShowPlaceholderText();
1900 mImpl->mEventData->mUpdateCursorPosition = true;
1901 mImpl->mEventData->mScrollAfterDelete = true;
1903 requestRelayout = true;
1907 case ImfManager::GETSURROUNDING:
1909 retrieveText = true;
1910 retrieveCursor = true;
1913 case ImfManager::VOID:
1920 if( requestRelayout )
1922 mImpl->mOperationsPending = ALL_OPERATIONS;
1923 mImpl->RequestRelayout();
1927 CharacterIndex cursorPosition = 0u;
1928 Length numberOfWhiteSpaces = 0u;
1930 if( retrieveCursor )
1932 numberOfWhiteSpaces = mImpl->GetNumberOfWhiteSpaces( 0u );
1934 cursorPosition = mImpl->GetLogicalCursorPosition();
1936 if( cursorPosition < numberOfWhiteSpaces )
1938 cursorPosition = 0u;
1942 cursorPosition -= numberOfWhiteSpaces;
1948 mImpl->GetText( numberOfWhiteSpaces, text );
1951 ImfManager::ImfCallbackData callbackData( ( retrieveText || retrieveCursor ), cursorPosition, text, false );
1953 if( requestRelayout &&
1954 ( NULL != mImpl->mEditableControlInterface ) )
1956 // Do this last since it provides callbacks into application code
1957 mImpl->mEditableControlInterface->TextChanged();
1960 return callbackData;
1963 void Controller::PasteClipboardItemEvent()
1965 // Retrieve the clipboard contents first
1966 ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
1967 std::string stringToPaste( notifier.GetContent() );
1969 // Commit the current pre-edit text; the contents of the clipboard should be appended
1970 mImpl->ResetImfManager();
1972 // Temporary disable hiding clipboard
1973 mImpl->SetClipboardHideEnable( false );
1976 PasteText( stringToPaste );
1978 mImpl->SetClipboardHideEnable( true );
1981 // protected : Inherit from Text::Decorator::ControllerInterface.
1983 void Controller::GetTargetSize( Vector2& targetSize )
1985 targetSize = mImpl->mVisualModel->mControlSize;
1988 void Controller::AddDecoration( Actor& actor, bool needsClipping )
1990 if( NULL != mImpl->mEditableControlInterface )
1992 mImpl->mEditableControlInterface->AddDecoration( actor, needsClipping );
1996 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
1998 DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
2000 if( NULL != mImpl->mEventData )
2002 switch( handleType )
2006 Event event( Event::GRAB_HANDLE_EVENT );
2007 event.p1.mUint = state;
2008 event.p2.mFloat = x;
2009 event.p3.mFloat = y;
2011 mImpl->mEventData->mEventQueue.push_back( event );
2014 case LEFT_SELECTION_HANDLE:
2016 Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
2017 event.p1.mUint = state;
2018 event.p2.mFloat = x;
2019 event.p3.mFloat = y;
2021 mImpl->mEventData->mEventQueue.push_back( event );
2024 case RIGHT_SELECTION_HANDLE:
2026 Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
2027 event.p1.mUint = state;
2028 event.p2.mFloat = x;
2029 event.p3.mFloat = y;
2031 mImpl->mEventData->mEventQueue.push_back( event );
2034 case LEFT_SELECTION_HANDLE_MARKER:
2035 case RIGHT_SELECTION_HANDLE_MARKER:
2037 // Markers do not move the handles.
2040 case HANDLE_TYPE_COUNT:
2042 DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
2046 mImpl->RequestRelayout();
2050 // protected : Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2052 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
2054 if( NULL == mImpl->mEventData )
2061 case Toolkit::TextSelectionPopup::CUT:
2063 mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
2064 mImpl->mOperationsPending = ALL_OPERATIONS;
2066 if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2067 !mImpl->IsPlaceholderAvailable() )
2069 mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2073 ShowPlaceholderText();
2076 mImpl->mEventData->mUpdateCursorPosition = true;
2077 mImpl->mEventData->mScrollAfterDelete = true;
2079 mImpl->RequestRelayout();
2081 if( NULL != mImpl->mEditableControlInterface )
2083 mImpl->mEditableControlInterface->TextChanged();
2087 case Toolkit::TextSelectionPopup::COPY:
2089 mImpl->SendSelectionToClipboard( false ); // Text not modified
2091 mImpl->mEventData->mUpdateCursorPosition = true;
2093 mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
2096 case Toolkit::TextSelectionPopup::PASTE:
2098 mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
2101 case Toolkit::TextSelectionPopup::SELECT:
2103 const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
2105 if( mImpl->mEventData->mSelectionEnabled )
2107 // Creates a SELECT event.
2108 SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
2112 case Toolkit::TextSelectionPopup::SELECT_ALL:
2114 // Creates a SELECT_ALL event
2115 SelectEvent( 0.f, 0.f, true );
2118 case Toolkit::TextSelectionPopup::CLIPBOARD:
2120 mImpl->ShowClipboard();
2123 case Toolkit::TextSelectionPopup::NONE:
2131 // private : Update.
2133 void Controller::InsertText( const std::string& text, Controller::InsertType type )
2135 bool removedPrevious( false );
2136 bool maxLengthReached( false );
2138 DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
2140 if( NULL == mImpl->mEventData )
2145 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
2146 this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
2147 mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2149 // TODO: At the moment the underline runs are only for pre-edit.
2150 mImpl->mVisualModel->mUnderlineRuns.Clear();
2152 // Keep the current number of characters.
2153 const Length currentNumberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2155 // Remove the previous IMF pre-edit.
2156 if( mImpl->mEventData->mPreEditFlag && ( 0u != mImpl->mEventData->mPreEditLength ) )
2158 removedPrevious = RemoveText( -static_cast<int>( mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition ),
2159 mImpl->mEventData->mPreEditLength,
2160 DONT_UPDATE_INPUT_STYLE );
2162 mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
2163 mImpl->mEventData->mPreEditLength = 0u;
2167 // Remove the previous Selection.
2168 removedPrevious = RemoveSelectedText();
2171 Vector<Character> utf32Characters;
2172 Length characterCount = 0u;
2176 // Convert text into UTF-32
2177 utf32Characters.Resize( text.size() );
2179 // This is a bit horrible but std::string returns a (signed) char*
2180 const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
2182 // Transform a text array encoded in utf8 into an array encoded in utf32.
2183 // It returns the actual number of characters.
2184 characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
2185 utf32Characters.Resize( characterCount );
2187 DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
2188 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
2191 if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
2193 // The placeholder text is no longer needed
2194 if( mImpl->IsShowingPlaceholderText() )
2199 mImpl->ChangeState( EventData::EDITING );
2201 // Handle the IMF (predicitive text) state changes
2202 if( COMMIT == type )
2204 // IMF manager is no longer handling key-events
2205 mImpl->ClearPreEditFlag();
2209 if( !mImpl->mEventData->mPreEditFlag )
2211 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state\n" );
2213 // Record the start of the pre-edit text
2214 mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
2217 mImpl->mEventData->mPreEditLength = utf32Characters.Count();
2218 mImpl->mEventData->mPreEditFlag = true;
2220 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2223 const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
2225 // Restrict new text to fit within Maximum characters setting.
2226 Length maxSizeOfNewText = std::min( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
2227 maxLengthReached = ( characterCount > maxSizeOfNewText );
2229 // The cursor position.
2230 CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2232 // Update the text's style.
2234 // Updates the text style runs by adding characters.
2235 mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, maxSizeOfNewText );
2237 // Get the character index from the cursor index.
2238 const CharacterIndex styleIndex = ( cursorIndex > 0u ) ? cursorIndex - 1u : 0u;
2240 // Retrieve the text's style for the given index.
2242 mImpl->RetrieveDefaultInputStyle( style );
2243 mImpl->mLogicalModel->RetrieveStyle( styleIndex, style );
2245 // Whether to add a new text color run.
2246 const bool addColorRun = ( style.textColor != mImpl->mEventData->mInputStyle.textColor );
2248 // Whether to add a new font run.
2249 const bool addFontNameRun = style.familyName != mImpl->mEventData->mInputStyle.familyName;
2250 const bool addFontWeightRun = style.weight != mImpl->mEventData->mInputStyle.weight;
2251 const bool addFontWidthRun = style.width != mImpl->mEventData->mInputStyle.width;
2252 const bool addFontSlantRun = style.slant != mImpl->mEventData->mInputStyle.slant;
2253 const bool addFontSizeRun = style.size != mImpl->mEventData->mInputStyle.size;
2258 const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mColorRuns.Count();
2259 mImpl->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
2261 ColorRun& colorRun = *( mImpl->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
2262 colorRun.color = mImpl->mEventData->mInputStyle.textColor;
2263 colorRun.characterRun.characterIndex = cursorIndex;
2264 colorRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2267 if( addFontNameRun ||
2273 const VectorBase::SizeType numberOfRuns = mImpl->mLogicalModel->mFontDescriptionRuns.Count();
2274 mImpl->mLogicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
2276 FontDescriptionRun& fontDescriptionRun = *( mImpl->mLogicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
2278 if( addFontNameRun )
2280 fontDescriptionRun.familyLength = mImpl->mEventData->mInputStyle.familyName.size();
2281 fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
2282 memcpy( fontDescriptionRun.familyName, mImpl->mEventData->mInputStyle.familyName.c_str(), fontDescriptionRun.familyLength );
2283 fontDescriptionRun.familyDefined = true;
2285 // The memory allocated for the font family name is freed when the font description is removed from the logical model.
2288 if( addFontWeightRun )
2290 fontDescriptionRun.weight = mImpl->mEventData->mInputStyle.weight;
2291 fontDescriptionRun.weightDefined = true;
2294 if( addFontWidthRun )
2296 fontDescriptionRun.width = mImpl->mEventData->mInputStyle.width;
2297 fontDescriptionRun.widthDefined = true;
2300 if( addFontSlantRun )
2302 fontDescriptionRun.slant = mImpl->mEventData->mInputStyle.slant;
2303 fontDescriptionRun.slantDefined = true;
2306 if( addFontSizeRun )
2308 fontDescriptionRun.size = static_cast<PointSize26Dot6>( mImpl->mEventData->mInputStyle.size * 64.f );
2309 fontDescriptionRun.sizeDefined = true;
2312 fontDescriptionRun.characterRun.characterIndex = cursorIndex;
2313 fontDescriptionRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2316 // Insert at current cursor position.
2317 Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
2319 if( cursorIndex < numberOfCharactersInModel )
2321 modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2325 modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2328 // Mark the first paragraph to be updated.
2329 mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2330 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd += maxSizeOfNewText;
2332 // Update the cursor index.
2333 cursorIndex += maxSizeOfNewText;
2335 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
2338 const Length numberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mLogicalModel->mText.Count() : 0u;
2340 if( ( 0u == mImpl->mLogicalModel->mText.Count() ) &&
2341 mImpl->IsPlaceholderAvailable() )
2343 // Show place-holder if empty after removing the pre-edit text
2344 ShowPlaceholderText();
2345 mImpl->mEventData->mUpdateCursorPosition = true;
2346 mImpl->ClearPreEditFlag();
2348 else if( removedPrevious ||
2349 ( 0 != utf32Characters.Count() ) )
2351 // Queue an inserted event
2352 mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
2354 mImpl->mEventData->mUpdateCursorPosition = true;
2355 if( numberOfCharacters < currentNumberOfCharacters )
2357 mImpl->mEventData->mScrollAfterDelete = true;
2361 mImpl->mEventData->mScrollAfterUpdatePosition = true;
2365 if( maxLengthReached )
2367 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
2369 mImpl->ResetImfManager();
2371 if( NULL != mImpl->mEditableControlInterface )
2373 // Do this last since it provides callbacks into application code
2374 mImpl->mEditableControlInterface->MaxLengthReached();
2379 void Controller::PasteText( const std::string& stringToPaste )
2381 InsertText( stringToPaste, Text::Controller::COMMIT );
2382 mImpl->ChangeState( EventData::EDITING );
2383 mImpl->RequestRelayout();
2385 if( NULL != mImpl->mEditableControlInterface )
2387 // Do this last since it provides callbacks into application code
2388 mImpl->mEditableControlInterface->TextChanged();
2392 bool Controller::RemoveText( int cursorOffset,
2393 int numberOfCharacters,
2394 UpdateInputStyleType type )
2396 bool removed = false;
2398 if( NULL == mImpl->mEventData )
2403 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfCharacters %d\n",
2404 this, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfCharacters );
2406 if( !mImpl->IsShowingPlaceholderText() )
2408 // Delete at current cursor position
2409 Vector<Character>& currentText = mImpl->mLogicalModel->mText;
2410 CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2412 CharacterIndex cursorIndex = oldCursorIndex;
2414 // Validate the cursor position & number of characters
2415 if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
2417 cursorIndex = oldCursorIndex + cursorOffset;
2420 if( ( cursorIndex + numberOfCharacters ) > currentText.Count() )
2422 numberOfCharacters = currentText.Count() - cursorIndex;
2425 if( ( cursorIndex + numberOfCharacters ) <= mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters )
2427 // Mark the paragraphs to be updated.
2428 mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2429 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove += numberOfCharacters;
2431 // Update the input style and remove the text's style before removing the text.
2433 if( UPDATE_INPUT_STYLE == type )
2435 // Keep a copy of the current input style.
2436 InputStyle currentInputStyle;
2437 currentInputStyle.Copy( mImpl->mEventData->mInputStyle );
2439 // Set first the default input style.
2440 mImpl->RetrieveDefaultInputStyle( mImpl->mEventData->mInputStyle );
2442 // Update the input style.
2443 mImpl->mLogicalModel->RetrieveStyle( cursorIndex, mImpl->mEventData->mInputStyle );
2445 // Compare if the input style has changed.
2446 const bool hasInputStyleChanged = !currentInputStyle.Equal( mImpl->mEventData->mInputStyle );
2448 if( hasInputStyleChanged )
2450 const InputStyle::Mask styleChangedMask = currentInputStyle.GetInputStyleChangeMask( mImpl->mEventData->mInputStyle );
2451 // Queue the input style changed signal.
2452 mImpl->mEventData->mInputStyleChangedQueue.PushBack( styleChangedMask );
2456 // Updates the text style runs by removing characters. Runs with no characters are removed.
2457 mImpl->mLogicalModel->UpdateTextStyleRuns( cursorIndex, -numberOfCharacters );
2459 // Remove the characters.
2460 Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
2461 Vector<Character>::Iterator last = first + numberOfCharacters;
2463 currentText.Erase( first, last );
2465 // Cursor position retreat
2466 oldCursorIndex = cursorIndex;
2468 mImpl->mEventData->mScrollAfterDelete = true;
2470 DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfCharacters );
2478 bool Controller::RemoveSelectedText()
2480 bool textRemoved( false );
2482 if( EventData::SELECTING == mImpl->mEventData->mState )
2484 std::string removedString;
2485 mImpl->RetrieveSelection( removedString, true );
2487 if( !removedString.empty() )
2490 mImpl->ChangeState( EventData::EDITING );
2497 // private : Relayout.
2499 bool Controller::DoRelayout( const Size& size,
2500 OperationsMask operationsRequired,
2503 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
2504 bool viewUpdated( false );
2506 // Calculate the operations to be done.
2507 const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
2509 const CharacterIndex startIndex = mImpl->mTextUpdateInfo.mParagraphCharacterIndex;
2510 const Length requestedNumberOfCharacters = mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters;
2512 // Get the current layout size.
2513 layoutSize = mImpl->mVisualModel->GetLayoutSize();
2515 if( NO_OPERATION != ( LAYOUT & operations ) )
2517 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
2519 // Some vectors with data needed to layout and reorder may be void
2520 // after the first time the text has been laid out.
2521 // Fill the vectors again.
2523 // Calculate the number of glyphs to layout.
2524 const Vector<GlyphIndex>& charactersToGlyph = mImpl->mVisualModel->mCharactersToGlyph;
2525 const Vector<Length>& glyphsPerCharacter = mImpl->mVisualModel->mGlyphsPerCharacter;
2526 const GlyphIndex* const charactersToGlyphBuffer = charactersToGlyph.Begin();
2527 const Length* const glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
2529 const CharacterIndex lastIndex = startIndex + ( ( requestedNumberOfCharacters > 0u ) ? requestedNumberOfCharacters - 1u : 0u );
2530 const GlyphIndex startGlyphIndex = mImpl->mTextUpdateInfo.mStartGlyphIndex;
2531 const Length numberOfGlyphs = ( requestedNumberOfCharacters > 0u ) ? *( charactersToGlyphBuffer + lastIndex ) + *( glyphsPerCharacterBuffer + lastIndex ) - startGlyphIndex : 0u;
2532 const Length totalNumberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
2534 if( 0u == totalNumberOfGlyphs )
2536 if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2538 mImpl->mVisualModel->SetLayoutSize( Size::ZERO );
2541 // Nothing else to do if there is no glyphs.
2542 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
2546 const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
2547 const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
2548 const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
2549 const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
2550 const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
2551 const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
2552 const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
2554 // Set the layout parameters.
2555 LayoutParameters layoutParameters( size,
2557 lineBreakInfo.Begin(),
2558 wordBreakInfo.Begin(),
2559 ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
2561 glyphsToCharactersMap.Begin(),
2562 charactersPerGlyph.Begin(),
2563 charactersToGlyphBuffer,
2564 glyphsPerCharacterBuffer,
2565 totalNumberOfGlyphs );
2567 // Resize the vector of positions to have the same size than the vector of glyphs.
2568 Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
2569 glyphPositions.Resize( totalNumberOfGlyphs );
2571 // Whether the last character is a new paragraph character.
2572 mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph = TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
2573 layoutParameters.isLastNewParagraph = mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph;
2575 // The initial glyph and the number of glyphs to layout.
2576 layoutParameters.startGlyphIndex = startGlyphIndex;
2577 layoutParameters.numberOfGlyphs = numberOfGlyphs;
2578 layoutParameters.startLineIndex = mImpl->mTextUpdateInfo.mStartLineIndex;
2579 layoutParameters.estimatedNumberOfLines = mImpl->mTextUpdateInfo.mEstimatedNumberOfLines;
2581 // Update the visual model.
2583 viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
2585 mImpl->mVisualModel->mLines,
2588 viewUpdated = viewUpdated || ( newLayoutSize != layoutSize );
2592 layoutSize = newLayoutSize;
2594 if ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) )
2596 mImpl->mAutoScrollDirectionRTL = false;
2599 // Reorder the lines
2600 if( NO_OPERATION != ( REORDER & operations ) )
2602 Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
2603 Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = mImpl->mLogicalModel->mBidirectionalLineInfo;
2605 // Check first if there are paragraphs with bidirectional info.
2606 if( 0u != bidirectionalInfo.Count() )
2609 const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
2611 // Reorder the lines.
2612 bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
2613 ReorderLines( bidirectionalInfo,
2615 requestedNumberOfCharacters,
2616 mImpl->mVisualModel->mLines,
2617 bidirectionalLineInfo );
2619 // Set the bidirectional info per line into the layout parameters.
2620 layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
2621 layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
2623 // Re-layout the text. Reorder those lines with right to left characters.
2624 mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
2626 requestedNumberOfCharacters,
2629 if ( ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) ) && ( numberOfLines > 0 ) )
2631 const LineRun* const firstline = mImpl->mVisualModel->mLines.Begin();
2634 mImpl->mAutoScrollDirectionRTL = firstline->direction;
2640 // Sets the layout size.
2641 if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2643 mImpl->mVisualModel->SetLayoutSize( layoutSize );
2647 // Store the size used to layout the text.
2648 mImpl->mVisualModel->mControlSize = size;
2651 if( NO_OPERATION != ( ALIGN & operations ) )
2653 // The laid-out lines.
2654 Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
2656 mImpl->mLayoutEngine.Align( size,
2658 requestedNumberOfCharacters,
2663 #if defined(DEBUG_ENABLED)
2664 std::string currentText;
2665 GetText( currentText );
2666 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mAutoScrollDirectionRTL[%s] [%s]\n", this, (mImpl->mAutoScrollDirectionRTL)?"true":"false", currentText.c_str() );
2668 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
2672 void Controller::CalculateVerticalOffset( const Size& controlSize )
2674 Size layoutSize = mImpl->mVisualModel->GetLayoutSize();
2676 if( fabsf( layoutSize.height ) < Math::MACHINE_EPSILON_1000 )
2678 // Get the line height of the default font.
2679 layoutSize.height = mImpl->GetDefaultFontLineHeight();
2682 switch( mImpl->mLayoutEngine.GetVerticalAlignment() )
2684 case LayoutEngine::VERTICAL_ALIGN_TOP:
2686 mImpl->mScrollPosition.y = 0.f;
2689 case LayoutEngine::VERTICAL_ALIGN_CENTER:
2691 mImpl->mScrollPosition.y = floorf( 0.5f * ( controlSize.height - layoutSize.height ) ); // try to avoid pixel alignment.
2694 case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
2696 mImpl->mScrollPosition.y = controlSize.height - layoutSize.height;
2702 // private : Events.
2704 void Controller::ProcessModifyEvents()
2706 Vector<ModifyEvent>& events = mImpl->mModifyEvents;
2708 if( 0u == events.Count() )
2714 for( Vector<ModifyEvent>::ConstIterator it = events.Begin(),
2715 endIt = events.End();
2719 const ModifyEvent& event = *it;
2721 if( ModifyEvent::TEXT_REPLACED == event.type )
2723 // A (single) replace event should come first, otherwise we wasted time processing NOOP events
2724 DALI_ASSERT_DEBUG( it == events.Begin() && "Unexpected TEXT_REPLACED event" );
2726 TextReplacedEvent();
2728 else if( ModifyEvent::TEXT_INSERTED == event.type )
2730 TextInsertedEvent();
2732 else if( ModifyEvent::TEXT_DELETED == event.type )
2734 // Placeholder-text cannot be deleted
2735 if( !mImpl->IsShowingPlaceholderText() )
2742 if( NULL != mImpl->mEventData )
2744 // When the text is being modified, delay cursor blinking
2745 mImpl->mEventData->mDecorator->DelayCursorBlink();
2748 // Discard temporary text
2752 void Controller::TextReplacedEvent()
2754 // The natural size needs to be re-calculated.
2755 mImpl->mRecalculateNaturalSize = true;
2757 // Apply modifications to the model
2758 mImpl->mOperationsPending = ALL_OPERATIONS;
2761 void Controller::TextInsertedEvent()
2763 DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
2765 if( NULL == mImpl->mEventData )
2770 // The natural size needs to be re-calculated.
2771 mImpl->mRecalculateNaturalSize = true;
2773 // Apply modifications to the model; TODO - Optimize this
2774 mImpl->mOperationsPending = ALL_OPERATIONS;
2777 void Controller::TextDeletedEvent()
2779 DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
2781 if( NULL == mImpl->mEventData )
2786 // The natural size needs to be re-calculated.
2787 mImpl->mRecalculateNaturalSize = true;
2789 // Apply modifications to the model; TODO - Optimize this
2790 mImpl->mOperationsPending = ALL_OPERATIONS;
2793 void Controller::SelectEvent( float x, float y, bool selectAll )
2795 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SelectEvent\n" );
2797 if( NULL != mImpl->mEventData )
2801 Event event( Event::SELECT_ALL );
2802 mImpl->mEventData->mEventQueue.push_back( event );
2806 Event event( Event::SELECT );
2807 event.p2.mFloat = x;
2808 event.p3.mFloat = y;
2809 mImpl->mEventData->mEventQueue.push_back( event );
2812 mImpl->RequestRelayout();
2816 bool Controller::BackspaceKeyEvent()
2818 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
2820 bool removed = false;
2822 if( NULL == mImpl->mEventData )
2827 // IMF manager is no longer handling key-events
2828 mImpl->ClearPreEditFlag();
2830 if( EventData::SELECTING == mImpl->mEventData->mState )
2832 removed = RemoveSelectedText();
2834 else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
2836 // Remove the character before the current cursor position
2837 removed = RemoveText( -1,
2839 UPDATE_INPUT_STYLE );
2844 if( ( 0u != mImpl->mLogicalModel->mText.Count() ) ||
2845 !mImpl->IsPlaceholderAvailable() )
2847 mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2851 ShowPlaceholderText();
2853 mImpl->mEventData->mUpdateCursorPosition = true;
2854 mImpl->mEventData->mScrollAfterDelete = true;
2860 // private : Helpers.
2862 void Controller::ResetText()
2865 mImpl->mLogicalModel->mText.Clear();
2867 // We have cleared everything including the placeholder-text
2868 mImpl->PlaceholderCleared();
2870 mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2871 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2872 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = 0u;
2874 // Clear any previous text.
2875 mImpl->mTextUpdateInfo.mClearAll = true;
2877 // The natural size needs to be re-calculated.
2878 mImpl->mRecalculateNaturalSize = true;
2880 // Apply modifications to the model
2881 mImpl->mOperationsPending = ALL_OPERATIONS;
2884 void Controller::ShowPlaceholderText()
2886 if( mImpl->IsPlaceholderAvailable() )
2888 DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
2890 if( NULL == mImpl->mEventData )
2895 mImpl->mEventData->mIsShowingPlaceholderText = true;
2897 // Disable handles when showing place-holder text
2898 mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
2899 mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
2900 mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
2902 const char* text( NULL );
2905 // TODO - Switch placeholder text styles when changing state
2906 if( ( EventData::INACTIVE != mImpl->mEventData->mState ) &&
2907 ( 0u != mImpl->mEventData->mPlaceholderTextActive.c_str() ) )
2909 text = mImpl->mEventData->mPlaceholderTextActive.c_str();
2910 size = mImpl->mEventData->mPlaceholderTextActive.size();
2914 text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
2915 size = mImpl->mEventData->mPlaceholderTextInactive.size();
2918 mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2919 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2921 // Reset model for showing placeholder.
2922 mImpl->mLogicalModel->mText.Clear();
2923 mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
2925 // Convert text into UTF-32
2926 Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
2927 utf32Characters.Resize( size );
2929 // This is a bit horrible but std::string returns a (signed) char*
2930 const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
2932 // Transform a text array encoded in utf8 into an array encoded in utf32.
2933 // It returns the actual number of characters.
2934 const Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
2935 utf32Characters.Resize( characterCount );
2937 // The characters to be added.
2938 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = characterCount;
2940 // Reset the cursor position
2941 mImpl->mEventData->mPrimaryCursorPosition = 0;
2943 // The natural size needs to be re-calculated.
2944 mImpl->mRecalculateNaturalSize = true;
2946 // Apply modifications to the model
2947 mImpl->mOperationsPending = ALL_OPERATIONS;
2949 // Update the rest of the model during size negotiation
2950 mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
2954 void Controller::ClearFontData()
2956 if( mImpl->mFontDefaults )
2958 mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
2961 // Set flags to update the model.
2962 mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2963 mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2964 mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mLogicalModel->mText.Count();
2966 mImpl->mTextUpdateInfo.mClearAll = true;
2967 mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
2968 mImpl->mRecalculateNaturalSize = true;
2970 mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
2975 UPDATE_LAYOUT_SIZE |
2980 void Controller::ClearStyleData()
2982 mImpl->mLogicalModel->mColorRuns.Clear();
2983 mImpl->mLogicalModel->ClearFontDescriptionRuns();
2986 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
2988 // Reset the cursor position
2989 if( NULL != mImpl->mEventData )
2991 mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
2993 // Update the cursor if it's in editing mode.
2994 if( EventData::IsEditingState( mImpl->mEventData->mState ) )
2996 mImpl->mEventData->mUpdateCursorPosition = true;
3001 void Controller::ResetScrollPosition()
3003 if( NULL != mImpl->mEventData )
3005 // Reset the scroll position.
3006 mImpl->mScrollPosition = Vector2::ZERO;
3007 mImpl->mEventData->mScrollAfterUpdatePosition = true;
3011 // private : Private contructors & copy operator.
3013 Controller::Controller()
3016 mImpl = new Controller::Impl( NULL, NULL );
3019 Controller::Controller( ControlInterface* controlInterface )
3021 mImpl = new Controller::Impl( controlInterface, NULL );
3024 Controller::Controller( ControlInterface* controlInterface,
3025 EditableControlInterface* editableControlInterface )
3027 mImpl = new Controller::Impl( controlInterface,
3028 editableControlInterface );
3031 // The copy constructor and operator are left unimplemented.
3033 // protected : Destructor.
3035 Controller::~Controller()
3042 } // namespace Toolkit