dali/public-api/events/long-press-gesture-detector.h

   1 #ifndef __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
   2 #define __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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-v2.h>
  24
  25 namespace Dali DALI_IMPORT_API
  26 {
  27
  28 namespace Internal DALI_INTERNAL
  29 {
  30 class LongPressGestureDetector;
  31 }
  32
  33 struct LongPressGesture;
  34
  35 /**
  36  * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
  37  * @see LongPressGestureDetector::SetTouchesRequired.
  38  *
  39  * For any valid long press, two signals will be emitted:
  40  * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
  41  * - Second identifying the ending (state = Finished) i.e. when fingers are released.
  42  *
  43  * The application programmer can use this gesture detector as follows:
  44  * @code
  45  * LongPressGestureDetector detector = LongPressGestureDetector::New();
  46  * detector.Attach(myActor);
  47  * detector.DetectedSignal().Connect(this, &MyApplication::OnLongPress);
  48  * @endcode
  49  *
  50  * @see LongPressGesture
  51  */
  52 class LongPressGestureDetector : public GestureDetector
  53 {
  54 public: // Typedefs
  55
  56   typedef SignalV2< void (Actor, LongPressGesture) > DetectedSignalV2; ///< Gesture detected signal type
  57
  58   //Signal Names
  59   static const char* const SIGNAL_LONG_PRESS_DETECTED; ///< name "long-press-detected"
  60
  61 public: // Creation & Destruction
  62
  63   /**
  64    * @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
  65    *
  66    * Calling member functions with an uninitialized Dali::Object is not allowed.
  67    */
  68   LongPressGestureDetector();
  69
  70   /**
  71    * @brief Create an initialized LongPressGestureDetector.
  72    *
  73    * By default, this would create a gesture detector that requires only one touch.
  74    * @return A handle to a newly allocated Dali resource.
  75    */
  76   static LongPressGestureDetector New();
  77
  78   /**
  79    * @brief Create an initialized LongPressGestureDetector with the number of touches required.
  80    *
  81    * A long press gesture will be emitted from this detector if the number of fingers touching the
  82    * screen is equal to the touches required.
  83    * @param[in]  touchesRequired  The number of touches required.
  84    * @return A handle to a newly allocated Dali resource.
  85    */
  86   static LongPressGestureDetector New(unsigned int touchesRequired);
  87
  88   /**
  89    * @brief Create an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
  90    *
  91    * A long press gesture will be emitted from this detector if the number of fingers touching the screen
  92    * falls between the minimum and maximum touches set.
  93    * @param[in]  minTouches  The minimum number of touches required.
  94    * @param[in]  maxTouches  The maximum number of touches required.
  95    * @return A handle to a newly allocated Dali resource.
  96    */
  97   static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
  98
  99   /**
 100    * @brief Downcast an Object handle to LongPressGestureDetector handle.
 101    *
 102    * If handle points to a LongPressGestureDetector object the
 103    * downcast produces valid handle. If not the returned handle is left uninitialized.
 104    * @param[in] handle to An object
 105    * @return handle to a LongPressGestureDetector object or an uninitialized handle
 106    */
 107   static LongPressGestureDetector DownCast( BaseHandle handle );
 108
 109   /**
 110    * @brief Destructor
 111    *
 112    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 113    */
 114   ~LongPressGestureDetector();
 115
 116   /**
 117    * @copydoc Dali::BaseHandle::operator=
 118    */
 119   using BaseHandle::operator=;
 120
 121 public: // Setters
 122
 123   /**
 124    * @brief Set the number of touches required.
 125    *
 126    * The number of touches corresponds to the number of fingers a user
 127    * has on the screen.  This sets the minimum and maximum touches to
 128    * the input parameter.
 129    *
 130    * @param[in]  touches  Touches required.
 131    * @pre The gesture detector has been initialized.
 132    * @note The default is '1'.
 133    */
 134   void SetTouchesRequired(unsigned int touches);
 135
 136   /**
 137    * @brief Sets the minimum and maximum touches required.
 138    *
 139    * The number of touches corresponds to the number of fingers a user
 140    * has on the screen.
 141    *
 142    * @param[in]  minTouches  Minimum Touches required.
 143    * @param[in]  maxTouches  Maximum Touches required.
 144    * @pre The gesture detector has been initialized.
 145    * @note The default is '1'.
 146    */
 147   void SetTouchesRequired(unsigned int minTouches, unsigned int maxTouches);
 148
 149 public: // Getters
 150
 151   /**
 152    * @brief Retrieves the minimum number of touches required.
 153    *
 154    * @return The minimum number of touches required.
 155    * @pre The gesture detector has been initialized.
 156    */
 157   unsigned int GetMinimumTouchesRequired() const;
 158
 159   /**
 160    * @brief Retrieves the maximum number of touches required.
 161    *
 162    * @return The maximum number of touches required.
 163    * @pre The gesture detector has been initialized.
 164    */
 165   unsigned int GetMaximumTouchesRequired() const;
 166
 167 public: // Signals
 168
 169   /**
 170    * @brief  This signal is emitted when the specified long press is detected on the attached actor.
 171    *
 172    * A callback of the following type may be connected:
 173    * @code
 174    *   void YourCallbackName(Actor actor, LongPressGesture gesture);
 175    * @endcode
 176    * @pre The gesture detector has been initialized.
 177    * @return The signal to connect to.
 178    */
 179   DetectedSignalV2& DetectedSignal();
 180
 181 public: // Not intended for Application developers
 182
 183   /**
 184    * @brief This constructor is used by Dali New() methods.
 185    *
 186    * @param [in]  internal  A pointer to a newly allocated Dali resource.
 187    */
 188   explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);
 189
 190 };
 191
 192 } // namespace Dali
 193
 194 #endif // __DALI_LONG_PRESS_GESTURE_DETECTOR_H__