src/ui/inc/FUi_ITouchFlickGestureEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18 * @file                 FUi_ITouchFlickGestureEventListener.h
  19 * @brief                This is the header file for the %_ITouchFlickGestureEventListener interface.
  20 *
  21 * This header file contains the declarations of the %_ITouchFlickGestureEventListener interface.
  22 */
  23 #ifndef _FUI_INTERNAL_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H
  24 #define _FUI_INTERNAL_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H
  25
  26 #include "FUi_ITouchGestureEventListener.h"
  27 #include "FUi_TouchFlickGestureDetector.h"
  28
  29 namespace Tizen { namespace Ui
  30 {
  31 /**
  32  * @interface           _ITouchFlickGestureEventListener
  33  * @brief                       This interface is used as the argument to the flick gesture event listener.
  34  * @since 2.0
  35  *
  36  * The listener interface for receiving gesture events. The class that processes a flick gesture event
  37  * implements this interface, and the instance created with that class is registered with a UI controls, using the gesture's
  38  * AddGestureEventListener() method. When the gesture is recognized, OnGestureTapRecognized method of that instance is invoked.
  39  */
  40 class _ITouchFlickGestureEventListener
  41         : virtual public _ITouchGestureEventListener
  42 {
  43 public:
  44         /**
  45         * This is the destructor for this class.
  46         *
  47         * @since 2.0
  48         */
  49         virtual ~_ITouchFlickGestureEventListener(void) {}
  50
  51         /**
  52         * Notifies when the gesture is recognized.
  53         *
  54         * @since 2.0
  55         * @param[in]            gesture         the gesture instance
  56         */
  57         virtual bool OnFlickGestureDetected(_TouchFlickGestureDetector& gesture) = 0;
  58
  59         /**
  60         * Notifies when the gesture recognition is canceled.
  61         *
  62         * @since 2.0
  63         * @param[in]            gesture         the gesture instance
  64         */
  65         virtual bool OnFlickGestureCanceled(_TouchFlickGestureDetector& gesture) = 0;
  66 }; // _ITouchFlickGestureEventListener
  67
  68 } } // Tizen::Ui
  69
  70 #endif // _FUI_INTERNAL_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H