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/atspi-interfaces/accessible.h>
  25 #include <dali/devel-api/atspi-interfaces/action.h>
  26 #include <dali/devel-api/atspi-interfaces/collection.h>
  27 #include <dali/devel-api/atspi-interfaces/component.h>
  28 #include <dali/public-api/object/weak-handle.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  32
  33 namespace Dali::Toolkit::DevelControl {
  34
  35 /**
  36  * @brief Represents the Accessible object for Dali::Toolkit::Control and derived classes
  37  *
  38  * You can create a derived class (and register it using SetAccessibilityConstructor)
  39  * in order to customize Accessibility for a given control.
  40  *
  41  * @see Dali::Toolkit::DevelControl::SetAccessibilityConstructor
  42  * @see Dali::Accessibility::Accessible
  43  * @see Dali::Accessibility::Component
  44  * @see Dali::Accessibility::Collection
  45  * @see Dali::Accessibility::Action
  46  * @see Dali::Accessibility::Value
  47  * @see Dali::Accessibility::Text
  48  * @see Dali::Accessibility::EditableText
  49  */
  50 struct DALI_TOOLKIT_API ControlAccessible : public virtual Dali::Accessibility::Accessible,
  51                                             public virtual Dali::Accessibility::Component,
  52                                             public virtual Dali::Accessibility::Collection,
  53                                             public virtual Dali::Accessibility::Action
  54 {
  55 protected:
  56   Vector2                       mLastPosition{0.0f, 0.0f};
  57   Dali::WeakHandle<Dali::Actor> mSelf;
  58   Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
  59   bool mIsModal = false;
  60   bool mIsRoot = false;
  61
  62   Dali::Actor Self() const
  63   {
  64     auto handle = mSelf.GetHandle();
  65
  66     // Control::Impl holds a std::unique_ptr to the Accessible object,
  67     // so that one does not outlive the other.
  68     DALI_ASSERT_ALWAYS(handle);
  69
  70     return handle;
  71   }
  72
  73   void ScrollToSelf();
  74
  75   /**
  76    * @brief Register property notification to check highlighted object position
  77    */
  78   void RegisterPositionPropertyNotification();
  79
  80   /**
  81    * @brief Remove property notification added by RegisterPropertyNotification
  82    */
  83   void UnregisterPositionPropertyNotification();
  84
  85   /**
  86    * @brief Check if the actor is showing
  87    * @return True if the actor is showing
  88    */
  89   bool IsShowing();
  90
  91 public:
  92   ControlAccessible(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
  93
  94   /**
  95    * @copydoc Dali::Accessibility::Accessible::GetName()
  96    */
  97   std::string GetName() const override;
  98
  99   /**
 100    * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
 101    */
 102   virtual std::string GetNameRaw() const;
 103
 104   /**
 105    * @copydoc Dali::Accessibility::Accessible::GetDescription()
 106    */
 107   std::string GetDescription() const override;
 108
 109   /**
 110    * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
 111    */
 112   virtual std::string GetDescriptionRaw() const;
 113
 114   /**
 115    * @copydoc Dali::Accessibility::Accessible::GetParent()
 116    */
 117   Dali::Accessibility::Accessible* GetParent() override;
 118
 119   /**
 120    * @copydoc Dali::Accessibility::Accessible::GetChildCount()
 121    */
 122   size_t GetChildCount() const override;
 123
 124   /**
 125    * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
 126    */
 127   Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
 128
 129   /**
 130    * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
 131    */
 132   size_t GetIndexInParent() override;
 133
 134   /**
 135    * @copydoc Dali::Accessibility::Accessible::GetRole()
 136    */
 137   Dali::Accessibility::Role GetRole() const override;
 138
 139   /**
 140    * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
 141    */
 142   std::string GetLocalizedRoleName() const override;
 143
 144   /**
 145    * @copydoc Dali::Accessibility::Accessible::GetStates()
 146    */
 147   Dali::Accessibility::States GetStates() override;
 148
 149   /**
 150    * @copydoc Dali::Accessibility::Accessible::GetAttributes()
 151    */
 152   Dali::Accessibility::Attributes GetAttributes() const override;
 153
 154   /**
 155    * @copydoc Dali::Accessibility::Component::GetExtents()
 156    */
 157   Dali::Rect<> GetExtents(Accessibility::CoordinateType type) const override;
 158
 159   /**
 160    * @copydoc Dali::Accessibility::Component::GetLayer()
 161    */
 162   Dali::Accessibility::ComponentLayer GetLayer() const override;
 163
 164   /**
 165    * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
 166    */
 167   int16_t GetMdiZOrder() const override;
 168
 169   /**
 170    * @copydoc Dali::Accessibility::Component::GrabFocus()
 171    */
 172   bool GrabFocus() override;
 173
 174   /**
 175    * @copydoc Dali::Accessibility::Component::GetAlpha()
 176    */
 177   double GetAlpha() const override;
 178
 179   /**
 180    * @copydoc Dali::Accessibility::Component::GrabHighlight()
 181    */
 182   bool GrabHighlight() override;
 183
 184   /**
 185    * @copydoc Dali::Accessibility::Component::ClearHighlight()
 186    */
 187   bool ClearHighlight() override;
 188
 189   /**
 190    * @copydoc Dali::Accessibility::Action::GetActionName()
 191    */
 192   std::string GetActionName(size_t index) const override;
 193
 194   /**
 195    * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
 196    */
 197   std::string GetLocalizedActionName(size_t index) const override;
 198
 199   /**
 200    * @copydoc Dali::Accessibility::Action::GetActionDescription()
 201    */
 202   std::string GetActionDescription(size_t index) const override;
 203
 204   /**
 205    * @copydoc Dali::Accessibility::Action::GetActionCount()
 206    */
 207   size_t GetActionCount() const override;
 208
 209   /**
 210    * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
 211    */
 212   std::string GetActionKeyBinding(size_t index) const override;
 213
 214   /**
 215    * @copydoc Dali::Accessibility::Action::DoAction(std::size_t)
 216    */
 217   bool DoAction(size_t index) override;
 218
 219   /**
 220    * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
 221    */
 222   bool DoAction(const std::string& name) override;
 223
 224   /**
 225    * @copydoc Dali::Accessibility::Accessible::DoGesture()
 226    */
 227   bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
 228
 229   /**
 230    * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
 231    */
 232   std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
 233
 234   /**
 235    * @copydoc Dali::Accessibility::Accessible::GetInternalActor()
 236    */
 237   Dali::Actor GetInternalActor() override;
 238
 239   /**
 240    * @copydoc Dali::Accessibility::Accessible::GetStates()
 241    */
 242   virtual Dali::Accessibility::States CalculateStates();
 243
 244   /**
 245    * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
 246    * @return false if scrolling is not supported or child is already visible
 247    */
 248   virtual bool ScrollToChild(Actor child);
 249
 250   /**
 251    * @brief Returns the index of the property that represents this actor's name
 252    */
 253   virtual Dali::Property::Index GetNamePropertyIndex();
 254
 255   /**
 256    * @brief Returns the index of the property that represents this actor's description
 257    */
 258   virtual Dali::Property::Index GetDescriptionPropertyIndex();
 259
 260   /**
 261    * @brief Sets last object position
 262    * @param[in] position Last object position
 263    */
 264   void SetLastPosition(Vector2 position);
 265
 266   /**
 267    * @brief Gets last object position
 268    * @return The Last object position
 269    */
 270   Vector2 GetLastPosition() const;
 271 };
 272
 273 } // namespace Dali::Toolkit::DevelControl
 274
 275 #endif // DALI_TOOLKIT_CONTROL_ACCESSIBLE_H