X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-editor-impl.h;h=6b6c37741cc575d30737b4e9c2e2647de9fae1e8;hp=c2385a22ad1a939679e4a94b7bd8a3fc5881d59c;hb=646440beeb663fc5efcccadeba73dd46016ed1b3;hpb=09502f5f09f1294ef5555e4efbf0e7e8115bfbc3 diff --git a/dali-toolkit/internal/controls/text-controls/text-editor-impl.h b/dali-toolkit/internal/controls/text-controls/text-editor-impl.h old mode 100755 new mode 100644 index c2385a2..6b6c377 --- a/dali-toolkit/internal/controls/text-controls/text-editor-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-editor-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H /* - * Copyright (c) 2020 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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. @@ -19,40 +19,39 @@ */ // EXTERNAL INCLUDES +#include #include #include -#include #include // INTERNAL INCLUDES -#include +#include #include -#include #include +#include #include +#include +#include #include +#include #include #include -#include #include -#include -#include +#include +#include namespace Dali { - namespace Toolkit { - namespace Internal { /** * @brief A control which renders a long text string with styles. */ -class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface +class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface { public: - /** * @copydoc Dali::Toollkit::TextEditor::New() */ @@ -67,7 +66,7 @@ public: * @param[in] index The property index. * @param[in] value The new property value. */ - static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ); + static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value); /** * @brief Called to retrieve a property of an object of this type. @@ -76,7 +75,7 @@ public: * @param[in] index The property index. * @return The current value of the property. */ - static Property::Value GetProperty( BaseObject* object, Property::Index index ); + static Property::Value GetProperty(BaseObject* object, Property::Index index); /** * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext() @@ -86,7 +85,17 @@ public: /** * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal() */ - DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + + /** + * @copydoc Dali::Toollkit::TextEditor::AnchorClickedSignal() + */ + DevelTextEditor::AnchorClickedSignalType& AnchorClickedSignal(); + + /** + * @copydoc Dali::Toollkit::TextEditor::InputFilteredSignal() + */ + DevelTextEditor::InputFilteredSignalType& InputFilteredSignal(); /** * Connects a callback function with the object's signals. @@ -97,12 +106,19 @@ public: * @return True if the signal was connected. * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor); + + /** + * @brief Gets text controller + * + * @return The text controller + */ + Text::ControllerPtr GetTextController(); /** * @copydoc TextEditor::TextChangedSignal() */ - Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal(); + Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal(); /** * @copydoc TextEditor::TextChangedSignal() @@ -115,7 +131,6 @@ public: Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal(); private: // From Control - /** * @copydoc Control::OnInitialize() */ @@ -124,7 +139,7 @@ private: // From Control /** * @copydoc Control::OnStyleChange() */ - void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override; + void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; /** * @copydoc Control::GetNaturalSize() @@ -134,12 +149,12 @@ private: // From Control /** * @copydoc Control::GetHeightForWidth() */ - float GetHeightForWidth( float width ) override; + float GetHeightForWidth(float width) override; /** * @copydoc Control::OnInitialize() */ - void OnRelayout( const Vector2& size, RelayoutContainer& container ) override; + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; /** * @copydoc Control::OnKeyInputFocusGained() @@ -159,56 +174,56 @@ private: // From Control /** * @copydoc Control::OnTap() */ - void OnTap( const TapGesture& tap ) override; + void OnTap(const TapGesture& tap) override; /** * @copydoc Control::OnPan() */ - void OnPan( const PanGesture& gesture ) override; + void OnPan(const PanGesture& gesture) override; /** * @copydoc Control::OnLongPress() */ - void OnLongPress( const LongPressGesture& gesture ) override; + void OnLongPress(const LongPressGesture& gesture) override; /** * @copydoc Control::OnSceneConnection() */ - void OnSceneConnection( int depth ) override; + void OnSceneConnection(int depth) override; /** * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) */ bool OnKeyEvent(const KeyEvent& event) override; -// From ControlInterface + // From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ void RequestTextRelayout() override; -// From EditableControlInterface + // From EditableControlInterface /** * @copydoc Text::EditableControlInterface::TextChanged() */ - void TextInserted( unsigned int position, unsigned int length, const std::string &content ) override; + void TextInserted(unsigned int position, unsigned int length, const std::string& content) override; /** * @copydoc Text::EditableControlInterface::TextDeleted() */ - void TextDeleted( unsigned int position, unsigned int length, const std::string &content ) override; + void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::EditableControlInterface::CaretMoved() + * @copydoc Text::EditableControlInterface::CursorMoved() */ - void CaretMoved( unsigned int position ) override; + void CursorMoved(unsigned int position) override; /** * @copydoc Text::EditableControlInterface::TextChanged() */ - void TextChanged() override; + void TextChanged(bool immediate) override; /** * @copydoc Text::EditableControlInterface::MaxLengthReached() @@ -218,19 +233,29 @@ private: // From Control /** * @copydoc Text::EditableControlInterface::InputStyleChanged() */ - void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override; + void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override; /** * @copydoc Text::EditableControlInterface::AddDecoration() */ - void AddDecoration( Actor& actor, bool needsClipping ) override; + void AddDecoration(Actor& actor, bool needsClipping) override; -// From SelectableControlInterface + /** + * @copydoc Text::EditableControlInterface::InputFiltered() + */ + void InputFiltered(Toolkit::InputFilter::Property::Type type) override; + + /** + * @copydoc Text::EditableControlInterface::GetControlBackgroundColor() + */ + void GetControlBackgroundColor(Vector4& color) const override; + + // From SelectableControlInterface public: /** * @copydoc Text::SelectableControlInterface::SetTextSelectionRange() */ - void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) override; + void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override; /** * @copydoc Text::SelectableControlInterface::GetTextSelectionRange() @@ -279,21 +304,26 @@ public: /** * @copydoc Text::EditableControlInterface::SetEditable() */ - void SetEditable( bool editable ) override; - Text::ControllerPtr getController(); + void SetEditable(bool editable) override; -private: // Implementation + // From AnchorControlInterface /** + * @copydoc Text::AnchorControlInterface::AnchorClicked() + */ + void AnchorClicked(const std::string& href) override; + +private: // Implementation + /** * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent) */ - InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent ); + InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent); /** * @brief Callback when Clipboard signals an item should be pasted * @param[in] clipboard handle to Clipboard Event Notifier */ - void OnClipboardTextSelected( ClipboardEventNotifier& clipboard ); + void OnClipboardTextSelected(ClipboardEventNotifier& clipboard); /** * @brief Get a Property Map for the image used for the required Handle Image @@ -301,14 +331,14 @@ private: // Implementation * @param[in] handleType the type of handle * @param[in] handleImageType the type of image for the given handleType */ - void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType ); + void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType); /** * @brief Callback when keyboard is shown/hidden. * * @param[in] keyboardShown True if keyboard is shown. */ - void KeyboardStatusChanged( bool keyboardShown ); + void KeyboardStatusChanged(bool keyboardShown); /** * @brief update scroll bar position @@ -323,7 +353,7 @@ private: // Implementation * @param[in] actor TextEditor touched * @param[in] touch Touch information */ - bool OnTouched( Actor actor, const TouchEvent& touch ); + bool OnTouched(Actor actor, const TouchEvent& touch); /** * @brief Callbacks called on idle. @@ -333,6 +363,11 @@ private: // Implementation void OnIdleSignal(); /** + * @brief Emits TextChanged signal. + */ + void EmitTextChangedSignal(); + + /** * @brief set RenderActor's position with new scrollPosition * * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled @@ -344,7 +379,14 @@ private: // Implementation * * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false */ - void OnScrollIndicatorAnimationFinished( Animation& animation ); + void OnScrollIndicatorAnimationFinished(Animation& animation); + + /** + * @brief Callback function for when the layout is changed. + * @param[in] actor The actor whose layoutDirection is changed. + * @param[in] type The layoutDirection. + */ + void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type); /** * Construct a new TextEditor. @@ -361,65 +403,140 @@ private: // Implementation TextEditor& operator=(const TextEditor& rhs); /** + * @brief Resize actor to the given size. + * + * @param[in] actor The actor to be resized. + * @param[in] size Size to change. + */ + void ResizeActor(Actor& actor, const Vector2& size); + + /** * @brief Render view, create and attach actor(s) to this text editor. */ - void RenderText( Text::Controller::UpdateTextType updateTextType ); + void RenderText(Text::Controller::UpdateTextType updateTextType); // Connection needed to re-render text, when a text editor returns to the scene. - void OnSceneConnect( Dali::Actor actor ); + void OnSceneConnect(Dali::Actor actor); private: // Data // Signals - Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal; - Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal; - Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal; + Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal; + Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal; + Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal; Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal; + Toolkit::DevelTextEditor::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextEditor::InputFilteredSignalType mInputFilteredSignal; - InputMethodContext mInputMethodContext; - Text::ControllerPtr mController; - Text::RendererPtr mRenderer; - Text::DecoratorPtr mDecorator; + InputMethodContext mInputMethodContext; + Text::ControllerPtr mController; + Text::RendererPtr mRenderer; + Text::DecoratorPtr mDecorator; Text::TextVerticalScrollerPtr mTextVerticalScroller; - Toolkit::Control mStencil; - Toolkit::ScrollBar mScrollBar; - Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation. - Dali::TimePeriod mAnimationPeriod; - std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. - - Actor mRenderableActor; - Actor mActiveLayer; + Toolkit::Control mStencil; + Toolkit::ScrollBar mScrollBar; + Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation. + Dali::TimePeriod mAnimationPeriod; + std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. + Dali::InputMethodOptions mInputMethodOptions; + + Actor mRenderableActor; + Actor mActiveLayer; + Actor mBackgroundActor; CallbackBase* mIdleCallback; float mAlignmentOffset; float mScrollAnimationDuration; float mLineSpacing; - int mRenderingBackend; - bool mHasBeenStaged:1; - bool mScrollAnimationEnabled:1; - bool mScrollBarEnabled:1; - bool mScrollStarted:1; + int mRenderingBackend; + bool mHasBeenStaged : 1; + bool mScrollAnimationEnabled : 1; + bool mScrollBarEnabled : 1; + bool mScrollStarted : 1; + bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout(). - struct AccessibleImpl : public Control::Impl::AccessibleImpl, + /** + * @brief This structure is to connect TextEditor with Accessible functions. + */ + struct AccessibleImpl : public DevelControl::AccessibleImpl, public virtual Dali::Accessibility::Text, public virtual Dali::Accessibility::EditableText { - using Control::Impl::AccessibleImpl::AccessibleImpl; + using DevelControl::AccessibleImpl::AccessibleImpl; + /** + * @copydoc Dali::Accessibility::Accessible::GetName() + */ std::string GetName() override; - std::string GetText( size_t startOffset, size_t endOffset ) override; + + /** + * @copydoc Dali::Accessibility::Text::GetText() + */ + std::string GetText(size_t startOffset, size_t endOffset) override; + + /** + * @copydoc Dali::Accessibility::Text::GetCharacterCount() + */ size_t GetCharacterCount() override; - size_t GetCaretOffset() override; - bool SetCaretOffset(size_t offset) override; - Dali::Accessibility::Range - GetTextAtOffset( size_t offset, - Dali::Accessibility::TextBoundary boundary ) override; - Dali::Accessibility::Range GetSelection( size_t selectionNum ) override; - bool RemoveSelection( size_t selectionNum ) override; - bool SetSelection( size_t selectionNum, size_t startOffset, - size_t endOffset ) override; - bool CopyText( size_t startPosition, size_t endPosition ) override; - bool CutText( size_t startPosition, size_t endPosition ) override; - Dali::Accessibility::States CalculateStates() override; + + /** + * @copydoc Dali::Accessibility::Text::GetCursorOffset() + */ + size_t GetCursorOffset() override; + + /** + * @copydoc Dali::Accessibility::Text::SetCursorOffset() + */ + bool SetCursorOffset(size_t offset) override; + + /** + * @copydoc Dali::Accessibility::Text::GetTextAtOffset() + */ + Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override; + + /** + * @copydoc Dali::Accessibility::Text::GetRangeOfSelection() + */ + Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override; + + /** + * @copydoc Dali::Accessibility::Text::RemoveSelection() + */ + bool RemoveSelection(size_t selectionIndex) override; + + /** + * @copydoc Dali::Accessibility::Text::SetRangeOfSelection() + */ + bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override; + + /** + * @copydoc Dali::Accessibility::EditableText::CopyText() + */ + bool CopyText(size_t startPosition, size_t endPosition) override; + + /** + * @copydoc Dali::Accessibility::EditableText::CutText() + */ + bool CutText(size_t startPosition, size_t endPosition) override; + + /** + * @copydoc Dali::Accessibility::Accessible::GetStates() + */ + Accessibility::States CalculateStates() override; + + /** + * @copydoc Dali::Accessibility::EditableText::InsertText() + */ + bool InsertText(size_t startPosition, std::string text) override; + + /** + * @copydoc Dali::Accessibility::EditableText::SetTextContents() + */ + bool SetTextContents(std::string newContents) override; + + /** + * @copydoc Dali::Accessibility::EditableText::DeleteText() + */ + bool DeleteText(size_t startPosition, size_t endPosition) override; }; }; @@ -427,7 +544,7 @@ private: // Data // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor ) +inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor) { DALI_ASSERT_ALWAYS(textEditor); @@ -436,7 +553,7 @@ inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor ) return static_cast(handle); } -inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor& textEditor ) +inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor) { DALI_ASSERT_ALWAYS(textEditor);