dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-wobble-effect.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_EFFECT_H__
   2 #define __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_EFFECT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 class ScrollViewEffect;
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 class ScrollViewWobbleEffect;
  34 }
  35
  36 /**
  37  * ScrollView Wobble-Effect.
  38  *
  39  * Using this effect, a %wobble% property is produced which swings
  40  * towards the origin in accordance to how the user pans the ScrollView.
  41  */
  42 class ScrollViewWobbleEffect : public ScrollViewEffect
  43 {
  44 public:
  45
  46   static const std::string EFFECT_OVERSHOOT;
  47   static const std::string EFFECT_TIME;
  48
  49 public:
  50
  51   /**
  52    * Create an initialized ScrollViewWobbleEffect.
  53    * @return A handle to a newly allocated Dali resource.
  54    */
  55   static ScrollViewWobbleEffect New();
  56
  57   /**
  58    * Create an uninitialized ScrollViewWobbleEffect; this can be initialized with ScrollViewWobbleEffect::New()
  59    * Calling member functions with an uninitialized Toolkit::ScrollViewWobbleEffect is not allowed.
  60    */
  61   ScrollViewWobbleEffect();
  62
  63 protected:
  64
  65   /**
  66    * This constructor is used by Dali New() methods.
  67    * @param [in] impl A pointer to a newly allocated Dali resource
  68    */
  69   ScrollViewWobbleEffect(Internal::ScrollViewWobbleEffect *impl);
  70
  71 };
  72
  73 } // namespace Toolkit
  74
  75 } // namespace Dali
  76
  77 #endif // __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_EFFECT_H__