1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
2 #define DALI_TOOLKIT_CONTROL_DEVEL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <dali/devel-api/adaptor-framework/accessibility-impl.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>
27 #include <dali-toolkit/devel-api/controls/accessible-impl.h>
28 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
29 #include <dali-toolkit/public-api/controls/control.h>
42 namespace DevelControl
44 /// @brief AccessibilityActivate signal type.
45 typedef Signal<void()> AccessibilityActivateSignalType;
47 /// @brief AccessibilityReadingSkipped signal type.
48 typedef Signal<void()> AccessibilityReadingSkippedSignalType;
50 /// @brief AccessibilityReadingPaused signal type.
51 typedef Signal<void()> AccessibilityReadingPausedSignalType;
53 /// @brief AccessibilityReadingResumed signal type.
54 typedef Signal<void()> AccessibilityReadingResumedSignalType;
56 /// @brief AccessibilityReadingCancelled signal type.
57 typedef Signal<void()> AccessibilityReadingCancelledSignalType;
59 /// @brief AccessibilityReadingStopped signal type.
60 typedef Signal<void()> AccessibilityReadingStoppedSignalType;
62 /// @brief AccessibilityGetName signal type.
63 typedef Signal<void(std::string&)> AccessibilityGetNameSignalType;
65 /// @brief AccessibilityGetDescription signal type.
66 typedef Signal<void(std::string&)> AccessibilityGetDescriptionSignalType;
68 /// @brief AccessibilityDoGesture signal type.
69 typedef Signal<void(std::pair<Dali::Accessibility::GestureInfo, bool>&)> AccessibilityDoGestureSignalType;
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,
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
99 TOOLTIP = PADDING + 1,
102 * @brief The current state of the control.
103 * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
105 * @see DevelControl::State
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.
113 * @see DevelControl::State
115 SUB_STATE = PADDING + 3,
118 * @brief The actor ID of the left focusable control.
119 * @details Name "leftFocusableActorId", type Property::INTEGER.
122 LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4,
125 * @brief The actor ID of the right focusable control.
126 * @details Name "rightFocusableActorId", type Property::INTEGER.
129 RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5,
132 * @brief The actor ID of the up focusable control.
133 * @details Name "upFocusableActorId", type Property::INTEGER.
136 UP_FOCUSABLE_ACTOR_ID = PADDING + 6,
139 * @brief The actor ID of the down focusable control.
140 * @details Name "downFocusableActorId", type Property::INTEGER.
143 DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
146 * @brief The shadow of the control.
147 * @details Name "shadow", type Property::MAP.
149 SHADOW = PADDING + 8,
152 * @brief The name of object visible in accessibility tree.
153 * @details Name "accessibilityName", type Property::STRING.
158 * @brief The description of object visible in accessibility tree.
159 * @details Name "accessibilityDescription", type Property::STRING.
161 ACCESSIBILITY_DESCRIPTION,
164 * @brief Current translation domain for accessibility clients.
165 * @details Name "accessibilityTranslationDomain", type Property::STRING.
167 ACCESSIBILITY_TRANSLATION_DOMAIN,
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
179 * @brief Mark of able to highlight object.
180 * @details Name "accessibilityHighlightable", type Property::BOOLEAN.
182 ACCESSIBILITY_HIGHLIGHTABLE,
184 * @brief Set of accessibility attributes describing object in accessibility hierarchy
185 * @details Name "accessibilityAttributes", type Property::MAP
187 ACCESSIBILITY_ATTRIBUTES
190 } // namespace Property
193 * @brief Register a visual by Property Index.
195 * @param[in] control The control
196 * @param[in] index The Property index of the visual, used to reference visual
197 * @param[in] visual The visual to register
199 * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
200 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
201 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
202 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
204 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual);
207 * @brief Register a visual by Property Index with a depth index.
209 * @param[in] control The control
210 * @param[in] index The Property index of the visual, used to reference visual
211 * @param[in] visual The visual to register
212 * @param[in] depthIndex The visual's depth-index is set to this
214 * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
215 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
217 * @see Visual::Base::GetDepthIndex()
218 * @see Visual::Base::SetDepthIndex()
220 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
223 * @brief Register a visual by Property Index with the option of enabling/disabling it.
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 * @param[in] enabled false if derived class wants to control when visual is set on stage.
230 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
231 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
233 * @see EnableVisual()
235 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
238 * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
240 * @param[in] control The control
241 * @param[in] index The Property index of the visual, used to reference visual
242 * @param[in] visual The visual to register
243 * @param[in] enabled false if derived class wants to control when visual is set on stage.
244 * @param[in] depthIndex The visual's depth-index is set to this
246 * @see EnableVisual()
247 * @see Visual::Base::GetDepthIndex()
248 * @see Visual::Base::SetDepthIndex()
250 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
253 * @brief Erase the entry matching the given index from the list of registered visuals
255 * @param[in] control The control
256 * @param[in] index The Property index of the visual, used to reference visual
258 DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index);
261 * @brief Retrieve the visual associated with the given property index.
263 * @param[in] control The control
264 * @param[in] index The Property index of the visual.
265 * @return The registered visual if exist, otherwise empty handle.
266 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
268 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index);
271 * @brief Sets the given visual to be displayed or not when parent staged.
273 * @param[in] control The control
274 * @param[in] index The Property index of the visual
275 * @param[in] enable flag to set enabled or disabled.
277 DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable);
280 * @brief Queries if the given visual is to be displayed when parent staged.
282 * @param[in] control The control
283 * @param[in] index The Property index of the visual
284 * @return bool whether visual is enabled or not
286 DALI_TOOLKIT_API bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index);
289 * @brief Add a transition effect on the control to the given animation
291 * Only generates an animator if the properties described in the transition
292 * data are staged (e.g. the visual is Enabled and the control is on stage).
293 * Otherwise the target values are stored, and will get set onto the properties
294 * when the visual is next staged.
296 * @param[in] control The control
297 * @param[in] animation The Animation to add valid transitions to
298 * @param[in] transitionData The transition data describing the effect to create
300 DALI_TOOLKIT_API void AddTransitions(Internal::Control& control,
301 Dali::Animation animation,
302 const Toolkit::TransitionData& transitionData);
305 * @brief Create a transition effect on the control.
307 * Only generates an animation if the properties described in the transition
308 * data are staged (e.g. the visual is Enabled and the control is on stage).
309 * Otherwise the target values are stored, and will get set onto the properties
310 * when the visual is next staged.
312 * @param[in] control The control
313 * @param[in] transitionData The transition data describing the effect to create
314 * @return A handle to an animation defined with the given effect, or an empty
315 * handle if no properties match.
317 DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control& control,
318 const Toolkit::TransitionData& transitionData);
321 * @brief Perform an action on a visual registered to this control.
323 * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
325 * @param[in] control The control.
326 * @param[in] visualIndex The Property index of the visual.
327 * @param[in] actionId The action to perform. See Visual to find supported actions.
328 * @param[in] attributes Optional attributes for the action.
330 DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
333 * @brief Set input method context.
335 * @param[in] control The control.
336 * @param[in] inputMethodContext The input method context.
338 DALI_TOOLKIT_API void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext);
341 * @brief Visual Event signal type
343 using VisualEventSignalType = Signal<void(Control, Dali::Property::Index, Dali::Property::Index)>;
346 * @brief This signal is emitted when a visual has an event to notify.
348 * A callback of the following type may be connected:
350 * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
352 * @return The signal to connect to
354 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
357 * @brief Retrieve the property object associated with the given property index and the visual property key.
359 * @param[in] control The control
360 * @param[in] index The Property index of the visual.
361 * @param[in] visualPropertyKey The key of the visual's property.
362 * @return The Property object
364 DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
367 * @brief Retrieve visual/renderer property animation between this Control and source control.
368 * Input animation must be created before this method called.
369 * And the animations between this method created are added the input animation.
370 * This method generates visual/renderer property animation but not creates Actor property animation.
372 * @param[in] control The control
373 * @param[in] animation generated animation
374 * @param[in] source source control of the animation.
375 * @param[in] alphaFunction AlphaFunction of the animation
376 * @param[in] timePeriod TimePeriod of the animation
378 DALI_TOOLKIT_API void CreateTransitions(Control control, Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod);
381 * @brief The signal is emmited as a succession of "activate" signal send by accessibility client.
382 * @return The signal to connect to
384 DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control);
387 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
388 * was placed in TTS queue but other text with higher priority prevented it from being read.
390 * @return The signal to connect to
392 DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control);
397 * @return The signal to connect to
399 DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control);
404 * @return The signal to connect to
406 DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control);
409 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
410 * was placed in TTS queue and reading was started but other text with higher priority cancelled it.
412 * @return The signal to connect to
414 DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control);
417 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
418 * was fully read by TTS module.
420 * @return The signal to connect to
422 DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control);
425 * @brief The signal is emmited when accessibility client asks for object's name.
427 * Connected callback should assign name to std::string call parameter.
428 * Accessibility name can be stored in two ways:
430 * ACCESSIBILITY_NAME property,
431 * Priority is as above. If none is used, default implementation is provided.
432 * @return [description]
434 DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control);
437 * @brief The signal is emmited when accessibility client asks for object's description.
439 * Connected callback should assign description to std::string call parameter.
440 * Accessibility description can be stored in two ways:
442 * ACCESSIBILITY_DESCRIPTION property,
443 * Priority is as above. If none is used, default implementation is provided.
444 * @return signal handler
446 DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control);
449 * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism.
451 * This signal allows developers to serve incoming gesture in specific way.
452 * @return signal handler
454 DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control);
457 * @brief The method allows connection with other actor with usage of concrete accessibility relation type.
459 * @param control object to append attribute to
460 * @param destination Actor object
461 * @param relation enumerated value describing relation
463 DALI_TOOLKIT_API void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation);
466 * @brief The method allows removing relation
468 * @param control object to append attribute to
469 * @param destination Actor object
470 * @param relation enumerated value describing relation
472 DALI_TOOLKIT_API void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation);
475 * @brief The method returns collection accessibility addresses representing objects connected with current object
477 * @param control object to append attribute to
478 * @return std::vector, where index is casted value of Accessibility::RelationType and value is std::vector of type Accessibility::Address
480 DALI_TOOLKIT_API std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control);
483 * @brief The method removes all previously appended relations
485 * @param control object to append attribute to
487 DALI_TOOLKIT_API void ClearAccessibilityRelations(Dali::Actor control);
490 * @brief The method allows to add or modify value matched with given key.
491 * Modification take place if key was previously set.
493 * @param control object to append attribute to
494 * @param key std::string value
495 * @param value std::string value
497 DALI_TOOLKIT_API void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value);
500 * @brief The method erases key with its value from accessibility attributes
501 * @param control object to append attribute to
502 * @param key std::string value
504 DALI_TOOLKIT_API void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key);
507 * @brief The method clears accessibility attributes
509 * @param control object to append attribute to
511 DALI_TOOLKIT_API void ClearAccessibilityAttributes(Dali::Actor control);
514 * @brief The method inserts reading information of an accessible object into attributes
516 * @param control object to append attribute to
517 * @param types Reading information types
519 DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types);
522 * @brief The method returns reading information of an accessible object
524 * @param control object to append attribute to
525 * @return Reading information types
527 DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control);
530 * @brief The method erases highlight.
532 * @param control object to append attribute to
533 * @return bool value, false when it is not possible or something went wrong, at the other way true.
535 DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Dali::Actor control);
538 * @brief The method grabs highlight.
540 * @param control object to append attribute to
541 * @return bool value, false when it is not possible or something went wrong, at the other way true.
543 DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Dali::Actor control);
546 * @brief The metod presents bitset of control's states.
548 * @param control object to append attribute to
549 * @return Dali::Accessibility::States is vector of enumerated State.
551 DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control);
554 * @brief The method force sending notifications about current states to accessibility clients
556 * @param control object to append attribute to
557 * @param states mask with states expected to broadcast
558 * @param isRecursive flag pointing if notifications of children's state would be sent
560 DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive);
563 * The method allows to set specific constructor for creating accessibility structure
565 * Thank to this method hierarchy of accessibility objects can be based on internal hierarchy of Actors.
566 * It prevents from necessity of keeping two trees synchronized.
567 * The method should be called inside OnInitialize method of all classes inheriting from Control.
569 * Possible usage can be as follows:
571 * SetAccessibilityConstructor( []( Dali::Actor actor ) {
572 return std::unique_ptr< Dali::Accessibility::Accessible >(
573 new AccessibleImpl( actor, Dali::Accessibility::Role::DIALOG, true ) );
577 * param constructor callback creating Accessible object
579 DALI_TOOLKIT_API void SetAccessibilityConstructor(Dali::Actor control, std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor);
582 * Returns accessibility object bound to actor, if any
584 * This method won't bound new accessibility object. Use Dali::Accessibility::Accessible::Get in that case.
586 DALI_TOOLKIT_API Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control);
588 } // namespace DevelControl
590 } // namespace Toolkit
594 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H