X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-field-impl.h;h=a3058806956dc7b26760d7e40a4c81498ddc564f;hb=27e7fb1ad1e36527c7af8b739ec49ac19b4ff309;hp=4e18eb2600edabb32b3d8ad508b3d1be82edce30;hpb=cbf1db0d70086e78736daaf1a4f0dc3e832378e3;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 old mode 100644 new mode 100755 index 4e18eb2..329d7b5 --- 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_LABEL_H__ -#define __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ +#ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H +#define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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,12 +18,19 @@ * */ +// EXTERNAL INCLUDES +#include +#include + // INTERNAL INCLUDES #include #include -#include -#include -#include +#include +#include +#include +#include +#include +#include namespace Dali { @@ -33,35 +40,23 @@ 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: - // Properties - enum - { - TEXTFIELD_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - TEXTFIELD_PROPERTY_END_INDEX = TEXTFIELD_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices - }; - /** * @copydoc Dali::Toollkit::TextField::New() */ static Toolkit::TextField New(); - /** - * @copydoc Dali::Toollkit::TextField::SetRenderer() - */ - void SetRenderer( Text::RendererPtr renderer ); - // Properties /** - * Called when a property of an object of this type is set. + * @brief Called when a property of an object of this type is set. + * * @param[in] object The object whose property is set. * @param[in] index The property index. * @param[in] value The new property value. @@ -69,38 +64,222 @@ public: static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ); /** - * Called to retrieve a property of an object of this type. + * @brief Called to retrieve a property of an object of this type. + * * @param[in] object The object whose property is to be retrieved. * @param[in] index The property index. * @return The current value of the property. */ 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. + * @param[in] object The object providing the signal. + * @param[in] tracker Used to disconnect the signal. + * @param[in] signalName The signal to connect to. + * @param[in] functor A newly allocated FunctorDelegate. + * @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 ); + + /** + * @copydoc TextField::TextChangedSignal() + */ + Toolkit::TextField::TextChangedSignalType& TextChangedSignal(); + + /** + * @copydoc TextField::MaxLengthReachedSignal() + */ + Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + + /** + * @copydoc TextField::TextChangedSignal() + */ + Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal(); + private: // From Control /** * @copydoc Control::OnInitialize() */ - virtual void OnInitialize(); + void OnInitialize() override; + + /** + * @copydoc Control::OnStyleChange() + */ + void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override; + + /** + * @copydoc Control::GetNaturalSize() + */ + Vector3 GetNaturalSize() override; + + /** + * @copydoc Control::GetHeightForWidth() + */ + float GetHeightForWidth( float width ) override; /** * @copydoc Control::OnInitialize() */ - virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container ); + void OnRelayout( const Vector2& size, RelayoutContainer& container ) override; + + /** + * @copydoc Control::OnKeyInputFocusGained() + */ + void OnKeyInputFocusGained() override; + + /** + * @copydoc Control::OnKeyInputFocusLost() + */ + void OnKeyInputFocusLost() override; /** * @copydoc Control::OnTap() */ - virtual void OnTap( const TapGesture& tap ); + void OnTap( const TapGesture& tap ) override; + + /** + * @copydoc Control::OnPan() + */ + void OnPan( const PanGesture& gesture ) override; + + /** + * @copydoc Control::OnLongPress() + */ + void OnLongPress( const LongPressGesture& gesture ) override; + + /** + * @copydoc Control::OnSceneConnection() + */ + void OnSceneConnection( int depth ) override; + + /** + * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) + */ + bool OnKeyEvent(const KeyEvent& event) override; + +// From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ - virtual void RequestTextRelayout(); + void RequestTextRelayout() override; + +// From EditableControlInterface + + /** + * @copydoc Text::EditableControlInterface::TextChanged() + */ + void TextChanged() override; + + /** + * @copydoc Text::EditableControlInterface::MaxLengthReached() + */ + void MaxLengthReached() override; + + /** + * @copydoc Text::EditableControlInterface::InputStyleChanged() + */ + void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override; + + /** + * @copydoc Text::EditableControlInterface::AddDecoration() + */ + 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 ); + + /** + * @brief Get a Property Map for the image used for the required Handle Image + * @param[out] value the returned image property + * @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 ); + + /** + * @brief Enable or disable clipping. + */ + void EnableClipping(); + + /** + * @brief Callback when keyboard is shown/hidden. + * + * @param[in] keyboardShown True if keyboard is shown. + */ + void KeyboardStatusChanged( bool keyboardShown ); + + /** + * @brief Callback when TextField is touched + * + * @param[in] actor TextField touched + * @param[in] touch Touch information + */ + 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. */ TextField(); @@ -110,37 +289,66 @@ private: // Implementation */ virtual ~TextField(); -private: - // Undefined copy constructor and assignment operators TextField(const TextField&); TextField& operator=(const TextField& rhs); + /** + * @brief Render view, create and attach actor(s) to this Text Field. + */ + void RenderText( Text::Controller::UpdateTextType updateTextType ); + + // Connection needed to re-render text, when a Text Field returns to the scene. + void OnSceneConnect( Dali::Actor actor ); + +public: // For UTC only + + Text::ControllerPtr GetTextController() { return mController; } + private: // Data + // Signals + 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; }; } // namespace Internal // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textLabel ) +inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField ) { - DALI_ASSERT_ALWAYS(textLabel); + DALI_ASSERT_ALWAYS(textField); - Dali::RefObject& handle = textLabel.GetImplementation(); + Dali::RefObject& handle = textField.GetImplementation(); return static_cast(handle); } -inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textLabel ) +inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField ) { - DALI_ASSERT_ALWAYS(textLabel); + DALI_ASSERT_ALWAYS(textField); - const Dali::RefObject& handle = textLabel.GetImplementation(); + const Dali::RefObject& handle = textField.GetImplementation(); return static_cast(handle); } @@ -149,4 +357,4 @@ inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& te } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ +#endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H