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=fcc563e6d284cdc718011a1a195b449ad0505ed8;hp=c9d13f2a4344be609c2eeff0e50d058767cbb643;hb=HEAD;hpb=d0b0cfa4a44953be9af9128885eb6ef5d83a214e diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index c9d13f2..465041a 100644 --- 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) 2021 Samsung Electronics Co., Ltd. + * Copyright (c) 2024 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,10 +18,13 @@ * */ // EXTERNAL INCLUDES -#include +#include #include +#include +#include // INTERNAL INCLUDES +#include #include #include @@ -172,11 +175,13 @@ enum * @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 @@ -184,11 +189,40 @@ enum ACCESSIBILITY_ATTRIBUTES, /** - * @brief Boolean flag describing object as animated - * @details Name "accessibilityAnimated", type Property::BOOLEAN - * @note Flag set to true will prevent BoundChanged accessibility signal from emiting + * @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. + * */ - ACCESSIBILITY_ANIMATED + 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 @@ -202,8 +236,7 @@ enum * * @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. + * @note depth-index be used to Dali::Toolkit::DepthIndex::Ranges::AUTO_INDEX. */ DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual); @@ -213,7 +246,9 @@ 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 * @param[in] visual The visual to register - * @param[in] depthIndex The visual's depth-index is set to this + * @param[in] depthIndex The visual's depth-index is set to this. If the depth-index is set to DepthIndex::Ranges::AUTO_INDEX, + * the actual depth-index of visual will be determind automatically (Use previous visuals depth-index, or placed on top of all other visuals.) + * Otherwise, the visual's depth-index is set to clamped value, between DepthIndex::Ranges::MINIMUM_DEPTH_INDEX and DepthIndex::Ranges::MAXIMUM_DEPTH_INDEX. * * @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. @@ -231,8 +266,7 @@ DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property: * @param[in] visual The visual to register * @param[in] enabled false if derived class wants to control when visual is set on stage. * - * @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. + * @note depth-index be used to Dali::Toolkit::DepthIndex::Ranges::AUTO_INDEX. * * @see EnableVisual() */ @@ -245,7 +279,9 @@ DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property: * @param[in] index The Property index of the visual, used to reference visual * @param[in] visual The visual to register * @param[in] enabled false if derived class wants to control when visual is set on stage. - * @param[in] depthIndex The visual's depth-index is set to this + * @param[in] depthIndex The visual's depth-index is set to this. If the depth-index is set to DepthIndex::Ranges::AUTO_INDEX, + * the actual depth-index of visual will be determind automatically (Use previous visuals depth-index, or placed on top of all other visuals.) + * Otherwise, the visual's depth-index is set to clamped value, between DepthIndex::Ranges::MINIMUM_DEPTH_INDEX and DepthIndex::Ranges::MAXIMUM_DEPTH_INDEX. * * @see EnableVisual() * @see Visual::Base::GetDepthIndex() @@ -334,6 +370,18 @@ DALI_TOOLKIT_API Dali::Animation CreateTransition(Internal::Control& DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes); /** + * @brief Perform an action on a visual registered to this control. + * + * Visuals will have actions, this API is used to perform one of these actions with the given attributes. + * + * @param[in] control The control. + * @param[in] visualIndex The Property index of the visual. + * @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 DoActionExtension(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes); + +/** * @brief Set input method context. * * @param[in] control The control. @@ -450,7 +498,7 @@ DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal( * @param destination Actor object * @param relation enumerated value describing relation */ -DALI_TOOLKIT_API void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation); +DALI_TOOLKIT_API void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation); /** * @brief The method allows removing relation @@ -459,22 +507,24 @@ DALI_TOOLKIT_API void AppendAccessibilityRelation(Dali::Actor control, Actor des * @param destination Actor object * @param relation enumerated value describing relation */ -DALI_TOOLKIT_API void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation); +DALI_TOOLKIT_API void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation); /** - * @brief The method returns collection accessibility addresses representing objects connected with current object + * @brief Returns a collection of Accessible objects related to current object and grouped by relation type. * - * @param control object to append attribute to - * @return std::vector, where index is casted value of Accessibility::RelationType and value is std::vector of type Accessibility::Address + * @param control object to query + * @return collection of relations + * + * @see Dali::Accessibility::Accessible::GetRelationSet() */ -DALI_TOOLKIT_API std::vector> GetAccessibilityRelations(Dali::Actor control); +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(Dali::Actor control); +DALI_TOOLKIT_API void ClearAccessibilityRelations(Toolkit::Control control); /** * @brief The method allows to add or modify value matched with given key. @@ -484,21 +534,21 @@ DALI_TOOLKIT_API void ClearAccessibilityRelations(Dali::Actor control); * @param key std::string value * @param value std::string value */ -DALI_TOOLKIT_API void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const 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(Dali::Actor control, const std::string& key); +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(Dali::Actor control); +DALI_TOOLKIT_API void ClearAccessibilityAttributes(Toolkit::Control control); /** * @brief The method inserts reading information of an accessible object into attributes @@ -506,7 +556,7 @@ DALI_TOOLKIT_API void ClearAccessibilityAttributes(Dali::Actor control); * @param control object to append attribute to * @param types Reading information types */ -DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types); +DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types); /** * @brief The method returns reading information of an accessible object @@ -514,7 +564,7 @@ DALI_TOOLKIT_API void SetAccessibilityReadingInfoType(Dali::Actor control, const * @param control object to append attribute to * @return Reading information types */ -DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control); +DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control); /** * @brief The method erases highlight. @@ -522,7 +572,7 @@ DALI_TOOLKIT_API Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingIn * @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(Dali::Actor control); +DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Toolkit::Control control); /** * @brief The method grabs highlight. @@ -530,7 +580,7 @@ DALI_TOOLKIT_API bool ClearAccessibilityHighlight(Dali::Actor control); * @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(Dali::Actor control); +DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Toolkit::Control control); /** * @brief The metod presents bitset of control's states. @@ -538,42 +588,41 @@ DALI_TOOLKIT_API bool GrabAccessibilityHighlight(Dali::Actor control); * @param control object to append attribute to * @return Dali::Accessibility::States is vector of enumerated State. */ -DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control); +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 doRecursive flag pointing if notifications of children's state would be sent + * @param states mask with states expected to broadcast + * @param recurse flag pointing if notifications of children's state would be sent */ -DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool doRecursive); +DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse); /** - * The method allows to set specific constructor for creating accessibility structure + * @brief The method to get the control's accessibility created or not. * - * Thank to this method hierarchy of accessibility objects can be based on internal hierarchy of Actors. - * It prevents from necessity of keeping two trees synchronized. - * The method should be called inside OnInitialize method of all classes inheriting from Control. + * @param[in] control object to append attribute to + * @return True if accessible were created. False otherwise. + */ +DALI_TOOLKIT_API bool IsAccessibleCreated(Toolkit::Control control); + +/** + * @brief The method to set creatable of control's accessibility. + * @note This method doesn't remove that already created accessible. * - * Possible usage can be as follows: - * @code - * SetAccessibilityConstructor( []( Dali::Actor actor ) { - return std::unique_ptr< Dali::Accessibility::Accessible >( - new AccessibleImpl( actor, Dali::Accessibility::Role::DIALOG, true ) ); - } ); - * @endcode - * - * param constructor callback creating Accessible object - */ -DALI_TOOLKIT_API void SetAccessibilityConstructor(Dali::Actor control, std::function(Dali::Actor)> constructor); + * @param[in] control object to append attribute to + * @param[in] enable True if we allow to create accessible. False otherwise. + */ +DALI_TOOLKIT_API void EnableCreateAccessible(Toolkit::Control control, bool enable); /** - * Returns accessibility object bound to actor, if any + * @brief The method to get creatable of control's accessibility. * - * This method won't bound new accessibility object. Use Dali::Accessibility::Accessible::Get in that case. + * @param[in] control object to append attribute to + * @return True if we allow to create accessible. False otherwise. */ -DALI_TOOLKIT_API Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control); +DALI_TOOLKIT_API bool IsCreateAccessibleEnabled(Toolkit::Control control); } // namespace DevelControl