[ATSPI] Fix for SCREEN coordinate type in GetExtents
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / accessible-impl.h
1 #ifndef DALI_TOOLKIT_ACCESSIBLE_IMPL_H
2 #define DALI_TOOLKIT_ACCESSIBLE_IMPL_H
3 /*
4  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
5  *
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
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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.
17  *
18  */
19 // EXTERNAL INCLUDES
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>
23
24 // INTERNAL INCLUDES
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
26
27 namespace Dali::Toolkit::DevelControl {
28
29 /**
30  * @brief Represents the Accessible object for Dali::Toolkit::Control and derived classes
31  *
32  * You can create a derived class (and register it using SetAccessibilityConstructor)
33  * in order to customize Accessibility for a given control.
34  *
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
43  */
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
48 {
49 protected:
50   Vector2                       mLastPosition{0.0f, 0.0f};
51   Dali::WeakHandle<Dali::Actor> mSelf;
52   Dali::WeakHandle<Dali::Actor> mCurrentHighlightActor;
53   bool mIsModal = false;
54   bool mIsRoot = false;
55
56   Dali::Actor Self()
57   {
58     auto handle = mSelf.GetHandle();
59
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);
63
64     return handle;
65   }
66
67   void ScrollToSelf();
68
69   /**
70    * @brief Register property notification to check highlighted object position
71    */
72   void RegisterPositionPropertyNotification();
73
74   /**
75    * @brief Remove property notification added by RegisterPropertyNotification
76    */
77   void UnregisterPositionPropertyNotification();
78
79 public:
80   AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
81
82   /**
83    * @copydoc Dali::Accessibility::Accessible::GetName()
84    */
85   std::string GetName() override;
86
87   /**
88    * @brief Returns the actor's name in the absence of ACCESSIBILITY_NAME property
89    */
90   virtual std::string GetNameRaw();
91
92   /**
93    * @copydoc Dali::Accessibility::Accessible::GetDescription()
94    */
95   std::string GetDescription() override;
96
97   /**
98    * @brief Returns the actor's description in the absence of ACCESSIBILITY_DESCRIPTION property
99    */
100   virtual std::string GetDescriptionRaw();
101
102   /**
103    * @copydoc Dali::Accessibility::Accessible::GetParent()
104    */
105   Dali::Accessibility::Accessible* GetParent() override;
106
107   /**
108    * @copydoc Dali::Accessibility::Accessible::GetChildCount()
109    */
110   size_t GetChildCount() override;
111
112   /**
113    * @copydoc Dali::Accessibility::Accessible::GetChildAtIndex()
114    */
115   Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
116
117   /**
118    * @copydoc Dali::Accessibility::Accessible::GetIndexInParent()
119    */
120   size_t GetIndexInParent() override;
121
122   /**
123    * @copydoc Dali::Accessibility::Accessible::GetRole()
124    */
125   Dali::Accessibility::Role GetRole() override;
126
127   /**
128    * @copydoc Dali::Accessibility::Accessible::GetLocalizedRoleName()
129    */
130   std::string GetLocalizedRoleName() override;
131
132   /**
133    * @copydoc Dali::Accessibility::Accessible::GetStates()
134    */
135   Dali::Accessibility::States GetStates() override;
136
137   /**
138    * @copydoc Dali::Accessibility::Accessible::GetAttributes()
139    */
140   Dali::Accessibility::Attributes GetAttributes() override;
141
142   /**
143    * @copydoc Dali::Accessibility::Component::GetExtents()
144    */
145   Dali::Rect<> GetExtents(Accessibility::CoordinateType type) override;
146
147   /**
148    * @copydoc Dali::Accessibility::Component::GetLayer()
149    */
150   Dali::Accessibility::ComponentLayer GetLayer() override;
151
152   /**
153    * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
154    */
155   int16_t GetMdiZOrder() override;
156
157   /**
158    * @copydoc Dali::Accessibility::Component::GrabFocus()
159    */
160   bool GrabFocus() override;
161
162   /**
163    * @copydoc Dali::Accessibility::Component::GetAlpha()
164    */
165   double GetAlpha() override;
166
167   /**
168    * @copydoc Dali::Accessibility::Component::GrabHighlight()
169    */
170   bool GrabHighlight() override;
171
172   /**
173    * @copydoc Dali::Accessibility::Component::ClearHighlight()
174    */
175   bool ClearHighlight() override;
176
177   /**
178    * @copydoc Dali::Accessibility::Action::GetActionName()
179    */
180   std::string GetActionName(size_t index) override;
181
182   /**
183    * @copydoc Dali::Accessibility::Action::GetLocalizedActionName()
184    */
185   std::string GetLocalizedActionName(size_t index) override;
186
187   /**
188    * @copydoc Dali::Accessibility::Action::GetActionDescription()
189    */
190   std::string GetActionDescription(size_t index) override;
191
192   /**
193    * @copydoc Dali::Accessibility::Action::GetActionCount()
194    */
195   size_t GetActionCount() override;
196
197   /**
198    * @copydoc Dali::Accessibility::Action::GetActionKeyBinding()
199    */
200   std::string GetActionKeyBinding(size_t index) override;
201
202   /**
203    * @copydoc Dali::Accessibility::Action::DoAction(size_t)
204    */
205   bool DoAction(size_t index) override;
206
207   /**
208    * @copydoc Dali::Accessibility::Action::DoAction(const std::string&)
209    */
210   bool DoAction(const std::string& name) override;
211
212   /**
213    * @copydoc Dali::Accessibility::Accessible::DoGesture()
214    */
215   bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
216
217   /**
218    * @copydoc Dali::Accessibility::Accessible::GetRelationSet()
219    */
220   std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
221
222   /**
223    * @copydoc Dali::Accessibility::Accessible::GetStates()
224    */
225   virtual Dali::Accessibility::States CalculateStates();
226
227   /**
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
230    */
231   virtual bool ScrollToChild(Actor child);
232
233   /**
234    * @brief Returns the index of the property that represents this actor's name
235    */
236   virtual Dali::Property::Index GetNamePropertyIndex();
237
238   /**
239    * @brief Returns the index of the property that represents this actor's description
240    */
241   virtual Dali::Property::Index GetDescriptionPropertyIndex();
242
243   /**
244    * @brief Sets last object position
245    * @param[in] position Last object position
246    */
247   void SetLastPosition(Vector2 position);
248
249   /**
250    * @brief Gets last object position
251    * @return The Last object position
252    */
253   Vector2 GetLastPosition() const;
254 };
255
256 } // namespace Dali::Toolkit::DevelControl
257
258 #endif // DALI_TOOLKIT_ACCESSIBLE_IMPL_H