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=392df2cc68d2dc7dbb5968723cb911484c55a9de;hp=06e94632144f14f87f12ef528c23ef03fd9ed9e0;hb=5b3cf0e6742934674bdf62bbe15af00e39eae566;hpb=c11c7538e070434e84856ebd4af000dff4ca3f9a diff --git a/dali-toolkit/internal/text/text-controller-impl.h b/dali-toolkit/internal/text/text-controller-impl.h index 06e9463..392df2c 100644 --- a/dali-toolkit/internal/text/text-controller-impl.h +++ b/dali-toolkit/internal/text/text-controller-impl.h @@ -19,12 +19,14 @@ */ // EXTERNAL INCLUDES -#include +#include +#include // INTERNAL INCLUDES #include #include #include +#include #include namespace Dali @@ -41,12 +43,15 @@ struct Event // Used to queue input events until DoRelayout() enum Type { - KEYBOARD_FOCUS_GAIN_EVENT, - KEYBOARD_FOCUS_LOST_EVENT, CURSOR_KEY_EVENT, TAP_EVENT, PAN_EVENT, - GRAB_HANDLE_EVENT + LONG_PRESS_EVENT, + GRAB_HANDLE_EVENT, + LEFT_SELECTION_HANDLE_EVENT, + RIGHT_SELECTION_HANDLE_EVENT, + SELECT, + SELECT_ALL }; union Param @@ -61,6 +66,7 @@ struct Event { p1.mInt = 0; p2.mInt = 0; + p3.mInt = 0; } Type type; @@ -96,56 +102,73 @@ struct EventData enum State { INACTIVE, + INTERRUPTED, SELECTING, + SELECTION_CHANGED, EDITING, - EDITING_WITH_POPUP + EDITING_WITH_POPUP, + EDITING_WITH_GRAB_HANDLE, + GRAB_HANDLE_PANNING, + SELECTION_HANDLE_PANNING }; EventData( DecoratorPtr decorator ); ~EventData(); - DecoratorPtr mDecorator; - std::string mPlaceholderText; + 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 /** * This is used to delay handling events until after the model has been updated. * The number of updates to the model is minimized to improve performance. */ - std::vector mEventQueue; ///< The queue of touch events etc. + std::vector mEventQueue; ///< The queue of touch events etc. /** * 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. - - State mState; ///< Selection mode, edit mode etc. - - CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor - CharacterIndex mSecondaryCursorPosition; ///< Index into logical model for secondary cursor - - bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing - bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active - 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 mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated + Vector2 mScrollPosition; ///< The text is offset by this position when scrolling. + + State mState; ///< Selection mode, edit mode etc. + + CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor. + CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle. + CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle. + + CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary. + Length mPreEditLength; ///< Used to remove the pre-edit text if necessary. + + 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. + bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active. + 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 mUpdateCursorPosition : 1; ///< True if the visual position of the cursor 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 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 }; struct ModifyEvent { enum Type { - REPLACE_TEXT, ///< Replace the entire text - INSERT_TEXT, ///< Insert characters at the current cursor position - DELETE_TEXT ///< Delete a character at the current cursor position + TEXT_REPLACED, ///< The entire text was replaced + TEXT_INSERTED, ///< Insert characters at the current cursor position + TEXT_DELETED ///< Characters were deleted }; Type type; - std::string text; }; struct FontDefaults @@ -182,25 +205,25 @@ struct Controller::Impl mFontDefaults( NULL ), mEventData( NULL ), mFontClient(), + mClipboard(), mView(), mLayoutEngine(), mModifyEvents(), - mControlSize(), + mTextColor( Color::BLACK ), mAlignmentOffset(), mOperationsPending( NO_OPERATION ), + mMaximumNumberOfCharacters( 50 ), mRecalculateNaturalSize( true ) { mLogicalModel = LogicalModel::New(); mVisualModel = VisualModel::New(); mFontClient = TextAbstraction::FontClient::Get(); + mClipboard = Clipboard::Get(); mView.SetVisualModel( mVisualModel ); // Set the text properties to default - mVisualModel->SetTextColor( Color::WHITE ); - mVisualModel->SetShadowOffset( Vector2::ZERO ); - mVisualModel->SetShadowColor( Color::BLACK ); mVisualModel->SetUnderlineEnabled( false ); mVisualModel->SetUnderlineHeight( 0.0f ); } @@ -215,30 +238,139 @@ struct Controller::Impl */ void RequestRelayout(); + /** + * @brief Request a relayout using the ControlInterface. + */ + void QueueModifyEvent( ModifyEvent::Type type ) + { + if( ModifyEvent::TEXT_REPLACED == type) + { + // Cancel previously queued inserts etc. + mModifyEvents.clear(); + } + + ModifyEvent event; + event.type = type; + mModifyEvents.push_back( event ); + + // The event will be processed during relayout + RequestRelayout(); + } /** * @brief Helper to move the cursor, grab handle etc. */ bool ProcessInputEvents(); - void OnKeyboardFocus( bool hasFocus ); + /** + * @brief Helper to check whether any place-holder text is available. + */ + bool IsPlaceholderAvailable() const + { + return ( mEventData && + ( !mEventData->mPlaceholderTextInactive.empty() || + !mEventData->mPlaceholderTextActive.empty() ) + ); + } - void OnCursorKeyEvent( const Event& event ); + bool IsShowingPlaceholderText() const + { + return ( mEventData && mEventData->mIsShowingPlaceholderText ); + } + + /** + * @brief Called when placeholder-text is hidden + */ + void PlaceholderCleared() + { + if( mEventData ) + { + mEventData->mIsShowingPlaceholderText = false; + + // Remove mPlaceholderTextColor + mVisualModel->SetTextColor( mTextColor ); + } + } + + void ClearPreEditFlag() + { + if( mEventData ) + { + mEventData->mPreEditFlag = false; + mEventData->mPreEditStartPosition = 0; + mEventData->mPreEditLength = 0; + } + } + + void ResetImfManager() + { + // Reset incase we are in a pre-edit state. + ImfManager imfManager = ImfManager::Get(); + if ( imfManager ) + { + imfManager.Reset(); // Will trigger a commit message + } - void HandleCursorKey( int keyCode ); + ClearPreEditFlag(); + } + + bool IsClipboardEmpty() + { + bool result( mClipboard && mClipboard.NumberOfItems() ); + return !result; // // If NumberOfItems greater than 0, return false + } + + void UpdateModel( OperationsMask operationsRequired ); + + /** + * @brief Retrieve the default fonts. + * + * @param[out] fonts The default font family, style and point sizes. + * @param[in] numberOfCharacters The number of characters in the logical model. + */ + void GetDefaultFonts( Dali::Vector& fonts, Length numberOfCharacters ); + + /** + * @brief Retrieve the line height of the default font. + */ + float GetDefaultFontLineHeight(); + + void OnCursorKeyEvent( const Event& event ); void OnTapEvent( const Event& event ); void OnPanEvent( const Event& event ); - void OnGrabHandleEvent( const Event& event ); + void OnLongPressEvent( const Event& event ); + + void OnHandleEvent( const Event& event ); + + void OnSelectEvent( const Event& event ); + + void OnSelectAllEvent(); + + void RetrieveSelection( std::string& selectedText, bool deleteAfterRetreival ); + + void ShowClipboard(); + void HideClipboard(); + + bool CopyStringToClipboard( std::string& source ); + + void SendSelectionToClipboard( bool deleteAfterSending ); + + void GetTextFromClipboard( unsigned int itemIndex, std::string& retreivedString ); + + void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd ); void RepositionSelectionHandles( float visualX, float visualY ); - void ChangeState( EventData::State newState ); + 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 * @@ -274,20 +406,69 @@ struct Controller::Impl */ CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const; + /** + * @brief Updates the cursor position. + * + * Retrieves the x,y position of the cursor logical position and sets it into the decorator. + * It sets the position of the secondary cursor if it's a valid one. + * Sets which cursors are active. + */ void UpdateCursorPosition(); + /** + * @brief Updates the position of the given selection handle. + * + * @param[in] handleType One of the selection handles. + */ + void UpdateSelectionHandle( HandleType handleType ); + + /** + * @biref Clamps the horizontal scrolling to get the control always filled with text. + * + * @param[in] actualSize The size of the laid out text. + */ + void ClampHorizontalScroll( const Vector2& actualSize ); + + /** + * @biref Clamps the vertical scrolling to get the control always filled with text. + * + * @param[in] actualSize The size of the laid out text. + */ + void ClampVerticalScroll( const Vector2& actualSize ); + + /** + * @brief Scrolls the text to make a position visible. + * + * @pre mEventData must not be NULL. (there is a text-input or selection capabilities). + * + * @param[in] position A position in decorator coords. + * + * 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 ); + + /** + * @brief Scrolls the text to make the cursor visible. + * + * This method is called after deleting text. + */ + void ScrollTextToMatchCursor(); + ControlInterface& mControlInterface; ///< Reference to the text controller. LogicalModelPtr mLogicalModel; ///< Pointer to the logical model. VisualModelPtr mVisualModel; ///< Pointer to the visual model. 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 View mView; ///< The view interface to the rendering back-end. LayoutEngine mLayoutEngine; ///< The layout engine. std::vector mModifyEvents; ///< Temporary stores the text set until the next relayout. - Size mControlSize; ///< The size of the control. + Vector4 mTextColor; ///< The regular text color Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment. 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. };