Enum properties added for the text effects style. 37/197437/2
authorVictor Cebollada <v.cebollada@samsung.com>
Thu, 10 Jan 2019 15:30:15 +0000 (15:30 +0000)
committerVictor Cebollada <v.cebollada@samsung.com>
Fri, 11 Jan 2019 16:40:06 +0000 (16:40 +0000)
* The keys of type string exist but keys of type Property::Index are missing.

Change-Id: Id959e72a2f5e1ba9b47b85fee1f0419fdce05b14
Signed-off-by: Victor Cebollada <v.cebollada@samsung.com>
automated-tests/src/dali-toolkit/utc-Dali-TextLabel.cpp
dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h [new file with mode: 0644]
dali-toolkit/devel-api/file.list
dali-toolkit/internal/text/text-effects-style.cpp

index 1087e13..67dc221 100755 (executable)
@@ -22,6 +22,7 @@
 #include <dali-toolkit-test-suite-utils.h>
 #include <dali-toolkit/dali-toolkit.h>
 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
+#include <dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h>
 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
 
 using namespace Dali;
@@ -70,55 +71,74 @@ const int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::Text::DEFAULT_RENDERING_BAC
 const std::string DEFAULT_FONT_DIR( "/resources/fonts" );
 const unsigned int EMOJI_FONT_SIZE = 3840u; // 60 * 64
 
