[Tizen][AT-SPI] Add Value::GetValueText()
[platform/core/uifw/dali-adaptor.git] / dali / internal / accessibility / bridge / bridge-value.h
index 0fb921f..e2d4d09 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_VALUE_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.
 #include <vector>
 
 // INTERNAL INCLUDES
+#include <dali/devel-api/atspi-interfaces/value.h>
 #include <dali/internal/accessibility/bridge/bridge-base.h>
 
+/**
+ * @brief The BridgeValue class is to correspond with Dali::Accessibility::Value.
+ */
 class BridgeValue : public virtual BridgeBase
 {
 protected:
+  /**
+   * @brief Constructor.
+   */
   BridgeValue();
 
+  /**
+   * @brief Registers Value functions to dbus interfaces.
+   */
   void RegisterInterfaces();
 
+  /**
+   * @brief Returns Value Action object of the currently executed DBus method call.
+   *
+   * @return The Value object
+   */
   Dali::Accessibility::Value* FindSelf() const;
 
 public:
+  /**
+   * @copydoc Dali::Accessibility::Value::GetCurrent()
+   */
   double GetCurrentValue();
-  void SetCurrentValue( double new_value );
+
+  /**
+   * @copydoc Dali::Accessibility::Value::SetCurrent()
+   */
+  void SetCurrentValue(double newValue);
+
+  /**
+   * @copydoc Dali::Accessibility::Value::GetValueText()
+   */
+  std::string GetCurrentValueText();
+
+  /**
+   * @copydoc Dali::Accessibility::Value::GetMaximum()
+   */
   double GetMaximumValue();
+
+  /**
+   * @copydoc Dali::Accessibility::Value::GetMinimumIncrement()
+   */
   double GetMinimumIncrement();
+
+  /**
+   * @copydoc Dali::Accessibility::Value::GetMinimum()
+   */
   double GetMinimumValue();
 };