1 #ifndef DALI_TOOLKIT_CONTROL_ACCESSIBLE_H
2 #define DALI_TOOLKIT_CONTROL_ACCESSIBLE_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/adaptor-framework/accessibility.h>
23 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
24 #include <dali/devel-api/adaptor-framework/actor-accessible.h>
25 #include <dali/devel-api/atspi-interfaces/action.h>
26 #include <dali/public-api/object/weak-handle.h>
29 #include <dali-toolkit/public-api/dali-toolkit-common.h>
31 namespace Dali::Toolkit::DevelControl {
34 * @brief Represents the Accessible object for Dali::Toolkit::Control and derived classes
36 * You can create a derived class (and register it using SetAccessibilityConstructor)
37 * in order to customize Accessibility for a given control.
39 * @see Dali::Toolkit::DevelControl::SetAccessibilityConstructor
40 * @see Dali::Accessibility::Accessible
41 * @see Dali::Accessibility::Component
42 * @see Dali::Accessibility::Collection
43 * @see Dali::Accessibility::Action
44 * @see Dali::Accessibility::Value
45 * @see Dali::Accessibility::Text
46 * @see Dali::Accessibility::EditableText
48 struct DALI_TOOLKIT_API ControlAccessible : public Dali::Accessibility::ActorAccessible,
49 public virtual Dali::Accessibility::Action
52 Vector2 mLastPosition{0.0f, 0.0f};
53 Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
54 bool mIsModal = false;
60 * @brief Register property notification to check highlighted object position
62 void RegisterPositionPropertyNotification();
65 * @brief Remove property notification added by RegisterPropertyNotification
67 void UnregisterPositionPropertyNotification();
70 * @brief Check if the actor is showing
71 * @return True if the actor is showing
76 ControlAccessible(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
79 * @copydoc Dali::Accessibility::Accessible::GetName()
81 std::string GetName() const override;
84 * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
86 virtual std::string GetNameRaw() const;
89 * @copydoc Dali::Accessibility::Accessible::GetDescription()
91 std::string GetDescription() const override;
94 * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
96 virtual std::string GetDescriptionRaw() const;
99 * @copydoc Dali::Accessibility::Accessible::GetRole()
101 Dali::Accessibility::Role GetRole() const override;
104 * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
106 std::string GetLocalizedRoleName() const override;
109 * @copydoc Dali::Accessibility::Accessible::GetStates()
111 Dali::Accessibility::States GetStates() override;
114 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
116 Dali::Accessibility::Attributes GetAttributes() const override;
119 * @copydoc Dali::Accessibility::Accessible::IsHidden()
121 bool IsHidden() const override;
124 * @copydoc Dali::Accessibility::Component::GrabFocus()
126 bool GrabFocus() override;
129 * @copydoc Dali::Accessibility::Component::GrabHighlight()
131 bool GrabHighlight() override;
134 * @copydoc Dali::Accessibility::Component::ClearHighlight()
136 bool ClearHighlight() override;
139 * @copydoc Dali::Accessibility::Action::GetActionName()
141 std::string GetActionName(size_t index) const override;
144 * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
146 std::string GetLocalizedActionName(size_t index) const override;
149 * @copydoc Dali::Accessibility::Action::GetActionDescription()
151 std::string GetActionDescription(size_t index) const override;
154 * @copydoc Dali::Accessibility::Action::GetActionCount()
156 size_t GetActionCount() const override;
159 * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
161 std::string GetActionKeyBinding(size_t index) const override;
164 * @copydoc Dali::Accessibility::Action::DoAction(std::size_t)
166 bool DoAction(size_t index) override;
169 * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
171 bool DoAction(const std::string& name) override;
174 * @copydoc Dali::Accessibility::Accessible::DoGesture()
176 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
179 * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
181 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
184 * @copydoc Dali::Accessibility::Accessible::GetStates()
186 virtual Dali::Accessibility::States CalculateStates();
189 * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
190 * @return false if scrolling is not supported or child is already visible
192 virtual bool ScrollToChild(Actor child);
195 * @brief Returns the index of the property that represents this actor's name
197 virtual Dali::Property::Index GetNamePropertyIndex();
200 * @brief Returns the index of the property that represents this actor's description
202 virtual Dali::Property::Index GetDescriptionPropertyIndex();
205 * @brief Sets last object position
206 * @param[in] position Last object position
208 void SetLastPosition(Vector2 position);
211 * @brief Gets last object position
212 * @return The Last object position
214 Vector2 GetLastPosition() const;
217 } // namespace Dali::Toolkit::DevelControl
219 #endif // DALI_TOOLKIT_CONTROL_ACCESSIBLE_H