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

   1 #ifndef DALI_TOOLKIT_ACCESSIBLE_IMPL_H
   2 #define DALI_TOOLKIT_ACCESSIBLE_IMPL_H
   3 /*
   4  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19 // EXTERNAL INCLUDES
  20 #include <dali/devel-api/adaptor-framework/accessibility.h>
  21 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
  22 #include <dali/devel-api/atspi-interfaces/accessible.h>
  23 #include <dali/devel-api/atspi-interfaces/action.h>
  24 #include <dali/devel-api/atspi-interfaces/collection.h>
  25 #include <dali/devel-api/atspi-interfaces/component.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 register it using SetAccessibilityConstructor)
  37  * in order to customize Accessibility for a given control.
  38  *
  39  * @see Dali::Toolkit::DevelControl::SetAccessibilityConstructor
  40  * @see Dali::Accessibility::Accessible
  41  * @see Dali::Accessibility::Component
  42  * @see Dali::Accessibility::Collection
  43  * @see Dali::Accessibility::Action
  44  * @see Dali::Accessibility::Value
  45  * @see Dali::Accessibility::Text
  46  * @see Dali::Accessibility::EditableText
  47  */
  48 struct DALI_TOOLKIT_API AccessibleImpl : public virtual Dali::Accessibility::Accessible,
  49                                          public virtual Dali::Accessibility::Component,
  50                                          public virtual Dali::Accessibility::Collection,
  51                                          public virtual Dali::Accessibility::Action
  52 {
  53 protected:
  54   Vector2                       mLastPosition{0.0f, 0.0f};
  55   Dali::WeakHandle<Dali::Actor> mSelf;
  56   Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
  57   bool mIsModal = false;
  58   bool mIsRoot = false;
  59
  60   Dali::Actor Self() const
  61   {
  62     auto handle = mSelf.GetHandle();
  63
  64     // Control::Impl holds a std::unique_ptr to the Accessible object,
  65     // so that one does not outlive the other.
  66     DALI_ASSERT_ALWAYS(handle);
  67
  68     return handle;
  69   }
  70
  71   void ScrollToSelf();
  72
  73   /**
  74    * @brief Register property notification to check highlighted object position
  75    */
  76   void RegisterPositionPropertyNotification();
  77
  78   /**
  79    * @brief Remove property notification added by RegisterPropertyNotification
  80    */
  81   void UnregisterPositionPropertyNotification();
  82
  83   /**
  84    * @brief Check if the actor is showing
  85    * @return True if the actor is showing
  86    */
  87   bool IsShowing();
  88
  89 public:
  90   AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
  91
  92   /**
  93    * @copydoc Dali::Accessibility::Accessible::GetName()
  94    */
  95   std::string GetName() override;
  96
  97   /**
  98    * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
  99    */
 100   virtual std::string GetNameRaw();
 101
 102   /**
 103    * @copydoc Dali::Accessibility::Accessible::GetDescription()
 104    */
 105   std::string GetDescription() override;
 106
 107   /**
 108    * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
 109    */
 110   virtual std::string GetDescriptionRaw();
 111
 112   /**
 113    * @copydoc Dali::Accessibility::Accessible::GetParent()
 114    */
 115   Dali::Accessibility::Accessible* GetParent() override;
 116
 117   /**
 118    * @copydoc Dali::Accessibility::Accessible::GetChildCount()
 119    */
 120   size_t GetChildCount() override;
 121
 122   /**
 123    * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
 124    */
 125   Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
 126
 127   /**
 128    * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
 129    */
 130   size_t GetIndexInParent() override;
 131
 132   /**
 133    * @copydoc Dali::Accessibility::Accessible::GetRole()
 134    */
 135   Dali::Accessibility::Role GetRole() override;
 136
 137   /**
 138    * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
 139    */
 140   std::string GetLocalizedRoleName() override;
 141
 142   /**
 143    * @copydoc Dali::Accessibility::Accessible::GetStates()
 144    */
 145   Dali::Accessibility::States GetStates() override;
 146
 147   /**
 148    * @copydoc Dali::Accessibility::Accessible::GetAttributes()
 149    */
 150   Dali::Accessibility::Attributes GetAttributes() override;
 151
 152   /**
 153    * @copydoc Dali::Accessibility::Component::GetExtents()
 154    */
 155   Dali::Rect<> GetExtents(Accessibility::CoordinateType type) override;
 156
 157   /**
 158    * @copydoc Dali::Accessibility::Component::GetLayer()
 159    */
 160   Dali::Accessibility::ComponentLayer GetLayer() override;
 161
 162   /**
 163    * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
 164    */
 165   int16_t GetMdiZOrder() override;
 166
 167   /**
 168    * @copydoc Dali::Accessibility::Component::GrabFocus()
 169    */
 170   bool GrabFocus() override;
 171
 172   /**
 173    * @copydoc Dali::Accessibility::Component::GetAlpha()
 174    */
 175   double GetAlpha() override;
 176
 177   /**
 178    * @copydoc Dali::Accessibility::Component::GrabHighlight()
 179    */
 180   bool GrabHighlight() override;
 181
 182   /**
 183    * @copydoc Dali::Accessibility::Component::ClearHighlight()
 184    */
 185   bool ClearHighlight() override;
 186
 187   /**
 188    * @copydoc Dali::Accessibility::Action::GetActionName()
 189    */
 190   std::string GetActionName(size_t index) override;
 191
 192   /**
 193    * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
 194    */
 195   std::string GetLocalizedActionName(size_t index) override;
 196
 197   /**
 198    * @copydoc Dali::Accessibility::Action::GetActionDescription()
 199    */
 200   std::string GetActionDescription(size_t index) override;
 201
 202   /**
 203    * @copydoc Dali::Accessibility::Action::GetActionCount()
 204    */
 205   size_t GetActionCount() override;
 206
 207   /**
 208    * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
 209    */
 210   std::string GetActionKeyBinding(size_t index) override;
 211
 212   /**
 213    * @copydoc Dali::Accessibility::Action::DoAction(size_t)
 214    */
 215   bool DoAction(size_t index) override;
 216
 217   /**
 218    * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
 219    */
 220   bool DoAction(const std::string& name) override;
 221
 222   /**
 223    * @copydoc Dali::Accessibility::Accessible::DoGesture()
 224    */
 225   bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
 226
 227   /**
 228    * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
 229    */
 230   std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
 231
 232   /**
 233    * @copydoc Dali::Accessibility::Accessible::GetInternalActor()
 234    */
 235   Dali::Actor GetInternalActor() override;
 236
 237   /**
 238    * @copydoc Dali::Accessibility::Accessible::GetStates()
 239    */
 240   virtual Dali::Accessibility::States CalculateStates();
 241
 242   /**
 243    * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
 244    * @return false if scrolling is not supported or child is already visible
 245    */
 246   virtual bool ScrollToChild(Actor child);
 247
 248   /**
 249    * @brief Returns the index of the property that represents this actor's name
 250    */
 251   virtual Dali::Property::Index GetNamePropertyIndex();
 252
 253   /**
 254    * @brief Returns the index of the property that represents this actor's description
 255    */
 256   virtual Dali::Property::Index GetDescriptionPropertyIndex();
 257
 258   /**
 259    * @brief Sets last object position
 260    * @param[in] position Last object position
 261    */
 262   void SetLastPosition(Vector2 position);
 263
 264   /**
 265    * @brief Gets last object position
 266    * @return The Last object position
 267    */
 268   Vector2 GetLastPosition() const;
 269 };
 270
 271 } // namespace Dali::Toolkit::DevelControl
 272
 273 #endif // DALI_TOOLKIT_ACCESSIBLE_IMPL_H