dali/integration-api/gesture-manager.h

   1 #ifndef __DALI_INTEGRATION_GESTURE_MANAGER_H__
   2 #define __DALI_INTEGRATION_GESTURE_MANAGER_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/public-api/events/gesture.h>
  22 #include <dali/integration-api/events/gesture-requests.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Integration
  28 {
  29
  30 /**
  31  * GestureManager is an abstract interface, used by Dali to register and unregister gestures provided
  32  * by the adaptor. A concrete implementation must be created for each adaptor, and provided when creating
  33  * the Dali::Integration::Core object.
  34  */
  35 class DALI_IMPORT_API GestureManager
  36 {
  37 public:
  38
  39   /**
  40    * Called by Dali to enable the adaptor to start detecting the required gesture type.
  41    * @param[in]  request  The required gesture and details.
  42    */
  43   virtual void Register(const GestureRequest& request) = 0;
  44
  45   /**
  46    * Called by Dali to inform the adaptor that it no longer requires a GestureEvent when the state
  47    * gesture type is detected.
  48    * @param[in]  request  The gesture that is no longer required.
  49    */
  50   virtual void Unregister(const GestureRequest& request) = 0;
  51
  52   /**
  53    * Called by Dali to inform the adaptor that the detection parameters of a previously requested
  54    * gesture have now changed.
  55    * @param[in]  request  The gesture and updated details.
  56    */
  57   virtual void Update(const GestureRequest& request) = 0;
  58
  59 }; // class GestureManager
  60
  61 } // namespace Integration
  62
  63 } // namespace Dali
  64
  65 #endif // __DALI_INTEGRATION_GESTURE_MANAGER_H__