inc/FUiITouchFlickGestureEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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 /**
  19  * @file                        FUiITouchFlickGestureEventListener.h
  20  * @brief               This is the header file for the %ITouchFlickGestureEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ITouchFlickGestureEventListener interface.
  23  */
  24
  25 #ifndef _FUI_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H_
  26 #define _FUI_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H_
  27
  28 #include <FUiITouchGestureEventListener.h>
  29 #include <FUiTouchFlickGestureDetector.h>
  30
  31 namespace Tizen { namespace Ui
  32 {
  33
  34 /**
  35  * @interface           ITouchFlickGestureEventListener
  36  * @brief               This interface implements the listener for the touch flick gesture events.
  37  * @since 2.0
  38  *
  39  * The %ITouchFlickGestureEventListener interface is the listener interface for receiving flick gesture events.
  40  * The class that processes a flick gesture event implements this interface, and the instance created with that class is registered with a
  41  * flick gesture detector, using the TouchFlickGestureDetector::AddFlickGestureEventListener() method. When the flick gesture event occurs, a method of that instance is
  42  * invoked.
  43  *
  44  */
  45 class _OSP_EXPORT_ ITouchFlickGestureEventListener
  46         : virtual public ITouchGestureEventListener
  47 {
  48 public:
  49         /**
  50          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  51          *
  52          * @since 2.0
  53          */
  54         virtual ~ITouchFlickGestureEventListener(void) {}
  55
  56         /**
  57          * Called when a flick gesture is detected.
  58          *
  59          * @since 2.0
  60          *
  61          * @param[in]   gestureDetector         The flick gesture detector instance
  62          */
  63         virtual void OnFlickGestureDetected(Tizen::Ui::TouchFlickGestureDetector& gestureDetector) = 0;
  64
  65         /**
  66          * Called when a flick gesture detection is canceled.
  67          *
  68          * @since 2.0
  69          *
  70          * @param[in]   gestureDetector         The flick gesture detector instance
  71          */
  72         virtual void OnFlickGestureCanceled(Tizen::Ui::TouchFlickGestureDetector& gestureDetector) = 0;
  73
  74 protected:
  75         //
  76         // This method is for internal use only. Using this method can cause behavioral, security-related,
  77         // and consistency-related issues in the application.
  78         //
  79         // Following method is reserved and may change its name at any time without
  80         // prior notice.
  81         //
  82         virtual void ITouchFlickGestureEventListener_Reserved1(void) {}
  83
  84         //
  85         // This method is for internal use only. Using this method can cause behavioral, security-related,
  86         // and consistency-related issues in the application.
  87         //
  88         // Following method is reserved and may change its name at any time without
  89         // prior notice.
  90         //
  91         virtual void ITouchFlickGestureEventListener_Reserved2(void) {}
  92
  93         //
  94         // This method is for internal use only. Using this method can cause behavioral, security-related,
  95         // and consistency-related issues in the application.
  96         //
  97         // Following method is reserved and may change its name at any time without
  98         // prior notice.
  99         //
 100         virtual void ITouchFlickGestureEventListener_Reserved3(void) {}
 101 }; // ITouchFlickGestureEventListener
 102
 103 }} // Tizen::Ui
 104
 105 #endif // _FUI_ITOUCH_FLICK_GESTURE_EVENT_LISTENER_H_