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 override Control::CreateAccessibleObject)
37 * in order to customize Accessibility for a given control.
39 * @see Dali::Accessibility::Accessible
40 * @see Dali::Accessibility::Component
41 * @see Dali::Accessibility::Collection
42 * @see Dali::Accessibility::Action
43 * @see Dali::Accessibility::Value
44 * @see Dali::Accessibility::Text
45 * @see Dali::Accessibility::EditableText
47 struct DALI_TOOLKIT_API ControlAccessible : public Dali::Accessibility::ActorAccessible,
48 public virtual Dali::Accessibility::Action
51 Vector2 mLastPosition{0.0f, 0.0f};
52 Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
57 * @brief Register property notification to check highlighted object position
59 void RegisterPositionPropertyNotification();
62 * @brief Remove property notification added by RegisterPropertyNotification
64 void UnregisterPositionPropertyNotification();
67 * @brief Check if the actor is showing
68 * @return True if the actor is showing
73 ControlAccessible(Dali::Actor self);
76 * @copydoc Dali::Accessibility::Accessible::GetName()
78 std::string GetName() const override;
81 * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
83 virtual std::string GetNameRaw() const;
86 * @copydoc Dali::Accessibility::Accessible::GetDescription()
88 std::string GetDescription() const override;
91 * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
93 virtual std::string GetDescriptionRaw() const;
96 * @copydoc Dali::Accessibility::Accessible::GetRole()
98 Dali::Accessibility::Role GetRole() const override;
101 * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
103 std::string GetLocalizedRoleName() const override;
106 * @copydoc Dali::Accessibility::Accessible::GetStates()
108 Dali::Accessibility::States GetStates() override;
111 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
113 Dali::Accessibility::Attributes GetAttributes() const override;
116 * @copydoc Dali::Accessibility::Accessible::IsHidden()
118 bool IsHidden() const override;
121 * @copydoc Dali::Accessibility::Component::GrabFocus()
123 bool GrabFocus() override;
126 * @copydoc Dali::Accessibility::Component::GrabHighlight()
128 bool GrabHighlight() override;
131 * @copydoc Dali::Accessibility::Component::ClearHighlight()
133 bool ClearHighlight() override;
136 * @copydoc Dali::Accessibility::Action::GetActionName()
138 std::string GetActionName(size_t index) const override;
141 * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
143 std::string GetLocalizedActionName(size_t index) const override;
146 * @copydoc Dali::Accessibility::Action::GetActionDescription()
148 std::string GetActionDescription(size_t index) const override;
151 * @copydoc Dali::Accessibility::Action::GetActionCount()
153 size_t GetActionCount() const override;
156 * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
158 std::string GetActionKeyBinding(size_t index) const override;
161 * @copydoc Dali::Accessibility::Action::DoAction(std::size_t)
163 bool DoAction(size_t index) override;
166 * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
168 bool DoAction(const std::string& name) override;
171 * @copydoc Dali::Accessibility::Accessible::DoGesture()
173 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
176 * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
178 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
181 * @copydoc Dali::Accessibility::Accessible::GetStates()
183 virtual Dali::Accessibility::States CalculateStates();
186 * @brief Makes sure that a given child (descendant) of this container (e.g. ItemView) is visible
187 * @return false if scrolling is not supported or child is already visible
189 virtual bool ScrollToChild(Actor child);
192 * @brief Returns the index of the property that represents this actor's name
194 virtual Dali::Property::Index GetNamePropertyIndex();
197 * @brief Returns the index of the property that represents this actor's description
199 virtual Dali::Property::Index GetDescriptionPropertyIndex();
202 * @brief Sets last object position
203 * @param[in] position Last object position
205 void SetLastPosition(Vector2 position);
208 * @brief Gets last object position
209 * @return The Last object position
211 Vector2 GetLastPosition() const;
214 } // namespace Dali::Toolkit::DevelControl
216 #endif // DALI_TOOLKIT_CONTROL_ACCESSIBLE_H