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=fe95c7095da5627df77a41b5f7e9986c151ee2aa;hp=07b504012c9ddc8913f0ce89db707448e9dab5b4;hb=6da98d4f526029d51c8404964dd954afe9752401;hpb=3991c05d4e79ba65ef4d98895d015754e08b3750 diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index 07b5040..fe95c70 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) 2022 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. @@ -201,6 +201,28 @@ enum * @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 @@ -346,6 +368,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. @@ -474,12 +508,14 @@ DALI_TOOLKIT_API void AppendAccessibilityRelation(Toolkit::Control control, Dali 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(Toolkit::Control control); +DALI_TOOLKIT_API std::vector GetAccessibilityRelations(Toolkit::Control control); /** * @brief The method removes all previously appended relations @@ -561,25 +597,6 @@ DALI_TOOLKIT_API Dali::Accessibility::States GetAccessibilityStates(Toolkit::Con */ 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 - * - * 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. - * - * Possible usage can be as follows: - * @code - * SetAccessibilityConstructor( []( Dali::Actor actor ) { - return std::unique_ptr< Dali::Accessibility::Accessible >( - new ControlAccessible( 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); - } // namespace DevelControl } // namespace Toolkit