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