inc/FUiITouchLongPressGestureEventListener.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                        FUiITouchLongPressGestureEventListener.h
  20  * @brief               This is the header file for the %ITouchLongPressGestureEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ITouchLongPressGestureEventListener interface.
  23  */
  24
  25 #ifndef _FUI_ITOUCH_LONG_PRESS_GESTURE_EVENT_LISTENER_H_
  26 #define _FUI_ITOUCH_LONG_PRESS_GESTURE_EVENT_LISTENER_H_
  27
  28 #include <FUiTouchLongPressGestureDetector.h>
  29 #include <FUiITouchGestureEventListener.h>
  30
  31 namespace Tizen { namespace Ui
  32 {
  33
  34 /**
  35  * @interface           ITouchLongPressGestureEventListener
  36  * @brief               This interface implements the listener for the touch long press gesture events.
  37  *
  38  * @since 2.0
  39  *
  40  * The %ITouchLongPressGestureEventListener interface is the listener interface for receiving long press gesture events.
  41  * The class that processes a long press gesture event implements this interface, and the instance created with that class is registered with a
  42  * long press gesture detector, using the TouchLongPressGestureDetector::AddLongPressGestureEventListener() method. When the long press gesture event occurs, a method of that instance is
  43  * invoked.
  44  */
  45 class _OSP_EXPORT_ ITouchLongPressGestureEventListener
  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          * This is the destructor for this class.
  52          *
  53          * @since 2.0
  54          */
  55         virtual ~ITouchLongPressGestureEventListener(void) {}
  56
  57         /**
  58          * Called when a long press gesture is detected.
  59          *
  60          * @since 2.0
  61          *
  62          * @param[in]   gestureDetector                 The long press gesture detector instance
  63          */
  64         virtual void OnLongPressGestureDetected(Tizen::Ui::TouchLongPressGestureDetector& gestureDetector) = 0;
  65
  66         /**
  67          * Called when a long press detection is canceled.
  68          *
  69          * @since 2.0
  70          *
  71          * @param[in]   gestureDetector                 The long press gesture detector instance
  72          */
  73         virtual void OnLongPressGestureCanceled(Tizen::Ui::TouchLongPressGestureDetector& gestureDetector) = 0;
  74
  75 protected:
  76         //
  77         // This method is for internal use only. Using this method can cause behavioral, security-related,
  78         // and consistency-related issues in the application.
  79         //
  80         // This method is reserved and may change its name at any time without
  81         // prior notice.
  82         //
  83         virtual void ITouchLongPressGestureEventListener_Reserved1(void) {}
  84
  85         //
  86         // This method is for internal use only. Using this method can cause behavioral, security-related,
  87         // and consistency-related issues in the application.
  88         //
  89         // This method is reserved and may change its name at any time without
  90         // prior notice.
  91         //
  92         virtual void ITouchLongPressGestureEventListener_Reserved2(void) {}
  93
  94         //
  95         // This method is for internal use only. Using this method can cause behavioral, security-related,
  96         // and consistency-related issues in the application.
  97         //
  98         // This method is reserved and may change its name at any time without
  99         // prior notice.
 100         //
 101         virtual void ITouchLongPressGestureEventListener_Reserved3(void) {}
 102 }; // ITouchLongPressGestureEventListener
 103
 104 }} // Tizen::Ui
 105
 106 #endif // _FUI_ITOUCH_LONG_PRESS_GESTURE_EVENT_LISTENER_H_