[AT-SPI] Support for hidden text added 66/265666/34
authorMaria Bialota <m.bialota@samsung.com>
Tue, 26 Oct 2021 17:43:01 +0000 (19:43 +0200)
committerMaria Białota <m.bialota@samsung.com>
Tue, 16 Nov 2021 10:18:03 +0000 (10:18 +0000)
- Modified AT-SPI API to not disclose the hidden text in returned values.
- Values returned instead are either empty string or replacement characters.

Change-Id: I6736a30ad70a45b77b0b4ac4b54c2a2c0072df25

automated-tests/src/dali-toolkit-internal/utc-Dali-Accessibility-Text.cpp
dali-toolkit/internal/controls/text-controls/text-field-impl.cpp
dali-toolkit/internal/controls/text-controls/text-field-property-handler.cpp
dali-toolkit/internal/text/hidden-text.cpp
dali-toolkit/internal/text/hidden-text.h

index 6b77f00..eea6fa6 100644 (file)
@@ -23,6 +23,7 @@
 #include <dali-toolkit/dali-toolkit.h>
 
 #include <dali/devel-api/adaptor-framework/accessibility.h>
+#include <dali-toolkit/internal/controls/text-controls/text-field-impl.h>
 #include <dali-toolkit/internal/controls/text-controls/text-editor-impl.h>
 
 #include <automated-tests/src/dali-toolkit-internal/dali-toolkit-test-utils/dbus-wrapper.h>
@@ -221,6 +222,20 @@ int utcDaliAccessibilityTextFieldGetText(void)
     DALI_TEST_EQUALS( x->GetText( 0, 0 ), "", TEST_LOCATION );
     field.SetProperty( Toolkit::TextField::Property::TEXT, "exemplary_text" );
     DALI_TEST_EQUALS( x->GetText( 0, 9 ), "exemplary", TEST_LOCATION );
+
+    Dali::Property::Map hiddenInputSettings;
+    hiddenInputSettings[ Toolkit::HiddenInput::Property::MODE ] = Toolkit::HiddenInput::Mode::HIDE_ALL;
+
+    field.SetProperty( Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS, hiddenInputSettings );
+
+    DALI_TEST_EQUALS( x->GetName(), "", TEST_LOCATION );
+    DALI_TEST_EQUALS( x->GetText( 0, 9 ), "*********", TEST_LOCATION );
+
+    hiddenInputSettings[ Toolkit::HiddenInput::Property::SUBSTITUTE_CHARACTER ] = 0x23;
+    field.SetProperty( Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS, hiddenInputSettings );
+
+    DALI_TEST_EQUALS( x->GetName(), "", TEST_LOCATION );
+    DALI_TEST_EQUALS( x->GetText( 0, 9 ), "#########", TEST_LOCATION );
   }
 
   END_TEST;
@@ -294,6 +309,16 @@ int utcDaliAccessibilityTextFieldGetTextAtOffset(void)
     DALI_TEST_EQUALS( range.content, " test sentence", TEST_LOCATION );
     DALI_TEST_EQUALS( range.startOffset, 25, TEST_LOCATION );
     DALI_TEST_EQUALS( range.endOffset, 39, TEST_LOCATION );
+
+    Dali::Property::Map hiddenInputSettings;
+    hiddenInputSettings[ Toolkit::HiddenInput::Property::MODE ] = Toolkit::HiddenInput::Mode::HIDE_ALL;
+    hiddenInputSettings[ Toolkit::HiddenInput::Property::SUBSTITUTE_CHARACTER ] = 0x23;
+    field.SetProperty( Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS, hiddenInputSettings );
+    range = x->GetTextAtOffset( 8, Dali::Accessibility::TextBoundary::LINE );
+    DALI_TEST_EQUALS( range.content, "", TEST_LOCATION );
+    DALI_TEST_EQUALS( range.startOffset, 0, TEST_LOCATION );
+    DALI_TEST_EQUALS( range.endOffset, 0, TEST_LOCATION );
+
   }
 
   END_TEST;
@@ -321,6 +346,15 @@ int utcDaliAccessibilityTextFieldGetSetRangeOfSelection(void)
     DALI_TEST_EQUALS( range.startOffset, 4, TEST_LOCATION );
     DALI_TEST_EQUALS( range.endOffset, 9, TEST_LOCATION );
     DALI_TEST_EQUALS( range.content, "plary", TEST_LOCATION );
+
+    Dali::Property::Map hiddenInputSettings;
+    hiddenInputSettings[ Toolkit::HiddenInput::Property::MODE ] = Toolkit::HiddenInput::Mode::HIDE_ALL;
+    field.SetProperty( Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS, hiddenInputSettings );
+
+    range = x->GetRangeOfSelection( 0 );
+    DALI_TEST_EQUALS( range.startOffset, 4, TEST_LOCATION );
+    DALI_TEST_EQUALS( range.endOffset, 9, TEST_LOCATION );
+    DALI_TEST_EQUALS( range.content, "*****", TEST_LOCATION );
   }
 
   END_TEST;