-bool DaliTestCheckMaps( const Property::Map& fontStyleMapGet, const Property::Map& fontStyleMapSet )
+bool DaliTestCheckMaps( const Property::Map& mapGet, const Property::Map& mapSet, const std::vector<std::string>& indexConversionTable = std::vector<std::string>() )
 {
-  if( fontStyleMapGet.Count() == fontStyleMapSet.Count() )
+  const Property::Map::SizeType size = mapGet.Count();
+
+  if( size == mapSet.Count() )
   {
-    for( unsigned int index = 0u; index < fontStyleMapGet.Count(); ++index )
+    for( unsigned int index = 0u; index < size; ++index )
     {
-      const KeyValuePair& valueGet = fontStyleMapGet.GetKeyValue( index );
+      const KeyValuePair& valueGet = mapGet.GetKeyValue( index );
 
-      Property::Value* valueSet = NULL;
-      if ( valueGet.first.type == Property::Key::INDEX )
-      {
-        valueSet = fontStyleMapSet.Find( valueGet.first.indexKey );
-      }
-      else
+      // Find the keys of the 'get' map
+      Property::Index indexKey = valueGet.first.indexKey;
+      std::string stringKey = valueGet.first.stringKey;
+
+      if( !indexConversionTable.empty() )
       {
-        // Get Key is a string so searching Set Map for a string key
-        valueSet = fontStyleMapSet.Find( valueGet.first.stringKey );
+        if( stringKey.empty() )
+        {
+          stringKey = indexConversionTable[ indexKey ];
+        }
+
+        if( ( indexKey == Property::INVALID_INDEX ) && !stringKey.empty() )
+        {
+          Property::Index index = 0u;
+          for( auto key : indexConversionTable )
+          {
+            if( key == stringKey )
+            {
+              indexKey = index;
+              break;
+            }
+            ++index;
+          }
+        }
       }
 
-      if( NULL != valueSet )
+      const Property::Value* const valueSet = mapSet.Find( indexKey, stringKey );
+
+      if( nullptr != valueSet )
       {
-        if( valueSet->GetType() == Dali::Property::STRING && ( valueGet.second.Get<std::string>() != valueSet->Get<std::string>() ) )
+        if( ( valueSet->GetType() == Dali::Property::STRING ) && ( valueGet.second.Get<std::string>() != valueSet->Get<std::string>() ) )
         {
           tet_printf( "Value got : [%s], expected : [%s]", valueGet.second.Get<std::string>().c_str(), valueSet->Get<std::string>().c_str() );
           return false;
         }
-        else if( valueSet->GetType() == Dali::Property::BOOLEAN && ( valueGet.second.Get<bool>() != valueSet->Get<bool>() ) )
+        else if( ( valueSet->GetType() == Dali::Property::BOOLEAN ) && ( valueGet.second.Get<bool>() != valueSet->Get<bool>() ) )
         {
           tet_printf( "Value got : [%d], expected : [%d]", valueGet.second.Get<bool>(), valueSet->Get<bool>() );
           return false;
         }
-        else if( valueSet->GetType() == Dali::Property::INTEGER && ( valueGet.second.Get<int>() != valueSet->Get<int>() ) )
+        else if( ( valueSet->GetType() == Dali::Property::INTEGER ) && ( valueGet.second.Get<int>() != valueSet->Get<int>() ) )
         {
           tet_printf( "Value got : [%d], expected : [%d]", valueGet.second.Get<int>(), valueSet->Get<int>() );
           return false;
         }
-        else if( valueSet->GetType() == Dali::Property::FLOAT && ( valueGet.second.Get<float>() != valueSet->Get<float>() ) )
+        else if( ( valueSet->GetType() == Dali::Property::FLOAT ) && ( valueGet.second.Get<float>() != valueSet->Get<float>() ) )
         {
           tet_printf( "Value got : [%f], expected : [%f]", valueGet.second.Get<float>(), valueSet->Get<float>() );
           return false;
         }
-        else if( valueSet->GetType() == Dali::Property::VECTOR2 && ( valueGet.second.Get<Vector2>() != valueSet->Get<Vector2>() ) )
+        else if( ( valueSet->GetType() == Dali::Property::VECTOR2 ) && ( valueGet.second.Get<Vector2>() != valueSet->Get<Vector2>() ) )
         {
           Vector2 vector2Get = valueGet.second.Get<Vector2>();
           Vector2 vector2Set = valueSet->Get<Vector2>();
           tet_printf( "Value got : [%f, %f], expected : [%f, %f]", vector2Get.x, vector2Get.y, vector2Set.x, vector2Set.y );
           return false;
         }
-        else if( valueSet->GetType() == Dali::Property::VECTOR4 && ( valueGet.second.Get<Vector4>() != valueSet->Get<Vector4>() ) )
+        else if( ( valueSet->GetType() == Dali::Property::VECTOR4 ) && ( valueGet.second.Get<Vector4>() != valueSet->Get<Vector4>() ) )
         {
           Vector4 vector4Get = valueGet.second.Get<Vector4>();
           Vector4 vector4Set = valueSet->Get<Vector4>();
@@ -460,13 +480,32 @@ int UtcDaliToolkitTextLabelSetPropertyP(void)
   DALI_TEST_EQUALS( DaliTestCheckMaps( underlineMapGet, underlineMapSet ), true, TEST_LOCATION );
 
   underlineMapSet.Clear();
+  underlineMapSet.Insert( Toolkit::DevelText::Underline::Property::ENABLE, "true" );
+  underlineMapSet.Insert( Toolkit::DevelText::Underline::Property::COLOR, "green" );
+  underlineMapSet.Insert( Toolkit::DevelText::Underline::Property::HEIGHT, "2" );
+
+  label.SetProperty( TextLabel::Property::UNDERLINE, underlineMapSet );
+
+  application.SendNotification();
+  application.Render();
+
+  underlineMapGet = label.GetProperty<Property::Map>( TextLabel::Property::UNDERLINE );
+  DALI_TEST_EQUALS( underlineMapGet.Count(), underlineMapSet.Count(), TEST_LOCATION );
+  std::vector<std::string> underlineIndicesConversionTable = { "enable", "color", "height" };
+  DALI_TEST_EQUALS( DaliTestCheckMaps( underlineMapGet, underlineMapSet, underlineIndicesConversionTable ), true, TEST_LOCATION );
+
+  underlineMapSet.Clear();
 
   Property::Map underlineDisabledMapGet;
   underlineDisabledMapGet.Insert( "enable", "false" );
-  underlineDisabledMapGet.Insert( "color", "red" );
-  underlineDisabledMapGet.Insert( "height", "1" );
+  underlineDisabledMapGet.Insert( "color", "green" );
+  underlineDisabledMapGet.Insert( "height", "2" );
 
   label.SetProperty( TextLabel::Property::UNDERLINE, underlineMapSet );
+
+  application.SendNotification();
+  application.Render();
+
   underlineMapGet = label.GetProperty<Property::Map>( TextLabel::Property::UNDERLINE );
   DALI_TEST_EQUALS( underlineMapGet.Count(), underlineDisabledMapGet.Count(), TEST_LOCATION );
   DALI_TEST_EQUALS( DaliTestCheckMaps( underlineMapGet, underlineDisabledMapGet ), true, TEST_LOCATION );
@@ -487,10 +526,29 @@ int UtcDaliToolkitTextLabelSetPropertyP(void)
   DALI_TEST_EQUALS( DaliTestCheckMaps( shadowMapGet, shadowMapSet ), true, TEST_LOCATION );
 
   shadowMapSet.Clear();
+
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::COLOR, Color::BLUE );
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::OFFSET, "3.0 3.0" );
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::BLUR_RADIUS, 3.0f );
+
+  label.SetProperty( TextLabel::Property::SHADOW, shadowMapSet );
+
+  // Replace the offset (string) by a vector2
+  shadowMapSet.Clear();
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::COLOR, Color::BLUE );
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::OFFSET, Vector2( 3.0, 3.0 ) );
+  shadowMapSet.Insert( Toolkit::DevelText::Shadow::Property::BLUR_RADIUS, 3.0f );
+
+  shadowMapGet = label.GetProperty<Property::Map>( TextLabel::Property::SHADOW );
+  DALI_TEST_EQUALS( shadowMapGet.Count(), shadowMapSet.Count(), TEST_LOCATION );
+  std::vector<std::string> shadowIndicesConversionTable = { "color", "offset", "blurRadius" };
+  DALI_TEST_EQUALS( DaliTestCheckMaps( shadowMapGet, shadowMapSet, shadowIndicesConversionTable ), true, TEST_LOCATION );
+
+  shadowMapSet.Clear();
   Property::Map shadowDisabledMapGet;
