dali/public-api/events/pinch-gesture-detector.h

   1 #ifndef __DALI_PINCH_GESTURE_DETECTOR_H__
   2 #define __DALI_PINCH_GESTURE_DETECTOR_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/events/gesture-detector.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali-core-events
  29  * @{
  30  */
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class PinchGestureDetector;
  35 }
  36
  37 struct PinchGesture;
  38
  39 /**
  40  * @brief This class looks for pinching gestures involving two touches.
  41  *
  42  * It tries to detect when the user moves two touch points towards or
  43  * away from each other.  Please see PinchGesture for more
  44  * information.
  45  *
  46  * The application programmer can use this gesture detector as follows:
  47  * @code
  48  * PinchGestureDetector detector = PinchGestureDetector::New();
  49  * detector.Attach(myActor);
  50  * detector.DetectedSignal().Connect(this, &MyApplication::OnPinch);
  51  * @endcode
  52  *
  53  * @see PinchGesture
  54  *
  55  * Signals
  56  * | %Signal Name   | Method                |
  57  * |----------------|-----------------------|
  58  * | pinch-detected | @ref DetectedSignal() |
  59  */
  60 class DALI_IMPORT_API PinchGestureDetector : public GestureDetector
  61 {
  62 public: // Typedefs
  63
  64   /**
  65    * @brief Signal type.
  66    */
  67   typedef Signal< void ( Actor, const PinchGesture& ) > DetectedSignalType;
  68
  69 public: // Creation & Destruction
  70
  71   /**
  72    * @brief Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
  73    *
  74    * Calling member functions with an uninitialized Dali::Object is not allowed.
  75    */
  76   PinchGestureDetector();
  77
  78   /**
  79    * @brief Create an initialized PinchGestureDetector.
  80    *
  81    * @return A handle to a newly allocated Dali resource.
  82    */
  83   static PinchGestureDetector New();
  84
  85   /**
  86    * @brief Downcast an Object handle to PinchGestureDetector handle.
  87    *
  88    * If handle points to a PinchGestureDetector object the
  89    * downcast produces valid handle. If not the returned handle is left uninitialized.
  90    * @param[in] handle to An object
  91    * @return handle to a PinchGestureDetector object or an uninitialized handle
  92    */
  93   static PinchGestureDetector DownCast( BaseHandle handle );
  94
  95   /**
  96    * @brief Destructor
  97    *
  98    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  99    */
 100   ~PinchGestureDetector();
 101
 102   /**
 103    * @brief This copy constructor is required for (smart) pointer semantics.
 104    *
 105    * @param [in] handle A reference to the copied handle
 106    */
 107   PinchGestureDetector(const PinchGestureDetector& handle);
 108
 109   /**
 110    * @brief This assignment operator is required for (smart) pointer semantics.
 111    *
 112    * @param [in] rhs  A reference to the copied handle
 113    * @return A reference to this
 114    */
 115   PinchGestureDetector& operator=(const PinchGestureDetector& rhs);
 116
 117 public: // Signals
 118
 119   /**
 120    * @brief This signal is emitted when the pinch gesture is detected on the attached actor.
 121    *
 122    * A callback of the following type may be connected:
 123    * @code
 124    *   void YourCallbackName( Actor actor, const PinchGesture& gesture );
 125    * @endcode
 126    * @pre The gesture detector has been initialized.
 127    * @return The signal to connect to.
 128    */
 129   DetectedSignalType& DetectedSignal();
 130
 131 public: // Not intended for Application developers
 132
 133   /**
 134    * @brief This constructor is used by Dali New() methods.
 135    *
 136    * @param [in]  internal  A pointer to a newly allocated Dali resource.
 137    */
 138   explicit DALI_INTERNAL PinchGestureDetector(Internal::PinchGestureDetector* internal);
 139
 140 };
 141
 142 /**
 143  * @}
 144  */
 145 } // namespace Dali
 146
 147 #endif // __DALI_PINCH_GESTURE_DETECTOR_H__