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=c9d13f2a4344be609c2eeff0e50d058767cbb643;hb=a44d1f25dfb55db30bb839e4b30ae1f85b541118;hpb=d0b0cfa4a44953be9af9128885eb6ef5d83a214e diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index c9d13f2..3a94e1b 100644 --- a/dali-toolkit/devel-api/controls/control-devel.h +++ b/dali-toolkit/devel-api/controls/control-devel.h @@ -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 @@ -450,7 +484,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 +493,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 +520,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 +542,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 +550,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 +558,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 +566,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 +574,16 @@ 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 - */ -DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool doRecursive); - -/** - * 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 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); - -/** - * Returns accessibility object bound to actor, if any - * - * This method won't bound new accessibility object. Use Dali::Accessibility::Accessible::Get in that case. + * @param states mask with states expected to broadcast + * @param recurse flag pointing if notifications of children's state would be sent */ -DALI_TOOLKIT_API Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control); +DALI_TOOLKIT_API void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse); } // namespace DevelControl