-  shadowDisabledMapGet.Insert( "color", Color::GREEN );
+  shadowDisabledMapGet.Insert( "color", Color::BLUE );
   shadowDisabledMapGet.Insert( "offset", Vector2(0.0f, 0.0f) );
-  shadowDisabledMapGet.Insert( "blurRadius", 5.0f );
+  shadowDisabledMapGet.Insert( "blurRadius", 3.0f );
 
   label.SetProperty( TextLabel::Property::SHADOW, shadowMapSet );
 
@@ -521,6 +579,16 @@ int UtcDaliToolkitTextLabelSetPropertyP(void)
   DALI_TEST_EQUALS( outlineMapGet.Count(), outlineMapSet.Count(), TEST_LOCATION );
   DALI_TEST_EQUALS( DaliTestCheckMaps( outlineMapGet, outlineMapSet ), true, TEST_LOCATION );
 
+  outlineMapSet.Clear();
+  outlineMapSet[Toolkit::DevelText::Outline::Property::COLOR] = Color::BLUE;
+  outlineMapSet[Toolkit::DevelText::Outline::Property::WIDTH] = 3.0f;
+  label.SetProperty( TextLabel::Property::OUTLINE, outlineMapSet );
+
+  outlineMapGet = label.GetProperty<Property::Map>( TextLabel::Property::OUTLINE );
+  DALI_TEST_EQUALS( outlineMapGet.Count(), outlineMapSet.Count(), TEST_LOCATION );
+  std::vector<std::string> outlineIndicesConversionTable = { "color", "width" };
+  DALI_TEST_EQUALS( DaliTestCheckMaps( outlineMapGet, outlineMapSet, outlineIndicesConversionTable ), true, TEST_LOCATION );
+
   // Check the background property
   Property::Map backgroundMapSet;
   Property::Map backgroundMapGet;
@@ -533,6 +601,16 @@ int UtcDaliToolkitTextLabelSetPropertyP(void)
   DALI_TEST_EQUALS( backgroundMapGet.Count(), backgroundMapSet.Count(), TEST_LOCATION );
   DALI_TEST_EQUALS( DaliTestCheckMaps( backgroundMapGet, backgroundMapSet ), true, TEST_LOCATION );
 
+  backgroundMapSet.Clear();
+  backgroundMapSet[Toolkit::DevelText::Background::Property::ENABLE] = true;
+  backgroundMapSet[Toolkit::DevelText::Background::Property::COLOR] = Color::GREEN;
+  label.SetProperty( DevelTextLabel::Property::BACKGROUND, backgroundMapSet );
+
+  backgroundMapGet = label.GetProperty<Property::Map>( DevelTextLabel::Property::BACKGROUND );
+  DALI_TEST_EQUALS( backgroundMapGet.Count(), backgroundMapSet.Count(), TEST_LOCATION );
+  std::vector<std::string> backgroundIndicesConversionTable = { "enable", "color" };
+  DALI_TEST_EQUALS( DaliTestCheckMaps( backgroundMapGet, backgroundMapSet, backgroundIndicesConversionTable ), true, TEST_LOCATION );
+
   // Check the pixel size of font
   label.SetProperty( TextLabel::Property::PIXEL_SIZE, 20.f );
   DALI_TEST_EQUALS( label.GetProperty<float>( TextLabel::Property::PIXEL_SIZE ), 20.f, Math::MACHINE_EPSILON_1000, TEST_LOCATION );
