X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-controller-impl.h;h=68659b6b558f067502432cea15cd0d53a30e8b15;hb=d00a250741411c386d988e7ac34525cf94a1918e;hp=2f14702ba002fc4b1e3dd27640990799c8dcaa2b;hpb=26cacf71e74fab984c12bc77485920f4573b97ec;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/text/text-controller-impl.h b/dali-toolkit/internal/text/text-controller-impl.h index 2f14702..68659b6 100644 --- a/dali-toolkit/internal/text/text-controller-impl.h +++ b/dali-toolkit/internal/text/text-controller-impl.h @@ -39,6 +39,9 @@ namespace Toolkit namespace Text { +//Forward declarations +struct CursorInfo; + struct Event { // Used to queue input events until DoRelayout() @@ -76,30 +79,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 @@ -138,12 +117,6 @@ struct EventData 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. - */ - 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. @@ -153,6 +126,8 @@ 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. + 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,11 +135,12 @@ 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 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. @@ -280,6 +256,30 @@ struct TextUpdateInfo } }; +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 ) @@ -287,6 +287,10 @@ struct Controller::Impl mLogicalModel(), mVisualModel(), mFontDefaults( NULL ), + mUnderlineDefaults( NULL ), + mShadowDefaults( NULL ), + mEmbossDefaults( NULL ), + mOutlineDefaults( NULL ), mEventData( NULL ), mFontClient(), mClipboard(), @@ -295,12 +299,14 @@ struct Controller::Impl mLayoutEngine(), mModifyEvents(), mTextColor( Color::BLACK ), - mAlignmentOffset(), mTextUpdateInfo(), mOperationsPending( NO_OPERATION ), mMaximumNumberOfCharacters( 50u ), mRecalculateNaturalSize( true ), - mMarkupProcessorEnabled( false ) + mMarkupProcessorEnabled( false ), + mClipboardHideEnabled( true ), + mAutoScrollEnabled( false ), + mAutoScrollDirectionRTL( false ) { mLogicalModel = LogicalModel::New(); mVisualModel = VisualModel::New(); @@ -322,6 +328,10 @@ struct Controller::Impl ~Impl() { delete mFontDefaults; + delete mUnderlineDefaults; + delete mShadowDefaults; + delete mEmbossDefaults; + delete mOutlineDefaults; delete mEventData; } @@ -422,6 +432,37 @@ struct Controller::Impl } } + /** + * @brief Helper to notify IMF manager with surrounding text & cursor changes. + */ + void NotifyImfManager(); + + /** + * @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() ); @@ -478,7 +519,7 @@ struct Controller::Impl void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations ); /** - * @brief Updates the logical and visual models. + * @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 @@ -486,17 +527,10 @@ struct Controller::Impl * matched with the operations pending to perform the minimum number of operations. * * @param[in] operationsRequired The operations required. - */ - void UpdateModel( OperationsMask operationsRequired ); - - /** - * @brief Updates the style runs in the visual model when the text's styles changes. - * - * @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. @@ -524,12 +558,20 @@ 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 ); @@ -542,20 +584,6 @@ struct Controller::Impl 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. @@ -605,16 +633,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. @@ -622,11 +650,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. @@ -635,10 +664,22 @@ struct Controller::Impl */ 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. VisualModelPtr mVisualModel; ///< Pointer to the visual 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 @@ -647,13 +688,21 @@ struct Controller::Impl LayoutEngine 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. + /** + * 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. 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