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-field-impl.h;h=07a7a374511c3519f0127def51b00bf6c19bcd7c;hp=bd02762ff613580531b95552ef7222da52665bba;hb=33ccee79d16a90d5f7ab427de1503ccc5bee4324;hpb=761122f3e8ff2b224d2329a911a78dc35177c5ea 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 bd02762..07a7a37 100644 --- a/dali-toolkit/internal/controls/text-controls/text-field-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-field-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__ -#define __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__ +#ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H +#define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H /* - * Copyright (c) 2015 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. @@ -18,34 +18,34 @@ * */ +// EXTERNAL INCLUDES +#include +#include + // INTERNAL INCLUDES -#include -#include -#include +#include +#include #include +#include #include #include -#include - -// EXTERNAL INCLUDES -#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 +class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface { public: - /** * @copydoc Dali::Toollkit::TextField::New() */ @@ -60,7 +60,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. @@ -69,7 +69,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. @@ -80,114 +85,183 @@ 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); /** * @copydoc TextField::TextChangedSignal() */ - Toolkit::TextField::TextChangedSignalType& TextChangedSignal(); + Toolkit::TextField::TextChangedSignalType& TextChangedSignal(); /** * @copydoc TextField::MaxLengthReachedSignal() */ - Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal(); -private: // From Control + /** + * @copydoc TextField::TextChangedSignal() + */ + Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal(); + Text::ControllerPtr getController(); + +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 + + /** + * @copydoc Text::ControlInterface::RequestTextRelayout() + */ + void RequestTextRelayout() override; -// From ControlInterface + // From EditableControlInterface /** - * @copydoc Text::ControlInterface::AddDecoration() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void AddDecoration( Actor& actor, bool needsClipping ); + void TextInserted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::RequestTextRelayout() + * @copydoc Text::EditableControlInterface::TextDeleted() */ - virtual void RequestTextRelayout(); + void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::TextChanged() + * @copydoc Text::EditableControlInterface::CaretMoved() */ - virtual void TextChanged(); + void CaretMoved(unsigned int position) override; /** - * @copydoc Text::ControlInterface::MaxLengthReached() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void MaxLengthReached(); + void TextChanged() override; -private: // Implementation + /** + * @copydoc Text::EditableControlInterface::MaxLengthReached() + */ + void MaxLengthReached() override; + + /** + * @copydoc Text::EditableControlInterface::InputStyleChanged() + */ + void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override; /** - * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent) + * @copydoc Text::EditableControlInterface::AddDecoration() */ - ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); + void AddDecoration(Actor& actor, bool needsClipping) 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::GetSelectedText() + */ + string GetSelectedText() const override; + + /** + * @copydoc Text::EditableControlInterface::IsEditable() + */ + bool IsEditable() const override; + + /** + * @copydoc Text::EditableControlInterface::SetEditable() + */ + void SetEditable(bool editable) override; + +private: // Implementation + /** + * @copydoc Dali::Toolkit::Text::Controller::(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 @@ -195,22 +269,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] clipping True if clipping should be enabled. - * @param[in] size The area to clip within. */ - void EnableClipping( bool clipping, 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 @@ -218,7 +289,14 @@ 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. + * + * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted. + */ + void OnIdleSignal(); /** * Construct a new TextField. @@ -235,37 +313,79 @@ 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(); + 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 +public: // For UTC only + Text::ControllerPtr GetTextController() + { + return mController; + } +private: // Data // Signals - Toolkit::TextField::TextChangedSignalType mTextChangedSignal; - Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal; - - 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; - - int mRenderingBackend; - int mExceedPolicy; - bool mHasBeenStaged:1; + Toolkit::TextField::TextChangedSignalType mTextChangedSignal; + Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal; + Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal; + + 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. + Dali::InputMethodOptions mInputMethodOptions; + + Actor mRenderableActor; + Actor mActiveLayer; + Actor mBackgroundActor; + CallbackBase* mIdleCallback; + + float mAlignmentOffset; + int mRenderingBackend; + int mExceedPolicy; + bool mHasBeenStaged : 1; + bool mTextChanged : 1; + +protected: + struct AccessibleImpl : public DevelControl::AccessibleImpl, + public virtual Dali::Accessibility::Text, + public virtual Dali::Accessibility::EditableText + { + using DevelControl::AccessibleImpl::AccessibleImpl; + + std::string GetName() override; + std::string GetText(size_t startOffset, size_t endOffset) override; + size_t GetCharacterCount() override; + size_t GetCaretOffset() override; + bool SetCaretOffset(size_t offset) override; + Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override; + 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; + Accessibility::States CalculateStates() 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); @@ -274,7 +394,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); @@ -287,4 +407,4 @@ inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& te } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__ +#endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H