[AT-SPI] Add notification for a11y name/description change
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-label-impl.h
index ae88beb..926128e 100644 (file)
@@ -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) 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.
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/object/property-map.h>
+
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
+#include <dali-toolkit/internal/text/text-control-interface.h>
 #include <dali-toolkit/internal/text/text-controller.h>
+#include <dali-toolkit/internal/text/text-scroller-interface.h>
 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
+#include <dali-toolkit/internal/text/text-scroller.h>
+#include <dali-toolkit/internal/visuals/text/text-visual.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
+
 
 namespace Dali
 {
@@ -36,7 +45,7 @@ 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:
 
@@ -65,57 +74,53 @@ public:
    */
   static Property::Value GetProperty( BaseObject* object, Property::Index index );
 
+  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::OnRelayout()
    */
-  virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+  void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
 
   /**
    * @copydoc Control::GetNaturalSize()
    */
-  virtual Vector3 GetNaturalSize();
+  Vector3 GetNaturalSize() override;
 
   /**
    * @copydoc Control::GetHeightForWidth()
    */
-  virtual float GetHeightForWidth( float width );
+  float GetHeightForWidth( float width ) override;
 
   /**
-   * @copydoc Text::ControlInterface::AddDecoration()
+   * @copydoc Control::OnPropertySet()
    */
-  virtual void AddDecoration( Actor& actor, bool needsClipping );
+  void OnPropertySet( Property::Index index, const Property::Value& propertyValue ) override ;
 
-  /**
-   * @copydoc Control::OnStageConnection()
-   */
-  virtual void OnStageConnection( int depth );
+  // From ControlInterface
 
   /**
    * @copydoc Text::ControlInterface::RequestTextRelayout()
    */
-  virtual void RequestTextRelayout();
+  void RequestTextRelayout() override;
 
-  /**
-   * @copydoc Text::ControlInterface::TextChanged()
-   */
-  virtual void TextChanged();
+private: // from TextScroller
 
   /**
-   * @copydoc Text::ControlInterface::MaxLengthReached()
+   * @copydoc Text::ScrollerInterface::ScrollingFinished()
    */
-  virtual void MaxLengthReached();
+  void ScrollingFinished() override;
 
 private: // Implementation
 
@@ -135,21 +140,54 @@ private:
   TextLabel(const TextLabel&);
   TextLabel& operator=(const TextLabel& rhs);
 
-  // Connection needed to re-render text, when a Text Label returns to the stage
-  void OnStageConnect( Dali::Actor actor );
+  /**
+   * @brief Set up Autoscrolling
+   */
+  void SetUpAutoScrolling();
 
   /**
-   * @brief Render view, create and attach actor(s) to this Text Label
+   * Creates a text-scroller if one has not been created.
+   * @return The text scroller.
    */
-  void RenderText();
+  Text::TextScrollerPtr GetTextScroller()
+  {
+    if( !mTextScroller )
+    {
+      mTextScroller = Text::TextScroller::New( *this );
+    }
+    return mTextScroller;
+  }
 
 private: // Data
 
   Text::ControllerPtr mController;
-  Text::RendererPtr mRenderer;
-  Actor mRenderableActor;
+  Text::TextScrollerPtr mTextScroller;
+
+  Toolkit::Visual::Base mVisual;
+
   int mRenderingBackend;
-  bool mHasBeenStaged:1;
+  bool mTextUpdateNeeded:1;
+
+protected:
+  struct AccessibleImpl : public Control::Impl::AccessibleImpl,
+                          public virtual Dali::Accessibility::Text
+  {
+    using Control::Impl::AccessibleImpl::AccessibleImpl;
+
+    std::string GetText( size_t startOffset, size_t endOffset ) override;
+    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;
+    std::string GetNameRaw() override;
+    Property::Index GetNamePropertyIndex() override;
+  };
 };
 
 } // namespace Internal
@@ -178,4 +216,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