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