[dali_2.1.33] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / 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) 2022 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    * @brief Identifier that allows the automation framework to find and interact with this element.
221    * @details Name "automationId", type Property::STRING.
222    * @note This is a string identifier (compared to @c Actor::Property::ID which is an integer).
223    * It will also appear in the AT-SPI tree under the key "automationId".
224    */
225   AUTOMATION_ID,
226 };
227
228 } // namespace Property
229
230 /**
231  * @brief Register a visual by Property Index.
232  *
233  * @param[in] control The control
234  * @param[in] index The Property index of the visual, used to reference visual
235  * @param[in] visual The visual to register
236  *
237  * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
238  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
239  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
240  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
241  */
242 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual);
243
244 /**
245  * @brief Register a visual by Property Index with a depth index.
246  *
247  * @param[in] control The control
248  * @param[in] index The Property index of the visual, used to reference visual
249  * @param[in] visual The visual to register
250  * @param[in] depthIndex The visual's depth-index is set to this
251  *
252  * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
253  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
254  *
255  * @see Visual::Base::GetDepthIndex()
256  * @see Visual::Base::SetDepthIndex()
257  */
258 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
259
260 /**
261  * @brief Register a visual by Property Index with the option of enabling/disabling it.
262  *
263  * @param[in] control The control
264  * @param[in] index The Property index of the visual, used to reference visual
265  * @param[in] visual The visual to register
266  * @param[in] enabled false if derived class wants to control when visual is set on stage.
267  *
268  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
269  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
270  *
271  * @see EnableVisual()
272  */
273 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
274
275 /**
276  * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
277  *
278  * @param[in] control The control
279  * @param[in] index The Property index of the visual, used to reference visual
280  * @param[in] visual The visual to register
281  * @param[in] enabled false if derived class wants to control when visual is set on stage.
282  * @param[in] depthIndex The visual's depth-index is set to this
283  *
284  * @see EnableVisual()
285  * @see Visual::Base::GetDepthIndex()
286  * @see Visual::Base::SetDepthIndex()
287  */
288 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
289
290 /**
291  * @brief Erase the entry matching the given index from the list of registered visuals
292  *
293  * @param[in] control The control
294  * @param[in] index The Property index of the visual, used to reference visual
295  */
296 DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index);
297
298 /**
299  * @brief Retrieve the visual associated with the given property index.
300  *
301  * @param[in] control The control
302  * @param[in] index The Property index of the visual.
303  * @return The registered visual if exist, otherwise empty handle.
304  * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
305  */
306 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index);
307
308 /**
309  * @brief Sets the given visual to be displayed or not when parent staged.
310  *
311  * @param[in] control The control
312  * @param[in] index The Property index of the visual
313  * @param[in] enable flag to set enabled or disabled.
314  */
315 DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable);
316
317 /**
318  * @brief Queries if the given visual is to be displayed when parent staged.
319  *
320  * @param[in] control The control
321  * @param[in] index The Property index of the visual
322  * @return bool whether visual is enabled or not
323  */
324 DALI_TOOLKIT_API bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index);
325
326 /**
327  * @brief Add a transition effect on the control to the given animation
328  *
329  * Only generates an animator if the properties described in the transition
330  * data are staged (e.g. the visual is Enabled and the control is on stage).
331  * Otherwise the target values are stored, and will get set onto the properties
332  * when the visual is next staged.
333  *
334  * @param[in] control The control
335  * @param[in] animation The Animation to add valid transitions to
336  * @param[in] transitionData The transition data describing the effect to create
337  */
338 DALI_TOOLKIT_API void AddTransitions(Internal::Control&             control,
339                                      Dali::Animation                animation,
340                                      const Toolkit::TransitionData& transitionData);
341
342 /**
343  * @brief Create a transition effect on the control.
344  *
345  * Only generates an animation if the properties described in the transition
346  * data are staged (e.g. the visual is Enabled and the control is on stage).
347  * Otherwise the target values are stored, and will get set onto the properties
348  * when the visual is next staged.
349  *
350  * @param[in] control The control
351  * @param[in] transitionData The transition data describing the effect to create
352  * @return A handle to an animation defined with the given effect, or an empty
353  * handle if no properties match.
354  */
355 DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control&             control,
356                                                   const Toolkit::TransitionData& transitionData);
357
358 /**
359  * @brief Perform an action on a visual registered to this control.
360  *
361  * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
362  *
363  * @param[in] control The control.
364  * @param[in] visualIndex The Property index of the visual.
365  * @param[in] actionId The action to perform.  See Visual to find supported actions.
366  * @param[in] attributes Optional attributes for the action.
367  */
368 DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
369
370 /**
371  * @brief Perform an action on a visual registered to this control.
372  *
373  * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
374  *
375  * @param[in] control The control.
376  * @param[in] visualIndex The Property index of the visual.
377  * @param[in] actionId The action to perform.  See Visual to find supported actions.
378  * @param[in] attributes Optional attributes for the action.
379  */
380 DALI_TOOLKIT_API void DoActionExtension(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes);
381
382 /**
383  * @brief Set input method context.
384  *
385  * @param[in] control The control.
386  * @param[in] inputMethodContext The input method context.
387  */
388 DALI_TOOLKIT_API void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext);
389
390 /**
391  * @brief Visual Event signal type
392  */
393 using VisualEventSignalType = Signal<void(Control, Dali::Property::Index, Dali::Property::Index)>;
394
395 /**
396  * @brief This signal is emitted when a visual has an event to notify.
397  *
398  * A callback of the following type may be connected:
399  * @code
400  *   void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
401  * @endcode
402  * @return The signal to connect to
403  */
404 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
405
406 /**
407  * @brief Retrieve the property object associated with the given property index and the visual property key.
408  *
409  * @param[in] control The control
410  * @param[in] index The Property index of the visual.
411  * @param[in] visualPropertyKey The key of the visual's property.
412  * @return The Property object
413  */
414 DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
415
416 /**
417  * @brief The signal is emmited as a succession of "activate" signal send by accessibility client.
418  * @return The signal to connect to
419  */
420 DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control);
421
422 /**
423  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
424  * was placed in TTS queue but other text with higher priority prevented it from being read.
425  *
426  * @return The signal to connect to
427  */
428 DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control);
429
430 /**
431  * @brief
432  *
433  * @return The signal to connect to
434  */
435 DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control);
436
437 /**
438  * @brief
439  *
440  * @return The signal to connect to
441  */
442 DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control);
443
444 /**
445  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
446  * was placed in TTS queue and reading was started but other text with higher priority cancelled it.
447  *
448  * @return The signal to connect to
449  */
450 DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control);
451
452 /**
453  * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
454  * was fully read by TTS module.
455  *
456  * @return The signal to connect to
457  */
458 DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control);
459
460 /**
461  * @brief The signal is emmited when accessibility client asks for object's name.
462  *
463  * Connected callback should assign name to std::string call parameter.
464  * Accessibility name can be stored in two ways:
465  *     this signal,
466  *     ACCESSIBILITY_NAME property,
467  * Priority is as above. If none is used, default implementation is provided.
468  * @return [description]
469  */
470 DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control);
471
472 /**
473  * @brief The signal is emmited when accessibility client asks for object's description.
474  *
475  * Connected callback should assign description to std::string call parameter.
476  * Accessibility description can be stored in two ways:
477  *     this signal,
478  *     ACCESSIBILITY_DESCRIPTION property,
479  * Priority is as above. If none is used, default implementation is provided.
480  * @return signal handler
481  */
482 DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control);
483
484 /**
485  * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism.
486  *
487  * This signal allows developers to serve incoming gesture in specific way.
488  * @return signal handler
489  */
490 DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control);
491
492 /**
493  * @brief The method allows connection with other actor with usage of concrete accessibility relation type.
494  *
495  * @param control object to append attribute to
496  * @param destination Actor object
497  * @param relation    enumerated value describing relation
498  */
499 DALI_TOOLKIT_API void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation);
500
501 /**
502  * @brief The method allows removing relation
503  *
504  * @param control object to append attribute to
505  * @param destination Actor object
506  * @param relation    enumerated value describing relation
507  */
508 DALI_TOOLKIT_API void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation);
509
510 /**
511  * @brief Returns a collection of Accessible objects related to current object and grouped by relation type.
512  *
513  * @param control object to query
514  * @return collection of relations
515  *
516  * @see Dali::Accessibility::Accessible::GetRelationSet()
517  */
518 DALI_TOOLKIT_API std::vector<Accessibility::Relation> GetAccessibilityRelations(Toolkit::Control control);
519
520 /**
521  * @brief The method removes all previously appended relations
522  *
523  * @param control object to append attribute to
524  */
525 DALI_TOOLKIT_API void ClearAccessibilityRelations(Toolkit::Control control);
526
527 /**
528  * @brief The method allows to add or modify value matched with given key.
529  * Modification take place if key was previously set.
530  *
531  * @param control object to append attribute to
532  * @param key   std::string value
533  * @param value std::string value
534  */
535 DALI_TOOLKIT_API void AppendAccessibilityAttribute(Toolkit::Control control, const std::string& key, const std::string& value);
536
537 /**
538  * @brief The method erases key with its value from accessibility attributes
539  * @param control object to append attribute to
540  * @param key std::string value
541  */
542 DALI_TOOLKIT_API void RemoveAccessibilityAttribute(Toolkit::Control control, const std::string& key);
543
544 /**
545  * @brief The method clears accessibility attributes
546  *
547  * @param control object to append attribute to
548  */
549 DALI_TOOLKIT_API void ClearAccessibilityAttributes(Toolkit::Control control);
550
551 /**
552  * @brief The method inserts reading information of an accessible object into attributes
553  *
554  * @param control object to append attribute to
555  * @param types Reading information types
556  */
557 DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types);
558
559 /**
560  * @brief The method returns reading information of an accessible object
561  *
562  * @param control object to append attribute to
563  * @return Reading information types
564  */
565 DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control);
566
567 /**
568  * @brief The method erases highlight.
569  *
570  * @param control object to append attribute to
571  * @return bool value, false when it is not possible or something went wrong, at the other way true.
572  */
573 DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Toolkit::Control control);
574
575 /**
576  * @brief The method grabs highlight.
577  *
578  * @param control object to append attribute to
579  * @return bool value, false when it is not possible or something went wrong, at the other way true.
580  */
581 DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Toolkit::Control control);
582
583 /**
584  * @brief The metod presents bitset of control's states.
585  *
586  * @param control object to append attribute to
587  * @return Dali::Accessibility::States is vector of enumerated State.
588  */
589 DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Toolkit::Control control);
590
591 /**
592  * @brief The method force sending notifications about current states to accessibility clients
593  *
594  * @param control object to append attribute to
595  * @param states  mask with states expected to broadcast
596  * @param recurse flag pointing if notifications of children's state would be sent
597  */
598 DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse);
599
600 } // namespace DevelControl
601
602 } // namespace Toolkit
603
604 } // namespace Dali
605
606 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H