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