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=af6c76cc32824c4155fbd172b4b161b5ffe13db2;hb=6da98d4f526029d51c8404964dd954afe9752401;hpb=798ef5fa1591aa78851e9e3d08fe37411192176a diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index af6c76c..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) 2020 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. @@ -18,10 +18,13 @@ * */ // EXTERNAL INCLUDES -#include +#include #include +#include +#include // INTERNAL INCLUDES +#include #include #include @@ -39,31 +42,31 @@ class Base; namespace DevelControl { /// @brief AccessibilityActivate signal type. -typedef Signal< void ( ) > AccessibilityActivateSignalType; +typedef Signal AccessibilityActivateSignalType; /// @brief AccessibilityReadingSkipped signal type. -typedef Signal< void ( ) > AccessibilityReadingSkippedSignalType; +typedef Signal AccessibilityReadingSkippedSignalType; /// @brief AccessibilityReadingPaused signal type. -typedef Signal< void ( ) > AccessibilityReadingPausedSignalType; +typedef Signal AccessibilityReadingPausedSignalType; /// @brief AccessibilityReadingResumed signal type. -typedef Signal< void ( ) > AccessibilityReadingResumedSignalType; +typedef Signal AccessibilityReadingResumedSignalType; /// @brief AccessibilityReadingCancelled signal type. -typedef Signal< void ( ) > AccessibilityReadingCancelledSignalType; +typedef Signal AccessibilityReadingCancelledSignalType; /// @brief AccessibilityReadingStopped signal type. -typedef Signal< void ( ) > AccessibilityReadingStoppedSignalType; +typedef Signal AccessibilityReadingStoppedSignalType; /// @brief AccessibilityGetName signal type. -typedef Signal< void ( std::string& ) > AccessibilityGetNameSignalType; +typedef Signal AccessibilityGetNameSignalType; /// @brief AccessibilityGetDescription signal type. -typedef Signal< void ( std::string& ) > AccessibilityGetDescriptionSignalType; +typedef Signal AccessibilityGetDescriptionSignalType; /// @brief AccessibilityDoGesture signal type. -typedef Signal< void ( std::pair& ) > AccessibilityDoGestureSignalType; +typedef Signal&)> AccessibilityDoGestureSignalType; enum State { @@ -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_ANIMATED + 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 @@ -334,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. @@ -364,8 +410,6 @@ DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control); * @param[in] index The Property index of the visual. * @param[in] visualPropertyKey The key of the visual's property. * @return The Property object - * @pre The control should be added to the Scene. - * @pre The returned object is valid for as long as the control is on the Scene. */ DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey); @@ -373,7 +417,7 @@ DALI_TOOLKIT_API Dali::Property GetVisualProperty(Control control, Dali::Propert * @brief The signal is emmited as a succession of "activate" signal send by accessibility client. * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityActivateSignalType &AccessibilityActivateSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control); /** * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say @@ -381,21 +425,21 @@ DALI_TOOLKIT_API AccessibilityActivateSignalType &AccessibilityActivateSignal( T * * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType &AccessibilityReadingSkippedSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control); /** * @brief * * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityReadingPausedSignalType &AccessibilityReadingPausedSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control); /** * @brief * * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityReadingResumedSignalType &AccessibilityReadingResumedSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control); /** * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say @@ -403,7 +447,7 @@ DALI_TOOLKIT_API AccessibilityReadingResumedSignalType &AccessibilityReadingResu * * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType &AccessibilityReadingCancelledSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control); /** * @brief The signal is emmited when text send via Dali::Accessibility::Bridge::Say @@ -411,7 +455,7 @@ DALI_TOOLKIT_API AccessibilityReadingCancelledSignalType &AccessibilityReadingCa * * @return The signal to connect to */ -DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType &AccessibilityReadingStoppedSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control); /** * @brief The signal is emmited when accessibility client asks for object's name. @@ -423,7 +467,7 @@ DALI_TOOLKIT_API AccessibilityReadingStoppedSignalType &AccessibilityReadingStop * Priority is as above. If none is used, default implementation is provided. * @return [description] */ -DALI_TOOLKIT_API AccessibilityGetNameSignalType &AccessibilityGetNameSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control); /** * @brief The signal is emmited when accessibility client asks for object's description. @@ -435,7 +479,7 @@ DALI_TOOLKIT_API AccessibilityGetNameSignalType &AccessibilityGetNameSignal( Too * Priority is as above. If none is used, default implementation is provided. * @return signal handler */ -DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType &AccessibilityGetDescriptionSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control); /** * @brief The signal is emitted when accessibility client call "DoGesture" method via IPC mechanism. @@ -443,7 +487,7 @@ DALI_TOOLKIT_API AccessibilityGetDescriptionSignalType &AccessibilityGetDescript * This signal allows developers to serve incoming gesture in specific way. * @return signal handler */ -DALI_TOOLKIT_API AccessibilityDoGestureSignalType &AccessibilityDoGestureSignal( Toolkit::Control control ); +DALI_TOOLKIT_API AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control); /** * @brief The method allows connection with other actor with usage of concrete accessibility relation type. @@ -452,7 +496,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 @@ -461,22 +505,24 @@ DALI_TOOLKIT_API void AppendAccessibilityRelation( Dali::Actor control, Actor de * @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. @@ -486,21 +532,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 @@ -508,7 +554,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 @@ -516,7 +562,7 @@ DALI_TOOLKIT_API void SetAccessibilityReadingInfoType( Dali::Actor control, cons * @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. @@ -524,7 +570,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. @@ -532,7 +578,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. @@ -540,42 +586,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