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 AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
83 * @copydoc Dali::Accessibility::Accessible::GetName()
85 std::string GetName() override;
88 * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
90 virtual std::string GetNameRaw();
93 * @copydoc Dali::Accessibility::Accessible::GetDescription()
95 std::string GetDescription() override;
98 * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
100 virtual std::string GetDescriptionRaw();
103 * @copydoc Dali::Accessibility::Accessible::GetParent()
105 Dali::Accessibility::Accessible* GetParent() override;
108 * @copydoc Dali::Accessibility::Accessible::GetChildCount()
110 size_t GetChildCount() override;
113 * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
115 Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
118 * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
120 size_t GetIndexInParent() override;
123 * @copydoc Dali::Accessibility::Accessible::GetRole()
125 Dali::Accessibility::Role GetRole() override;
128 * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
130 std::string GetLocalizedRoleName() override;
133 * @copydoc Dali::Accessibility::Accessible::GetStates()
135 Dali::Accessibility::States GetStates() override;
138 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
140 Dali::Accessibility::Attributes GetAttributes() override;
143 * @copydoc Dali::Accessibility::Component::GetExtents()
145 Dali::Rect<> GetExtents(Accessibility::CoordinateType type) override;
148 * @copydoc Dali::Accessibility::Component::GetLayer()
150 Dali::Accessibility::ComponentLayer GetLayer() override;
153 * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
155 int16_t GetMdiZOrder() override;
158 * @copydoc Dali::Accessibility::Component::GrabFocus()
160 bool GrabFocus() override;
163 * @copydoc Dali::Accessibility::Component::GetAlpha()
165 double GetAlpha() override;
168 * @copydoc Dali::Accessibility::Component::GrabHighlight()
170 bool GrabHighlight() override;
173 * @copydoc Dali::Accessibility::Component::ClearHighlight()
175 bool ClearHighlight() override;
178 * @copydoc Dali::Accessibility::Action::GetActionName()
180 std::string GetActionName(size_t index) override;
183 * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
185 std::string GetLocalizedActionName(size_t index) override;
188 * @copydoc Dali::Accessibility::Action::GetActionDescription()
190 std::string GetActionDescription(size_t index) override;
193 * @copydoc Dali::Accessibility::Action::GetActionCount()
195 size_t GetActionCount() override;
198 * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
200 std::string GetActionKeyBinding(size_t index) override;
203 * @copydoc Dali::Accessibility::Action::DoAction(size_t)
205 bool DoAction(size_t index) override;
208 * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
210 bool DoAction(const std::string& name) override;
213 * @copydoc Dali::Accessibility::Accessible::DoGesture()
215 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
218 * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
220 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
223 * @copydoc Dali::Accessibility::Accessible::GetStates()
225 virtual Dali::Accessibility::States CalculateStates();
228 * @brief Makes sure that a given child of this container (e.g. ItemView) is visible
229 * @return false if scrolling is not supported or child is already visible
231 virtual bool ScrollToChild(Actor child);
234 * @brief Returns the index of the property that represents this actor's name
236 virtual Dali::Property::Index GetNamePropertyIndex();
239 * @brief Returns the index of the property that represents this actor's description
241 virtual Dali::Property::Index GetDescriptionPropertyIndex();
244 * @brief Sets last object position
245 * @param[in] position Last object position
247 void SetLastPosition(Vector2 position);
250 * @brief Gets last object position
251 * @return The Last object position
253 Vector2 GetLastPosition() const;
256 } // namespace Dali::Toolkit::DevelControl
258 #endif // DALI_TOOLKIT_ACCESSIBLE_IMPL_H