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=8e9ab39be9a48426143b9a11ddde10265373b1cd;hp=2f14702ba002fc4b1e3dd27640990799c8dcaa2b;hb=a267f3da043b1b792ffc64d1848542aa761e44c0;hpb=9598e692217c5fb541d862a3957b3efd5fd5171d diff --git a/dali-toolkit/internal/text/text-controller-impl.h b/dali-toolkit/internal/text/text-controller-impl.h old mode 100644 new mode 100755 index 2f14702..5527870 --- 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,11 @@ // INTERNAL INCLUDES #include -#include -#include #include +#include #include -#include +#include +#include namespace Dali { @@ -39,6 +39,14 @@ namespace Toolkit namespace Text { +const float DEFAULT_TEXTFIT_MIN = 10.f; +const float DEFAULT_TEXTFIT_MAX = 100.f; +const float DEFAULT_TEXTFIT_STEP = 1.f; + +//Forward declarations +struct CursorInfo; +struct FontDefaults; + struct Event { // Used to queue input events until DoRelayout() @@ -60,6 +68,7 @@ struct Event int mInt; unsigned int mUint; float mFloat; + bool mBool; }; Event( Type eventType ) @@ -76,30 +85,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,10 +97,11 @@ struct EventData EDITING_WITH_GRAB_HANDLE, EDITING_WITH_PASTE_POPUP, GRAB_HANDLE_PANNING, - SELECTION_HANDLE_PANNING + SELECTION_HANDLE_PANNING, + TEXT_PANNING }; - EventData( DecoratorPtr decorator ); + EventData( DecoratorPtr decorator, InputMethodContext& inputMethodContext ); ~EventData(); @@ -125,7 +111,8 @@ struct EventData } DecoratorPtr mDecorator; ///< Pointer to the decorator. - ImfManager mImfManager; ///< The Input Method Framework Manager. + InputMethodContext mInputMethodContext; ///< 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 +123,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 +137,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 +149,24 @@ 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. + bool mIsPlaceholderElideEnabled : 1; ///< True if the placeholder text's elide is enabled. + bool mPlaceholderEllipsisFlag : 1; ///< True if the text controller sets the placeholder ellipsis. + bool mShiftSelectionFlag : 1; ///< True if the text selection using Shift key is enabled. }; struct ModifyEvent @@ -187,8 +185,8 @@ struct FontDefaults { FontDefaults() : mFontDescription(), - mFontStyle(), mDefaultPointSize( 0.f ), + mFitPointSize( 0.f ), mFontId( 0u ), familyDefined( false ), weightDefined( false ), @@ -213,8 +211,8 @@ 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. + float mFitPointSize; ///< The fit 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. @@ -280,53 +278,113 @@ 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 ) + 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 ), + mUpdateTextDirection( true ), + mIsTextDirectionRTL( false ), + mUnderlineSetByString( false ), + mShadowSetByString( false ), + mOutlineSetByString( false ), + mFontStyleSetByString( false ), + mShouldClearFocusOnEscape( true ), + mLayoutDirection( LayoutDirection::LEFT_TO_RIGHT ), + mTextFitMinSize( DEFAULT_TEXTFIT_MIN ), + mTextFitMaxSize( DEFAULT_TEXTFIT_MAX ), + mTextFitStepSize( DEFAULT_TEXTFIT_STEP ), + mTextFitEnabled( 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 ); + + Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get(); + if( styleManager ) + { + bool temp; + Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager ); + if( config["clearFocusOnEscape"].Get( temp ) ) + { + mShouldClearFocusOnEscape = temp; + } + } } ~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(); @@ -381,7 +439,7 @@ struct Controller::Impl bool IsShowingRealText() const { return ( !IsShowingPlaceholderText() && - 0u != mLogicalModel->mText.Count() ); + 0u != mModel->mLogicalModel->mText.Count() ); } /** @@ -394,7 +452,7 @@ struct Controller::Impl mEventData->mIsShowingPlaceholderText = false; // Remove mPlaceholderTextColor - mVisualModel->SetTextColor( mTextColor ); + mModel->mVisualModel->SetTextColor( mTextColor ); } } @@ -408,26 +466,68 @@ struct Controller::Impl } } - void ResetImfManager() + void ResetInputMethodContext() { if( mEventData ) { // Reset incase we are in a pre-edit state. - if( mEventData->mImfManager ) + if( mEventData->mInputMethodContext ) { - mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding ) + mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding ) } ClearPreEditFlag(); } } + /** + * @brief Helper to notify InputMethodContext with surrounding text & cursor changes. + */ + void NotifyInputMethodContext(); + + /** + * @brief Helper to notify InputMethodContext with multi line status. + */ + void NotifyInputMethodContextMultiLineStatus(); + + /** + * @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 } + bool IsClipboardVisible() + { + bool result( mClipboard && mClipboard.IsVisible() ); + return result; + } + /** * @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. @@ -478,7 +578,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 +586,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,38 +617,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. @@ -605,16 +692,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 +709,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,25 +723,66 @@ 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. +public: + + /** + * @brief Gets implementation from the controller handle. + * @param controller The text controller + * @return The implementation of the Controller + */ + static Impl& GetImplementation( Text::Controller& controller ) + { + return *controller.mImpl; + } + +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. + Vector2 mTextFitContentSize; ///< Size of Text fit content 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. + bool mUpdateTextDirection:1; ///< Whether the text direction needs to be updated. + CharacterDirection mIsTextDirectionRTL:1; ///< Whether the text direction is right to left or not + + 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 mOutlineSetByString:1; ///< Set when outline is set by string (legacy) instead of map + bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map + bool mShouldClearFocusOnEscape:1; ///< Whether text control should clear key input focus + LayoutDirection::Type mLayoutDirection; ///< Current system language direction + + float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10 + float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100 + float mTextFitStepSize; ///< Step Size for font intervalse. Default 1 + bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled. }; } // namespace Text @@ -662,4 +791,4 @@ struct Controller::Impl } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H