X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-controller-impl.h;h=054f4a71ea12116d90a5bcbad6e40a9de96d415a;hp=f88ca8db6db2cfbbc559e616a8c2f321715b3a71;hb=21f60153d688233c47b7e86dfe1d6e06450ed3a0;hpb=e5a56dace042712c1d89015bcb43942dfb237af8 diff --git a/dali-toolkit/internal/text/text-controller-impl.h b/dali-toolkit/internal/text/text-controller-impl.h index f88ca8d..054f4a7 100644 --- a/dali-toolkit/internal/text/text-controller-impl.h +++ b/dali-toolkit/internal/text/text-controller-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__ -#define __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__ +#ifndef DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H +#define DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,11 +24,9 @@ // INTERNAL INCLUDES #include -#include -#include #include +#include #include -#include namespace Dali { @@ -39,6 +37,10 @@ namespace Toolkit namespace Text { +//Forward declarations +struct CursorInfo; +struct FontDefaults; + struct Event { // Used to queue input events until DoRelayout() @@ -76,30 +78,6 @@ struct Event Param p3; }; -struct CursorInfo -{ - CursorInfo() - : primaryPosition(), - secondaryPosition(), - lineOffset( 0.f ), - lineHeight( 0.f ), - primaryCursorHeight( 0.f ), - secondaryCursorHeight( 0.f ), - isSecondaryCursor( false ) - {} - - ~CursorInfo() - {} - - Vector2 primaryPosition; ///< The primary cursor's position. - Vector2 secondaryPosition; ///< The secondary cursor's position. - float lineOffset; ///< The vertical offset where the line containing the cursor starts. - float lineHeight; ///< The height of the line where the cursor is placed. - float primaryCursorHeight; ///< The primary cursor's height. - float secondaryCursorHeight; ///< The secondary cursor's height. - bool isSecondaryCursor; ///< Whether the secondary cursor is valid. -}; - struct EventData { enum State @@ -112,7 +90,8 @@ struct EventData EDITING_WITH_GRAB_HANDLE, EDITING_WITH_PASTE_POPUP, GRAB_HANDLE_PANNING, - SELECTION_HANDLE_PANNING + SELECTION_HANDLE_PANNING, + TEXT_PANNING }; EventData( DecoratorPtr decorator ); @@ -126,6 +105,7 @@ struct EventData DecoratorPtr mDecorator; ///< Pointer to the decorator. ImfManager mImfManager; ///< The Input Method Framework Manager. + FontDefaults* mPlaceholderFont; ///< The placeholder default font. std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus. std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive. Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color. @@ -136,14 +116,11 @@ struct EventData */ std::vector mEventQueue; ///< The queue of touch events etc. - InputStyle mInputStyle; ///< The style to be set to the new inputed text. + Vector mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback. - /** - * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control. - * Typically this will have a negative value with scrolling occurs. - */ - Vector2 mScrollPosition; ///< The text is offset by this position when scrolling. + InputStyle mInputStyle; ///< The style to be set to the new inputed text. + State mPreviousState; ///< Stores the current state before it's updated with the new one. State mState; ///< Selection mode, edit mode etc. CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor. @@ -153,6 +130,11 @@ struct EventData CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary. Length mPreEditLength; ///< Used to remove the pre-edit text if necessary. + float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles. + + Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text' + Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text' + bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed. bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state. bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing. @@ -160,15 +142,21 @@ struct EventData bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled. bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown. bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled. - bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled. - bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled. + bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'. bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated. + bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated. bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated. bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated. + bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected. + bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected. + bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated. bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated. bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters. bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text. bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor. + bool mPasswordInput : 1; ///< True if password input is enabled. + bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position + bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size. }; struct ModifyEvent @@ -187,7 +175,6 @@ struct FontDefaults { FontDefaults() : mFontDescription(), - mFontStyle(), mDefaultPointSize( 0.f ), mFontId( 0u ), familyDefined( false ), @@ -213,7 +200,6 @@ struct FontDefaults } TextAbstraction::FontDescription mFontDescription; ///< The default font's description. - std::string mFontStyle; ///< The font's style string set through the property system. float mDefaultPointSize; ///< The default font's point size. FontId mFontId; ///< The font's id of the default font. bool familyDefined:1; ///< Whether the default font's family name is defined. @@ -223,52 +209,151 @@ struct FontDefaults bool sizeDefined:1; ///< Whether the default font's point size is defined. }; +/** + * @brief Stores indices used to update the text. + * Stores the character index where the text is updated and the number of characters removed and added. + * Stores as well indices to the first and the last paragraphs to be updated. + */ +struct TextUpdateInfo +{ + TextUpdateInfo() + : mCharacterIndex( 0u ), + mNumberOfCharactersToRemove( 0u ), + mNumberOfCharactersToAdd( 0u ), + mPreviousNumberOfCharacters( 0u ), + mParagraphCharacterIndex( 0u ), + mRequestedNumberOfCharacters( 0u ), + mStartGlyphIndex( 0u ), + mStartLineIndex( 0u ), + mEstimatedNumberOfLines( 0u ), + mClearAll( true ), + mFullRelayoutNeeded( true ), + mIsLastCharacterNewParagraph( false ) + {} + + ~TextUpdateInfo() + {} + + CharacterIndex mCharacterIndex; ///< Index to the first character to be updated. + Length mNumberOfCharactersToRemove; ///< The number of characters to be removed. + Length mNumberOfCharactersToAdd; ///< The number of characters to be added. + Length mPreviousNumberOfCharacters; ///< The number of characters before the text update. + + CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated. + Length mRequestedNumberOfCharacters; ///< The requested number of characters. + GlyphIndex mStartGlyphIndex; + LineIndex mStartLineIndex; + Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting. + + bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset. + bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control. + bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character. + + void Clear() + { + // Clear all info except the mPreviousNumberOfCharacters member. + mCharacterIndex = static_cast( -1 ); + mNumberOfCharactersToRemove = 0u; + mNumberOfCharactersToAdd = 0u; + mParagraphCharacterIndex = 0u; + mRequestedNumberOfCharacters = 0u; + mStartGlyphIndex = 0u; + mStartLineIndex = 0u; + mEstimatedNumberOfLines = 0u; + mClearAll = false; + mFullRelayoutNeeded = false; + mIsLastCharacterNewParagraph = false; + } +}; + +struct UnderlineDefaults +{ + std::string properties; + // TODO: complete with underline parameters. +}; + +struct ShadowDefaults +{ + std::string properties; + // TODO: complete with shadow parameters. +}; + +struct EmbossDefaults +{ + std::string properties; + // TODO: complete with emboss parameters. +}; + +struct OutlineDefaults +{ + std::string properties; + // TODO: complete with outline parameters. +}; + struct Controller::Impl { - Impl( ControlInterface& controlInterface ) + Impl( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ) : mControlInterface( controlInterface ), - mLogicalModel(), - mVisualModel(), + mEditableControlInterface( editableControlInterface ), + mModel(), mFontDefaults( NULL ), + mUnderlineDefaults( NULL ), + mShadowDefaults( NULL ), + mEmbossDefaults( NULL ), + mOutlineDefaults( NULL ), mEventData( NULL ), mFontClient(), mClipboard(), mView(), mMetrics(), - mLayoutEngine(), mModifyEvents(), mTextColor( Color::BLACK ), - mAlignmentOffset(), + mTextUpdateInfo(), mOperationsPending( NO_OPERATION ), mMaximumNumberOfCharacters( 50u ), + mHiddenInput( NULL ), mRecalculateNaturalSize( true ), - mMarkupProcessorEnabled( false ) + mMarkupProcessorEnabled( false ), + mClipboardHideEnabled( true ), + mIsAutoScrollEnabled( false ), + mAutoScrollDirectionRTL( false ), + mUnderlineSetByString( false ), + mShadowSetByString( false ), + mFontStyleSetByString( false ) { - mLogicalModel = LogicalModel::New(); - mVisualModel = VisualModel::New(); + mModel = Model::New(); mFontClient = TextAbstraction::FontClient::Get(); mClipboard = Clipboard::Get(); - mView.SetVisualModel( mVisualModel ); + mView.SetVisualModel( mModel->mVisualModel ); // Use this to access FontClient i.e. to get down-scaled Emoji metrics. mMetrics = Metrics::New( mFontClient ); mLayoutEngine.SetMetrics( mMetrics ); // Set the text properties to default - mVisualModel->SetUnderlineEnabled( false ); - mVisualModel->SetUnderlineHeight( 0.0f ); + mModel->mVisualModel->SetUnderlineEnabled( false ); + mModel->mVisualModel->SetUnderlineHeight( 0.0f ); } ~Impl() { + delete mHiddenInput; + delete mFontDefaults; + delete mUnderlineDefaults; + delete mShadowDefaults; + delete mEmbossDefaults; + delete mOutlineDefaults; delete mEventData; } + // Text Controller Implementation. + /** - * @brief Request a relayout using the ControlInterface. + * @copydoc Text::Controller::RequestRelayout() */ void RequestRelayout(); @@ -323,7 +408,7 @@ struct Controller::Impl bool IsShowingRealText() const { return ( !IsShowingPlaceholderText() && - 0u != mLogicalModel->mText.Count() ); + 0u != mModel->mLogicalModel->mText.Count() ); } /** @@ -336,7 +421,7 @@ struct Controller::Impl mEventData->mIsShowingPlaceholderText = false; // Remove mPlaceholderTextColor - mVisualModel->SetTextColor( mTextColor ); + mModel->mVisualModel->SetTextColor( mTextColor ); } } @@ -364,32 +449,116 @@ struct Controller::Impl } } + /** + * @brief Helper to notify IMF manager with surrounding text & cursor changes. + */ + void NotifyImfManager(); + + /** + * @brief Helper to notify IMF manager with multi line status. + */ + void NotifyImfMultiLineStatus(); + + /** + * @brief Retrieve the current cursor position. + * + * @return The cursor position. + */ + CharacterIndex GetLogicalCursorPosition() const; + + /** + * @brief Retrieves the number of consecutive white spaces starting from the given @p index. + * + * @param[in] index The character index from where to count the number of consecutive white spaces. + * + * @return The number of consecutive white spaces. + */ + Length GetNumberOfWhiteSpaces( CharacterIndex index ) const; + + /** + * @brief Retrieve any text previously set starting from the given @p index. + * + * @param[in] index The character index from where to retrieve the text. + * @param[out] text A string of UTF-8 characters. + * + * @see Dali::Toolkit::Text::Controller::GetText() + */ + void GetText( CharacterIndex index, std::string& text ) const; + bool IsClipboardEmpty() { bool result( mClipboard && mClipboard.NumberOfItems() ); - return !result; // // If NumberOfItems greater than 0, return false + return !result; // If NumberOfItems greater than 0, return false + } + + bool IsClipboardVisible() + { + bool result( mClipboard && mClipboard.IsVisible() ); + return result; } /** - * @brief Updates the logical and visual models. + * @brief Calculates the start character index of the first paragraph to be updated and + * the end character index of the last paragraph to be updated. * - * When text or style changes the model is set with some operations pending. - * When i.e. the text's size or a relayout is required this method is called - * with a given @p operationsRequired parameter. The operations required are - * matched with the operations pending to perform the minimum number of operations. + * @param[out] numberOfCharacters The number of characters to be updated. + */ + void CalculateTextUpdateIndices( Length& numberOfCharacters ); + + /** + * @brief Helper to clear completely the parts of the model specified by the given @p operations. * - * @param[in] operationsRequired The operations required. + * @note It never clears the text stored in utf32. */ - void UpdateModel( OperationsMask operationsRequired ); + void ClearFullModelData( OperationsMask operations ); /** - * @brief Updates the style runs in the visual model when the text's styles changes. + * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations. + * + * @note It never clears the text stored in utf32. + * + * @param[in] startIndex Index to the first character to be cleared. + * @param[in] endIndex Index to the last character to be cleared. + * @param[in] operations The operations required. + */ + void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations ); + + /** + * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations. + * + * @note It never clears the text stored in utf32. + * @note Character indices are transformed to glyph indices. + * + * @param[in] startIndex Index to the first character to be cleared. + * @param[in] endIndex Index to the last character to be cleared. + * @param[in] operations The operations required. + */ + void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations ); + + /** + * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex. + * + * @note It never clears the text stored in utf32. + * + * @param[in] startIndex Index to the first character to be cleared. + * @param[in] endIndex Index to the last character to be cleared. + * @param[in] operations The operations required. + */ + void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations ); + + /** + * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes. + * + * When text or style changes the model is set with some operations pending. + * When i.e. the text's size or a relayout is required this method is called + * with a given @p operationsRequired parameter. The operations required are + * matched with the operations pending to perform the minimum number of operations. * * @param[in] operationsRequired The operations required. * * @return @e true if the model has been modified. */ - bool UpdateModelStyle( OperationsMask operationsRequired ); + bool UpdateModel( OperationsMask operationsRequired ); /** * @brief Retreieves the default style. @@ -417,38 +586,32 @@ struct Controller::Impl void OnSelectAllEvent(); + /** + * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true. + * + * @param[out] selectedText The selected text encoded in utf8. + * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval. + */ void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval ); void ShowClipboard(); void HideClipboard(); + void SetClipboardHideEnable(bool enable); + bool CopyStringToClipboard( std::string& source ); void SendSelectionToClipboard( bool deleteAfterSending ); - void GetTextFromClipboard( unsigned int itemIndex, std::string& retrievedString ); + void RequestGetTextFromClipboard(); void RepositionSelectionHandles(); - void RepositionSelectionHandles( float visualX, float visualY ); + void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action ); void SetPopupButtons(); void ChangeState( EventData::State newState ); - LineIndex GetClosestLine( float y ) const; - - void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex ); - - /** - * @brief Retrieves the cursor's logical position for a given touch point x,y - * - * @param[in] visualX The touch point x. - * @param[in] visualY The touch point y. - * - * @return The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character. - */ - CharacterIndex GetClosestCursorIndex( float visualX, - float visualY ); /** * @brief Calculates the cursor's position for a given character index in the logical order. @@ -498,16 +661,16 @@ struct Controller::Impl /** * @biref Clamps the horizontal scrolling to get the control always filled with text. * - * @param[in] actualSize The size of the laid out text. + * @param[in] layoutSize The size of the laid out text. */ - void ClampHorizontalScroll( const Vector2& actualSize ); + void ClampHorizontalScroll( const Vector2& layoutSize ); /** * @biref Clamps the vertical scrolling to get the control always filled with text. * - * @param[in] actualSize The size of the laid out text. + * @param[in] layoutSize The size of the laid out text. */ - void ClampVerticalScroll( const Vector2& actualSize ); + void ClampVerticalScroll( const Vector2& layoutSize ); /** * @brief Scrolls the text to make a position visible. @@ -515,11 +678,12 @@ struct Controller::Impl * @pre mEventData must not be NULL. (there is a text-input or selection capabilities). * * @param[in] position A position in text coords. + * @param[in] lineHeight The line height for the given position. * * This method is called after inserting text, moving the cursor with the grab handle or the keypad, * or moving the selection handles. */ - void ScrollToMakePositionVisible( const Vector2& position ); + void ScrollToMakePositionVisible( const Vector2& position, float lineHeight ); /** * @brief Scrolls the text to make the cursor visible. @@ -528,24 +692,44 @@ struct Controller::Impl */ void ScrollTextToMatchCursor( const CursorInfo& cursorInfo ); - ControlInterface& mControlInterface; ///< Reference to the text controller. - LogicalModelPtr mLogicalModel; ///< Pointer to the logical model. - VisualModelPtr mVisualModel; ///< Pointer to the visual model. +private: + // Declared private and left undefined to avoid copies. + Impl( const Impl& ); + // Declared private and left undefined to avoid copies. + Impl& operator=( const Impl& ); + +public: + + ControlInterface* mControlInterface; ///< Reference to the text controller. + EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller. + ModelPtr mModel; ///< Pointer to the text's model. FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font. + UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters. + ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters. + EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters. + OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters. EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput(). TextAbstraction::FontClient mFontClient; ///< Handle to the font client. Clipboard mClipboard; ///< Handle to the system clipboard View mView; ///< The view interface to the rendering back-end. MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics. - LayoutEngine mLayoutEngine; ///< The layout engine. + Layout::Engine mLayoutEngine; ///< The layout engine. Vector mModifyEvents; ///< Temporary stores the text set until the next relayout. Vector4 mTextColor; ///< The regular text color - Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment. + TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated. OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text. Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted. + HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode. bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated. bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled. + bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not + bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled. + CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl + + bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map + bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map + bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map }; } // namespace Text @@ -554,4 +738,4 @@ struct Controller::Impl } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H