1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
2 #define DALI_TOOLKIT_CONTROL_DEVEL_H
5 * Copyright (c) 2024 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-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>
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>
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
180 * @brief Mark of able to highlight object.
181 * @details Name "accessibilityHighlightable", type Property::BOOLEAN.
183 ACCESSIBILITY_HIGHLIGHTABLE,
186 * @brief Set of accessibility attributes describing object in accessibility hierarchy
187 * @details Name "accessibilityAttributes", type Property::MAP
189 ACCESSIBILITY_ATTRIBUTES,
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.
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.
203 ACCESSIBILITY_HIDDEN,
206 * @brief The actor ID of the clockwise focusable control.
207 * @details Name "clockwiseFocusableActorId", type Property::INTEGER.
210 CLOCKWISE_FOCUSABLE_ACTOR_ID,
213 * @brief The actor ID of the conter-clockwise focusable control.
214 * @details Name "counterClockwiseFocusableActorId", type Property::INTEGER.
217 COUNTER_CLOCKWISE_FOCUSABLE_ACTOR_ID,
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".
228 } // namespace Property
231 * @brief Register a visual by Property Index.
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
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 depth-index be used to Dali::Toolkit::DepthIndex::Ranges::AUTO_INDEX.
241 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual);
244 * @brief Register a visual by Property Index with a depth index.
246 * @param[in] control The control
247 * @param[in] index The Property index of the visual, used to reference visual
248 * @param[in] visual The visual to register
249 * @param[in] depthIndex The visual's depth-index is set to this. If the depth-index is set to DepthIndex::Ranges::AUTO_INDEX,
250 * the actual depth-index of visual will be determind automatically (Use previous visuals depth-index, or placed on top of all other visuals.)
251 * Otherwise, the visual's depth-index is set to clamped value, between DepthIndex::Ranges::MINIMUM_DEPTH_INDEX and DepthIndex::Ranges::MAXIMUM_DEPTH_INDEX.
253 * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
254 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
256 * @see Visual::Base::GetDepthIndex()
257 * @see Visual::Base::SetDepthIndex()
259 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
262 * @brief Register a visual by Property Index with the option of enabling/disabling it.
264 * @param[in] control The control
265 * @param[in] index The Property index of the visual, used to reference visual
266 * @param[in] visual The visual to register
267 * @param[in] enabled false if derived class wants to control when visual is set on stage.
269 * @note depth-index be used to Dali::Toolkit::DepthIndex::Ranges::AUTO_INDEX.
271 * @see EnableVisual()
273 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
276 * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
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. If the depth-index is set to DepthIndex::Ranges::AUTO_INDEX,
283 * the actual depth-index of visual will be determind automatically (Use previous visuals depth-index, or placed on top of all other visuals.)
284 * Otherwise, the visual's depth-index is set to clamped value, between DepthIndex::Ranges::MINIMUM_DEPTH_INDEX and DepthIndex::Ranges::MAXIMUM_DEPTH_INDEX.
286 * @see EnableVisual()
287 * @see Visual::Base::GetDepthIndex()
288 * @see Visual::Base::SetDepthIndex()
290 DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
293 * @brief Erase the entry matching the given index from the list of registered visuals
295 * @param[in] control The control
296 * @param[in] index The Property index of the visual, used to reference visual
298 DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index);
301 * @brief Retrieve the visual associated with the given property index.
303 * @param[in] control The control
304 * @param[in] index The Property index of the visual.
305 * @return The registered visual if exist, otherwise empty handle.
306 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
308 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index);
311 * @brief Sets the given visual to be displayed or not when parent staged.
313 * @param[in] control The control
314 * @param[in] index The Property index of the visual
315 * @param[in] enable flag to set enabled or disabled.
317 DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable);
320 * @brief Queries if the given visual is to be displayed when parent staged.
322 * @param[in] control The control
323 * @param[in] index The Property index of the visual
324 * @return bool whether visual is enabled or not
326 DALI_TOOLKIT_API bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index);
329 * @brief Add a transition effect on the control to the given animation
331 * Only generates an animator if the properties described in the transition
332 * data are staged (e.g. the visual is Enabled and the control is on stage).
333 * Otherwise the target values are stored, and will get set onto the properties
334 * when the visual is next staged.
336 * @param[in] control The control
337 * @param[in] animation The Animation to add valid transitions to
338 * @param[in] transitionData The transition data describing the effect to create
340 DALI_TOOLKIT_API void AddTransitions(Internal::Control& control,
341 Dali::Animation animation,
342 const Toolkit::TransitionData& transitionData);
345 * @brief Create a transition effect on the control.
347 * Only generates an animation if the properties described in the transition
348 * data are staged (e.g. the visual is Enabled and the control is on stage).
349 * Otherwise the target values are stored, and will get set onto the properties
350 * when the visual is next staged.
352 * @param[in] control The control
353 * @param[in] transitionData The transition data describing the effect to create
354 * @return A handle to an animation defined with the given effect, or an empty
355 * handle if no properties match.
357 DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control& control,
358 const Toolkit::TransitionData& transitionData);
361 * @brief Perform an action on a visual registered to this control.
363 * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
365 * @param[in] control The control.
366 * @param[in] visualIndex The Property index of the visual.
367 * @param[in] actionId The action to perform. See Visual to find supported actions.
368 * @param[in] attributes Optional attributes for the action.
370 DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
373 * @brief Perform an action on a visual registered to this control.
375 * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
377 * @param[in] control The control.
378 * @param[in] visualIndex The Property index of the visual.
379 * @param[in] actionId The action to perform. See Visual to find supported actions.
380 * @param[in] attributes Optional attributes for the action.
382 DALI_TOOLKIT_API void DoActionExtension(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes);
385 * @brief Set input method context.
387 * @param[in] control The control.
388 * @param[in] inputMethodContext The input method context.
390 DALI_TOOLKIT_API void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext);
393 * @brief Visual Event signal type
395 using VisualEventSignalType = Signal<void(Control, Dali::Property::Index, Dali::Property::Index)>;
398 * @brief This signal is emitted when a visual has an event to notify.
400 * A callback of the following type may be connected:
402 * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
404 * @return The signal to connect to
406 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
409 * @brief Retrieve the property object associated with the given property index and the visual property key.
411 * @param[in] control The control
412 * @param[in] index The Property index of the visual.
413 * @param[in] visualPropertyKey The key of the visual's property.
414 * @return The Property object
416 DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
419 * @brief The signal is emmited as a succession of "activate" signal send by accessibility client.
420 * @return The signal to connect to
422 DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control);
425 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
426 * was placed in TTS queue but other text with higher priority prevented it from being read.
428 * @return The signal to connect to
430 DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control);
435 * @return The signal to connect to
437 DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control);
442 * @return The signal to connect to
444 DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control);
447 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
448 * was placed in TTS queue and reading was started but other text with higher priority cancelled it.
450 * @return The signal to connect to
452 DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control);
455 * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say
456 * was fully read by TTS module.
458 * @return The signal to connect to
460 DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control);
463 * @brief The signal is emmited when accessibility client asks for object's name.
465 * Connected callback should assign name to std::string call parameter.
466 * Accessibility name can be stored in two ways:
468 * ACCESSIBILITY_NAME property,
469 * Priority is as above. If none is used, default implementation is provided.
470 * @return [description]
472 DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control);
475 * @brief The signal is emmited when accessibility client asks for object's description.
477 * Connected callback should assign description to std::string call parameter.
478 * Accessibility description can be stored in two ways:
480 * ACCESSIBILITY_DESCRIPTION property,
481 * Priority is as above. If none is used, default implementation is provided.
482 * @return signal handler
484 DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control);
487 * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism.
489 * This signal allows developers to serve incoming gesture in specific way.
490 * @return signal handler
492 DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control);
495 * @brief The method allows connection with other actor with usage of concrete accessibility relation type.
497 * @param control object to append attribute to
498 * @param destination Actor object
499 * @param relation enumerated value describing relation
501 DALI_TOOLKIT_API void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation);
504 * @brief The method allows removing relation
506 * @param control object to append attribute to
507 * @param destination Actor object
508 * @param relation enumerated value describing relation
510 DALI_TOOLKIT_API void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation);
513 * @brief Returns a collection of Accessible objects related to current object and grouped by relation type.
515 * @param control object to query
516 * @return collection of relations
518 * @see Dali::Accessibility::Accessible::GetRelationSet()
520 DALI_TOOLKIT_API std::vector<Accessibility::Relation> GetAccessibilityRelations(Toolkit::Control control);
523 * @brief The method removes all previously appended relations
525 * @param control object to append attribute to
527 DALI_TOOLKIT_API void ClearAccessibilityRelations(Toolkit::Control control);
530 * @brief The method allows to add or modify value matched with given key.
531 * Modification take place if key was previously set.
533 * @param control object to append attribute to
534 * @param key std::string value
535 * @param value std::string value
537 DALI_TOOLKIT_API void AppendAccessibilityAttribute(Toolkit::Control control, const std::string& key, const std::string& value);
540 * @brief The method erases key with its value from accessibility attributes
541 * @param control object to append attribute to
542 * @param key std::string value
544 DALI_TOOLKIT_API void RemoveAccessibilityAttribute(Toolkit::Control control, const std::string& key);
547 * @brief The method clears accessibility attributes
549 * @param control object to append attribute to
551 DALI_TOOLKIT_API void ClearAccessibilityAttributes(Toolkit::Control control);
554 * @brief The method inserts reading information of an accessible object into attributes
556 * @param control object to append attribute to
557 * @param types Reading information types
559 DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types);
562 * @brief The method returns reading information of an accessible object
564 * @param control object to append attribute to
565 * @return Reading information types
567 DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control);
570 * @brief The method erases highlight.
572 * @param control object to append attribute to
573 * @return bool value, false when it is not possible or something went wrong, at the other way true.
575 DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Toolkit::Control control);
578 * @brief The method grabs highlight.
580 * @param control object to append attribute to
581 * @return bool value, false when it is not possible or something went wrong, at the other way true.
583 DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Toolkit::Control control);
586 * @brief The metod presents bitset of control's states.
588 * @param control object to append attribute to
589 * @return Dali::Accessibility::States is vector of enumerated State.
591 DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Toolkit::Control control);
594 * @brief The method force sending notifications about current states to accessibility clients
596 * @param control object to append attribute to
597 * @param states mask with states expected to broadcast
598 * @param recurse flag pointing if notifications of children's state would be sent
600 DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse);
603 * @brief The method to get the control's accessibility created or not.
605 * @param[in] control object to append attribute to
606 * @return True if accessible were created. False otherwise.
608 DALI_TOOLKIT_API bool IsAccessibleCreated(Toolkit::Control control);
611 * @brief The method to set creatable of control's accessibility.
612 * @note This method doesn't remove that already created accessible.
614 * @param[in] control object to append attribute to
615 * @param[in] enable True if we allow to create accessible. False otherwise.
617 DALI_TOOLKIT_API void EnableCreateAccessible(Toolkit::Control control, bool enable);
620 * @brief The method to get creatable of control's accessibility.
622 * @param[in] control object to append attribute to
623 * @return True if we allow to create accessible. False otherwise.
625 DALI_TOOLKIT_API bool IsCreateAccessibleEnabled(Toolkit::Control control);
627 } // namespace DevelControl
629 } // namespace Toolkit
633 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H