dali-toolkit/devel-api/controls/control-devel.h

   1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
   2 #define DALI_TOOLKIT_CONTROL_DEVEL_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/devel-api/adaptor-framework/accessibility-impl.h>
  22 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/devel-api/controls/accessible-impl.h>
  26 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  27 #include <dali-toolkit/public-api/controls/control.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 class TransitionData;
  34
  35 namespace Visual
  36 {
  37 class Base;
  38 }
  39
  40 namespace DevelControl
  41 {
  42 /// @brief AccessibilityActivate signal type.
  43 typedef Signal<void()> AccessibilityActivateSignalType;
  44
  45 /// @brief AccessibilityReadingSkipped signal type.
  46 typedef Signal<void()> AccessibilityReadingSkippedSignalType;
  47
  48 /// @brief AccessibilityReadingPaused signal type.
  49 typedef Signal<void()> AccessibilityReadingPausedSignalType;
  50
  51 /// @brief AccessibilityReadingResumed signal type.
  52 typedef Signal<void()> AccessibilityReadingResumedSignalType;
  53
  54 /// @brief AccessibilityReadingCancelled signal type.
  55 typedef Signal<void()> AccessibilityReadingCancelledSignalType;
  56
  57 /// @brief AccessibilityReadingStopped signal type.
  58 typedef Signal<void()> AccessibilityReadingStoppedSignalType;
  59
  60 /// @brief AccessibilityGetName signal type.
  61 typedef Signal<void(std::string&)> AccessibilityGetNameSignalType;
  62
  63 /// @brief AccessibilityGetDescription signal type.
  64 typedef Signal<void(std::string&)> AccessibilityGetDescriptionSignalType;
  65
  66 /// @brief AccessibilityDoGesture signal type.
  67 typedef Signal<void(std::pair<Dali::Accessibility::GestureInfo, bool>&)> AccessibilityDoGestureSignalType;
  68
  69 enum State
  70 {
  71   NORMAL,
  72   FOCUSED,
  73   DISABLED
  74 };
  75
  76 namespace Property
  77 {
  78 enum
  79 {
  80   STYLE_NAME      = Control::Property::STYLE_NAME,
  81   KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS,
  82   BACKGROUND      = Control::Property::BACKGROUND,
  83   MARGIN          = Control::Property::MARGIN,
  84   PADDING         = Control::Property::PADDING,
  85
  86   /**
  87    * @brief Displays a tooltip when the control is hovered over.
  88    * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
  89    *          If Property::STRING, then the style specified in the stylesheet is used.
  90    *          If Property::ARRAY of Visuals then all are displayed in one row.
  91    *          If Property::MAP, then it should be a map of Tooltip properties.
  92    * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
  93    *       The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
  94    * @note When retrieved, a Property::MAP is returned.
  95    * @see Toolkit::Tooltip
  96    */
  97   TOOLTIP = PADDING + 1,
  98
  99   /**
 100    * @brief The current state of the control.
 101    * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
 102    *
 103    * @see DevelControl::State
 104    */
 105   STATE = PADDING + 2,
 106
 107   /**
 108    * @brief The current sub state of the control.
 109    * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
 110    *
 111    * @see DevelControl::State
 112    */
 113   SUB_STATE = PADDING + 3,
 114
 115   /**
 116    * @brief The actor ID of the left focusable control.
 117    * @details Name "leftFocusableActorId", type Property::INTEGER.
 118    *
 119    */
 120   LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4,
 121
 122   /**
 123    * @brief The actor ID of the right focusable control.
 124    * @details Name "rightFocusableActorId", type Property::INTEGER.
 125    *
 126    */
 127   RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5,
 128
 129   /**
 130    * @brief The actor ID of the up focusable control.
 131    * @details Name "upFocusableActorId", type Property::INTEGER.
 132    *
 133    */
 134   UP_FOCUSABLE_ACTOR_ID = PADDING + 6,
 135
 136   /**
 137    * @brief The actor ID of the down focusable control.
 138    * @details Name "downFocusableActorId", type Property::INTEGER.
 139    *
 140    */
 141   DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
 142
 143   /**
 144    * @brief The shadow of the control.
 145    * @details Name "shadow", type Property::MAP.
 146    */
 147   SHADOW = PADDING + 8,
 148
 149   /**
 150    * @brief The name of object visible in accessibility tree.
 151    * @details Name "accessibilityName", type Property::STRING.
 152    */
 153   ACCESSIBILITY_NAME,
 154
 155   /**
 156    * @brief The description of object visible in accessibility tree.
 157    * @details Name "accessibilityDescription", type Property::STRING.
 158    */
 159   ACCESSIBILITY_DESCRIPTION,
 160
 161   /**
 162    * @brief Current translation domain for accessibility clients.
 163    * @details Name "accessibilityTranslationDomain", type Property::STRING.
 164    */
 165   ACCESSIBILITY_TRANSLATION_DOMAIN,
 166
 167   /**
 168    * @brief Role being performed in accessibility hierarchy.
 169    * @details Name "accessibilityRole", type Property::INTEGER.
 170    * @note Property is stored as INTEGER, however its interpretaton
 171    * depend on enumeration Dali::Accessibility::Role and should be read and written
 172    * with usage of enumerated values.
 173    * @see Dali::Accessibility::Role
 174    */
 175   ACCESSIBILITY_ROLE,
 176   /**
 177    * @brief Mark of able to highlight object.
 178    * @details Name "accessibilityHighlightable", type Property::BOOLEAN.
 179    */
 180   ACCESSIBILITY_HIGHLIGHTABLE,
 181   /**
 182    * @brief Set of accessibility attributes describing object in accessibility hierarchy
 183    * @details Name "accessibilityAttributes", type Property::MAP
 184    */
 185   ACCESSIBILITY_ATTRIBUTES
 186 };
 187
 188 } // namespace Property
 189
 190 /**
 191  * @brief Register a visual by Property Index.
 192  *
 193  * @param[in] control The control
 194  * @param[in] index The Property index of the visual, used to reference visual
 195  * @param[in] visual The visual to register
 196  *
 197  * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 198  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 199  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 200  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 201  */
 202 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual);
 203
 204 /**
 205  * @brief Register a visual by Property Index with a depth index.
 206  *
 207  * @param[in] control The control
 208  * @param[in] index The Property index of the visual, used to reference visual
 209  * @param[in] visual The visual to register
 210  * @param[in] depthIndex The visual's depth-index is set to this
 211  *
 212  * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 213  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 214  *
 215  * @see Visual::Base::GetDepthIndex()
 216  * @see Visual::Base::SetDepthIndex()
 217  */
 218 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
 219
 220 /**
 221  * @brief Register a visual by Property Index with the option of enabling/disabling it.
 222  *
 223  * @param[in] control The control
 224  * @param[in] index The Property index of the visual, used to reference visual
 225  * @param[in] visual The visual to register
 226  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 227  *
 228  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 229  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 230  *
 231  * @see EnableVisual()
 232  */
 233 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
 234
 235 /**
 236  * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
 237  *
 238  * @param[in] control The control
 239  * @param[in] index The Property index of the visual, used to reference visual
 240  * @param[in] visual The visual to register
 241  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 242  * @param[in] depthIndex The visual's depth-index is set to this
 243  *
 244  * @see EnableVisual()
 245  * @see Visual::Base::GetDepthIndex()
 246  * @see Visual::Base::SetDepthIndex()
 247  */
 248 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
 249
 250 /**
 251  * @brief Erase the entry matching the given index from the list of registered visuals
 252  *
 253  * @param[in] control The control
 254  * @param[in] index The Property index of the visual, used to reference visual
 255  */
 256 DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index);
 257
 258 /**
 259  * @brief Retrieve the visual associated with the given property index.
 260  *
 261  * @param[in] control The control
 262  * @param[in] index The Property index of the visual.
 263  * @return The registered visual if exist, otherwise empty handle.
 264  * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
 265  */
 266 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index);
 267
 268 /**
 269  * @brief Sets the given visual to be displayed or not when parent staged.
 270  *
 271  * @param[in] control The control
 272  * @param[in] index The Property index of the visual
 273  * @param[in] enable flag to set enabled or disabled.
 274  */
 275 DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable);
 276
 277 /**
 278  * @brief Queries if the given visual is to be displayed when parent staged.
 279  *
 280  * @param[in] control The control
 281  * @param[in] index The Property index of the visual
 282  * @return bool whether visual is enabled or not
 283  */
 284 DALI_TOOLKIT_API bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index);
 285
 286 /**
 287  * @brief Add a transition effect on the control to the given animation
 288  *
 289  * Only generates an animator if the properties described in the transition
 290  * data are staged (e.g. the visual is Enabled and the control is on stage).
 291  * Otherwise the target values are stored, and will get set onto the properties
 292  * when the visual is next staged.
 293  *
 294  * @param[in] control The control
 295  * @param[in] animation The Animation to add valid transitions to
 296  * @param[in] transitionData The transition data describing the effect to create
 297  */
 298 DALI_TOOLKIT_API void AddTransitions(Internal::Control&             control,
 299                                      Dali::Animation                animation,
 300                                      const Toolkit::TransitionData& transitionData);
 301
 302 /**
 303  * @brief Create a transition effect on the control.
 304  *
 305  * Only generates an animation if the properties described in the transition
 306  * data are staged (e.g. the visual is Enabled and the control is on stage).
 307  * Otherwise the target values are stored, and will get set onto the properties
 308  * when the visual is next staged.
 309  *
 310  * @param[in] control The control
 311  * @param[in] transitionData The transition data describing the effect to create
 312  * @return A handle to an animation defined with the given effect, or an empty
 313  * handle if no properties match.
 314  */
 315 DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control&             control,
 316                                                   const Toolkit::TransitionData& transitionData);
 317
 318 /**
 319  * @brief Perform an action on a visual registered to this control.
 320  *
 321  * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
 322  *
 323  * @param[in] control The control.
 324  * @param[in] visualIndex The Property index of the visual.
 325  * @param[in] actionId The action to perform.  See Visual to find supported actions.
 326  * @param[in] attributes Optional attributes for the action.
 327  */
 328 DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
 329
 330 /**
 331  * @brief Set input method context.
 332  *
 333  * @param[in] control The control.
 334  * @param[in] inputMethodContext The input method context.
 335  */
 336 DALI_TOOLKIT_API void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext);
 337
 338 /**
 339  * @brief Visual Event signal type
 340  */
 341 using VisualEventSignalType = Signal<void(Control, Dali::Property::Index, Dali::Property::Index)>;
 342
 343 /**
 344  * @brief This signal is emitted when a visual has an event to notify.
 345  *
 346  * A callback of the following type may be connected:
 347  * @code
 348  *   void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
 349  * @endcode
 350  * @return The signal to connect to
 351  */
 352 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
 353
 354 /**
 355  * @brief Retrieve the property object associated with the given property index and the visual property key.
 356  *
 357  * @param[in] control The control
 358  * @param[in] index The Property index of the visual.
 359  * @param[in] visualPropertyKey The key of the visual's property.
 360  * @return The Property object
 361  */
 362 DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
 363
 364 /**
 365  * @brief The signal is emmited as a succession of "activate" signal send by accessibility client.
 366  * @return The signal to connect to
 367  */
 368 DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control);
 369
 370 /**
 371  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
 372  * was placed in TTS queue but other text with higher priority prevented it from being read.
 373  *
 374  * @return The signal to connect to
 375  */
 376 DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control);
 377
 378 /**
 379  * @brief
 380  *
 381  * @return The signal to connect to
 382  */
 383 DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control);
 384
 385 /**
 386  * @brief
 387  *
 388  * @return The signal to connect to
 389  */
 390 DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control);
 391
 392 /**
 393  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
 394  * was placed in TTS queue and reading was started but other text with higher priority cancelled it.
 395  *
 396  * @return The signal to connect to
 397  */
 398 DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control);
 399
 400 /**
 401  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
 402  * was fully read by TTS module.
 403  *
 404  * @return The signal to connect to
 405  */
 406 DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control);
 407
 408 /**
 409  * @brief The signal is emmited when accessibility client asks for object's name.
 410  *
 411  * Connected callback should assign name to std::string call parameter.
 412  * Accessibility name can be stored in two ways:
 413  *     this signal,
 414  *     ACCESSIBILITY_NAME property,
 415  * Priority is as above. If none is used, default implementation is provided.
 416  * @return [description]
 417  */
 418 DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control);
 419
 420 /**
 421  * @brief The signal is emmited when accessibility client asks for object's description.
 422  *
 423  * Connected callback should assign description to std::string call parameter.
 424  * Accessibility description can be stored in two ways:
 425  *     this signal,
 426  *     ACCESSIBILITY_DESCRIPTION property,
 427  * Priority is as above. If none is used, default implementation is provided.
 428  * @return signal handler
 429  */
 430 DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control);
 431
 432 /**
 433  * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism.
 434  *
 435  * This signal allows developers to serve incoming gesture in specific way.
 436  * @return signal handler
 437  */
 438 DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control);
 439
 440 /**
 441  * @brief The method allows connection with other actor with usage of concrete accessibility relation type.
 442  *
 443  * @param control object to append attribute to
 444  * @param destination Actor object
 445  * @param relation    enumerated value describing relation
 446  */
 447 DALI_TOOLKIT_API void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation);
 448
 449 /**
 450  * @brief The method allows removing relation
 451  *
 452  * @param control object to append attribute to
 453  * @param destination Actor object
 454  * @param relation    enumerated value describing relation
 455  */
 456 DALI_TOOLKIT_API void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation);
 457
 458 /**
 459  * @brief The method returns collection accessibility addresses representing objects connected with current object
 460  *
 461  * @param control object to append attribute to
 462  * @return std::vector, where index is casted value of Accessibility::RelationType and value is std::vector of type Accessibility::Address
 463  */
 464 DALI_TOOLKIT_API std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control);
 465
 466 /**
 467  * @brief The method removes all previously appended relations
 468  *
 469  * @param control object to append attribute to
 470  */
 471 DALI_TOOLKIT_API void ClearAccessibilityRelations(Dali::Actor control);
 472
 473 /**
 474  * @brief The method allows to add or modify value matched with given key.
 475  * Modification take place if key was previously set.
 476  *
 477  * @param control object to append attribute to
 478  * @param key   std::string value
 479  * @param value std::string value
 480  */
 481 DALI_TOOLKIT_API void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value);
 482
 483 /**
 484  * @brief The method erases key with its value from accessibility attributes
 485  * @param control object to append attribute to
 486  * @param key std::string value
 487  */
 488 DALI_TOOLKIT_API void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key);
 489
 490 /**
 491  * @brief The method clears accessibility attributes
 492  *
 493  * @param control object to append attribute to
 494  */
 495 DALI_TOOLKIT_API void ClearAccessibilityAttributes(Dali::Actor control);
 496
 497 /**
 498  * @brief The method inserts reading information of an accessible object into attributes
 499  *
 500  * @param control object to append attribute to
 501  * @param types Reading information types
 502  */
 503 DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types);
 504
 505 /**
 506  * @brief The method returns reading information of an accessible object
 507  *
 508  * @param control object to append attribute to
 509  * @return Reading information types
 510  */
 511 DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control);
 512
 513 /**
 514  * @brief The method erases highlight.
 515  *
 516  * @param control object to append attribute to
 517  * @return bool value, false when it is not possible or something went wrong, at the other way true.
 518  */
 519 DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Dali::Actor control);
 520
 521 /**
 522  * @brief The method grabs highlight.
 523  *
 524  * @param control object to append attribute to
 525  * @return bool value, false when it is not possible or something went wrong, at the other way true.
 526  */
 527 DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Dali::Actor control);
 528
 529 /**
 530  * @brief The metod presents bitset of control's states.
 531  *
 532  * @param control object to append attribute to
 533  * @return Dali::Accessibility::States is vector of enumerated State.
 534  */
 535 DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control);
 536
 537 /**
 538  * @brief The method force sending notifications about current states to accessibility clients
 539  *
 540  * @param control object to append attribute to
 541  * @param states      mask with states expected to broadcast
 542  * @param doRecursive flag pointing if notifications of children's state would be sent
 543  */
 544 DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool doRecursive);
 545
 546 /**
 547  * The method allows to set specific constructor for creating accessibility structure
 548  *
 549  * Thank to this method hierarchy of accessibility objects can be based on internal hierarchy of Actors.
 550  * It prevents from necessity of keeping two trees synchronized.
 551  * The method should be called inside OnInitialize method of all classes inheriting from Control.
 552  *
 553  * Possible usage can be as follows:
 554  * @code
 555  *   SetAccessibilityConstructor( []( Dali::Actor actor ) {
 556        return std::unique_ptr< Dali::Accessibility::Accessible >(
 557        new AccessibleImpl( actor, Dali::Accessibility::Role::DIALOG, true ) );
 558       } );
 559   * @endcode
 560   *
 561   * param constructor callback creating Accessible object
 562   */
 563 DALI_TOOLKIT_API void SetAccessibilityConstructor(Dali::Actor control, std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor);
 564
 565 /**
 566  * Returns accessibility object bound to actor, if any
 567  *
 568  * This method won't bound new accessibility object. Use Dali::Accessibility::Accessible::Get in that case.
 569  */
 570 DALI_TOOLKIT_API Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control);
 571
 572 } // namespace DevelControl
 573
 574 } // namespace Toolkit
 575
 576 } // namespace Dali
 577
 578 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H