1 #ifndef __DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H__
2 #define __DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H__
5 * Copyright (c) 2014 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.
24 #include <dali/public-api/object/base-object.h>
25 #include <dali/public-api/math/vector2.h>
26 #include <dali/public-api/events/touch-point.h>
27 #include <dali/integration-api/events/touch-event-combiner.h>
30 #include <accessibility-adaptor.h>
31 #include <accessibility-action-handler.h>
32 #include <accessibility-gesture-handler.h>
33 #include <indicator-interface.h>
34 #include <accessibility-gesture-detector.h>
46 * This class detects to accessibility action
48 class AccessibilityAdaptor : public Dali::BaseObject
55 AccessibilityAdaptor();
58 * @brief Get an instance of the AccessibilityAdaptor.
60 * @note This singleton-style getter can be reimplemented for different platforms.
61 * @return The instance of the AccessibilityAdaptor.
63 static Dali::AccessibilityAdaptor Get();
66 * Turn on accessibility action
67 * This method should be called by vconf callback
69 void EnableAccessibility();
72 * Turn off accessibility action
73 * This method should be called by vconf callback
75 void DisableAccessibility();
78 * @copydoc Dali::AccessibilityAdaptor::IsEnabled()
80 bool IsEnabled() const;
83 * @copydoc Dali::AccessibilityAdaptor::GetReadPosition() const
85 Vector2 GetReadPosition() const;
88 * @copydoc Dali::AccessibilityAdaptor::SetActionHandler()
90 void SetActionHandler(AccessibilityActionHandler& handler);
93 * @copydoc Dali::AccessibilityAdaptor::SetGestureHandler()
95 void SetGestureHandler(AccessibilityGestureHandler& handler);
98 * @brief Set the Indicator
99 * @param[in] Indiciator interface
101 void SetIndicator( IndicatorInterface* indicator );
104 * @copydoc Dali::AccessibilityAdaptor::HandleActionNextEvent()
106 virtual bool HandleActionNextEvent( bool allowEndFeedback = true);
109 * @copydoc Dali::AccessibilityAdaptor::HandleActionPreviousEvent()
111 virtual bool HandleActionPreviousEvent( bool allowEndFeedback = true);
114 * @copydoc Dali::AccessibilityAdaptor::HandleActionActivateEvent()
116 virtual bool HandleActionActivateEvent();
119 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadEvent()
121 virtual bool HandleActionReadEvent( unsigned int x, unsigned int y, bool allowReadAgain );
124 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadNextEvent()
126 virtual bool HandleActionReadNextEvent( bool allowEndFeedback = true);
129 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadPreviousEvent()
131 virtual bool HandleActionReadPreviousEvent( bool allowEndFeedback = true);
134 * @copydoc Dali::AccessibilityAdaptor::HandleActionUpEvent()
136 virtual bool HandleActionUpEvent();
139 * @copydoc Dali::AccessibilityAdaptor::HandleActionDownEvent()
141 virtual bool HandleActionDownEvent();
144 * @copydoc Dali::AccessibilityAdaptor::HandleActionClearFocusEvent()
146 bool HandleActionClearFocusEvent();
149 * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollEvent()
151 bool HandleActionScrollEvent(const TouchPoint& point, unsigned long timeStamp);
154 * @copydoc Dali::AccessibilityAdaptor::HandleActionTouchEvent()
156 bool HandleActionTouchEvent(const TouchPoint& point, unsigned long timeStamp);
159 * @copydoc Dali::AccessibilityAdaptor::HandleActionBackEvent()
161 bool HandleActionBackEvent();
164 * @copydoc Dali::AccessibilityAdaptor::HandleActionEnableEvent()
166 void HandleActionEnableEvent();
169 * @copydoc Dali::AccessibilityAdaptor::HandleActionDisableEvent()
171 void HandleActionDisableEvent();
174 * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollUpEvent()
176 bool HandleActionScrollUpEvent();
179 * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollDownEvent()
181 bool HandleActionScrollDownEvent();
184 * @copydoc Dali::AccessibilityAdaptor::HandleActionPageLeftEvent()
186 bool HandleActionPageLeftEvent();
189 * @copydoc Dali::AccessibilityAdaptor::HandleActionPageRightEvent()
191 bool HandleActionPageRightEvent();
194 * @copydoc Dali::AccessibilityAdaptor::HandleActionPageUpEvent()
196 bool HandleActionPageUpEvent();
199 * @copydoc Dali::AccessibilityAdaptor::HandleActionPageDownEvent()
201 bool HandleActionPageDownEvent();
204 * @copydoc Dali::AccessibilityAdaptor::HandleActionMoveToFirstEvent()
206 bool HandleActionMoveToFirstEvent();
209 * @copydoc Dali::AccessibilityAdaptor::HandleActionMoveToLastEvent()
211 bool HandleActionMoveToLastEvent();
214 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadFromTopEvent()
216 bool HandleActionReadFromTopEvent();
219 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadFromNextEvent()
221 bool HandleActionReadFromNextEvent();
224 * @copydoc Dali::AccessibilityAdaptor::HandleActionZoomEvent()
226 bool HandleActionZoomEvent();
229 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadIndicatorInformationEvent()
231 bool HandleActionReadIndicatorInformationEvent();
234 * @copydoc Dali::AccessibilityAdaptor::HandleActionReadPauseResumeEvent()
236 bool HandleActionReadPauseResumeEvent();
239 * @copydoc Dali::AccessibilityAdaptor::HandleActionStartStopEvent()
241 bool HandleActionStartStopEvent();
248 virtual ~AccessibilityAdaptor();
253 * @brief Called when the singleton is destroyed.
255 * @note This can be reimplemented for different platforms.
256 * @return The instance of the AccessibilityAdaptor.
258 static void OnDestroy();
261 AccessibilityAdaptor( const AccessibilityAdaptor& );
262 AccessibilityAdaptor& operator=( AccessibilityAdaptor& );
266 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
268 Vector2 mReadPosition; ///< ActionRead position
270 AccessibilityActionHandler* mActionHandler; ///< The pointer of accessibility action handler
272 AccessibilityGestureDetectorPtr mAccessibilityGestureDetector; ///< The accessibility gesture detector
274 IndicatorInterface* mIndicator; ///< The indicator
276 bool mIsEnabled : 1; ///< enable/disable the accessibility action
277 bool mIndicatorFocused : 1; ///< Whether the Indicator is focused
281 // Helpers for public-api forwarding methods
283 inline static Internal::Adaptor::AccessibilityAdaptor& GetImplementation(Dali::AccessibilityAdaptor& adaptor)
285 DALI_ASSERT_ALWAYS( adaptor && "AccessibilityAdaptor handle is empty" );
287 BaseObject& handle = adaptor.GetBaseObject();
289 return static_cast<Internal::Adaptor::AccessibilityAdaptor&>(handle);
292 inline static const Internal::Adaptor::AccessibilityAdaptor& GetImplementation(const Dali::AccessibilityAdaptor& adaptor)
294 DALI_ASSERT_ALWAYS( adaptor && "AccessibilityAdaptor handle is empty" );
296 const BaseObject& handle = adaptor.GetBaseObject();
298 return static_cast<const Internal::Adaptor::AccessibilityAdaptor&>(handle);
303 } // namespace Adaptor
305 } // namespace Internal
309 #endif // __DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H__