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