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=88776462885386b798a9cce81d44e62c9e339691;hp=af6c76cc32824c4155fbd172b4b161b5ffe13db2;hb=90168515fb4b80ff64c068769420c0235a225d71;hpb=3b0dbb53f9e300e1dfc642d7040cf955b9c4b064 diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index af6c76c..8877646 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) 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. @@ -20,8 +20,11 @@ // EXTERNAL INCLUDES #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 { @@ -184,11 +187,11 @@ 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. */ - ACCESSIBILITY_ANIMATED + DISPATCH_KEY_EVENTS, }; } // namespace Property @@ -364,8 +367,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 +374,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 +382,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 +404,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 +412,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 +424,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 +436,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 +444,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 +453,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(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation); /** * @brief The method allows removing relation @@ -461,7 +462,7 @@ 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(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation); /** * @brief The method returns collection accessibility addresses representing objects connected with current object @@ -469,14 +470,14 @@ DALI_TOOLKIT_API void RemoveAccessibilityRelation( Dali::Actor control, Actor de * @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 */ -DALI_TOOLKIT_API std::vector> GetAccessibilityRelations( Dali::Actor control ); +DALI_TOOLKIT_API std::vector> GetAccessibilityRelations(Dali::Actor 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(Dali::Actor control); /** * @brief The method allows to add or modify value matched with given key. @@ -486,21 +487,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(Dali::Actor 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(Dali::Actor 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(Dali::Actor control); /** * @brief The method inserts reading information of an accessible object into attributes @@ -508,7 +509,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(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types); /** * @brief The method returns reading information of an accessible object @@ -516,7 +517,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(Dali::Actor control); /** * @brief The method erases highlight. @@ -524,7 +525,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(Dali::Actor control); /** * @brief The method grabs highlight. @@ -532,7 +533,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(Dali::Actor control); /** * @brief The metod presents bitset of control's states. @@ -540,16 +541,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(Dali::Actor 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 isRecursive 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(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive); /** * The method allows to set specific constructor for creating accessibility structure @@ -568,14 +569,14 @@ DALI_TOOLKIT_API void NotifyAccessibilityStateChange( Dali::Actor control, Dali: * * param constructor callback creating Accessible object */ -DALI_TOOLKIT_API void SetAccessibilityConstructor( Dali::Actor control, std::function(Dali::Actor)> constructor); +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. */ -DALI_TOOLKIT_API Dali::Accessibility::Accessible *GetBoundAccessibilityObject( Dali::Actor control ); +DALI_TOOLKIT_API Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control); } // namespace DevelControl