From: Artur Świgoń Date: Fri, 18 Feb 2022 09:43:26 +0000 (+0100) Subject: [AT-SPI] Change DevelControl functions' first parameter to Control X-Git-Tag: dali_2.1.14~7 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=e051e39fe89448c656713c8b9a2594e1b92c870e [AT-SPI] Change DevelControl functions' first parameter to Control These functions did nothing for non-Control actors anyway. It is better to narrow down the parameter type to a Control, especially since they are in the DevelControl namespace. As a special exception, SetAccessibilityConstructor() retains its Actor parameter, because changing that would require too many changes, and we intend to replace it with a virtual method very soon anyway. Change-Id: I0b5939dd9fc0933841cd36b6833aeff668d2ab30 --- diff --git a/dali-toolkit/devel-api/controls/control-devel.cpp b/dali-toolkit/devel-api/controls/control-devel.cpp index 5ab6b79..a98cefe 100644 --- a/dali-toolkit/devel-api/controls/control-devel.cpp +++ b/dali-toolkit/devel-api/controls/control-devel.cpp @@ -28,6 +28,17 @@ #include #include +namespace +{ +Dali::Toolkit::Internal::Control::Impl& GetControlImplementation(Dali::Toolkit::Control control) +{ + auto& internalControl = Dali::Toolkit::Internal::GetImplementation(control); + + return Dali::Toolkit::Internal::Control::Impl::Get(internalControl); +} + +} // unnamed namespace + namespace Dali { namespace Toolkit @@ -122,219 +133,151 @@ Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, D return controlDataImpl.GetVisualProperty(index, visualPropertyKey); } -static Toolkit::Internal::Control::Impl* GetControlImplementation(Dali::Actor actor) -{ - Dali::Toolkit::Control control = Toolkit::Control::DownCast(actor); - if(control) - { - auto& internalControl = Toolkit::Internal::GetImplementation(control); - auto& controlDataImpl = Toolkit::Internal::Control::Impl::Get(internalControl); - return &controlDataImpl; - } - return nullptr; -} - Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityActivateSignal; + return GetControlImplementation(control).mAccessibilityActivateSignal; } Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityReadingSkippedSignal; + return GetControlImplementation(control).mAccessibilityReadingSkippedSignal; } Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityReadingPausedSignal; + return GetControlImplementation(control).mAccessibilityReadingPausedSignal; } Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityReadingResumedSignal; + return GetControlImplementation(control).mAccessibilityReadingResumedSignal; } Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityReadingCancelledSignal; + return GetControlImplementation(control).mAccessibilityReadingCancelledSignal; } Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityReadingStoppedSignal; + return GetControlImplementation(control).mAccessibilityReadingStoppedSignal; } Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityGetNameSignal; + return GetControlImplementation(control).mAccessibilityGetNameSignal; } Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityGetDescriptionSignal; + return GetControlImplementation(control).mAccessibilityGetDescriptionSignal; } Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control) { - return GetControlImplementation(control)->mAccessibilityDoGestureSignal; + return GetControlImplementation(control).mAccessibilityDoGestureSignal; } -void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation) +void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation) { - if(auto controlDataImpl = GetControlImplementation(control)) + if(auto destinationAccessible = Accessibility::Accessible::Get(destination)) { - auto object = controlDataImpl->GetAccessibilityObject(destination); - if(object) - { - controlDataImpl->mAccessibilityRelations[relation].insert(object); - } + GetControlImplementation(control).mAccessibilityRelations[relation].insert(destinationAccessible); } } -void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation) +void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation) { - if(auto controlDataImpl = GetControlImplementation(control)) + if(auto destinationAccessible = Accessibility::Accessible::Get(destination)) { - auto object = controlDataImpl->GetAccessibilityObject(destination); - if(object) - { - auto& relations = controlDataImpl->mAccessibilityRelations; + auto& relations = GetControlImplementation(control).mAccessibilityRelations; - relations[relation].erase(object); + relations[relation].erase(destinationAccessible); - if(relations[relation].empty()) - { - relations.erase(relation); - } + if(relations[relation].empty()) + { + relations.erase(relation); } } } -std::vector> GetAccessibilityRelations(Dali::Actor control) +std::vector> GetAccessibilityRelations(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - std::vector> result(static_cast(Accessibility::RelationType::MAX_COUNT)); + std::vector> result(static_cast(Accessibility::RelationType::MAX_COUNT)); - // Map every Accessible* to its Address - for(auto& relation : controlDataImpl->mAccessibilityRelations) - { - auto index = static_cast(relation.first); - auto& targets = relation.second; - - std::transform(targets.begin(), targets.end(), std::back_inserter(result[index]), [](auto* x) { - return x->GetAddress(); - }); - } + // Map every Accessible* to its Address + for(auto& relation : GetControlImplementation(control).mAccessibilityRelations) + { + auto index = static_cast(relation.first); + auto& targets = relation.second; - return result; + std::transform(targets.begin(), targets.end(), std::back_inserter(result[index]), [](auto* x) { + return x->GetAddress(); + }); } - return {}; + return result; } -void ClearAccessibilityRelations(Dali::Actor control) +void ClearAccessibilityRelations(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->mAccessibilityRelations.clear(); - } + GetControlImplementation(control).mAccessibilityRelations.clear(); } void SetAccessibilityConstructor(Dali::Actor control, std::function(Dali::Actor)> constructor) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->mAccessibilityConstructor = constructor; - } + GetControlImplementation(Toolkit::Control::DownCast(control)).mAccessibilityConstructor = constructor; } -void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value) +void AppendAccessibilityAttribute(Toolkit::Control control, const std::string& key, const std::string& value) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->AppendAccessibilityAttribute(key, value); - } + GetControlImplementation(control).AppendAccessibilityAttribute(key, value); } -void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key) +void RemoveAccessibilityAttribute(Toolkit::Control control, const std::string& key) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->RemoveAccessibilityAttribute(key); - } + GetControlImplementation(control).RemoveAccessibilityAttribute(key); } -void ClearAccessibilityAttributes(Dali::Actor control) +void ClearAccessibilityAttributes(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->ClearAccessibilityAttributes(); - } + GetControlImplementation(control).ClearAccessibilityAttributes(); } -void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types) +void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->SetAccessibilityReadingInfoType(types); - } + GetControlImplementation(control).SetAccessibilityReadingInfoType(types); } -Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control) +Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - return controlDataImpl->GetAccessibilityReadingInfoType(); - } - return {}; + return GetControlImplementation(control).GetAccessibilityReadingInfoType(); } -bool ClearAccessibilityHighlight(Dali::Actor control) +bool ClearAccessibilityHighlight(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - auto object = dynamic_cast(controlDataImpl->GetAccessibilityObject()); - if(object) - { - return object->ClearHighlight(); - } - } - return false; + auto* accessible = Dali::Accessibility::Component::DownCast(GetControlImplementation(control).GetAccessibilityObject()); + + return accessible ? accessible->ClearHighlight() : false; } -bool GrabAccessibilityHighlight(Dali::Actor control) +bool GrabAccessibilityHighlight(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - auto object = dynamic_cast(controlDataImpl->GetAccessibilityObject()); - if(object) - { - return object->GrabHighlight(); - } - } - return false; + auto* accessible = Dali::Accessibility::Component::DownCast(GetControlImplementation(control).GetAccessibilityObject()); + + return accessible ? accessible->GrabHighlight() : false; } -Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control) +Dali::Accessibility::States GetAccessibilityStates(Toolkit::Control control) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - auto object = dynamic_cast(controlDataImpl->GetAccessibilityObject()); - if(object) - { - return object->GetStates(); - } - } - return {}; + auto* accessible = GetControlImplementation(control).GetAccessibilityObject(); + + return accessible->GetStates(); } -void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive) +void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse) { - if(auto controlDataImpl = GetControlImplementation(control)) - { - controlDataImpl->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), isRecursive); - } + GetControlImplementation(control).GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), recurse); } } // namespace DevelControl diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index b188b9b..07b5040 100644 --- a/dali-toolkit/devel-api/controls/control-devel.h +++ b/dali-toolkit/devel-api/controls/control-devel.h @@ -462,7 +462,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 @@ -471,7 +471,7 @@ 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 @@ -479,14 +479,14 @@ DALI_TOOLKIT_API void RemoveAccessibilityRelation(Dali::Actor control, Actor des * @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(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. @@ -496,21 +496,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 @@ -518,7 +518,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 @@ -526,7 +526,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. @@ -534,7 +534,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. @@ -542,7 +542,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. @@ -550,16 +550,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 isRecursive 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 isRecursive); +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 diff --git a/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.cpp b/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.cpp index 6337f59..adc2fa0 100644 --- a/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.cpp +++ b/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.cpp @@ -80,27 +80,37 @@ std::string AccessibilityManager::GetAccessibilityAttribute(Actor actor, Toolkit void AccessibilityManager::SetFocusOrder(Actor actor, const unsigned int order) { - if(order == 0) + auto control = Toolkit::Control::DownCast(actor); + + if(!control || order == 0) + { return; + } if(order >= mFocusOrder.size()) + { mFocusOrder.resize(order + 1); + } auto it = mFocusOrder.begin() + order; - mFocusOrder.insert(it, actor); + mFocusOrder.insert(it, control); if(order > 0) { - Actor prev = mFocusOrder[order - 1]; - DevelControl::AppendAccessibilityRelation(prev, actor, Accessibility::RelationType::FLOWS_TO); - DevelControl::AppendAccessibilityRelation(actor, prev, Accessibility::RelationType::FLOWS_FROM); + if(auto prev = mFocusOrder[order - 1]) + { + DevelControl::AppendAccessibilityRelation(prev, control, Accessibility::RelationType::FLOWS_TO); + DevelControl::AppendAccessibilityRelation(control, prev, Accessibility::RelationType::FLOWS_FROM); + } } if(order + 1 < mFocusOrder.size()) { - Actor next = mFocusOrder[order + 1]; - DevelControl::AppendAccessibilityRelation(actor, next, Accessibility::RelationType::FLOWS_TO); - DevelControl::AppendAccessibilityRelation(next, actor, Accessibility::RelationType::FLOWS_FROM); + if(auto next = mFocusOrder[order + 1]) + { + DevelControl::AppendAccessibilityRelation(control, next, Accessibility::RelationType::FLOWS_TO); + DevelControl::AppendAccessibilityRelation(next, control, Accessibility::RelationType::FLOWS_FROM); + } } } @@ -132,7 +142,13 @@ Actor AccessibilityManager::GetActorByFocusOrder(const unsigned int order) bool AccessibilityManager::SetCurrentFocusActor(Actor actor) { - return Toolkit::DevelControl::GrabAccessibilityHighlight(actor); + auto control = Toolkit::Control::DownCast(actor); + if(!control) + { + return false; + } + + return Toolkit::DevelControl::GrabAccessibilityHighlight(control); } Actor AccessibilityManager::GetCurrentFocusActor() @@ -178,8 +194,13 @@ bool AccessibilityManager::MoveFocusBackward() void AccessibilityManager::ClearFocus() { - auto actor = GetCurrentFocusActor(); - Toolkit::DevelControl::ClearAccessibilityHighlight(actor); + auto control = Toolkit::Control::DownCast(GetCurrentFocusActor()); + if(!control) + { + return; + } + + Toolkit::DevelControl::ClearAccessibilityHighlight(control); } void AccessibilityManager::Reset() @@ -188,11 +209,14 @@ void AccessibilityManager::Reset() for(std::size_t i = 2; i < mFocusOrder.size(); ++i) { - Actor prev = mFocusOrder[i - 1]; - Actor next = mFocusOrder[i]; - - DevelControl::RemoveAccessibilityRelation(prev, next, Accessibility::RelationType::FLOWS_TO); - DevelControl::RemoveAccessibilityRelation(next, prev, Accessibility::RelationType::FLOWS_FROM); + auto prev = mFocusOrder[i - 1]; + auto next = mFocusOrder[i]; + + if(prev && next) + { + DevelControl::RemoveAccessibilityRelation(prev, next, Accessibility::RelationType::FLOWS_TO); + DevelControl::RemoveAccessibilityRelation(next, prev, Accessibility::RelationType::FLOWS_FROM); + } } mFocusOrder.clear(); diff --git a/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.h b/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.h index 97da737..9470d05 100644 --- a/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.h +++ b/dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.h @@ -25,6 +25,7 @@ // INTERNAL INCLUDES #include +#include namespace Dali { @@ -406,7 +407,7 @@ private: AccessibilityManager& operator=(const AccessibilityManager& rhs); private: - std::vector mFocusOrder; + std::vector mFocusOrder; Toolkit::AccessibilityManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change Toolkit::AccessibilityManager::FocusOvershotSignalType mFocusOvershotSignal; ///< The signal to notify the focus overshooted diff --git a/dali-toolkit/internal/controls/popup/popup-impl.cpp b/dali-toolkit/internal/controls/popup/popup-impl.cpp index 5331e74..f811812 100644 --- a/dali-toolkit/internal/controls/popup/popup-impl.cpp +++ b/dali-toolkit/internal/controls/popup/popup-impl.cpp @@ -343,7 +343,7 @@ void Popup::OnInitialize() SetupTouch(); - DevelControl::AppendAccessibilityAttribute(self, "sub-role", "Alert"); + DevelControl::AppendAccessibilityAttribute(Toolkit::Control::DownCast(self), "sub-role", "Alert"); DevelControl::SetAccessibilityConstructor(self, [](Dali::Actor actor) { return std::unique_ptr(new AccessibleImpl(actor, Dali::Accessibility::Role::DIALOG, true)); diff --git a/dali-toolkit/public-api/controls/control-impl.cpp b/dali-toolkit/public-api/controls/control-impl.cpp index 4ad7103..afb2bf9 100644 --- a/dali-toolkit/public-api/controls/control-impl.cpp +++ b/dali-toolkit/public-api/controls/control-impl.cpp @@ -432,7 +432,7 @@ void Control::Initialize() if(type) { auto typeName = type.GetName(); - DevelControl::AppendAccessibilityAttribute(Self(), "class", typeName); + DevelControl::AppendAccessibilityAttribute(Toolkit::Control::DownCast(Self()), "class", typeName); } }