inc/FUiITouchPinchGestureEventListener.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 /**
  19 * @file                 FUiITouchPinchGestureEventListener.h
  20 * @brief                This is the header file for the %ITouchPinchGestureEventListener interface.
  21 *
  22 * This header file contains the declarations of the %ITouchPinchGestureEventListener interface.
  23 */
  24
  25 #ifndef _FUI_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_
  26 #define _FUI_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_
  27
  28 #include <FUiTouchPinchGestureDetector.h>
  29 #include <FUiITouchGestureEventListener.h>
  30
  31 namespace Tizen { namespace Ui
  32 {
  33
  34 /**
  35  * @class               ITouchPinchGestureEventListener
  36  * @brief               This interface implements the listener for the touch pinch gesture events.
  37  *
  38  * @since 2.0
  39  *
  40  * The %ITouchPinchGestureEventListener interface is the listener interface for receiving pinch gesture events.
  41  * The class that processes a pinch gesture event implements this interface, and the instance created with that class is registered with a
  42  * pinch gesture detector, using the TouchPinchGestureDetector::AddPinchGestureEventListener() method. When the pinch gesture event occurs, a method of that instance is
  43  * invoked.
  44  *
  45  */
  46 class _OSP_EXPORT_ ITouchPinchGestureEventListener
  47         : virtual public ITouchGestureEventListener
  48 {
  49
  50 public:
  51         /**
  52          * 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.
  53         *
  54         * @since 2.0
  55         */
  56         virtual ~ITouchPinchGestureEventListener(void) {}
  57
  58         /**
  59         * Called when a pinch gesture detection is started.
  60         *
  61         * @since 2.0
  62         *
  63         * @param[in]   gestureDetector                       The pinch gesture detector instance
  64         */
  65         virtual void OnPinchGestureStarted(Tizen::Ui::TouchPinchGestureDetector& gestureDetector) = 0;
  66
  67         /**
  68         * Called when a pinch gesture is detected and is in progress.
  69         *
  70         * @since 2.0
  71         *
  72         * @param[in]   gestureDetector                       The pinch gesture detector instance
  73         */
  74         virtual void OnPinchGestureChanged(Tizen::Ui::TouchPinchGestureDetector& gestureDetector) = 0;
  75
  76         /**
  77         * Called when a pinch gesture detection is finished.
  78         *
  79         * @since 2.0
  80         *
  81         * @param[in]   gestureDetector                       The pinch gesture detector instance
  82         */
  83         virtual void OnPinchGestureFinished(Tizen::Ui::TouchPinchGestureDetector& gestureDetector) = 0;
  84
  85         /**
  86         * Called when a pinch gesture detection is canceled.
  87         *
  88         * @since 2.0
  89         *
  90         * @param[in]   gestureDetector                       The pinch gesture detector instance
  91         */
  92         virtual void OnPinchGestureCanceled(Tizen::Ui::TouchPinchGestureDetector& gestureDetector) = 0;
  93
  94 protected:
  95         //
  96         // This method is for internal use only. Using this method can cause behavioral, security-related,
  97         // and consistency-related issues in the application.
  98         //
  99         // This method is reserved and may change its name at any time without
 100         // prior notice.
 101         //
 102         virtual void ITouchPinchGestureEventListener_Reserved1(void) {}
 103
 104         //
 105         // This method is for internal use only. Using this method can cause behavioral, security-related,
 106         // and consistency-related issues in the application.
 107         //
 108         // This method is reserved and may change its name at any time without
 109         // prior notice.
 110         //
 111         virtual void ITouchPinchGestureEventListener_Reserved2(void) {}
 112
 113         //
 114         // This method is for internal use only. Using this method can cause behavioral, security-related,
 115         // and consistency-related issues in the application.
 116         //
 117         // This method is reserved and may change its name at any time without
 118         // prior notice.
 119         //
 120         virtual void ITouchPinchGestureEventListener_Reserved3(void) {}
 121 }; // ITouchPinchGestureEventListener
 122
 123 }} // Tizen::Ui
 124
 125 #endif // _FUI_ITOUCH_PINCH_GESTURE_EVENT_LISTENER_H_