diff --git a/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h
new file mode 100644 (file)
index 0000000..b663105
--- /dev/null
@@ -0,0 +1,171 @@
+#ifndef DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
+#define DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
+
+/*
+ * Copyright (c) 2019 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+namespace Dali
+{
+
+namespace Toolkit
+{
+
+/**
+ * @addtogroup dali_toolkit_controls
+ * @{
+ */
+
+namespace DevelText
+{
+
+namespace Shadow
+{
+
+/**
+ * @brief Used by Text controls to show different styles of text.
+ *
+ */
+namespace Property
+{
+
+enum
+{
+  /**
+   * @brief The color of the shadow.
+   * @details Name "color", type Property::STRING or Property::VECTOR4.
+   * @note Optional. If not provided the default color (BLACK) is used.
+   */
+  COLOR,
+
+  /**
+   * @brief The offset in pixels of the shadow.
+   * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
+   * @note Optional. If not provided then the shadow is not enabled.
+   */
+  OFFSET,
+
+  /**
+   * @brief The radius of the Gaussian blur for the soft shadow.
+   * @details Name "blurRadius", type Property::STRING or Property::FLOAT. i.e "5.0" or 5.f
+   * @note Optional. If not provided then the soft shadow is not enabled.
+   */
+  BLUR_RADIUS
+};
+
+} // namespace Property
+
+} // namespace Shadow
+
+namespace Underline
+{
+
+namespace Property
+{
+
+enum
+{
+  /**
+   * @brief Whether the underline is enabled.
+   * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
+   * @note Optional. By default is disabled.
+   */
+  ENABLE,
+
+  /**
+   * @brief The color of the underline.
+   * @details Name "color", type Property::STRING or Property::VECTOR4
+   * @note Optional. If not provided then the color of the text is used.
+   */
+  COLOR,
+
+  /**
+   * @brief The height in pixels of the underline.
+   * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
+   * @note Optional. If not provided then the default height is used (1 pixel).
+   */
+  HEIGHT
+};
+
+} // namespace Property
+
+} // namespace Underline
+
+namespace Outline
+{
+
+namespace Property
+{
+
+enum
+{
+  /**
+   * @brief The color of the outline.
+   * @details Name "color", type Property::STRING or Property::VECTOR4
+   * @note Optional. If not provided the default color (WHITE) is used.
+   */
+  COLOR,
+
+  /**
+   * @brief The width in pixels of the outline.
+   * @details Name "width", type Property::STRING or Property::FLOAT i.e. "1.0" or 1.f
+   * @note Optional. If not provided then the outline is not enabled.
+   */
+  WIDTH
+};
+
+} // namespace Property
+
+} // namespace Outline
+
+namespace Background
+{
+
+namespace Property
+{
+
+enum
+{
+  /**
+   * @brief Whether to paint the text's background.
+   * @details Name "enable", type Property::STRING or Property::BOOLEAN i.e. "true", "false", true or false
+   * @note Optional. By default is disabled.
+   */
+  ENABLE,
+
+  /**
+   * @brief The color of the background.
+   * @details Name "color", type Property::STRING or Property::VECTOR4
+   * @note Optional. If not provided the default color (CYAN) is used.
+   */
+  COLOR
+};
+
+} // namespace Property
+
+} // namespace Background
+
+} // namespace DevelText
+
+/**
+ * @}
+ */
+
+} // namespace Toolkit
+
+} // namespace Dali
+
+#endif // DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
index ebb9631..ef91d3a 100755 (executable)
@@ -177,7 +177,8 @@ devel_api_text_controls_header_files = \
   $(devel_api_src_dir)/controls/text-controls/text-field-devel.h \
   $(devel_api_src_dir)/controls/text-controls/text-label-devel.h \
   $(devel_api_src_dir)/controls/text-controls/text-selection-popup.h \
-  $(devel_api_src_dir)/controls/text-controls/text-selection-toolbar.h
+  $(devel_api_src_dir)/controls/text-controls/text-selection-toolbar.h \
+  $(devel_api_src_dir)/controls/text-controls/text-style-properties-devel.h
 
 devel_api_text_header_files = \
   $(devel_api_src_dir)/text/text-enumerations-devel.h