index fe01e46..b48faa0 100644 (file)
@@ -201,6 +201,28 @@ Toolkit::TextField::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask in
   return fieldInputStyleMask;
 }
 
+bool IsHiddenInput(Toolkit::TextField textField)
+{
+  Property::Map hiddenInputSettings = textField.GetProperty<Property::Map>(Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS);
+  auto mode  = hiddenInputSettings.Find(Toolkit::HiddenInput::Property::MODE);
+  if (mode && (mode->Get<int>() != Toolkit::HiddenInput::Mode::HIDE_NONE))
+  {
+    return true;
+  }
+  return false;
+}
+
+char GetSubstituteCharacter(Toolkit::TextField textField)
+{
+  Property::Map hiddenInputSettings = textField.GetProperty<Property::Map>(Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS);
+  auto substChar = hiddenInputSettings.Find(Toolkit::HiddenInput::Property::SUBSTITUTE_CHARACTER);
+  if (substChar)
+  {
+    return static_cast<char>(substChar->Get<int>());
+  }
+  return STAR;
+}
+
 } // namespace
 
 Toolkit::TextField TextField::New()
@@ -1101,6 +1123,11 @@ TextField::~TextField()
 std::string TextField::AccessibleImpl::GetName()
 {
   auto self = Toolkit::TextField::DownCast(Self());
+  if (IsHiddenInput(self))
+  {
+    return {};
+  }
+
   return self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
 }
 
@@ -1118,7 +1145,10 @@ std::string TextField::AccessibleImpl::GetText(size_t startOffset, size_t endOff
   {
     return {};
   }
-
+  if(IsHiddenInput(self))
+  {
+    return std::string(endOffset - startOffset, GetSubstituteCharacter(self));
+  }
   return text.substr(startOffset, endOffset - startOffset);
 }
 
@@ -1156,11 +1186,18 @@ Dali::Accessibility::Range TextField::AccessibleImpl::GetTextAtOffset(
   size_t offset, Dali::Accessibility::TextBoundary boundary)
 {
   auto self     = Toolkit::TextField::DownCast(Self());
+  auto range    = Dali::Accessibility::Range{};
+
+  if(IsHiddenInput(self))
+  {
+    // Returning empty object, as there is no possibility to parse the textfield
+    // when its content is hidden.
+    return range;
+  }
+
   auto text     = self.GetProperty(Toolkit::TextField::Property::TEXT).Get<std::string>();
   auto textSize = text.size();
 
-  auto range = Dali::Accessibility::Range{};
-
   switch(boundary)
   {
     case Dali::Accessibility::TextBoundary::CHARACTER:
@@ -1252,13 +1289,21 @@ Dali::Accessibility::Range TextField::AccessibleImpl::GetRangeOfSelection(size_t
     return {};
   }
 
-  auto        self       = Toolkit::TextField::DownCast(Self());
-  auto        controller = Dali::Toolkit::GetImpl(self).GetTextController();
-  std::string value{};
-  controller->RetrieveSelection(value);
+  auto self = Toolkit::TextField::DownCast(Self());
+  auto controller = Dali::Toolkit::GetImpl(self).GetTextController();
   auto indices = controller->GetSelectionIndexes();
 
-  return {static_cast<size_t>(indices.first), static_cast<size_t>(indices.second), value};
+  auto startOffset = static_cast<size_t>(indices.first);
+  auto endOffset = static_cast<size_t>(indices.second);
+
+  if (IsHiddenInput(self))
+  {
+    return {startOffset, endOffset, std::string(endOffset - startOffset, GetSubstituteCharacter(self))};
+  }
+
+  std::string value{};
+  controller->RetrieveSelection(value);
+  return {startOffset, endOffset, value};
 }
 
 bool TextField::AccessibleImpl::RemoveSelection(size_t selectionIndex)
index 04a5082..db08d3a 100644 (file)
@@ -507,6 +507,15 @@ void TextField::PropertyHandler::SetProperty(Toolkit::TextField textField, Prope
       if(map)
       {
         impl.mController->SetHiddenInputOption(*map);
+        auto mode = map->Find(Toolkit::HiddenInput::Property::MODE);
+        if(mode && (mode->Get<int>() != Toolkit::HiddenInput::Mode::HIDE_NONE))
+        {
+          textField.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE, Accessibility::Role::PASSWORD_TEXT);
+        }
+        else
+        {
+          textField.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE, Accessibility::Role::ENTRY);
+        }
       }
       break;
     }
index 1adbe83..ab2aba5 100644 (file)
@@ -23,7 +23,6 @@
 
 using namespace Dali::Toolkit;
 
-const uint32_t STAR                  = 0x2A; // Set default substitute character as '*'
 const int      DEFAULT_SHOW_DURATION = 1000;
 
 namespace Dali
index 70d4a82..b13c263 100644 (file)
@@ -32,6 +32,9 @@ namespace Toolkit
 {
 namespace Text
 {
+
+static constexpr const uint32_t STAR = 0x2A; // Set default substitute character as '*'
+
 /**
  * Class to handle the hidden text
  */