Add APIs for showing/hiding context menu.
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / atspi-accessibility.h
old mode 100755 (executable)
new mode 100644 (file)
index ce65360..7e52419
@@ -1,7 +1,7 @@
 #ifndef DALI_DEVEL_ATSPI_ACCESSIBILITY_H
 #define DALI_DEVEL_ATSPI_ACCESSIBILITY_H
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
@@ -37,7 +37,7 @@ namespace AtspiAccessibility
  * Callback can be one of the following signals:
  * ReadingCancelled, ReadingStopped, ReadingSkipped
  */
-DALI_ADAPTOR_API void Say( const std::string &text, bool discardable, std::function<void(std::string)> callback );
+DALI_ADAPTOR_API void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback);
 
 /**
  * @brief Force accessibility client to pause.
@@ -50,13 +50,28 @@ DALI_ADAPTOR_API void Pause();
 DALI_ADAPTOR_API void Resume();
 
 /**
+ * @brief Cancels anything screen-reader is reading / has queued to read
+ *
+ * @param alsoNonDiscardable whether to cancel non-discardable readings as well
+ */
+DALI_ADAPTOR_API void StopReading(bool alsoNonDiscardable = false);
+
+/**
+ * @brief Suppresses reading of screen-reader
+ *
+ * @param suppress whether to suppress reading of screen-reader
+ * @return true on success, false otherwise
+ */
+DALI_ADAPTOR_API bool SuppressScreenReader(bool suppress);
+
+/**
  * @brief Set ATSPI to be turned On or Off forcibly.
  *
  * @param[in] turnOn true to turn on, false to turn off.
  * @return The status of ATSPI : 0(ATSPI OFF, ScreenReader OFF), 1(ATSPI ON, ScreenReader OFF),
  * 2 (ATSPI OFF, ScreenReader ON), 3(ATSPI ON, ScreenReader ON)
  */
-DALI_ADAPTOR_API int SetForcefully( bool turnOn );
+DALI_ADAPTOR_API int SetForcefully(bool turnOn);
 
 /**
  * @brief Get ATSPI status.