Merge "Text Editing (enable) property in text controls" into devel/master

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / decorator / text-decorator.h

diff --git a/dali-toolkit/internal/text/decorator/text-decorator.h b/dali-toolkit/internal/text/decorator/text-decorator.h
index 11f7062..0d0b25b 100644 (file)
--- a/dali-toolkit/internal/text/decorator/text-decorator.h
+++ b/dali-toolkit/internal/text/decorator/text-decorator.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_TEXT_DECORATOR_H__
-#define __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#ifndef DALI_TOOLKIT_TEXT_DECORATOR_H
+#define DALI_TOOLKIT_TEXT_DECORATOR_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.
@@ -353,23 +353,23 @@ public:
   bool IsHandleActive( HandleType handleType ) const;
 
   /**
-   * @brief Sets the image for one of the handles.
+   * @brief Sets the image file name for one of the handles.
    *
    * @param[in] handleType One of the handles.
    * @param[in] handleImageType A different image can be set for the pressed/released states.
-   * @param[in] image The image to use.
+   * @param[in] imageFileName The image filename to use.
    */
-  void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
+  void SetHandleImage( HandleType handleType, HandleImageType handleImageType, const std::string& imageFileName );
 
   /**
-   * @brief Retrieves the image for one of the handles.
+   * @brief Retrieves the file name of the image for one of the handles.
    *
    * @param[in] handleType One of the handles.
    * @param[in] handleImageType A different image can be set for the pressed/released states.
    *
-   * @return The grab handle image.
+   * @return The grab handle image string.
    */
-  Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
+  const std::string& GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
 
   /**
    * @brief Sets the color of the handles
@@ -515,6 +515,13 @@ public:
   bool IsHighlightActive() const;
 
   /**
+   * @brief Retreives whether the highlight is shown or not.
+   *
+   * @return true if the highlight is visible, false otherwise.
+   */
+  bool IsHighlightVisible() const;
+
+  /**
    * @brief Sets into the decorator the depth used to render the text.
    *
    * @param[in] depth The text's depth.
@@ -572,6 +579,15 @@ public:
    */
   void SetScrollSpeed( float speed );
 
+ /**
+   * @brief Sets Editable mode decoration.
+   *
+   * If this set to false, Primary cursor and grab will always be hidden.
+   *
+   * @param[in] isEditable enable or disable Editing.
+   */
+  void SetEditable( bool isEditable );
+
   /**
    * @brief Retrieves the scroll speed.
    *
@@ -648,4 +664,4 @@ private:
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#endif // DALI_TOOLKIT_TEXT_DECORATOR_H