Merge "Fix documentation for Text::EditableControlInterface interface override functi...

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-field-impl.h

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 201d5d1..165234b 100755 (executable)
--- 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
 
 /*
 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
 
 /*

- * Copyright (c) 2017 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.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.


@@ -28,6 +28,7 @@
 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
 #include <dali-toolkit/internal/text/text-control-interface.h>
 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
 #include <dali-toolkit/internal/text/text-control-interface.h>
 #include <dali-toolkit/internal/text/text-editable-control-interface.h>

+#include <dali-toolkit/internal/text/text-selectable-control-interface.h>

 #include <dali-toolkit/internal/text/text-controller.h>
 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
 
 #include <dali-toolkit/internal/text/text-controller.h>
 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
 


@@ -42,7 +43,7 @@ namespace Internal
 /**
  * @brief A control which renders a short text string.
  */
 /**
  * @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:
 
 {
 public:
 


@@ -107,7 +108,7 @@ public:
    */
   void SelectWholeText();
 
    */
   void SelectWholeText();
 

-    /**
+  /**

    * @brief Called to unselect the whole texts.
    */
   void SelectNone();
    * @brief Called to unselect the whole texts.
    */
   void SelectNone();


@@ -117,91 +118,113 @@ private: // From Control
   /**
    * @copydoc Control::OnInitialize()
    */
   /**
    * @copydoc Control::OnInitialize()
    */

-  virtual void OnInitialize();
+  void OnInitialize() override;

 
   /**
    * @copydoc Control::OnStyleChange()
    */
 
   /**
    * @copydoc Control::OnStyleChange()
    */

-  virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
+  void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override;

 
   /**
    * @copydoc Control::GetNaturalSize()
    */
 
   /**
    * @copydoc Control::GetNaturalSize()
    */

-  virtual Vector3 GetNaturalSize();
+  Vector3 GetNaturalSize() override;

 
   /**
    * @copydoc Control::GetHeightForWidth()
    */
 
   /**
    * @copydoc Control::GetHeightForWidth()
    */

-  virtual float GetHeightForWidth( float width );
+  float GetHeightForWidth( float width ) override;

 
   /**
    * @copydoc Control::OnInitialize()
    */
 
   /**
    * @copydoc Control::OnInitialize()
    */

-  virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+  void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;

 
   /**
    * @copydoc Control::OnKeyInputFocusGained()
    */
 
   /**
    * @copydoc Control::OnKeyInputFocusGained()
    */

-  virtual void OnKeyInputFocusGained();
+  void OnKeyInputFocusGained() override;

 
   /**
    * @copydoc Control::OnKeyInputFocusLost()
    */
 
   /**
    * @copydoc Control::OnKeyInputFocusLost()
    */

-  virtual void OnKeyInputFocusLost();
+  void OnKeyInputFocusLost() override;

 
   /**
    * @copydoc Control::OnTap()
    */
 
   /**
    * @copydoc Control::OnTap()
    */

-  virtual void OnTap( const TapGesture& tap );
+  void OnTap( const TapGesture& tap ) override;

 
   /**
    * @copydoc Control::OnPan()
    */
 
   /**
    * @copydoc Control::OnPan()
    */

-  virtual void OnPan( const PanGesture& gesture );
+  void OnPan( const PanGesture& gesture ) override;

 
   /**
    * @copydoc Control::OnLongPress()
    */
 
   /**
    * @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&)
    */
 
   /**
    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
    */

-  virtual bool OnKeyEvent(const KeyEvent& event);
+  bool OnKeyEvent(const KeyEvent& event) override;

 
 // From ControlInterface
 
   /**
    * @copydoc Text::ControlInterface::RequestTextRelayout()
    */
 
 // From ControlInterface
 
   /**
    * @copydoc Text::ControlInterface::RequestTextRelayout()
    */

-  virtual void RequestTextRelayout();
+  void RequestTextRelayout() override;

 
 // From EditableControlInterface
 
   /**
    * @copydoc Text::EditableControlInterface::TextChanged()
    */
 
 // From EditableControlInterface
 
   /**
    * @copydoc Text::EditableControlInterface::TextChanged()
    */

-  virtual void TextChanged();
+  void TextChanged() override;

 
   /**
    * @copydoc Text::EditableControlInterface::MaxLengthReached()
    */
 
   /**
    * @copydoc Text::EditableControlInterface::MaxLengthReached()
    */

-  virtual void MaxLengthReached();
+  void MaxLengthReached() override;

 
   /**
    * @copydoc Text::EditableControlInterface::InputStyleChanged()
    */
 
   /**
    * @copydoc Text::EditableControlInterface::InputStyleChanged()
    */

-  virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask );
+  void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override;

 
   /**
    * @copydoc Text::EditableControlInterface::AddDecoration()
    */
 
   /**
    * @copydoc Text::EditableControlInterface::AddDecoration()
    */

-  virtual void AddDecoration( Actor& actor, bool needsClipping );
+  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::EditableControlInterface::IsEditable()
+   */
+  bool IsEditable() const override;
+
+  /**
+   * @copydoc Text::EditableControlInterface::SetEditable()
+   */
+  void SetEditable( bool editable ) override;

 
 private: // Implementation
 
 
 private: // Implementation
 


@@ -242,7 +265,7 @@ private: // Implementation
    * @param[in] actor TextField touched
    * @param[in] touch Touch information
    */
    * @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.
 
   /**
    * @brief Callbacks called on idle.


@@ -270,8 +293,8 @@ private: // Implementation
    */
   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 );

 
 public: // For UTC only
 
 
 public: // For UTC only