X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-field-impl.h;h=dbafa30e42739db9fecb906d1819361d673dd474;hb=549e79b19f4d24588121f55739f9fc53e00fcdaf;hp=e40c6474c8eb030ce7a42a1aed49a1edd888b253;hpb=07bdc775bf08ac2f53c8f6a3a8856077a299959b;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/text-controls/text-field-impl.h b/dali-toolkit/internal/controls/text-controls/text-field-impl.h index e40c647..223fa71 100644 --- a/dali-toolkit/internal/controls/text-controls/text-field-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-field-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 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. @@ -20,33 +20,38 @@ // 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 namespace Dali { - namespace Toolkit { - namespace Internal { - /** * @brief A control which renders a short text string. */ -class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface +class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface { public: - /** * @copydoc Dali::Toollkit::TextField::New() */ @@ -61,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. @@ -70,7 +75,12 @@ 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::TextField::GetInputMethodContext() + */ + InputMethodContext GetInputMethodContext(); /** * Connects a callback function with the object's signals. @@ -81,126 +91,283 @@ 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 TextField::TextChangedSignal() */ - Toolkit::TextField::TextChangedSignalType& TextChangedSignal(); + Toolkit::TextField::TextChangedSignalType& TextChangedSignal(); /** * @copydoc TextField::MaxLengthReachedSignal() */ - Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal(); /** * @copydoc TextField::TextChangedSignal() */ Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal(); -private: // From Control + /** + * @copydoc TextField::AnchorClickedSignal() + */ + DevelTextField::AnchorClickedSignalType& AnchorClickedSignal(); + + /** + * @copydoc TextField::CursorPositionChangedSignal() + */ + DevelTextField::CursorPositionChangedSignalType& CursorPositionChangedSignal(); + + /** + * @copydoc TextField::InputFilteredSignal() + */ + DevelTextField::InputFilteredSignalType& InputFilteredSignal(); + + /** + * @copydoc TextField::SelectionChangedSignal() + */ + DevelTextField::SelectionChangedSignalType& SelectionChangedSignal(); + + /** + * @copydoc TextField::SelectionClearedSignal() + */ + DevelTextField::SelectionClearedSignalType& SelectionClearedSignal(); /** + * @copydoc TextField::SelectionStartedSignal() + */ + DevelTextField::SelectionStartedSignalType& SelectionStartedSignal(); + +private: // From Control + /** * @copydoc Control::OnInitialize() */ - virtual void OnInitialize(); + void OnInitialize() override; /** * @copydoc Control::OnStyleChange() */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); + void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; /** * @copydoc Control::GetNaturalSize() */ - virtual Vector3 GetNaturalSize(); + Vector3 GetNaturalSize() override; /** * @copydoc Control::GetHeightForWidth() */ - virtual float GetHeightForWidth( float width ); + float GetHeightForWidth(float width) override; /** * @copydoc Control::OnInitialize() */ - virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; /** * @copydoc Control::OnKeyInputFocusGained() */ - virtual void OnKeyInputFocusGained(); + void OnKeyInputFocusGained() override; /** * @copydoc Control::OnKeyInputFocusLost() */ - virtual void OnKeyInputFocusLost(); + void OnKeyInputFocusLost() override; + + /** + * @copydoc Control::OnAccessibilityActivated() + */ + bool OnAccessibilityActivated() override; /** * @copydoc Control::OnTap() */ - virtual void OnTap( const TapGesture& tap ); + void OnTap(const TapGesture& tap) override; /** * @copydoc Control::OnPan() */ - virtual void OnPan( const PanGesture& gesture ); + void OnPan(const PanGesture& gesture) override; /** * @copydoc Control::OnLongPress() */ - virtual void OnLongPress( const LongPressGesture& gesture ); + void OnLongPress(const LongPressGesture& gesture) override; /** - * @copydoc Control::OnStageConnection() + * @copydoc Control::OnSceneConnection() */ - virtual void OnStageConnection( int depth ); + void OnSceneConnection(int depth) override; /** * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) */ - virtual bool OnKeyEvent(const KeyEvent& event); + bool OnKeyEvent(const KeyEvent& event) override; -// From ControlInterface + // From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ - virtual void RequestTextRelayout(); + void RequestTextRelayout() override; -// From EditableControlInterface + // From EditableControlInterface /** - * @copydoc Text::ControlInterface::TextChanged() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void TextChanged(); + void TextInserted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::MaxLengthReached() + * @copydoc Text::EditableControlInterface::TextDeleted() */ - virtual void MaxLengthReached(); + void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::InputStyleChanged() + * @copydoc Text::EditableControlInterface::CursorPositionChanged() */ - virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ); + void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override; /** - * @copydoc Text::ControlInterface::AddDecoration() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void AddDecoration( Actor& actor, bool needsClipping ); + void TextChanged(bool immediate) override; -private: // Implementation + /** + * @copydoc Text::EditableControlInterface::MaxLengthReached() + */ + void MaxLengthReached() override; + + /** + * @copydoc Text::EditableControlInterface::InputStyleChanged() + */ + void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override; + + /** + * @copydoc Text::SelectableControlInterface::SelectionChanged() + */ + void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override; + + /** + * @copydoc Text::EditableControlInterface::AddDecoration() + */ + void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override; + + /** + * @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; + + /** + * @copydoc Text::SelectableControlInterface::GetTextSelectionRange() + */ + Uint32Pair GetTextSelectionRange() const override; + + /** + * @copydoc Text::SelectableControlInterface::SelectWholeText() + */ + void SelectWholeText() override; + + /** + * @copydoc Text::SelectableControlInterface::SelectNone() + */ + void SelectNone() override; + + /** + * @copydoc Text::SelectableControlInterface::SelectText() + */ + void SelectText(const uint32_t start, const uint32_t end) override; + + /** + * @copydoc Text::SelectableControlInterface::GetSelectedText() + */ + string GetSelectedText() const override; + + /** + * @copydoc Text::EditableControlInterface::IsEditable() + */ + bool IsEditable() const override; + + /** + * @copydoc Text::EditableControlInterface::SetEditable() + */ + void SetEditable(bool editable) override; + + /** + * @copydoc Dali::EditableControlInterface::CopyText() + */ + string CopyText() override; + + /** + * @copydoc Dali::EditableControlInterface::CutText() + */ + string CutText() override; + + /** + * @copydoc Text::EditableControlInterface::PasteText() + */ + void PasteText() override; + + // From AnchorControlInterface + + /** + * @copydoc Text::AnchorControlInterface::AnchorClicked() + */ + void AnchorClicked(const std::string& href) override; + + /** + * @brief Get the rendered size of a specific text range. + * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to calculate size for. + * @param[in] endIndex end index(included) of the text requested to calculate size for. + * @return list of sizes of the reuested text. + */ + Vector GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const; /** - * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent) + * @brief Get the top/left rendered position of a specific text range. + * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to get position to. + * @param[in] endIndex end index(included) of the text requested to get position to. + * @return list of positions of the requested text. + */ + Vector GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const; + +private: // Implementation + /** + * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent) */ - ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); + 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 @@ -208,21 +375,19 @@ 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 Enable or disable clipping. - * - * @param[in] size The area to clip within. */ - void EnableClipping( const Vector2& size ); + void EnableClipping(); /** * @brief Callback when keyboard is shown/hidden. * * @param[in] keyboardShown True if keyboard is shown. */ - void KeyboardStatusChanged( bool keyboardShown ); + void KeyboardStatusChanged(bool keyboardShown); /** * @brief Callback when TextField is touched @@ -230,7 +395,7 @@ private: // Implementation * @param[in] actor TextField touched * @param[in] touch Touch information */ - bool OnTouched( Actor actor, const TouchData& touch ); + bool OnTouched(Actor actor, const TouchEvent& touch); /** * @brief Callbacks called on idle. @@ -240,6 +405,45 @@ private: // Implementation void OnIdleSignal(); /** + * @brief Emits TextChanged signal. + */ + void EmitTextChangedSignal(); + + /** + * @brief Emits CursorPositionChanged signal. + */ + void EmitCursorPositionChangedSignal(); + + /** + * @brief Emits SelectionChanged signal. + */ + void EmitSelectionChangedSignal(); + + /** + * @brief Emits SelectionCleared signal. + */ + void EmitSelectionClearedSignal(); + + /** + * @brief Emits SelectionStarted signal. + */ + void EmitSelectionStartedSignal(); + + /** + * @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); + + /** + * @brief Add a layer for active or cursor. + * @param[in] layer The actor in which to store the layer. + * @param[in] actor The new layer to add. + */ + void AddLayer(Actor& layer, Actor& actor); + + /** * Construct a new TextField. */ TextField(); @@ -254,39 +458,118 @@ private: // Implementation TextField& operator=(const TextField& 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 Field. */ - void RenderText( Text::Controller::UpdateTextType updateTextType ); + void RenderText(Text::Controller::UpdateTextType updateTextType); - // Connection needed to re-render text, when a Text Field returns to the stage. - void OnStageConnect( Dali::Actor actor ); + // Connection needed to re-render text, when a Text Field returns to the scene. + void OnSceneConnect(Dali::Actor actor); -private: // Data + // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model + void OnAccessibilityStatusChanged(); +private: // Data // Signals - Toolkit::TextField::TextChangedSignalType mTextChangedSignal; - Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal; - Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal; - - Text::ControllerPtr mController; - Text::RendererPtr mRenderer; - Text::DecoratorPtr mDecorator; - Text::ClipperPtr mClipper; ///< For EXCEED_POLICY_CLIP - std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. - - Actor mRenderableActor; + Toolkit::TextField::TextChangedSignalType mTextChangedSignal; + Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal; + Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal; + Toolkit::DevelTextField::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextField::InputFilteredSignalType mInputFilteredSignal; + Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal; + Toolkit::DevelTextField::SelectionChangedSignalType mSelectionChangedSignal; + Toolkit::DevelTextField::SelectionClearedSignalType mSelectionClearedSignal; + Toolkit::DevelTextField::SelectionStartedSignalType mSelectionStartedSignal; + + InputMethodContext mInputMethodContext; + Text::ControllerPtr mController; + Text::RendererPtr mRenderer; + Text::DecoratorPtr mDecorator; + Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP + std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. + std::vector mAnchorActors; + Dali::InputMethodOptions mInputMethodOptions; + + Actor mRenderableActor; + Actor mActiveLayer; + Actor mCursorLayer; + Actor mBackgroundActor; CallbackBase* mIdleCallback; - int mRenderingBackend; - int mExceedPolicy; - bool mHasBeenStaged:1; + float mAlignmentOffset; + int mRenderingBackend; + int mExceedPolicy; + bool mHasBeenStaged : 1; + bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout(). + bool mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout(). + bool mSelectionChanged : 1; ///< If true, emits SelectionChangedSignal at the end of OnRelayout(). + bool mSelectionCleared : 1; ///< If true, emits SelectionClearedSignal at the end of OnRelayout(). + + //args for cursor position changed event + unsigned int mOldPosition; + + //args for selection changed event + uint32_t mOldSelectionStart; + uint32_t mOldSelectionEnd; + + bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout(). + +protected: + struct PropertyHandler; + + /** + * @brief This structure is to connect TextField with Accessible functions. + */ + class TextFieldAccessible : public EditableTextControlAccessible + { + public: + using EditableTextControlAccessible::EditableTextControlAccessible; + + /** + * @copydoc Dali::Accessibility::Accessible::GetName() + */ + std::string GetName() const override; + + protected: + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors() + */ + const std::vector& GetTextAnchors() const override; + + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController() + */ + Toolkit::Text::ControllerPtr GetTextController() const override; + + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetSubstituteCharacter() + */ + std::uint32_t GetSubstituteCharacter() const override; + + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::IsHiddenInput() + */ + bool IsHiddenInput() const override; + + /** + * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout() + */ + void RequestTextRelayout() override; + }; }; } // namespace Internal // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField ) +inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField) { DALI_ASSERT_ALWAYS(textField); @@ -295,7 +578,7 @@ inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField ) return static_cast(handle); } -inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField ) +inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField) { DALI_ASSERT_ALWAYS(textField);