dali-toolkit/devel-api/controls/control-accessible.h

   1 #ifndef DALI_TOOLKIT_CONTROL_ACCESSIBLE_H
   2 #define DALI_TOOLKIT_CONTROL_ACCESSIBLE_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 <dali/devel-api/adaptor-framework/accessibility.h>
  23 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
  24 #include <dali/devel-api/adaptor-framework/actor-accessible.h>
  25 #include <dali/devel-api/atspi-interfaces/action.h>
  26 #include <dali/public-api/object/weak-handle.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  30
  31 namespace Dali::Toolkit::DevelControl {
  32
  33 /**
  34  * @brief Represents the Accessible object for Dali::Toolkit::Control and derived classes
  35  *
  36  * You can create a derived class (and override Control::CreateAccessibleObject)
  37  * in order to customize Accessibility for a given control.
  38  *
  39  * @see Dali::Accessibility::Accessible
  40  * @see Dali::Accessibility::Component
  41  * @see Dali::Accessibility::Collection
  42  * @see Dali::Accessibility::Action
  43  * @see Dali::Accessibility::Value
  44  * @see Dali::Accessibility::Text
  45  * @see Dali::Accessibility::EditableText
  46  */
  47 struct DALI_TOOLKIT_API ControlAccessible : public Dali::Accessibility::ActorAccessible,
  48                                             public virtual Dali::Accessibility::Action
  49 {
  50 protected:
  51   Vector2                       mLastPosition{0.0f, 0.0f};
  52   Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
  53
  54   void ScrollToSelf();
  55
  56   /**
  57    * @brief Register property notification to check highlighted object position
  58    */
  59   void RegisterPositionPropertyNotification();
  60
  61   /**
  62    * @brief Remove property notification added by RegisterPropertyNotification
  63    */
  64   void UnregisterPositionPropertyNotification();
  65
  66   /**
  67    * @brief Check if the actor is showing
  68    * @return True if the actor is showing
  69    */
  70   bool IsShowing();
  71
  72 public:
  73   ControlAccessible(Dali::Actor self);
  74
  75   /**
  76    * @copydoc Dali::Accessibility::Accessible::GetName()
  77    */
  78   std::string GetName() const override;
  79
  80   /**
  81    * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
  82    */
  83   virtual std::string GetNameRaw() const;
  84
  85   /**
  86    * @copydoc Dali::Accessibility::Accessible::GetDescription()
  87    */
  88   std::string GetDescription() const override;
  89
  90   /**
  91    * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
  92    */
  93   virtual std::string GetDescriptionRaw() const;
  94
  95   /**
  96    * @copydoc Dali::Accessibility::Accessible::GetRole()
  97    */
  98   Dali::Accessibility::Role GetRole() const override;
  99
 100   /**
 101    * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
 102    */
 103   std::string GetLocalizedRoleName() const override;
 104
 105   /**
 106    * @copydoc Dali::Accessibility::Accessible::GetStates()
 107    */
 108   Dali::Accessibility::States GetStates() override;
 109
 110   /**
 111    * @copydoc Dali::Accessibility::Accessible::GetAttributes()
 112    */
 113   Dali::Accessibility::Attributes GetAttributes() const override;
 114
 115   /**
 116    * @copydoc Dali::Accessibility::Accessible::IsHidden()
 117    */
 118   bool IsHidden() const override;
 119
 120   /**
 121    * @copydoc Dali::Accessibility::Component::GrabFocus()
 122    */
 123   bool GrabFocus() override;
 124
 125   /**
 126    * @copydoc Dali::Accessibility::Component::GrabHighlight()
 127    */
 128   bool GrabHighlight() override;
 129
 130   /**
 131    * @copydoc Dali::Accessibility::Component::ClearHighlight()
 132    */
 133   bool ClearHighlight() override;
 134
 135   /**
 136    * @copydoc Dali::Accessibility::Action::GetActionName()
 137    */
 138   std::string GetActionName(size_t index) const override;
 139
 140   /**
 141    * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
 142    */
 143   std::string GetLocalizedActionName(size_t index) const override;
 144
 145   /**
 146    * @copydoc Dali::Accessibility::Action::GetActionDescription()
 147    */
 148   std::string GetActionDescription(size_t index) const override;
 149
 150   /**
 151    * @copydoc Dali::Accessibility::Action::GetActionCount()
 152    */
 153   size_t GetActionCount() const override;
 154
 155   /**
 156    * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
 157    */
 158   std::string GetActionKeyBinding(size_t index) const override;
 159
 160   /**
 161    * @copydoc Dali::Accessibility::Action::DoAction(std::size_t)
 162    */
 163   bool DoAction(size_t index) override;
 164
 165   /**
 166    * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
 167    */
 168   bool DoAction(const std::string& name) override;
 169
 170   /**
 171    * @copydoc Dali::Accessibility::Accessible::DoGesture()
 172    */
 173   bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
 174
 175   /**
 176    * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
 177    */
 178   std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
 179
 180   /**
 181    * @copydoc Dali::Accessibility::Accessible::GetStates()
 182    */
 183   virtual Dali::Accessibility::States CalculateStates();
 184
 185   /**
 186    * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
 187    * @return false if scrolling is not supported or child is already visible
 188    */
 189   virtual bool ScrollToChild(Actor child);
 190
 191   /**
 192    * @brief Returns the index of the property that represents this actor's name
 193    */
 194   virtual Dali::Property::Index GetNamePropertyIndex();
 195
 196   /**
 197    * @brief Returns the index of the property that represents this actor's description
 198    */
 199   virtual Dali::Property::Index GetDescriptionPropertyIndex();
 200
 201   /**
 202    * @brief Sets last object position
 203    * @param[in] position Last object position
 204    */
 205   void SetLastPosition(Vector2 position);
 206
 207   /**
 208    * @brief Gets last object position
 209    * @return The Last object position
 210    */
 211   Vector2 GetLastPosition() const;
 212 };
 213
 214 } // namespace Dali::Toolkit::DevelControl
 215
 216 #endif // DALI_TOOLKIT_CONTROL_ACCESSIBLE_H