X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-label-impl.h;h=c9287639481fa81674edbf42950b6fe65d6f6dca;hb=309be8bafca890aea5baad5c46679cf207adb497;hp=b0c22322f129829404e4be9839680b868116f6e8;hpb=830f03638ec6ecd3b12ba3d9eb6419fdb3a3db09;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/text-controls/text-label-impl.h b/dali-toolkit/internal/controls/text-controls/text-label-impl.h index b0c2232..f4dac1d 100644 --- a/dali-toolkit/internal/controls/text-controls/text-label-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-label-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_LABEL_H +#define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H /* - * Copyright (c) 2015 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. @@ -18,91 +18,179 @@ * */ +// EXTERNAL INCLUDES +#include +#include +#include + // INTERNAL INCLUDES +#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 TextLabel : public Control, public Text::ControlInterface +class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface { public: - - // Properties - enum - { - TEXTLABEL_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - TEXTLABEL_PROPERTY_END_INDEX = TEXTLABEL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices - }; - /** * @copydoc Dali::Toollkit::TextLabel::New() + * @param[in] additionalBehaviour custom behavior flags for this TextLabel. Default is CONTROL_BEHAVIOUR_DEFAULT */ - static Toolkit::TextLabel New(); + static Toolkit::TextLabel New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT); // 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. */ - static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ); + 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 ); + static Property::Value GetProperty(BaseObject* object, Property::Index index); -private: // From Control + /** + * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal() + */ + DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal(); /** - * @copydoc Control::OnInitialize() + * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal() + */ + DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal(); + + /** + * 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. */ - virtual void OnInitialize(); + static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor); /** + * @brief Gets text controller + * + * @return The text controller + */ + Text::ControllerPtr GetTextController(); + + /** + * @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; + + /** + * @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: // From Control + /** * @copydoc Control::OnInitialize() */ - virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container ); + void OnInitialize() override; + + /** + * @copydoc Toolkit::Internal::Control::CreateAccessibleObject() + */ + DevelControl::ControlAccessible* CreateAccessibleObject() override; + + /** + * @copydoc Control::OnStyleChange() + */ + void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; + + /** + * @copydoc Control::OnRelayout() + */ + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; + + /** + * @copydoc Control::OnTap() + */ + void OnTap(const TapGesture& tap) 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::OnPropertySet() + */ + void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override; + + // From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ - virtual void RequestTextRelayout(); + void RequestTextRelayout() override; -private: // Implementation +private: // from TextScroller + /** + * @copydoc Text::ScrollerInterface::ScrollingFinished() + */ + void ScrollingFinished() override; +public: // From AnchorControlInterface + /** + * @copydoc Text::AnchorControlInterface::AnchorClicked() + */ + void AnchorClicked(const std::string& href) override; + +private: // Implementation /** * Construct a new TextLabel. + * + * @param[in] additionalBehaviour additional behaviour flags for this TextLabel */ - TextLabel(); + TextLabel(ControlBehaviour additionalBehaviour); /** * A reference counted object may only be deleted by calling Unreference() @@ -110,24 +198,93 @@ private: // Implementation virtual ~TextLabel(); private: - // Undefined copy constructor and assignment operators TextLabel(const TextLabel&); TextLabel& operator=(const TextLabel& rhs); + /** + * @brief Set up Autoscrolling + */ + void SetUpAutoScrolling(); + + /** + * Creates a text-scroller if one has not been created. + * @return The text scroller. + */ + Text::TextScrollerPtr GetTextScroller() + { + if(!mTextScroller) + { + mTextScroller = Text::TextScroller::New(*this); + } + return mTextScroller; + } + + /** + * @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 Emits TextFitChanged signal. + */ + void EmitTextFitChangedSignal(); + void OnAccessibilityStatusChanged(); + private: // Data + Text::ControllerPtr mController; + Text::TextScrollerPtr mTextScroller; + + Toolkit::Visual::Base mVisual; + + std::vector mAnchorActors; + + // Signals + Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal; - Text::ControllerPtr mController; - Text::RendererPtr mRenderer; + int mRenderingBackend; + bool mTextUpdateNeeded : 1; - unsigned int mRenderingBackend; +protected: + /** + * @brief This structure is to connect TextLabel with Accessible functions. + */ + class TextLabelAccessible : public TextControlAccessible + { + public: + using TextControlAccessible::TextControlAccessible; + + /** + * @copydoc Dali::Accessibility::Text::GetNameRaw() + */ + std::string GetNameRaw() const override; + + /** + * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex() + */ + Property::Index GetNamePropertyIndex() 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; + }; }; } // namespace Internal // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextLabel& GetImpl( Toolkit::TextLabel& textLabel ) +inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel) { DALI_ASSERT_ALWAYS(textLabel); @@ -136,7 +293,7 @@ inline Toolkit::Internal::TextLabel& GetImpl( Toolkit::TextLabel& textLabel ) return static_cast(handle); } -inline const Toolkit::Internal::TextLabel& GetImpl( const Toolkit::TextLabel& textLabel ) +inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel) { DALI_ASSERT_ALWAYS(textLabel); @@ -149,4 +306,4 @@ inline const Toolkit::Internal::TextLabel& GetImpl( const Toolkit::TextLabel& te } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ +#endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H