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=c996a1f582be48695484af50bd390c88f1c69c5d;hp=dc5d3a63ba39b003fe96405102d27d519731da4a;hb=ded447ca28a294ce011a4c1f25f481b1cc04eefd;hpb=6a23335f5f519910533bbeefd0d627d6d071c7a8 diff --git a/dali-toolkit/internal/text/text-controller-impl.h b/dali-toolkit/internal/text/text-controller-impl.h index dc5d3a6..c996a1f 100644 --- a/dali-toolkit/internal/text/text-controller-impl.h +++ b/dali-toolkit/internal/text/text-controller-impl.h @@ -20,13 +20,14 @@ // EXTERNAL INCLUDES #include -#include #include // INTERNAL INCLUDES +#include #include #include #include +#include #include namespace Dali @@ -38,6 +39,9 @@ namespace Toolkit namespace Text { +//Forward declarations +struct CursorInfo; + struct Event { // Used to queue input events until DoRelayout() @@ -46,6 +50,7 @@ struct Event CURSOR_KEY_EVENT, TAP_EVENT, PAN_EVENT, + LONG_PRESS_EVENT, GRAB_HANDLE_EVENT, LEFT_SELECTION_HANDLE_EVENT, RIGHT_SELECTION_HANDLE_EVENT, @@ -74,37 +79,17 @@ struct Event Param p3; }; -struct CursorInfo -{ - CursorInfo() - : primaryPosition(), - secondaryPosition(), - 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 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 { INACTIVE, + INTERRUPTED, SELECTING, - SELECTION_CHANGED, EDITING, EDITING_WITH_POPUP, + EDITING_WITH_GRAB_HANDLE, + EDITING_WITH_PASTE_POPUP, GRAB_HANDLE_PANNING, SELECTION_HANDLE_PANNING }; @@ -113,10 +98,16 @@ struct EventData ~EventData(); - DecoratorPtr mDecorator; ///< Pointer to the decorator - 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 + static bool IsEditingState( State stateToCheck ) + { + return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP ); + } + + DecoratorPtr mDecorator; ///< Pointer to the decorator. + ImfManager mImfManager; ///< The Input Method Framework Manager. + 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. /** * This is used to delay handling events until after the model has been updated. @@ -124,6 +115,8 @@ struct EventData */ std::vector mEventQueue; ///< The queue of touch events etc. + InputStyle mInputStyle; ///< The style to be set to the new inputed text. + /** * 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. @@ -153,6 +146,8 @@ struct EventData bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated. 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. }; struct ModifyEvent @@ -170,26 +165,98 @@ struct ModifyEvent struct FontDefaults { FontDefaults() - : mDefaultPointSize(0.0f), - mFontId(0u) + : mFontDescription(), + mFontStyle(), + mDefaultPointSize( 0.f ), + mFontId( 0u ), + familyDefined( false ), + weightDefined( false ), + widthDefined( false ), + slantDefined( false ), + sizeDefined( false ) { + // Initially use the default platform font + TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get(); + fontClient.GetDefaultPlatformFontDescription( mFontDescription ); } FontId GetFontId( TextAbstraction::FontClient& fontClient ) { if( !mFontId ) { - Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64; - mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize ); + const PointSize26Dot6 pointSize = static_cast( mDefaultPointSize * 64.f ); + mFontId = fontClient.GetFontId( mFontDescription, pointSize ); } return mFontId; } - std::string mDefaultFontFamily; - std::string mDefaultFontStyle; - float mDefaultPointSize; - FontId mFontId; + 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. + bool weightDefined:1; ///< Whether the default font's weight is defined. + bool widthDefined:1; ///< Whether the default font's width is defined. + bool slantDefined:1; ///< Whether the default font's slant is defined. + 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 Controller::Impl @@ -203,14 +270,19 @@ struct Controller::Impl mFontClient(), mClipboard(), mView(), + mMetrics(), mLayoutEngine(), mModifyEvents(), - mControlSize(), mTextColor( Color::BLACK ), mAlignmentOffset(), + mTextUpdateInfo(), mOperationsPending( NO_OPERATION ), - mMaximumNumberOfCharacters( 50 ), - mRecalculateNaturalSize( true ) + mMaximumNumberOfCharacters( 50u ), + mRecalculateNaturalSize( true ), + mMarkupProcessorEnabled( false ), + mClipboardHideEnabled( true ), + mAutoScrollEnabled( false ), + mAutoScrollDirectionRTL( false ) { mLogicalModel = LogicalModel::New(); mVisualModel = VisualModel::New(); @@ -220,6 +292,10 @@ struct Controller::Impl mView.SetVisualModel( 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 ); @@ -227,6 +303,7 @@ struct Controller::Impl ~Impl() { + delete mFontDefaults; delete mEventData; } @@ -243,12 +320,12 @@ struct Controller::Impl if( ModifyEvent::TEXT_REPLACED == type) { // Cancel previously queued inserts etc. - mModifyEvents.clear(); + mModifyEvents.Clear(); } ModifyEvent event; event.type = type; - mModifyEvents.push_back( event ); + mModifyEvents.PushBack( event ); // The event will be processed during relayout RequestRelayout(); @@ -276,6 +353,20 @@ struct Controller::Impl } /** + * @brief Helper to check whether active place-holder text is available. + */ + bool IsFocusedPlaceholderAvailable() const + { + return ( mEventData && !mEventData->mPlaceholderTextActive.empty() ); + } + + bool IsShowingRealText() const + { + return ( !IsShowingPlaceholderText() && + 0u != mLogicalModel->mText.Count() ); + } + + /** * @brief Called when placeholder-text is hidden */ void PlaceholderCleared() @@ -301,31 +392,98 @@ struct Controller::Impl void ResetImfManager() { - // Reset incase we are in a pre-edit state. - ImfManager imfManager = ImfManager::Get(); - if ( imfManager ) + if( mEventData ) { - imfManager.Reset(); // Will trigger a commit message - } + // Reset incase we are in a pre-edit state. + if( mEventData->mImfManager ) + { + mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding ) + } - ClearPreEditFlag(); + ClearPreEditFlag(); + } } 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 } - void UpdateModel( OperationsMask operationsRequired ); + /** + * @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. + * + * @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. + * + * @note It never clears the text stored in utf32. + */ + void ClearFullModelData( OperationsMask operations ); + + /** + * @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 UpdateModel( OperationsMask operationsRequired ); /** - * @brief Retrieve the default fonts. + * @brief Retreieves the default style. * - * @param[out] fonts The default font family, style and point sizes. - * @param[in] numberOfCharacters The number of characters in the logical model. + * @param[out] inputStyle The default style. */ - void GetDefaultFonts( Dali::Vector& fonts, Length numberOfCharacters ); + void RetrieveDefaultInputStyle( InputStyle& inputStyle ); + + /** + * @brief Retrieve the line height of the default font. + */ + float GetDefaultFontLineHeight(); void OnCursorKeyEvent( const Event& event ); @@ -333,39 +491,34 @@ struct Controller::Impl void OnPanEvent( const Event& event ); + void OnLongPressEvent( const Event& event ); + void OnHandleEvent( const Event& event ); void OnSelectEvent( const Event& event ); void OnSelectAllEvent(); - void RetreiveSelection( std::string& selectedText, bool deleteAfterRetreival ); + 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 PasteTextFromClipboard(); + void GetTextFromClipboard( unsigned int itemIndex, std::string& retrievedString ); - void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd ); + void RepositionSelectionHandles(); void RepositionSelectionHandles( float visualX, float visualY ); - void ChangeState( EventData::State newState ); - - LineIndex GetClosestLine( float y ) const; + void SetPopupButtons(); - 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 ); + void ChangeState( EventData::State newState ); /** * @brief Calculates the cursor's position for a given character index in the logical order. @@ -394,18 +547,23 @@ struct Controller::Impl /** * @brief Updates the cursor position. * - * Retrieves the x,y position of the cursor logical position and sets it into the decorator. + * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords. * It sets the position of the secondary cursor if it's a valid one. * Sets which cursors are active. + * + * @param[in] cursorInfo Contains the selection handle position in Actor's coords. + * */ - void UpdateCursorPosition(); + void UpdateCursorPosition( const CursorInfo& cursorInfo ); /** - * @brief Updates the position of the given selection handle. + * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords. * * @param[in] handleType One of the selection handles. + * @param[in] cursorInfo Contains the selection handle position in Actor's coords. */ - void UpdateSelectionHandle( HandleType handleType ); + void UpdateSelectionHandle( HandleType handleType, + const CursorInfo& cursorInfo ); /** * @biref Clamps the horizontal scrolling to get the control always filled with text. @@ -426,7 +584,7 @@ struct Controller::Impl * * @pre mEventData must not be NULL. (there is a text-input or selection capabilities). * - * @param[in] position A position in decorator coords. + * @param[in] position A position in text coords. * * This method is called after inserting text, moving the cursor with the grab handle or the keypad, * or moving the selection handles. @@ -438,7 +596,15 @@ struct Controller::Impl * * This method is called after deleting text. */ - void ScrollTextToMatchCursor(); + void ScrollTextToMatchCursor( const CursorInfo& cursorInfo ); + +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. LogicalModelPtr mLogicalModel; ///< Pointer to the logical model. @@ -446,16 +612,23 @@ struct Controller::Impl FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font. 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 + 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. - std::vector mModifyEvents; ///< Temporary stores the text set until the next relayout. - Size mControlSize; ///< The size of the control. + 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. + 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 mAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled. + CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl + }; } // namespace Text