index a3f07d6..f65655b 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
@@ -19,6 +19,7 @@
 #include <dali-toolkit/internal/text/text-effects-style.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h>
 #include <dali-toolkit/internal/text/markup-processor-helper-functions.h>
 #include <dali-toolkit/internal/text/property-string-parser.h>
 
@@ -58,7 +59,7 @@ bool ParseShadowProperties( const Property::Map& shadowPropertiesMap,
   {
     const KeyValuePair& valueGet = shadowPropertiesMap.GetKeyValue( index );
 
-    if( COLOR_KEY == valueGet.first.stringKey )
+    if( ( DevelText::Shadow::Property::COLOR == valueGet.first.indexKey ) || ( COLOR_KEY == valueGet.first.stringKey ) )
     {
       /// Color key.
       colorDefined = true;
@@ -73,7 +74,7 @@ bool ParseShadowProperties( const Property::Map& shadowPropertiesMap,
         color = valueGet.second.Get<Vector4>();
       }
     }
-    else if( OFFSET_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Shadow::Property::OFFSET == valueGet.first.indexKey ) || ( OFFSET_KEY == valueGet.first.stringKey ) )
     {
       /// Offset key.
       offsetDefined = true;
@@ -88,7 +89,7 @@ bool ParseShadowProperties( const Property::Map& shadowPropertiesMap,
         offset = valueGet.second.Get<Vector2>();
       }
     }
-    else if( BLUR_RADIUS_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Shadow::Property::BLUR_RADIUS == valueGet.first.indexKey ) || ( BLUR_RADIUS_KEY == valueGet.first.stringKey ) )
     {
       /// Blur radius key.
       blurRadiusDefined = true;
@@ -122,7 +123,7 @@ bool ParseUnderlineProperties( const Property::Map& underlinePropertiesMap,
   {
     const KeyValuePair& valueGet = underlinePropertiesMap.GetKeyValue( index );
 
-    if( ENABLE_KEY == valueGet.first.stringKey )
+    if( ( DevelText::Underline::Property::ENABLE == valueGet.first.indexKey ) || ( ENABLE_KEY == valueGet.first.stringKey ) )
     {
       /// Enable key.
       if( valueGet.second.GetType() == Dali::Property::STRING )
@@ -135,7 +136,7 @@ bool ParseUnderlineProperties( const Property::Map& underlinePropertiesMap,
         enabled = valueGet.second.Get<bool>();
       }
     }
-    else if( COLOR_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Underline::Property::COLOR == valueGet.first.indexKey ) || ( COLOR_KEY == valueGet.first.stringKey ) )
     {
       /// Color key.
       colorDefined = true;
@@ -150,7 +151,7 @@ bool ParseUnderlineProperties( const Property::Map& underlinePropertiesMap,
         color = valueGet.second.Get<Vector4>();
       }
     }
-    else if( HEIGHT_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Underline::Property::HEIGHT == valueGet.first.indexKey ) || ( HEIGHT_KEY == valueGet.first.stringKey ) )
     {
       /// Height key.
       heightDefined = true;
@@ -183,13 +184,13 @@ bool ParseOutlineProperties( const Property::Map& underlinePropertiesMap,
   {
     const KeyValuePair& valueGet = underlinePropertiesMap.GetKeyValue( index );
 
-    if( COLOR_KEY == valueGet.first.stringKey )
+    if( ( DevelText::Outline::Property::COLOR == valueGet.first.indexKey ) || ( COLOR_KEY == valueGet.first.stringKey ) )
     {
       /// Color key.
       colorDefined = true;
       color = valueGet.second.Get<Vector4>();
     }
-    else if( WIDTH_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Outline::Property::WIDTH == valueGet.first.indexKey ) || ( WIDTH_KEY == valueGet.first.stringKey ) )
     {
       /// Width key.
       widthDefined = true;
@@ -212,12 +213,12 @@ bool ParseBackgroundProperties( const Property::Map& backgroundProperties,
   {
     const KeyValuePair& valueGet = backgroundProperties.GetKeyValue( index );
 
-    if( ENABLE_KEY == valueGet.first.stringKey )
+    if( ( DevelText::Background::Property::ENABLE == valueGet.first.indexKey ) || ( ENABLE_KEY == valueGet.first.stringKey ) )
     {
       /// Enable key.
       enabled = valueGet.second.Get<bool>();
     }
-    else if( COLOR_KEY == valueGet.first.stringKey )
+    else if( ( DevelText::Background::Property::COLOR == valueGet.first.indexKey ) || ( COLOR_KEY == valueGet.first.stringKey ) )
     {
       /// Color key.
       colorDefined = true;