dali/internal/accessibility/common/accessibility-adaptor-impl.h

   1 #ifndef DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H
   2 #define DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/math/vector2.h>
  26 #include <dali/devel-api/events/touch-point.h>
  27 #include <dali/integration-api/events/touch-event-combiner.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali/devel-api/adaptor-framework/accessibility-adaptor.h>
  31 #include <dali/devel-api/adaptor-framework/accessibility-action-handler.h>
  32 #include <dali/devel-api/adaptor-framework/accessibility-gesture-handler.h>
  33 #include <dali/internal/accessibility/common/accessibility-gesture-detector.h>
  34
  35 namespace Dali
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 namespace Adaptor
  42 {
  43
  44 /**
  45  * This class detects to accessibility action
  46  */
  47 class AccessibilityAdaptor : public Dali::BaseObject
  48 {
  49 public:
  50
  51   /**
  52    * Constructor.
  53    */
  54   AccessibilityAdaptor();
  55
  56   /**
  57    * @brief Get an instance of the AccessibilityAdaptor.
  58    *
  59    * @note This singleton-style getter can be reimplemented for different platforms.
  60    * @return The instance of the AccessibilityAdaptor.
  61    */
  62   static Dali::AccessibilityAdaptor Get();
  63
  64   /**
  65    * Turn on accessibility action
  66    * This method should be called by vconf callback
  67    */
  68   void EnableAccessibility();
  69
  70   /**
  71    * Turn off accessibility action
  72    * This method should be called by vconf callback
  73    */
  74   void DisableAccessibility();
  75
  76   /**
  77    * @copydoc Dali::AccessibilityAdaptor::IsEnabled()
  78    */
  79   bool IsEnabled() const;
  80
  81   /**
  82    * @copydoc Dali::AccessibilityAdaptor::GetReadPosition() const
  83    */
  84   Vector2 GetReadPosition() const;
  85
  86   /**
  87    * @copydoc Dali::AccessibilityAdaptor::SetActionHandler()
  88    */
  89   void SetActionHandler(AccessibilityActionHandler& handler);
  90
  91   /**
  92    * @copydoc Dali::AccessibilityAdaptor::SetGestureHandler()
  93    */
  94   void SetGestureHandler(AccessibilityGestureHandler& handler);
  95
  96   /**
  97    * @copydoc Dali::AccessibilityAdaptor::HandleActionNextEvent()
  98    */
  99   virtual bool HandleActionNextEvent( bool allowEndFeedback = true);
 100
 101   /**
 102    * @copydoc Dali::AccessibilityAdaptor::HandleActionPreviousEvent()
 103    */
 104   virtual bool HandleActionPreviousEvent( bool allowEndFeedback = true);
 105
 106   /**
 107    * @copydoc Dali::AccessibilityAdaptor::HandleActionActivateEvent()
 108    */
 109   virtual bool HandleActionActivateEvent();
 110
 111   /**
 112    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadEvent()
 113    */
 114   virtual bool HandleActionReadEvent( unsigned int x, unsigned int y, bool allowReadAgain );
 115
 116   /**
 117    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadNextEvent()
 118    */
 119   virtual bool HandleActionReadNextEvent( bool allowEndFeedback = true);
 120
 121   /**
 122    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadPreviousEvent()
 123    */
 124   virtual bool HandleActionReadPreviousEvent( bool allowEndFeedback = true);
 125
 126   /**
 127    * @copydoc Dali::AccessibilityAdaptor::HandleActionUpEvent()
 128    */
 129   virtual bool HandleActionUpEvent();
 130
 131   /**
 132    * @copydoc Dali::AccessibilityAdaptor::HandleActionDownEvent()
 133    */
 134   virtual bool HandleActionDownEvent();
 135
 136   /**
 137    * @copydoc Dali::AccessibilityAdaptor::HandleActionClearFocusEvent()
 138    */
 139   bool HandleActionClearFocusEvent();
 140
 141   /**
 142    * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollEvent()
 143    */
 144   bool HandleActionScrollEvent(const TouchPoint& point, uint32_t timeStamp);
 145
 146   /**
 147    * @copydoc Dali::AccessibilityAdaptor::HandleActionBackEvent()
 148    */
 149   bool HandleActionBackEvent();
 150
 151   /**
 152    * @copydoc Dali::AccessibilityAdaptor::HandleActionEnableEvent()
 153    */
 154   void HandleActionEnableEvent();
 155
 156   /**
 157    * @copydoc Dali::AccessibilityAdaptor::HandleActionDisableEvent()
 158    */
 159   void HandleActionDisableEvent();
 160
 161   /**
 162    * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollUpEvent()
 163    */
 164   bool HandleActionScrollUpEvent();
 165
 166   /**
 167    * @copydoc Dali::AccessibilityAdaptor::HandleActionScrollDownEvent()
 168    */
 169   bool HandleActionScrollDownEvent();
 170
 171   /**
 172    * @copydoc Dali::AccessibilityAdaptor::HandleActionPageLeftEvent()
 173    */
 174   bool HandleActionPageLeftEvent();
 175
 176   /**
 177    * @copydoc Dali::AccessibilityAdaptor::HandleActionPageRightEvent()
 178    */
 179   bool HandleActionPageRightEvent();
 180
 181   /**
 182    * @copydoc Dali::AccessibilityAdaptor::HandleActionPageUpEvent()
 183    */
 184   bool HandleActionPageUpEvent();
 185
 186   /**
 187    * @copydoc Dali::AccessibilityAdaptor::HandleActionPageDownEvent()
 188    */
 189   bool HandleActionPageDownEvent();
 190
 191   /**
 192    * @copydoc Dali::AccessibilityAdaptor::HandleActionMoveToFirstEvent()
 193    */
 194   bool HandleActionMoveToFirstEvent();
 195
 196   /**
 197    * @copydoc Dali::AccessibilityAdaptor::HandleActionMoveToLastEvent()
 198    */
 199   bool HandleActionMoveToLastEvent();
 200
 201   /**
 202    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadFromTopEvent()
 203    */
 204   bool HandleActionReadFromTopEvent();
 205
 206   /**
 207    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadFromNextEvent()
 208    */
 209   bool HandleActionReadFromNextEvent();
 210
 211   /**
 212    * @copydoc Dali::AccessibilityAdaptor::HandleActionZoomEvent()
 213    */
 214   bool HandleActionZoomEvent();
 215
 216   /**
 217    * @copydoc Dali::AccessibilityAdaptor::HandleActionReadPauseResumeEvent()
 218    */
 219   bool HandleActionReadPauseResumeEvent();
 220
 221   /**
 222    * @copydoc Dali::AccessibilityAdaptor::HandleActionStartStopEvent()
 223    */
 224   bool HandleActionStartStopEvent();
 225
 226 protected:
 227
 228   /**
 229    * Destructor.
 230    */
 231   ~AccessibilityAdaptor() override;
 232
 233 private:
 234
 235   /**
 236    * @brief Called when the singleton is destroyed.
 237    *
 238    * @note This can be reimplemented for different platforms.
 239    * @return The instance of the AccessibilityAdaptor.
 240    */
 241   static void OnDestroy();
 242
 243   // Undefined
 244   AccessibilityAdaptor( const AccessibilityAdaptor& );
 245   AccessibilityAdaptor& operator=( AccessibilityAdaptor& );
 246
 247 protected:
 248
 249   Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
 250
 251   Vector2 mReadPosition; ///< ActionRead position
 252
 253   AccessibilityActionHandler* mActionHandler; ///< The pointer of accessibility action handler
 254
 255   AccessibilityGestureDetectorPtr mAccessibilityGestureDetector; ///< The accessibility gesture detector
 256
 257   bool mIsEnabled        : 1; ///< enable/disable the accessibility action
 258
 259 public:
 260
 261   // Helpers for public-api forwarding methods
 262
 263   inline static Internal::Adaptor::AccessibilityAdaptor& GetImplementation(Dali::AccessibilityAdaptor& adaptor)
 264   {
 265     DALI_ASSERT_ALWAYS( adaptor && "AccessibilityAdaptor handle is empty" );
 266
 267     BaseObject& handle = adaptor.GetBaseObject();
 268
 269     return static_cast<Internal::Adaptor::AccessibilityAdaptor&>(handle);
 270   }
 271
 272   inline static const Internal::Adaptor::AccessibilityAdaptor& GetImplementation(const Dali::AccessibilityAdaptor& adaptor)
 273   {
 274     DALI_ASSERT_ALWAYS( adaptor && "AccessibilityAdaptor handle is empty" );
 275
 276     const BaseObject& handle = adaptor.GetBaseObject();
 277
 278     return static_cast<const Internal::Adaptor::AccessibilityAdaptor&>(handle);
 279   }
 280
 281 };
 282
 283 } // namespace Adaptor
 284
 285 } // namespace Internal
 286
 287 } // namespace Dali
 288
 289 #endif // DALI_INTERNAL_ACCESSIBILITY_ADAPTOR_H