dali/devel-api/atspi-interfaces/value.h

   1 #ifndef DALI_ADAPTOR_ATSPI_VALUE_H
   2 #define DALI_ADAPTOR_ATSPI_VALUE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 // INTERNAL INCLUDES
  21 #include <dali/devel-api/atspi-interfaces/accessible.h>
  22
  23 namespace Dali::Accessibility
  24 {
  25 /**
  26  * @brief Interface representing objects which can store numeric value.
  27  */
  28 class DALI_ADAPTOR_API Value : public virtual Accessible
  29 {
  30 public:
  31   /**
  32    * @brief Gets the lowest possible value.
  33    *
  34    * @return The minimum value
  35   */
  36   virtual double GetMinimum() = 0;
  37
  38   /**
  39    * @brief Gets the current value.
  40    *
  41    * @return The current value
  42   */
  43   virtual double GetCurrent() = 0;
  44
  45   /**
  46    * @brief Gets the highest possible value.
  47    *
  48    * @return The highest value.
  49   */
  50   virtual double GetMaximum() = 0;
  51
  52   /**
  53    * @brief Sets the current value.
  54    *
  55    * @param[in] value The current value to set
  56    *
  57    * @return true if value could have been assigned, false otherwise
  58   */
  59   virtual bool SetCurrent(double value) = 0;
  60
  61   /**
  62    * @brief Gets the lowest increment that can be distinguished.
  63    *
  64    * @return The lowest increment
  65   */
  66   virtual double GetMinimumIncrement() = 0;
  67 };
  68
  69 } // namespace Dali::Accessibility
  70
  71 #endif // DALI_ADAPTOR_ATSPI_VALUE_H