src/ui/inc/FUi_ITouchPinchGestureEventListener.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_ITouchPinchGestureEventListener.h
  19 * @brief                This is the header file for the %_ITouchPinchGestureEventListener interface.
  20 *
  21 * This header file contains the declarations of the %_ITouchPinchGestureEventListener interface.
  22 */
  23 #ifndef _FUI_INTERNAL_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_
  24 #define _FUI_INTERNAL_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_
  25
  26 #include "FUi_ITouchGestureEventListener.h"
  27 #include "FUi_TouchPinchGestureDetector.h"
  28
  29 namespace Tizen { namespace Ui
  30 {
  31
  32 /**
  33  * @interface           _ITouchPinchGestureEventListener
  34  * @brief                       This interface is used as the argument to the pinch gesture event listener.
  35  * @since 2.0
  36  *
  37  * The listener interface for receiving gesture events. The class that processes a pinch 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, OnPinchGestureRecognized method of that instance is invoked.
  40  */
  41 class _ITouchPinchGestureEventListener
  42         : virtual public _ITouchGestureEventListener
  43 {
  44 // Operation
  45 public:
  46         /**
  47         * This is the destructor for this class.
  48         *
  49         * @since 2.0
  50         */
  51         virtual ~_ITouchPinchGestureEventListener(void) {}
  52
  53         /**
  54         * Notifies when the gesture is recognized.
  55         *
  56         * @since 2.0
  57         * @param[in]            gesture         the gesture instance
  58         */
  59         virtual bool OnPinchGestureStarted(_TouchPinchGestureDetector& gesture) = 0;
  60
  61         /**
  62         * Notifies when the gesture is recognized.
  63         *
  64         * @since 2.0
  65         * @param[in]            gesture         the gesture instance
  66         */
  67         virtual bool OnPinchGestureChanged(_TouchPinchGestureDetector& gesture) = 0;
  68
  69         /**
  70         * Notifies when the gesture is recognized.
  71         *
  72         * @since 2.0
  73         * @param[in]            gesture         the gesture instance
  74         */
  75         virtual bool OnPinchGestureFinished(_TouchPinchGestureDetector& gesture) = 0;
  76
  77         /**
  78         * Notifies when the gesture is recognized.
  79         *
  80         * @since 2.0
  81         * @param[in]            gesture         the gesture instance
  82         */
  83         virtual bool OnPinchGestureCanceled(_TouchPinchGestureDetector& gesture) = 0;
  84 }; // _ITouchPinchGestureEventListener
  85
  86 } } // Tizen::Ui
  87
  88 #endif // _FUI_INTERNAL_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_