dali/devel-api/adaptor-framework/accessibility-impl.h

   1 #ifndef DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_H
   2 #define DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_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/public-api/actors/actor.h>
  23 #include <dali/public-api/math/rect.h>
  24 #include <dali/public-api/object/object-registry.h>
  25 #include <atomic>
  26 #include <bitset>
  27 #include <exception>
  28 #include <functional>
  29 #include <memory>
  30 #include <stdexcept>
  31 #include <string>
  32 #include <unordered_map>
  33 #include <unordered_set>
  34 #include <vector>
  35
  36 //INTERNAL INCLUDES
  37 #include <dali/devel-api/adaptor-framework/accessibility.h>
  38 #include <dali/integration-api/debug.h>
  39
  40 namespace Dali
  41 {
  42 namespace Accessibility
  43 {
  44 class DALI_ADAPTOR_API Accessible;
  45 class DALI_ADAPTOR_API Text;
  46 class DALI_ADAPTOR_API Value;
  47 class DALI_ADAPTOR_API Component;
  48 class DALI_ADAPTOR_API Collection;
  49 class DALI_ADAPTOR_API Action;
  50
  51 /**
  52  * @brief Base class for different accessibility bridges
  53  *
  54  * Bridge is resposible for initializing and managing connection on accessibility bus.
  55  * Accessibility clients will not get any information about UI without initialized and upraised bridge.
  56  * Concrete implementation depends on the accessibility technology available on the platform.
  57  *
  58  * @note This class is singleton.
  59  */
  60 struct DALI_ADAPTOR_API Bridge
  61 {
  62   enum class ForceUpResult
  63   {
  64     JUST_STARTED,
  65     ALREADY_UP
  66   };
  67
  68   /**
  69    * @brief Destructor
  70    */
  71   virtual ~Bridge() = default;
  72
  73   /**
  74    * @brief Get bus name which bridge is initialized on
  75    */
  76   virtual const std::string& GetBusName() const = 0;
  77
  78   /**
  79    * @brief Registers top level window
  80    *
  81    * Hierarchy of objects visible for accessibility clients is based on tree-like
  82    * structure created from Actors objects. This method allows to connect chosen
  83    * object as direct ancestor of application and therefore make it visible for
  84    * accessibility clients.
  85    */
  86   virtual void AddTopLevelWindow(Accessible*) = 0;
  87
  88   /**
  89    * @brief Removes top level window
  90    *
  91    * Hierarchy of objects visible for accessibility clients is based on tree-like
  92    * structure created from Actors objects. This method removes previously added
  93    * window from visible accessibility objects.
  94    */
  95   virtual void RemoveTopLevelWindow(Accessible*) = 0;
  96
  97   /**
  98    * @brief Adds popup window
  99    *
 100    * Hierarchy of objects visible for accessibility clients is based on tree-like
 101    * structure created from Actors objects. This method adds new popup to the tree.
 102    */
 103   virtual void AddPopup(Accessible*) = 0;
 104
 105   /**
 106    * @brief Removes popup window
 107    *
 108    * Hierarchy of objects visible for accessibility clients is based on tree-like
 109    * structure created from Actors objects. This method removes previously added
 110    * popup window.
 111    */
 112   virtual void RemovePopup(Accessible*) = 0;
 113
 114   /**
 115    * @brief Set name of current application which will be visible on accessibility bus
 116    */
 117   virtual void SetApplicationName(std::string) = 0;
 118
 119   /**
 120    * @brief Get object being root of accessibility tree
 121    *
 122    * @return handler to accessibility object
 123    */
 124   virtual Accessible* GetApplication() const = 0;
 125
 126   /**
 127    * @brief Find an object in accessibility tree
 128    *
 129    * @param[in] s path to object
 130    *
 131    * @return handler to accessibility object
 132    */
 133   virtual Accessible* FindByPath(const std::string& s) const = 0;
 134
 135   /**
 136    * @brief Show application on accessibility bus
 137    */
 138   virtual void ApplicationShown() = 0;
 139
 140   /**
 141    * @brief Hide application on accessibility bus
 142    */
 143   virtual void ApplicationHidden() = 0;
 144
 145   /**
 146    * @brief Initialize accessibility bus
 147    */
 148   virtual void Initialize() = 0;
 149
 150   /**
 151    * @brief Terminate accessibility bus
 152    */
 153   virtual void Terminate() = 0;
 154
 155   /**
 156    * @brief This method is called, when bridge is being activated.
 157    */
 158   virtual ForceUpResult ForceUp()
 159   {
 160     if(data)
 161     {
 162       return ForceUpResult::ALREADY_UP;
 163     }
 164     data         = std::make_shared<Data>();
 165     data->bridge = this;
 166     return ForceUpResult::JUST_STARTED;
 167   }
 168
 169   /**
 170    * @brief This method is called, when bridge is being deactivated.
 171    */
 172   virtual void ForceDown() = 0;
 173
 174   /**
 175    * @brief Check if bridge is activated or not.
 176    * @return True if brige is activated.
 177    */
 178   bool IsUp() const
 179   {
 180     return bool(data);
 181   }
 182
 183   /**
 184    * @brief Emits caret-moved event on at-spi bus.
 185    **/
 186   virtual void EmitCaretMoved(Accessible* obj, unsigned int cursorPosition) = 0;
 187
 188   /**
 189    * @brief Emits active-descendant-changed event on at-spi bus.
 190    **/
 191   virtual void EmitActiveDescendantChanged(Accessible* obj, Accessible* child) = 0;
 192
 193   /**
 194    * @brief Emits text-changed event on at-spi bus.
 195    **/
 196   virtual void EmitTextChanged(Accessible* obj, TextChangedState state, unsigned int position, unsigned int length, const std::string& content) = 0;
 197
 198   /**
 199    * @brief Emits state-changed event on at-spi bus.
 200    **/
 201   virtual void EmitStateChanged(Accessible* obj, State state, int val1, int val2 = 0) = 0;
 202
 203   /**
 204    * @brief Emits window event on at-spi bus.
 205    **/
 206   virtual void Emit(Accessible* obj, WindowEvent we, unsigned int detail1 = 0) = 0;
 207
 208   /**
 209    * @brief Emits property-changed event on at-spi bus.
 210    **/
 211   virtual void Emit(Accessible* obj, ObjectPropertyChangeEvent event) = 0;
 212
 213   /**
 214    * @brief Emits bounds-changed event on at-spi bus.
 215    **/
 216   virtual void EmitBoundsChanged(Accessible* obj, Rect<> rect) = 0;
 217
 218   /**
 219    * @brief Emits key event on at-spi bus.
 220    *
 221    * Screen-reader might receive this event and reply, that given keycode is consumed. In that case
 222    * further processing of the keycode should be ignored.
 223    **/
 224   virtual Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) = 0;
 225
 226   /**
 227    * @brief Reads given text by screen reader
 228    *
 229    * @param text The text to read
 230    * @param discardable If TRUE, reading can be discarded by subsequent reading requests,
 231    * if FALSE the reading must finish before next reading request can be started
 232    * @param callback the callback function that is called on reading signals emitted
 233    * during processing of this reading request.
 234    * Callback can be one of the following signals:
 235    * ReadingCancelled, ReadingStopped, ReadingSkipped
 236    */
 237   virtual void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) = 0;
 238
 239   /**
 240    * @brief Force accessibility client to pause.
 241    */
 242   virtual void Pause() = 0;
 243
 244   /**
 245    * @brief Force accessibility client to resume.
 246    */
 247   virtual void Resume() = 0;
 248
 249   /**
 250    * @brief Get screen reader status.
 251    */
 252   virtual bool GetScreenReaderEnabled() = 0;
 253
 254   /**
 255    * @brief Get ATSPI status.
 256    */
 257   virtual bool GetIsEnabled() = 0;
 258
 259   /**
 260    * @brief Returns instance of bridge singleton object.
 261    **/
 262   static Bridge* GetCurrentBridge();
 263
 264 protected:
 265   struct Data
 266   {
 267     std::unordered_set<Accessible*> knownObjects;
 268     std::string                     busName;
 269     Bridge*                         bridge = nullptr;
 270     Actor                           highlightActor, currentlyHighlightedActor;
 271   };
 272   std::shared_ptr<Data> data;
 273   friend class Accessible;
 274
 275   /**
 276    * @brief Registers accessible object to be known in bridge object
 277    *
 278    * Bridge must known about all currently alive accessible objects, as some requst
 279    * might come and object will be identified by number id (it's memory address).
 280    * To avoid memory corruption number id is checked against set of known objects.
 281    **/
 282   void RegisterOnBridge(Accessible*);
 283
 284   /**
 285    * @brief Tells bridge, that given object is considered root (doesn't have any parents).
 286    *
 287    * All root objects will have the same parent - application object. Application object
 288    * is controlled by bridge and private.
 289    **/
 290   void SetIsOnRootLevel(Accessible*);
 291 };
 292
 293 /**
 294  * @brief Check if ATSPI is activated or not.
 295  * @return True if ATSPI is activated.
 296  */
 297 inline bool IsUp()
 298 {
 299   if(Bridge::GetCurrentBridge() == nullptr)
 300   {
 301     return false;
 302   }
 303   if(Bridge::GetCurrentBridge()->GetIsEnabled() == false)
 304   {
 305     return false;
 306   }
 307   return Bridge::GetCurrentBridge()->IsUp();
 308 }
 309
 310 /**
 311  * @brief Basic interface implemented by all accessibility objects
 312  */
 313 class Accessible
 314 {
 315 public:
 316   virtual ~Accessible();
 317
 318   using utf8_t = unsigned char;
 319
 320   /**
 321    * @brief Calculaties word boundaries in given utf8 text.
 322    *
 323    * s and length represents source text pointer and it's length respectively. langauge represents
 324    * language to use. Word boundaries are returned as non-zero values in table breaks, which
 325    * must be of size at least length.
 326    **/
 327   void FindWordSeparationsUtf8(const utf8_t* s, size_t length, const char* language, char* breaks);
 328
 329   /**
 330    * @brief Calculaties line boundaries in given utf8 text.
 331    *
 332    * s and length represents source text pointer and it's length respectively. langauge represents
 333    * language to use. Line boundaries are returned as non-zero values in table breaks, which
 334    * must be of size at least length.
 335    **/
 336   void FindLineSeparationsUtf8(const utf8_t* s, size_t length, const char* language, char* breaks);
 337
 338   /**
 339    * @brief Helper function for emiting active-descendant-changed event
 340    **/
 341   void EmitActiveDescendantChanged(Accessible* obj, Accessible* child);
 342
 343   /**
 344    * @brief Helper function for emiting state-changed event
 345    **/
 346   void EmitStateChanged(State state, int newValue1, int newValue2 = 0);
 347
 348   /**
 349    * @brief Helper function for emiting bounds-changed event
 350    **/
 351   void EmitBoundsChanged(Rect<> rect);
 352
 353   /**
 354    * @brief Emit "showing" event.
 355    * The method inform accessibility clients about "showing" state
 356    *
 357    * @param[in] showing flag pointing if object is showing
 358    */
 359   void EmitShowing(bool showing);
 360
 361   /**
 362    * @brief Emit "visible" event.
 363    * The method inform accessibility clients about "visible" state
 364    *
 365    * @param[in] visible flag pointing if object is visible
 366    */
 367   void EmitVisible(bool visible);
 368
 369   /**
 370    * @brief Emit "highlighted" event.
 371    * The method inform accessibility clients about "highlighted" state
 372    *
 373    * @param[in] set flag pointing if object is highlighted
 374    */
 375   void EmitHighlighted(bool set);
 376
 377   /**
 378    * @brief Emit "focused" event.
 379    * The method inform accessibility clients about "focused" state
 380    *
 381    * @param[in] set flag pointing if object is focused
 382    */
 383   void EmitFocused(bool set);
 384
 385   /**
 386    * @brief Emit "text inserted" event
 387    *
 388    * @param[in] position caret position
 389    * @param[in] length text length
 390    * @param[in] content inserted text
 391    */
 392   void EmitTextInserted(unsigned int position, unsigned int length, const std::string& content);
 393
 394   /**
 395    * @brief Emit "text deleted" event
 396    *
 397    * @param[in] position caret position
 398    * @param[in] length text length
 399    * @param[in] content deleted text
 400    */
 401   void EmitTextDeleted(unsigned int position, unsigned int length, const std::string& content);
 402
 403   /**
 404    * @brief Emit "caret moved" event
 405    *
 406    * @param[in] cursorPosition new caret position
 407    */
 408   void EmitTextCaretMoved(unsigned int cursorPosition);
 409
 410   /**
 411    * @brief Emit "highlighted" event
 412    *
 413    * @param[in] we enumerated window event
 414    * @param[in] detail1 additional parameter which interpretation depends on chosen event
 415    */
 416   void Emit(WindowEvent we, unsigned int detail1 = 0);
 417
 418   /**
 419    * @brief Emits property-changed event
 420    * @param[in] event Property changed event
 421    **/
 422   void Emit(ObjectPropertyChangeEvent event);
 423
 424   /**
 425    * @brief Get accessibility name
 426    *
 427    * @return string with name
 428    */
 429   virtual std::string GetName() = 0;
 430
 431   /**
 432    * @brief Get accessibility description
 433    *
 434    * @return string with description
 435    */
 436   virtual std::string GetDescription() = 0;
 437
 438   /**
 439    * @brief Get parent
 440    *
 441    * @return handler to accessibility object
 442    */
 443   virtual Accessible* GetParent() = 0;
 444
 445   /**
 446    * @brief Get count of children
 447    *
 448    * @return unsigned integer value
 449    */
 450   virtual size_t GetChildCount() = 0;
 451
 452   /**
 453    * @brief Get collection with all children
 454    *
 455    * @return collection of accessibility objects
 456    */
 457   virtual std::vector<Accessible*> GetChildren();
 458
 459   /**
 460    * @brief Get nth child
 461    *
 462    * @return accessibility object
 463    */
 464   virtual Accessible* GetChildAtIndex(size_t index) = 0;
 465
 466   /**
 467    * @brief Get index that current object has in its parent's children collection
 468    *
 469    * @return unsigned integer index
 470    */
 471   virtual size_t GetIndexInParent() = 0;
 472
 473   /**
 474    * @brief Get accessibility role
 475    *
 476    * @return Role enumeration
 477    *
 478    * @see Dali::Accessibility::Role
 479    */
 480   virtual Role GetRole() = 0;
 481
 482   /**
 483    * @brief Get name of accessibility role
 484    *
 485    * @return string with human readable role converted from enumeration
 486    *
 487    * @see Dali::Accessibility::Role
 488    * @see Accessibility::Accessible::GetRole
 489    */
 490   virtual std::string GetRoleName();
 491
 492   /**
 493    * @brief Get localized name of accessibility role
 494    *
 495    * @return string with human readable role translated according to current
 496    * translation domain
 497    *
 498    * @see Dali::Accessibility::Role
 499    * @see Accessibility::Accessible::GetRole
 500    * @see Accessibility::Accessible::GetRoleName
 501    *
 502    * @note translation is not supported in this version
 503    */
 504   virtual std::string GetLocalizedRoleName();
 505
 506   /**
 507    * @brief Get accessibility states
 508    *
 509    * @return collection of states
 510    *
 511    * @note States class is instatation of ArrayBitset template class
 512    *
 513    * @see Dali::Accessibility::State
 514    * @see Dali::Accessibility::ArrayBitset
 515    */
 516   virtual States GetStates() = 0;
 517
 518   /**
 519    * @brief Get accessibility attributes
 520    *
 521    * @return map of attributes and their values
 522    */
 523   virtual Attributes GetAttributes() = 0;
 524
 525   /**
 526    * @brief Check if this is proxy
 527    *
 528    * @return True if this is proxy
 529    */
 530   virtual bool IsProxy();
 531
 532   /**
 533    * @brief Get unique address on accessibility bus
 534    *
 535    * @return class containing address
 536    *
 537    * @see Dali::Accessibility::Address
 538    */
 539   virtual Address GetAddress();
 540
 541   /**
 542    * @brief Get accessibility object, which is "default label" for this object
 543    */
 544   virtual Accessible* GetDefaultLabel();
 545
 546   /**
 547    * @brief Depute an object to perform provided gesture
 548    *
 549    * @param[in] gestureInfo structure describing the gesture
 550    *
 551    * @return true on success, false otherwise
 552    *
 553    * @see Dali::Accessibility::GestureInfo
 554    */
 555   virtual bool DoGesture(const GestureInfo& gestureInfo) = 0;
 556
 557   /**
 558    * @brief Re-emits selected states of an Accessibility Object
 559    *
 560    * @param[in] states chosen states to re-emit
 561    * @param[in] doRecursive if true all children of the Accessibility Object will also re-emit the states
 562    */
 563   void NotifyAccessibilityStateChange(Dali::Accessibility::States states, bool doRecursive);
 564
 565   /**
 566    * @brief Get information about current object and all relations that connects
 567    * it with other accessibility objects
 568    *
 569    * @return iterable collection of Relation objects
 570    *
 571    * @see Dali::Accessibility::Relation
 572    */
 573   virtual std::vector<Relation> GetRelationSet() = 0;
 574
 575   /**
 576    * @brief Get all implemented interfaces
 577    *
 578    * @return collection of strings with implemented interfaces
 579    */
 580   std::vector<std::string> GetInterfaces();
 581
 582   /**
 583    * @brief Check if object is on root level
 584    */
 585   bool GetIsOnRootLevel() const
 586   {
 587     return isOnRootLevel;
 588   }
 589
 590   /**
 591    * @brief The method registers functor resposible for converting Actor into Accessible
 592    * @param functor returning Accessible handle from Actor object
 593    */
 594   static void RegisterControlAccessibilityGetter(std::function<Accessible*(Dali::Actor)> functor);
 595
 596   /**
 597    * @brief Acquire Accessible object from Actor object
 598    *
 599    * @param[in] actor Actor object
 600    * @param[in] root true, if it's top level object (window)
 601    *
 602    * @return handle to Accessible object
 603    */
 604   static Accessible* Get(Dali::Actor actor, bool root = false);
 605
 606 protected:
 607   Accessible();
 608   Accessible(const Accessible&)         = delete;
 609   Accessible(Accessible&&)              = delete;
 610   Accessible&                   operator=(const Accessible&) = delete;
 611   Accessible&                   operator=(Accessible&&) = delete;
 612   std::shared_ptr<Bridge::Data> GetBridgeData();
 613
 614 public:
 615   static Dali::Actor GetHighlightActor();
 616   static void        SetHighlightActor(Dali::Actor actor);
 617   static Dali::Actor GetCurrentlyHighlightedActor();
 618   static void        SetCurrentlyHighlightedActor(Dali::Actor);
 619   static void        SetObjectRegistry(ObjectRegistry registry);
 620
 621 private:
 622   friend class Bridge;
 623
 624   std::weak_ptr<Bridge::Data> bridgeData;
 625   bool                        isOnRootLevel = false;
 626 };
 627
 628 /**
 629  * @brief Interface enabling to perform provided actions
 630  */
 631 class Action : public virtual Accessible
 632 {
 633 public:
 634   /**
 635    * @brief Get name of action with given index
 636    *
 637    * @param[in] index index of action
 638    *
 639    * @return string with name of action
 640    */
 641   virtual std::string GetActionName(size_t index) = 0;
 642
 643   /**
 644    * @brief Get translated name of action with given index
 645    *
 646    * @param[in] index index of action
 647    *
 648    * @return string with name of action translated according to current translation domain
 649    *
 650    * @note translation is not supported in this version
 651    */
 652   virtual std::string GetLocalizedActionName(size_t index) = 0;
 653
 654   /**
 655    * @brief Get description of action with given index
 656    *
 657    * @param[in] index index of action
 658    *
 659    * @return string with description of action
 660    */
 661   virtual std::string GetActionDescription(size_t index) = 0;
 662
 663   /**
 664    * @brief Get key code binded to action with given index
 665    *
 666    * @param[in] index index of action
 667    *
 668    * @return string with key name
 669    */
 670   virtual std::string GetActionKeyBinding(size_t index) = 0;
 671
 672   /**
 673    * @brief Get number of provided actions
 674    *
 675    * @return unsigned integer with number of actions
 676    */
 677   virtual size_t GetActionCount() = 0;
 678
 679   /**
 680    * @brief Perform an action with given index
 681    *
 682    * @param index index of action
 683    *
 684    * @return true on success, false otherwise
 685    */
 686   virtual bool DoAction(size_t index) = 0;
 687
 688   /**
 689    * @brief Perform an action with given name
 690    *
 691    * @param name name of action
 692    *
 693    * @return true on success, false otherwise
 694    */
 695   virtual bool DoAction(const std::string& name) = 0;
 696 };
 697
 698 /**
 699  * @brief Interface enabling advanced quering of accessibility objects
 700  *
 701  * @note since all mathods can be implemented inside bridge,
 702  * none methods have to be overrided
 703  */
 704 class Collection : public virtual Accessible
 705 {
 706 public:
 707 };
 708
 709 /**
 710  * @brief Interface representing objects having screen coordinates
 711  */
 712 class Component : public virtual Accessible
 713 {
 714 public:
 715   /**
 716    * @brief Get rectangle describing size
 717    *
 718    * @param[in] ctype enumeration with type of coordinate systems
 719    *
 720    * @return Rect<> object
 721    *
 722    * @see Dali::Rect
 723    */
 724   virtual Rect<> GetExtents(CoordType ctype) = 0;
 725
 726   /**
 727    * @brief Get layer current object is localized on
 728    *
 729    * @return enumeration pointing layer
 730    *
 731    * @see Dali::Accessibility::ComponentLayer
 732    */
 733   virtual ComponentLayer GetLayer() = 0;
 734
 735   /**
 736    * @brief Get value of z-order
 737    *
 738    * @return value of z-order
 739    */
 740   virtual int16_t GetMdiZOrder() = 0;
 741
 742   /**
 743    * @brief Set current object as "focused"
 744    *
 745    * @return true on success, false otherwise
 746    */
 747   virtual bool GrabFocus() = 0;
 748
 749   /**
 750    * @brief Get value of alpha channel
 751    *
 752    * @return alpha channel value in range [0.0, 1.0]
 753    */
 754   virtual double GetAlpha() = 0;
 755
 756   /**
 757    * @brief Set current object as "highlighted"
 758    *
 759    * The method assings "highlighted" state, simultaneously removing it
 760    * from currently highlighted object.
 761    *
 762    * @return true on success, false otherwise
 763    */
 764   virtual bool GrabHighlight() = 0;
 765
 766   /**
 767    * @brief Set current object as "unhighlighted"
 768    *
 769    * The method removes "highlighted" state from object.
 770    *
 771    * @return true on success, false otherwise
 772    *
 773    * @see Dali:Accessibility::State
 774    */
 775   virtual bool ClearHighlight() = 0;
 776
 777   /**
 778    * @brief Check whether object can be scrolled
 779    *
 780    * @return true if object is scrollable, false otherwise
 781    *
 782    * @see Dali:Accessibility::State
 783    */
 784   virtual bool IsScrollable();
 785
 786   /**
 787    * @brief Get Accessible object containing given point
 788    *
 789    * @param[in] p two-dimensional point
 790    * @param[in] ctype enumeration with type of coordinate system
 791    *
 792    * @return handle to last child of current object which contains given point
 793    *
 794    * @see Dali::Accessibility::Point
 795    */
 796   virtual Accessible* GetAccessibleAtPoint(Point p, CoordType ctype);
 797
 798   /**
 799    * @brief Check if current object contains given point
 800    *
 801    * @param[in] p two-dimensional point
 802    * @param[in] ctype enumeration with type of coordinate system
 803    *
 804    * @return handle to Accessible object
 805    *
 806    * @see Dali::Accessibility::Point
 807    */
 808   virtual bool Contains(Point p, CoordType ctype);
 809 };
 810
 811 /**
 812  * @brief Interface representing objects which can store numeric value
 813  */
 814 class Value : public virtual Accessible
 815 {
 816 public:
 817   /**
 818    * @brief Get the lowest possible value
 819    *
 820    * @return double value
 821   */
 822   virtual double GetMinimum() = 0;
 823
 824   /**
 825    * @brief Get current value
 826    *
 827    * @return double value
 828   */
 829   virtual double GetCurrent() = 0;
 830
 831   /**
 832    * @brief Get the highest possible value
 833    *
 834    * @return double value
 835   */
 836   virtual double GetMaximum() = 0;
 837
 838   /**
 839    * @brief Set value
 840    *
 841    * @param[in] val double value
 842    *
 843    * @return true if value could have been assigned, false otherwise
 844   */
 845   virtual bool SetCurrent(double val) = 0;
 846
 847   /**
 848    * @brief Get the lowest increment that can be distinguished
 849    *
 850    * @return double value
 851   */
 852   virtual double GetMinimumIncrement() = 0;
 853 };
 854
 855 /**
 856  * @brief Interface representing objects which can store immutable texts
 857  *
 858  * @see Dali::Accessibility::EditableText
 859  */
 860 class DALI_ADAPTOR_API Text : public virtual Accessible
 861 {
 862 public:
 863   /**
 864    * @brief Get stored text in given range
 865    *
 866    * @param[in] startOffset index of first character
 867    * @param[in] endOffset index of first character after the last one expected
 868    *
 869    * @return substring of stored text
 870    */
 871   virtual std::string GetText(size_t startOffset, size_t endOffset) = 0;
 872
 873   /**
 874    * @brief Get number of all stored characters
 875    *
 876    * @return number of characters
 877    */
 878   virtual size_t GetCharacterCount() = 0;
 879
 880   /**
 881    * @brief Get caret offset
 882    *
 883    * @return Value of caret offset
 884    */
 885   virtual size_t GetCaretOffset() = 0;
 886
 887   /**
 888    * @brief Set caret offset
 889    *
 890    * @param[in] offset Caret offset
 891    *
 892    * @return True if successful
 893    */
 894   virtual bool SetCaretOffset(size_t offset) = 0;
 895
 896   /**
 897    * @brief Get substring of stored text truncated in concrete gradation
 898    *
 899    * @param[in] offset position in stored text
 900    * @param[in] boundary enumeration describing text gradation
 901    *
 902    * @return Range structure containing acquired text and offsets in original string
 903    *
 904    * @see Dali::Accessibility::Range
 905    */
 906   virtual Range GetTextAtOffset(size_t offset, TextBoundary boundary) = 0;
 907
 908   /**
 909    * @brief Get selected text
 910    *
 911    * @param[in] selectionNum selection index
 912    * @note Currently only one selection (i.e. with index = 0) is supported
 913    *
 914    * @return Range structure containing acquired text and offsets in original string
 915    *
 916    * @see Dali::Accessibility::Range
 917    */
 918   virtual Range GetSelection(size_t selectionNum) = 0;
 919
 920   /**
 921    * @brief Remove selection
 922    *
 923    * @param[in] selectionNum selection index
 924    * @note Currently only one selection (i.e. with index = 0) is supported
 925    *
 926    * @return bool on success, false otherwise
 927    */
 928   virtual bool RemoveSelection(size_t selectionNum) = 0;
 929
 930   /**
 931    * @brief Get selected text
 932    *
 933    * @param[in] selectionNum selection index
 934    * @param[in] startOffset index of first character
 935    * @param[in] endOffset index of first character after the last one expected
 936    *
 937    * @note Currently only one selection (i.e. with index = 0) is supported
 938    *
 939    * @return true on success, false otherwise
 940    */
 941   virtual bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) = 0;
 942 };
 943
 944 /**
 945  * @brief Interface representing objects which can store editable texts
 946  *
 947  * @note Paste method is entirely implemented inside bridge
 948  *
 949  * @see Dali::Accessibility::EditableText
 950  */
 951 class DALI_ADAPTOR_API EditableText : public virtual Accessible
 952 {
 953 public:
 954   /**
 955    * @brief Copy text in range to system clipboard
 956    *
 957    * @param[in] startPosition index of first character
 958    * @param[in] endPosition index of first character after the last one expected
 959    *
 960    * @return true on success, false otherwise
 961    */
 962   virtual bool CopyText(size_t startPosition, size_t endPosition) = 0;
 963
 964   /**
 965    * @brief Cut text in range to system clipboard
 966    *
 967    * @param[in] startPosition index of first character
 968    * @param[in] endPosition index of first character after the last one expected
 969    *
 970    * @return true on success, false otherwise
 971    */
 972   virtual bool CutText(size_t startPosition, size_t endPosition) = 0;
 973 };
 974
 975 /**
 976  * @brief minimalistic, always empty Accessible object with settable address
 977  *
 978  * For those situations, where you want to return address in different bridge
 979  * (embedding for example), but the object itself ain't planned to be used otherwise.
 980  * This object has null parent, no children, empty name and so on
 981  */
 982 class DALI_ADAPTOR_API EmptyAccessibleWithAddress : public virtual Accessible
 983 {
 984 public:
 985   EmptyAccessibleWithAddress() = default;
 986   EmptyAccessibleWithAddress(Address address)
 987   : address(std::move(address))
 988   {
 989   }
 990
 991   void SetAddress(Address address)
 992   {
 993     this->address = std::move(address);
 994   }
 995
 996   std::string GetName() override
 997   {
 998     return "";
 999   }
1000   std::string GetDescription() override
1001   {
1002     return "";
1003   }
1004   Accessible* GetParent() override
1005   {
1006     return nullptr;
1007   }
1008   size_t GetChildCount() override
1009   {
1010     return 0;
1011   }
1012   std::vector<Accessible*> GetChildren() override
1013   {
1014     return {};
1015   }
1016   Accessible* GetChildAtIndex(size_t index) override
1017   {
1018     throw std::domain_error{"out of bounds index (" + std::to_string(index) + ") - no children"};
1019   }
1020   size_t GetIndexInParent() override
1021   {
1022     return static_cast<size_t>(-1);
1023   }
1024   Role GetRole() override
1025   {
1026     return {};
1027   }
1028   std::string GetRoleName() override;
1029   States      GetStates() override
1030   {
1031     return {};
1032   }
1033   Attributes GetAttributes() override
1034   {
1035     return {};
1036   }
1037   Address GetAddress() override
1038   {
1039     return address;
1040   }
1041   bool DoGesture(const GestureInfo& gestureInfo) override
1042   {
1043     return false;
1044   }
1045   std::vector<Relation> GetRelationSet() override
1046   {
1047     return {};
1048   }
1049
1050 private:
1051   Address address;
1052 };
1053
1054 } // namespace Accessibility
1055 } // namespace Dali
1056
1057 #endif // DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_H