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