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 Dali::WeakHandle<Dali::Actor> self;
51 Dali::WeakHandle<Dali::Actor> currentHighlightActor;
52 bool modal = false, root = false;
56 auto handle = self.GetHandle();
58 // Control::Impl holds a std::unique_ptr to the Accessible object,
59 // so that one does not outlive the other.
60 DALI_ASSERT_ALWAYS(handle);
66 AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
69 * @copydoc Dali::Accessibility::Accessible::GetName()
71 std::string GetName() override;
74 * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
76 virtual std::string GetNameRaw();
79 * @copydoc Dali::Accessibility::Accessible::GetDescription()
81 std::string GetDescription() override;
84 * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
86 virtual std::string GetDescriptionRaw();
89 * @copydoc Dali::Accessibility::Accessible::GetParent()
91 Dali::Accessibility::Accessible* GetParent() override;
94 * @copydoc Dali::Accessibility::Accessible::GetChildCount()
96 size_t GetChildCount() override;
99 * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
101 Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
104 * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
106 size_t GetIndexInParent() override;
109 * @copydoc Dali::Accessibility::Accessible::GetRole()
111 Dali::Accessibility::Role GetRole() override;
114 * @copydoc Dali::Accessibility::Accessible::GetStates()
116 Dali::Accessibility::States GetStates() override;
119 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
121 Dali::Accessibility::Attributes GetAttributes() override;
124 * @copydoc Dali::Accessibility::Component::GetExtents()
126 Dali::Rect<> GetExtents(Dali::Accessibility::CoordType ctype) override;
129 * @copydoc Dali::Accessibility::Component::GetLayer()
131 Dali::Accessibility::ComponentLayer GetLayer() override;
134 * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
136 int16_t GetMdiZOrder() override;
139 * @copydoc Dali::Accessibility::Component::GrabFocus()
141 bool GrabFocus() override;
144 * @copydoc Dali::Accessibility::Component::GetAlpha()
146 double GetAlpha() override;
149 * @copydoc Dali::Accessibility::Component::GrabHighlight()
151 bool GrabHighlight() override;
154 * @copydoc Dali::Accessibility::Component::ClearHighlight()
156 bool ClearHighlight() override;
159 * @copydoc Dali::Accessibility::Action::GetActionName()
161 std::string GetActionName(size_t index) override;
164 * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
166 std::string GetLocalizedActionName(size_t index) override;
169 * @copydoc Dali::Accessibility::Action::GetActionDescription()
171 std::string GetActionDescription(size_t index) override;
174 * @copydoc Dali::Accessibility::Action::GetActionCount()
176 size_t GetActionCount() override;
179 * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
181 std::string GetActionKeyBinding(size_t index) override;
184 * @copydoc Dali::Accessibility::Action::DoAction(size_t)
186 bool DoAction(size_t index) override;
189 * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
191 bool DoAction(const std::string& name) override;
194 * @copydoc Dali::Accessibility::Accessible::DoGesture()
196 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
199 * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
201 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
204 * @copydoc Dali::Accessibility::Accessible::GetStates()
206 virtual Dali::Accessibility::States CalculateStates();
209 * @brief Makes sure that a given child of this container (e.g. ItemView) is visible
211 virtual void EnsureChildVisible(Actor child);
214 * @brief Makes sure this actor is visible (when moving the highlight frame to an
215 * actor that is scrolled out of the viewport)
217 virtual void EnsureSelfVisible();
220 * @brief Returns the index of the property that represents this actor's name
222 virtual Dali::Property::Index GetNamePropertyIndex();
225 * @brief Returns the index of the property that represents this actor's description
227 virtual Dali::Property::Index GetDescriptionPropertyIndex();
230 } // namespace Dali::Toolkit::DevelControl
232 #endif // DALI_TOOLKIT_ACCESSIBLE_IMPL_H