X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fcontrol-devel.h;h=3a94e1b6c58e2a64e30db035c114e9d050d3e7b3;hp=dad426f9d7a33fe0641a61fe7a8ed7c25b240dbf;hb=a44d1f25dfb55db30bb839e4b30ae1f85b541118;hpb=6a945b790dae35b878e88f25ca19d69d6e2e6d46 diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h old mode 100755 new mode 100644 index dad426f..3a94e1b --- a/dali-toolkit/devel-api/controls/control-devel.h +++ b/dali-toolkit/devel-api/controls/control-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_CONTROL_DEVEL_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,19 +18,20 @@ * */ // EXTERNAL INCLUDES +#include #include +#include +#include // INTERNAL INCLUDES -#include +#include #include -#include +#include namespace Dali { - namespace Toolkit { - class TransitionData; namespace Visual @@ -40,6 +41,32 @@ class Base; namespace DevelControl { +/// @brief AccessibilityActivate signal type. +typedef Signal AccessibilityActivateSignalType; + +/// @brief AccessibilityReadingSkipped signal type. +typedef Signal AccessibilityReadingSkippedSignalType; + +/// @brief AccessibilityReadingPaused signal type. +typedef Signal AccessibilityReadingPausedSignalType; + +/// @brief AccessibilityReadingResumed signal type. +typedef Signal AccessibilityReadingResumedSignalType; + +/// @brief AccessibilityReadingCancelled signal type. +typedef Signal AccessibilityReadingCancelledSignalType; + +/// @brief AccessibilityReadingStopped signal type. +typedef Signal AccessibilityReadingStoppedSignalType; + +/// @brief AccessibilityGetName signal type. +typedef Signal AccessibilityGetNameSignalType; + +/// @brief AccessibilityGetDescription signal type. +typedef Signal AccessibilityGetDescriptionSignalType; + +/// @brief AccessibilityDoGesture signal type. +typedef Signal&)> AccessibilityDoGestureSignalType; enum State { @@ -50,16 +77,13 @@ enum State namespace Property { - enum { - STYLE_NAME = Control::Property::STYLE_NAME, - BACKGROUND_COLOR = Control::Property::BACKGROUND_COLOR, - BACKGROUND_IMAGE = Control::Property::BACKGROUND_IMAGE, - KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS, - BACKGROUND = Control::Property::BACKGROUND, - MARGIN = Control::Property::MARGIN, - PADDING = Control::Property::PADDING, + STYLE_NAME = Control::Property::STYLE_NAME, + KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS, + BACKGROUND = Control::Property::BACKGROUND, + MARGIN = Control::Property::MARGIN, + PADDING = Control::Property::PADDING, /** * @brief Displays a tooltip when the control is hovered over. @@ -116,7 +140,89 @@ enum * @details Name "downFocusableActorId", type Property::INTEGER. * */ - DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7 + DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7, + + /** + * @brief The shadow of the control. + * @details Name "shadow", type Property::MAP. + */ + SHADOW = PADDING + 8, + + /** + * @brief The name of object visible in accessibility tree. + * @details Name "accessibilityName", type Property::STRING. + */ + ACCESSIBILITY_NAME, + + /** + * @brief The description of object visible in accessibility tree. + * @details Name "accessibilityDescription", type Property::STRING. + */ + ACCESSIBILITY_DESCRIPTION, + + /** + * @brief Current translation domain for accessibility clients. + * @details Name "accessibilityTranslationDomain", type Property::STRING. + */ + ACCESSIBILITY_TRANSLATION_DOMAIN, + + /** + * @brief Role being performed in accessibility hierarchy. + * @details Name "accessibilityRole", type Property::INTEGER. + * @note Property is stored as INTEGER, however its interpretaton + * depend on enumeration Dali::Accessibility::Role and should be read and written + * with usage of enumerated values. + * @see Dali::Accessibility::Role + */ + ACCESSIBILITY_ROLE, + + /** + * @brief Mark of able to highlight object. + * @details Name "accessibilityHighlightable", type Property::BOOLEAN. + */ + ACCESSIBILITY_HIGHLIGHTABLE, + + /** + * @brief Set of accessibility attributes describing object in accessibility hierarchy + * @details Name "accessibilityAttributes", type Property::MAP + */ + ACCESSIBILITY_ATTRIBUTES, + + /** + * @brief Whether a Control and its descendants can emit key signals. + * @details Name "dispatchKeyEvents", type Property::BOOLEAN + * @note If a control's dispatchKeyEvents is set to false, then it's children will not emit a key event signal either. + */ + DISPATCH_KEY_EVENTS, + + /** + * @brief Marks the object as invisible to AT-SPI clients. + * @details Name "accessibilityHidden", type Property::BOOLEAN. + * @note The representative Accessible object will not appear in the AT-SPI tree. + */ + ACCESSIBILITY_HIDDEN, + + /** + * @brief The actor ID of the clockwise focusable control. + * @details Name "clockwiseFocusableActorId", type Property::INTEGER. + * + */ + CLOCKWISE_FOCUSABLE_ACTOR_ID, + + /** + * @brief The actor ID of the conter-clockwise focusable control. + * @details Name "counterClockwiseFocusableActorId", type Property::INTEGER. + * + */ + COUNTER_CLOCKWISE_FOCUSABLE_ACTOR_ID, + + /** + * @brief Identifier that allows the automation framework to find and interact with this element. + * @details Name "automationId", type Property::STRING. + * @note This is a string identifier (compared to @c Actor::Property::ID which is an integer). + * It will also appear in the AT-SPI tree under the key "automationId". + */ + AUTOMATION_ID, }; } // namespace Property @@ -128,12 +234,12 @@ enum * @param[in] index The Property index of the visual, used to reference visual * @param[in] visual The visual to register * - * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. + * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. * Use below API with enabled set to false if derived class wishes to control when visual is staged. * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals. * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual. */ -DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual ); +DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual); /** * @brief Register a visual by Property Index with a depth index. @@ -143,13 +249,13 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property * @param[in] visual The visual to register * @param[in] depthIndex The visual's depth-index is set to this * - * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. + * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. * Use below API with enabled set to false if derived class wishes to control when visual is staged. * * @see Visual::Base::GetDepthIndex() * @see Visual::Base::SetDepthIndex() */ -DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex ); +DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex); /** * @brief Register a visual by Property Index with the option of enabling/disabling it. @@ -164,7 +270,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property * * @see EnableVisual() */ -DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled ); +DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled); /** * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it. @@ -179,7 +285,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property * @see Visual::Base::GetDepthIndex() * @see Visual::Base::SetDepthIndex() */ -DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex ); +DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex); /** * @brief Erase the entry matching the given index from the list of registered visuals @@ -187,7 +293,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property * @param[in] control The control * @param[in] index The Property index of the visual, used to reference visual */ -DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index ); +DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index); /** * @brief Retrieve the visual associated with the given property index. @@ -197,7 +303,7 @@ DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Proper * @return The registered visual if exist, otherwise empty handle. * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count. */ -DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index ); +DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index); /** * @brief Sets the given visual to be displayed or not when parent staged. @@ -206,7 +312,7 @@ DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& contr * @param[in] index The Property index of the visual * @param[in] enable flag to set enabled or disabled. */ -DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable ); +DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable); /** * @brief Queries if the given visual is to be displayed when parent staged. @@ -215,8 +321,7 @@ DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property:: * @param[in] index The Property index of the visual * @return bool whether visual is enabled or not */ -DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index ); - +DALI_TOOLKIT_API bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index); /** * @brief Add a transition effect on the control to the given animation @@ -230,9 +335,9 @@ DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::P * @param[in] animation The Animation to add valid transitions to * @param[in] transitionData The transition data describing the effect to create */ -DALI_TOOLKIT_API void AddTransitions( Internal::Control& control, - Dali::Animation animation, - const Toolkit::TransitionData& transitionData ); +DALI_TOOLKIT_API void AddTransitions(Internal::Control& control, + Dali::Animation animation, + const Toolkit::TransitionData& transitionData); /** * @brief Create a transition effect on the control. @@ -247,8 +352,8 @@ DALI_TOOLKIT_API void AddTransitions( Internal::Control& control, * @return A handle to an animation defined with the given effect, or an empty * handle if no properties match. */ -DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control, - const Toolkit::TransitionData& transitionData ); +DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control& control, + const Toolkit::TransitionData& transitionData); /** * @brief Perform an action on a visual registered to this control. @@ -260,7 +365,7 @@ DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control, * @param[in] actionId The action to perform. See Visual to find supported actions. * @param[in] attributes Optional attributes for the action. */ -DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes ); +DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes); /** * @brief Set input method context. @@ -268,81 +373,217 @@ DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIn * @param[in] control The control. * @param[in] inputMethodContext The input method context. */ -DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext ); +DALI_TOOLKIT_API void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext); /** - * @brief Get the layout associated with this control, if any. + * @brief Visual Event signal type + */ +using VisualEventSignalType = Signal; + +/** + * @brief This signal is emitted when a visual has an event to notify. * - * @return A handle to the layout, or empty. + * A callback of the following type may be connected: + * @code + * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId ); + * @endcode + * @return The signal to connect to */ -DALI_TOOLKIT_API Toolkit::LayoutItem GetLayout( Internal::Control& control ); +DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control); /** - * @brief Get the layout associated with a control, if any. + * @brief Retrieve the property object associated with the given property index and the visual property key. * - * @return A handle to the layout, or empty. + * @param[in] control The control + * @param[in] index The Property index of the visual. + * @param[in] visualPropertyKey The key of the visual's property. + * @return The Property object + */ +DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey); + +/** + * @brief The signal is emmited as a succession of "activate" signal send by accessibility client. + * @return The signal to connect to */ -DALI_TOOLKIT_API Toolkit::LayoutItem GetLayout( Control control ); +DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control); /** - * @brief Set the layout on this control. + * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say + * was placed in TTS queue but other text with higher priority prevented it from being read. * - * @param[in] control The internal Control to set the layout on - * @param[in] layout Pointer to the layout - * @note Providing an empty layout will remove the current layout and - * replace it with a BinLayout. - * Setting a layout that has already been set will result in the - * original control becoming a BinLayout. Two Controls can not share - * the same layout. + * @return The signal to connect to */ -DALI_TOOLKIT_API void SetLayout( Internal::Control& control, Toolkit::LayoutItem layout ); +DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control); /** - * @brief Set the layout on a control. + * @brief * - * @param[in] control The Control to set the layout on - * @param[in] layout Pointer to the layout - * @note Providing an empty layout will remove the current layout and - * replace it with a BinLayout. + * @return The signal to connect to */ -DALI_TOOLKIT_API void SetLayout( Control control, Toolkit::LayoutItem layout ); +DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control); /** - * @brief Request the control layout. + * @brief * - * @param[in] control The internal Control to request the layout of + * @return The signal to connect to */ -DALI_TOOLKIT_API void RequestLayout( Internal::Control& control ); +DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control); /** - * @brief Set whether the control should have a layout - * @param[in] control The Control to set the behaviour on - * @param[in] layoutingRequired true if the control should have a layout + * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say + * was placed in TTS queue and reading was started but other text with higher priority cancelled it. + * + * @return The signal to connect to */ -DALI_TOOLKIT_API void SetLayoutingRequired( Control control, bool layoutingRequired ); +DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control); /** - * @brief Check if the control has been set to require layouting - * @param[in] control The Control to query - * @return true if the control needs layouting + * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say + * was fully read by TTS module. + * + * @return The signal to connect to */ -DALI_TOOLKIT_API bool IsLayoutingRequired( Control control ); +DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control); /** - * @brief Visual Event signal type + * @brief The signal is emmited when accessibility client asks for object's name. + * + * Connected callback should assign name to std::string call parameter. + * Accessibility name can be stored in two ways: + * this signal, + * ACCESSIBILITY_NAME property, + * Priority is as above. If none is used, default implementation is provided. + * @return [description] */ -using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >; +DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control); /** - * @brief This signal is emitted when a visual has an event to notify. + * @brief The signal is emmited when accessibility client asks for object's description. * - * A callback of the following type may be connected: - * @code - * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId ); - * @endcode - * @return The signal to connect to + * Connected callback should assign description to std::string call parameter. + * Accessibility description can be stored in two ways: + * this signal, + * ACCESSIBILITY_DESCRIPTION property, + * Priority is as above. If none is used, default implementation is provided. + * @return signal handler + */ +DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control); + +/** + * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism. + * + * This signal allows developers to serve incoming gesture in specific way. + * @return signal handler + */ +DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control); + +/** + * @brief The method allows connection with other actor with usage of concrete accessibility relation type. + * + * @param control object to append attribute to + * @param destination Actor object + * @param relation enumerated value describing relation + */ +DALI_TOOLKIT_API void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation); + +/** + * @brief The method allows removing relation + * + * @param control object to append attribute to + * @param destination Actor object + * @param relation enumerated value describing relation + */ +DALI_TOOLKIT_API void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation); + +/** + * @brief Returns a collection of Accessible objects related to current object and grouped by relation type. + * + * @param control object to query + * @return collection of relations + * + * @see Dali::Accessibility::Accessible::GetRelationSet() + */ +DALI_TOOLKIT_API std::vector GetAccessibilityRelations(Toolkit::Control control); + +/** + * @brief The method removes all previously appended relations + * + * @param control object to append attribute to + */ +DALI_TOOLKIT_API void ClearAccessibilityRelations(Toolkit::Control control); + +/** + * @brief The method allows to add or modify value matched with given key. + * Modification take place if key was previously set. + * + * @param control object to append attribute to + * @param key std::string value + * @param value std::string value + */ +DALI_TOOLKIT_API void AppendAccessibilityAttribute(Toolkit::Control control, const std::string& key, const std::string& value); + +/** + * @brief The method erases key with its value from accessibility attributes + * @param control object to append attribute to + * @param key std::string value + */ +DALI_TOOLKIT_API void RemoveAccessibilityAttribute(Toolkit::Control control, const std::string& key); + +/** + * @brief The method clears accessibility attributes + * + * @param control object to append attribute to + */ +DALI_TOOLKIT_API void ClearAccessibilityAttributes(Toolkit::Control control); + +/** + * @brief The method inserts reading information of an accessible object into attributes + * + * @param control object to append attribute to + * @param types Reading information types + */ +DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types); + +/** + * @brief The method returns reading information of an accessible object + * + * @param control object to append attribute to + * @return Reading information types + */ +DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control); + +/** + * @brief The method erases highlight. + * + * @param control object to append attribute to + * @return bool value, false when it is not possible or something went wrong, at the other way true. + */ +DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Toolkit::Control control); + +/** + * @brief The method grabs highlight. + * + * @param control object to append attribute to + * @return bool value, false when it is not possible or something went wrong, at the other way true. + */ +DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Toolkit::Control control); + +/** + * @brief The metod presents bitset of control's states. + * + * @param control object to append attribute to + * @return Dali::Accessibility::States is vector of enumerated State. + */ +DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Toolkit::Control control); + +/** + * @brief The method force sending notifications about current states to accessibility clients + * + * @param control object to append attribute to + * @param states mask with states expected to broadcast + * @param recurse flag pointing if notifications of children's state would be sent */ -DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control ); +DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse); } // namespace DevelControl