src/ui/inc/FUi_ITouchPanningGestureEventListener.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_ITouchPanningGestureEventListener.h
  19 * @brief                This is the header file for the %_ITouchPanningGestureEventListener interface.
  20 *
  21 * This header file contains the declarations of the %_ITouchPanningGestureEventListener interface.
  22 */
  23 #ifndef _FUI_INTERNAL_ITOUCH_PANNING_GESTURE_EVENT_LISTENER_H_
  24 #define _FUI_INTERNAL_ITOUCH_PANNING_GESTURE_EVENT_LISTENER_H_
  25
  26 #include "FUi_ITouchGestureEventListener.h"
  27 #include "FUi_TouchPanningGestureDetector.h"
  28
  29 namespace Tizen { namespace Ui
  30 {
  31
  32 /**
  33  * @interface           _ITouchPanningGestureEventListener
  34  * @brief                       This interface is used as the argument to the panning gesture event listener.
  35  * @since 2.0
  36  *
  37  * The listener interface for receiving gesture events. The class that processes a panning gesture event
  38  * implements this interface, and the instance created with that class is registered with a UI controls, using the gesture's
  39  * AddGestureEventListener() method. When the gesture is recognized, OnGestureTapRecognized method of that instance is invoked.
  40  */
  41 class _ITouchPanningGestureEventListener
  42         : virtual public _ITouchGestureEventListener
  43 {
  44 // Operation
  45 public:
  46         virtual ~_ITouchPanningGestureEventListener(void) {}
  47
  48         /**
  49         * Notifies when the gesture is started to recognition.
  50         *
  51         * @since 2.0
  52         * @param[in]            gesture         the gesture instance
  53         */
  54         virtual bool OnPanningGestureStarted(_TouchPanningGestureDetector& gesture) = 0;
  55
  56         /**
  57         * Notifies when the gesture is recognized.
  58         *
  59         * @since 2.0
  60         * @param[in]            gesture         the gesture instance
  61         */
  62         virtual bool OnPanningGestureChanged(_TouchPanningGestureDetector& gesture) = 0;
  63
  64         /**
  65         * Notifies when the gesture recognition is finished.
  66         *
  67         * @since 2.0
  68         * @param[in]            gesture         the gesture instance
  69         */
  70         virtual bool OnPanningGestureFinished(_TouchPanningGestureDetector& gesture) = 0;
  71
  72         /**
  73         * Notifies when the gesture recognition is canceled.
  74         *
  75         * @since 2.0
  76         * @param[in]            gesture         the gesture instance
  77         */
  78         virtual bool OnPanningGestureCanceled(_TouchPanningGestureDetector& gesture) = 0;
  79 }; // _ITouchPanningGestureEventListener
  80
  81 } } // Tizen::Ui
  82
  83 #endif // _FUI_INTERNAL_ITOUCH_PANNING_GESTURE_EVENT_LISTENER_H_