dali/devel-api/atspi-interfaces/accessible.h

   1 #ifndef DALI_ADAPTOR_ATSPI_ACCESSIBLE_H
   2 #define DALI_ADAPTOR_ATSPI_ACCESSIBLE_H
   3
   4 /*
   5  * Copyright (c) 2023 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 // EXTERNAL INCLUDES
  21 #include <dali/public-api/actors/actor.h>
  22 #include <dali/public-api/math/rect.h>
  23 #include <dali/public-api/object/object-registry.h>
  24 #include <cstdint>
  25 #include <string>
  26 #include <vector>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
  30 #include <dali/devel-api/adaptor-framework/accessibility.h>
  31
  32 namespace Dali::Accessibility
  33 {
  34 /**
  35  * @brief Basic interface implemented by all accessibility objects.
  36  */
  37 class DALI_ADAPTOR_API Accessible
  38 {
  39 public:
  40   virtual ~Accessible() noexcept;
  41
  42   /**
  43    * @brief Helper function for emiting active-descendant-changed event.
  44    *
  45    * @param[in] child The child of the object
  46    */
  47   void EmitActiveDescendantChanged(Accessible* child);
  48
  49   /**
  50    * @brief Helper function for emiting state-changed event.
  51    *
  52    * @param[in] state The accessibility state (SHOWING, HIGHLIGHTED, etc)
  53    * @param[in] newValue Whether the state value is changed to new value or not.
  54    * @param[in] reserved Reserved. (TODO : Currently, this argument is not implemented in dali)
  55    *
  56    * @note The second argument determines which value is depending on State.
  57    * For instance, if the state is PRESSED, newValue means isPressed or isSelected.
  58    * If the state is SHOWING, newValue means isShowing.
  59    */
  60   void EmitStateChanged(State state, int newValue, int reserved = 0);
  61
  62   /**
  63    * @brief Helper function for emiting bounds-changed event.
  64    *
  65    * @param rect The rectangle for changed bounds
  66    */
  67   void EmitBoundsChanged(Rect<> rect);
  68
  69   /**
  70    * @brief Emits "showing" event.
  71    * The method informs accessibility clients about "showing" state.
  72    *
  73    * @param[in] isShowing The flag pointing if object is showing
  74    */
  75   void EmitShowing(bool isShowing);
  76
  77   /**
  78    * @brief Emits "visible" event.
  79    * The method informs accessibility clients about "visible" state.
  80    *
  81    * @param[in] isVisible The flag pointing if object is visible
  82    */
  83   void EmitVisible(bool isVisible);
  84
  85   /**
  86    * @brief Emits "highlighted" event.
  87    * The method informs accessibility clients about "highlighted" state.
  88    *
  89    * @param[in] isHighlighted The flag pointing if object is highlighted
  90    */
  91   void EmitHighlighted(bool isHighlighted);
  92
  93   /**
  94    * @brief Emits "focused" event.
  95    * The method informs accessibility clients about "focused" state.
  96    *
  97    * @param[in] isFocused The flag pointing if object is focused
  98    */
  99   void EmitFocused(bool isFocused);
 100
 101   /**
 102    * @brief Emits "text inserted" event.
 103    *
 104    * @param[in] position The cursor position
 105    * @param[in] length The text length
 106    * @param[in] content The inserted text
 107    */
 108   void EmitTextInserted(unsigned int position, unsigned int length, const std::string& content);
 109
 110   /**
 111    * @brief Emits "text deleted" event.
 112    *
 113    * @param[in] position The cursor position
 114    * @param[in] length The text length
 115    * @param[in] content The deleted text
 116    */
 117   void EmitTextDeleted(unsigned int position, unsigned int length, const std::string& content);
 118
 119   /**
 120    * @brief Emits "cursor moved" event.
 121    *
 122    * @param[in] cursorPosition The new cursor position
 123    */
 124   void EmitTextCursorMoved(unsigned int cursorPosition);
 125
 126   /**
 127    * @brief Emits "MoveOuted" event.
 128    *
 129    * @param[in] type moved out of screen type
 130    */
 131   void EmitMovedOutOfScreen(ScreenRelativeMoveType type);
 132
 133   /**
 134    * @brief Emits "org.a11y.atspi.Socket.Available" signal.
 135    */
 136   // This belongs to Dali::Accessibility::Socket. However, all Emit*() helpers
 137   // are here in Accessible, regardless of what interface they belong to (perhaps
 138   // to spare a dynamic_cast if used like this: Accessible::Get()->Emit*(...)).
 139   void EmitSocketAvailable();
 140
 141   /**
 142    * @brief Emits "ScrollStarted" event.
 143    *
 144    */
 145   void EmitScrollStarted();
 146
 147   /**
 148    * @brief Emits "ScrollFinished" event.
 149    *
 150    */
 151   void EmitScrollFinished();
 152
 153   /**
 154    * @brief Emits "highlighted" event.
 155    *
 156    * @param[in] event The enumerated window event
 157    * @param[in] detail The additional parameter which interpretation depends on chosen event
 158    */
 159   void Emit(WindowEvent event, unsigned int detail = 0);
 160
 161   /**
 162    * @brief Emits property-changed event.
 163    *
 164    * @param[in] event Property changed event
 165    **/
 166   void Emit(ObjectPropertyChangeEvent event);
 167
 168   /**
 169    * @brief Gets accessibility name.
 170    *
 171    * @return The string with name
 172    */
 173   virtual std::string GetName() const = 0;
 174
 175   /**
 176    * @brief Gets accessibility description.
 177    *
 178    * @return The string with description
 179    */
 180   virtual std::string GetDescription() const = 0;
 181
 182   /**
 183    * @brief Gets parent.
 184    *
 185    * @return The handler to accessibility object
 186    */
 187   virtual Accessible* GetParent() = 0;
 188
 189   /**
 190    * @brief Gets the number of children.
 191    *
 192    * @return The number of children
 193    */
 194   virtual std::size_t GetChildCount() const = 0;
 195
 196   /**
 197    * @brief Gets collection with all children.
 198    *
 199    * @return The collection of accessibility objects
 200    */
 201   virtual std::vector<Accessible*> GetChildren() = 0;
 202
 203   /**
 204    * @brief Gets child of the index.
 205    *
 206    * @return The child object
 207    */
 208   virtual Accessible* GetChildAtIndex(std::size_t index) = 0;
 209
 210   /**
 211    * @brief Gets index that current object has in its parent's children collection.
 212    *
 213    * @return The index of the current object
 214    */
 215   virtual std::size_t GetIndexInParent() = 0;
 216
 217   /**
 218    * @brief Gets accessibility role.
 219    *
 220    * @return Role enumeration
 221    *
 222    * @see Dali::Accessibility::Role
 223    */
 224   virtual Role GetRole() const = 0;
 225
 226   /**
 227    * @brief Gets name of accessibility role.
 228    *
 229    * @return The string with human readable role converted from enumeration
 230    *
 231    * @see Dali::Accessibility::Role
 232    * @see Accessibility::Accessible::GetRole
 233    */
 234   virtual std::string GetRoleName() const;
 235
 236   /**
 237    * @brief Gets localized name of accessibility role.
 238    *
 239    * @return The string with human readable role translated according to current
 240    * translation domain
 241    *
 242    * @see Dali::Accessibility::Role
 243    * @see Accessibility::Accessible::GetRole
 244    * @see Accessibility::Accessible::GetRoleName
 245    *
 246    * @note translation is not supported in this version
 247    */
 248   virtual std::string GetLocalizedRoleName() const;
 249
 250   /**
 251    * @brief Gets accessibility states.
 252    *
 253    * @return The collection of states
 254    *
 255    * @note States class is instatation of ArrayBitset template class
 256    *
 257    * @see Dali::Accessibility::State
 258    * @see Dali::Accessibility::ArrayBitset
 259    */
 260   virtual States GetStates() = 0;
 261
 262   /**
 263    * @brief Gets accessibility attributes.
 264    *
 265    * @return The map of attributes and their values
 266    */
 267   virtual Attributes GetAttributes() const = 0;
 268
 269   /**
 270    * @brief Checks if this is hidden.
 271    *
 272    * @return True if this is hidden
 273    *
 274    * @note Hidden means not present in the AT-SPI tree.
 275    */
 276   virtual bool IsHidden() const;
 277
 278   /**
 279    * @brief Checks if this is proxy.
 280    *
 281    * @return True if this is proxy
 282    */
 283   virtual bool IsProxy() const;
 284
 285   /**
 286    * @brief Checks if this is highlighted
 287    *
 288    * @return True if highlighted, false otherwise
 289    */
 290   bool IsHighlighted() const;
 291
 292   /**
 293    * @brief Gets unique address on accessibility bus.
 294    *
 295    * @return The Address class containing address
 296    *
 297    * @see Dali::Accessibility::Address
 298    */
 299   virtual Address GetAddress() const;
 300
 301   /**
 302    * @brief Deputes an object to perform provided gesture.
 303    *
 304    * @param[in] gestureInfo The structure describing the gesture
 305    *
 306    * @return true on success, false otherwise
 307    *
 308    * @see Dali::Accessibility::GestureInfo
 309    */
 310   virtual bool DoGesture(const GestureInfo& gestureInfo) = 0;
 311
 312   /**
 313    * @brief Re-emits selected states of an Accessibility Object.
 314    *
 315    * @param[in] states The chosen states to re-emit
 316    * @param[in] isRecursive If true, all children of the Accessibility object will also re-emit the states
 317    */
 318   void NotifyAccessibilityStateChange(Dali::Accessibility::States states, bool isRecursive);
 319
 320   /**
 321    * @brief Gets information about current object and all relations that connects
 322    * it with other accessibility objects.
 323    *
 324    * @return The iterable collection of Relation objects
 325    *
 326    * @see Dali::Accessibility::Relation
 327    */
 328   virtual std::vector<Relation> GetRelationSet() = 0;
 329
 330   /**
 331    * @brief Gets the Actor associated with this Accessible (if there is one).
 332    *
 333    * @return The internal Actor
 334    */
 335   virtual Dali::Actor GetInternalActor() const = 0;
 336
 337   /**
 338    * @brief Sets whether to listen for post render callback.
 339    *
 340    * @param[in] enabled If ture, registration post render callback, false otherwise
 341    */
 342   virtual void SetListenPostRender(bool enabled);
 343
 344   /**
 345    * @brief Gets all implemented interfaces.
 346    *
 347    * Override DoGetInterfaces() to customize the return value of this method.
 348    *
 349    * @return The collection of implemented interfaces
 350    *
 351    * @see DoGetInterfaces()
 352    */
 353   AtspiInterfaces GetInterfaces() const;
 354
 355   /**
 356    * @brief Gets all implemented interfaces.
 357    *
 358    * Converts all interfaces returned by GetInterfaces() to their DBus names
 359    * using GetInterfaceName().
 360    *
 361    * @return The collection of names of implemented interfaces
 362    *
 363    * @see GetInterfaces()
 364    * @see GetInterfaceName()
 365    */
 366   std::vector<std::string> GetInterfacesAsStrings() const;
 367
 368   /**
 369    * @brief Checks if object is on root level.
 370    *
 371    * @return Whether object is on root level or not
 372    */
 373   bool IsOnRootLevel() const
 374   {
 375     return mIsOnRootLevel;
 376   }
 377
 378   /**
 379    * @brief Gets all suppressed events.
 380    *
 381    * @return All suppressed events
 382    */
 383   AtspiEvents GetSuppressedEvents() const
 384   {
 385     return mSuppressedEvents;
 386   }
 387
 388   /**
 389    * @brief Gets all suppressed events.
 390    *
 391    * @return All suppressed events
 392    */
 393   AtspiEvents& GetSuppressedEvents()
 394   {
 395     return mSuppressedEvents;
 396   }
 397
 398 protected:
 399   Accessible();
 400   Accessible(const Accessible&)         = delete;
 401   Accessible(Accessible&&)              = delete;
 402   Accessible&                   operator=(const Accessible&) = delete;
 403   Accessible&                   operator=(Accessible&&) = delete;
 404   std::shared_ptr<Bridge::Data> GetBridgeData() const;
 405
 406   /**
 407    * @brief Returns the collection of AT-SPI interfaces implemented by this Accessible.
 408    *
 409    * This method is called only once and its return value is cached. The default implementation
 410    * uses dynamic_cast to determine which interfaces are implemented. Override this if you
 411    * conceptually provide fewer interfaces than dynamic_cast can see.
 412    *
 413    * @return The collection of implemented interfaces
 414    *
 415    * @see GetInterfaces()
 416    * @see GetInterfaceName()
 417    */
 418   virtual AtspiInterfaces DoGetInterfaces() const;
 419
 420 public:
 421   /**
 422    * @brief Gets the highlight actor.
 423    *
 424    * This method is to get the highlight itself.
 425    * @return The highlight actor
 426    */
 427   static Dali::Actor GetHighlightActor();
 428
 429   /**
 430    * @brief Sets the highlight actor.
 431    *
 432    * This method is to set the highlight itself.
 433    * @param[in] actor The highlight actor
 434    */
 435   static void SetHighlightActor(Dali::Actor actor);
 436
 437   /**
 438    * @brief Gets the currently highlighted actor.
 439    *
 440    * @return The current highlighted actor
 441    */
 442   static Dali::Actor GetCurrentlyHighlightedActor();
 443
 444   /**
 445    * @brief Sets currently highlighted actor.
 446    *
 447    * @param[in] actor The highlight actor
 448    */
 449   static void SetCurrentlyHighlightedActor(Dali::Actor actor);
 450
 451   /**
 452    * @brief Sets ObjectRegistry.
 453    *
 454    * @param[in] registry ObjectRegistry instance
 455    */
 456   static void SetObjectRegistry(ObjectRegistry registry);
 457
 458   /**
 459    * @brief The method registers functor resposible for converting Actor into Accessible.
 460    * @param functor The returning Accessible handle from Actor object
 461    */
 462   static void RegisterExternalAccessibleGetter(std::function<Accessible*(Dali::Actor)> functor);
 463
 464   /**
 465    * @brief Acquires Accessible object from Actor object.
 466    *
 467    * @param[in] actor Actor object
 468    *
 469    * @return The handle to Accessible object
 470    */
 471   static Accessible* Get(Dali::Actor actor);
 472
 473   /**
 474    * @brief Obtains the DBus interface name for the specified AT-SPI interface.
 475    *
 476    * @param interface AT-SPI interface identifier (e.g. AtspiInterface::ACCESSIBLE)
 477    * @return AT-SPI interface name (e.g. "org.a11y.atspi.Accessible")
 478    */
 479   static std::string GetInterfaceName(AtspiInterface interface);
 480
 481   /**
 482    * @brief Downcasts an Accessible pointer to an AT-SPI interface pointer.
 483    *
 484    * @tparam I Desired AT-SPI interface
 485    *
 486    * @param obj Object to cast.
 487    *
 488    * @return Pointer to an AT-SPI interface or null if the interface is not implemented.
 489    */
 490   template<AtspiInterface I>
 491   static AtspiInterfaceType<I>* DownCast(Accessible* obj)
 492   {
 493     if(!obj || !obj->GetInterfaces()[I])
 494     {
 495       return nullptr;
 496     }
 497
 498     return dynamic_cast<AtspiInterfaceType<I>*>(obj);
 499   }
 500
 501 private:
 502   friend class Bridge;
 503
 504   mutable std::weak_ptr<Bridge::Data> mBridgeData;
 505   mutable AtspiInterfaces             mInterfaces;
 506   AtspiEvents                         mSuppressedEvents;
 507   bool                                mIsOnRootLevel = false;
 508
 509 }; // Accessible class
 510
 511 namespace Internal
 512 {
 513 template<>
 514 struct AtspiInterfaceTypeHelper<AtspiInterface::ACCESSIBLE>
 515 {
 516   using Type = Accessible;
 517 };
 518 } // namespace Internal
 519
 520 } // namespace Dali::Accessibility
 521
 522 #endif // DALI_ADAPTOR_ATSPI_ACCESSIBLE_H