dali/internal/accessibility/bridge/bridge-action.h

   1 #ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_ACTION_H
   2 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_ACTION_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
  21 // EXTERNAL INCLUDES
  22 #include <tuple>
  23 #include <vector>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/internal/accessibility/bridge/bridge-base.h>
  27
  28 /**
  29  * @brief The BridgeAction class is to correspond with Dali::Accessibility::Action.
  30  */
  31 class BridgeAction : public virtual BridgeBase
  32 {
  33 protected:
  34   BridgeAction() = default;
  35
  36   /**
  37    * @brief Registers Action functions to dbus interfaces.
  38    */
  39   void RegisterInterfaces();
  40
  41   /**
  42    * @brief Returns the Action object of the currently executed DBus method call.
  43    *
  44    * @return The Action object
  45    */
  46   Dali::Accessibility::Action* FindSelf() const;
  47
  48 public:
  49   /**
  50    * @copydoc Dali::Accessibility::Action::GetActionName()
  51    */
  52   DBus::ValueOrError<std::string> GetActionName(int32_t index);
  53
  54   /**
  55    * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
  56    */
  57   DBus::ValueOrError<std::string> GetLocalizedActionName(int32_t index);
  58
  59   /**
  60    * @copydoc Dali::Accessibility::Action::GetActionDescription()
  61    */
  62   DBus::ValueOrError<std::string> GetActionDescription(int32_t index);
  63
  64   /**
  65    * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
  66    */
  67   DBus::ValueOrError<std::string> GetActionKeyBinding(int32_t index);
  68
  69   /**
  70    * @copydoc Dali::Accessibility::Action::GetActionCount()
  71    */
  72   DBus::ValueOrError<int32_t> GetActionCount();
  73
  74   /**
  75    * @copydoc Dali::Accessibility::Action::DoAction()
  76    */
  77   DBus::ValueOrError<bool> DoAction(int32_t index);
  78
  79   /**
  80    * @copydoc Dali::Accessibility::Action::DoAction()
  81    */
  82   DBus::ValueOrError<bool> DoActionName(std::string name);
  83 };
  84
  85 #endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_ACTION_H