1 #ifndef DALI_TOOLKIT_ACCESSIBLE_IMPL_H
2 #define DALI_TOOLKIT_ACCESSIBLE_IMPL_H
4 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
20 #include <dali/devel-api/adaptor-framework/accessibility-impl.h>
21 #include <dali/devel-api/adaptor-framework/accessibility.h>
22 #include <dali/public-api/object/weak-handle.h>
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
27 namespace Dali::Toolkit::DevelControl {
30 * @brief Represents the Accessible object for Dali::Toolkit::Control and derived classes
32 * You can create a derived class (and register it using SetAccessibilityConstructor)
33 * in order to customize Accessibility for a given control.
35 * @see Dali::Toolkit::DevelControl::SetAccessibilityConstructor
36 * @see Dali::Accessibility::Accessible
37 * @see Dali::Accessibility::Component
38 * @see Dali::Accessibility::Collection
39 * @see Dali::Accessibility::Action
40 * @see Dali::Accessibility::Value
41 * @see Dali::Accessibility::Text
42 * @see Dali::Accessibility::EditableText
44 struct DALI_TOOLKIT_API AccessibleImpl : public virtual Dali::Accessibility::Accessible,
45 public virtual Dali::Accessibility::Component,
46 public virtual Dali::Accessibility::Collection,
47 public virtual Dali::Accessibility::Action
50 Vector2 mLastPosition{0.0f, 0.0f};
51 Dali::WeakHandle<Dali::Actor> mSelf;
52 Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
53 bool mIsModal = false;
58 auto handle = mSelf.GetHandle();
60 // Control::Impl holds a std::unique_ptr to the Accessible object,
61 // so that one does not outlive the other.
62 DALI_ASSERT_ALWAYS(handle);
70 * @brief Register property notification to check highlighted object position
72 void RegisterPositionPropertyNotification();
75 * @brief Remove property notification added by RegisterPropertyNotification
77 void UnregisterPositionPropertyNotification();
80 * @brief Check if the actor is showing
81 * @return True if the actor is showing
86 AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
89 * @copydoc Dali::Accessibility::Accessible::GetName()
91 std::string GetName() override;
94 * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
96 virtual std::string GetNameRaw();
99 * @copydoc Dali::Accessibility::Accessible::GetDescription()
101 std::string GetDescription() override;
104 * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
106 virtual std::string GetDescriptionRaw();
109 * @copydoc Dali::Accessibility::Accessible::GetParent()
111 Dali::Accessibility::Accessible* GetParent() override;
114 * @copydoc Dali::Accessibility::Accessible::GetChildCount()
116 size_t GetChildCount() override;
119 * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
121 Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
124 * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
126 size_t GetIndexInParent() override;
129 * @copydoc Dali::Accessibility::Accessible::GetRole()
131 Dali::Accessibility::Role GetRole() override;
134 * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
136 std::string GetLocalizedRoleName() override;
139 * @copydoc Dali::Accessibility::Accessible::GetStates()
141 Dali::Accessibility::States GetStates() override;
144 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
146 Dali::Accessibility::Attributes GetAttributes() override;
149 * @copydoc Dali::Accessibility::Component::GetExtents()
151 Dali::Rect<> GetExtents(Accessibility::CoordinateType type) override;
154 * @copydoc Dali::Accessibility::Component::GetLayer()
156 Dali::Accessibility::ComponentLayer GetLayer() override;
159 * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
161 int16_t GetMdiZOrder() override;
164 * @copydoc Dali::Accessibility::Component::GrabFocus()
166 bool GrabFocus() override;
169 * @copydoc Dali::Accessibility::Component::GetAlpha()
171 double GetAlpha() override;
174 * @copydoc Dali::Accessibility::Component::GrabHighlight()
176 bool GrabHighlight() override;
179 * @copydoc Dali::Accessibility::Component::ClearHighlight()
181 bool ClearHighlight() override;
184 * @copydoc Dali::Accessibility::Action::GetActionName()
186 std::string GetActionName(size_t index) override;
189 * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
191 std::string GetLocalizedActionName(size_t index) override;
194 * @copydoc Dali::Accessibility::Action::GetActionDescription()
196 std::string GetActionDescription(size_t index) override;
199 * @copydoc Dali::Accessibility::Action::GetActionCount()
201 size_t GetActionCount() override;
204 * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
206 std::string GetActionKeyBinding(size_t index) override;
209 * @copydoc Dali::Accessibility::Action::DoAction(size_t)
211 bool DoAction(size_t index) override;
214 * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
216 bool DoAction(const std::string& name) override;
219 * @copydoc Dali::Accessibility::Accessible::DoGesture()
221 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
224 * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
226 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
229 * @copydoc Dali::Accessibility::Accessible::GetInternalActor()
231 Dali::Actor GetInternalActor() override;
234 * @copydoc Dali::Accessibility::Accessible::GetStates()
236 virtual Dali::Accessibility::States CalculateStates();
239 * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
240 * @return false if scrolling is not supported or child is already visible
242 virtual bool ScrollToChild(Actor child);
245 * @brief Returns the index of the property that represents this actor's name
247 virtual Dali::Property::Index GetNamePropertyIndex();
250 * @brief Returns the index of the property that represents this actor's description
252 virtual Dali::Property::Index GetDescriptionPropertyIndex();
255 * @brief Sets last object position
256 * @param[in] position Last object position
258 void SetLastPosition(Vector2 position);
261 * @brief Gets last object position
262 * @return The Last object position
264 Vector2 GetLastPosition() const;
267 } // namespace Dali::Toolkit::DevelControl
269 #endif // DALI_TOOLKIT_ACCESSIBLE_IMPL_H